Add verbose/quiet modes for docs, check and tags rules.
[bertos.git] / drv / kdebug.c
old mode 100755 (executable)
new mode 100644 (file)
index a815902..1e20615
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
- * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
+ * 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, 2005, 2006, 2007 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000, 2001, 2002 Bernardo Innocenti <bernie@codewiz.org>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief General pourpose debug support for embedded systems (implementation).
  * \author Stefano Fedrigo <aleph@develer.com>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.21  2005/02/16 20:29:48  bernie
- *#* TRACE(), TRACEMSG(): Reduce code and data footprint.
- *#*
- *#* 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().
- *#*
- *#* Revision 1.18  2004/12/08 08:52:00  bernie
- *#* Save some more RAM on AVR.
- *#*
- *#* Revision 1.17  2004/10/03 18:41:28  bernie
- *#* Restore \version header killed by mistake in previous commit.
- *#*
- *#* Revision 1.16  2004/10/03 18:40:50  bernie
- *#* Use new CPU macros.
- *#*
- *#* Revision 1.15  2004/09/14 21:03:46  bernie
- *#* Use debug.h instead of kdebug.h.
- *#*
- *#* Revision 1.14  2004/09/06 21:39:56  bernie
- *#* Allow partial redefinition of BUS macros.
- *#*
- *#* Revision 1.13  2004/08/29 22:04:26  bernie
- *#* Convert 485 macros to generic BUS macros;
- *#* kputchar(): New public function.
- *#*
- *#* Revision 1.12  2004/08/25 14:12:08  rasky
- *#* Aggiornato il comment block dei log RCS
- *#*
- *#* Revision 1.11  2004/08/24 16:19:08  bernie
- *#* kputchar(): New public function; Add missing dummy inlines for \!_DEBUG.
- *#*
- *#* 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.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.
- *#*
- *#*/
-
-#include <debug.h>
-#include <cpu.h>
-#include <macros.h> /* for BV() */
-#include <config.h>
-#include <hw.h>
+
+#include <cfg/debug.h>
+#include <cpu/irq.h>
+#include <cpu/attr.h>
+#include <cpu/types.h>
+#include <cfg/macros.h> /* for BV() */
+#include <appconfig.h>
+#warning what about these?
+//#include <hw_cpu.h>     /* for CLOCK_FREQ */
+//#include <hw_ser.h>     /* Required for bus macros overrides */
 
 #include <mware/formatwr.h> /* for _formatted_write() */
+#include <mware/pgm.h>
 
 #ifdef _DEBUG
 
-#if defined(_EMUL)
+#if CPU_HARVARD && !defined(_PROGMEM)
+       #error This module build correctly only in program memory!
+#endif
+
+
+#if OS_HOSTED
        #include <stdio.h>
        #define KDBG_WAIT_READY()      do { /*nop*/ } while(0)
-       #define KDBG_WRITE_CHAR(c)     putchar((c))
+       #define KDBG_WRITE_CHAR(c)     putc((c), stderr)
        #define KDBG_MASK_IRQ(old)     do { (void)(old); } while(0)
        #define KDBG_RESTORE_IRQ(old)  do { /*nop*/ } while(0)
        typedef char kdbg_irqsave_t; /* unused */
