4 * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 2001, 2002, 2003 Bernardo Innocenti <bernie@codewiz.org>
6 * This file is part of DevLib - See devlib/README for information.
9 * \brief Additional support macros for compiler independance
12 * \author Bernardo Innocenti <bernie@develer.com>
17 *#* Revision 1.40 2005/01/20 18:46:04 aleph
18 *#* Add progmem datatypes; PSTR() definition.
20 *#* Revision 1.39 2005/01/08 08:49:39 bernie
21 *#* Define PROGMEM on AVR only when not including pgmspace.h.
23 *#* Revision 1.38 2004/12/31 16:41:52 bernie
24 *#* PROGMEM: Define to nothing for non-Harvard processors.
26 *#* Revision 1.37 2004/12/08 09:43:21 bernie
27 *#* Metrowerks supports variadic macros.
29 *#* Revision 1.36 2004/12/08 08:55:54 bernie
30 *#* Rename sigset_t to sigmask_t and time_t to mtime_t, to avoid conflicts with POSIX definitions.
32 *#* Revision 1.35 2004/12/08 07:35:51 bernie
33 *#* Typo in macro name.
35 *#* Revision 1.34 2004/11/28 23:21:33 bernie
36 *#* Use mtime_t instead of overloading ANSI time_t with new semantics.
38 *#* Revision 1.33 2004/11/16 23:09:40 bernie
39 *#* size_t: Add 64bit definitions; time_t: Add 16bit hack for tiny CPUs.
41 *#* Revision 1.32 2004/11/16 22:42:44 bernie
44 *#* Revision 1.31 2004/11/16 22:37:28 bernie
45 *#* IPTR: Remove obsolete definition.
47 *#* Revision 1.30 2004/11/16 22:30:19 bernie
48 *#* Declare fixed-size types before other types.
50 *#* Revision 1.29 2004/11/16 20:34:40 bernie
51 *#* UNUSED_VAR, USED_VAR, USED_FUNC: New macros; UNUSED_ARG: Rename from UNUSED.
53 *#* Revision 1.28 2004/10/21 11:03:52 bernie
56 *#* Revision 1.27 2004/10/21 10:09:40 bernie
57 *#* Remove spurious token in preprocessor directive.
59 *#* Revision 1.26 2004/10/19 08:55:14 bernie
60 *#* UNUSED_FUNC: New function attribute.
62 *#* Revision 1.25 2004/10/19 07:14:20 bernie
63 *#* Add macros to test for specific compiler features.
65 *#* Revision 1.24 2004/10/03 18:35:13 bernie
66 *#* Poison C++ keywords in C programs for better portability.
68 *#* Revision 1.23 2004/09/20 03:30:27 bernie
69 *#* Remove vsprintf_P() proto, no longer needed with avr-libc 1.0.4.
71 *#* Revision 1.22 2004/09/14 21:03:04 bernie
72 *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
74 *#* Revision 1.21 2004/09/06 21:38:31 bernie
75 *#* Misc documentation and style fixes.
77 *#* Revision 1.20 2004/08/29 21:57:58 bernie
78 *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
79 *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
81 *#* Revision 1.19 2004/08/25 14:12:08 rasky
82 *#* Aggiornato il comment block dei log RCS
84 *#* Revision 1.18 2004/08/24 16:32:37 bernie
85 *#* Document custom types.
87 *#* Revision 1.17 2004/08/24 13:32:14 bernie
88 *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
89 *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
91 *#* Rename header guards;
92 *#* Don't include arch_config.h in compiler.h as it's not needed there.
94 *#* Revision 1.16 2004/08/14 19:37:57 rasky
95 *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
97 *#* Revision 1.15 2004/08/13 03:23:26 bernie
98 *#* Adjust a few MSVC tweaks from older projects.
100 *#* Revision 1.14 2004/08/10 06:56:29 bernie
101 *#* RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
103 *#* Revision 1.13 2004/08/02 20:20:29 aleph
104 *#* Merge from project_ks
106 *#* Revision 1.12 2004/08/01 01:21:17 bernie
107 *#* LIKELY(), UNLIKELY(): New compiler-specific macros.
109 *#* Revision 1.11 2004/07/30 14:34:10 rasky
110 *#* Vari fix per documentazione e commenti
111 *#* Aggiunte PP_CATn e STATIC_ASSERT
113 *#* Revision 1.10 2004/07/30 14:15:53 rasky
114 *#* Nuovo supporto unificato per detect della CPU
116 *#* Revision 1.9 2004/07/29 22:57:09 bernie
117 *#* vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
119 #ifndef DEVLIB_COMPILER_H
120 #define DEVLIB_COMPILER_H
122 #include "cpu_detect.h"
125 #if defined __GNUC__ && defined __GNUC_MINOR__
126 #define GNUC_PREREQ(maj, min) \
127 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
129 #define GNUC_PREREQ(maj, min) 0
132 /* Some CW versions do not allow enabling C99 from the settings panel. */
133 #if defined(__MWERKS__)
137 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
138 #define COMPILER_C99 1
140 #define COMPILER_C99 0
144 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
145 #define PP_CAT(x,y) PP_CAT__(x,y)
146 #define PP_CAT__(x,y) x ## y
147 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
148 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
149 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
151 /*! String-ize a token (allowing macros to expand) */
152 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
153 #define PP_STRINGIZE__(x) #x
156 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
157 #pragma language=extended
158 #define INTERRUPT(x) interrupt [x]
159 #define REGISTER shortad
160 #define INLINE /* unsupported */
163 * Imported from <longjmp.h>. Unfortunately, we can't just include
164 * this header because it typedefs jmp_buf to be an array of chars.
165 * This would allow the compiler to place the buffer on an odd address.
166 * The CPU _should_ be able to perform word accesses to
167 * unaligned data, but there are *BUGS* in the 80196KC with
168 * some combinations of opcodes and addressing modes. One of
169 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
170 * provided by the IAR compiler ANSI C library. When ?GR contains
171 * an odd address, surprisingly the CPU will copy the high order
172 * byte of the source operand (SP) in the low order byte of the
173 * destination operand (the memory location pointed to by ?GR).
175 * We also need to replace the library setjmp()/longjmp() with
176 * our own versions because the IAR implementation "forgets" to
177 * save the contents of local registers (?LR).
181 void *sp; /* Stack pointer */
182 void *return_addr; /* Return address */
183 int lr[6]; /* 6 local registers */
186 typedef struct _JMP_BUF jmp_buf[1];
188 int setjmp(jmp_buf env);
189 void longjmp(jmp_buf env, int val);
191 /* Fake bool support */
194 typedef unsigned char bool;
196 #elif defined(_MSC_VER) /* Win32 emulation support */
200 /* FIXME: I can't remember why exactly this was needed (NdBernie) */
203 /* MSVC doesn't provide <stdbool.h>. */
208 #endif /* !__cplusplus */
210 /* These C99 functions are oddly named in MSVCRT32.lib */
211 #define snprintf _snprintf
212 #define vsnprintf _vsnprintf
214 #elif defined(__GNUC__)
216 /* Compiler features */
217 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
218 #define COMPILER_TYPEOF 1
219 #define COMPILER_STATEMENT_EXPRESSIONS 1
222 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
223 #define NORETURN __attribute__((__noreturn__))
224 #define UNUSED_ARG(type,arg) __attribute__((__unused__)) type arg
225 #define UNUSED_VAR(type,name) __attribute__((__unused__)) type name
226 #define USED_VAR(type,name) __attribute__((__used__)) type name
227 #define INLINE static inline __attribute__((__always_inline__))
228 #define LIKELY(x) __builtin_expect(!!(x), 1)
229 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
230 #define PURE_FUNC __attribute__((pure))
231 #define CONST_FUNC __attribute__((const))
232 #define UNUSED_FUNC __attribute__((unused))
233 #define USED_FUNC __attribute__((__used__))
234 #define RESTRICT __restrict__
235 #define MUST_CHECK __attribute__((warn_unused_result))
237 #define DEPRECATED __attribute__((__deprecated__))
251 /* Support for harvard architectures */
253 #include <avr/pgmspace.h>
254 #define PGM_READ_CHAR(s) pgm_read_byte(s)
255 #define PGM_FUNC(x) x ## _P
256 #define PGM_ATTR PROGMEM
258 /* We still need this for prototypes */
259 #define PROGMEM __attribute__((__progmem__))
260 #define PSTR(s) ({static char __c[] PROGMEM = (s); __c;})
267 * Disallow some C++ keywords as identifiers in C programs,
268 * for improved portability.
270 #pragma GCC poison new delete class template typename
271 #pragma GCC poison private protected public operator
272 #pragma GCC poison friend mutable using namespace
273 #pragma GCC poison cin cout cerr clog
276 #elif defined(__MWERKS__) && CPU_DSP56K
278 /* Compiler features */
279 #define COMPILER_VARIADIC_MACROS 1
280 #define COMPILER_TYPEOF 1
281 #define COMPILER_STATEMENT_EXPRESSIONS 1
288 // CodeWarrior has size_t as built-in type, but does not define this symbol.
289 #define _SIZE_T_DEFINED
292 #error unknown compiler
296 /* Defaults for compiler extensions. */
299 * \def COMPILER_VARIADIC_MACROS
300 * Support for macros with variable arguments.
302 #ifndef COMPILER_VARIADIC_MACROS
303 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
307 * \def COMPILER_TYPEOF
308 * Support for macros with variable arguments.
310 #ifndef COMPILER_TYPEOF
311 #define COMPILER_TYPEOF 0
315 * \def COMPILER_STATEMENT_EXPRESSIONS
316 * Support for macros with variable arguments.
318 #ifndef COMPILER_STATEMENT_EXPRESSIONS
319 #define COMPILER_STATEMENT_EXPRESSIONS 0
322 /* A few defaults for missing compiler features. */
324 #define INLINE static inline
327 #define NORETURN /* nothing */
330 #define FORMAT(type,fmt,first) /* nothing */
333 #define DEPRECATED /* nothing */
336 #define UNUSED_ARG(type,arg) type arg
338 #define UNUSED UNUSED_ARG /* OBSOLETE */
340 #define UNUSED_VAR(type,name) type name
343 #define USED_VAR(type,name) type name
346 #define REGISTER /* nothing */
349 #define PROGMEM /* nothing */
352 #define INTERRUPT(x) ERROR_NOT_IMPLEMENTED
358 #define UNLIKELY(x) x
361 #define PURE_FUNC /* nothing */
364 #define CONST_FUNC /* nothing */
367 #define UNUSED_FUNC /* nothing */
370 #define USED_FUNC /* nothing */
373 #define RESTRICT /* nothing */
376 #define MUST_CHECK /* nothing */
379 /* Support for harvard architectures */
381 #define PSTR /* nothing */
383 #ifndef PGM_READ_CHAR
384 #define PGM_READ_CHAR(s) (*(s))
387 #define PGM_FUNC(x) x
390 #define PGM_ATTR /* nothing */
393 /* Misc definitions */
395 #define NULL (void *)0
402 /* Support for hybrid C/C++ applications. */
404 #define EXTERN_C extern "C"
405 #define EXTERN_C_BEGIN extern "C" {
406 #define EXTERN_C_END }
408 #define EXTERN_C extern
409 #define EXTERN_C_BEGIN /* nothing */
410 #define EXTERN_C_END /* nothing */
414 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
416 * \name ISO C99 fixed-size types
418 * These should be in <stdint.h>, but many compilers lack them.
421 typedef signed char int8_t;
422 typedef short int int16_t;
423 typedef long int int32_t;
424 typedef unsigned char uint8_t;
425 typedef unsigned short int uint16_t;
426 typedef unsigned long int uint32_t;
428 #elif defined(__GNUC__) && CPU_AVR
429 /* avr-libc is weird... */
430 #include <inttypes.h>
432 /* This is the correct location. */
437 * \name Types for variables stored in program memory (harvard processors).
440 typedef PROGMEM int8_t pgm_int8_t;
441 typedef PROGMEM uint8_t pgm_uint8_t;
442 typedef PROGMEM int16_t pgm_int16_t;
443 typedef PROGMEM uint16_t pgm_uint16_t;
444 typedef PROGMEM int32_t pgm_int32_t;
445 typedef PROGMEM uint32_t pgm_uint32_t;
450 * The ATmega8 has a very small Flash, so we can't afford
451 * to link in support routines for 32bit integer arithmetic.
453 typedef int16_t mtime_t; /*!< Type for time expressed in milliseconds. */
454 typedef int16_t utime_t; /*!< Type for time expressed in microseconds. */
455 #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
456 #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
458 typedef int32_t mtime_t; /*!< Type for time expressed in milliseconds. */
459 typedef int32_t utime_t; /*!< Type for time expressed in microseconds. */
460 #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
461 #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
464 /*! Bulk storage large enough for both pointers or integers. */
465 typedef void * iptr_t;
466 typedef const void * const_iptr_t;
468 typedef unsigned char sig_t; /*!< Type for signal bits. */
469 typedef unsigned char sigmask_t; /*!< Type for signal masks. */
470 typedef unsigned char page_t; /*!< Type for banked memory pages. */
474 * \name Standard type definitions.
476 * These should be in <sys/types.h>, but many compilers lack them.
480 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
481 #if CPU_REG_BITS > 32
483 typedef unsigned long size_t;
484 typedef long ssize_t;
486 /* 32bit or 16bit. */
487 typedef unsigned int size_t;
492 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined) || defined(_EMUL))
493 /*! For backwards compatibility. Use mtime_t in new code. */
494 #define time_t mtime_t
495 #define SIZEOF_TIME_T SIZEOF_MTIME_T
497 /* Just a guess, but quite safe. */
498 #define SIZEOF_TIME_T SIZEOF_LONG
499 #endif /* _TIME_T_DEFINED || __time_t_defined */
504 * \name Types for hardware registers.
506 * Only use these types for registers whose contents can
507 * be changed asynchronously by external hardware.
512 /* Registers can be accessed only through 16-bit pointers */
513 typedef volatile uint16_t reg16_t;
515 typedef volatile uint8_t reg8_t;
516 typedef volatile uint16_t reg16_t;
517 typedef volatile uint32_t reg32_t;
522 /* Quasi-ANSI macros */
525 * Return the byte offset of the member \a m in struct \a s.
527 * \note This macro should be defined in "stddef.h" and is sometimes
528 * compiler-specific (g++ has a builtin for it).
530 #define offsetof(s,m) (size_t)&(((s *)0)->m)
534 * Count the number of elements in the static array \a a.
536 * \note This macro is non-standard, but implements a very common idiom
538 #define countof(a) (sizeof(a) / sizeof(*(a)))
541 /*! Issue a compilation error if the \a condition is false */
542 #define STATIC_ASSERT(condition) \
543 UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
545 #endif /* DEVLIB_COMPILER_H */