Save some more RAM on AVR.

[bertos.git] / debug.h

diff --git a/debug.h b/debug.h
index 7daee2c38ab97db2756f9c8cea9f038940ec7585..66967a7b7ff0773c65a61ff3cd03d9264e35aef1 100755 (executable)
--- a/debug.h
+++ b/debug.h
@@ -5,11 +5,11 @@
  * This file is part of DevLib - See devlib/README for information.
  * -->
  *
- * \brief Simple debug facilities for hosted and embedded C/C++ applications
+ * \brief Simple debug facilities for hosted and embedded C/C++ applications.
  *
- * Debug output goes to stderr in hosted applications.  Freestanding (AKA embedded)
- * applications use drv/kdebug.c to output diagnostic messages to a serial terminal
- * or a JTAG debugger.
+ * 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>
@@ -17,6 +17,15 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.6  2004/12/08 08:52:00  bernie
+ *#* Save some more RAM on AVR.
+ *#*
+ *#* Revision 1.5  2004/12/08 08:04:13  bernie
+ *#* Doxygen fixes.
+ *#*
+ *#* Revision 1.4  2004/12/08 07:29:27  bernie
+ *#* Fix Doxygen tags.
+ *#*
  *#* Revision 1.3  2004/09/20 03:31:27  bernie
  *#* Sanitize for C++.
  *#*
@@ -67,12 +76,11 @@
        #define UNUSED(type,name) type
        #endif
 #else /* !OS_HOSTED */
+       #include <config.h>
        #include <compiler.h>
 #endif /* !OS_HOSTED */
 
-/*!
- * \def _DEBUG
- *
+/*
  * This preprocessor symbol is defined only in debug builds.
  *
  * The build infrastructure must arrange for _DEBUG to
@@ -113,7 +121,7 @@
         * statements conditioned on \c _DEBUG, avoiding the clutter
         * of #ifdef/#endif pairs.
         *
-        * \example
+        * \code
         *     struct FooBar
         *     {
         *         int foo;
@@ -125,8 +133,7 @@
          *             DB(--ref_count;)
         *         }
         *     };
-        *
-        * \endexample
+        * \endcode
         */
        #define DB(x) x
 
@@ -172,6 +179,7 @@
                void kdbg_init(void);
                void kputchar(char c);
                void kdump(const void *buf, size_t len);
+               void __init_wall(long *wall, int size);
 
                #ifdef __AVR__
                        #include <avr/pgmspace.h>
@@ -179,20 +187,20 @@
                        void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
                        int __assert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
                        int __invalid_ptr_P(void *p, const char *PROGMEM name, const char *PROGMEM file, int line);
+                       int __check_wall_P(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line);
                        #define kputs(str)  kputs_P(PSTR(str))
                        #define kprintf(fmt, ...)  kprintf_P(PSTR(fmt) ,## __VA_ARGS__)
                        #define __assert(cond, file, line)  __assert_P(PSTR(cond), PSTR(file), (line))
                        #define __invalid_ptr(p, name, file, line)  __invalid_ptr_P((p), PSTR(name), PSTR(file), (line))
+                       #define __check_wall(wall, size, name, file, line)  __check_wall_P(wall, size, PSTR(name), PSTR(file), (line))
                #else /* !__AVR__ */
                        void kputs(const char *str);
                        void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2);
                        int __assert(const char *cond, const char *file, int line);
                        int __invalid_ptr(void *p, const char *name, const char *file, int line);
+                       int __check_wall(long *wall, int size, const char *name, const char *file, int line);
                #endif /* !__AVR__ */
 
-               void __init_wall(long *wall, int size);
-               int __check_wall(long *wall, int size, const char *name, const char *file, int line);
-
                #ifndef CONFIG_KDEBUG_ASSERT_NO_TEXT
                        #define ASSERT(x)         ((void)(LIKELY(x) ? 0 : __assert(#x, THIS_FILE, __LINE__)))
                        #define ASSERT2(x, help)  ((void)(LIKELY(x) ? 0 : __assert(help " (" #x ")", THIS_FILE, __LINE__)))
@@ -235,7 +243,7 @@
         * These macros help track some kinds of leaks in C++ programs.
         * Usage is as follows:
         *
-        * \example
+        * \code
         *   class Foo
         *   {
         *       DECLARE_INSTANCE_TRACKING(Foo)
@@ -264,8 +272,8 @@
         *        delete foo;
         *        ASSERT_ZERO_INSTANCES(Foo); // OK
         *   }
-        *
-        * \end example
+        * \endcode
+        * \{
         */
        #define NEW_INSTANCE(CLASS)                do { ++CLASS::__instances } while (0)
        #define DELETE_INSTANCE(CLASS)             do { --CLASS::__instances } while (0)
@@ -273,6 +281,7 @@
        #define GET_INSTANCE_COUNT(CLASS)          (CLASS::__instances)
        #define DECLARE_INSTANCE_TRACKING(CLASS)   static int __instances
        #define IMPLEMENT_INSTANCE_TRACKING(CLASS) int CLASS::__instances = 0
+       /*\}*/
 
 #else /* !_DEBUG */