Typo.
[bertos.git] / drv / kdebug.c
index 88554e9571faedaa94bb374540140b7e809c9956..bd21cbbbf7700bf57b5226863cd33815f493c7c7 100755 (executable)
@@ -1,9 +1,9 @@
-/*!
+/**
  * \file
  * <!--
- * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000, 2001, 2002 Bernardo Innocenti <bernie@codewiz.org>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of DevLib - See README.devlib for information.
  * -->
  *
  * \brief General pourpose debug support for embedded systems (implementation).
 
 /*#*
  *#* $Log$
- *#* Revision 1.17  2004/10/03 18:41:28  bernie
- *#* Restore \version header killed by mistake in previous commit.
+ *#* Revision 1.28  2006/07/19 12:56:25  bernie
+ *#* Convert to new Doxygen style.
  *#*
- *#* Revision 1.16  2004/10/03 18:40:50  bernie
- *#* Use new CPU macros.
+ *#* Revision 1.27  2006/06/01 12:32:06  marco
+ *#* Updated include reference.
  *#*
- *#* Revision 1.15  2004/09/14 21:03:46  bernie
- *#* Use debug.h instead of kdebug.h.
+ *#* Revision 1.26  2006/04/27 05:40:27  bernie
+ *#* Break on assertion failures.
  *#*
- *#* Revision 1.14  2004/09/06 21:39:56  bernie
- *#* Allow partial redefinition of BUS macros.
+ *#* Revision 1.25  2005/06/27 21:26:24  bernie
+ *#* Misc PGM fixes.
  *#*
- *#* Revision 1.13  2004/08/29 22:04:26  bernie
- *#* Convert 485 macros to generic BUS macros;
- *#* kputchar(): New public function.
+ *#* Revision 1.24  2005/04/12 01:36:37  bernie
+ *#* Add hack to enable TX line at module initialization.
  *#*
- *#* Revision 1.12  2004/08/25 14:12:08  rasky
- *#* Aggiornato il comment block dei log RCS
+ *#* Revision 1.23  2005/04/11 19:10:27  bernie
+ *#* Include top-level headers from cfg/ subdir.
  *#*
- *#* Revision 1.11  2004/08/24 16:19:08  bernie
- *#* kputchar(): New public function; Add missing dummy inlines for \!_DEBUG.
+ *#* Revision 1.22  2005/02/18 11:18:33  bernie
+ *#* Fixes for Harvard processors from project_ks.
  *#*
- *#* Revision 1.10  2004/08/04 15:57:50  rasky
- *#* Cambiata la putchar per kdebug per DSP56k: la nuova funzione e' quella piu' a basso livello (assembly)
+ *#* Revision 1.21  2005/02/16 20:29:48  bernie
+ *#* TRACE(), TRACEMSG(): Reduce code and data footprint.
  *#*
- *#* Revision 1.9  2004/08/02 20:20:29  aleph
- *#* Merge from project_ks
- *#*
- *#* Revision 1.8  2004/07/30 14:26:33  rasky
- *#* Semplificato l'output dell'ASSERT
- *#* Aggiunta ASSERT2 con stringa di help opzionalmente disattivabile
- *#*
- *#* Revision 1.7  2004/07/30 14:15:53  rasky
- *#* Nuovo supporto unificato per detect della CPU
- *#*
- *#* Revision 1.6  2004/07/18 21:49:28  bernie
- *#* Add ATmega8 support.
- *#*
- *#* Revision 1.5  2004/06/27 15:20:26  aleph
- *#* Change UNUSED() macro to accept two arguments: type and name;
- *#* Add macro GNUC_PREREQ to detect GCC version during build;
- *#* Some spacing cleanups and typo fix
- *#*
- *#* Revision 1.4  2004/06/06 18:09:51  bernie
- *#* Import DSP56800 changes; Print broken wall bricks in hex.
- *#*
- *#* Revision 1.3  2004/06/03 11:27:09  bernie
- *#* Add dual-license information.
- *#*
- *#* Revision 1.2  2004/05/23 18:21:53  bernie
- *#* Trim CVS logs and cleanup header info.
+ *#* Revision 1.20  2005/01/25 08:36:40  bernie
+ *#* kputnum(): Export.
  *#*
+ *#* Revision 1.19  2004/12/31 17:47:45  bernie
+ *#* Rename UNUSED() to UNUSED_ARG().
  *#*/
 
