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