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.21 2006/07/19 12:53:43 bernie
20 *#* Revision 1.20 2006/06/10 05:36:15 bernie
21 *#* Convert to new Doxygen comments.
23 *#* Revision 1.19 2006/04/11 00:07:33 bernie
24 *#* Implemenent MF_SAVESEL flag.
26 *#* Revision 1.18 2006/03/22 13:34:34 bernie
29 *#* Revision 1.17 2006/03/22 09:48:35 bernie
32 *#* Revision 1.16 2006/03/20 17:48:09 bernie
33 *#* Fix for avr-libc; INTERRUPT(): Remove macro.
35 *#* Revision 1.15 2006/03/13 02:06:25 bernie
36 *#* containerof(): New macro.
38 *#* Revision 1.14 2006/02/23 08:36:33 bernie
39 *#* Emulate __func__ on MSVC.
41 *#* Revision 1.13 2006/02/23 07:37:37 bernie
42 *#* Compile fix for MSVC.
44 *#* Revision 1.12 2006/02/21 16:06:31 bernie
45 *#* Fix ssize_t redefinitions on glibc systems.
47 *#* Revision 1.11 2006/02/20 14:34:58 bernie
48 *#* Use portable type checking.
50 *#* Revision 1.10 2006/02/15 09:12:01 bernie
51 *#* Fixes for ARM/IAR support.
53 *#* Revision 1.9 2006/02/10 12:38:00 bernie
54 *#* Add support for ARM on IAR.
56 *#* Revision 1.8 2006/01/16 03:27:49 bernie
57 *#* Rename sig_t to sigbit_t to avoid clash with POSIX.
59 *#* Revision 1.7 2005/11/27 23:33:05 bernie
60 *#* Drop avr-libc hack for missing stdint.h.
62 *#* Revision 1.6 2005/07/19 07:27:31 bernie
63 *#* Don't use CPU_REG_BITS from cpu.h to avoid circular header dependendy.
65 *#* Revision 1.5 2005/06/27 21:24:37 bernie
66 *#* ticks_t: New typedef.
68 *#* Revision 1.4 2005/06/14 06:15:10 bernie
69 *#* Add X86_64 support.
71 *#* Revision 1.3 2005/04/12 01:37:01 bernie
72 *#* Metrowerks touchups from HeCo.
74 *#* Revision 1.2 2005/04/11 19:10:27 bernie
75 *#* Include top-level headers from cfg/ subdir.
77 *#* Revision 1.1 2005/04/11 19:04:13 bernie
78 *#* Move top-level headers to cfg/ subdir.
80 #ifndef DEVLIB_COMPILER_H
81 #define DEVLIB_COMPILER_H
83 #include <cfg/cpu_detect.h>
86 #if defined __GNUC__ && defined __GNUC_MINOR__
87 #define GNUC_PREREQ(maj, min) \
88 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
90 #define GNUC_PREREQ(maj, min) 0
93 /* Some CW versions do not allow enabling C99 from the settings panel. */
94 #if defined(__MWERKS__)
98 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
99 #define COMPILER_C99 1
101 #define COMPILER_C99 0
105 /** Concatenate two different preprocessor tokens (allowing macros to expand) */
106 #define PP_CAT(x,y) PP_CAT__(x,y)
107 #define PP_CAT__(x,y) x ## y
108 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
109 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
110 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
112 /** String-ize a token (allowing macros to expand) */
113 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
114 #define PP_STRINGIZE__(x) #x
117 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
119 #pragma language=extended
123 #define COMPILER_VARIADIC_MACROS 1
125 #define INTERRUPT(x) __irq __arm void x (void)
126 #define INLINE static inline
128 /* Include some standard C89/C99 stuff */
135 // IAR has size_t as built-in type, but does not define this symbol.
136 #define _SIZE_T_DEFINED
138 #define INTERRUPT(x) interrupt [x]
139 #define REGISTER shortad
140 #define INLINE /* unsupported */
143 * Imported from <longjmp.h>. Unfortunately, we can't just include
144 * this header because it typedefs jmp_buf to be an array of chars.
145 * This would allow the compiler to place the buffer on an odd address.
146 * The CPU _should_ be able to perform word accesses to
147 * unaligned data, but there are *BUGS* in the 80196KC with
148 * some combinations of opcodes and addressing modes. One of
149 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
150 * provided by the IAR compiler ANSI C library. When ?GR contains
151 * an odd address, surprisingly the CPU will copy the high order
152 * byte of the source operand (SP) in the low order byte of the
153 * destination operand (the memory location pointed to by ?GR).
155 * We also need to replace the library setjmp()/longjmp() with
156 * our own versions because the IAR implementation "forgets" to
157 * save the contents of local registers (?LR).
161 void *sp; /* Stack pointer */
162 void *return_addr; /* Return address */
163 int lr[6]; /* 6 local registers */
166 typedef struct _JMP_BUF jmp_buf[1];
168 int setjmp(jmp_buf env);
169 void longjmp(jmp_buf env, int val);
171 /* Fake bool support */
174 typedef unsigned char bool;
177 #error Unsupported CPU
180 #elif defined(_MSC_VER) /* Win32 emulation support */
182 /* MSVC doesn't provide <stdbool.h>. */
187 #endif /* !__cplusplus */
189 /* These C99 functions are oddly named in MSVCRT32.lib */
190 #define snprintf _snprintf
191 #define vsnprintf _vsnprintf
193 /* MSVC doesn't support C99's __func__, but has a similar extension. */
194 #define __func__ __FUNCTION__
196 /* MSVC doesn't support C99's inline keyword */
198 #define INLINE __inline
201 #elif defined(__GNUC__)
203 /* Compiler features */
204 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
205 #define COMPILER_TYPEOF 1
206 #define COMPILER_STATEMENT_EXPRESSIONS 1
209 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
210 #define NORETURN __attribute__((__noreturn__))
211 #define UNUSED_ARG(type,arg) __attribute__((__unused__)) type arg
212 #define UNUSED_VAR(type,name) __attribute__((__unused__)) type name
213 #define USED_VAR(type,name) __attribute__((__used__)) type name
214 #define INLINE static inline __attribute__((__always_inline__))
215 #define LIKELY(x) __builtin_expect(!!(x), 1)
216 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
217 #define PURE_FUNC __attribute__((pure))
218 #define CONST_FUNC __attribute__((const))
219 #define UNUSED_FUNC __attribute__((unused))
220 #define USED_FUNC __attribute__((__used__))
221 #define RESTRICT __restrict__
222 #define MUST_CHECK __attribute__((warn_unused_result))
224 #define DEPRECATED __attribute__((__deprecated__))
228 #define ASSERT_TYPE_EQUAL(var1, var2) \
229 STATIC_ASSERT(__builtin_types_compatible_p(typeof(var1), typeof(var2)))
230 #define ASSERT_TYPE_IS(var, type) \
231 STATIC_ASSERT(__builtin_types_compatible_p(typeof(var), type))
234 /* Include some standard C89/C99 stuff */
239 #include <sys/types.h> /* for ssize_t */
244 * Disallow some C++ keywords as identifiers in C programs,
245 * for improved portability.
247 #pragma GCC poison new delete class template typename
248 #pragma GCC poison private protected public operator
249 #pragma GCC poison friend mutable using namespace
250 #pragma GCC poison cin cout cerr clog
253 #elif defined(__MWERKS__)
255 /* Compiler features */
256 #define COMPILER_VARIADIC_MACROS 1
257 #define COMPILER_TYPEOF 1
258 #define COMPILER_STATEMENT_EXPRESSIONS 1
260 #define typeof __typeof__
262 #define UNUSED_ARG(type,arg) type
268 // CodeWarrior has size_t as built-in type, but does not define this symbol.
269 #define _SIZE_T_DEFINED
272 #error unknown compiler
276 /* Defaults for compiler extensions. */
279 * \def COMPILER_VARIADIC_MACROS
280 * Support for macros with variable arguments.
282 #ifndef COMPILER_VARIADIC_MACROS
283 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
287 * \def COMPILER_TYPEOF
288 * Support for dynamic type identification.
290 #ifndef COMPILER_TYPEOF
291 #define COMPILER_TYPEOF 0
295 * \def COMPILER_STATEMENT_EXPRESSIONS
296 * Support for statement expressions.
298 #ifndef COMPILER_STATEMENT_EXPRESSIONS
299 #define COMPILER_STATEMENT_EXPRESSIONS 0
302 /* A few defaults for missing compiler features. */
304 #define INLINE static inline
307 #define NORETURN /* nothing */
310 #define FORMAT(type,fmt,first) /* nothing */
313 #define DEPRECATED /* nothing */
316 #define UNUSED_ARG(type,arg) type arg
318 #define UNUSED UNUSED_ARG /* OBSOLETE */
320 #define UNUSED_VAR(type,name) type name
323 #define USED_VAR(type,name) type name
326 #define REGISTER /* nothing */
332 #define UNLIKELY(x) x
335 #define PURE_FUNC /* nothing */
338 #define CONST_FUNC /* nothing */
341 #define UNUSED_FUNC /* nothing */
344 #define USED_FUNC /* nothing */
347 #define RESTRICT /* nothing */
350 #define MUST_CHECK /* nothing */
353 /* Misc definitions */
355 #define NULL (void *)0
362 /* Support for hybrid C/C++ applications. */
364 #define EXTERN_C extern "C"
365 #define EXTERN_C_BEGIN extern "C" {
366 #define EXTERN_C_END }
367 #define EXTERN_CONST extern const
368 #define CONST_CAST(TYPE,EXPR) (const_cast<TYPE>(EXPR))
370 #define EXTERN_C extern
371 #define EXTERN_C_BEGIN /* nothing */
372 #define EXTERN_C_END /* nothing */
373 #define EXTERN_CONST const
374 #define CONST_CAST(TYPE,EXPR) ((TYPE)(EXPR)) /* FIXME: How can we suppress the warning in C? */
378 #if defined(_MSC_VER) \
379 || ((defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)) && CPU_I196)
381 * \name ISO C99 fixed-size types
383 * These should be in <stdint.h>, but a few compilers lack them.
386 typedef signed char int8_t;
387 typedef unsigned char uint8_t;
388 typedef short int int16_t;
389 typedef unsigned short int uint16_t;
390 typedef long int int32_t; /* _WIN64 safe */
391 typedef unsigned long int uint32_t; /* _WIN64 safe */
394 typedef __int64 int64_t;
395 typedef unsigned __int64 uint64_t;
397 typedef long long int64_t;
398 typedef unsigned long long uint64_t;
402 /* This is the standard location. */
408 * The ATmega8 has a very small Flash, so we can't afford
409 * to link in support routines for 32bit integer arithmetic.
411 typedef int16_t ticks_t; /**< Type for time expressed in ticks. */
412 typedef int16_t mtime_t; /**< Type for time expressed in milliseconds. */
413 typedef int16_t utime_t; /**< Type for time expressed in microseconds. */
414 #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
415 #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
416 #define MTIME_INFINITE 0x7FFFL
418 typedef int32_t ticks_t; /**< Type for time expressed in ticks. */
419 typedef int32_t mtime_t; /**< Type for time expressed in milliseconds. */
420 typedef int32_t utime_t; /**< Type for time expressed in microseconds. */
421 #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
422 #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
423 #define MTIME_INFINITE 0x7FFFFFFFL
426 /** Bulk storage large enough for both pointers or integers. */
427 typedef void * iptr_t;
429 /** Bulk storage large enough for both pointers to constants or integers. */
430 typedef const void * const_iptr_t;
432 typedef unsigned char sigbit_t; /**< Type for signal bits. */
433 typedef unsigned char sigmask_t; /**< Type for signal masks. */
434 typedef unsigned char page_t; /**< Type for banked memory pages. */
438 * \name Standard type definitions.
440 * These should be in <sys/types.h> or <stddef.h>, but many compilers
441 * and C libraries lack them.
443 * We check for some common definitions to avoid redefinitions:
445 * glibc, avr-libc: _SIZE_T_DEFINED, __ssize_t_defined
446 * Darwin libc: _BSD_SIZE_T_DEFINED_, _SIZE_T
451 #if !(defined(size_t) || defined(_SIZE_T_DEFINED) || defined(_BSD_SIZE_T_DEFINED_) \
454 /* 32bit or 64bit (32bit for _WIN64). */
455 typedef unsigned long size_t;
461 #if !(defined(ssize_t) || defined(_SSIZE_T) || defined(__ssize_t_defined))
463 /* 32bit or 64bit (32bit for _WIN64). */
464 typedef long ssize_t;
468 /* 16bit (missing in avr-libc's sys/types.h). */
478 * \name Types for hardware registers.
480 * Only use these types for registers whose contents can
481 * be changed asynchronously by external hardware.
486 /* Registers can be accessed only through 16-bit pointers */
487 typedef volatile uint16_t reg16_t;
489 typedef volatile uint8_t reg8_t;
490 typedef volatile uint16_t reg16_t;
491 typedef volatile uint32_t reg32_t;
496 /* Quasi-ANSI macros */
499 * Return the byte offset of the member \a m in struct \a s.
501 * \note This macro should be defined in "stddef.h" and is sometimes
502 * compiler-specific (g++ has a builtin for it).
504 #define offsetof(s,m) (size_t)&(((s *)0)->m)
508 * Count the number of elements in the static array \a a.
510 * \note This macro is non-standard, but implements a very common idiom
512 #define countof(a) (sizeof(a) / sizeof(*(a)))
516 * Cast a member of a structure out to the containing structure.
518 * \param ptr the pointer to the member.
519 * \param type the type of the container struct this is embedded in.
520 * \param member the name of the member within the struct.
522 #if COMPILER_TYPEOF && COMPILER_STATEMENT_EXPRESSIONS
523 #define containerof(ptr, type, member) ({ \
524 const typeof( ((type *)0)->member ) *_mptr = (ptr); /* type check */ \
525 (type *)((char *)_mptr - offsetof(type, member)); \
528 #define containerof(ptr, type, member) \
529 ( (type *)((char *)(ptr) - offsetof(type, member)) )
532 /** Issue a compilation error if the \a condition is false */
533 #define STATIC_ASSERT(condition) \
534 UNUSED_VAR(extern char, STATIC_ASSERTION_FAILED__[(condition) ? 1 : -1])
536 #ifndef ASSERT_TYPE_EQUAL
537 /** Ensure two variables have the same type. */
538 #define ASSERT_TYPE_EQUAL(var1, var2) \
539 do { (void)(&(var1) == &(var2)); } while(0)
542 #ifndef ASSERT_TYPE_IS
543 /** Ensure variable is of specified type. */
544 #define ASSERT_TYPE_IS(var, type) \
545 do { (void)(&(var) == (type *)0); } while(0)
548 #endif /* DEVLIB_COMPILER_H */