-#include <debug.h>
-#include <cpu.h>
-#include "hw.h"
-#include "config.h"
+#include <cfg/debug.h>
+#include <cfg/cpu.h>
+#include <cfg/macros.h> /* for BV() */
+#include <appconfig.h>
+#include <hw_cpu.h>     /* for CLOCK_FREQ */
 
 #include <mware/formatwr.h> /* for _formatted_write() */
 
                /*
                 * Support for special bus policies or external transceivers
                 * on UART0 (to be overridden in "hw.h").
+                *
+                * HACK: if we don't set TXEN, kdbg disables the transmitter
+                * after each output statement until the serial driver
+                * is initialized.  These glitches confuse the debug
+                * terminal that ends up printing some trash.
                 */
                #ifndef KDBG_UART0_BUS_INIT
-               #define KDBG_UART0_BUS_INIT  do {} while (0)
+               #define KDBG_UART0_BUS_INIT  do { \
+                               UCSR0B = BV(TXEN); \
+                       } while (0)
                #endif
                #ifndef KDBG_UART0_BUS_RX
                #define KDBG_UART0_BUS_RX    do {} while (0)
                #define KDBG_UART0_BUS_TX    do {} while (0)
                #endif
 
-               #if CPU_AVR_ATMEGA64
+               #if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128
                        #define UCR UCSR0B
                        #define UDR UDR0
                        #define USR UCSR0A
                /*
                 * Support for special bus policies or external transceivers
                 * on UART1 (to be overridden in "hw.h").
+                *
+                * HACK: if we don't set TXEN, kdbg disables the transmitter
+                * after each output statement until the serial driver
+                * is initialized.  These glitches confuse the debug
+                * terminal that ends up printing some trash.
                 */
                #ifndef KDBG_UART1_BUS_INIT
-               #define KDBG_UART1_BUS_INIT  do {} while (0)
+               #define KDBG_UART1_BUS_INIT  do { \
+                               UCSR1B = BV(TXEN); \
+                       } while (0)
                #endif
                #ifndef KDBG_UART1_BUS_RX
                #define KDBG_UART1_BUS_RX    do {} while (0)
@@ -223,7 +215,7 @@ void kdbg_init(void)
        /* Compute the baud rate */
        uint16_t period = (((CLOCK_FREQ / 16UL) + (CONFIG_KDEBUG_BAUDRATE / 2)) / CONFIG_KDEBUG_BAUDRATE) - 1;
 
-       #if CPU_AVR_ATMEGA64
+       #if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128
                #if CONFIG_KDEBUG_PORT == 0
                        UBRR0H = (uint8_t)(period>>8);
                        UBRR0L = (uint8_t)period;
@@ -251,10 +243,10 @@ void kdbg_init(void)
 }
 
 
-/*!
+/**
  * Output one character to the debug console
  */
-static void __kputchar(char c, UNUSED(void *, unused))
+static void __kputchar(char c, UNUSED_ARG(void *, unused))
 {
        /* Poll while serial buffer is still busy */
        KDBG_WAIT_READY();
@@ -283,22 +275,31 @@ void kputchar(char c)
 }
 
 
-void PGM_FUNC(kprintf)(const char * PGM_ATTR fmt, ...)
+static void PGM_FUNC(kvprintf)(const char * PGM_ATTR fmt, va_list ap)
 {
-       va_list ap;
-
+#if CONFIG_PRINTF
        /* Mask serial TX intr */
        kdbg_irqsave_t irqsave;
        KDBG_MASK_IRQ(irqsave);
 
-       va_start(ap, fmt);
        PGM_FUNC(_formatted_write)(fmt, __kputchar, 0, ap);
-       va_end(ap);
 
        /* Restore serial TX intr */
        KDBG_RESTORE_IRQ(irqsave);
+#else
+       /* A better than nothing printf() surrogate. */
+       PGM_FUNC(kputs)(fmt);
+#endif /* CONFIG_PRINTF */
 }
 
+void PGM_FUNC(kprintf)(const char * PGM_ATTR fmt, ...)
+{
+       va_list ap;
+
+       va_start(ap, fmt);
+       PGM_FUNC(kvprintf)(fmt, ap);
+       va_end(ap);
+}
 
 void PGM_FUNC(kputs)(const char * PGM_ATTR str)
 {
@@ -315,22 +316,82 @@ void PGM_FUNC(kputs)(const char * PGM_ATTR str)
 }
 
 
