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.33 2004/11/16 23:09:40 bernie
18 *#* size_t: Add 64bit definitions; time_t: Add 16bit hack for tiny CPUs.
20 *#* Revision 1.32 2004/11/16 22:42:44 bernie
23 *#* Revision 1.31 2004/11/16 22:37:28 bernie
24 *#* IPTR: Remove obsolete definition.
26 *#* Revision 1.30 2004/11/16 22:30:19 bernie
27 *#* Declare fixed-size types before other types.
29 *#* Revision 1.29 2004/11/16 20:34:40 bernie
30 *#* UNUSED_VAR, USED_VAR, USED_FUNC: New macros; UNUSED_ARG: Rename from UNUSED.
32 *#* Revision 1.28 2004/10/21 11:03:52 bernie
35 *#* Revision 1.27 2004/10/21 10:09:40 bernie
36 *#* Remove spurious token in preprocessor directive.
38 *#* Revision 1.26 2004/10/19 08:55:14 bernie
39 *#* UNUSED_FUNC: New function attribute.
41 *#* Revision 1.25 2004/10/19 07:14:20 bernie
42 *#* Add macros to test for specific compiler features.
44 *#* Revision 1.24 2004/10/03 18:35:13 bernie
45 *#* Poison C++ keywords in C programs for better portability.
47 *#* Revision 1.23 2004/09/20 03:30:27 bernie
48 *#* Remove vsprintf_P() proto, no longer needed with avr-libc 1.0.4.
50 *#* Revision 1.22 2004/09/14 21:03:04 bernie
51 *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
53 *#* Revision 1.21 2004/09/06 21:38:31 bernie
54 *#* Misc documentation and style fixes.
56 *#* Revision 1.20 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.
60 *#* Revision 1.19 2004/08/25 14:12:08 rasky
61 *#* Aggiornato il comment block dei log RCS
63 *#* Revision 1.18 2004/08/24 16:32:37 bernie
64 *#* Document custom types.
66 *#* Revision 1.17 2004/08/24 13:32:14 bernie
67 *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
68 *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
70 *#* Rename header guards;
71 *#* Don't include arch_config.h in compiler.h as it's not needed there.
73 *#* Revision 1.16 2004/08/14 19:37:57 rasky
74 *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
76 *#* Revision 1.15 2004/08/13 03:23:26 bernie
77 *#* Adjust a few MSVC tweaks from older projects.
79 *#* Revision 1.14 2004/08/10 06:56:29 bernie
80 *#* RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
82 *#* Revision 1.13 2004/08/02 20:20:29 aleph
83 *#* Merge from project_ks
85 *#* Revision 1.12 2004/08/01 01:21:17 bernie
86 *#* LIKELY(), UNLIKELY(): New compiler-specific macros.
88 *#* Revision 1.11 2004/07/30 14:34:10 rasky
89 *#* Vari fix per documentazione e commenti
90 *#* Aggiunte PP_CATn e STATIC_ASSERT
92 *#* Revision 1.10 2004/07/30 14:15:53 rasky
93 *#* Nuovo supporto unificato per detect della CPU
95 *#* Revision 1.9 2004/07/29 22:57:09 bernie
96 *#* vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
98 #ifndef DEVLIB_COMPILER_H
99 #define DEVLIB_COMPILER_H
101 #include "cpu_detect.h"
104 #if defined __GNUC__ && defined __GNUC_MINOR__
105 #define GNUC_PREREQ(maj, min) \
106 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
108 #define GNUC_PREREQ(maj, min) 0
111 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
112 #define COMPILER_C99 1
114 #define COMPILER_C99 0
118 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
119 #define PP_CAT(x,y) PP_CAT__(x,y)
120 #define PP_CAT__(x,y) x ## y
121 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
122 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
123 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
125 /*! String-ize a token (allowing macros to expand) */
126 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
127 #define PP_STRINGIZE__(x) #x
130 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
131 #pragma language=extended
132 #define INTERRUPT(x) interrupt [x]
133 #define REGISTER shortad
134 #define INLINE /* unsupported */
136 /* Imported from <longjmp.h>. Unfortunately, we can't just include
137 * this header because it typedefs jmp_buf to be an array of chars.
138 * This would allow the compiler to place the buffer on an odd address.
139 * The CPU _should_ be able to perform word accesses to
140 * unaligned data, but there are *BUGS* in the 80196KC with
141 * some combinations of opcodes and addressing modes. One of
142 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
143 * provided by the IAR compiler ANSI C library. When ?GR contains
144 * an odd address, surprisingly the CPU will copy the high order
145 * byte of the source operand (SP) in the low order byte of the
146 * destination operand (the memory location pointed to by ?GR).
148 * We also need to replace the library setjmp()/longjmp() with
149 * our own versions because the IAR implementation "forgets" to
150 * save the contents of local registers (?LR).
154 void * sp; /* Stack pointer */
155 void * return_addr; /* Return address */
156 int lr[6]; /* 6 local registers */
159 typedef struct _JMP_BUF jmp_buf[1];
161 int setjmp(jmp_buf env);
162 void longjmp(jmp_buf env, int val);
164 /* Fake bool support */
167 typedef unsigned char bool;
169 #elif defined(_MSC_VER) /* Win32 emulation support */
172 #include <time.h> /* for time_t */
174 /* FIXME: I can't remember why exactly this was needed (NdBernie) */
177 /* Fake bool support */
182 #endif /* !__cplusplus */
184 /* These C99 functions are oddly named in MSVCRT32.lib */
185 #define snprintf _snprintf
186 #define vsnprintf _vsnprintf
188 #elif defined(__GNUC__)
190 /* Compiler features */
191 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
192 #define COMPILER_TYPEOF 1
193 #define COMPILER_STATEMENT_EXPRESSIONS 1
196 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
197 #define NORETURN __attribute__((__noreturn__))
198 #define UNUSED_ARG(type,arg) __attribute__((__unused__)) type arg
199 #define UNUSED_VAR(type,name) __attribute__((__unused__)) type name
200 #define USED_VAR(type,name) __attribute__((__used__)) type name
201 #define INLINE static inline __attribute__((__always_inline__))
202 #define LIKELY(x) __builtin_expect(!!(x), 1)
203 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
204 #define PURE_FUNC __attribute__((pure))
205 #define CONST_FUNC __attribute__((const))
206 #define UNUSED_FUNC __attribute__((unused))
207 #define USED_FUNC __attribute__((__used__))
208 #define RESTRICT __restrict__
209 #define MUST_CHECK __attribute__((warn_unused_result))
211 #define DEPRECATED __attribute__((__deprecated__))
216 /* Hack to avoid conflicts with system type */
217 #define sigset_t system_sigset_t
221 #undef system_sigset_t
228 /* Support for harvard architectures */
230 #define PGM_READ_CHAR(s) pgm_read_byte(s)
231 #define PGM_FUNC(x) x ## _P
232 #define PGM_ATTR PROGMEM
239 * Disallow some C++ keywords as identifiers in C programs,
240 * for improved portability.
242 #pragma GCC poison new delete class template typename
243 #pragma GCC poison private protected public operator
244 #pragma GCC poison friend mutable using namespace
245 #pragma GCC poison cin cout cerr clog
248 #elif defined(__MWERKS__) && CPU_DSP56K
250 /* Compiler features */
251 #define COMPILER_TYPEOF 1
252 #define COMPILER_STATEMENT_EXPRESSIONS 1
259 // CodeWarrior has size_t as built-in type, but does not define this symbol.
260 #define _SIZE_T_DEFINED
263 #error unknown compiler
267 /* Defaults for compiler extensions. */
270 * \def COMPILER_VARIADIC_MACROS
271 * Support for macros with variable arguments.
273 #ifndef COMPILER_HAVE_VARIADIC_MACROS
274 #define COMPILER_HAVE_VARIADIC_MACROS (COMPILER_C99 != 0)
278 * \def COMPILER_TYPEOF
279 * Support for macros with variable arguments.
281 #ifndef COMPILER_TYPEOF
282 #define COMPILER_TYPEOF 0
286 * \def COMPILER_STATEMENT_EXPRESSIONS
287 * Support for macros with variable arguments.
289 #ifndef COMPILER_STATEMENT_EXPRESSIONS
290 #define COMPILER_STATEMENT_EXPRESSIONS 0
293 /* A few defaults for missing compiler features. */
295 #define INLINE static inline
298 #define NORETURN /* nothing */
301 #define FORMAT(type,fmt,first) /* nothing */
304 #define DEPRECATED /* nothing */
307 #define UNUSED_ARG(type,arg) type arg
309 #define UNUSED UNUSED_ARG /* OBSOLETE */
311 #define UNUSED_VAR(type,name) type name
314 #define USED_VAR(type,name) type name
317 #define REGISTER /* nothing */
320 #define INTERRUPT(x) ERROR_NOT_IMPLEMENTED
326 #define UNLIKELY(x) x
329 #define PURE_FUNC /* nothing */
332 #define CONST_FUNC /* nothing */
335 #define UNUSED_FUNC /* nothing */
338 #define USED_FUNC /* nothing */
341 #define RESTRICT /* nothing */
344 #define MUST_CHECK /* nothing */
347 /* Support for harvard architectures */
349 #define PSTR /* nothing */
351 #ifndef PGM_READ_CHAR
352 #define PGM_READ_CHAR(s) (*(s))
355 #define PGM_FUNC(x) x
358 #define PGM_ATTR /* nothing */
362 /* Misc definitions */
364 #define NULL (void *)0
371 /* Support for hybrid C/C++ applications. */
373 #define EXTERN_C extern "C"
374 #define EXTERN_C_BEGIN extern "C" {
375 #define EXTERN_C_END }
377 #define EXTERN_C extern
378 #define EXTERN_C_BEGIN /* nothing */
379 #define EXTERN_C_END /* nothing */
383 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
385 * \name ISO C99 fixed-size types
387 * These should be in <stdint.h>, but many compilers lack them.
390 typedef signed char int8_t;
391 typedef short int int16_t;
392 typedef long int int32_t;
393 typedef unsigned char uint8_t;
394 typedef unsigned short int uint16_t;
395 typedef unsigned long int uint32_t;
397 #elif defined(__GNUC__) && CPU_AVR
398 /* avr-libc is weird... */
399 #include <inttypes.h>
401 /* This is the correct location. */
407 * \name Standard type definitions.
409 * These should be in <sys/types.h>, but many compilers lack them.
413 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
414 #if CPU_REG_BITS > 32
416 typedef unsigned long size_t;
417 typedef long ssize_t;
419 /* 32bit or 16bit. */
420 typedef unsigned int size_t;
424 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
426 * The ATmega8 has a very small Flash, so we can't afford to
427 * link in support routines for 32bit integer arithmetic.
430 typedef int time_t; /* 16bit. */
431 #define SIZEOF_TIME_T SIZEOF_INT
433 typedef long time_t; /* 32bit or 64bit. */
434 #define SIZEOF_TIME_T SIZEOF_LONG
437 /* Just a guess, but quite safe. */
438 #define SIZEOF_TIME_T SIZEOF_LONG
439 #endif /* _TIME_T_DEFINED || __time_t_defined */
442 /*! Bulk storage large enough for both pointers or integers. */
443 typedef void * iptr_t;
444 typedef const void * const_iptr_t;
446 typedef long utime_t; /*!< Type for time expressed in microseconds. */
447 typedef unsigned char sig_t; /*!< Type for signal bits. */
448 typedef unsigned char sigset_t; /*!< Type for signal masks. */
449 typedef unsigned char page_t; /*!< Type for banked memory pages. */
452 * \name Types for hardware registers.
454 * Only use these types for registers whose contents can
455 * be changed asynchronously by external hardware.
460 /* Registers can be accessed only through 16-bit pointers */
461 typedef volatile uint16_t reg16_t;
463 typedef volatile uint8_t reg8_t;
464 typedef volatile uint16_t reg16_t;
465 typedef volatile uint32_t reg32_t;
470 /* Quasi-ANSI macros */
473 * Return the byte offset of the member \a m in struct \a s.
475 * \note This macro should be defined in "stddef.h" and is sometimes
476 * compiler-specific (g++ has a builtin for it).
478 #define offsetof(s,m) (size_t)&(((s *)0)->m)
482 * Count the number of elements in the static array \a a.
484 * \note This macro is non-standard, but implements a very common idiom
486 #define countof(a) (sizeof(a) / sizeof(*(a)))
489 /*! Issue a compilation error if the \a condition is false */
490 #define STATIC_ASSERT(condition) \
491 UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
493 #endif /* DEVLIB_COMPILER_H */