4 * Copyright 2003, 2004, 2005 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 README.devlib for information.
9 * \brief Additional support macros for compiler independance
12 * \author Bernardo Innocenti <bernie@develer.com>
17 *#* Revision 1.11 2006/02/20 14:34:58 bernie
18 *#* Use portable type checking.
20 *#* Revision 1.10 2006/02/15 09:12:01 bernie
21 *#* Fixes for ARM/IAR support.
23 *#* Revision 1.9 2006/02/10 12:38:00 bernie
24 *#* Add support for ARM on IAR.
26 *#* Revision 1.8 2006/01/16 03:27:49 bernie
27 *#* Rename sig_t to sigbit_t to avoid clash with POSIX.
29 *#* Revision 1.7 2005/11/27 23:33:05 bernie
30 *#* Drop avr-libc hack for missing stdint.h.
32 *#* Revision 1.6 2005/07/19 07:27:31 bernie
33 *#* Don't use CPU_REG_BITS from cpu.h to avoid circular header dependendy.
35 *#* Revision 1.5 2005/06/27 21:24:37 bernie
36 *#* ticks_t: New typedef.
38 *#* Revision 1.4 2005/06/14 06:15:10 bernie
39 *#* Add X86_64 support.
41 *#* Revision 1.3 2005/04/12 01:37:01 bernie
42 *#* Metrowerks touchups from HeCo.
44 *#* Revision 1.2 2005/04/11 19:10:27 bernie
45 *#* Include top-level headers from cfg/ subdir.
47 *#* Revision 1.1 2005/04/11 19:04:13 bernie
48 *#* Move top-level headers to cfg/ subdir.
50 *#* Revision 1.44 2005/03/29 06:39:59 bernie
51 *#* setjmp.h, time_t: Remove ancient retrocompatibility; Remove MSVC double to float hack.
53 *#* Revision 1.43 2005/03/01 23:15:12 bernie
54 *#* Remove compatibility hack.
56 *#* Revision 1.42 2005/02/16 20:28:46 bernie
57 *#* Move PGM macros to mware/pgm.h
59 *#* Revision 1.41 2005/01/22 04:19:22 bernie
60 *#* MTIME_INFINITE: New constant.
62 *#* Revision 1.40 2005/01/20 18:46:04 aleph
63 *#* Add progmem datatypes; PSTR() definition.
65 #ifndef DEVLIB_COMPILER_H
66 #define DEVLIB_COMPILER_H
68 #include <cfg/cpu_detect.h>
71 #if defined __GNUC__ && defined __GNUC_MINOR__
72 #define GNUC_PREREQ(maj, min) \
73 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
75 #define GNUC_PREREQ(maj, min) 0
78 /* Some CW versions do not allow enabling C99 from the settings panel. */
79 #if defined(__MWERKS__)
83 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
84 #define COMPILER_C99 1
86 #define COMPILER_C99 0
90 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
91 #define PP_CAT(x,y) PP_CAT__(x,y)
92 #define PP_CAT__(x,y) x ## y
93 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
94 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
95 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
97 /*! String-ize a token (allowing macros to expand) */
98 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
99 #define PP_STRINGIZE__(x) #x
102 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
104 #pragma language=extended
108 #define COMPILER_VARIADIC_MACROS 1
110 #define INTERRUPT(x) __irq __arm void x (void)
111 #define INLINE static inline
113 /* Include some standard C89/C99 stuff */
120 // IAR has size_t as built-in type, but does not define this symbol.
121 #define _SIZE_T_DEFINED
123 #define INTERRUPT(x) interrupt [x]
124 #define REGISTER shortad
125 #define INLINE /* unsupported */
128 * Imported from <longjmp.h>. Unfortunately, we can't just include
129 * this header because it typedefs jmp_buf to be an array of chars.
130 * This would allow the compiler to place the buffer on an odd address.
131 * The CPU _should_ be able to perform word accesses to
132 * unaligned data, but there are *BUGS* in the 80196KC with
133 * some combinations of opcodes and addressing modes. One of
134 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
135 * provided by the IAR compiler ANSI C library. When ?GR contains
136 * an odd address, surprisingly the CPU will copy the high order
137 * byte of the source operand (SP) in the low order byte of the
138 * destination operand (the memory location pointed to by ?GR).
140 * We also need to replace the library setjmp()/longjmp() with
141 * our own versions because the IAR implementation "forgets" to
142 * save the contents of local registers (?LR).
146 void *sp; /* Stack pointer */
147 void *return_addr; /* Return address */
148 int lr[6]; /* 6 local registers */
151 typedef struct _JMP_BUF jmp_buf[1];
153 int setjmp(jmp_buf env);
154 void longjmp(jmp_buf env, int val);
156 /* Fake bool support */
159 typedef unsigned char bool;
162 #error Unsupported CPU
165 #elif defined(_MSC_VER) /* Win32 emulation support */
167 /* MSVC doesn't provide <stdbool.h>. */
172 #endif /* !__cplusplus */
174 /* These C99 functions are oddly named in MSVCRT32.lib */
175 #define snprintf _snprintf
176 #define vsnprintf _vsnprintf
178 #elif defined(__GNUC__)
180 /* Compiler features */
181 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
182 #define COMPILER_TYPEOF 1
183 #define COMPILER_STATEMENT_EXPRESSIONS 1
186 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
187 #define NORETURN __attribute__((__noreturn__))
188 #define UNUSED_ARG(type,arg) __attribute__((__unused__)) type arg
189 #define UNUSED_VAR(type,name) __attribute__((__unused__)) type name
190 #define USED_VAR(type,name) __attribute__((__used__)) type name
191 #define INLINE static inline __attribute__((__always_inline__))
192 #define LIKELY(x) __builtin_expect(!!(x), 1)
193 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
194 #define PURE_FUNC __attribute__((pure))
195 #define CONST_FUNC __attribute__((const))
196 #define UNUSED_FUNC __attribute__((unused))
197 #define USED_FUNC __attribute__((__used__))
198 #define RESTRICT __restrict__
199 #define MUST_CHECK __attribute__((warn_unused_result))
201 #define DEPRECATED __attribute__((__deprecated__))
205 #define ASSERT_TYPE_EQUAL(var1, var2) \
206 STATIC_ASSERT(__builtin_types_compatible_p(typeof(var1), typeof(var2)))
207 #define ASSERT_TYPE_IS(var, type) \
208 STATIC_ASSERT(__builtin_types_compatible_p(typeof(var), type))
211 /* Include some standard C89/C99 stuff */
218 * Disallow some C++ keywords as identifiers in C programs,
219 * for improved portability.
221 #pragma GCC poison new delete class template typename
222 #pragma GCC poison private protected public operator
223 #pragma GCC poison friend mutable using namespace
224 #pragma GCC poison cin cout cerr clog
227 #elif defined(__MWERKS__)
229 /* Compiler features */
230 #define COMPILER_VARIADIC_MACROS 1
231 #define COMPILER_TYPEOF 1
232 #define COMPILER_STATEMENT_EXPRESSIONS 1
234 #define typeof __typeof__
236 #define UNUSED_ARG(type,arg) type
242 // CodeWarrior has size_t as built-in type, but does not define this symbol.
243 #define _SIZE_T_DEFINED
246 #error unknown compiler
250 /* Defaults for compiler extensions. */
253 * \def COMPILER_VARIADIC_MACROS
254 * Support for macros with variable arguments.
256 #ifndef COMPILER_VARIADIC_MACROS
257 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
261 * \def COMPILER_TYPEOF
262 * Support for dynamic type identification.
264 #ifndef COMPILER_TYPEOF
265 #define COMPILER_TYPEOF 0
269 * \def COMPILER_STATEMENT_EXPRESSIONS
270 * Support for statement expressions.
272 #ifndef COMPILER_STATEMENT_EXPRESSIONS
273 #define COMPILER_STATEMENT_EXPRESSIONS 0
276 /* A few defaults for missing compiler features. */
278 #define INLINE static inline
281 #define NORETURN /* nothing */
284 #define FORMAT(type,fmt,first) /* nothing */
287 #define DEPRECATED /* nothing */
290 #define UNUSED_ARG(type,arg) type arg
292 #define UNUSED UNUSED_ARG /* OBSOLETE */
294 #define UNUSED_VAR(type,name) type name
297 #define USED_VAR(type,name) type name
300 #define REGISTER /* nothing */
303 #define INTERRUPT(x) ERROR_NOT_IMPLEMENTED
309 #define UNLIKELY(x) x
312 #define PURE_FUNC /* nothing */
315 #define CONST_FUNC /* nothing */
318 #define UNUSED_FUNC /* nothing */
321 #define USED_FUNC /* nothing */
324 #define RESTRICT /* nothing */
327 #define MUST_CHECK /* nothing */
330 /* Misc definitions */
332 #define NULL (void *)0
339 /* Support for hybrid C/C++ applications. */
341 #define EXTERN_C extern "C"
342 #define EXTERN_C_BEGIN extern "C" {
343 #define EXTERN_C_END }
344 #define EXTERN_CONST extern const
346 #define EXTERN_C extern
347 #define EXTERN_C_BEGIN /* nothing */
348 #define EXTERN_C_END /* nothing */
349 #define EXTERN_CONST const
353 #if defined(_MSC_VER)
354 || ((defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)) && CPU_I196)
356 * \name ISO C99 fixed-size types
358 * These should be in <stdint.h>, but a few compilers lack them.
361 typedef signed char int8_t;
362 typedef unsigned char uint8_t;
363 typedef short int int16_t;
364 typedef unsigned short int uint16_t;
365 typedef long int int32_t; /* _WIN64 safe */
366 typedef unsigned long int uint32_t; /* _WIN64 safe */
369 typedef __int64 int64_t;
370 typedef unsigned __int64 uint64_t;
372 typedef long long int64_t;
373 typedef unsigned long long uint64_t;
377 /* This is the standard location. */
383 * The ATmega8 has a very small Flash, so we can't afford
384 * to link in support routines for 32bit integer arithmetic.
386 typedef int16_t ticks_t; /*!< Type for time expressed in ticks. */
387 typedef int16_t mtime_t; /*!< Type for time expressed in milliseconds. */
388 typedef int16_t utime_t; /*!< Type for time expressed in microseconds. */
389 #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
390 #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
391 #define MTIME_INFINITE 0x7FFFL
393 typedef int32_t ticks_t; /*!< Type for time expressed in ticks. */
394 typedef int32_t mtime_t; /*!< Type for time expressed in milliseconds. */
395 typedef int32_t utime_t; /*!< Type for time expressed in microseconds. */
396 #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
397 #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
398 #define MTIME_INFINITE 0x7FFFFFFFL
401 /*! Bulk storage large enough for both pointers or integers. */
402 typedef void * iptr_t;
404 /*! Bulk storage large enough for both pointers to constants or integers. */
405 typedef const void * const_iptr_t;
407 typedef unsigned char sigbit_t; /*!< Type for signal bits. */
408 typedef unsigned char sigmask_t; /*!< Type for signal masks. */
409 typedef unsigned char page_t; /*!< Type for banked memory pages. */
413 * \name Standard type definitions.
415 * These should be in <sys/types.h> or <stddef.h>, but many compilers
416 * and C libraries lack them.
418 * We check for some common definitions to avoid redefinitions:
420 * glibc, avr-libc: _SIZE_T_DEFINED
421 * Darwin libc: _BSD_SIZE_T_DEFINED_
426 #if !(defined(size_t) || defined(_SIZE_T_DEFINED) || defined(_BSD_SIZE_T_DEFINED_) \
429 /* 32bit or 64bit (32bit for _WIN64). */
430 typedef unsigned long size_t;
436 #if !(defined(ssize_t) || defined(__ssize_t_defined))
438 /* 32bit or 64bit (32bit for _WIN64). */
439 typedef long ssize_t;
443 /* 16bit (missing in avr-libc's sys/types.h). */
453 * \name Types for hardware registers.
455 * Only use these types for registers whose contents can
456 * be changed asynchronously by external hardware.
461 /* Registers can be accessed only through 16-bit pointers */
462 typedef volatile uint16_t reg16_t;
464 typedef volatile uint8_t reg8_t;
465 typedef volatile uint16_t reg16_t;
466 typedef volatile uint32_t reg32_t;
471 /* Quasi-ANSI macros */
474 * Return the byte offset of the member \a m in struct \a s.
476 * \note This macro should be defined in "stddef.h" and is sometimes
477 * compiler-specific (g++ has a builtin for it).
479 #define offsetof(s,m) (size_t)&(((s *)0)->m)
483 * Count the number of elements in the static array \a a.
485 * \note This macro is non-standard, but implements a very common idiom
487 #define countof(a) (sizeof(a) / sizeof(*(a)))
490 /*! Issue a compilation error if the \a condition is false */
491 #define STATIC_ASSERT(condition) \
492 UNUSED_VAR(extern char, STATIC_ASSERTION_FAILED__[(condition) ? 1 : -1])
494 #ifndef ASSERT_TYPE_EQUAL
495 /*! Ensure two variables have the same type. */
496 #define ASSERT_TYPE_EQUAL(var1, var2) \
497 do { (void)(&(var1) == &(var2)); } while(0)
500 #ifndef ASSERT_TYPE_IS
501 /*! Ensure variable is of specified type. */
502 #define ASSERT_TYPE_IS(var, type) \
503 do { (void)(&var == (type *)0); } while(0)
506 #endif /* DEVLIB_COMPILER_H */