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.34 2004/11/28 23:21:33 bernie
18 *#* Use mtime_t instead of overloading ANSI time_t with new semantics.
20 *#* Revision 1.33 2004/11/16 23:09:40 bernie
21 *#* size_t: Add 64bit definitions; time_t: Add 16bit hack for tiny CPUs.
23 *#* Revision 1.32 2004/11/16 22:42:44 bernie
26 *#* Revision 1.31 2004/11/16 22:37:28 bernie
27 *#* IPTR: Remove obsolete definition.
29 *#* Revision 1.30 2004/11/16 22:30:19 bernie
30 *#* Declare fixed-size types before other types.
32 *#* Revision 1.29 2004/11/16 20:34:40 bernie
33 *#* UNUSED_VAR, USED_VAR, USED_FUNC: New macros; UNUSED_ARG: Rename from UNUSED.
35 *#* Revision 1.28 2004/10/21 11:03:52 bernie
38 *#* Revision 1.27 2004/10/21 10:09:40 bernie
39 *#* Remove spurious token in preprocessor directive.
41 *#* Revision 1.26 2004/10/19 08:55:14 bernie
42 *#* UNUSED_FUNC: New function attribute.
44 *#* Revision 1.25 2004/10/19 07:14:20 bernie
45 *#* Add macros to test for specific compiler features.
47 *#* Revision 1.24 2004/10/03 18:35:13 bernie
48 *#* Poison C++ keywords in C programs for better portability.
50 *#* Revision 1.23 2004/09/20 03:30:27 bernie
51 *#* Remove vsprintf_P() proto, no longer needed with avr-libc 1.0.4.
53 *#* Revision 1.22 2004/09/14 21:03:04 bernie
54 *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
56 *#* Revision 1.21 2004/09/06 21:38:31 bernie
57 *#* Misc documentation and style fixes.
59 *#* Revision 1.20 2004/08/29 21:57:58 bernie
60 *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
61 *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
63 *#* Revision 1.19 2004/08/25 14:12:08 rasky
64 *#* Aggiornato il comment block dei log RCS
66 *#* Revision 1.18 2004/08/24 16:32:37 bernie
67 *#* Document custom types.
69 *#* Revision 1.17 2004/08/24 13:32:14 bernie
70 *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
71 *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
73 *#* Rename header guards;
74 *#* Don't include arch_config.h in compiler.h as it's not needed there.
76 *#* Revision 1.16 2004/08/14 19:37:57 rasky
77 *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
79 *#* Revision 1.15 2004/08/13 03:23:26 bernie
80 *#* Adjust a few MSVC tweaks from older projects.
82 *#* Revision 1.14 2004/08/10 06:56:29 bernie
83 *#* RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
85 *#* Revision 1.13 2004/08/02 20:20:29 aleph
86 *#* Merge from project_ks
88 *#* Revision 1.12 2004/08/01 01:21:17 bernie
89 *#* LIKELY(), UNLIKELY(): New compiler-specific macros.
91 *#* Revision 1.11 2004/07/30 14:34:10 rasky
92 *#* Vari fix per documentazione e commenti
93 *#* Aggiunte PP_CATn e STATIC_ASSERT
95 *#* Revision 1.10 2004/07/30 14:15:53 rasky
96 *#* Nuovo supporto unificato per detect della CPU
98 *#* Revision 1.9 2004/07/29 22:57:09 bernie
99 *#* vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
101 #ifndef DEVLIB_COMPILER_H
102 #define DEVLIB_COMPILER_H
104 #include "cpu_detect.h"
107 #if defined __GNUC__ && defined __GNUC_MINOR__
108 #define GNUC_PREREQ(maj, min) \
109 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
111 #define GNUC_PREREQ(maj, min) 0
114 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
115 #define COMPILER_C99 1
117 #define COMPILER_C99 0
121 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
122 #define PP_CAT(x,y) PP_CAT__(x,y)
123 #define PP_CAT__(x,y) x ## y
124 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
125 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
126 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
128 /*! String-ize a token (allowing macros to expand) */
129 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
130 #define PP_STRINGIZE__(x) #x
133 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
134 #pragma language=extended
135 #define INTERRUPT(x) interrupt [x]
136 #define REGISTER shortad
137 #define INLINE /* unsupported */
139 /* Imported from <longjmp.h>. Unfortunately, we can't just include
140 * this header because it typedefs jmp_buf to be an array of chars.
141 * This would allow the compiler to place the buffer on an odd address.
142 * The CPU _should_ be able to perform word accesses to
143 * unaligned data, but there are *BUGS* in the 80196KC with
144 * some combinations of opcodes and addressing modes. One of
145 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
146 * provided by the IAR compiler ANSI C library. When ?GR contains
147 * an odd address, surprisingly the CPU will copy the high order
148 * byte of the source operand (SP) in the low order byte of the
149 * destination operand (the memory location pointed to by ?GR).
151 * We also need to replace the library setjmp()/longjmp() with
152 * our own versions because the IAR implementation "forgets" to
153 * save the contents of local registers (?LR).
157 void * sp; /* Stack pointer */
158 void * return_addr; /* Return address */
159 int lr[6]; /* 6 local registers */
162 typedef struct _JMP_BUF jmp_buf[1];
164 int setjmp(jmp_buf env);
165 void longjmp(jmp_buf env, int val);
167 /* Fake bool support */
170 typedef unsigned char bool;
172 #elif defined(_MSC_VER) /* Win32 emulation support */
175 #include <time.h> /* for time_t */
177 /* FIXME: I can't remember why exactly this was needed (NdBernie) */
180 /* Fake bool support */
185 #endif /* !__cplusplus */
187 /* These C99 functions are oddly named in MSVCRT32.lib */
188 #define snprintf _snprintf
189 #define vsnprintf _vsnprintf
191 #elif defined(__GNUC__)
193 /* Compiler features */
194 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
195 #define COMPILER_TYPEOF 1
196 #define COMPILER_STATEMENT_EXPRESSIONS 1
199 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
200 #define NORETURN __attribute__((__noreturn__))
201 #define UNUSED_ARG(type,arg) __attribute__((__unused__)) type arg
202 #define UNUSED_VAR(type,name) __attribute__((__unused__)) type name
203 #define USED_VAR(type,name) __attribute__((__used__)) type name
204 #define INLINE static inline __attribute__((__always_inline__))
205 #define LIKELY(x) __builtin_expect(!!(x), 1)
206 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
207 #define PURE_FUNC __attribute__((pure))
208 #define CONST_FUNC __attribute__((const))
209 #define UNUSED_FUNC __attribute__((unused))
210 #define USED_FUNC __attribute__((__used__))
211 #define RESTRICT __restrict__
212 #define MUST_CHECK __attribute__((warn_unused_result))
214 #define DEPRECATED __attribute__((__deprecated__))
219 /* Hack to avoid conflicts with system type */
220 #define sigset_t system_sigset_t
224 #undef system_sigset_t
231 /* Support for harvard architectures */
233 #define PGM_READ_CHAR(s) pgm_read_byte(s)
234 #define PGM_FUNC(x) x ## _P
235 #define PGM_ATTR PROGMEM
242 * Disallow some C++ keywords as identifiers in C programs,
243 * for improved portability.
245 #pragma GCC poison new delete class template typename
246 #pragma GCC poison private protected public operator
247 #pragma GCC poison friend mutable using namespace
248 #pragma GCC poison cin cout cerr clog
251 #elif defined(__MWERKS__) && CPU_DSP56K
253 /* Compiler features */
254 #define COMPILER_TYPEOF 1
255 #define COMPILER_STATEMENT_EXPRESSIONS 1
262 // CodeWarrior has size_t as built-in type, but does not define this symbol.
263 #define _SIZE_T_DEFINED
266 #error unknown compiler
270 /* Defaults for compiler extensions. */
273 * \def COMPILER_VARIADIC_MACROS
274 * Support for macros with variable arguments.
276 #ifndef COMPILER_HAVE_VARIADIC_MACROS
277 #define COMPILER_HAVE_VARIADIC_MACROS (COMPILER_C99 != 0)
281 * \def COMPILER_TYPEOF
282 * Support for macros with variable arguments.
284 #ifndef COMPILER_TYPEOF
285 #define COMPILER_TYPEOF 0
289 * \def COMPILER_STATEMENT_EXPRESSIONS
290 * Support for macros with variable arguments.
292 #ifndef COMPILER_STATEMENT_EXPRESSIONS
293 #define COMPILER_STATEMENT_EXPRESSIONS 0
296 /* A few defaults for missing compiler features. */
298 #define INLINE static inline
301 #define NORETURN /* nothing */
304 #define FORMAT(type,fmt,first) /* nothing */
307 #define DEPRECATED /* nothing */
310 #define UNUSED_ARG(type,arg) type arg
312 #define UNUSED UNUSED_ARG /* OBSOLETE */
314 #define UNUSED_VAR(type,name) type name
317 #define USED_VAR(type,name) type name
320 #define REGISTER /* nothing */
323 #define INTERRUPT(x) ERROR_NOT_IMPLEMENTED
329 #define UNLIKELY(x) x
332 #define PURE_FUNC /* nothing */
335 #define CONST_FUNC /* nothing */
338 #define UNUSED_FUNC /* nothing */
341 #define USED_FUNC /* nothing */
344 #define RESTRICT /* nothing */
347 #define MUST_CHECK /* nothing */
350 /* Support for harvard architectures */
352 #define PSTR /* nothing */
354 #ifndef PGM_READ_CHAR
355 #define PGM_READ_CHAR(s) (*(s))
358 #define PGM_FUNC(x) x
361 #define PGM_ATTR /* nothing */
365 /* Misc definitions */
367 #define NULL (void *)0
374 /* Support for hybrid C/C++ applications. */
376 #define EXTERN_C extern "C"
377 #define EXTERN_C_BEGIN extern "C" {
378 #define EXTERN_C_END }
380 #define EXTERN_C extern
381 #define EXTERN_C_BEGIN /* nothing */
382 #define EXTERN_C_END /* nothing */
386 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
388 * \name ISO C99 fixed-size types
390 * These should be in <stdint.h>, but many compilers lack them.
393 typedef signed char int8_t;
394 typedef short int int16_t;
395 typedef long int int32_t;
396 typedef unsigned char uint8_t;
397 typedef unsigned short int uint16_t;
398 typedef unsigned long int uint32_t;
400 #elif defined(__GNUC__) && CPU_AVR
401 /* avr-libc is weird... */
402 #include <inttypes.h>
404 /* This is the correct location. */
411 * The ATmega8 has a very small Flash, so we can't afford
412 * to link in support routines for 32bit integer arithmetic.
414 typedef int16_t mtime_t; /*!< Type for time expressed in milliseconds. */
415 typedef int16_t utime_t; /*!< Type for time expressed in microseconds. */
416 #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
417 #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
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)
425 /*! Bulk storage large enough for both pointers or integers. */
426 typedef void * iptr_t;
427 typedef const void * const_iptr_t;
429 typedef unsigned char sig_t; /*!< Type for signal bits. */
430 typedef unsigned char sigset_t; /*!< Type for signal masks. */
431 typedef unsigned char page_t; /*!< Type for banked memory pages. */
435 * \name Standard type definitions.
437 * These should be in <sys/types.h>, but many compilers lack them.
441 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
442 #if CPU_REG_BITS > 32
444 typedef unsigned long size_t;
445 typedef long ssize_t;
447 /* 32bit or 16bit. */
448 typedef unsigned int size_t;
453 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
454 /*! For backwards compatibility. Use mtime_t in new code. */
455 #define time_t mtime_t
456 #define SIZEOF_TIME_T SIZEOF_MTIME_T
458 /* Just a guess, but quite safe. */
459 #define SIZEOF_TIME_T SIZEOF_LONG
460 #endif /* _TIME_T_DEFINED || __time_t_defined */
465 * \name Types for hardware registers.
467 * Only use these types for registers whose contents can
468 * be changed asynchronously by external hardware.
473 /* Registers can be accessed only through 16-bit pointers */
474 typedef volatile uint16_t reg16_t;
476 typedef volatile uint8_t reg8_t;
477 typedef volatile uint16_t reg16_t;
478 typedef volatile uint32_t reg32_t;
483 /* Quasi-ANSI macros */
486 * Return the byte offset of the member \a m in struct \a s.
488 * \note This macro should be defined in "stddef.h" and is sometimes
489 * compiler-specific (g++ has a builtin for it).
491 #define offsetof(s,m) (size_t)&(((s *)0)->m)
495 * Count the number of elements in the static array \a a.
497 * \note This macro is non-standard, but implements a very common idiom
499 #define countof(a) (sizeof(a) / sizeof(*(a)))
502 /*! Issue a compilation error if the \a condition is false */
503 #define STATIC_ASSERT(condition) \
504 UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
506 #endif /* DEVLIB_COMPILER_H */