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