Doc fixes.
[bertos.git] / cfg / compiler.h
old mode 100755 (executable)
new mode 100644 (file)
index 7174eb1..a303dc7
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2001, 2002, 2003 Bernardo Innocenti <bernie@codewiz.org>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief Additional support macros for compiler independance
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.16  2006/03/20 17:48:09  bernie
- *#* Fix for avr-libc; INTERRUPT(): Remove macro.
- *#*
- *#* Revision 1.15  2006/03/13 02:06:25  bernie
- *#* containerof(): New macro.
- *#*
- *#* Revision 1.14  2006/02/23 08:36:33  bernie
- *#* Emulate __func__ on MSVC.
- *#*
- *#* Revision 1.13  2006/02/23 07:37:37  bernie
- *#* Compile fix for MSVC.
- *#*
- *#* Revision 1.12  2006/02/21 16:06:31  bernie
- *#* Fix ssize_t redefinitions on glibc systems.
- *#*
- *#* Revision 1.11  2006/02/20 14:34:58  bernie
- *#* Use portable type checking.
- *#*
- *#* Revision 1.10  2006/02/15 09:12:01  bernie
- *#* Fixes for ARM/IAR support.
- *#*
- *#* Revision 1.9  2006/02/10 12:38:00  bernie
- *#* Add support for ARM on IAR.
- *#*
- *#* Revision 1.8  2006/01/16 03:27:49  bernie
- *#* Rename sig_t to sigbit_t to avoid clash with POSIX.
- *#*
- *#* Revision 1.7  2005/11/27 23:33:05  bernie
- *#* Drop avr-libc hack for missing stdint.h.
- *#*
- *#* Revision 1.6  2005/07/19 07:27:31  bernie
- *#* Don't use CPU_REG_BITS from cpu.h to avoid circular header dependendy.
- *#*
- *#* Revision 1.5  2005/06/27 21:24:37  bernie
- *#* ticks_t: New typedef.
- *#*
- *#* Revision 1.4  2005/06/14 06:15:10  bernie
- *#* Add X86_64 support.
- *#*
- *#* Revision 1.3  2005/04/12 01:37:01  bernie
- *#* Metrowerks touchups from HeCo.
- *#*
- *#* Revision 1.2  2005/04/11 19:10:27  bernie
- *#* Include top-level headers from cfg/ subdir.
- *#*
- *#* Revision 1.1  2005/04/11 19:04:13  bernie
- *#* Move top-level headers to cfg/ subdir.
- *#*
- *#* Revision 1.44  2005/03/29 06:39:59  bernie
- *#* setjmp.h, time_t: Remove ancient retrocompatibility; Remove MSVC double to float hack.
- *#*
- *#* Revision 1.43  2005/03/01 23:15:12  bernie
- *#* Remove compatibility hack.
- *#*
- *#* Revision 1.42  2005/02/16 20:28:46  bernie
- *#* Move PGM macros to mware/pgm.h
- *#*
- *#* Revision 1.41  2005/01/22 04:19:22  bernie
- *#* MTIME_INFINITE: New constant.
- *#*
- *#* Revision 1.40  2005/01/20 18:46:04  aleph
- *#* Add progmem datatypes; PSTR() definition.
- *#*/
-#ifndef DEVLIB_COMPILER_H
-#define DEVLIB_COMPILER_H
-
-#include <cfg/cpu_detect.h>
+#ifndef BERTOS_COMPILER_H
+#define BERTOS_COMPILER_H
+
+#include <cpu/detect.h>
 
 
 #if defined __GNUC__ && defined __GNUC_MINOR__
 #endif
 
 
-/*! Concatenate two different preprocessor tokens (allowing macros to expand) */
+/** Concatenate two different preprocessor tokens (allowing macros to expand) */
 #define PP_CAT(x,y)         PP_CAT__(x,y)
 #define PP_CAT__(x,y)       x ## y
 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
 
