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