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.37 2004/12/08 09:43:21 bernie
18 *#* Metrowerks supports variadic macros.
20 *#* Revision 1.36 2004/12/08 08:55:54 bernie
21 *#* Rename sigset_t to sigmask_t and time_t to mtime_t, to avoid conflicts with POSIX definitions.
23 *#* Revision 1.35 2004/12/08 07:35:51 bernie
24 *#* Typo in macro name.
26 *#* Revision 1.34 2004/11/28 23:21:33 bernie
27 *#* Use mtime_t instead of overloading ANSI time_t with new semantics.
29 *#* Revision 1.33 2004/11/16 23:09:40 bernie
30 *#* size_t: Add 64bit definitions; time_t: Add 16bit hack for tiny CPUs.
32 *#* Revision 1.32 2004/11/16 22:42:44 bernie
35 *#* Revision 1.31 2004/11/16 22:37:28 bernie
36 *#* IPTR: Remove obsolete definition.
38 *#* Revision 1.30 2004/11/16 22:30:19 bernie
39 *#* Declare fixed-size types before other types.
41 *#* Revision 1.29 2004/11/16 20:34:40 bernie
42 *#* UNUSED_VAR, USED_VAR, USED_FUNC: New macros; UNUSED_ARG: Rename from UNUSED.
44 *#* Revision 1.28 2004/10/21 11:03:52 bernie
47 *#* Revision 1.27 2004/10/21 10:09:40 bernie
48 *#* Remove spurious token in preprocessor directive.
50 *#* Revision 1.26 2004/10/19 08:55:14 bernie
51 *#* UNUSED_FUNC: New function attribute.
53 *#* Revision 1.25 2004/10/19 07:14:20 bernie
54 *#* Add macros to test for specific compiler features.
56 *#* Revision 1.24 2004/10/03 18:35:13 bernie
57 *#* Poison C++ keywords in C programs for better portability.
59 *#* Revision 1.23 2004/09/20 03:30:27 bernie
60 *#* Remove vsprintf_P() proto, no longer needed with avr-libc 1.0.4.
62 *#* Revision 1.22 2004/09/14 21:03:04 bernie
63 *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
65 *#* Revision 1.21 2004/09/06 21:38:31 bernie
66 *#* Misc documentation and style fixes.
68 *#* Revision 1.20 2004/08/29 21:57:58 bernie
69 *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
70 *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
72 *#* Revision 1.19 2004/08/25 14:12:08 rasky
73 *#* Aggiornato il comment block dei log RCS
75 *#* Revision 1.18 2004/08/24 16:32:37 bernie
76 *#* Document custom types.
78 *#* Revision 1.17 2004/08/24 13:32:14 bernie
79 *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
80 *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
82 *#* Rename header guards;
83 *#* Don't include arch_config.h in compiler.h as it's not needed there.
85 *#* Revision 1.16 2004/08/14 19:37:57 rasky
86 *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
88 *#* Revision 1.15 2004/08/13 03:23:26 bernie
89 *#* Adjust a few MSVC tweaks from older projects.
91 *#* Revision 1.14 2004/08/10 06:56:29 bernie
92 *#* RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
94 *#* Revision 1.13 2004/08/02 20:20:29 aleph
95 *#* Merge from project_ks
97 *#* Revision 1.12 2004/08/01 01:21:17 bernie
98 *#* LIKELY(), UNLIKELY(): New compiler-specific macros.
100 *#* Revision 1.11 2004/07/30 14:34:10 rasky
101 *#* Vari fix per documentazione e commenti
102 *#* Aggiunte PP_CATn e STATIC_ASSERT
104 *#* Revision 1.10 2004/07/30 14:15:53 rasky
105 *#* Nuovo supporto unificato per detect della CPU
107 *#* Revision 1.9 2004/07/29 22:57:09 bernie
108 *#* vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
110 #ifndef DEVLIB_COMPILER_H
111 #define DEVLIB_COMPILER_H
113 #include "cpu_detect.h"
116 #if defined __GNUC__ && defined __GNUC_MINOR__
117 #define GNUC_PREREQ(maj, min) \
118 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
120 #define GNUC_PREREQ(maj, min) 0
123 /* Some CW versions do not allow enabling C99 from the settings panel. */
124 #if defined(__MWERKS__)
128 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
129 #define COMPILER_C99 1
131 #define COMPILER_C99 0
135 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
136 #define PP_CAT(x,y) PP_CAT__(x,y)
137 #define PP_CAT__(x,y) x ## y
138 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
139 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
140 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
142 /*! String-ize a token (allowing macros to expand) */
143 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
144 #define PP_STRINGIZE__(x) #x
147 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
148 #pragma language=extended
149 #define INTERRUPT(x) interrupt [x]
150 #define REGISTER shortad
151 #define INLINE /* unsupported */
153 /* Imported from <longjmp.h>. Unfortunately, we can't just include
154 * this header because it typedefs jmp_buf to be an array of chars.
155 * This would allow the compiler to place the buffer on an odd address.
156 * The CPU _should_ be able to perform word accesses to
157 * unaligned data, but there are *BUGS* in the 80196KC with
158 * some combinations of opcodes and addressing modes. One of
159 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
160 * provided by the IAR compiler ANSI C library. When ?GR contains
161 * an odd address, surprisingly the CPU will copy the high order
162 * byte of the source operand (SP) in the low order byte of the
163 * destination operand (the memory location pointed to by ?GR).
165 * We also need to replace the library setjmp()/longjmp() with
166 * our own versions because the IAR implementation "forgets" to
167 * save the contents of local registers (?LR).
171 void * sp; /* Stack pointer */
172 void * return_addr; /* Return address */
173 int lr[6]; /* 6 local registers */
176 typedef struct _JMP_BUF jmp_buf[1];
178 int setjmp(jmp_buf env);
179 void longjmp(jmp_buf env, int val);
181 /* Fake bool support */
184 typedef unsigned char bool;
186 #elif defined(_MSC_VER) /* Win32 emulation support */
190 /* FIXME: I can't remember why exactly this was needed (NdBernie) */
193 /* Fake bool support */
198 #endif /* !__cplusplus */
200 /* These C99 functions are oddly named in MSVCRT32.lib */
201 #define snprintf _snprintf
202 #define vsnprintf _vsnprintf
204 #elif defined(__GNUC__)
206 /* Compiler features */
207 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
208 #define COMPILER_TYPEOF 1
209 #define COMPILER_STATEMENT_EXPRESSIONS 1
212 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
213 #define NORETURN __attribute__((__noreturn__))
214 #define UNUSED_ARG(type,arg) __attribute__((__unused__)) type arg
215 #define UNUSED_VAR(type,name) __attribute__((__unused__)) type name
216 #define USED_VAR(type,name) __attribute__((__used__)) type name
217 #define INLINE static inline __attribute__((__always_inline__))
218 #define LIKELY(x) __builtin_expect(!!(x), 1)
219 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
220 #define PURE_FUNC __attribute__((pure))
221 #define CONST_FUNC __attribute__((const))
222 #define UNUSED_FUNC __attribute__((unused))
223 #define USED_FUNC __attribute__((__used__))
224 #define RESTRICT __restrict__
225 #define MUST_CHECK __attribute__((warn_unused_result))
227 #define DEPRECATED __attribute__((__deprecated__))
241 /* Support for harvard architectures */
243 #define PGM_READ_CHAR(s) pgm_read_byte(s)
244 #define PGM_FUNC(x) x ## _P
245 #define PGM_ATTR PROGMEM
252 * Disallow some C++ keywords as identifiers in C programs,
253 * for improved portability.
255 #pragma GCC poison new delete class template typename
256 #pragma GCC poison private protected public operator
257 #pragma GCC poison friend mutable using namespace
258 #pragma GCC poison cin cout cerr clog
261 #elif defined(__MWERKS__) && CPU_DSP56K
263 /* Compiler features */
264 #define COMPILER_VARIADIC_MACROS 1
265 #define COMPILER_TYPEOF 1
266 #define COMPILER_STATEMENT_EXPRESSIONS 1
273 // CodeWarrior has size_t as built-in type, but does not define this symbol.
274 #define _SIZE_T_DEFINED
277 #error unknown compiler
281 /* Defaults for compiler extensions. */
284 * \def COMPILER_VARIADIC_MACROS
285 * Support for macros with variable arguments.
287 #ifndef COMPILER_VARIADIC_MACROS
288 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
292 * \def COMPILER_TYPEOF
293 * Support for macros with variable arguments.
295 #ifndef COMPILER_TYPEOF
296 #define COMPILER_TYPEOF 0
300 * \def COMPILER_STATEMENT_EXPRESSIONS
301 * Support for macros with variable arguments.
303 #ifndef COMPILER_STATEMENT_EXPRESSIONS
304 #define COMPILER_STATEMENT_EXPRESSIONS 0
307 /* A few defaults for missing compiler features. */
309 #define INLINE static inline
312 #define NORETURN /* nothing */
315 #define FORMAT(type,fmt,first) /* nothing */
318 #define DEPRECATED /* nothing */
321 #define UNUSED_ARG(type,arg) type arg
323 #define UNUSED UNUSED_ARG /* OBSOLETE */
325 #define UNUSED_VAR(type,name) type name
328 #define USED_VAR(type,name) type name
331 #define REGISTER /* nothing */
334 #define INTERRUPT(x) ERROR_NOT_IMPLEMENTED
340 #define UNLIKELY(x) x
343 #define PURE_FUNC /* nothing */
346 #define CONST_FUNC /* nothing */
349 #define UNUSED_FUNC /* nothing */
352 #define USED_FUNC /* nothing */
355 #define RESTRICT /* nothing */
358 #define MUST_CHECK /* nothing */
361 /* Support for harvard architectures */
363 #define PSTR /* nothing */
365 #ifndef PGM_READ_CHAR
366 #define PGM_READ_CHAR(s) (*(s))
369 #define PGM_FUNC(x) x
372 #define PGM_ATTR /* nothing */
376 /* Misc definitions */
378 #define NULL (void *)0
385 /* Support for hybrid C/C++ applications. */
387 #define EXTERN_C extern "C"
388 #define EXTERN_C_BEGIN extern "C" {
389 #define EXTERN_C_END }
391 #define EXTERN_C extern
392 #define EXTERN_C_BEGIN /* nothing */
393 #define EXTERN_C_END /* nothing */
397 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
399 * \name ISO C99 fixed-size types
401 * These should be in <stdint.h>, but many compilers lack them.
404 typedef signed char int8_t;
405 typedef short int int16_t;
406 typedef long int int32_t;
407 typedef unsigned char uint8_t;
408 typedef unsigned short int uint16_t;
409 typedef unsigned long int uint32_t;
411 #elif defined(__GNUC__) && CPU_AVR
412 /* avr-libc is weird... */
413 #include <inttypes.h>
415 /* This is the correct location. */
422 * The ATmega8 has a very small Flash, so we can't afford
423 * to link in support routines for 32bit integer arithmetic.
425 typedef int16_t mtime_t; /*!< Type for time expressed in milliseconds. */
426 typedef int16_t utime_t; /*!< Type for time expressed in microseconds. */
427 #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
428 #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
430 typedef int32_t mtime_t; /*!< Type for time expressed in milliseconds. */
431 typedef int32_t utime_t; /*!< Type for time expressed in microseconds. */
432 #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
433 #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
436 /*! Bulk storage large enough for both pointers or integers. */
437 typedef void * iptr_t;
438 typedef const void * const_iptr_t;
440 typedef unsigned char sig_t; /*!< Type for signal bits. */
441 typedef unsigned char sigmask_t; /*!< Type for signal masks. */
442 typedef unsigned char page_t; /*!< Type for banked memory pages. */
446 * \name Standard type definitions.
448 * These should be in <sys/types.h>, but many compilers lack them.
452 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
453 #if CPU_REG_BITS > 32
455 typedef unsigned long size_t;
456 typedef long ssize_t;
458 /* 32bit or 16bit. */
459 typedef unsigned int size_t;
464 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined) || defined(_EMUL))
465 /*! For backwards compatibility. Use mtime_t in new code. */
466 #define time_t mtime_t
467 #define SIZEOF_TIME_T SIZEOF_MTIME_T
469 /* Just a guess, but quite safe. */
470 #define SIZEOF_TIME_T SIZEOF_LONG
471 #endif /* _TIME_T_DEFINED || __time_t_defined */
476 * \name Types for hardware registers.
478 * Only use these types for registers whose contents can
479 * be changed asynchronously by external hardware.
484 /* Registers can be accessed only through 16-bit pointers */
485 typedef volatile uint16_t reg16_t;
487 typedef volatile uint8_t reg8_t;
488 typedef volatile uint16_t reg16_t;
489 typedef volatile uint32_t reg32_t;
494 /* Quasi-ANSI macros */
497 * Return the byte offset of the member \a m in struct \a s.
499 * \note This macro should be defined in "stddef.h" and is sometimes
500 * compiler-specific (g++ has a builtin for it).
502 #define offsetof(s,m) (size_t)&(((s *)0)->m)
506 * Count the number of elements in the static array \a a.
508 * \note This macro is non-standard, but implements a very common idiom
510 #define countof(a) (sizeof(a) / sizeof(*(a)))
513 /*! Issue a compilation error if the \a condition is false */
514 #define STATIC_ASSERT(condition) \
515 UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
517 #endif /* DEVLIB_COMPILER_H */