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