-#elif CPU_I196
-       #include "Util196.h"
-       #define KDBG_WAIT_READY()      do {} while (!(SP_STAT & (SPSF_TX_EMPTY | SPSF_TX_INT)))
-       #define KDBG_WRITE_CHAR(c)     do { SBUF = (c); } while(0)
-       #define KDBG_MASK_IRQ(old) \
-               do { \
-                       (old) = INT_MASK1 & INT1F_TI; \
-                       INT_MASK1 &= ~INT1F_TI; \
-               } while(0)
-       #define KDBG_RESTORE_IRQ(old)  do { INT_MASK1 |= (old); }
-       typedef uint16_t kdbg_irqsave_t; /* FIXME: unconfirmed */
-#elif CPU_AVR
-       #include <avr/io.h>
-
-       #if CONFIG_KDEBUG_PORT == 0
-
-               /*
-                * Support for special bus policies or external transceivers
-                * on UART0 (to be overridden in "hw.h").
-                */
-               #ifndef KDBG_UART0_BUS_INIT
-               #define KDBG_UART0_BUS_INIT  do {} while (0)
-               #endif
-               #ifndef KDBG_UART0_BUS_RX
-               #define KDBG_UART0_BUS_RX    do {} while (0)
-               #endif
-               #ifndef KDBG_UART0_BUS_TX
-               #define KDBG_UART0_BUS_TX    do {} while (0)
-               #endif
-
-               #if CPU_AVR_ATMEGA64
-                       #define UCR UCSR0B
-                       #define UDR UDR0
-                       #define USR UCSR0A
-               #elif CPU_AVR_ATMEGA8
-                       #define UCR UCSRB
-                       #define USR UCSRA
-               #else
-                       #error Unknown CPU
-               #endif
-
-               #define KDBG_WAIT_READY()     do { loop_until_bit_is_set(USR, UDRE); } while(0)
-               #define KDBG_WAIT_TXDONE()    do { loop_until_bit_is_set(USR, TXC); } while(0)
-
-               /*
-                * We must clear the TXC flag before sending a new character to allow
-                * KDBG_WAIT_TXDONE() to work properly.
-                *
-                * BUG: if KDBG_WRITE_CHAR() is called after the TXC flag is set by hardware,
-                * a new TXC could be generated after we've cleared it and before the new
-                * character is written to UDR.  On a 485 bus, the transceiver will be put
-                * in RX mode while still transmitting the last char.
-                */
-               #define KDBG_WRITE_CHAR(c)    do { USR |= BV(TXC); UDR = (c); } while(0)
-
-               #define KDBG_MASK_IRQ(old)    do { \
-                       (old) = UCR; \
-                       UCR |= BV(TXEN); \
-                       UCR &= ~(BV(TXCIE) | BV(UDRIE)); \
-                       KDBG_UART0_BUS_TX; \
-               } while(0)
-
-               #define KDBG_RESTORE_IRQ(old) do { \
-                       KDBG_WAIT_TXDONE(); \
-                       KDBG_UART0_BUS_RX; \
-                       UCR = (old); \
-               } while(0)
-
-               typedef uint8_t kdbg_irqsave_t;
-
-       #elif CONFIG_KDEBUG_PORT == 1
-
-               /*
-                * Support for special bus policies or external transceivers
-                * on UART1 (to be overridden in "hw.h").
-                */
-               #ifndef KDBG_UART1_BUS_INIT
-               #define KDBG_UART1_BUS_INIT  do {} while (0)
-               #endif
-               #ifndef KDBG_UART1_BUS_RX
-               #define KDBG_UART1_BUS_RX    do {} while (0)
-               #endif
-               #ifndef KDBG_UART1_BUS_TX
-               #define KDBG_UART1_BUS_TX    do {} while (0)
-               #endif
-
-               #define KDBG_WAIT_READY()     do { loop_until_bit_is_set(UCSR1A, UDRE); } while(0)
-               #define KDBG_WAIT_TXDONE()    do { loop_until_bit_is_set(UCSR1A, TXC); } while(0)
-               #define KDBG_WRITE_CHAR(c)    do { UCSR1A |= BV(TXC); UDR1 = (c); } while(0)
-
-               #define KDBG_MASK_IRQ(old)    do { \
-                       (old) = UCSR1B; \
-                       UCSR1B |= BV(TXEN); \
-                       UCSR1B &= ~(BV(TXCIE) | BV(UDRIE)); \
-                       KDBG_UART1_BUS_TX; \
-               } while(0)
-
-               #define KDBG_RESTORE_IRQ(old) do { \
-                       KDBG_WAIT_TXDONE(); \
-                       KDBG_UART1_BUS_RX; \
-                       UCSR1B = (old); \
-               } while(0)
-
-               typedef uint8_t kdbg_irqsave_t;
-       #else
-               #error CONFIG_KDEBUG_PORT should be either 0 or 1
+
+       #define kdbg_hw_init() do {} while (0) ///< Not needed
+
+       #if CONFIG_KDEBUG_PORT == 666
+               #error BITBANG debug console missing for this platform
        #endif
-#elif defined(__MWERKS__) && CPU_DSP56K
-       /* Debugging go through the JTAG interface. The MSL library already
-          implements the console I/O correctly. */
-       #include <stdio.h>
-       #define KDBG_WAIT_READY()         do { } while (0)
-       #define KDBG_WRITE_CHAR(c)        __put_char(c, stdout)
-       #define KDBG_MASK_IRQ(old)        do { (void)(old); } while (0)
-       #define KDBG_RESTORE_IRQ(old)     do { (void)(old); } while (0)
-       typedef uint8_t kdbg_irqsave_t; /* unused */
 #else
