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