[PATCH] new kfifo API v.08 (fixed)

Prev: Documentation: update ftrace-design.txt
Next: Innolux Display Module #AT080TN42 Support

From: Stefani Seibold on 20 Dec 2009 05:10

---

This is a complete rewrite of the new kfifo API, which is now really
generic. The API is still stable.

There are different types of a fifo which can not handled in C without a
lot of overhead. So i decided to write the API as a set of macros, which
is the only way to do a kind of template meta programming without c++.
This macros handles the different types of fifos in a transparent way.

There are a lot of benefits:

- Compile time handling of the different fifo types
- Performance (a save put or get of an integer does only generate 9 assembly
instructions on a x86)
- Type save
- Cleaner interface, the additional kfifo_..._rec() functions are gone
- Easier to use
- Less error prone
- Smaller footprint
- Different types of fifos: it is now possible to define a int fifo or
any other type. See below for an example.
- The size of the record field will be now detected at compile time
- No need of creating a hidden variable, like in DEFINE_KFIFO

The API has not been change, but there are now real in place fifos
where the data space is a part of the structure. There is no need for an
extra indirection to the access the data and also no size field, because
the size of the fifo can be determinate with sizeof. This kind of fifo
does only need 8 bytes plus the fifo space.

The dynamic assigned or allocated fifos still needs 16 byte plus the
fifo space and does also creates more code.

Most of the macros code will be optimized away and does only generate a
function call. Only the really the small ones generates inline code. The
overall size is half of the size of the previous implementation.

Additional you can now create fifos for any data type, not only the
"unsigned char" byte streamed fifos.

There is also a new kfifo_put and kfifo_get function, to handle a single
element in a fifo.

Here is a small example how to use it:

Example 1: an integer fifo

#include "kfifo.h"

#define FIFO_SIZE 32

#define DYNAMIC
#ifdef DYNAMIC
static DECLARE_KFIFO_PTR(test, int);
#else
static DECLARE_KFIFO(test, int, FIFO_SIZE);
#endif

int testfunc(void)
{
int i;
int buf[6];
unsigned int ret;

#ifdef DYNAMIC
if (kfifo_alloc(&test, 32, 0)) {
printk("error kfifo_alloc\n");
return 1;
}
#else
INIT_KFIFO(test);
#endif

printk("int fifo test start\n");

for(i = 0; i != 10; i++)
kfifo_put(&test, &i);

printk("queue peek: %u\n", kfifo_peek(&test));

ret = kfifo_to_user(&test, buf, kfifo_sizeof(test) * 2);
printk("ret: %d\n", ret);
ret = kfifo_from_user(&test, buf, kfifo_sizeof(test) * 2 - ret);
printk("ret: %d\n", ret);
ret = kfifo_out(&test, buf, 1);
printk("ret: %d\n", ret);
ret = kfifo_in(&test, buf, 1);
printk("ret: %d\n", ret);

for(i = 20; i != 30; i++)
kfifo_put(&test, &i);

printk("queue len: %u\n", kfifo_len(&test));

while(kfifo_get(&test, &i))
printk("%d ", i);
printk("\n");

return 0;
}

Example 2: a dynamic record size fifo

#include "kfifo.h"

#define FIFO_SIZE 32

#define DYNAMIC
#ifdef DYNAMIC
struct kfifo_rec_ptr_2 test[1];

#else
typedef STRUCT_KFIFO_REC_1(FIFO_SIZE) mytest;

static mytest test[1];
#endif

int testfunc(void)
{
const struct { unsigned char buf[6]; } hello = { "hello" };
unsigned int i;
char buf[100];
unsigned int ret;

printk("record fifo test start\n");

#ifdef DYNAMIC
if (kfifo_alloc(test, FIFO_SIZE, 0)) {
printk("error kfifo_alloc\n");
return 1;
}
#else
INIT_KFIFO(test[0]);
#endif
printk("queue size: %u\n", kfifo_size(test));

kfifo_put(test, &hello);

printk("queue peek: %u\n", kfifo_peek(test));

for(i = 0; i < 10; i++) {
memset(buf,'a' + i, i + 1);
kfifo_in(test, buf, i + 1);
}

ret = kfifo_to_user(test, buf, sizeof(buf));
printk("ret: %d\n", ret);
ret = kfifo_from_user(test, buf, sizeof(buf) - ret);
printk("ret: %d\n", ret);

printk("queue len: %u\n", kfifo_len(test));

while(!kfifo_is_empty(test)) {
ret = kfifo_out(test, buf, sizeof(buf));
printk("%.*s\n", ret, buf);
}

return 0;
}

Example 3: a bytes stream fifo

#include "kfifo.h"

#define FIFO_SIZE 32

//#define DYNAMIC
#ifdef DYNAMIC
static struct kfifo test[1];
#else
static DECLARE_KFIFO(test[1], unsigned char, FIFO_SIZE);
#endif

int testfunc(void)
{
unsigned char buf[6];
unsigned char i;
unsigned int ret;

printk("byte stream fifo test start\n");

#ifdef DYNAMIC
if (kfifo_alloc(test, FIFO_SIZE, 0)) {
printk("error kfifo_alloc\n");
return 1;
}
#endif

printk("queue size: %u\n", kfifo_size(test));

kfifo_in(test, "hello", 5);

for(i = 0; i != 9; i++)
kfifo_put(test, &i);

printk("queue peek: %u\n", kfifo_peek(test));

i = kfifo_out(test, buf, 5);
printk("buf: %.*s\n", i, buf);

ret = kfifo_to_user(test, buf, 4);
printk("ret: %d\n", ret);
ret = kfifo_from_user(test, buf, 4 - ret);
printk("ret: %d\n", ret);

ret = kfifo_out(test, buf, 2);
printk("ret: %d\n", ret);
ret = kfifo_in(test, buf, ret);
printk("ret: %d\n", ret);

printk("queue len: %u\n", kfifo_len(test));

for(i = 20; kfifo_put(test, &i); i++)
;

while(kfifo_get(test, &i))
printk("%d ", i);
printk("\n");

return 0;
}

I know that this kind of macros are very sophisticated and not easy to
maintain. But i have all tested and it works as expected. I analyzed the
output of the compiler and for the x86 the code is as good as hand
written assembler code.

The main goal was to provide an API which is very intuitive, save and easy
to use. So linux will get now an powerfull fifo API which provides all what
a developer needs. This will save in the future a lot of kernel space, since
there is no need to write an own. Most of the device driver developers need
a fifo, and also deep kernel development will gain a benefit from this API.

As Linus mentioned the kernel get bloated. I think the best way to prevent this
is to provide powerful API's and LIB's to resuse code.

You can download the test code at www.seibold.net/kfifo.tgz

The patch-set is against mm tree from 11-Dec-2009

Stefani

Signed-off-by: Stefani Seibold <stefani(a)seibold.net>
---
include/linux/kfifo.h | 1105 +++++++++++++++++++++++++++++---------------------
kernel/kfifo.c | 764 +++++++++++++++++++++++-----------
2 files changed, 1167 insertions(+), 702 deletions(-)

diff -u -N -r -p mmotm.orig/include/linux/kfifo.h mmotm.new/include/linux/kfifo.h
--- mmotm.orig/include/linux/kfifo.h 2009-12-19 00:23:12.510334931 +0100
+++ mmotm.new/include/linux/kfifo.h 2009-12-20 10:44:29.777840444 +0100
@@ -1,8 +1,7 @@
/*
- * A generic kernel FIFO implementation.
+ * A generic kernel FIFO implementation
*
* Copyright (C) 2009 Stefani Seibold <stefani(a)seibold.net>
- * Copyright (C) 2004 Stelian Pop <stelian(a)popies.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -20,8 +19,11 @@
*
*/

+#ifndef _LINUX_KFIFO_H
+#define _LINUX_KFIFO_H
+
/*
- * Howto porting drivers to the new generic fifo API:
+ * Howto porting drivers to the new generic FIFO API:
*
* - Modify the declaration of the "struct kfifo *" object into a
* in-place "struct kfifo" object
@@ -35,577 +37,782 @@
* Note: the spinlock pointer formerly passed to kfifo_init/kfifo_alloc
* must be passed now to the kfifo_in_locked and kfifo_out_locked
* as the last parameter.
- * - All formerly name __kfifo_* functions has been renamed into kfifo_*
+ * - The formerly named __kfifo_* functions has been renamed into kfifo_*
*/

-#ifndef _LINUX_KFIFO_H
-#define _LINUX_KFIFO_H
-
#include <linux/kernel.h>
#include <linux/spinlock.h>
+#include <linux/stddef.h>
+#include <linux/scatterlist.h>

-struct kfifo {
- unsigned char *buffer; /* the buffer holding the data */
- unsigned int size; /* the size of the allocated buffer */
- unsigned int in; /* data is added at offset (in % size) */
- unsigned int out; /* data is extracted from off. (out % size) */
-};
+typedef unsigned int __KFIFO_STREAM[0];
+typedef unsigned char __KFIFO_REC_1;
+typedef unsigned short __KFIFO_REC_2;
+
+#define __STRUCT_KFIFO_COMMON(rectype, ptrtype) \
+ union { \
+ struct { \
+ unsigned int in; \
+ unsigned int out; \
+ }; \
+ rectype type; \
+ ptrtype * ptr; \
+ const ptrtype * ptr_const; \
+ };
+
+#define __STRUCT_KFIFO(type, size, rectype, ptrtype) \
+{ \
+ __STRUCT_KFIFO_COMMON(rectype, ptrtype) \
+ type data[(!size || (size & (size - 1))) ? -1 : size]; \
+}
+
+#define STRUCT_KFIFO(type, size) \
+ struct __STRUCT_KFIFO(type, size, __KFIFO_STREAM, type)
+
+#define __STRUCT_KFIFO_PTR(type, rectype, ptrtype) \
+{ \
+ __STRUCT_KFIFO_COMMON(rectype, ptrtype) \
+ unsigned int size; \
+ type * data; \
+}
+
+#define STRUCT_KFIFO_PTR(type) \
+ struct __STRUCT_KFIFO_PTR(type, __KFIFO_STREAM, type)

/*
- * Macros for declaration and initialization of the kfifo datatype
+ * define compatibility struct kfifo for dynamic allocated fifos
*/
+struct kfifo __STRUCT_KFIFO_PTR(unsigned char, __KFIFO_STREAM, void);

-/* helper macro */
-#define __kfifo_initializer(s, b) \
- (struct kfifo) { \
- .size = s, \
- .in = 0, \
- .out = 0, \
- .buffer = b \
- }
+#define STRUCT_KFIFO_REC_1(size) \
+ struct __STRUCT_KFIFO(unsigned char, size, __KFIFO_REC_1, void)

-/**
- * DECLARE_KFIFO - macro to declare a kfifo and the associated buffer
- * @name: name of the declared kfifo datatype
- * @size: size of the fifo buffer
- *
- * Note: the macro can be used inside struct or union declaration
- * Note: the macro creates two objects:
- * A kfifo object with the given name and a buffer for the kfifo
- * object named name##kfifo_buffer
- */
-#define DECLARE_KFIFO(name, size) \
-union { \
- struct kfifo name; \
- unsigned char name##kfifo_buffer[size + sizeof(struct kfifo)]; \
-}
+#define STRUCT_KFIFO_REC_2(size) \
+ struct __STRUCT_KFIFO(unsigned char, size, __KFIFO_REC_2, void)

-/**
- * INIT_KFIFO - Initialize a kfifo declared by DECLARED_KFIFO
- * @name: name of the declared kfifo datatype
- * @size: size of the fifo buffer
+/*
+ * define kfifo_rec types
*/
-#define INIT_KFIFO(name) \
- name = __kfifo_initializer(sizeof(name##kfifo_buffer) - \
- sizeof(struct kfifo), name##kfifo_buffer)
+struct kfifo_rec_ptr_1 __STRUCT_KFIFO_PTR(unsigned char, __KFIFO_REC_1, void);
+struct kfifo_rec_ptr_2 __STRUCT_KFIFO_PTR(unsigned char, __KFIFO_REC_2, void);

/**
- * DEFINE_KFIFO - macro to define and initialize a kfifo
- * @name: name of the declared kfifo datatype
- * @size: size of the fifo buffer
- *
- * Note: the macro can be used for global and local kfifo data type variables
- * Note: the macro creates two objects:
- * A kfifo object with the given name and a buffer for the kfifo
- * object named name##kfifo_buffer
+ * DECLARE_KFIFO_PTR - macro to declare a fifo pointer object
+ * @fifo: name of the declared fifo
+ * @type: type of the fifo elements
+ * @size: the number of elements in the fifo, this must be a power of 2.
*/
-#define DEFINE_KFIFO(name, size) \
- unsigned char name##kfifo_buffer[size]; \
- struct kfifo name = __kfifo_initializer(size, name##kfifo_buffer)
+#define DECLARE_KFIFO_PTR(fifo, type) \
+ STRUCT_KFIFO_PTR(type) fifo

-#undef __kfifo_initializer
+struct __kfifoc {
+ __STRUCT_KFIFO_COMMON(unsigned int, void);
+};
+
+/* helper macro */
+#define __kfifo_initializer(fifo) \
+ (typeof(fifo)) { \
+ { \
+ { \
+ .in = 0, \
+ .out = 0, \
+ } \
+ } \
+ }

-extern void kfifo_init(struct kfifo *fifo, unsigned char *buffer,
- unsigned int size);
-extern __must_check int kfifo_alloc(struct kfifo *fifo, unsigned int size,
- gfp_t gfp_mask);
-extern void kfifo_free(struct kfifo *fifo);
-extern unsigned int kfifo_in(struct kfifo *fifo,
- const unsigned char *from, unsigned int len);
-extern __must_check unsigned int kfifo_out(struct kfifo *fifo,
- unsigned char *to, unsigned int len);
+#define __is_kfifo_ptr(fifo) \
+ (offsetof(typeof(*fifo), data) == offsetof(struct kfifo, data))

/**
- * kfifo_reset - removes the entire FIFO contents
- * @fifo: the fifo to be emptied.
+ * INIT_KFIFO - Initialize a fifo declared by DECLARED_KFIFO
+ * @fifo: name of the declared fifo datatype
*/
-static inline void kfifo_reset(struct kfifo *fifo)
-{
- fifo->in = fifo->out = 0;
-}
+#define INIT_KFIFO(fifo) \
+ fifo = __kfifo_initializer(fifo)

/**
- * kfifo_reset_out - skip FIFO contents
- * @fifo: the fifo to be emptied.
+ * DECLARE_KFIFO - macro to declare a fifo object
+ * @fifo: name of the declared fifo
+ * @type: type of the fifo elements
+ * @size: the number of elements in the fifo, this must be a power of 2.
*/
-static inline void kfifo_reset_out(struct kfifo *fifo)
-{
- smp_mb();
- fifo->out = fifo->in;
-}
+#define DECLARE_KFIFO(fifo, type, size) \
+ STRUCT_KFIFO(type, size) fifo

/**
- * kfifo_size - returns the size of the fifo in bytes
- * @fifo: the fifo to be used.
+ * DEFINE_KFIFO - macro to define and initialize a fifo
+ * @fifo: name of the declared fifo datatype
+ * @type: type of the fifo elements
+ * @size: the number of elements in the fifo, this must be a power of 2.
+ *
+ * Note: the macro can be used for global and local fifo data type variables
*/
-static inline __must_check unsigned int kfifo_size(struct kfifo *fifo)
+#define DEFINE_KFIFO(fifo, type, size) \
+ DECLARE_KFIFO(fifo, type, size) = __kfifo_initializer(fifo)
+
+static inline unsigned int __must_check __kfifo_check(unsigned int val)
{
- return fifo->size;
+ return val;
}

/**
- * kfifo_len - returns the number of used bytes in the FIFO
+ * kfifo_sizeof - returns the size of a fifo element
* @fifo: the fifo to be used.
*/
-static inline unsigned int kfifo_len(struct kfifo *fifo)
-{
- register unsigned int out;
-
- out = fifo->out;
- smp_rmb();
- return fifo->in - out;
-}
+#define kfifo_sizeof(fifo) (sizeof((fifo)->data[0]))

/**
- * kfifo_is_empty - returns true if the fifo is empty
+ * kfifo_recsize - returns the size of the record length field
* @fifo: the fifo to be used.
*/
-static inline __must_check int kfifo_is_empty(struct kfifo *fifo)
-{
- return fifo->in == fifo->out;
-}
+#define kfifo_recsize(fifo) (sizeof((fifo)->type))

/**
- * kfifo_is_full - returns true if the fifo is full
+ * kfifo_size - returns the size of the fifo in elements
* @fifo: the fifo to be used.
*/
-static inline __must_check int kfifo_is_full(struct kfifo *fifo)
-{
- return kfifo_len(fifo) == kfifo_size(fifo);
-}
+#define kfifo_size(fifo) \
+({ \
+ typeof(fifo + 1) __tmps = (fifo); \
+ __is_kfifo_ptr(__tmps) ? ((struct kfifo *)__tmps)->size : \
+ sizeof(__tmps->data) / sizeof(__tmps->data[0]); \
+})

/**
- * kfifo_avail - returns the number of bytes available in the FIFO
+ * kfifo_reset - removes the entire fifo content
* @fifo: the fifo to be used.
*/
-static inline __must_check unsigned int kfifo_avail(struct kfifo *fifo)
-{
- return kfifo_size(fifo) - kfifo_len(fifo);
-}
+#define kfifo_reset(fifo) \
+(void)({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ __tmp->in = __tmp->out = 0; \
+})

/**
- * kfifo_in_locked - puts some data into the FIFO using a spinlock for locking
+ * kfifo_reset_out - skip fifo content
* @fifo: the fifo to be used.
- * @from: the data to be added.
- * @n: the length of the data to be added.
- * @lock: pointer to the spinlock to use for locking.
- *
- * This function copies at most @len bytes from the @from buffer into
- * the FIFO depending on the free space, and returns the number of
- * bytes copied.
*/
-static inline unsigned int kfifo_in_locked(struct kfifo *fifo,
- const unsigned char *from, unsigned int n, spinlock_t *lock)
-{
- unsigned long flags;
- unsigned int ret;
-
- spin_lock_irqsave(lock, flags);
-
- ret = kfifo_in(fifo, from, n);
-
- spin_unlock_irqrestore(lock, flags);
-
- return ret;
-}
+#define kfifo_reset_out(fifo) \
+(void)({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ __tmp->out = __tmp->in; \
+})

/**
- * kfifo_out_locked - gets some data from the FIFO using a spinlock for locking
+ * kfifo_len - returns the number of used elements in the fifo
* @fifo: the fifo to be used.
- * @to: where the data must be copied.
- * @n: the size of the destination buffer.
- * @lock: pointer to the spinlock to use for locking.
- *
- * This function copies at most @len bytes from the FIFO into the
- * @to buffer and returns the number of copied bytes.
*/
-static inline __must_check unsigned int kfifo_out_locked(struct kfifo *fifo,
- unsigned char *to, unsigned int n, spinlock_t *lock)
-{
- unsigned long flags;
- unsigned int ret;
-
- spin_lock_irqsave(lock, flags);
-
- ret = kfifo_out(fifo, to, n);
-
- /*
- * optimization: if the FIFO is empty, set the indices to 0
- * so we don't wrap the next time
- */
- if (kfifo_is_empty(fifo))
- kfifo_reset(fifo);
-
- spin_unlock_irqrestore(lock, flags);
-
- return ret;
-}
-
-extern void kfifo_skip(struct kfifo *fifo, unsigned int len);
-
-extern __must_check unsigned int kfifo_from_user(struct kfifo *fifo,
- const void __user *from, unsigned int n);
-
-extern __must_check unsigned int kfifo_to_user(struct kfifo *fifo,
- void __user *to, unsigned int n);
+#define kfifo_len(fifo) \
+({ \
+ typeof(fifo + 1) __tmpl = (fifo); \
+ __tmpl->in - __tmpl->out; \
+})

/**
- * __kfifo_add_out internal helper function for updating the out offset
+ * kfifo_is_empty - returns true if the fifo is empty
+ * @fifo: the fifo to be used.
*/
-static inline void __kfifo_add_out(struct kfifo *fifo,
- unsigned int off)
-{
- smp_mb();
- fifo->out += off;
-}
+#define kfifo_is_empty(fifo) \
+__kfifo_check( \
+({ \
+ typeof(fifo + 1) __tmpq = (fifo); \
+ __tmpq->in == __tmpq->out; \
+}) \
+)

/**
- * __kfifo_add_in internal helper function for updating the in offset
+ * kfifo_is_full - returns true if the fifo is full
+ * @fifo: the fifo to be used.
*/
-static inline void __kfifo_add_in(struct kfifo *fifo,
- unsigned int off)
-{
- smp_wmb();
- fifo->in += off;
-}
+#define kfifo_is_full(fifo) \
+__kfifo_check( \
+({ \
+ typeof(fifo + 1) __tmpq = (fifo); \
+ kfifo_size(__tmpq) == kfifo_len(__tmpq); \
+}) \
+)

/**
- * __kfifo_off internal helper function for calculating the index of a
- * given offeset
+ * kfifo_avail - returns the number of elements available in the fifo
+ * @fifo: the fifo to be used.
*/
-static inline unsigned int __kfifo_off(struct kfifo *fifo, unsigned int off)
-{
- return off & (fifo->size - 1);
-}
+#define kfifo_avail(fifo) \
+__kfifo_check( \
+({ \
+ typeof(fifo + 1) __tmpq = (fifo); \
+ const size_t __recsize = sizeof(__tmpq->type); \
+ unsigned int __avail = kfifo_size(__tmpq) - kfifo_len(__tmpq); \
+ (__avail <= recsize) ? 0 __avail - __recsize; \
+}) \
+)

/**
- * __kfifo_peek_n internal helper function for determinate the length of
- * the next record in the fifo
+ * kfifo_skip - skip output data
+ * @fifo: the fifo to be used.
*/
-static inline unsigned int __kfifo_peek_n(struct kfifo *fifo,
- unsigned int recsize)
-{
-#define __KFIFO_GET(fifo, off, shift) \
- ((fifo)->buffer[__kfifo_off((fifo), (fifo)->out+(off))] << (shift))
-
- unsigned int l;
-
- l = __KFIFO_GET(fifo, 0, 0);
-
- if (--recsize)
- l |= __KFIFO_GET(fifo, 1, 8);
-
- return l;
-#undef __KFIFO_GET
-}
+#define kfifo_skip(fifo) \
+(void)({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ if (__recsize) \
+ __kfifo_skip_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, __recsize); \
+ else \
+ __tmp->out++; \
+})

/**
- * __kfifo_poke_n internal helper function for storing the length of
- * the next record into the fifo
+ * kfifo_peek - gets the size of the next FIFO record
+ * @fifo: the fifo to be used.
+ * @recsize: size of record field
+ *
+ * This function returns the size of the next FIFO record in number of bytes
*/
-static inline void __kfifo_poke_n(struct kfifo *fifo,
- unsigned int recsize, unsigned int n)
-{
-#define __KFIFO_PUT(fifo, off, val, shift) \
- ( \
- (fifo)->buffer[__kfifo_off((fifo), (fifo)->in+(off))] = \
- (unsigned char)((val) >> (shift)) \
- )
-
- __KFIFO_PUT(fifo, 0, n, 0);
-
- if (--recsize)
- __KFIFO_PUT(fifo, 1, n, 8);
-#undef __KFIFO_PUT
-}
+#define kfifo_peek(fifo) \
+__kfifo_check( \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ (!__recsize) ? kfifo_len(__tmp) * sizeof(__tmp->data[0]) : \
+ __kfifo_peek_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, kfifo_size(__tmp), __recsize); \
+}) \
+)

