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