-/*! String-ize a token (allowing macros to expand) */
+/** String-ize a token (allowing macros to expand) */
 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
 #define PP_STRINGIZE__(x)   #x
 
        /* MSVC doesn't support C99's __func__, but has a similar extension. */
        #define __func__ __FUNCTION__
 
+       /* MSVC doesn't support C99's inline keyword */
+       #ifndef __cplusplus
+               #define INLINE __inline
+       #endif
+
 #elif defined(__GNUC__)
 
        /* Compiler features */
        #define USED_FUNC               __attribute__((__used__))
        #define RESTRICT                __restrict__
        #define MUST_CHECK              __attribute__((warn_unused_result))
+       #define PACKED                  __attribute__((packed))
+       /**
+        * Force compiler to realod context variable.
+        */
+       #define MEMORY_BARRIER           asm volatile ("" : : : "memory")
+
        #if GNUC_PREREQ(3,1)
                #define DEPRECATED  __attribute__((__deprecated__))
        #endif
                #pragma GCC poison cin cout cerr clog
        #endif
 
+
+
 #elif defined(__MWERKS__)
 
        /* Compiler features */
 
 /* Defaults for compiler extensions. */
 
-/*!
+/**
  * \def COMPILER_VARIADIC_MACROS
  * Support for macros with variable arguments.
  */
 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
 #endif
 
-/*!
+/**
  * \def COMPILER_TYPEOF
  * Support for dynamic type identification.
  */
 #define COMPILER_TYPEOF 0
 #endif
 
-/*!
+/**
  * \def COMPILER_STATEMENT_EXPRESSIONS
  * Support for statement expressions.
  */
 #ifndef MUST_CHECK
 #define MUST_CHECK             /* nothing */
 #endif
+#ifndef PACKED
+#define PACKED                 /* nothing */
+#endif
+#ifndef MEMORY_BARRIER
+#define MEMORY_BARRIER         /* nothing */
+#warning No memory barrier defined for select compiler. If you use the kernel check it.
+#endif
+
 
 /* Misc definitions */
 #ifndef NULL
 #define        EOF   (-1)
 #endif
 
-
 /* Support for hybrid C/C++ applications. */
 #ifdef __cplusplus
        #define EXTERN_C        extern "C"
        #define EXTERN_C_BEGIN  extern "C" {
        #define EXTERN_C_END    }
-       #define EXTERN_CONST    extern const
+       #define EXTERN_CONST    extern const
+       #define CONST_CAST(TYPE,EXPR)   (const_cast<TYPE>(EXPR))
 #else
        #define EXTERN_C        extern
        #define EXTERN_C_BEGIN  /* nothing */
        #define EXTERN_C_END    /* nothing */
-       #define EXTERN_CONST    const
+       #define EXTERN_CONST    const
+       #define CONST_CAST(TYPE,EXPR)   ((TYPE)(EXPR)) /* FIXME: How can we suppress the warning in C? */
 #endif
 
 
 #if defined(_MSC_VER) \
        || ((defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)) && CPU_I196)
-       /*!
+       /**
         * \name ISO C99 fixed-size types
         *
         * These should be in <stdint.h>, but a few compilers lack them.
         * The ATmega8 has a very small Flash, so we can't afford
         * to link in support routines for 32bit integer arithmetic.
         */
-       typedef int16_t ticks_t;  /*!< Type for time expressed in ticks. */
-       typedef int16_t mtime_t;  /*!< Type for time expressed in milliseconds. */
-       typedef int16_t utime_t;  /*!< Type for time expressed in microseconds. */
+       typedef int16_t ticks_t;  /**< Type for time expressed in ticks. */
+       typedef int16_t mtime_t;  /**< Type for time expressed in milliseconds. */
+       typedef int16_t utime_t;  /**< Type for time expressed in microseconds. */
        #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
        #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
        #define MTIME_INFINITE 0x7FFFL
 #else