-int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char * PGM_ATTR file, int line)
+/**
+ * Cheap function to print small integers without using printf().
+ */
+int kputnum(int num)
+{
+       int output_len = 0;
+       int divisor = 10000;
+       int digit;
+
+       do
+       {
+               digit = num / divisor;
+               num %= divisor;
+
+               if (digit || output_len || divisor == 1)
+               {
+                       kputchar(digit + '0');
+                       ++output_len;
+               }
+       }
+       while (divisor /= 10);
+
+       return output_len;
+}
+
+
+static void klocation(const char * PGM_ATTR file, int line)
 {
        PGM_FUNC(kputs)(file);
-       PGM_FUNC(kprintf)(PSTR(":%d: Assertion failed: "), line);
+       kputchar(':');
+       kputnum(line);
+       PGM_FUNC(kputs)(PGM_STR(": "));
+}
+
+int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char * PGM_ATTR file, int line)
+{
+       klocation(file, line);
+       PGM_FUNC(kputs)(PGM_STR("Assertion failed: "));
        PGM_FUNC(kputs)(cond);
-       PGM_FUNC(kputs)(PSTR("\n"));
+       kputchar('\n');
+       BREAKPOINT;
        return 1;
 }
 
+/*
+ * Unfortunately, there's no way to get __func__ in
+ * program memory, so we waste quite a lot of RAM in
+ * AVR and other Harvard processors.
+ */
+void PGM_FUNC(__trace)(const char *name)
+{
+       PGM_FUNC(kprintf)(PGM_STR("%s()\n"), name);
+}
+
+void PGM_FUNC(__tracemsg)(const char *name, const char * PGM_ATTR fmt, ...)
+{
+       va_list ap;
+
+       PGM_FUNC(kprintf)(PGM_STR("%s(): "), name);
+       va_start(ap, fmt);
+       PGM_FUNC(kvprintf)(fmt, ap);
+       va_end(ap);
+       kputchar('\n');
+}
 
 int PGM_FUNC(__invalid_ptr)(void *value, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
 {
-       PGM_FUNC(kputs)(file);
-       PGM_FUNC(kprintf)(PSTR(":%d: Invalid pointer: "), line);
+       klocation(file, line);
+       PGM_FUNC(kputs)(PGM_STR("Invalid ptr: "));
        PGM_FUNC(kputs)(name);
-       PGM_FUNC(kprintf)(PSTR(" = 0x%x\n"), value);
+       #if CONFIG_PRINTF
+               PGM_FUNC(kprintf)(PGM_STR(" = 0x%x\n"), (unsigned int)value);
+       #else
+               (void)value;
+               kputchar('\n');
+       #endif
        return 1;
 }
 
@@ -342,7 +403,7 @@ void __init_wall(long *wall, int size)
 }
 
 
-int __check_wall(long *wall, int size, const char *name, const char *file, int line)
+int PGM_FUNC(__check_wall)(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
 {
        int i, fail = 0;
 
@@ -350,8 +411,14 @@ int __check_wall(long *wall, int size, const char *name, const char *file, int l
        {
                if (wall[i] != WALL_VALUE)
                {
-                       kprintf("%s:%d: Wall broken: %s[%d] (0x%p) = 0x%lx\n",
-                               file, line, name, i, wall + i, wall[i]);
+                       klocation(file, line);
+                       PGM_FUNC(kputs)(PGM_STR("Wall broken: "));
+                       PGM_FUNC(kputs)(name);
+                       #if CONFIG_PRINTF
+                               PGM_FUNC(kprintf)(PGM_STR("[%d] (0x%p) = 0x%lx\n"), i, wall + i, wall[i]);
+                       #else
+                               kputchar('\n');
+                       #endif
                        fail = 1;
                }
        }
@@ -360,7 +427,9 @@ int __check_wall(long *wall, int size, const char *name, const char *file, int l
 }
 
 
-/*!
+#if CONFIG_PRINTF
+
+/**
  * Dump binary data in hex
  */
 void kdump(const void *_buf, size_t len)
@@ -372,4 +441,6 @@ void kdump(const void *_buf, size_t len)
        kputchar('\n');
 }
 
+#endif /* CONFIG_PRINTF */
+
 #endif /* _DEBUG */