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.28 2004/10/21 11:03:52 bernie
20 *#* Revision 1.27 2004/10/21 10:09:40 bernie
21 *#* Remove spurious token in preprocessor directive.
23 *#* Revision 1.26 2004/10/19 08:55:14 bernie
24 *#* UNUSED_FUNC: New function attribute.
26 *#* Revision 1.25 2004/10/19 07:14:20 bernie
27 *#* Add macros to test for specific compiler features.
29 *#* Revision 1.24 2004/10/03 18:35:13 bernie
30 *#* Poison C++ keywords in C programs for better portability.
32 *#* Revision 1.23 2004/09/20 03:30:27 bernie
33 *#* Remove vsprintf_P() proto, no longer needed with avr-libc 1.0.4.
35 *#* Revision 1.22 2004/09/14 21:03:04 bernie
36 *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
38 *#* Revision 1.21 2004/09/06 21:38:31 bernie
39 *#* Misc documentation and style fixes.
41 *#* Revision 1.20 2004/08/29 21:57:58 bernie
42 *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
43 *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
45 *#* Revision 1.19 2004/08/25 14:12:08 rasky
46 *#* Aggiornato il comment block dei log RCS
48 *#* Revision 1.18 2004/08/24 16:32:37 bernie
49 *#* Document custom types.
51 *#* Revision 1.17 2004/08/24 13:32:14 bernie
52 *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
53 *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
55 *#* Rename header guards;
56 *#* Don't include arch_config.h in compiler.h as it's not needed there.
58 *#* Revision 1.16 2004/08/14 19:37:57 rasky
59 *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
61 *#* Revision 1.15 2004/08/13 03:23:26 bernie
62 *#* Adjust a few MSVC tweaks from older projects.
64 *#* Revision 1.14 2004/08/10 06:56:29 bernie
65 *#* RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
67 *#* Revision 1.13 2004/08/02 20:20:29 aleph
68 *#* Merge from project_ks
70 *#* Revision 1.12 2004/08/01 01:21:17 bernie
71 *#* LIKELY(), UNLIKELY(): New compiler-specific macros.
73 *#* Revision 1.11 2004/07/30 14:34:10 rasky
74 *#* Vari fix per documentazione e commenti
75 *#* Aggiunte PP_CATn e STATIC_ASSERT
77 *#* Revision 1.10 2004/07/30 14:15:53 rasky
78 *#* Nuovo supporto unificato per detect della CPU
80 *#* Revision 1.9 2004/07/29 22:57:09 bernie
81 *#* vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
83 #ifndef DEVLIB_COMPILER_H
84 #define DEVLIB_COMPILER_H
86 #include "cpu_detect.h"
89 #if defined __GNUC__ && defined __GNUC_MINOR__
90 #define GNUC_PREREQ(maj, min) \
91 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
93 #define GNUC_PREREQ(maj, min) 0
96 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
97 #define COMPILER_C99 1
99 #define COMPILER_C99 0
103 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
104 #define PP_CAT(x,y) PP_CAT__(x,y)
105 #define PP_CAT__(x,y) x ## y
106 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
107 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
108 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
110 /*! String-ize a token (allowing macros to expand) */
111 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
112 #define PP_STRINGIZE__(x) #x
115 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
116 #pragma language=extended
117 #define INTERRUPT(x) interrupt [x]
118 #define REGISTER shortad
119 #define INLINE /* unsupported */
121 /* Imported from <longjmp.h>. Unfortunately, we can't just include
122 * this header because it typedefs jmp_buf to be an array of chars.
123 * This would allow the compiler to place the buffer on an odd address.
124 * The CPU _should_ be able to perform word accesses to
125 * unaligned data, but there are *BUGS* in the 80196KC with
126 * some combinations of opcodes and addressing modes. One of
127 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
128 * provided by the IAR compiler ANSI C library. When ?GR contains
129 * an odd address, surprisingly the CPU will copy the high order
130 * byte of the source operand (SP) in the low order byte of the
131 * destination operand (the memory location pointed to by ?GR).
133 * We also need to replace the library setjmp()/longjmp() with
134 * our own versions because the IAR implementation "forgets" to
135 * save the contents of local registers (?LR).
139 void * sp; /* Stack pointer */
140 void * return_addr; /* Return address */
141 int lr[6]; /* 6 local registers */
144 typedef struct _JMP_BUF jmp_buf[1];
146 int setjmp(jmp_buf env);
147 void longjmp(jmp_buf env, int val);
149 /* Fake bool support */
152 typedef unsigned char bool;
154 #elif defined(_MSC_VER) /* Win32 emulation support */
157 #include <time.h> /* for time_t */
159 /* FIXME: I can't remember why exactly this was needed (NdBernie) */
162 /* Fake bool support */
167 #endif /* !__cplusplus */
169 /* These C99 functions are oddly named in MSVCRT32.lib */
170 #define snprintf _snprintf
171 #define vsnprintf _vsnprintf
173 #elif defined(__GNUC__)
175 /* Compiler features */
176 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
177 #define COMPILER_TYPEOF 1
178 #define COMPILER_STATEMENT_EXPRESSIONS 1
181 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
182 #define NORETURN __attribute__((__noreturn__))
183 #define UNUSED(type,arg) __attribute__((__unused__)) type arg
184 #define INLINE static inline __attribute__((__always_inline__))
185 #define LIKELY(x) __builtin_expect(!!(x), 1)
186 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
187 #define PURE_FUNC __attribute__((pure))
188 #define CONST_FUNC __attribute__((const))
189 #define UNUSED_FUNC __attribute__((unused))
190 #define RESTRICT __restrict__
191 #define MUST_CHECK __attribute__((warn_unused_result))
193 #define DEPRECATED __attribute__((__deprecated__))
198 /* Hack to avoid conflicts with system type */
199 #define sigset_t system_sigset_t
203 #undef system_sigset_t
210 /* Support for harvard architectures */
212 #define PGM_READ_CHAR(s) pgm_read_byte(s)
213 #define PGM_FUNC(x) x ## _P
214 #define PGM_ATTR PROGMEM
221 * Disallow some C++ keywords as identifiers in C programs,
222 * for improved portability.
224 #pragma GCC poison new delete class template typename
225 #pragma GCC poison private protected public operator
226 #pragma GCC poison friend mutable using namespace
227 #pragma GCC poison cin cout cerr clog
230 #elif defined(__MWERKS__) && CPU_DSP56K
232 /* Compiler features */
233 #define COMPILER_TYPEOF 1
234 #define COMPILER_STATEMENT_EXPRESSIONS 1
241 // CodeWarrior has size_t as built-in type, but does not define this symbol.
242 #define _SIZE_T_DEFINED
245 #error unknown compiler
249 /* Defaults for compiler extensions. */
252 * \def COMPILER_VARIADIC_MACROS
253 * Support for macros with variable arguments.
255 #ifndef COMPILER_HAVE_VARIADIC_MACROS
256 #define COMPILER_HAVE_VARIADIC_MACROS (COMPILER_C99 != 0)
260 * \def COMPILER_TYPEOF
261 * Support for macros with variable arguments.
263 #ifndef COMPILER_TYPEOF
264 #define COMPILER_TYPEOF 0
268 * \def COMPILER_STATEMENT_EXPRESSIONS
269 * Support for macros with variable arguments.
271 #ifndef COMPILER_STATEMENT_EXPRESSIONS
272 #define COMPILER_STATEMENT_EXPRESSIONS 0
275 /* A few defaults for missing compiler features. */
277 #define INLINE static inline
280 #define NORETURN /* nothing */
283 #define FORMAT(type,fmt,first) /* nothing */
286 #define DEPRECATED /* nothing */
289 #define UNUSED(type,arg) type arg
292 #define REGISTER /* nothing */
295 #define INTERRUPT(x) ERROR_NOT_IMPLEMENTED
301 #define UNLIKELY(x) x
304 #define PURE_FUNC /* nothing */
307 #define CONST_FUNC /* nothing */
310 #define UNUSED_FUNC /* nothing */
313 #define RESTRICT /* nothing */
316 #define MUST_CHECK /* nothing */
319 /* Support for harvard architectures */
321 #define PSTR /* nothing */
323 #ifndef PGM_READ_CHAR
324 #define PGM_READ_CHAR(s) (*(s))
327 #define PGM_FUNC(x) x
330 #define PGM_ATTR /* nothing */
334 /* Misc definitions */
336 #define NULL (void *)0
343 /* Support for hybrid C/C++ applications. */
345 #define EXTERN_C extern "C"
346 #define EXTERN_C_BEGIN extern "C" {
347 #define EXTERN_C_END }
349 #define EXTERN_C extern
350 #define EXTERN_C_BEGIN /* nothing */
351 #define EXTERN_C_END /* nothing */
356 * Standard type definitions.
357 * These should be in <sys/types.h>, but many compilers lack them.
359 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
360 typedef unsigned int size_t;
363 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
365 #endif /* _TIME_T_DEFINED || __time_t_defined */
367 /*! Bulk storage large enough for both pointers or integers */
368 typedef void * iptr_t;
369 typedef const void * const_iptr_t;
370 #define IPTR iptr_t /* OBSOLETE */
372 typedef long utime_t; /*!< Type for time expressed in microseconds */
373 typedef unsigned char sig_t; /*!< Type for signal bits */
374 typedef unsigned char sigset_t; /*!< Type for signal masks */
375 typedef unsigned char page_t; /*!< Type for banked memory pages */
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. */
400 * \name Types for hardware registers.
402 * Only use these types for registers whose contents can
403 * be changed asynchronously by external hardware.
408 /* Registers can be accessed only through 16-bit pointers */
409 typedef volatile uint16_t reg16_t;
411 typedef volatile uint8_t reg8_t;
412 typedef volatile uint16_t reg16_t;
413 typedef volatile uint32_t reg32_t;
418 /* Quasi-ANSI macros */
421 * Return the byte offset of the member \a m in struct \a s.
423 * \note This macro should be defined in "stddef.h" and is sometimes
424 * compiler-specific (g++ has a builtin for it).
426 #define offsetof(s,m) (size_t)&(((s *)0)->m)
430 * Count the number of elements in the static array \a a.
432 * \note This macro is non-standard, but implements a very common idiom
434 #define countof(a) (sizeof(a) / sizeof(*(a)))
437 /*! Issue a compilation error if the \a condition is false */
438 #define STATIC_ASSERT(condition) \
439 extern char PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1]
441 #endif /* DEVLIB_COMPILER_H */