cfg/macros.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Common and handy function macros
  34  *
  35  * \version $Id$
  36  * \author Bernardo Innocenti <bernie@develer.com>
  37  * \author Giovanni Bajo <rasky@develer.com>
  38  */
  39 #ifndef CFG_MACROS_H
  40 #define CFG_MACROS_H
  41
  42 #include <cfg/compiler.h>
  43
  44 /* avr-gcc does not seem to support libstdc++ */
  45 #if defined(__cplusplus) && !CPU_AVR
  46         /* Type-generic macros implemented with template functions. */
  47         #include <algorithm>
  48
  49         template<class T> inline T ABS(T n) { return n >= 0 ? n : -n; }
  50         #define MIN(a,b)   std::min(a, b)
  51         #define MAX(a,b)   std::max(a, b)
  52         #define SWAP(a,b)  std::swap(a, b)
  53 #elif (COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF)
  54         /* Type-generic macros implemented with statement expressions. */
  55         #define ABS(n) ({ \
  56                 typeof(n) _n = (n); \
  57                 (_n < 0) ? -_n : _n; \
  58         })
  59         #define MIN(a,b) ({ \
  60                 typeof(a) _a = (a); \
  61                 typeof(b) _b = (b); \
  62                 ASSERT_TYPE_EQUAL(_a, _b); \
  63                 /** \
  64                  * The (typeof(_a)) cast in necessary: \
  65                  * result type of conditional expressions is \
  66                  * *NOT* the type of the value returned but \
  67                  * the type that would be produced if _a and _b \
  68                  * were mixed in an expression. \
  69                  * Even in _a and _b are of the same type, \
  70                  * if mixed in an expression the type will be \
  71                  * promoted to int! \
  72                 */ \
  73                 ((typeof(_a))((_a < _b) ? _a : _b)); \
  74         })
  75         #define MAX(a,b) ({ \
  76                 typeof(a) _a = (a); \
  77                 typeof(b) _b = (b); \
  78                 ASSERT_TYPE_EQUAL(_a, _b); \
  79                 /** \
  80                  * The (typeof(_a)) cast in necessary: \
  81                  * result type of conditional expressions is \
  82                  * *NOT* the type of the value returned but \
  83                  * the type that would be produced if _a and _b \
  84                  * were mixed in an expression. \
  85                  * Even in _a and _b are of the same type, \
  86                  * if mixed in an expression the type will be \
  87                  * promoted to int! \
  88                 */ \
  89                 ((typeof(_a))((_a > _b) ? _a : _b)); \
  90         })
  91 #else /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
  92         /* Buggy macros for inferior compilers.  */
  93         #define ABS(a)          (((a) < 0) ? -(a) : (a))
  94         #define MIN(a,b)        (((a) < (b)) ? (a) : (b))
  95         #define MAX(a,b)        (((a) > (b)) ? (a) : (b))
  96 #endif /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
  97
  98 /** Bound \a x between \a min and \a max. */
  99 #define MINMAX(min,x,max)  (MIN(MAX(min, x), max))
 100
 101 #ifdef __cplusplus
 102         /* Use standard implementation from <algorithm> */
 103         #define SWAP(a,b)  std::swap(a, b)
 104 #elif COMPILER_TYPEOF
 105         /**
 106          * Type-generic macro to swap \a a with \a b.
 107          *
 108          * \note Arguments are evaluated multiple times.
 109          */
 110         #define SWAP(a, b) \
 111                 do { \
 112                         typeof(a) tmp; \
 113                         ASSERT_TYPE_EQUAL(a, b); \
 114                         tmp = (a); \
 115                         (a) = (b); \
 116                         (b) = tmp; \
 117                 } while (0)
 118 #else /* !COMPILER_TYPEOF */
 119         /* Sub-optimal implementation that only works with integral types. */
 120         #define SWAP(a, b) \
 121                 do { \
 122                         (a) ^= (b); \
 123                         (b) ^= (a); \
 124                         (a) ^= (b); \
 125                 } while (0)
 126
 127 #endif /* COMPILER_TYPEOF */
 128
 129 /**
 130  * Macro to swap \a a with \a b, with explicit type \a T for dumb C89 compilers.
 131  *
 132  * \note Arguments are evaluated multiple times.
 133  */
 134 #define SWAP_T(a, b, T) \
 135         do { \
 136                 T tmp; \
 137                 ASSERT_TYPE_IS(a, T); \
 138                 ASSERT_TYPE_IS(b, T); \
 139                 tmp = (a); \
 140                 (a) = (b); \
 141                 (b) = tmp; \
 142         } while (0)
 143
 144
 145 #ifndef BV
 146         /** Convert a bit value to a binary flag. */
 147         #define BV(x)  (1<<(x))
 148 #endif
 149
 150 /** Same as BV() but with 32 bit result */
 151 #define BV32(x)  ((uint32_t)1<<(x))
 152
 153 /** Same as BV() but with 16 bit result */
 154 #define BV16(x)  ((uint16_t)1<<(x))
 155
 156 /** Same as BV() but with 8 bit result */
 157 #define BV8(x)  ((uint8_t)1<<(x))
 158
 159 /**
 160  * Perform an integer division rounding the result to the nearest int value.
 161  * \note \a divisor should preferibly be a costant, otherwise this macro generates
 162  * 2 division. Also divisor is evaluated twice.
 163  */
 164 #define DIV_ROUND(dividend, divisor)  (((dividend) + (divisor) / 2) / (divisor))
 165
 166 /** Round up \a x to an even multiple of the 2's power \a pad. */
 167 #define ROUND_UP2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
 168
 169 /* OBSOLETE */
 170 #define ROUND2 ROUND_UP2
 171
 172 /**
 173  * \name Integer round macros.
 174  *
 175  * Round \a x to a multiple of \a base.
 176  * \note If \a x is signed these macros generate a lot of code.
 177  * \{
 178  */
 179 #define ROUND_DOWN(x, base)    ( (x) - ((x) % (base)) )
 180 #define ROUND_UP(x, base)      ( ((x) + (base) - 1) - (((x) + (base) - 1) % (base)) )
 181 #define ROUND_NEAREST(x, base) ( ((x) + (base) / 2) - (((x) + (base) / 2) % (base)) )
 182 /* \} */
 183
 184 /** Check if \a x is an integer power of 2. */
 185 #define IS_POW2(x)     (!(bool)((x) & ((x)-1)))
 186
 187 /** Calculate a compile-time log2 for a uint8_t */
 188 #define UINT8_LOG2(x) \
 189         ((x) < 2 ? 0 : \
 190          ((x) < 4 ? 1 : \
 191           ((x) < 8 ? 2 : \
 192            ((x) < 16 ? 3 : \
 193             ((x) < 32 ? 4 : \
 194              ((x) < 64 ? 5 : \
 195               ((x) < 128 ? 6 : 7)))))))
 196
 197 /** Calculate a compile-time log2 for a uint16_t */
 198 #define UINT16_LOG2(x) \
 199         ((x < 256) ? UINT8_LOG2(x) : UINT8_LOG2((x) >> 8) + 8)
 200
 201 /** Calculate a compile-time log2 for a uint32_t */
 202 #define UINT32_LOG2(x) \
 203         ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 204
 205 #if COMPILER_VARIADIC_MACROS
 206         /** Count the number of arguments (up to 16). */
 207         #define PP_COUNT(...) \
 208                 PP_COUNT__(__VA_ARGS__,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
 209         #define PP_COUNT__(a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,count,...) \
 210                 count
 211 #endif
 212
 213 #if COMPILER_VARIADIC_MACROS
 214         /**
 215          * \def BIT_CHANGE(reg, (mask, value), ...)
 216          *
 217          * This macro allows for efficient and compact bit toggling in a hardware
 218          * register. It is meant to replace hand-coded cruft which toggles bits
 219          * in sequence.
 220          *
 221          * It is possible to specify an unlimited pair of (mask, value) parameters.
 222          * For instance:
 223          *
 224          * \code
 225          * void set_timer(bool start)
 226          * {
 227          *     BIT_CHANGE(REG_CTRL_TIMER,
 228          *        (TIMER_MODE, MODE_COUNT),
 229          *        (OVL_IRQ, 1),
 230          *        (CMP_IRQ, 1),
 231          *        (START, start)
 232          *     );
 233          * }
 234          * \endcode
 235          *
 236          * The macro expansion will be roughly the following:
 237          *
 238          * \code
 239          * REG_CTRL_TIMER = (REG_CTRL_TIMER & ~(TIMER_MODE|OVL_IRQ|CMP_IRQ|START)
 240          *                  | (MODE_COUNT|OVL_IRQ|CMP_IRQ|(start ? START : 0));
 241          * \endcode
 242          *
 243          * It is up to the compiler to produce the optimal code. We checked that GCC produces
 244          * the best code in most cases. We preferred this expansion over the use of a block
 245          * with a local variable because CodeWarrior 6.1 was not able to remove completely the
 246          * allocation of the local from the stack.
 247          *
 248          * \note This macro is available only in C99 because it makes use of variadic macros.
 249          * It would be possible to make up an implementation with a slightly different syntax
 250          * for use with C90 compilers, through Boost Preprocessor.
 251          */
 252
 253         /**
 254          * \def BIT_CHANGE_BV(reg, (bit, value), ...)
 255          *
 256          * Similar to BIT_CHANGE(), but get bits instead of masks (and applies BV() to convert
 257          * them to masks).
 258          */
 259
 260         #define BIT_EXTRACT_FLAG_0(bit, value)  bit
 261         #define BIT_EXTRACT_FLAG_1(bit, value)  BV(bit)
 262         #define BIT_EXTRACT_VALUE__(bit, value) value
 263
 264         #define BIT_MASK_SINGLE__(use_bv, index, max, arg) \
 265                 ((index < max) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
 266                 /**/
 267
 268         #define BIT_MASK_IF_SINGLE__(use_bv, index, max, arg) \
 269                 (((index < max) && (BIT_EXTRACT_VALUE__ arg)) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
 270                 /**/
 271
 272         #define BIT_ITER__2(macro, use_bv, max, a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15, ...) \
 273                 (macro(use_bv, 0, max, a0) | \
 274                 macro(use_bv, 1, max, a1) | \
 275                 macro(use_bv, 2, max, a2) | \
 276                 macro(use_bv, 3, max, a3) | \
 277                 macro(use_bv, 4, max, a4) | \
 278                 macro(use_bv, 5, max, a5) | \
 279                 macro(use_bv, 6, max, a6) | \
 280                 macro(use_bv, 7, max, a7) | \
 281                 macro(use_bv, 8, max, a8) | \
 282                 macro(use_bv, 9, max, a9) | \
 283                 macro(use_bv, 10, max, a10) | \
 284                 macro(use_bv, 11, max, a11) | \
 285                 macro(use_bv, 12, max, a12) | \
 286                 macro(use_bv, 13, max, a13) | \
 287                 macro(use_bv, 14, max, a14) | \
 288                 macro(use_bv, 15, max, a15)) \
 289                 /**/
 290
 291         #define BIT_ITER__(macro, use_bv, ...) \
 292                 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)) \
 293                 /**/
 294
 295         #define BIT_MASKS__(use_bv, ...) \
 296                 BIT_ITER__(BIT_MASK_SINGLE__, use_bv, __VA_ARGS__)
 297                 /**/
 298
 299         #define BIT_MASKS_CONDITIONAL__(use_bv, ...) \
 300                 BIT_ITER__(BIT_MASK_IF_SINGLE__, use_bv, __VA_ARGS__)
 301                 /**/
 302
 303         #define BIT_CHANGE__(reg, use_bv, ...) \
 304                 ((reg) = ((reg) & ~BIT_MASKS__(use_bv, __VA_ARGS__)) | BIT_MASKS_CONDITIONAL__(use_bv, __VA_ARGS__)) \
 305                 /**/
 306
 307         #define BIT_CHANGE(reg, ...)        BIT_CHANGE__(reg, 0, __VA_ARGS__)
 308         #define BIT_CHANGE_BV(reg, ...)     BIT_CHANGE__(reg, 1, __VA_ARGS__)
 309
 310 #endif /* COMPILER_VARIADIC_MACROS */
 311
 312 /**
 313  * Macro for rotating bit left or right.
 314  * \{
 315  */
 316 #define ROTR(var, rot) (((var) >> (rot)) | ((var) << ((sizeof(var) * 8) - (rot))))
 317 #define ROTL(var, rot) (((var) << (rot)) | ((var) >> ((sizeof(var) * 8) - (rot))))
 318 /*\}*/
 319
 320 /**
 321  * Make an id from 4 letters, useful for
 322  * file formats and kfile ids.
 323  */
 324 #define MAKE_ID(a,b,c,d) \
 325         ( ((uint32_t)(a) << 24) \
 326         | ((uint32_t)(b) << 16) \
 327         | ((uint32_t)(c) <<  8) \
 328         | ((uint32_t)(d) <<  0) )
 329
 330 /**
 331  * Type for id generated by MAKE_ID().
 332  */
 333 typedef uint32_t id_t;
 334
 335 #endif /* MACROS_H */
 336