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.31 2004/11/16 22:37:28 bernie
18 *#* IPTR: Remove obsolete definition.
20 *#* Revision 1.30 2004/11/16 22:30:19 bernie
21 *#* Declare fixed-size types before other types.
23 *#* Revision 1.29 2004/11/16 20:34:40 bernie
24 *#* UNUSED_VAR, USED_VAR, USED_FUNC: New macros; UNUSED_ARG: Rename from UNUSED.
26 *#* Revision 1.28 2004/10/21 11:03:52 bernie
29 *#* Revision 1.27 2004/10/21 10:09:40 bernie
30 *#* Remove spurious token in preprocessor directive.
32 *#* Revision 1.26 2004/10/19 08:55:14 bernie
33 *#* UNUSED_FUNC: New function attribute.
35 *#* Revision 1.25 2004/10/19 07:14:20 bernie
36 *#* Add macros to test for specific compiler features.
38 *#* Revision 1.24 2004/10/03 18:35:13 bernie
39 *#* Poison C++ keywords in C programs for better portability.
41 *#* Revision 1.23 2004/09/20 03:30:27 bernie
42 *#* Remove vsprintf_P() proto, no longer needed with avr-libc 1.0.4.
44 *#* Revision 1.22 2004/09/14 21:03:04 bernie
45 *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
47 *#* Revision 1.21 2004/09/06 21:38:31 bernie
48 *#* Misc documentation and style fixes.
50 *#* Revision 1.20 2004/08/29 21:57:58 bernie
51 *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
52 *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
54 *#* Revision 1.19 2004/08/25 14:12:08 rasky
55 *#* Aggiornato il comment block dei log RCS
57 *#* Revision 1.18 2004/08/24 16:32:37 bernie
58 *#* Document custom types.
60 *#* Revision 1.17 2004/08/24 13:32:14 bernie
61 *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
62 *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
64 *#* Rename header guards;
65 *#* Don't include arch_config.h in compiler.h as it's not needed there.
67 *#* Revision 1.16 2004/08/14 19:37:57 rasky
68 *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
70 *#* Revision 1.15 2004/08/13 03:23:26 bernie
71 *#* Adjust a few MSVC tweaks from older projects.
73 *#* Revision 1.14 2004/08/10 06:56:29 bernie
74 *#* RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
76 *#* Revision 1.13 2004/08/02 20:20:29 aleph
77 *#* Merge from project_ks
79 *#* Revision 1.12 2004/08/01 01:21:17 bernie
80 *#* LIKELY(), UNLIKELY(): New compiler-specific macros.
82 *#* Revision 1.11 2004/07/30 14:34:10 rasky
83 *#* Vari fix per documentazione e commenti
84 *#* Aggiunte PP_CATn e STATIC_ASSERT
86 *#* Revision 1.10 2004/07/30 14:15:53 rasky
87 *#* Nuovo supporto unificato per detect della CPU
89 *#* Revision 1.9 2004/07/29 22:57:09 bernie
90 *#* vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
92 #ifndef DEVLIB_COMPILER_H
93 #define DEVLIB_COMPILER_H
95 #include "cpu_detect.h"
98 #if defined __GNUC__ && defined __GNUC_MINOR__
99 #define GNUC_PREREQ(maj, min) \
100 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
102 #define GNUC_PREREQ(maj, min) 0
105 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
106 #define COMPILER_C99 1
108 #define COMPILER_C99 0
112 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
113 #define PP_CAT(x,y) PP_CAT__(x,y)
114 #define PP_CAT__(x,y) x ## y
115 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
116 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
117 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
119 /*! String-ize a token (allowing macros to expand) */
120 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
121 #define PP_STRINGIZE__(x) #x
124 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
125 #pragma language=extended
126 #define INTERRUPT(x) interrupt [x]
127 #define REGISTER shortad
128 #define INLINE /* unsupported */
130 /* Imported from <longjmp.h>. Unfortunately, we can't just include
131 * this header because it typedefs jmp_buf to be an array of chars.
132 * This would allow the compiler to place the buffer on an odd address.
133 * The CPU _should_ be able to perform word accesses to
134 * unaligned data, but there are *BUGS* in the 80196KC with
135 * some combinations of opcodes and addressing modes. One of
136 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
137 * provided by the IAR compiler ANSI C library. When ?GR contains
138 * an odd address, surprisingly the CPU will copy the high order
139 * byte of the source operand (SP) in the low order byte of the
140 * destination operand (the memory location pointed to by ?GR).
142 * We also need to replace the library setjmp()/longjmp() with
143 * our own versions because the IAR implementation "forgets" to
144 * save the contents of local registers (?LR).
148 void * sp; /* Stack pointer */
149 void * return_addr; /* Return address */
150 int lr[6]; /* 6 local registers */
153 typedef struct _JMP_BUF jmp_buf[1];
155 int setjmp(jmp_buf env);
156 void longjmp(jmp_buf env, int val);
158 /* Fake bool support */
161 typedef unsigned char bool;
163 #elif defined(_MSC_VER) /* Win32 emulation support */
166 #include <time.h> /* for time_t */
168 /* FIXME: I can't remember why exactly this was needed (NdBernie) */
171 /* Fake bool support */
176 #endif /* !__cplusplus */
178 /* These C99 functions are oddly named in MSVCRT32.lib */
179 #define snprintf _snprintf
180 #define vsnprintf _vsnprintf
182 #elif defined(__GNUC__)
184 /* Compiler features */
185 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
186 #define COMPILER_TYPEOF 1
187 #define COMPILER_STATEMENT_EXPRESSIONS 1
190 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
191 #define NORETURN __attribute__((__noreturn__))
192 #define UNUSED_ARG(type,arg) __attribute__((__unused__)) type arg
193 #define UNUSED_VAR(type,name) __attribute__((__unused__)) type name
194 #define USED_VAR(type,name) __attribute__((__used__)) type name
195 #define INLINE static inline __attribute__((__always_inline__))
196 #define LIKELY(x) __builtin_expect(!!(x), 1)
197 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
198 #define PURE_FUNC __attribute__((pure))
199 #define CONST_FUNC __attribute__((const))
200 #define UNUSED_FUNC __attribute__((unused))
201 #define USED_FUNC __attribute__((__used__))
202 #define RESTRICT __restrict__
203 #define MUST_CHECK __attribute__((warn_unused_result))
205 #define DEPRECATED __attribute__((__deprecated__))
210 /* Hack to avoid conflicts with system type */
211 #define sigset_t system_sigset_t
215 #undef system_sigset_t
222 /* Support for harvard architectures */
224 #define PGM_READ_CHAR(s) pgm_read_byte(s)
225 #define PGM_FUNC(x) x ## _P
226 #define PGM_ATTR PROGMEM
233 * Disallow some C++ keywords as identifiers in C programs,
234 * for improved portability.
236 #pragma GCC poison new delete class template typename
237 #pragma GCC poison private protected public operator
238 #pragma GCC poison friend mutable using namespace
239 #pragma GCC poison cin cout cerr clog
242 #elif defined(__MWERKS__) && CPU_DSP56K
244 /* Compiler features */
245 #define COMPILER_TYPEOF 1
246 #define COMPILER_STATEMENT_EXPRESSIONS 1
253 // CodeWarrior has size_t as built-in type, but does not define this symbol.
254 #define _SIZE_T_DEFINED
257 #error unknown compiler
261 /* Defaults for compiler extensions. */
264 * \def COMPILER_VARIADIC_MACROS
265 * Support for macros with variable arguments.
267 #ifndef COMPILER_HAVE_VARIADIC_MACROS
268 #define COMPILER_HAVE_VARIADIC_MACROS (COMPILER_C99 != 0)
272 * \def COMPILER_TYPEOF
273 * Support for macros with variable arguments.
275 #ifndef COMPILER_TYPEOF
276 #define COMPILER_TYPEOF 0
280 * \def COMPILER_STATEMENT_EXPRESSIONS
281 * Support for macros with variable arguments.
283 #ifndef COMPILER_STATEMENT_EXPRESSIONS
284 #define COMPILER_STATEMENT_EXPRESSIONS 0
287 /* A few defaults for missing compiler features. */
289 #define INLINE static inline
292 #define NORETURN /* nothing */
295 #define FORMAT(type,fmt,first) /* nothing */
298 #define DEPRECATED /* nothing */
301 #define UNUSED_ARG(type,arg) type arg
303 #define UNUSED UNUSED_ARG /* OBSOLETE */
305 #define UNUSED_VAR(type,name) type name
308 #define USED_VAR(type,name) type name
311 #define REGISTER /* nothing */
314 #define INTERRUPT(x) ERROR_NOT_IMPLEMENTED
320 #define UNLIKELY(x) x
323 #define PURE_FUNC /* nothing */
326 #define CONST_FUNC /* nothing */
329 #define UNUSED_FUNC /* nothing */
332 #define USED_FUNC /* nothing */
335 #define RESTRICT /* nothing */
338 #define MUST_CHECK /* nothing */
341 /* Support for harvard architectures */
343 #define PSTR /* nothing */
345 #ifndef PGM_READ_CHAR
346 #define PGM_READ_CHAR(s) (*(s))
349 #define PGM_FUNC(x) x
352 #define PGM_ATTR /* nothing */
356 /* Misc definitions */
358 #define NULL (void *)0
365 /* Support for hybrid C/C++ applications. */
367 #define EXTERN_C extern "C"
368 #define EXTERN_C_BEGIN extern "C" {
369 #define EXTERN_C_END }
371 #define EXTERN_C extern
372 #define EXTERN_C_BEGIN /* nothing */
373 #define EXTERN_C_END /* nothing */
377 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
379 * \name ISO C99 fixed-size types
381 * These should be in <stdint.h>, but many compilers lack them.
384 typedef signed char int8_t;
385 typedef short int int16_t;
386 typedef long int int32_t;
387 typedef unsigned char uint8_t;
388 typedef unsigned short int uint16_t;
389 typedef unsigned long int uint32_t;
391 #elif defined(__GNUC__) && CPU_AVR
392 /* avr-libc is weird... */
393 #include <inttypes.h>
395 /* This is the correct location. */
401 * Standard type definitions.
402 * These should be in <sys/types.h>, but many compilers lack them.
404 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
405 typedef unsigned int size_t;
408 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
410 #endif /* _TIME_T_DEFINED || __time_t_defined */
412 /*! Bulk storage large enough for both pointers or integers */
413 typedef void * iptr_t;
414 typedef const void * const_iptr_t;
416 typedef long utime_t; /*!< Type for time expressed in microseconds */
417 typedef unsigned char sig_t; /*!< Type for signal bits */
418 typedef unsigned char sigset_t; /*!< Type for signal masks */
419 typedef unsigned char page_t; /*!< Type for banked memory pages */
422 * \name Types for hardware registers.
424 * Only use these types for registers whose contents can
425 * be changed asynchronously by external hardware.
430 /* Registers can be accessed only through 16-bit pointers */
431 typedef volatile uint16_t reg16_t;
433 typedef volatile uint8_t reg8_t;
434 typedef volatile uint16_t reg16_t;
435 typedef volatile uint32_t reg32_t;
440 /* Quasi-ANSI macros */
443 * Return the byte offset of the member \a m in struct \a s.
445 * \note This macro should be defined in "stddef.h" and is sometimes
446 * compiler-specific (g++ has a builtin for it).
448 #define offsetof(s,m) (size_t)&(((s *)0)->m)
452 * Count the number of elements in the static array \a a.
454 * \note This macro is non-standard, but implements a very common idiom
456 #define countof(a) (sizeof(a) / sizeof(*(a)))
459 /*! Issue a compilation error if the \a condition is false */
460 #define STATIC_ASSERT(condition) \
461 UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
463 #endif /* DEVLIB_COMPILER_H */