X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=cfg%2Fmacros.h;h=5e9e25ed04fcf4dd75ef4f8e0d38d8e586e64f49;hb=efbdba7e2814415234ef47bd10ff888559ea90af;hp=41f0b9d3faf3071141e5fa6dd2ef46cac21a468f;hpb=22853ba2260f6dd8dc0e5ccafb95e75fc36cfa29;p=bertos.git

diff --git a/cfg/macros.h b/cfg/macros.h
old mode 100755
new mode 100644
index 41f0b9d3..5e9e25ed
--- a/cfg/macros.h
+++ b/cfg/macros.h
@@ -1,8 +1,33 @@
-/*!
+/**
  * \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
@@ -14,6 +39,27 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.11  2007/02/06 15:22:12  asterix
+ *#* Add ROTL and ROTR macros for bit rotating.
+ *#*
+ *#* Revision 1.10  2006/09/13 18:31:37  bernie
+ *#* BV8(), BV16(), BV32(): New macros for CPUs with small word size; SWAP_T(): New macro to support old compilers.
+ *#*
+ *#* Revision 1.9  2006/07/19 12:56:25  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.8  2006/03/13 02:06:55  bernie
+ *#* ROUND_UP2: Rename from ROUND2.
+ *#*
+ *#* Revision 1.7  2006/02/20 14:34:58  bernie
+ *#* Use portable type checking.
+ *#*
+ *#* Revision 1.6  2006/02/10 12:36:57  bernie
+ *#* Pacify IAR warnings for side-effects.
+ *#*
+ *#* Revision 1.5  2005/11/04 16:20:01  bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
  *#* Revision 1.4  2005/07/03 15:19:09  bernie
  *#* Doxygen fix.
  *#*
@@ -96,13 +142,13 @@
 	#define MIN(a,b) ({ \
 		typeof(a) _a = (a); \
 		typeof(b) _b = (b); \
-		(void)(&_a == &_b); /* ensure same type */ \
+		ASSERT_TYPE_EQUAL(_a, _b); \
 		(_a < _b) ? _a : _b; \
 	})
 	#define MAX(a,b) ({ \
 		typeof(a) _a = (a); \
 		typeof(b) _b = (b); \
-		(void)(&_a == &_b); /* ensure same type */ \
+		ASSERT_TYPE_EQUAL(_a, _b); \
 		(_a > _b) ? _a : _b; \
 	})
 #else /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
@@ -112,40 +158,76 @@
 	#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))
+
+/** 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))
 
-/*!
+
+
+/** 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.
@@ -157,10 +239,10 @@
 #define ROUND_NEAREST(x, base) ( ((x) + (base) / 2) - (((x) + (base) / 2) % (base)) )
 /* \} */
 
-//! Check if \a x is an integer power of 2
+/** 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 : \
@@ -170,16 +252,16 @@
 	     ((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,...) \
@@ -187,7 +269,7 @@
 #endif
 
 #if COMPILER_VARIADIC_MACROS
-	/*!
+	/**
 	 * \def BIT_CHANGE(reg, (mask, value), ...)
 	 *
 	 * This macro allows for efficient and compact bit toggling in a hardware
@@ -226,7 +308,7 @@
 	 * 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
@@ -285,5 +367,13 @@
 
 #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))))
+/*\}*/
+
 #endif /* MACROS_H */