Commit 25cb5b7a authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Linus Torvalds

bitfield: add explicit inclusions to the example

It's not obvious that bitfield.h doesn't guarantee the bits.h inclusion
and the example in the former is confusing.  Some developers think that
it's okay to just include bitfield.h to get it working.  Change example
to explicitly include necessary headers in order to avoid confusion.

Link: https://lkml.kernel.org/r/20220207123341.47533-1-andriy.shevchenko@linux.intel.com
Fixes: 3e9b3112 ("add basic register-field manipulation macros")
Depends-on: 8bd9cb51 ("locking/atomics, asm-generic: Move some macros from <linux/bitops.h> to a new <linux/bits.h> file")
Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Reported-by: default avatarJan Dąbroś <jsd@semihalf.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent f334f566
...@@ -19,6 +19,9 @@ ...@@ -19,6 +19,9 @@
* *
* Example: * Example:
* *
* #include <linux/bitfield.h>
* #include <linux/bits.h>
*
* #define REG_FIELD_A GENMASK(6, 0) * #define REG_FIELD_A GENMASK(6, 0)
* #define REG_FIELD_B BIT(7) * #define REG_FIELD_B BIT(7)
* #define REG_FIELD_C GENMASK(15, 8) * #define REG_FIELD_C GENMASK(15, 8)
......
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