/**
- * __kfifo_in_... internal functions for put date into the fifo
- * do not call it directly, use kfifo_in_rec() instead
+ * kfifo_alloc - dynamically allocates a new fifo
+ * @fifo: pointer to the fifo
+ * @size: the number of elements in the fifo, this must be a power of 2.
+ * @gfp_mask: get_free_pages mask, passed to kmalloc()
+ *
+ * This macro dynamically allocates a new fifo.
+ *
+ * The numer of elements will be rounded-up to a power of 2.
+ * The fifo will be release with kfifo_free().
+ * Return 0 if no error, otherwise an error code
*/
-extern unsigned int __kfifo_in_n(struct kfifo *fifo,
- const void *from, unsigned int n, unsigned int recsize);
+#define kfifo_alloc(fifo, size, gfp_mask) \
+__kfifo_check( \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ if (0) \
+ __tmp->data = NULL; \
+ __kfifo_alloc(__tmp, size, sizeof(__tmp->data[0]), gfp_mask); \
+}) \
+)

-extern unsigned int __kfifo_in_generic(struct kfifo *fifo,
- const void *from, unsigned int n, unsigned int recsize);
-
-static inline unsigned int __kfifo_in_rec(struct kfifo *fifo,
- const void *from, unsigned int n, unsigned int recsize)
-{
- unsigned int ret;
-
- ret = __kfifo_in_n(fifo, from, n, recsize);
+/**
+ * kfifo_free - frees the fifo
+ * @fifo: the fifo to be freed.
+ */
+#define kfifo_free(fifo) kfree(fifo)

- if (likely(ret == 0)) {
- if (recsize)
- __kfifo_poke_n(fifo, recsize, n);
- __kfifo_add_in(fifo, n + recsize);
- }
- return ret;
-}
+/**
+ * kfifo_init - initialize a FIFO using a preallocated buffer
+ * @fifo: the fifo to assign the buffer
+ * @buffer: the preallocated buffer to be used.
+ * @size: the size of the internal buffer, this have to be a power of 2.
+ */
+#define kfifo_init(fifo, buffer, size) \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ if (0) \
+ __tmp->data = NULL; \
+ __kfifo_init(__tmp, buffer, size, sizeof(__tmp->data[0])); \
+})

