Eric Lee / linux-smarc-t335x-v3.2

Download as
Browse Code ยป

Commit 5dab600e6a153ceb64832f608069e6c08185411a

Authored by Andi Kleen
Committed by Linus Torvalds
1 parent d994ffc247
Exists in master and in 4 other branches v3.2_AM335xPSP_04.06.00.11, v3.2_NEWT335xPSP_04.06.00.11, v3.2_SBC_SMARTMEN, v3.2_SMARCT335xPSP_04.06.00.11

kfifo: document everywhere that size has to be power of two 

On my first try using them I missed that the fifos need to be power of
two, resulting in a runtime bug.  Document that requirement everywhere
(and fix one grammar bug)

Signed-off-by: Andi Kleen <ak@linux.intel.com>
Acked-by: Stefani Seibold <stefani@seibold.net>
Cc: Roland Dreier <rdreier@cisco.com>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Andy Walls <awalls@radix.net>
Cc: Vikram Dhillon <dhillonv10@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 2 changed files with 3 additions and 3 deletions Side-by-side Diff

include/linux/kfifo.h
Diff comments   View file @ 5dab600
... ... @@ -67,7 +67,7 @@
67 67 /**
68 68 * DECLARE_KFIFO - macro to declare a kfifo and the associated buffer
69 69 * @name: name of the declared kfifo datatype
70   - * @size: size of the fifo buffer
  70 + * @size: size of the fifo buffer. Must be a power of two.
71 71 *
72 72 * Note1: the macro can be used inside struct or union declaration
73 73 * Note2: the macro creates two objects:
... ... @@ -91,7 +91,7 @@
91 91 /**
92 92 * DEFINE_KFIFO - macro to define and initialize a kfifo
93 93 * @name: name of the declared kfifo datatype
94   - * @size: size of the fifo buffer
  94 + * @size: size of the fifo buffer. Must be a power of two.
95 95 *
96 96 * Note1: the macro can be used for global and local kfifo data type variables
97 97 * Note2: the macro creates two objects:
... ... @@ -41,7 +41,7 @@
41 41 * kfifo_init - initialize a FIFO using a preallocated buffer
42 42 * @fifo: the fifo to assign the buffer
43 43 * @buffer: the preallocated buffer to be used.
44   - * @size: the size of the internal buffer, this have to be a power of 2.
  44 + * @size: the size of the internal buffer, this has to be a power of 2.
45 45 *
46 46 */
47 47 void kfifo_init(struct kfifo *fifo, void *buffer, unsigned int size)