bertos/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  * \defgroup macros General purpose macros
  34  * \ingroup core
  35  * \{
  36  *
  37  * \brief Common and handy function macros
  38  *
  39  * \author Bernie Innocenti <bernie@codewiz.org>
  40  * \author Giovanni Bajo <rasky@develer.com>
  41  */
  42 #ifndef CFG_MACROS_H
  43 #define CFG_MACROS_H
  44
  45 #include <cfg/compiler.h>
  46
  47 /* avr-gcc does not seem to support libstdc++ */
  48 #if defined(__cplusplus) && !CPU_AVR
  49         /* Type-generic macros implemented with template functions. */
  50         #include <algorithm>
  51
  52         template<class T> inline T ABS(T n) { return n >= 0 ? n : -n; }
  53         #define MIN(a,b)   std::min(a, b)
  54         #define MAX(a,b)   std::max(a, b)
  55         #define SWAP(a,b)  std::swap(a, b)
  56 #elif (COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF)
  57         /* Type-generic macros implemented with statement expressions. */
  58         #define ABS(n) ({ \
  59                 typeof(n) _n = (n); \
  60                 (_n < 0) ? -_n : _n; \
  61         })
  62         #define MIN(a,b) ({ \
  63                 typeof(a) _a = (a); \
  64                 typeof(b) _b = (b); \
  65                 ASSERT_TYPE_EQUAL(_a, _b); \
  66                 /** \
  67                  * The (typeof(_a)) cast in necessary: \
  68                  * result type of conditional expressions is \
  69                  * *NOT* the type of the value returned but \
  70                  * the type that would be produced if _a and _b \
  71                  * were mixed in an expression. \
  72                  * Even in _a and _b are of the same type, \
  73                  * if mixed in an expression the type will be \
  74                  * (at least) promoted to int! \
  75                  */ \
  76                 ((typeof(_a))((_a < _b) ? _a : _b)); \
  77         })
  78         #define MAX(a,b) ({ \
  79                 typeof(a) _a = (a); \
  80                 typeof(b) _b = (b); \
  81                 ASSERT_TYPE_EQUAL(_a, _b); \
  82                 /** \
  83                  * The (typeof(_a)) cast in necessary: \
  84                  * result type of conditional expressions is \
  85                  * *NOT* the type of the value returned but \
  86                  * the type that would be produced if _a and _b \
  87                  * were mixed in an expression. \
  88                  * Even in _a and _b are of the same type, \
  89                  * if mixed in an expression the type will be \
  90                  * (at least) promoted to int! \
  91                  */ \
  92                 ((typeof(_a))((_a > _b) ? _a : _b)); \
  93         })
  94 #else /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
  95         /* Buggy macros for inferior compilers.  */
  96         #define ABS(a)          (((a) < 0) ? -(a) : (a))
  97         #define MIN(a,b)        (((a) < (b)) ? (a) : (b))
  98         #define MAX(a,b)        (((a) > (b)) ? (a) : (b))
  99 #endif /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
 100
 101 /** Align \p value to the next \p align boundary */
 102 #define ALIGN_UP(value, align)  (((value) & ((align) - 1)) ? \
 103                                 (((value) + ((align) - 1)) & ~((align) - 1)) : \
 104                                 (value))
 105
 106 /** Bound \a x between \a min and \a max. */
 107 #define MINMAX(min,x,max)  (MIN(MAX(min, x), max))
 108
 109 #ifdef __cplusplus
 110         /* Use standard implementation from <algorithm> */
 111         #define SWAP(a,b)  std::swap(a, b)
 112 #elif COMPILER_TYPEOF
 113         /**
 114          * Type-generic macro to swap \a a with \a b.
 115          *
 116          * \note Arguments are evaluated multiple times.
 117          */
 118         #define SWAP(a, b) \
 119                 do { \
 120                         typeof(a) tmp; \
 121                         ASSERT_TYPE_EQUAL(a, b); \
 122                         tmp = (a); \
 123                         (a) = (b); \
 124                         (b) = tmp; \
 125                 } while (0)
 126 #else /* !COMPILER_TYPEOF */
 127         /* Sub-optimal implementation that only works with integral types. */
 128         #define SWAP(a, b) \
 129                 do { \
 130                         (a) ^= (b); \
 131                         (b) ^= (a); \
 132                         (a) ^= (b); \
 133                 } while (0)
 134
 135 #endif /* COMPILER_TYPEOF */
 136
 137 /**
 138  * Shuffle the content of \a array that counts \a len elements.
 139  */
 140 #define SHUFFLE(array, len) \
 141         do { \
 142                 int i, j; \
 143                 for (i = (len) - 1; i > 0; i--) \
 144                 { \
 145                         j = ((i + 1) * (rand() / (RAND_MAX + 1.0))); \
 146                         SWAP((array)[i], (array)[j]); \
 147                 } \
 148         } while (0)
 149
 150 /**
 151  * Macro to swap \a a with \a b, with explicit type \a T for dumb C89 compilers.
 152  *
 153  * \note Arguments are evaluated multiple times.
 154  */
 155 #define SWAP_T(a, b, T) \
 156         do { \
 157                 T tmp; \
 158                 ASSERT_TYPE_IS(a, T); \
 159                 ASSERT_TYPE_IS(b, T); \
 160                 tmp = (a); \
 161                 (a) = (b); \
 162                 (b) = tmp; \
 163         } while (0)
 164
 165 /**
 166  * Reverse the bits contained in b (LSB becomes the MSB and so on).
 167  * \note \a b is evaluated twice
 168  */
 169 #define REVERSE_UINT8(b) \
 170         ((uint8_t)((((b) * 0x0802UL & 0x22110UL) | ((b) * 0x8020UL & 0x88440UL)) * 0x10101UL >> 16))
 171
 172 #ifndef BV
 173         /** Convert a bit value to a binary flag. */
 174         #define BV(x)  (1<<(x))
 175 #endif
 176
 177 /** Same as BV() but with 32 bit result */
 178 #define BV32(x)  ((uint32_t)1<<(x))
 179
 180 /** Same as BV() but with 16 bit result */
 181 #define BV16(x)  ((uint16_t)1<<(x))
 182
 183 /** Same as BV() but with 8 bit result */
 184 #define BV8(x)  ((uint8_t)1<<(x))
 185
 186 /**
 187  * Perform an integer division rounding the result to the nearest int value.
 188  * \note \a divisor should preferibly be a costant, otherwise this macro generates
 189  * 2 division. Also divisor is evaluated twice.
 190  */
 191 #define DIV_ROUND(dividend, divisor)  (((dividend) + (divisor) / 2) / (divisor))
 192
 193 /**
 194  * Perform an integer division rounding the result to the upper int value.
 195  * \note \a divisor should preferibly be a costant, otherwise this macro generates
 196  * 2 division. Also divisor is evaluated twice.
 197  */
 198 #define DIV_ROUNDUP(dividend, divisor)  (((dividend) + (divisor) - 1) / (divisor))
 199
 200 /** Round up \a x to an even multiple of the 2's power \a pad. */
 201 #define ROUND_UP2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
 202
 203 /**
 204  * \name Integer round macros.
 205  *
 206  * Round \a x to a multiple of \a base.
 207  * \note If \a x is signed these macros generate a lot of code.
 208  * \{
 209  */
 210 #define ROUND_DOWN(x, base)    ( (x) - ((x) % (base)) )
 211 #define ROUND_UP(x, base)      ( ((x) + (base) - 1) - (((x) + (base) - 1) % (base)) )
 212 #define ROUND_NEAREST(x, base) ( ((x) + (base) / 2) - (((x) + (base) / 2) % (base)) )
 213 /* \} */
 214
 215 /** Check if \a x is an integer power of 2. */
 216 #define IS_POW2(x)     (!(bool)((x) & ((x)-1)))
 217
 218 /** Calculate a compile-time log2 for a uint8_t */
 219 #define UINT8_LOG2(x) \
 220         ((x) < 2 ? 0 : \
 221          ((x) < 4 ? 1 : \
 222           ((x) < 8 ? 2 : \
 223            ((x) < 16 ? 3 : \
 224             ((x) < 32 ? 4 : \
 225              ((x) < 64 ? 5 : \
 226               ((x) < 128 ? 6 : 7)))))))
 227
 228 /** Calculate a compile-time log2 for a uint16_t */
 229 #define UINT16_LOG2(x) \
 230         ((x < 256) ? UINT8_LOG2(x) : UINT8_LOG2((x) >> 8) + 8)
 231
 232 /** Calculate a compile-time log2 for a uint32_t */
 233 #define UINT32_LOG2(x) \
 234         ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 235
 236 #if COMPILER_VARIADIC_MACROS
 237         /** Count the number of arguments (up to 16). */
 238         #define PP_COUNT(...) \
 239                 PP_COUNT__(__VA_ARGS__,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
 240         #define PP_COUNT__(a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,count,...) \
 241                 count
 242 #endif
 243
 244 #if COMPILER_VARIADIC_MACROS
 245         /**
 246          * \def BIT_CHANGE(reg, (mask, value), ...)
 247          *
 248          * This macro allows for efficient and compact bit toggling in a hardware
 249          * register. It is meant to replace hand-coded cruft which toggles bits
 250          * in sequence.
 251          *
 252          * It is possible to specify an unlimited pair of (mask, value) parameters.
 253          * For instance:
 254          *
 255          * \code
 256          * void set_timer(bool start)
 257          * {
 258          *     BIT_CHANGE(REG_CTRL_TIMER,
 259          *        (TIMER_MODE, MODE_COUNT),
 260          *        (OVL_IRQ, 1),
 261          *        (CMP_IRQ, 1),
 262          *        (START, start)
 263          *     );
 264          * }
 265          * \endcode
 266          *
 267          * The macro expansion will be roughly the following:
 268          *
 269          * \code
 270          * REG_CTRL_TIMER = (REG_CTRL_TIMER & ~(TIMER_MODE|OVL_IRQ|CMP_IRQ|START)
 271          *                  | (MODE_COUNT|OVL_IRQ|CMP_IRQ|(start ? START : 0));
 272          * \endcode
 273          *
 274          * It is up to the compiler to produce the optimal code. We checked that GCC produces
 275          * the best code in most cases. We preferred this expansion over the use of a block
 276          * with a local variable because CodeWarrior 6.1 was not able to remove completely the
 277          * allocation of the local from the stack.
 278          *
 279          * \note This macro is available only in C99 because it makes use of variadic macros.
 280          * It would be possible to make up an implementation with a slightly different syntax
 281          * for use with C90 compilers, through Boost Preprocessor.
 282          */
 283
 284         /**
 285          * \def BIT_CHANGE_BV(reg, (bit, value), ...)
 286          *
 287          * Similar to BIT_CHANGE(), but get bits instead of masks (and applies BV() to convert
 288          * them to masks).
 289          */
 290
 291         #define BIT_EXTRACT_FLAG_0(bit, value)  bit
 292         #define BIT_EXTRACT_FLAG_1(bit, value)  BV(bit)
 293         #define BIT_EXTRACT_VALUE__(bit, value) value
 294
 295         #define BIT_MASK_SINGLE__(use_bv, index, max, arg) \
 296                 ((index < max) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
 297                 /* */
 298
 299         #define BIT_MASK_IF_SINGLE__(use_bv, index, max, arg) \
 300                 (((index < max) && (BIT_EXTRACT_VALUE__ arg)) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
 301                 /* */
 302
 303         #define BIT_ITER__2(macro, use_bv, max, a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15, ...) \
 304                 (macro(use_bv, 0, max, a0) | \
 305                 macro(use_bv, 1, max, a1) | \
 306                 macro(use_bv, 2, max, a2) | \
 307                 macro(use_bv, 3, max, a3) | \
 308                 macro(use_bv, 4, max, a4) | \
 309                 macro(use_bv, 5, max, a5) | \
 310                 macro(use_bv, 6, max, a6) | \
 311                 macro(use_bv, 7, max, a7) | \
 312                 macro(use_bv, 8, max, a8) | \
 313                 macro(use_bv, 9, max, a9) | \
 314                 macro(use_bv, 10, max, a10) | \
 315                 macro(use_bv, 11, max, a11) | \
 316                 macro(use_bv, 12, max, a12) | \
 317                 macro(use_bv, 13, max, a13) | \
 318                 macro(use_bv, 14, max, a14) | \
 319                 macro(use_bv, 15, max, a15)) \
 320                 /* */
 321
 322         #define BIT_ITER__(macro, use_bv, ...) \
 323                 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)) \
 324                 /* */
 325
 326         #define BIT_MASKS__(use_bv, ...) \
 327                 BIT_ITER__(BIT_MASK_SINGLE__, use_bv, __VA_ARGS__)
 328                 /* */
 329
 330         #define BIT_MASKS_CONDITIONAL__(use_bv, ...) \
 331                 BIT_ITER__(BIT_MASK_IF_SINGLE__, use_bv, __VA_ARGS__)
 332                 /* */
 333
 334         #define BIT_CHANGE__(reg, use_bv, ...) \
 335                 ((reg) = ((reg) & ~BIT_MASKS__(use_bv, __VA_ARGS__)) | BIT_MASKS_CONDITIONAL__(use_bv, __VA_ARGS__)) \
 336                 /* */
 337
 338         #define BIT_CHANGE(reg, ...)        BIT_CHANGE__(reg, 0, __VA_ARGS__)
 339         #define BIT_CHANGE_BV(reg, ...)     BIT_CHANGE__(reg, 1, __VA_ARGS__)
 340
 341 #endif /* COMPILER_VARIADIC_MACROS */
 342
 343 /**
 344  * Macro for rotating bit left or right.
 345  * \{
 346  */
 347 #define ROTR(var, rot) (((var) >> (rot)) | ((var) << ((sizeof(var) * 8) - (rot))))
 348 #define ROTL(var, rot) (((var) << (rot)) | ((var) >> ((sizeof(var) * 8) - (rot))))
 349 /*\}*/
 350
 351 /**
 352  * Make an id from 4 letters, useful for
 353  * file formats and kfile ids.
 354  */
 355 #define MAKE_ID(a,b,c,d) \
 356         ( ((uint32_t)(a) << 24) \
 357         | ((uint32_t)(b) << 16) \
 358         | ((uint32_t)(c) <<  8) \
 359         | ((uint32_t)(d) <<  0) )
 360
 361 /**
 362  * Type for id generated by MAKE_ID().
 363  */
 364 typedef uint32_t id_t;
 365
 366 /** \} */ //defgroup macros
 367
 368 #endif /* MACROS_H */
 369