macros.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
   5  * This file is part of DevLib - See devlib/README for information.
   6  * -->
   7  *
   8  * \brief Common and handy function macros
   9  *
  10  * \version $Id$
  11  * \author Bernardo Innocenti <bernie@develer.com>
  12  * \author Giovanni Bajo <rasky@develer.com>
  13  */
  14
  15 /*#*
  16  *#* $Log$
  17  *#* Revision 1.8  2004/10/19 07:14:20  bernie
  18  *#* Add macros to test for specific compiler features.
  19  *#*
  20  *#* Revision 1.7  2004/09/20 03:30:45  bernie
  21  *#* C++ also has variadic macros.
  22  *#*
  23  *#* Revision 1.6  2004/09/14 21:02:04  bernie
  24  *#* SWAP(), MINMAX(): New macros.
  25  *#*
  26  *#* Revision 1.5  2004/08/29 21:57:58  bernie
  27  *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
  28  *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
  29  *#*
  30  *#* Revision 1.3  2004/08/24 14:13:48  bernie
  31  *#* Restore a few macros that were lost in the way.
  32  *#*
  33  *#* Revision 1.2  2004/08/24 13:32:14  bernie
  34  *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
  35  *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
  36  *#* Trim CVS log;
  37  *#* Rename header guards;
  38  *#* Don't include arch_config.h in compiler.h as it's not needed there.
  39  *#*
  40  *#* Revision 1.1  2004/08/14 19:37:57  rasky
  41  *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
  42  *#*
  43  *#* Revision 1.4  2004/08/14 18:36:50  rasky
  44  *#* Doxygen fix e un livello di parentesi aggiuntivi per la macro
  45  *#*
  46  *#* Revision 1.3  2004/08/12 20:01:32  rasky
  47  *#* Aggiunte macro BIT_CHANGE e BIT_CHANGE_BV
  48  *#*
  49  *#* Revision 1.2  2004/08/10 21:36:14  rasky
  50  *#* Aggiunto include macros.h dove serve
  51  *#* Aggiunta dipendenza da compiler.h in macros.h
  52  *#*
  53  *#* Revision 1.1  2004/08/10 21:30:00  rasky
  54  *#* Estratte le funzioni macro in macros.h
  55  *#*
  56  *#*/
  57
  58 #ifndef MACROS_H
  59 #define MACROS_H
  60
  61 #include <compiler.h>
  62
  63 #if (COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF)
  64         /* Type-generic macros */
  65         #define ABS(n) ({ \
  66                 __typeof__(n) _n = (n); \
  67                 (_n < 0) ? -_n : _n; \
  68         })
  69         #define MIN(a,b) ({ \
  70                 __typeof__(a) _a = (a); \
  71                 __typeof__(b) _b = (b); \
  72                 (void)(&_a == &_b); /* ensure same type */ \
  73                 (_a < _b) ? _a : _b; \
  74         })
  75         #define MAX(a,b) ({ \
  76                 __typeof__(a) _a = (a); \
  77                 __typeof__(b) _b = (b); \
  78                 (void)(&_a == &_b); /* ensure same type */ \
  79                 (_a > _b) ? _a : _b; \
  80         })
  81 #else /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
  82         /* Buggy macros for inferior compilers.  */
  83         #define ABS(a)          (((a) < 0) ? -(a) : (a))
  84         #define MIN(a,b)        (((a) < (b)) ? (a) : (b))
  85         #define MAX(a,b)        (((a) > (b)) ? (a) : (b))
  86 #endif /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
  87
  88 /*! Bound \a x between \a min and \a max. */
  89 #define MINMAX(min,x,max)  (MIN(MAX(min, x), max))
  90
  91 #if COMPILER_TYPEOF
  92         /*!
  93          * Type-generic macro to swap \a a with \a b.
  94          *
  95          * \note Arguments are evaluated multiple times.
  96          */
  97         #define SWAP(a, b) \
  98                 do { \
  99                         (void)(&(a) == &(b)); /* type check */ \
 100                         typeof(a) tmp; \
 101                         tmp = (a); \
 102                         (a) = (b); \
 103                         (b) = tmp; \
 104                 } while (0)
 105 #else /* !COMPILER_TYPEOF */
 106         /* Sub-optimal implementation that only works with integral types. */
 107         #define SWAP(a, b) ((a) ^= (b) ^= (a) ^= (b))
 108 #endif /* COMPILER_TYPEOF */
 109
 110 #ifndef BV
 111         /*! Convert a bit value to a binary flag. */
 112         #define BV(x)  (1<<(x))
 113 #endif
 114
 115 /*! Round up \a x to an even multiple of the 2's power \a pad */
 116 #define ROUND2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
 117
 118 //! Check if \a x is an integer power of 2
 119 #define IS_POW2(x)     (!(bool)((x) & ((x)-1)))
 120
 121 /*! Calculate a compile-time log2 for a uint8_t */
 122 #define UINT8_LOG2(x) \
 123         ((x) < 2 ? 0 : \
 124          ((x) < 4 ? 1 : \
 125           ((x) < 8 ? 2 : \
 126            ((x) < 16 ? 3 : \
 127             ((x) < 32 ? 4 : \
 128              ((x) < 64 ? 5 : \
 129               ((x) < 128 ? 6 : 7)))))))
 130
 131 /*! Calculate a compile-time log2 for a uint16_t */
 132 #define UINT16_LOG2(x) \
 133         ((x < 256) ? UINT8_LOG2(x) : UINT8_LOG2((x) >> 8) + 8)
 134
 135 /*! Calculate a compile-time log2 for a uint32_t */
 136 #define UINT32_LOG2(x) \
 137         ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 138
 139 #if COMPILER_VARIADIC_MACROS
 140         /*! Count the number of arguments (up to 16). */
 141         #define PP_COUNT(...) \
 142                 PP_COUNT__(__VA_ARGS__,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
 143         #define PP_COUNT__(a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,count,...) \
 144                 count
 145 #endif
 146
 147 #if COMPILER_VARIADIC_MACROS
 148         /*!
 149          * \def BIT_CHANGE(reg, (mask, value), ...)
 150          *
 151          * This macro allows for efficient and compact bit toggling in a hardware
 152          * register. It is meant to replace hand-coded cruft which toggles bits
 153          * in sequence.
 154          *
 155          * It is possible to specify an unlimited pair of (mask, value) parameters.
 156          * For instance:
 157          *
 158          * \code
 159          * void set_timer(bool start)
 160          * {
 161          *     BIT_CHANGE(REG_CTRL_TIMER,
 162          *        (TIMER_MODE, MODE_COUNT),
 163          *        (OVL_IRQ, 1),
 164          *        (CMP_IRQ, 1),
 165          *        (START, start)
 166          *     );
 167          * }
 168          * \endcode
 169          *
 170          * The macro expansion will be roughly the following:
 171          *
 172          * \code
 173          * REG_CTRL_TIMER = (REG_CTRL_TIMER & ~(TIMER_MODE|OVL_IRQ|CMP_IRQ|START)
 174          *                  | (MODE_COUNT|OVL_IRQ|CMP_IRQ|(start ? START : 0));
 175          * \endcode
 176          *
 177          * It is up to the compiler to produce the optimal code. We checked that GCC produces
 178          * the best code in most cases. We preferred this expansion over the use of a block
 179          * with a local variable because CodeWarrior 6.1 was not able to remove completely the
 180          * allocation of the local from the stack.
 181          *
 182          * \note This macro is available only in C99 because it makes use of variadic macros.
 183          * It would be possible to make up an implementation with a slightly different syntax
 184          * for use with C90 compilers, through Boost Preprocessor.
 185          */
 186
 187         /*!
 188          * \def BIT_CHANGE_BV(reg, (bit, value), ...)
 189          *
 190          * Similar to BIT_CHANGE(), but get bits instead of masks (and applies BV() to convert
 191          * them to masks).
 192          */
 193
 194         #define BIT_EXTRACT_FLAG_0(bit, value)  bit
 195         #define BIT_EXTRACT_FLAG_1(bit, value)  BV(bit)
 196         #define BIT_EXTRACT_VALUE__(bit, value) value
 197
 198         #define BIT_MASK_SINGLE__(use_bv, index, max, arg) \
 199                 ((index < max) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
 200                 /**/
 201
 202         #define BIT_MASK_IF_SINGLE__(use_bv, index, max, arg) \
 203                 (((index < max) && (BIT_EXTRACT_VALUE__ arg)) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
 204                 /**/
 205
 206         #define BIT_ITER__2(macro, use_bv, max, a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15, ...) \
 207                 (macro(use_bv, 0, max, a0) | \
 208                 macro(use_bv, 1, max, a1) | \
 209                 macro(use_bv, 2, max, a2) | \
 210                 macro(use_bv, 3, max, a3) | \
 211                 macro(use_bv, 4, max, a4) | \
 212                 macro(use_bv, 5, max, a5) | \
 213                 macro(use_bv, 6, max, a6) | \
 214                 macro(use_bv, 7, max, a7) | \
 215                 macro(use_bv, 8, max, a8) | \
 216                 macro(use_bv, 9, max, a9) | \
 217                 macro(use_bv, 10, max, a10) | \
 218                 macro(use_bv, 11, max, a11) | \
 219                 macro(use_bv, 12, max, a12) | \
 220                 macro(use_bv, 13, max, a13) | \
 221                 macro(use_bv, 14, max, a14) | \
 222                 macro(use_bv, 15, max, a15)) \
 223                 /**/
 224
 225         #define BIT_ITER__(macro, use_bv, ...) \
 226                 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)) \
 227                 /**/
 228
 229         #define BIT_MASKS__(use_bv, ...) \
 230                 BIT_ITER__(BIT_MASK_SINGLE__, use_bv, __VA_ARGS__)
 231                 /**/
 232
 233         #define BIT_MASKS_CONDITIONAL__(use_bv, ...) \
 234                 BIT_ITER__(BIT_MASK_IF_SINGLE__, use_bv, __VA_ARGS__)
 235                 /**/
 236
 237         #define BIT_CHANGE__(reg, use_bv, ...) \
 238                 ((reg) = ((reg) & ~BIT_MASKS__(use_bv, __VA_ARGS__)) | BIT_MASKS_CONDITIONAL__(use_bv, __VA_ARGS__)) \
 239                 /**/
 240
 241         #define BIT_CHANGE(reg, ...)        BIT_CHANGE__(reg, 0, __VA_ARGS__)
 242         #define BIT_CHANGE_BV(reg, ...)     BIT_CHANGE__(reg, 1, __VA_ARGS__)
 243
 244 #endif /* COMPILER_VARIADIC_MACROS */
 245
 246 #endif /* MACROS_H */
 247