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