-       typedef int32_t ticks_t;  /*!< Type for time expressed in ticks. */
-       typedef int32_t mtime_t;  /*!< Type for time expressed in milliseconds. */
-       typedef int32_t utime_t;  /*!< Type for time expressed in microseconds. */
-       #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
+       typedef int32_t ticks_t;  /**< Type for time expressed in ticks. */
+
+       typedef int32_t utime_t;  /**< Type for time expressed in microseconds. */
        #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
-       #define MTIME_INFINITE 0x7FFFFFFFL
+
+       #ifndef DEVLIB_MTIME_DEFINED
+               #define DEVLIB_MTIME_DEFINED 1 /* Resolve conflict with <os/hptime.h> */
+               typedef int32_t mtime_t;  /**< Type for time expressed in milliseconds. */
+               #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
+               #define MTIME_INFINITE 0x7FFFFFFFL
+       #endif
 #endif
 
-/*! Bulk storage large enough for both pointers or integers. */
+/** Bulk storage large enough for both pointers or integers. */
 typedef void * iptr_t;
 
-/*! Bulk storage large enough for both pointers to constants or integers. */
+/** Bulk storage large enough for both pointers to constants or integers. */
 typedef const void * const_iptr_t;
 
-typedef unsigned char sigbit_t;  /*!< Type for signal bits. */
-typedef unsigned char sigmask_t; /*!< Type for signal masks. */
-typedef unsigned char page_t;    /*!< Type for banked memory pages. */
+typedef unsigned char sigbit_t;  /**< Type for signal bits. */
+typedef unsigned char sigmask_t; /**< Type for signal masks. */
+typedef unsigned char page_t;    /**< Type for banked memory pages. */
 
 
-/*!
+/**
  * \name Standard type definitions.
  *
  * These should be in <sys/types.h> or <stddef.h>, but many compilers
@@ -467,7 +454,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
 /*\}*/
 
 
-/*!
+/**
  * \name Types for hardware registers.
  *
  * Only use these types for registers whose contents can
@@ -488,7 +475,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
 
 /* Quasi-ANSI macros */
 #ifndef offsetof
-       /*!
+       /**
         * Return the byte offset of the member \a m in struct \a s.
         *
         * \note This macro should be defined in "stddef.h" and is sometimes
@@ -497,7 +484,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
        #define offsetof(s,m)  (size_t)&(((s *)0)->m)
 #endif
 #ifndef countof
-       /*!
+       /**
         * Count the number of elements in the static array \a a.
         *
         * \note This macro is non-standard, but implements a very common idiom
@@ -522,20 +509,20 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
                ( (type *)((char *)(ptr) - offsetof(type, member)) )
 #endif
 
-/*! Issue a compilation error if the \a condition is false */
+/** Issue a compilation error if the \a condition is false */
 #define STATIC_ASSERT(condition)  \
        UNUSED_VAR(extern char, STATIC_ASSERTION_FAILED__[(condition) ? 1 : -1])
 
 #ifndef ASSERT_TYPE_EQUAL
-/*! Ensure two variables have the same type. */
-#define ASSERT_TYPE_EQUAL(var1, var2)  \
-               do { (void)(&(var1) == &(var2)); } while(0)
+       /** Ensure two variables have the same type. */
+       #define ASSERT_TYPE_EQUAL(var1, var2)  \
+                       do { (void)(&(var1) == &(var2)); } while(0)
 #endif
 
 #ifndef ASSERT_TYPE_IS
-/** Ensure variable is of specified type. */
-#define ASSERT_TYPE_IS(var, type)  \
-               do { (void)(&(var) == (type *)0); } while(0)
+       /** Ensure variable is of specified type. */
+       #define ASSERT_TYPE_IS(var, type)  \
+                       do { (void)(&(var) == (type *)0); } while(0)
 #endif
 
-#endif /* DEVLIB_COMPILER_H */
+#endif /* BERTOS_COMPILER_H */