X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fcfg%2Fdebug.h;h=efa26e18907a8102699d3ca125cf099abf43dbf3;hb=183859226be37f23232f080b9e7457113a0faeb7;hp=7d457487677fea83173d66f2d777b019b821e3b4;hpb=eb8b43262e8b6d98f3af877a86c142a83a1c6ce5;p=bertos.git

diff --git a/bertos/cfg/debug.h b/bertos/cfg/debug.h
index 7d457487..efa26e18 100644
--- a/bertos/cfg/debug.h
+++ b/bertos/cfg/debug.h
@@ -30,14 +30,23 @@
  *
  * -->
  *
+ * \defgroup debug Debugging facilities and macros
+ * \ingroup core
+ * \{
+ *
  * \brief Simple debug facilities for hosted and embedded C/C++ applications.
  *
  * Debug output goes to stderr in hosted applications.
  * Freestanding (AKA embedded) applications use \c drv/kdebug.c to output
  * diagnostic messages to a serial terminal or a JTAG debugger.
  *
- * \version $Id$
- * \author Bernardo Innocenti <bernie@develer.com>
+ * \author Bernie Innocenti <bernie@codewiz.org>
+ *
+ * $WIZ$ module_name = "debug"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_debug.h"
+ * $WIZ$ DEBUG = 1
+ * $WIZ$ module_depends = "formatwr"
+ * $WIZ$ module_supports = "not atmega103"
  */
 
 #ifndef BERTOS_DEBUG_H
@@ -129,7 +138,7 @@
 	void __init_wall(long *wall, int size);
 
 	#if CPU_HARVARD
-		#include <mware/pgm.h>
+		#include <cpu/pgm.h>
 		void kputs_P(const char *PROGMEM str);
 		void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
 		int __bassert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
@@ -155,28 +164,44 @@
 	#endif /* !CPU_HARVARD */
 
 	#if !CONFIG_KDEBUG_ASSERT_NO_TEXT
+		/**
+		 * Assert a pre-condition on code.
+		 */
 		#define ASSERT(x)         ((void)(LIKELY(x) ? 0 : __bassert(#x, THIS_FILE, __LINE__)))
+		/**
+		 * Assert a pre-condition and give explanation message when assert fails
+		 */
 		#define ASSERT2(x, help)  ((void)(LIKELY(x) ? 0 : __bassert(help " (" #x ")", THIS_FILE, __LINE__)))
 	#else
 		#define ASSERT(x)         ((void)(LIKELY(x) ? 0 : __bassert("", THIS_FILE, __LINE__)))
 		#define ASSERT2(x, help)  ((void)ASSERT(x))
 	#endif
 
+	#define IS_VALID_PTR(p) (LIKELY((void *)(p) >= (void *)CPU_RAM_START))
 	/**
 	 * Check that the given pointer is either NULL or pointing to valid memory.
 	 *
 	 * The assumption here is that valid pointers never point to low
 	 * memory regions.  This helps catching pointers taken from
 	 * struct/class memebers when the struct pointer was NULL.
+	 *
+	 * \see ASSERT_VALID_PTR_OR_NULL()
 	 */
-	#define ASSERT_VALID_PTR(p)         ((void)(LIKELY((p) >= 0x200) ? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__)))
+	#define ASSERT_VALID_PTR(p) (IS_VALID_PTR(p) \
+		? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__))
 
 	/**
 	 * Check that the given pointer is not pointing to invalid memory.
 	 *
+	 * \note The check for invalid memory is architecture specific and
+	 *       conservative.  The current implementation only checks against
+	 *       a lower bound.
+	 *
 	 * \see ASSERT_VALID_PTR()
 	 */
-	#define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) || ((p) >= 0x200)) ? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
+	#define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) \
+		|| ((void *)(p) >= (void *)CPU_RAM_START)) \
+		? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
 
 	#if !CONFIG_KDEBUG_DISABLE_TRACE
 		#define TRACE  __trace(__func__)
@@ -269,6 +294,7 @@
 		#define ASSERT(x)  ((void)0)
 	#endif /* ASSERT */
 	#define ASSERT2(x, help)             ((void)0)
+	#define IS_VALID_PTR(p)              (1)
 	#define ASSERT_VALID_PTR(p)          ((void)0)
 	#define ASSERT_VALID_PTR_OR_NULL(p)  ((void)0)
 	#define ASSERT_VALID_OBJ(_t, _o)     ((void)0)
@@ -310,4 +336,6 @@
 
 #endif /* _DEBUG */
 
+/** \} */ // defgroup debug
+
 #endif /* BERTOS_DEBUG_H */