doc: Added group definitions for most common modules.

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

diff --git a/bertos/cfg/macros.h b/bertos/cfg/macros.h
index 9e8139688402d4e64d51c6e5e6dacb8b96149235..0a721ac5a060f703d00a594ed9ab7cad25ae926e 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,13 @@
  */
 #define DIV_ROUND(dividend, divisor)  (((dividend) + (divisor) / 2) / (divisor))
 
+/**
+ * Perform an integer division rounding the result to the upper int value.
+ * \note \a divisor should preferibly be a costant, otherwise this macro generates
+ * 2 division. Also 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))
 
@@ -342,5 +363,7 @@
  */
 typedef uint32_t id_t;
 
+/** \} */ //defgroup macros
+
 #endif /* MACROS_H */