Convert 485 macros to generic BUS macros;
[bertos.git] / drv / kdebug.c
index 54e5845b92b5687801f15b4039c00c5a399543ac..471e6f4ea41d52841dd897e51059d7a0aadb4fbb 100755 (executable)
  * \author Stefano Fedrigo <aleph@develer.com>
  */
 
-/*
- * $Log$
- * 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.
- *
- */
+/*#*
+ *#* $Log$
+ *#* 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 "kdebug.h"
 #include "hw.h"
 
 #if defined(_EMUL)
        #include <stdio.h>
-       #define KDBG_WAIT_READY()      do {/*nop*/} while(0)
+       #define KDBG_WAIT_READY()      do { /*nop*/ } while(0)
        #define KDBG_WRITE_CHAR(c)     putchar((c))
-       #define KDBG_MASK_IRQ(old)     do {/*nop*/} while(0)
-       #define KDBG_RESTORE_IRQ()     do {/*nop*/} while(0)
+       #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)))
                        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
 
-               /* External 485 transceiver on UART0 (to be overridden in "hw.h").  */
-               #if !defined(SER_UART0_485_INIT)
-                       #if defined(SER_UART0_485_RX) || defined(SER_UART0_485_TX)
-                               #error SER_UART0_485_INIT, SER_UART0_485_RX and SER_UART0_485_TX must be defined together
+               /*
+                * Support for special bus policies or external transceivers
+                * on UART0 (to be overridden in "hw.h").
+                */
+               #if !defined(KDBG_UART0_BUS_INIT)
+                       #if defined(KDBG_UART0_BUS_RX) || defined(KDBG_UART0_BUS_TX)
+                               #error KDBG_UART0_BUS_INIT, KDBG_UART0_BUS_RX and KDBG_UART0_BUS_TX must be defined together
                        #endif
-                       #define SER_UART0_485_INIT  do {} while (0)
-                       #define SER_UART0_485_TX    do {} while (0)
-                       #define SER_UART0_485_RX    do {} while (0)
-               #elif !defined(SER_UART0_485_RX) || !defined(SER_UART0_485_TX)
-                       #error SER_UART0_485_INIT, SER_UART0_485_RX and SER_UART0_485_TX must be defined together
+                       #define KDBG_UART0_BUS_INIT  do {} while (0)
+                       #define KDBG_UART0_BUS_TX    do {} while (0)
+                       #define KDBG_UART0_BUS_RX    do {} while (0)
+               #elif !defined(KDBG_UART0_BUS_RX) || !defined(KDBG_UART0_BUS_TX)
+                       #error KDBG_UART0_BUS_INIT, KDBG_UART0_BUS_RX and KDBG_UART0_BUS_TX must be defined together
                #endif
 
                #if defined(__AVR_ATmega64__)
                #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)
                /*
-                * BUG: before sending a new character the TXC flag is cleared to allow
-                * KDBG_WAIT_TXDONE() to work properly, but, if KDBG_WRITE_CHAR() is called
-                * after the RXC flag is set by hardware, a new TXC could be generated
-                * after we clear it and before the new character is put in UDR. In this
-                * case if a 485 is used the transceiver will be put in RX mode while
-                * transmitting the last char.
+                * 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 { \
-                       SER_UART0_485_TX; \
+                       KDBG_UART0_BUS_TX; \
                        (old) = UCR; \
                        UCR |= BV(TXEN); \
                        UCR &= ~(BV(TXCIE) | BV(UDRIE)); \
 
                #define KDBG_RESTORE_IRQ(old) do { \
                        KDBG_WAIT_TXDONE(); \
-                       SER_UART0_485_RX; \
+                       KDBG_UART0_BUS_RX; \
                        UCR = (old); \
                } while(0)
 
+               typedef uint8_t kdbg_irqsave_t;
+
        #elif CONFIG_KDEBUG_PORT == 1
 
-               /* External 485 transceiver on UART1 (to be overridden in "hw.h").  */
-               #ifndef SER_UART1_485_INIT
-                       #if defined(SER_UART1_485_RX) || defined(SER_UART1_485_TX)
-                               #error SER_UART1_485_INIT, SER_UART1_485_RX and SER_UART1_485_TX must be defined together
+               /*
+                * Support for special bus policies or external transceivers
+                * on UART1 (to be overridden in "hw.h").
+                */
+               #ifndef KDBG_UART1_BUS_INIT
+                       #if defined(KDBG_UART1_BUS_RX) || defined(KDBG_UART1_BUS_TX)
+                               #error KDBG_UART1_BUS_INIT, KDBG_UART1_BUS_RX and KDBG_UART1_BUS_TX must be defined together
                        #endif
