Fix comment.

[bertos.git] / bertos / cfg / macros.h

diff --git a/bertos/cfg/macros.h b/bertos/cfg/macros.h
index abf2057d5308d43d56593d60d0d8ed2c642ac5c4..e6706f648f66006810ba009c78d42115afead3f1 100644 (file)
--- a/bertos/cfg/macros.h
+++ b/bertos/cfg/macros.h
@@ -30,9 +30,12 @@
  *
  * -->
  *
+ * \defgroup macros General purpose macros
+ * \ingroup core
+ * \{
+ *
  * \brief Common and handy function macros
  *
- * \version $Id$
  * \author Bernie Innocenti <bernie@codewiz.org>
  * \author Giovanni Bajo <rasky@develer.com>
  */
@@ -95,6 +98,11 @@
        #define MAX(a,b)        (((a) > (b)) ? (a) : (b))
 #endif /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
 
+/** Align \p value to the next \p align boundary */
+#define ALIGN_UP(value, align) (((value) & ((align) - 1)) ? \
+                               (((value) + ((align) - 1)) & ~((align) - 1)) : \
+                               (value))
+
 /** Bound \a x between \a min and \a max. */
 #define MINMAX(min,x,max)  (MIN(MAX(min, x), max))
 
@@ -154,6 +162,12 @@
                (b) = tmp; \
        } while (0)
 
+/**
+ * Reverse the bits contained in b (LSB becomes the MSB and so on).
+ * \note \a b is evaluated twice
+ */
+#define REVERSE_UINT8(b) \
+       ((uint8_t)((((b) * 0x0802UL & 0x22110UL) | ((b) * 0x8020UL & 0x88440UL)) * 0x10101UL >> 16))
 
 #ifndef BV
        /** Convert a bit value to a binary flag. */
@@ -176,6 +190,12 @@
  */
 #define DIV_ROUND(dividend, divisor)  (((dividend) + (divisor) / 2) / (divisor))
 
+/**
+ * Perform an integer division rounding the result to the upper int value.
+ * \note \a divisor is evaluated twice.
+ */
+#define DIV_ROUNDUP(dividend, divisor)  (((dividend) + (divisor) - 1) / (divisor))
+
 /** Round up \a x to an even multiple of the 2's power \a pad. */
 #define ROUND_UP2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
 
@@ -273,11 +293,11 @@
 
        #define BIT_MASK_SINGLE__(use_bv, index, max, arg) \
                ((index < max) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
-               /**/
+               /* */
 
        #define BIT_MASK_IF_SINGLE__(use_bv, index, max, arg) \
                (((index < max) && (BIT_EXTRACT_VALUE__ arg)) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
-               /**/
+               /* */
 
        #define BIT_ITER__2(macro, use_bv, max, a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15, ...) \
                (macro(use_bv, 0, max, a0) | \
@@ -296,23 +316,23 @@
                macro(use_bv, 13, max, a13) | \
                macro(use_bv, 14, max, a14) | \
                macro(use_bv, 15, max, a15)) \
-               /**/
+               /* */
 
        #define BIT_ITER__(macro, use_bv, ...) \
                BIT_ITER__2(macro, use_bv, PP_COUNT(__VA_ARGS__), __VA_ARGS__, (0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1),(0,1)) \
-               /**/
+               /* */
 
        #define BIT_MASKS__(use_bv, ...) \
                BIT_ITER__(BIT_MASK_SINGLE__, use_bv, __VA_ARGS__)
-               /**/
+               /* */
 
        #define BIT_MASKS_CONDITIONAL__(use_bv, ...) \
                BIT_ITER__(BIT_MASK_IF_SINGLE__, use_bv, __VA_ARGS__)
-               /**/
+               /* */
 
        #define BIT_CHANGE__(reg, use_bv, ...) \
                ((reg) = ((reg) & ~BIT_MASKS__(use_bv, __VA_ARGS__)) | BIT_MASKS_CONDITIONAL__(use_bv, __VA_ARGS__)) \
-               /**/
+               /* */
 
        #define BIT_CHANGE(reg, ...)        BIT_CHANGE__(reg, 0, __VA_ARGS__)
        #define BIT_CHANGE_BV(reg, ...)     BIT_CHANGE__(reg, 1, __VA_ARGS__)
@@ -342,5 +362,7 @@
  */
 typedef uint32_t id_t;
 
+/** \} */ //defgroup macros
+
 #endif /* MACROS_H */