/**
- * kfifo_in_rec - puts some record data into the FIFO
+ * kfifo_put - put data into the fifo
* @fifo: the fifo to be used.
- * @from: the data to be added.
- * @n: the length of the data to be added.
- * @recsize: size of record field
+ * @val: the data to be added.
*
- * This function copies @n bytes from the @from into the FIFO and returns
- * the number of bytes which cannot be copied.
- * A returned value greater than the @n value means that the record doesn't
- * fit into the buffer.
+ * This macro copies the given value into the fifo.
*
* Note that with only one concurrent reader and one concurrent
- * writer, you don't need extra locking to use these functions.
+ * writer, you don't need extra locking to use these macro.
*/
-static inline __must_check unsigned int kfifo_in_rec(struct kfifo *fifo,
- void *from, unsigned int n, unsigned int recsize)
-{
- if (!__builtin_constant_p(recsize))
- return __kfifo_in_generic(fifo, from, n, recsize);
- return __kfifo_in_rec(fifo, from, n, recsize);
-}
+#define kfifo_put(fifo, val) \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ typeof(val + 1) __val = (val); \
+ unsigned int __ret; \
+ const size_t __recsize = sizeof(__tmp->type); \
+ const unsigned int fifo_size = kfifo_size(__tmp); \
+ if (0) { \
+ typeof(__tmp->ptr_const) __dummy __attribute__ ((unused)); \
+ __dummy = (typeof(__val))NULL; \
+ } \
+ if (__recsize) \
+ __ret = __kfifo_in_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __val, sizeof(*__val), \
+ __recsize); \
+ else { \
+ if (kfifo_is_full(__tmp)) \
+ __ret = 0; \
+ else { \
+ __tmp->data[__tmp->in & (fifo_size - 1)] = \
+ *(typeof(&__tmp->data[0]))__val; \
+ smp_wmb(); \
+ __tmp->in++; \
+ __ret = 1; \
+ } \
+ } \
+ __ret; \
+})

/**
- * __kfifo_out_... internal functions for get date from the fifo
- * do not call it directly, use kfifo_out_rec() instead
+ * kfifo_get - get data from the fifo
+ * @fifo: the fifo to be used.
+ * @val: the var where to store the data to be added.
+ *
+ * This macro returns the data from the fifo
+ *
+ * Note that with only one concurrent reader and one concurrent
+ * writer, you don't need extra locking to use these macro.
*/
-extern unsigned int __kfifo_out_n(struct kfifo *fifo,
- void *to, unsigned int reclen, unsigned int recsize);
-
-extern unsigned int __kfifo_out_generic(struct kfifo *fifo,
- void *to, unsigned int n,
- unsigned int recsize, unsigned int *total);
-
-static inline unsigned int __kfifo_out_rec(struct kfifo *fifo,
- void *to, unsigned int n, unsigned int recsize,
- unsigned int *total)
-{
- unsigned int l;
-
- if (!recsize) {
- l = n;
- if (total)
- *total = l;
- } else {
- l = __kfifo_peek_n(fifo, recsize);
- if (total)
- *total = l;
- if (n < l)
- return l;
- }
-
- return __kfifo_out_n(fifo, to, l, recsize);
-}
+#define kfifo_get(fifo, val) \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ typeof(val + 1) __val = (val); \
+ unsigned int __ret; \
+ const size_t __recsize = sizeof(__tmp->type); \
+ const unsigned int fifo_size = kfifo_size(__tmp); \
+ if (0) { \
+ typeof(__tmp->ptr) __dummy __attribute__ ((unused)); \
+ __dummy = (typeof(__val))NULL; \
+ } \
+ if (__recsize) \
+ __ret = __kfifo_out_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, (void *)__val, sizeof(*__val), \
+ __recsize); \
+ else { \
+ if (kfifo_is_empty(__tmp)) \
+ __ret = 0; \
+ else { \
+ *(typeof(&__tmp->data[0]))__val = \
+ __tmp->data[__tmp->out & (fifo_size - 1)]; \
+ smp_wmb(); \
+ __tmp->out++; \
+ __ret = 1; \
+ } \
+ } \
+ __ret; \
+})

/**
- * kfifo_out_rec - gets some record data from the FIFO
+ * kfifo_in - puts some data into the fifo
* @fifo: the fifo to be used.
- * @to: where the data must be copied.
- * @n: the size of the destination buffer.
- * @recsize: size of record field
- * @total: pointer where the total number of to copied bytes should stored
+ * @buf: the data to be added.
+ * @n: number of elements to be added
*
- * This function copies at most @n bytes from the FIFO to @to and returns the
- * number of bytes which cannot be copied.
- * A returned value greater than the @n value means that the record doesn't
- * fit into the @to buffer.
+ * This macro copies the given values buffer into the fifo and returns the
+ * number of copied elements.
*
* Note that with only one concurrent reader and one concurrent
- * writer, you don't need extra locking to use these functions.
+ * writer, you don't need extra locking to use these macro.
*/
-static inline __must_check unsigned int kfifo_out_rec(struct kfifo *fifo,
- void *to, unsigned int n, unsigned int recsize,
- unsigned int *total)
-
-{
- if (!__builtin_constant_p(recsize))
- return __kfifo_out_generic(fifo, to, n, recsize, total);
- return __kfifo_out_rec(fifo, to, n, recsize, total);
-}
+#define kfifo_in(fifo, buf, n) \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ typeof(buf + 1) __buf = (buf); \
+ unsigned long num = (n); \
+ unsigned int __ret; \
+ const size_t __esize = sizeof(__tmp->data[0]); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ const unsigned int fifo_size = kfifo_size(__tmp); \
+ if (0) { \
+ typeof(__tmp->ptr_const) __dummy __attribute__ ((unused)); \
+ __dummy = (typeof(__buf))NULL; \
+ } \
+ if (__recsize) \
+ __ret = __kfifo_in_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __buf, num, __recsize); \
+ else { \
+ if (__esize == 1) \
+ __ret = __kfifo_in_1((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __buf, num); \
+ else \
+ __ret = __kfifo_in((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __esize, __buf, num); \
+ } \
+ __ret; \
+})

/**
- * __kfifo_from_user_... internal functions for transfer from user space into
- * the fifo. do not call it directly, use kfifo_from_user_rec() instead
+ * kfifo_in_locked - puts some data into the fifo using a spinlock for locking
+ * @fifo: the fifo to be used.
+ * @buf: the data to be added.
+ * @n: number of elements to be added
+ * @lock: pointer to the spinlock to use for locking.
+ *
+ * This macro copies the given values buffer into the fifo and returns the
+ * number of copied elements.
*/
-extern unsigned int __kfifo_from_user_n(struct kfifo *fifo,
- const void __user *from, unsigned int n, unsigned int recsize);
-
-extern unsigned int __kfifo_from_user_generic(struct kfifo *fifo,
- const void __user *from, unsigned int n, unsigned int recsize);
-
-static inline unsigned int __kfifo_from_user_rec(struct kfifo *fifo,
- const void __user *from, unsigned int n, unsigned int recsize)
-{
- unsigned int ret;
-
- ret = __kfifo_from_user_n(fifo, from, n, recsize);
-
- if (likely(ret == 0)) {
- if (recsize)
- __kfifo_poke_n(fifo, recsize, n);
- __kfifo_add_in(fifo, n + recsize);
- }
- return ret;
-}
+#define kfifo_in_locked(fifo, buf, n, lock) \
+({ \
+ unsigned long __flags; \
+ unsigned int __ret; \
+ spin_lock_irqsave(lock, __flags); \
+ __ret = kfifo_in(fifo, buf, n); \
+ spin_unlock_irqrestore(lock, __flags); \
+ __ret; \
+})

/**
- * kfifo_from_user_rec - puts some data from user space into the FIFO
+ * kfifo_out - gets some data from the fifo
* @fifo: the fifo to be used.
- * @from: pointer to the data to be added.
- * @n: the length of the data to be added.
- * @recsize: size of record field
- *
- * This function copies @n bytes from the @from into the
- * FIFO and returns the number of bytes which cannot be copied.
+ * @buf: pointer to the storage buffer
+ * @n: max. number of elements to get
*
- * If the returned value is equal or less the @n value, the copy_from_user()
- * functions has failed. Otherwise the record doesn't fit into the buffer.
+ * This macro get the data from the fifo and return the numbers of elements
+ * copied.
*
* Note that with only one concurrent reader and one concurrent
- * writer, you don't need extra locking to use these functions.
+ * writer, you don't need extra locking to use these macro.
*/
-static inline __must_check unsigned int kfifo_from_user_rec(struct kfifo *fifo,
- const void __user *from, unsigned int n, unsigned int recsize)
-{
- if (!__builtin_constant_p(recsize))
- return __kfifo_from_user_generic(fifo, from, n, recsize);
- return __kfifo_from_user_rec(fifo, from, n, recsize);
-}
+#define kfifo_out(fifo, buf, n) \
+__kfifo_check( \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ typeof(buf + 1) __buf = (buf); \
+ unsigned long num = (n); \
+ unsigned int __ret; \
+ const size_t __esize = sizeof(__tmp->data[0]); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ const unsigned int fifo_size = kfifo_size(__tmp); \
+ if (0) { \
+ typeof(__tmp->ptr) __dummy __attribute__ ((unused)); \
+ __dummy = (typeof(__buf))NULL; \
+ } \
+ if (__recsize) \
+ __ret = __kfifo_out_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, \
+ (void *)__buf, num, __recsize); \
+ else { \
+ if (__esize == 1) \
+ __ret = __kfifo_out_1((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, \
+ (void *)__buf, num); \
+ else \
+ __ret = __kfifo_out((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __esize, \
+ (void *)__buf, num); \
+ } \
+ __ret; \
+}) \
+)

/**
- * __kfifo_to_user_... internal functions for transfer fifo data into user space
- * do not call it directly, use kfifo_to_user_rec() instead
+ * kfifo_out_locked - gets some data from the fifo using a spinlock for locking
+ * @fifo: the fifo to be used.
+ * @buf: pointer to the storage buffer
+ * @n: max. number of elements to get
+ * @lock: pointer to the spinlock to use for locking.
+ *
+ * This macro get the data from the fifo and return the numbers of elements
+ * copied.
*/
-extern unsigned int __kfifo_to_user_n(struct kfifo *fifo,
- void __user *to, unsigned int n, unsigned int reclen,
- unsigned int recsize);
-
-extern unsigned int __kfifo_to_user_generic(struct kfifo *fifo,
- void __user *to, unsigned int n, unsigned int recsize,
- unsigned int *total);
-
-static inline unsigned int __kfifo_to_user_rec(struct kfifo *fifo,
- void __user *to, unsigned int n,
- unsigned int recsize, unsigned int *total)
-{
- unsigned int l;
-
- if (!recsize) {
- l = n;
- if (total)
- *total = l;
- } else {
- l = __kfifo_peek_n(fifo, recsize);
- if (total)
- *total = l;
- if (n < l)
- return l;
- }
-
- return __kfifo_to_user_n(fifo, to, n, l, recsize);
-}
+#define kfifo_out_locked(fifo, buf, n, lock) \
+__kfifo_check( \
+({ \
+ unsigned long __flags; \
+ unsigned int __ret; \
+ spin_lock_irqsave(lock, __flags); \
+ __ret = kfifo_out(fifo, buf, n); \
+ spin_unlock_irqrestore(lock, __flags); \
+ __ret; \
+}) \
+)

/**
- * kfifo_to_user_rec - gets data from the FIFO and write it to user space
+ * kfifo_from_user - puts some data from user space into the fifo
* @fifo: the fifo to be used.
- * @to: where the data must be copied.
- * @n: the size of the destination buffer.
- * @recsize: size of record field
- * @total: pointer where the total number of to copied bytes should stored
+ * @from: pointer to the data to be added.
+ * @len: the length of the data to be added.
*
- * This function copies at most @n bytes from the FIFO to the @to.
- * In case of an error, the function returns the number of bytes which cannot
- * be copied.
- * If the returned value is equal or less the @n value, the copy_to_user()
- * functions has failed. Otherwise the record doesn't fit into the @to buffer.
+ * This macro copies at most @len bytes from the @from into the
+ * fifo, depending of the available space and returns the number
+ * of bytes not be copied.
*
* Note that with only one concurrent reader and one concurrent
- * writer, you don't need extra locking to use these functions.
+ * writer, you don't need extra locking to use these macro.
*/
-static inline __must_check unsigned int kfifo_to_user_rec(struct kfifo *fifo,
- void __user *to, unsigned int n, unsigned int recsize,
- unsigned int *total)
-{
- if (!__builtin_constant_p(recsize))
- return __kfifo_to_user_generic(fifo, to, n, recsize, total);
- return __kfifo_to_user_rec(fifo, to, n, recsize, total);
-}
+#define kfifo_from_user(fifo, from, len) \
+__kfifo_check( \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ const void __user * __from = (from); \
+ unsigned int __len = (len); \
+ unsigned int __ret; \
+ const size_t __esize = sizeof(__tmp->data[0]); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ const unsigned int fifo_size = kfifo_size(__tmp); \
+ if (__recsize) \
+ __ret = __kfifo_from_user_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __from, __len, __recsize); \
+ else { \
+ if (__esize == 1) \
+ __ret = __kfifo_from_user_1((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __from, __len); \
+ else \
+ __ret = __kfifo_from_user((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __esize, __from, __len); \
+ } \
+ __len - __ret; \
+}) \
+)

/**
- * __kfifo_peek_... internal functions for peek into the next fifo record
- * do not call it directly, use kfifo_peek_rec() instead
+ * kfifo_to_user - copies data from the fifo into user space
+ * @fifo: the fifo to be used.
+ * @to: where the data must be copied.
+ * @len: the size of the destination buffer.
+ *
+ * This macro copies at most @len bytes from the fifo into the
+ * @to buffer and returns the number of bytes not be copied.
+ *
+ * Note that with only one concurrent reader and one concurrent
+ * writer, you don't need extra locking to use these macro.
+ */
+#define kfifo_to_user(fifo, to, len) \
+__kfifo_check( \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ void __user * __to = (to); \
+ unsigned int __len = (len); \
+ unsigned int __ret; \
+ const size_t __esize = sizeof(__tmp->data[0]); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ const unsigned int fifo_size = kfifo_size(__tmp); \
+ if (__recsize) \
+ __ret = __kfifo_to_user_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __to, __len, __recsize); \
+ else { \
+ if (__esize == 1) \
+ __ret = __kfifo_to_user_1((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __to, __len); \
+ else \
+ __ret = __kfifo_to_user((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __esize, __to, __len); \
+ } \
+ __len - __ret; \
+}) \
+)
+
+/**
+ * kfifo_dma_in_prepare - setup a scatterlist for DMA input
+ * @fifo: the fifo to be used.
+ * @sgl: pointer to the scatterlist array.
+ * @nents: number of entries in the scatterlist array (should be 1 or 2).
+ * @len: number of elements to transfer.
+ *
+ * This macro fills a scatterlist for DMA input.
+ * It returns the number of bytes which are available for the transfer.
+ *
+ * Note that with only one concurrent reader and one concurrent
+ * writer, you don't need extra locking to use these macros.
*/
-extern unsigned int __kfifo_peek_generic(struct kfifo *fifo,
- unsigned int recsize);
+#define kfifo_dma_in_prepare(fifo, sgl, nents, len) \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ struct scatterlist *__sgl = (sgl); \
+ int __nents = (nents); \
+ unsigned int __len = (len); \
+ const size_t __esize = sizeof(__tmp->data[0]); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ const unsigned int fifo_size = kfifo_size(__tmp); \
+ if (__recsize) \
+ __ret = __kfifo_dma_in_prepare_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __sgl, __nents, \
+ __len, __recsize); \
+ else { \
+ if (__esize == 1) \
+ __kfifo_dma_in_prepare_1((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __sgl, __nents, \
+ __len); \
+ else \
+ __kfifo_dma_in_prepare((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __esize, __sgl, \
+ __nents, __len); \
+ } \
+})

/**
- * kfifo_peek_rec - gets the size of the next FIFO record data
+ * kfifo_dma_in_finish - finish a DMA IN operation
* @fifo: the fifo to be used.
- * @recsize: size of record field
+ * @len: number of bytes to received.
*
- * This function returns the size of the next FIFO record in number of bytes
+ * This macro finish a DMA IN operation. The in counter will be updated by
+ * the len parameter. No error checking will be done.
+ *
+ * Note that with only one concurrent reader and one concurrent
+ * writer, you don't need extra locking to use these macros.
*/
-static inline __must_check unsigned int kfifo_peek_rec(struct kfifo *fifo,
- unsigned int recsize)
-{
- if (!__builtin_constant_p(recsize))
- return __kfifo_peek_generic(fifo, recsize);
- if (!recsize)
- return kfifo_len(fifo);
- return __kfifo_peek_n(fifo, recsize);
-}
+#define kfifo_dma_in_finish(fifo, len) \
+(void)({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ unsigned int __len = (len); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ if (__recsize) \
+ __kfifo_dma_in_finish_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, kfifo_size(__tmp), __len, __recsize); \
+ else \
+ __tmp->in += __len / sizeof(__tmp->data[0]); \
+})
+
+/**
+ * kfifo_dma_out_prepare - setup a scatterlist for DMA output
+ * @fifo: the fifo to be used.
+ * @sgl: pointer to the scatterlist array.
+ * @nents: number of entries in the scatterlist array (should be 1 or 2).
+ * @len: number of elements to transfer.
+ *
+ * This macro fills a scatterlist for DMA output which at most @len bytes
+ * to transfer.
+ * It returns the number of bytes which are available for the transfer.
+ * A zero means there is no space available and the scatterlist is not filled
+ *
+ * Note that with only one concurrent reader and one concurrent
+ * writer, you don't need extra locking to use these macros.
+ */
+#define kfifo_dma_out_prepare(fifo, sgl, nents, len) \
+({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ int __nents = (nents); \
+ unsigned int __len = (len); \
+ const size_t __esize = sizeof(__tmp->data[0]); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ const unsigned int fifo_size = kfifo_size(__tmp); \
+ if (__recsize) \
+ __ret = __kfifo_dma_out_prepare_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __sgl, __nents, \
+ __len, __recsize); \
+ else { \
+ if (__esize == 1) \
+ __kfifo_dma_out_prepare_1((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __sgl, __nents, \
+ __len); \
+ else \
+ __kfifo_dma_out_prepare((struct __kfifoc *)__tmp, \
+ __tmp->data, fifo_size, __esize, __sgl, \
+ __nents, __len); \
+ } \
+})

