move is_aligned() helper function into bertos/cfg/macros.h
[bertos.git] / bertos / cfg / macros.h
index 3ec6b277e51f320f87937098c1a88094ce965a1d..17f9c6768d92db83972074b7ed26ba479f1c5451 100644 (file)
  *
  * -->
  *
+ * \defgroup macros General purpose macros
+ * \ingroup core
+ * \{
+ *
  * \brief Common and handy function macros
  *
  * \author Bernie Innocenti <bernie@codewiz.org>
 
 /**
  * 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.
+ * \note \a divisor is evaluated twice.
  */
 #define DIV_ROUNDUP(dividend, divisor)  (((dividend) + (divisor) - 1) / (divisor))
 
  */
 typedef uint32_t id_t;
 
+/**
+ * Check if a pointer is aligned to a certain power-of-2 size
+ */
+INLINE bool is_aligned(const void *addr, size_t size)
+{
+       return ((size_t)addr & (size - 1)) == 0;
+}
+
+/** \} */ //defgroup macros
+
 #endif /* MACROS_H */