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