-       #error Unknown architecture
+       #include CPU_CSOURCE(kdebug)
 #endif
 
 
 void kdbg_init(void)
 {
-#if CPU_I196
-
-       /* Set serial port for 19200bps 8N1 */
-       INT_MASK1 &= ~(INT1F_TI | INT1F_RI);
-       SP_CON = SPCF_RECEIVE_ENABLE | SPCF_MODE1;
-       ioc1_img |= IOC1F_TXD_SEL | IOC1F_EXTINT_SRC;
-       IOC1 = ioc1_img;
-       BAUD_RATE = 0x33;
-       BAUD_RATE = 0x80;
-
-#elif CPU_AVR
-
-       /* Compute the baud rate */
-       uint16_t period = (((CLOCK_FREQ / 16UL) + (CONFIG_KDEBUG_BAUDRATE / 2)) / CONFIG_KDEBUG_BAUDRATE) - 1;
-
-       #if CPU_AVR_ATMEGA64
-               #if CONFIG_KDEBUG_PORT == 0
-                       UBRR0H = (uint8_t)(period>>8);
-                       UBRR0L = (uint8_t)period;
-                       KDBG_UART0_BUS_INIT;
-               #elif CONFIG_KDEBUG_PORT == 1
-                       UBRR1H = (uint8_t)(period>>8);
-                       UBRR1L = (uint8_t)period;
-                       KDBG_UART1_BUS_INIT;
-               #else
-                       #error CONFIG_KDEBUG_PORT must be either 0 or 1
-               #endif
-       #elif CPU_AVR_ATMEGA8
-               UBRRH = (uint8_t)(period>>8);
-               UBRRL = (uint8_t)period;
-       #elif CPU_AVR_ATMEGA103
-               UBRR = (uint8_t)period;
-               KDBG_UART0_BUS_INIT;
-       #else
-               #error Unknown CPU
-       #endif
-
-#endif /* !CPU_I196 && !CPU_AVR */
-
-       kputs("\n\n*** DBG START ***\n");
+       /* Init debug hw */
+       kdbg_hw_init();
+       kputs("\n\n*** BeRTOS DBG START ***\n");
 }
 
 
-/*!
+/**
  * Output one character to the debug console
  */
 static void __kputchar(char c, UNUSED_ARG(void *, unused))
@@ -296,7 +117,7 @@ void kputchar(char c)
 }
 
 
-void PGM_FUNC(kvprintf)(const char * PGM_ATTR fmt, va_list ap)
+static void PGM_FUNC(kvprintf)(const char * PGM_ATTR fmt, va_list ap)
 {
 #if CONFIG_PRINTF
        /* Mask serial TX intr */
@@ -337,7 +158,7 @@ void PGM_FUNC(kputs)(const char * PGM_ATTR str)
 }
 
 
-/*!
+/**
  * Cheap function to print small integers without using printf().
  */
 int kputnum(int num)
@@ -368,42 +189,47 @@ static void klocation(const char * PGM_ATTR file, int line)
        PGM_FUNC(kputs)(file);
        kputchar(':');
        kputnum(line);
-       PGM_FUNC(kputs)(PSTR(": "));
+       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)(PSTR("Assertion failed: "));
+       PGM_FUNC(kputs)(PGM_STR("Assertion failed: "));
        PGM_FUNC(kputs)(cond);
        kputchar('\n');
+       BREAKPOINT;
        return 1;
 }
 
-void PGM_FUNC(__trace)(const char * PGM_ATTR name)
+/*
+ * 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(kputs)(name);
-       PGM_FUNC(kputs)(PSTR("()\n"));
+       PGM_FUNC(kprintf)(PGM_STR("%s()\n"), name);
 }
 
-void PGM_FUNC(__tracemsg)(const char * PGM_ATTR name, const char * PGM_ATTR fmt, ...)
+void PGM_FUNC(__tracemsg)(const char *name, const char * PGM_ATTR fmt, ...)
 {
        va_list ap;
 
-       PGM_FUNC(kputs)(name);
-       PGM_FUNC(kputs)(PSTR("(): "));
+       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)
 {
        klocation(file, line);
-       PGM_FUNC(kputs)(PSTR("Invalid ptr: "));
+       PGM_FUNC(kputs)(PGM_STR("Invalid ptr: "));
        PGM_FUNC(kputs)(name);
        #if CONFIG_PRINTF
-               PGM_FUNC(kprintf)(PSTR(" = 0x%x\n"), value);
+               PGM_FUNC(kprintf)(PGM_STR(" = 0x%p\n"), value);
        #else
                (void)value;
                kputchar('\n');
@@ -428,10 +254,10 @@ int PGM_FUNC(__check_wall)(long *wall, int size, const char * PGM_ATTR name, con
                if (wall[i] != WALL_VALUE)
                {
                        klocation(file, line);
-                       PGM_FUNC(kputs)(PSTR("Wall broken: "));
+                       PGM_FUNC(kputs)(PGM_STR("Wall broken: "));
                        PGM_FUNC(kputs)(name);
                        #if CONFIG_PRINTF
-                               PGM_FUNC(kprintf)(PSTR("[%d] (0x%p) = 0x%lx\n"), i, wall + i, wall[i]);
+                               PGM_FUNC(kprintf)(PGM_STR("[%d] (0x%p) = 0x%lx\n"), i, wall + i, wall[i]);
                        #else
                                kputchar('\n');
                        #endif
@@ -445,7 +271,7 @@ int PGM_FUNC(__check_wall)(long *wall, int size, const char * PGM_ATTR name, con
 
 #if CONFIG_PRINTF
 
-/*!
+/**
  * Dump binary data in hex
  */
 void kdump(const void *_buf, size_t len)