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 is evaluated twice.
 196  */
 197 #define DIV_ROUNDUP(dividend, divisor)  (((dividend) + (divisor) - 1) / (divisor))
 198
 199
 200 /**
 201  * Perform a multiply between the integer \a a and the float constant \a f.
 202  *
 203  * This macro can be used in order to avoid floating point arithmetics
 204  * in expressions like this:
 205  * \code
 206  * int a, b;
 207  * a = b * 0.5579652750;
 208  * \endcode
 209  *
 210  * This macro rounds the floating point constant to a fraction,
 211  * usign (2 ^ prec) as the denominator.
 212  * For instance, with prec = 8, the constant 0.5579652750 will be rounded to:
 213  * (143 / 256) = 0.55859375
 214  * So, the former code will be transformed to:
 215  * \code
 216  * a = b * 143 / 256;
 217  * \endcode
 218  *
 219  * Since the denominator is a power of 2, we rely on the compiler to optimize
 220  * this to a right shift.
 221  * So, when you have to multiply an integer by a float constant, this macro
 222  * will not use the floating point arithmentics.
 223  * The operation will be converted to a mul + shift, with a huge performance boost.
 224  *
 225  * \note \a f MUST be a constant in order gain performance benefits.
 226  *
 227  * \param a integer you want to multiply
 228  * \param f floating point constant which you want to multply with \a a
 229  * \param prec conversion precision, ranges from 1 to the number of bits in a long.
 230  *             The higher, the better the approximation of the float constant will be.
 231  */
 232 #define INT_MULT(a, f, prec) (((a) * (long)((f) * (1 << (prec)) + 0.5)) >> (prec))
 233
 234
 235 /** Round up \a x to an even multiple of the 2's power \a pad. */
 236 #define ROUND_UP2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
 237
 238 /**
 239  * \name Integer round macros.
 240  *
 241  * Round \a x to a multiple of \a base.
 242  * \note If \a x is signed these macros generate a lot of code.
 243  * \{
 244  */
 245 #define ROUND_DOWN(x, base)    ( (x) - ((x) % (base)) )
 246 #define ROUND_UP(x, base)      ( ((x) + (base) - 1) - (((x) + (base) - 1) % (base)) )
 247 #define ROUND_NEAREST(x, base) ( ((x) + (base) / 2) - (((x) + (base) / 2) % (base)) )
 248 /* \} */
 249
 250 /** Check if \a x is an integer power of 2. */
 251 #define IS_POW2(x)     (!(bool)((x) & ((x)-1)))
 252
 253 /** Calculate a compile-time log2 for a uint8_t */
 254 #define UINT8_LOG2(x) \
 255         ((x) < 2 ? 0 : \
 256          ((x) < 4 ? 1 : \
 257           ((x) < 8 ? 2 : \
 258            ((x) < 16 ? 3 : \
 259             ((x) < 32 ? 4 : \
 260              ((x) < 64 ? 5 : \
 261               ((x) < 128 ? 6 : 7)))))))
 262
 263 /** Calculate a compile-time log2 for a uint16_t */
 264 #define UINT16_LOG2(x) \
 265         ((x < 256) ? UINT8_LOG2(x) : UINT8_LOG2((x) >> 8) + 8)
 266
 267 /** Calculate a compile-time log2 for a uint32_t */
 268 #define UINT32_LOG2(x) \
 269         ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 270
 271 #if COMPILER_VARIADIC_MACROS
 272         /** Count the number of arguments (up to 16). */
 273         #define PP_COUNT(...) \
 274                 PP_COUNT__(__VA_ARGS__,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
 275         #define PP_COUNT__(a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,count,...) \
 276                 count
 277 #endif
 278
 279 #if COMPILER_VARIADIC_MACROS
 280         /**
 281          * \def BIT_CHANGE(reg, (mask, value), ...)
 282          *
 283          * This macro allows for efficient and compact bit toggling in a hardware
 284          * register. It is meant to replace hand-coded cruft which toggles bits
 285          * in sequence.
 286          *
 287          * It is possible to specify an unlimited pair of (mask, value) parameters.
 288          * For instance:
 289          *
 290          * \code
 291          * void set_timer(bool start)
 292          * {
 293          *     BIT_CHANGE(REG_CTRL_TIMER,
 294          *        (TIMER_MODE, MODE_COUNT),
 295          *        (OVL_IRQ, 1),
 296          *        (CMP_IRQ, 1),
 297          *        (START, start)
 298          *     );
 299          * }
 300          * \endcode
 301          *
 302          * The macro expansion will be roughly the following:
 303          *
 304          * \code
 305          * REG_CTRL_TIMER = (REG_CTRL_TIMER & ~(TIMER_MODE|OVL_IRQ|CMP_IRQ|START)
 306          *                  | (MODE_COUNT|OVL_IRQ|CMP_IRQ|(start ? START : 0));
 307          * \endcode
 308          *
 309          * It is up to the compiler to produce the optimal code. We checked that GCC produces
 310          * the best code in most cases. We preferred this expansion over the use of a block
 311          * with a local variable because CodeWarrior 6.1 was not able to remove completely the
 312          * allocation of the local from the stack.
 313          *
 314          * \note This macro is available only in C99 because it makes use of variadic macros.
 315          * It would be possible to make up an implementation with a slightly different syntax
 316          * for use with C90 compilers, through Boost Preprocessor.
 317          */
 318
 319         /**
 320          * \def BIT_CHANGE_BV(reg, (bit, value), ...)
 321          *
 322          * Similar to BIT_CHANGE(), but get bits instead of masks (and applies BV() to convert
 323          * them to masks).
 324          */
 325
 326         #define BIT_EXTRACT_FLAG_0(bit, value)  bit
 327         #define BIT_EXTRACT_FLAG_1(bit, value)  BV(bit)
 328         #define BIT_EXTRACT_VALUE__(bit, value) value
 329
 330         #define BIT_MASK_SINGLE__(use_bv, index, max, arg) \
 331                 ((index < max) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
 332                 /* */
 333
 334         #define BIT_MASK_IF_SINGLE__(use_bv, index, max, arg) \
 335                 (((index < max) && (BIT_EXTRACT_VALUE__ arg)) ? (PP_CAT(BIT_EXTRACT_FLAG_, use_bv) arg) : 0) \
 336                 /* */
 337
 338         #define BIT_ITER__2(macro, use_bv, max, a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15, ...) \
 339                 (macro(use_bv, 0, max, a0) | \
 340                 macro(use_bv, 1, max, a1) | \
 341                 macro(use_bv, 2, max, a2) | \
 342                 macro(use_bv, 3, max, a3) | \
 343                 macro(use_bv, 4, max, a4) | \
 344                 macro(use_bv, 5, max, a5) | \
 345                 macro(use_bv, 6, max, a6) | \
 346                 macro(use_bv, 7, max, a7) | \
 347                 macro(use_bv, 8, max, a8) | \
 348                 macro(use_bv, 9, max, a9) | \
 349                 macro(use_bv, 10, max, a10) | \
 350                 macro(use_bv, 11, max, a11) | \
 351                 macro(use_bv, 12, max, a12) | \
 352                 macro(use_bv, 13, max, a13) | \
 353                 macro(use_bv, 14, max, a14) | \
 354                 macro(use_bv, 15, max, a15)) \
 355                 /* */
 356
 357         #define BIT_ITER__(macro, use_bv, ...) \
 358                 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)) \
 359                 /* */
 360
 361         #define BIT_MASKS__(use_bv, ...) \
 362                 BIT_ITER__(BIT_MASK_SINGLE__, use_bv, __VA_ARGS__)
 363                 /* */
 364
 365         #define BIT_MASKS_CONDITIONAL__(use_bv, ...) \
 366                 BIT_ITER__(BIT_MASK_IF_SINGLE__, use_bv, __VA_ARGS__)
 367                 /* */
 368
 369         #define BIT_CHANGE__(reg, use_bv, ...) \
 370                 ((reg) = ((reg) & ~BIT_MASKS__(use_bv, __VA_ARGS__)) | BIT_MASKS_CONDITIONAL__(use_bv, __VA_ARGS__)) \
 371                 /* */
 372
 373         #define BIT_CHANGE(reg, ...)        BIT_CHANGE__(reg, 0, __VA_ARGS__)
 374         #define BIT_CHANGE_BV(reg, ...)     BIT_CHANGE__(reg, 1, __VA_ARGS__)
 375
 376 #endif /* COMPILER_VARIADIC_MACROS */
 377
 378 /**
 379  * Macro for rotating bit left or right.
 380  * \{
 381  */
 382 #define ROTR(var, rot) (((var) >> (rot)) | ((var) << ((sizeof(var) * 8) - (rot))))
 383 #define ROTL(var, rot) (((var) << (rot)) | ((var) >> ((sizeof(var) * 8) - (rot))))
 384 /*\}*/
 385
 386 /**
 387  * Make an id from 4 letters, useful for
 388  * file formats and kfile ids.
 389  */
 390 #define MAKE_ID(a,b,c,d) \
 391         ( ((uint32_t)(a) << 24) \
 392         | ((uint32_t)(b) << 16) \
 393         | ((uint32_t)(c) <<  8) \
 394         | ((uint32_t)(d) <<  0) )
 395
 396 /**
 397  * Type for id generated by MAKE_ID().
 398  */
 399 typedef uint32_t id_t;
 400
 401 /**
 402  * Check if a pointer is aligned to a certain power-of-2 size
 403  */
 404 INLINE bool is_aligned(const void *addr, size_t size)
 405 {
 406         return ((size_t)addr & (size - 1)) == 0;
 407 }
 408
 409 /**
 410  * Convert one 32bit bcd numbert to int.
 411  */
 412 #define BCD_TO_INT_32BIT(bcd)  \
 413         ((uint32_t )((bcd) & 0xf) * 1 +  \
 414         (((bcd) >> 4) & 0xf)  * 10 +      \
 415         (((bcd) >> 8) & 0xf)  * 100 +     \
 416         (((bcd) >> 12) & 0xf) * 1000 +   \
 417         (((bcd) >> 16) & 0xf) * 10000 +   \
 418         (((bcd) >> 20) & 0xf) * 100000 +  \
 419         (((bcd) >> 24) & 0xf) * 1000000 + \
 420         (((bcd) >> 28) & 0xf) * 10000000) \
 421
 422 /**
 423  * Extract chunk of bit from gived array (uint32_t type).
 424  * \param resp array of bit 32bit aligned
 425  * \param start bit position in array
 426  * \param size of bit chuck from start
 427  * \return uint32_t chunk value.
 428  */
 429 #define UNSTUFF_BITS(resp, start, size)                   \
 430     ({                              \
 431         const uint32_t __size = size;                \
 432         const uint32_t __mask = (__size < 32 ? 1 << __size : 0) - 1; \
 433         const uint32_t __off = 3 - ((start) / 32);           \
 434         const uint32_t __shft = (start) & 31;            \
 435         uint32_t __res;                      \
 436                                     \
 437         __res = resp[__off] >> __shft;              \
 438         if (__size + __shft > 32)               \
 439             __res |= resp[__off-1] << ((32 - __shft) % 32); \
 440         __res & __mask;                     \
 441     })
 442
 443
 444 /** \} */ //defgroup macros
 445
 446 #endif /* MACROS_H */
 447