bits: introduce fixed-type BIT_U*()
authorLucas De Marchi <lucas.demarchi@intel.com>
Tue, 25 Mar 2025 15:59:58 +0000 (00:59 +0900)
committerYury Norov <yury.norov@gmail.com>
Tue, 29 Apr 2025 19:58:38 +0000 (15:58 -0400)
Implement fixed-type BIT_U*() to help drivers add stricter checks,
like it was done for GENMASK_U*().

Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
Acked-by: Jani Nikula <jani.nikula@intel.com>
Co-developed-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Yury Norov <yury.norov@gmail.com>
include/linux/bits.h

index 9718c5ae5fc356e66958cf48667bb1edda4f9673..7ad0562191153471dac729b0020cdb1c9d3049fc 100644 (file)
@@ -24,7 +24,7 @@
 /*
  * Missing asm support
  *
- * GENMASK_U*() depend on BITS_PER_TYPE() which relies on sizeof(),
+ * GENMASK_U*() and BIT_U*() depend on BITS_PER_TYPE() which relies on sizeof(),
  * something not available in asm. Nevertheless, fixed width integers is a C
  * concept. Assembly code can rely on the long and long long versions instead.
  */
 #define GENMASK_U32(h, l)      GENMASK_TYPE(u32, h, l)
 #define GENMASK_U64(h, l)      GENMASK_TYPE(u64, h, l)
 
+/*
+ * Fixed-type variants of BIT(), with additional checks like GENMASK_TYPE(). The
+ * following examples generate compiler warnings due to -Wshift-count-overflow:
+ *
+ * - BIT_U8(8)
+ * - BIT_U32(-1)
+ * - BIT_U32(40)
+ */
+#define BIT_INPUT_CHECK(type, nr) \
+       BUILD_BUG_ON_ZERO(const_true((nr) >= BITS_PER_TYPE(type)))
+
+#define BIT_TYPE(type, nr) ((type)(BIT_INPUT_CHECK(type, nr) + BIT_ULL(nr)))
+
+#define BIT_U8(nr)     BIT_TYPE(u8, nr)
+#define BIT_U16(nr)    BIT_TYPE(u16, nr)
+#define BIT_U32(nr)    BIT_TYPE(u32, nr)
+#define BIT_U64(nr)    BIT_TYPE(u64, nr)
+
 #else /* defined(__ASSEMBLY__) */
 
 /*