/**
- * __kfifo_skip_... internal functions for skip the next fifo record
- * do not call it directly, use kfifo_skip_rec() instead
+ * kfifo_dma_out_finish - finish a DMA OUT operation
+ * @fifo: the fifo to be used.
+ * @len: number of bytes transferd.
+ *
+ * This macro finish a DMA OUT operation. The out counter will be updated by
+ * the len parameter. No error checking will be done.
+ *
+ * Note that with only one concurrent reader and one concurrent
+ * writer, you don't need extra locking to use these macros.
*/
-extern void __kfifo_skip_generic(struct kfifo *fifo, unsigned int recsize);
+#define kfifo_dma_out_finish(fifo, len) \
+(void)({ \
+ typeof(fifo + 1) __tmp = (fifo); \
+ unsigned int __len = (len); \
+ const size_t __recsize = sizeof(__tmp->type); \
+ if (__recsize) \
+ __kfifo_dma_out_finish_rec((struct __kfifoc *)__tmp, \
+ __tmp->data, kfifo_size(__tmp), __len, __recsize); \
+ else \
+ __tmp->out += __len / sizeof(__tmp->data[0]); \
+})

-static inline void __kfifo_skip_rec(struct kfifo *fifo,
- unsigned int recsize)
-{
- unsigned int l;
+extern int __kfifo_alloc(void *fifo, unsigned int size,
+ size_t esize, gfp_t gfp_mask);

- if (recsize) {
- l = __kfifo_peek_n(fifo, recsize);

- if (l + recsize <= kfifo_len(fifo)) {
- __kfifo_add_out(fifo, l + recsize);
- return;
- }
- }
- kfifo_reset_out(fifo);
-}
+extern void __kfifo_init(void *fifo, void *buffer, unsigned int size,
+ size_t esize);

-/**
- * kfifo_skip_rec - skip the next fifo out record
- * @fifo: the fifo to be used.
- * @recsize: size of record field
- *
- * This function skips the next FIFO record
- */
-static inline void kfifo_skip_rec(struct kfifo *fifo,
- unsigned int recsize)
-{
- if (!__builtin_constant_p(recsize))
- __kfifo_skip_generic(fifo, recsize);
- else
- __kfifo_skip_rec(fifo, recsize);
-}
+extern unsigned int __kfifo_in(struct __kfifoc *fifoc, void *data,
+ unsigned int size, size_t esize, const void *buf,
+ unsigned int len);

-/**
- * kfifo_avail_rec - returns the number of bytes available in a record FIFO
- * @fifo: the fifo to be used.
- * @recsize: size of record field
- */
-static inline __must_check unsigned int kfifo_avail_rec(struct kfifo *fifo,
- unsigned int recsize)
-{
- unsigned int l = kfifo_size(fifo) - kfifo_len(fifo);
+extern unsigned int __kfifo_in_1(struct __kfifoc *fifoc, void *data,
+ unsigned int size, const void *buf, unsigned int len);

- return (l > recsize) ? l - recsize : 0;
-}
+extern unsigned int __kfifo_in_rec(struct __kfifoc *fifoc, void *data,
+ unsigned int size, const void *buf, unsigned int len,
+ size_t recsize);
+
+
+extern unsigned int __kfifo_out(struct __kfifoc *fifoc, void *data,
+ unsigned int size, size_t esize, void *buf, unsigned int len);
+
+extern unsigned int __kfifo_out_1(struct __kfifoc *fifoc, void *data,
+ unsigned int size, void *buf, unsigned int len);
+
+extern unsigned int __kfifo_out_rec(struct __kfifoc *fifoc, void *data,
+ unsigned int size, void *buf, unsigned int len, size_t recsize);
+
+
+extern unsigned long __kfifo_from_user(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t esize,
+ const void __user *from, unsigned long len);
+
+extern unsigned long __kfifo_from_user_1(struct __kfifoc *fifoc,
+ void *data, unsigned int size, const void __user *from,
+ unsigned long len);
+
+extern unsigned long __kfifo_from_user_rec(struct __kfifoc *fifoc,
+ void *data, unsigned int size, const void __user *from,
+ unsigned long len, size_t recsize);
+
+
+extern unsigned long __kfifo_to_user(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t esize, void __user *to,
+ unsigned long len);
+
+extern unsigned long __kfifo_to_user_1(struct __kfifoc *fifoc,
+ void *data, unsigned int size, void __user *to,
+ unsigned long len);
+
+extern unsigned long __kfifo_to_user_rec(struct __kfifoc *fifoc,
+ void *data, unsigned int size, void __user *to,
+ unsigned int long, size_t recsize);
+
+
+extern unsigned int __kfifo_dma_in_prepare(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t esize,
+ struct scatterlist *sgl, int nents, unsigned int len);
+
+extern unsigned int __kfifo_dma_in_prepare_1(struct __kfifoc *fifoc,
+ void *data, unsigned int size, struct scatterlist *sgl,
+ int nents, unsigned int len);
+
+extern unsigned int __kfifo_dma_in_prepare_rec(struct __kfifoc *fifoc,
+ void *data, unsigned int size, struct scatterlist *sgl,
+ int nents, unsigned int len, size_t recsize);
+
+
+extern void __kfifo_dma_in_finish_rec(struct __kfifoc *fifoc,
+ void *data, unsigned int size, unsigned int len, size_t recsize);
+
+
+extern unsigned int __kfifo_dma_out_prepare(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t esize,
+ struct scatterlist *sgl, int nents, unsigned int len);
+
+extern unsigned int __kfifo_dma_out_prepare_1(struct __kfifoc *fifoc,
+ void *data, unsigned int size, struct scatterlist *sgl,
+ int nents, unsigned int len);
+
+extern unsigned int __kfifo_dma_out_prepare_rec(struct __kfifoc *fifoc,
+ void *data, unsigned int size, struct scatterlist *sgl,
+ int nents, unsigned int len, size_t recsize);
+
+
+extern void __kfifo_dma_out_finish_rec(struct __kfifoc *fifoc,
+ void *data, unsigned int size, unsigned int len, size_t recsize);
+
+
+extern unsigned int __kfifo_peek_rec(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t recsize);