-                       #define SER_UART1_485_INIT  do {} while (0)
-                       #define SER_UART1_485_TX    do {} while (0)
-                       #define SER_UART1_485_RX    do {} while (0)
-               #elif !defined(SER_UART1_485_RX) || !defined(SER_UART1_485_TX)
-                       #error SER_UART1_485_INIT, SER_UART1_485_RX and SER_UART1_485_TX must be defined together
+                       #define KDBG_UART1_BUS_INIT  do {} while (0)
+                       #define KDBG_UART1_BUS_TX    do {} while (0)
+                       #define KDBG_UART1_BUS_RX    do {} while (0)
+               #elif !defined(KDBG_UART1_BUS_RX) || !defined(KDBG_UART1_BUS_TX)
+                       #error KDBG_UART1_BUS_INIT, KDBG_UART1_BUS_RX and KDBG_UART1_BUS_TX must be defined together
                #endif
 
                #define KDBG_WAIT_READY()     do { loop_until_bit_is_set(UCSR1A, UDRE); } while(0)
                #define KDBG_WRITE_CHAR(c)    do { UCSR1A |= BV(TXC); UDR1 = (c); } while(0)
 
                #define KDBG_MASK_IRQ(old)    do { \
-                       SER_UART1_485_TX; \
+                       KDBG_UART1_BUS_TX; \
                        (old) = UCSR1B; \
                        UCSR1B |= BV(TXEN); \
                        UCSR1B &= ~(BV(TXCIE) | BV(UDRIE)); \
 
                #define KDBG_RESTORE_IRQ(old) do { \
                        KDBG_WAIT_TXDONE(); \
-                       SER_UART1_485_RX; \
+                       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
        #endif
        /* Debugging go through the JTAG interface. The MSL library already
           implements the console I/O correctly. */
        #include <stdio.h>
-       #define KDBG_WAIT_READY()
+       #define KDBG_WAIT_READY()         do { } while (0)
        #define KDBG_WRITE_CHAR(c)        __put_char(c, stdout)
-       #define KDBG_MASK_IRQ(old)
-       #define KDBG_RESTORE_IRQ(old)
+       #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
 #endif
@@ -190,11 +214,11 @@ void kdbg_init(void)
                #if CONFIG_KDEBUG_PORT == 0
                        UBRR0H = (uint8_t)(period>>8);
                        UBRR0L = (uint8_t)period;
-                       SER_UART0_485_INIT;
+                       KDBG_UART0_BUS_INIT;
                #elif CONFIG_KDEBUG_PORT == 1
                        UBRR1H = (uint8_t)(period>>8);
                        UBRR1L = (uint8_t)period;
-                       SER_UART1_485_INIT;
+                       KDBG_UART1_BUS_INIT;
                #else
                        #error CONFIG_KDEBUG_PORT must be either 0 or 1
                #endif
@@ -203,7 +227,7 @@ void kdbg_init(void)
                UBRRL = (uint8_t)period;
        #elif defined(__AVR_ATmega103__)
                UBRR = (uint8_t)period;
-               SER_UART0_485_INIT;
+               KDBG_UART0_BUS_INIT;
        #else
                #error Unknown arch
        #endif
@@ -217,7 +241,7 @@ 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(void *, unused))
 {
        /* Poll while serial buffer is still busy */
        KDBG_WAIT_READY();
@@ -233,16 +257,29 @@ static void kputchar(char c, UNUSED(void *, unused))
 }
 
 
+void kputchar(char c)
+{
+       /* Mask serial TX intr */
+       kdbg_irqsave_t irqsave;
+       KDBG_MASK_IRQ(irqsave);
+
+       __kputchar(c, 0);
+
+       /* Restore serial TX intr */
+       KDBG_RESTORE_IRQ(irqsave);
+}
+
+
 void PGM_FUNC(kprintf)(const char * PGM_ATTR fmt, ...)
 {
        va_list ap;
 
        /* Mask serial TX intr */
-       unsigned char irqsave;
+       kdbg_irqsave_t irqsave;
        KDBG_MASK_IRQ(irqsave);
 
        va_start(ap, fmt);
-       PGM_FUNC(_formatted_write)(fmt, kputchar, 0, ap);
+       PGM_FUNC(_formatted_write)(fmt, __kputchar, 0, ap);
        va_end(ap);
 
        /* Restore serial TX intr */
@@ -255,17 +292,17 @@ void PGM_FUNC(kputs)(const char * PGM_ATTR str)
        char c;
 
        /* Mask serial TX intr */
-       unsigned char irqsave;
+       kdbg_irqsave_t irqsave;
        KDBG_MASK_IRQ(irqsave);
 
        while ((c = PGM_READ_CHAR(str++)))
-               kputchar(c, 0);
+               __kputchar(c, 0);
 
        KDBG_RESTORE_IRQ(irqsave);
 }
 
 
-int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char *file, int line)
+int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char * PGM_ATTR file, int line)
 {
        PGM_FUNC(kputs)(file);
        PGM_FUNC(kprintf)(PSTR(":%d: Assertion failed: "), line);
@@ -319,7 +356,7 @@ void kdump(const void *_buf, size_t len)
 
        while (len--)
                kprintf("%02X", *buf++);
-       kputs("\n");
+       kputchar('\n');
 }
 
 #endif /* _DEBUG */