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