-/*!
+/**
* \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 Develer S.r.l. (http://www.develer.com/)
- * This file is part of DevLib - See devlib/README for information.
+ *
* -->
*
* \brief Common and handy function macros
* \author Bernardo Innocenti <bernie@develer.com>
* \author Giovanni Bajo <rasky@develer.com>
*/
-
-/*#*
- *#* $Log$
- *#* 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.10 2005/01/22 04:19:50 bernie
- *#* Use non-uglified typeof().
- *#*
- *#* Revision 1.9 2004/12/08 08:51:34 bernie
- *#* Add type-generic macros for C++.
- *#*
- *#* Revision 1.8 2004/10/19 07:14:20 bernie
- *#* Add macros to test for specific compiler features.
- *#*
- *#* Revision 1.7 2004/09/20 03:30:45 bernie
- *#* C++ also has variadic macros.
- *#*
- *#* Revision 1.6 2004/09/14 21:02:04 bernie
- *#* SWAP(), MINMAX(): New macros.
- *#*
- *#* Revision 1.5 2004/08/29 21:57:58 bernie
- *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
- *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
- *#*
- *#* Revision 1.3 2004/08/24 14:13:48 bernie
- *#* Restore a few macros that were lost in the way.
- *#*
- *#* Revision 1.2 2004/08/24 13:32:14 bernie
- *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
- *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
- *#* Trim CVS log;
- *#* Rename header guards;
- *#* Don't include arch_config.h in compiler.h as it's not needed there.
- *#*
- *#* Revision 1.1 2004/08/14 19:37:57 rasky
- *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
- *#*
- *#* Revision 1.4 2004/08/14 18:36:50 rasky
- *#* Doxygen fix e un livello di parentesi aggiuntivi per la macro
- *#*
- *#* Revision 1.3 2004/08/12 20:01:32 rasky
- *#* Aggiunte macro BIT_CHANGE e BIT_CHANGE_BV
- *#*
- *#* Revision 1.2 2004/08/10 21:36:14 rasky
- *#* Aggiunto include macros.h dove serve
- *#* Aggiunta dipendenza da compiler.h in macros.h
- *#*
- *#* Revision 1.1 2004/08/10 21:30:00 rasky
- *#* Estratte le funzioni macro in macros.h
- *#*
- *#*/
-
-#ifndef MACROS_H
-#define MACROS_H
+#ifndef CFG_MACROS_H
+#define CFG_MACROS_H
#include <cfg/compiler.h>
#define MIN(a,b) ({ \
typeof(a) _a = (a); \
typeof(b) _b = (b); \
- (void)(&_a == &_b); /* ensure same type */ \
- (_a < _b) ? _a : _b; \
+ ASSERT_TYPE_EQUAL(_a, _b); \
+ /** \
+ * The (typeof(_a)) cast in necessary: \
+ * result type of conditional expressions is \
+ * *NOT* the type of the value returned but \
+ * the type that would be produced if _a and _b \
+ * were mixed in an expression. \
+ * Even in _a and _b are of the same type, \
+ * if mixed in an expression the type will be \
+ * promoted to int! \
+ */ \
+ ((typeof(_a))((_a < _b) ? _a : _b)); \
})
#define MAX(a,b) ({ \
typeof(a) _a = (a); \
typeof(b) _b = (b); \
- (void)(&_a == &_b); /* ensure same type */ \
- (_a > _b) ? _a : _b; \
+ ASSERT_TYPE_EQUAL(_a, _b); \
+ /** \
+ * The (typeof(_a)) cast in necessary: \
+ * result type of conditional expressions is \
+ * *NOT* the type of the value returned but \
+ * the type that would be produced if _a and _b \
+ * were mixed in an expression. \
+ * Even in _a and _b are of the same type, \
+ * if mixed in an expression the type will be \
+ * promoted to int! \
+ */ \
+ ((typeof(_a))((_a > _b) ? _a : _b)); \
})
#else /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
/* Buggy macros for inferior compilers. */
#define MAX(a,b) (((a) > (b)) ? (a) : (b))
#endif /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
-/*! Bound \a x between \a min and \a max. */
+/** Bound \a x between \a min and \a max. */
#define MINMAX(min,x,max) (MIN(MAX(min, x), max))
#ifdef __cplusplus
/* Use standard implementation from <algorithm> */
#define SWAP(a,b) std::swap(a, b)
#elif COMPILER_TYPEOF
- /*!
+ /**
* Type-generic macro to swap \a a with \a b.
*
* \note Arguments are evaluated multiple times.
*/
#define SWAP(a, b) \
do { \
- (void)(&(a) == &(b)); /* type check */ \
typeof(a) tmp; \
+ ASSERT_TYPE_EQUAL(a, b); \
tmp = (a); \
(a) = (b); \
(b) = tmp; \
} while (0)
#else /* !COMPILER_TYPEOF */
/* Sub-optimal implementation that only works with integral types. */
- #define SWAP(a, b) ((a) ^= (b) ^= (a) ^= (b))
+ #define SWAP(a, b) \
+ do { \
+ (a) ^= (b); \
+ (b) ^= (a); \
+ (a) ^= (b); \
+ } while (0)
+
#endif /* COMPILER_TYPEOF */
+/**
+ * Macro to swap \a a with \a b, with explicit type \a T for dumb C89 compilers.
+ *
+ * \note Arguments are evaluated multiple times.
+ */
+#define SWAP_T(a, b, T) \
+ do { \
+ T tmp; \
+ ASSERT_TYPE_IS(a, T); \
+ ASSERT_TYPE_IS(b, T); \
+ tmp = (a); \
+ (a) = (b); \
+ (b) = tmp; \
+ } while (0)
+
+
#ifndef BV
- /*! Convert a bit value to a binary flag. */
+ /** Convert a bit value to a binary flag. */
#define BV(x) (1<<(x))
#endif
-/*! Round up \a x to an even multiple of the 2's power \a pad */
-#define ROUND2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
+/** Same as BV() but with 32 bit result */
+#define BV32(x) ((uint32_t)1<<(x))
-//! Check if \a x is an integer power of 2
+/** Same as BV() but with 16 bit result */
+#define BV16(x) ((uint16_t)1<<(x))
+
+/** Same as BV() but with 8 bit result */
+#define BV8(x) ((uint8_t)1<<(x))
+
+/**
+ * Perform an integer division rounding the result to the nearest int value.
+ * \note \a divisor should preferibly be a costant, otherwise this macro generates
+ * 2 division. Also divisor is evaluated twice.
+ */
+#define DIV_ROUND(dividend, divisor) (((dividend) + (divisor) / 2) / (divisor))
+
+/** Round up \a x to an even multiple of the 2's power \a pad. */
+#define ROUND_UP2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
+
+/* OBSOLETE */
+#define ROUND2 ROUND_UP2
+
+/**
+ * \name Integer round macros.
+ *
+ * Round \a x to a multiple of \a base.
+ * \note If \a x is signed these macros generate a lot of code.
+ * \{
+ */
+#define ROUND_DOWN(x, base) ( (x) - ((x) % (base)) )
+#define ROUND_UP(x, base) ( ((x) + (base) - 1) - (((x) + (base) - 1) % (base)) )
+#define ROUND_NEAREST(x, base) ( ((x) + (base) / 2) - (((x) + (base) / 2) % (base)) )
+/* \} */
+
+/** Check if \a x is an integer power of 2. */
#define IS_POW2(x) (!(bool)((x) & ((x)-1)))
-/*! Calculate a compile-time log2 for a uint8_t */
+/** Calculate a compile-time log2 for a uint8_t */
#define UINT8_LOG2(x) \
((x) < 2 ? 0 : \
((x) < 4 ? 1 : \
((x) < 64 ? 5 : \
((x) < 128 ? 6 : 7)))))))
-/*! Calculate a compile-time log2 for a uint16_t */
+/** Calculate a compile-time log2 for a uint16_t */
#define UINT16_LOG2(x) \
((x < 256) ? UINT8_LOG2(x) : UINT8_LOG2((x) >> 8) + 8)
-/*! Calculate a compile-time log2 for a uint32_t */
+/** Calculate a compile-time log2 for a uint32_t */
#define UINT32_LOG2(x) \
((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
#if COMPILER_VARIADIC_MACROS
- /*! Count the number of arguments (up to 16). */
+ /** Count the number of arguments (up to 16). */
#define PP_COUNT(...) \
PP_COUNT__(__VA_ARGS__,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
#define PP_COUNT__(a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,count,...) \
#endif
#if COMPILER_VARIADIC_MACROS
- /*!
+ /**
* \def BIT_CHANGE(reg, (mask, value), ...)
*
* This macro allows for efficient and compact bit toggling in a hardware
* for use with C90 compilers, through Boost Preprocessor.
*/
- /*!
+ /**
* \def BIT_CHANGE_BV(reg, (bit, value), ...)
*
* Similar to BIT_CHANGE(), but get bits instead of masks (and applies BV() to convert
#endif /* COMPILER_VARIADIC_MACROS */
+/**
+ * Macro for rotating bit left or right.
+ * \{
+ */
+#define ROTR(var, rot) (((var) >> (rot)) | ((var) << ((sizeof(var) * 8) - (rot))))
+#define ROTL(var, rot) (((var) << (rot)) | ((var) >> ((sizeof(var) * 8) - (rot))))
+/*\}*/
+
+/**
+ * Make an id from 4 letters, useful for
+ * file formats and kfile ids.
+ */
+#define MAKE_ID(a,b,c,d) \
+ ( ((uint32_t)(a) << 24) \
+ | ((uint32_t)(b) << 16) \
+ | ((uint32_t)(c) << 8) \
+ | ((uint32_t)(d) << 0) )
+
+/**
+ * Type for id generated by MAKE_ID().
+ */
+typedef uint32_t id_t;
+
#endif /* MACROS_H */
projects / bertos.git / blobdiff