Commit ec778edf authored by Cody P Schafer's avatar Cody P Schafer Committed by Linus Torvalds

bitops/find: clarify and extend documentation

Add return value documentation and clarify the units of the @size
parameter.
Signed-off-by: default avatarCody P Schafer <cody@linux.vnet.ibm.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Cody P Schafer <cody@linux.vnet.ibm.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent c962f7b9
...@@ -7,6 +7,9 @@ ...@@ -7,6 +7,9 @@
* @addr: The address to base the search on * @addr: The address to base the search on
* @offset: The bitnumber to start searching at * @offset: The bitnumber to start searching at
* @size: The bitmap size in bits * @size: The bitmap size in bits
*
* Returns the bit number for the next set bit
* If no bits are set, returns @size.
*/ */
extern unsigned long find_next_bit(const unsigned long *addr, unsigned long extern unsigned long find_next_bit(const unsigned long *addr, unsigned long
size, unsigned long offset); size, unsigned long offset);
...@@ -18,6 +21,9 @@ extern unsigned long find_next_bit(const unsigned long *addr, unsigned long ...@@ -18,6 +21,9 @@ extern unsigned long find_next_bit(const unsigned long *addr, unsigned long
* @addr: The address to base the search on * @addr: The address to base the search on
* @offset: The bitnumber to start searching at * @offset: The bitnumber to start searching at
* @size: The bitmap size in bits * @size: The bitmap size in bits
*
* Returns the bit number of the next zero bit
* If no bits are zero, returns @size.
*/ */
extern unsigned long find_next_zero_bit(const unsigned long *addr, unsigned extern unsigned long find_next_zero_bit(const unsigned long *addr, unsigned
long size, unsigned long offset); long size, unsigned long offset);
...@@ -28,9 +34,10 @@ extern unsigned long find_next_zero_bit(const unsigned long *addr, unsigned ...@@ -28,9 +34,10 @@ extern unsigned long find_next_zero_bit(const unsigned long *addr, unsigned
/** /**
* find_first_bit - find the first set bit in a memory region * find_first_bit - find the first set bit in a memory region
* @addr: The address to start the search at * @addr: The address to start the search at
* @size: The maximum size to search * @size: The maximum number of bits to search
* *
* Returns the bit number of the first set bit. * Returns the bit number of the first set bit.
* If no bits are set, returns @size.
*/ */
extern unsigned long find_first_bit(const unsigned long *addr, extern unsigned long find_first_bit(const unsigned long *addr,
unsigned long size); unsigned long size);
...@@ -38,9 +45,10 @@ extern unsigned long find_first_bit(const unsigned long *addr, ...@@ -38,9 +45,10 @@ extern unsigned long find_first_bit(const unsigned long *addr,
/** /**
* find_first_zero_bit - find the first cleared bit in a memory region * find_first_zero_bit - find the first cleared bit in a memory region
* @addr: The address to start the search at * @addr: The address to start the search at
* @size: The maximum size to search * @size: The maximum number of bits to search
* *
* Returns the bit number of the first cleared bit. * Returns the bit number of the first cleared bit.
* If no bits are zero, returns @size.
*/ */
extern unsigned long find_first_zero_bit(const unsigned long *addr, extern unsigned long find_first_zero_bit(const unsigned long *addr,
unsigned long size); unsigned long size);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment