Messages in this thread | | | Subject | Re: [PATCH] [6/6] kfifo: Document everywhere that size has to be power of two | From | Stefani Seibold <> | Date | Sun, 27 Dec 2009 22:50:32 +0100 |
| |
Am Sonntag, den 27.12.2009, 22:03 +0100 schrieb Andi Kleen: > 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: Stefani Seibold <Stefani@Seibold.net>
> --- > include/linux/kfifo.h | 4 ++-- > kernel/kfifo.c | 2 +- > 2 files changed, 3 insertions(+), 3 deletions(-) > > Index: linux/include/linux/kfifo.h > =================================================================== > --- linux.orig/include/linux/kfifo.h > +++ linux/include/linux/kfifo.h > @@ -67,7 +67,7 @@ struct kfifo { > /** > * DECLARE_KFIFO - macro to declare a kfifo and the associated buffer > * @name: name of the declared kfifo datatype > - * @size: size of the fifo buffer > + * @size: size of the fifo buffer. Must be a power of two. > * > * Note1: the macro can be used inside struct or union declaration > * Note2: the macro creates two objects: > @@ -91,7 +91,7 @@ union { \ > /** > * DEFINE_KFIFO - macro to define and initialize a kfifo > * @name: name of the declared kfifo datatype > - * @size: size of the fifo buffer > + * @size: size of the fifo buffer. Must be a power of two. > * > * Note1: the macro can be used for global and local kfifo data type variables > * Note2: the macro creates two objects: > Index: linux/kernel/kfifo.c > =================================================================== > --- linux.orig/kernel/kfifo.c > +++ linux/kernel/kfifo.c > @@ -41,7 +41,7 @@ static void _kfifo_init(struct kfifo *fi > * 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. > + * @size: the size of the internal buffer, this has to be a power of 2. > * > */ > void kfifo_init(struct kfifo *fifo, void *buffer, unsigned int size)
| |