#endif
+
diff -u -N -r -p mmotm.orig/kernel/kfifo.c mmotm.new/kernel/kfifo.c
--- mmotm.orig/kernel/kfifo.c 2009-12-19 00:22:49.674556018 +0100
+++ mmotm.new/kernel/kfifo.c 2009-12-20 10:44:51.460975775 +0100
@@ -1,8 +1,7 @@
/*
- * A generic kernel FIFO implementation.
+ * A generic kernel FIFO implementation
*
* Copyright (C) 2009 Stefani Seibold <stefani(a)seibold.net>
- * Copyright (C) 2004 Stelian Pop <stelian(a)popies.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -28,46 +27,12 @@
#include <linux/log2.h>
#include <linux/uaccess.h>

-static void _kfifo_init(struct kfifo *fifo, unsigned char *buffer,
- unsigned int size)
-{
- fifo->buffer = buffer;
- fifo->size = size;
-
- kfifo_reset(fifo);
-}
+#define roundup_diff(val, size) (((val) + (size - 1)) / size)

-/**
- * kfifo_init - initialize a FIFO using a preallocated buffer
- * @fifo: the fifo to assign the buffer
- * @buffer: the preallocated buffer to be used.
- * @size: the size of the internal buffer, this have to be a power of 2.
- *
- */
-void kfifo_init(struct kfifo *fifo, unsigned char *buffer, unsigned int size)
+int __kfifo_alloc(void *fifo, unsigned int size,
+ size_t esize, gfp_t gfp_mask)
{
- /* size must be a power of 2 */
- BUG_ON(!is_power_of_2(size));
-
- _kfifo_init(fifo, buffer, size);
-}
-EXPORT_SYMBOL(kfifo_init);
-
-/**
- * kfifo_alloc - allocates a new FIFO internal buffer
- * @fifo: the fifo to assign then new buffer
- * @size: the size of the buffer to be allocated, this have to be a power of 2.
- * @gfp_mask: get_free_pages mask, passed to kmalloc()
- *
- * This function dynamically allocates a new fifo internal buffer
- *
- * The size will be rounded-up to a power of 2.
- * The buffer will be release with kfifo_free().
- * Return 0 if no error, otherwise the an error code
- */
-int kfifo_alloc(struct kfifo *fifo, unsigned int size, gfp_t gfp_mask)
-{
- unsigned char *buffer;
+ struct kfifo *proxy = (struct kfifo *)fifo;

/*
* round up to the next power of 2, since our 'let the indices
@@ -77,324 +42,617 @@ int kfifo_alloc(struct kfifo *fifo, unsi
BUG_ON(size > 0x80000000);
size = roundup_pow_of_two(size);
}
+ BUG_ON(size <= 1);
+
+ proxy->in = proxy->out = 0;
+ proxy->data = kmalloc(size * esize, gfp_mask);

- buffer = kmalloc(size, gfp_mask);
- if (!buffer) {
- _kfifo_init(fifo, 0, 0);
+ if (!proxy->data) {
+ proxy->size = 0;
return -ENOMEM;
}

- _kfifo_init(fifo, buffer, size);
+ proxy->size = size;

return 0;
}
-EXPORT_SYMBOL(kfifo_alloc);
+EXPORT_SYMBOL(__kfifo_alloc);

-/**
- * kfifo_free - frees the FIFO internal buffer
- * @fifo: the fifo to be freed.
- */
-void kfifo_free(struct kfifo *fifo)
+void __kfifo_init(void *fifo, void *buffer, unsigned int size, size_t esize)
{
- kfree(fifo->buffer);
-}
-EXPORT_SYMBOL(kfifo_free);
+ struct kfifo *proxy = (struct kfifo *)fifo;

-/**
- * kfifo_skip - skip output data
- * @fifo: the fifo to be used.
- * @len: number of bytes to skip
- */
-void kfifo_skip(struct kfifo *fifo, unsigned int len)
-{
- if (len < kfifo_len(fifo)) {
- __kfifo_add_out(fifo, len);
- return;
- }
- kfifo_reset_out(fifo);
+ size /= esize;
+
+ if (size)
+ size = rounddown_pow_of_two(size);
+
+ proxy->data = buffer;
+ proxy->in = proxy->out = 0;
+ proxy->size = size;
}
-EXPORT_SYMBOL(kfifo_skip);
+EXPORT_SYMBOL(__kfifo_init);

-static inline void __kfifo_in_data(struct kfifo *fifo,
- const void *from, unsigned int len, unsigned int off)
+extern unsigned int __kfifo_in(struct __kfifoc *fifoc, void *data,
+ unsigned int size, size_t esize, const void *buf,
+ unsigned int len)
{
unsigned int l;
+ unsigned int off;

- /*
- * Ensure that we sample the fifo->out index -before- we
- * start putting bytes into the kfifo.
- */
+ l = size - (fifoc->in - fifoc->out);
+ if (len > l)
+ len = l;

- smp_mb();
+ off = fifoc->in & (size - 1);

- off = __kfifo_off(fifo, fifo->in + off);
+ /* first put the data starting from in to fifo end */
+ l = min(len, size - off);
+ memcpy(data + off * esize, buf, l * esize);

- /* first put the data starting from fifo->in to buffer end */
- l = min(len, fifo->size - off);
- memcpy(fifo->buffer + off, from, l);
+ /* then put the rest (if any) at the beginning of the fifo */
+ memcpy(data, buf + l * esize, (len - l) * esize);

- /* then put the rest (if any) at the beginning of the buffer */
- memcpy(fifo->buffer, from + l, len - l);
+ smp_wmb();
+ fifoc->in += len;
+ return len;
}
+EXPORT_SYMBOL(__kfifo_in);

-static inline void __kfifo_out_data(struct kfifo *fifo,
- void *to, unsigned int len, unsigned int off)
+unsigned int __kfifo_out(struct __kfifoc *fifoc, void *data,
+ unsigned int size, size_t esize, void *buf, unsigned int len)
{
unsigned int l;
+ unsigned int off;

- /*
- * Ensure that we sample the fifo->in index -before- we
- * start removing bytes from the kfifo.
- */
+ l = fifoc->in - fifoc->out;
+ if (len > l)
+ len = l;

- smp_rmb();
+ off = fifoc->out & (size - 1);

- off = __kfifo_off(fifo, fifo->out + off);
+ /* first get the data from out until the end of the fifo */
+ l = min(len, size - off);
+ memcpy(buf, data + off * esize, l * esize);

- /* first get the data from fifo->out until the end of the buffer */
- l = min(len, fifo->size - off);
- memcpy(to, fifo->buffer + off, l);
+ /* then get the rest (if any) from the beginning of the fifo */
+ memcpy(buf + l * esize, data, (len - l) * esize);

- /* then get the rest (if any) from the beginning of the buffer */
- memcpy(to + l, fifo->buffer, len - l);
+ smp_wmb();
+ fifoc->out += len;
+ return len;
}
+EXPORT_SYMBOL(__kfifo_out);

-static inline unsigned int __kfifo_from_user_data(struct kfifo *fifo,
- const void __user *from, unsigned int len, unsigned int off)
+extern unsigned long __kfifo_from_user(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t esize,
+ const void __user *from, unsigned long len)
{
unsigned int l;
- int ret;
+ unsigned long ret;
+ unsigned long off;

- /*
- * Ensure that we sample the fifo->out index -before- we
- * start putting bytes into the kfifo.
- */
+ len /= esize;
+ l = size - (fifoc->in - fifoc->out);
+ if (len > l)
+ len = l;
+
+ off = fifoc->in & (size - 1);
+
+ /* first put the data starting from in to fifo end */
+ l = min(len, size - off);
+ ret = copy_from_user(data + off * esize, from, l * esize);

- smp_mb();
+ if (unlikely(ret))
+ len = l - roundup_diff(ret, esize);
+ else {
+ ret = copy_from_user(data, from + l * esize, (len - l) * esize);

- off = __kfifo_off(fifo, fifo->in + off);
+ if (unlikely(ret))
+ len -= roundup_diff(ret, esize);
+ }

- /* first put the data starting from fifo->in to buffer end */
- l = min(len, fifo->size - off);
- ret = copy_from_user(fifo->buffer + off, from, l);
+ smp_wmb();
+ fifoc->in += len;
+ return len * esize;
+}
+EXPORT_SYMBOL(__kfifo_from_user);
+
+unsigned long __kfifo_to_user(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t esize, void __user *to,
+ unsigned long len)
+{
+ unsigned int l;
+ unsigned long ret;
+ unsigned long off;
+
+ len /= esize;
+ l = fifoc->in - fifoc->out;
+ if (len > l)
+ len = l;
+
+ off = fifoc->out & (size - 1);
+
+ /* first get the data from out until the end of the fifo */
+ l = min(len, size - off);
+ ret = copy_to_user(to, data + off * esize, l * esize);

if (unlikely(ret))
- return ret + len - l;
+ len = l - roundup_diff(ret, esize);
+ else {
+ ret = copy_to_user(to + l * esize, data, (len - l) * esize);
+
+ if (unlikely(ret))
+ len -= roundup_diff(ret, esize);
+ }

- /* then put the rest (if any) at the beginning of the buffer */
- return copy_from_user(fifo->buffer, from + l, len - l);
+ smp_wmb();
+ fifoc->out += len;
+ return len * esize;
+}
+EXPORT_SYMBOL(__kfifo_to_user);
+
+static unsigned int setup_sgl(void *data, unsigned int size,
+ struct scatterlist *sgl, int nents, unsigned int len, unsigned int off)
+{
+ unsigned int l;
+
+ l = min(len, size - off);
+ if (l != len) {
+ if (nents > 1) {
+ sg_set_buf(sgl, data + off, l);
+ sgl++;
+
+ off = 0;
+ l = len - l;
+ } else
+ len = l;
+ }
+ sg_set_buf(sgl, data + off, l);
+ sg_mark_end(sgl);
+
+ return len;
}

-static inline unsigned int __kfifo_to_user_data(struct kfifo *fifo,
- void __user *to, unsigned int len, unsigned int off)
+unsigned int __kfifo_dma_in_prepare(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t esize,
+ struct scatterlist *sgl, int nents, unsigned int len)
{
- unsigned int l;
- int ret;
+ unsigned int l;
+ unsigned int off;

- /*
- * Ensure that we sample the fifo->in index -before- we
- * start removing bytes from the kfifo.
- */
+ if (!nents)
+ BUG();

- smp_rmb();
+ l = size - (fifoc->in - fifoc->out);
+ if (len > l)
+ len = l;
+ if (!len)
+ return 0;

- off = __kfifo_off(fifo, fifo->out + off);
+ off = fifoc->in & (size - 1);

- /* first get the data from fifo->out until the end of the buffer */
- l = min(len, fifo->size - off);
- ret = copy_to_user(to, fifo->buffer + off, l);
+ return setup_sgl(data, size, sgl, nents, len * esize, off * esize);
+}
+EXPORT_SYMBOL(__kfifo_dma_in_prepare);

- if (unlikely(ret))
- return ret + len - l;
+unsigned int __kfifo_dma_out_prepare(struct __kfifoc *fifoc,
+ void *data, unsigned int size, size_t esize,
+ struct scatterlist *sgl, int nents, unsigned int len)
+{
+ unsigned int l;
+ unsigned int off;
+
+ if (!nents)
+ BUG();

- /* then get the rest (if any) from the beginning of the buffer */
- return copy_to_user(to + l, fifo->buffer, len - l);
+ l = fifoc->in - fifoc->out;
+ if (len > l)
+ len = l;
+ if (!len)
+ return 0;
+
+ off = fifoc->out & (size - 1);
+
+ l = min(len, size - off);
+
+ return setup_sgl(data, size, sgl, nents, len * esize, off * esize);
}
+EXPORT_SYMBOL(__kfifo_dma_out_prepare);

-unsigned int __kfifo_in_n(struct kfifo *fifo,
- const void *from, unsigned int len, unsigned int recsize)
+unsigned int __kfifo_in_1(struct __kfifoc *fifoc, void *data,
+ unsigned int size, const void *buf, unsigned int len)
{
- if (kfifo_avail(fifo) < len + recsize)
- return len + 1;
+ unsigned int l;
+ unsigned int off;

- __kfifo_in_data(fifo, from, len, recsize);
- return 0;
+ l = size - (fifoc->in - fifoc->out);
+ if (len > l)
+ len = l;
+
+ off = fifoc->in & (size - 1);
+
+ /* first put the data starting from in to fifo end */
+ l = min(len, size - off);
+ memcpy(data + off, buf, l);
+
+ /* then put the rest (if any) at the beginning of the fifo */
+ memcpy(data, buf + l, len - l);
+
+ smp_wmb();
+ fifoc->in += len;
+ return len;
}
-EXPORT_SYMBOL(__kfifo_in_n);
+EXPORT_SYMBOL(__kfifo_in_1);

-/**
- * kfifo_in - puts some data into the FIFO
- * @fifo: the fifo to be used.
- * @from: the data to be added.
- * @len: the length of the data to be added.
- *
- * This function copies at most @len bytes from the @from buffer into
- * the FIFO depending on the free space, and returns the number of
- * bytes copied.
- *
- * Note that with only one concurrent reader and one concurrent
- * writer, you don't need extra locking to use these functions.
- */
-unsigned int kfifo_in(struct kfifo *fifo, const unsigned char *from,
- unsigned int len)
+unsigned int __kfifo_out_1(struct __kfifoc *fifoc, void *data,
+ unsigned int size, void *buf, unsigned int len)
{
- len = min(kfifo_avail(fifo), len);
+ unsigned int l;
+ unsigned int off;
+
+ l = fifoc->in - fifoc->out;
+ if (len > l)
+ len = l;
+
+ off = fifoc->out & (size - 1);
+
+ /* first get the data from out until the end of the fifo */
+ l = min(len, size - off);
+ memcpy(buf, data + off, l);

- __kfifo_in_data(fifo, from, len, 0);
- __kfifo_add_in(fifo, len);
+ /* then get the rest (if any) from the beginning of the fifo */
+ memcpy(buf + l, data, len - l);
+
+ smp_wmb();
+ fifoc->out += len;
return len;
}
-EXPORT_SYMBOL(kfifo_in);
+EXPORT_SYMBOL(__kfifo_out_1);

-unsigned int __kfifo_in_generic(struct kfifo *fifo,
- const void *from, unsigned int len, unsigned int recsize)
+extern unsigned long __kfifo_from_user_1(struct __kfifoc *fifoc,
+ void *data, unsigned int size, const void __user *from,
+ unsigned long len)
{
- return __kfifo_in_rec(fifo, from, len, recsize);
+ unsigned int l;
+ unsigned long ret;
+ unsigned long off;
+
+ l = size - (fifoc->in - fifoc->out);
+ if (len > l)
+ len = l;
+
+ off = fifoc->in & (size - 1);
+
+ /* first put the data starting from in to fifo end */
+ l = min(len, size - off);
+ ret = copy_from_user(data + off, from, l);
+
+ if (unlikely(ret))
+ ret = l - ret;
+ else
+ ret = len - copy_from_user(data, from + l, len - l);
+
+ smp_wmb();
+ fifoc->in += ret;
+ return ret;
}
-EXPORT_SYMBOL(__kfifo_in_generic);
+EXPORT_SYMBOL(__kfifo_from_user_1);

-unsigned int __kfifo_out_n(struct kfifo *fifo,
- void *to, unsigned int len, unsigned int recsize)
+unsigned long __kfifo_to_user_1(struct __kfifoc *fifoc,
+ void *data, unsigned int size, void __user *to,
+ unsigned long len)
{
- if (kfifo_len(fifo) < len + recsize)
- return len;
+ unsigned int l;
+ unsigned long ret;
+ unsigned long off;

- __kfifo_out_data(fifo, to, len, recsize);
- __kfifo_add_out(fifo, len + recsize);
- return 0;
+ l = fifoc->in - fifoc->out;
+ if (len > l)
+ len = l;
+
+ off = fifoc->out & (size - 1);
+
+ /* first get the data from out until the end of the fifo */
+ l = min(len, size - off);
+ ret = copy_to_user(to, data + off, l);
+
+ if (unlikely(ret))
+ ret = l - ret;
+ else
+ ret = len - copy_to_user(to + l, data, len - l);
+ smp_wmb();
+ fifoc->out += ret;
+ return ret;
}
-EXPORT_SYMBOL(__kfifo_out_n);
+EXPORT_SYMBOL(__kfifo_to_user_1);

-/**
- * kfifo_out - gets some data from the FIFO
- * @fifo: the fifo to be used.
- * @to: where the data must be copied.
- * @len: the size of the destination buffer.
- *
- * This function copies at most @len bytes from the FIFO into the
- * @to buffer and returns the number of copied bytes.
- *
- * Note that with only one concurrent reader and one concurrent
- * writer, you don't need extra locking to use these functions.
- */
-unsigned int kfifo_out(struct kfifo *fifo, unsigned char *to, unsigned int len)
+unsigned int __kfifo_dma_in_prepare_1(struct __kfifoc *fifoc,
+ void *data, unsigned int size, struct scatterlist *sgl,
+ int nents, unsigned int len)
{
- len = min(kfifo_len(fifo), len);
+ unsigned int l;
+ unsigned int off;

- __kfifo_out_data(fifo, to, len, 0);
- __kfifo_add_out(fifo, len);
+ if (!nents)
+ BUG();

- return len;
+ l = size - (fifoc->in - fifoc->out);
+ if (len > l)
+ len = l;
+ if (!len)
+ return 0;
+
+ off = fifoc->in & (size - 1);
+
+ return setup_sgl(data, size, sgl, nents, len, off);
}
-EXPORT_SYMBOL(kfifo_out);
+EXPORT_SYMBOL(__kfifo_dma_in_prepare_1);

-unsigned int __kfifo_out_generic(struct kfifo *fifo,
- void *to, unsigned int len, unsigned int recsize,
- unsigned int *total)
+unsigned int __kfifo_dma_out_prepare_1(struct __kfifoc *fifoc,
+ void *data, unsigned int size, struct scatterlist *sgl,
+ int nents, unsigned int len)
{
- return __kfifo_out_rec(fifo, to, len, recsize, total);
+ unsigned int l;
+ unsigned int off;
+
+ if (!nents)
+ BUG();
+
+ l = fifoc->in - fifoc->out;
+ if (len > l)
+ len = l;
+ if (!len)
+ return 0;
+
+ off = fifoc->out & (size - 1);
+
+ return setup_sgl(data, size, sgl, nents, len, off);
}
-EXPORT_SYMBOL(__kfifo_out_generic);
+EXPORT_SYMBOL(__kfifo_dma_out_prepare_1);

-unsigned int __kfifo_from_user_n(struct kfifo *fifo,
- const void __user *from, unsigned int len, unsigned int recsize)
+#define __KFIFO_PEEK(data, out, size) \
+ ((data)[(out) & ((size) -1)])
+/**
+ * __kfifo_peek_n internal helper function for determinate the length of
+ * the next record in the fifo
+ */
+static unsigned int __kfifo_peek_n(struct __kfifoc *fifoc,
+ unsigned char *data, unsigned int size, size_t recsize)
{
- if (kfifo_avail(fifo) < len + recsize)
- return len + 1;
+ unsigned int l;

- return __kfifo_from_user_data(fifo, from, len, recsize);
+ l = __KFIFO_PEEK(data, fifoc->out, size);
+
+ if (--recsize)
+ l |= __KFIFO_PEEK(data, fifoc->out + 1, size) << 8;
+
+ return l;
}
-EXPORT_SYMBOL(__kfifo_from_user_n);
+
+#define __KFIFO_POKE(data, in, size, val) \
+ ( \
+ (data)[(in) & ((size) - 1)] = (unsigned char)(val) \
+ )

/**
- * kfifo_from_user - puts some data from user space into the FIFO
- * @fifo: the fifo to be used.
- * @from: pointer to the data to be added.
- * @len: the length of the data to be added.
- *
- * This function copies at most @len bytes from the @from into the
- * FIFO depending and returns the number of copied bytes.
- *
- * Note that with only one concurrent reader and one concurrent
- * writer, you don't need extra locking to use these functions.
+ * __kfifo_poke_n internal helper function for storeing the length of
+ * the next record into the fifo
*/
-unsigned int kfifo_from_use

 | 
Pages: 1
Prev: Documentation: update ftrace-design.txt
Next: Innolux Display Module #AT080TN42 Support