drv/kdebug.c

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2000, 2001, 2002 Bernardo Innocenti <bernie@codewiz.org>
   6  * This file is part of DevLib - See devlib/README for information.
   7  * -->
   8  *
   9  * \brief General pourpose debug support for embedded systems (implementation).
  10  *
  11  * \version $Id$
  12  * \author Bernardo Innocenti <bernie@develer.com>
  13  * \author Stefano Fedrigo <aleph@develer.com>
  14  */
  15
  16 /*#*
  17  *#* $Log$
  18  *#* Revision 1.17  2004/10/03 18:41:28  bernie
  19  *#* Restore \version header killed by mistake in previous commit.
  20  *#*
  21  *#* Revision 1.16  2004/10/03 18:40:50  bernie
  22  *#* Use new CPU macros.
  23  *#*
  24  *#* Revision 1.15  2004/09/14 21:03:46  bernie
  25  *#* Use debug.h instead of kdebug.h.
  26  *#*
  27  *#* Revision 1.14  2004/09/06 21:39:56  bernie
  28  *#* Allow partial redefinition of BUS macros.
  29  *#*
  30  *#* Revision 1.13  2004/08/29 22:04:26  bernie
  31  *#* Convert 485 macros to generic BUS macros;
  32  *#* kputchar(): New public function.
  33  *#*
  34  *#* Revision 1.12  2004/08/25 14:12:08  rasky
  35  *#* Aggiornato il comment block dei log RCS
  36  *#*
  37  *#* Revision 1.11  2004/08/24 16:19:08  bernie
  38  *#* kputchar(): New public function; Add missing dummy inlines for \!_DEBUG.
  39  *#*
  40  *#* Revision 1.10  2004/08/04 15:57:50  rasky
  41  *#* Cambiata la putchar per kdebug per DSP56k: la nuova funzione e' quella piu' a basso livello (assembly)
  42  *#*
  43  *#* Revision 1.9  2004/08/02 20:20:29  aleph
  44  *#* Merge from project_ks
  45  *#*
  46  *#* Revision 1.8  2004/07/30 14:26:33  rasky
  47  *#* Semplificato l'output dell'ASSERT
  48  *#* Aggiunta ASSERT2 con stringa di help opzionalmente disattivabile
  49  *#*
  50  *#* Revision 1.7  2004/07/30 14:15:53  rasky
  51  *#* Nuovo supporto unificato per detect della CPU
  52  *#*
  53  *#* Revision 1.6  2004/07/18 21:49:28  bernie
  54  *#* Add ATmega8 support.
  55  *#*
  56  *#* Revision 1.5  2004/06/27 15:20:26  aleph
  57  *#* Change UNUSED() macro to accept two arguments: type and name;
  58  *#* Add macro GNUC_PREREQ to detect GCC version during build;
  59  *#* Some spacing cleanups and typo fix
  60  *#*
  61  *#* Revision 1.4  2004/06/06 18:09:51  bernie
  62  *#* Import DSP56800 changes; Print broken wall bricks in hex.
  63  *#*
  64  *#* Revision 1.3  2004/06/03 11:27:09  bernie
  65  *#* Add dual-license information.
  66  *#*
  67  *#* Revision 1.2  2004/05/23 18:21:53  bernie
  68  *#* Trim CVS logs and cleanup header info.
  69  *#*
  70  *#*/
  71
  72 #include <debug.h>
  73 #include <cpu.h>
  74 #include "hw.h"
  75 #include "config.h"
  76
  77 #include <mware/formatwr.h> /* for _formatted_write() */
  78
  79 #ifdef _DEBUG
  80
  81 #if defined(_EMUL)
  82         #include <stdio.h>
  83         #define KDBG_WAIT_READY()      do { /*nop*/ } while(0)
  84         #define KDBG_WRITE_CHAR(c)     putchar((c))
  85         #define KDBG_MASK_IRQ(old)     do { (void)(old); } while(0)
  86         #define KDBG_RESTORE_IRQ(old)  do { /*nop*/ } while(0)
  87         typedef char kdbg_irqsave_t; /* unused */
  88 #elif CPU_I196
  89         #include "Util196.h"
  90         #define KDBG_WAIT_READY()      do {} while (!(SP_STAT & (SPSF_TX_EMPTY | SPSF_TX_INT)))
  91         #define KDBG_WRITE_CHAR(c)     do { SBUF = (c); } while(0)
  92         #define KDBG_MASK_IRQ(old) \
  93                 do { \
  94                         (old) = INT_MASK1 & INT1F_TI; \
  95                         INT_MASK1 &= ~INT1F_TI; \
  96                 } while(0)
  97         #define KDBG_RESTORE_IRQ(old)  do { INT_MASK1 |= (old); }
  98         typedef uint16_t kdbg_irqsave_t; /* FIXME: unconfirmed */
  99 #elif CPU_AVR
 100         #include <avr/io.h>
 101
 102         #if CONFIG_KDEBUG_PORT == 0
 103
 104                 /*
 105                  * Support for special bus policies or external transceivers
 106                  * on UART0 (to be overridden in "hw.h").
 107                  */
 108                 #ifndef KDBG_UART0_BUS_INIT
 109                 #define KDBG_UART0_BUS_INIT  do {} while (0)
 110                 #endif
 111                 #ifndef KDBG_UART0_BUS_RX
 112                 #define KDBG_UART0_BUS_RX    do {} while (0)
 113                 #endif
 114                 #ifndef KDBG_UART0_BUS_TX
 115                 #define KDBG_UART0_BUS_TX    do {} while (0)
 116                 #endif
 117
 118                 #if CPU_AVR_ATMEGA64
 119                         #define UCR UCSR0B
 120                         #define UDR UDR0
 121                         #define USR UCSR0A
 122                 #elif CPU_AVR_ATMEGA8
 123                         #define UCR UCSRB
 124                         #define USR UCSRA
 125                 #else
 126                         #error Unknown CPU
 127                 #endif
 128
 129                 #define KDBG_WAIT_READY()     do { loop_until_bit_is_set(USR, UDRE); } while(0)
 130                 #define KDBG_WAIT_TXDONE()    do { loop_until_bit_is_set(USR, TXC); } while(0)
 131
 132                 /*
 133                  * We must clear the TXC flag before sending a new character to allow
 134                  * KDBG_WAIT_TXDONE() to work properly.
 135                  *
 136                  * BUG: if KDBG_WRITE_CHAR() is called after the TXC flag is set by hardware,
 137                  * a new TXC could be generated after we've cleared it and before the new
 138                  * character is written to UDR.  On a 485 bus, the transceiver will be put
 139                  * in RX mode while still transmitting the last char.
 140                  */
 141                 #define KDBG_WRITE_CHAR(c)    do { USR |= BV(TXC); UDR = (c); } while(0)
 142
 143                 #define KDBG_MASK_IRQ(old)    do { \
 144                         (old) = UCR; \
 145                         UCR |= BV(TXEN); \
 146                         UCR &= ~(BV(TXCIE) | BV(UDRIE)); \
 147                         KDBG_UART0_BUS_TX; \
 148                 } while(0)
 149
 150                 #define KDBG_RESTORE_IRQ(old) do { \
 151                         KDBG_WAIT_TXDONE(); \
 152                         KDBG_UART0_BUS_RX; \
 153                         UCR = (old); \
 154                 } while(0)
 155
 156                 typedef uint8_t kdbg_irqsave_t;
 157
 158         #elif CONFIG_KDEBUG_PORT == 1
 159
 160                 /*
 161                  * Support for special bus policies or external transceivers
 162                  * on UART1 (to be overridden in "hw.h").
 163                  */
 164                 #ifndef KDBG_UART1_BUS_INIT
 165                 #define KDBG_UART1_BUS_INIT  do {} while (0)
 166                 #endif
 167                 #ifndef KDBG_UART1_BUS_RX
 168                 #define KDBG_UART1_BUS_RX    do {} while (0)
 169                 #endif
 170                 #ifndef KDBG_UART1_BUS_TX
 171                 #define KDBG_UART1_BUS_TX    do {} while (0)
 172                 #endif
 173
 174                 #define KDBG_WAIT_READY()     do { loop_until_bit_is_set(UCSR1A, UDRE); } while(0)
 175                 #define KDBG_WAIT_TXDONE()    do { loop_until_bit_is_set(UCSR1A, TXC); } while(0)
 176                 #define KDBG_WRITE_CHAR(c)    do { UCSR1A |= BV(TXC); UDR1 = (c); } while(0)
 177
 178                 #define KDBG_MASK_IRQ(old)    do { \
 179                         (old) = UCSR1B; \
 180                         UCSR1B |= BV(TXEN); \
 181                         UCSR1B &= ~(BV(TXCIE) | BV(UDRIE)); \
 182                         KDBG_UART1_BUS_TX; \
 183                 } while(0)
 184
 185                 #define KDBG_RESTORE_IRQ(old) do { \
 186                         KDBG_WAIT_TXDONE(); \
 187                         KDBG_UART1_BUS_RX; \
 188                         UCSR1B = (old); \
 189                 } while(0)
 190
 191                 typedef uint8_t kdbg_irqsave_t;
 192         #else
 193                 #error CONFIG_KDEBUG_PORT should be either 0 or 1
 194         #endif
 195 #elif defined(__MWERKS__) && CPU_DSP56K
 196         /* Debugging go through the JTAG interface. The MSL library already
 197            implements the console I/O correctly. */
 198         #include <stdio.h>
 199         #define KDBG_WAIT_READY()         do { } while (0)
 200         #define KDBG_WRITE_CHAR(c)        __put_char(c, stdout)
 201         #define KDBG_MASK_IRQ(old)        do { (void)(old); } while (0)
 202         #define KDBG_RESTORE_IRQ(old)     do { (void)(old); } while (0)
 203         typedef uint8_t kdbg_irqsave_t; /* unused */
 204 #else
 205         #error Unknown architecture
 206 #endif
 207
 208
 209 void kdbg_init(void)
 210 {
 211 #if CPU_I196
 212
 213         /* Set serial port for 19200bps 8N1 */
 214         INT_MASK1 &= ~(INT1F_TI | INT1F_RI);
 215         SP_CON = SPCF_RECEIVE_ENABLE | SPCF_MODE1;
 216         ioc1_img |= IOC1F_TXD_SEL | IOC1F_EXTINT_SRC;
 217         IOC1 = ioc1_img;
 218         BAUD_RATE = 0x33;
 219         BAUD_RATE = 0x80;
 220
 221 #elif CPU_AVR
 222
 223         /* Compute the baud rate */
 224         uint16_t period = (((CLOCK_FREQ / 16UL) + (CONFIG_KDEBUG_BAUDRATE / 2)) / CONFIG_KDEBUG_BAUDRATE) - 1;
 225
 226         #if CPU_AVR_ATMEGA64
 227                 #if CONFIG_KDEBUG_PORT == 0
 228                         UBRR0H = (uint8_t)(period>>8);
 229                         UBRR0L = (uint8_t)period;
 230                         KDBG_UART0_BUS_INIT;
 231                 #elif CONFIG_KDEBUG_PORT == 1
 232                         UBRR1H = (uint8_t)(period>>8);
 233                         UBRR1L = (uint8_t)period;
 234                         KDBG_UART1_BUS_INIT;
 235                 #else
 236                         #error CONFIG_KDEBUG_PORT must be either 0 or 1
 237                 #endif
 238         #elif CPU_AVR_ATMEGA8
 239                 UBRRH = (uint8_t)(period>>8);
 240                 UBRRL = (uint8_t)period;
 241         #elif CPU_AVR_ATMEGA103
 242                 UBRR = (uint8_t)period;
 243                 KDBG_UART0_BUS_INIT;
 244         #else
 245                 #error Unknown CPU
 246         #endif
 247
 248 #endif /* !CPU_I196 && !CPU_AVR */
 249
 250         kputs("\n\n*** DBG START ***\n");
 251 }
 252
 253
 254 /*!
 255  * Output one character to the debug console
 256  */
 257 static void __kputchar(char c, UNUSED(void *, unused))
 258 {
 259         /* Poll while serial buffer is still busy */
 260         KDBG_WAIT_READY();
 261
 262         /* Send '\n' as '\r\n' for dumb terminals */
 263         if (c == '\n')
 264         {
 265                 KDBG_WRITE_CHAR('\r');
 266                 KDBG_WAIT_READY();
 267         }
 268
 269         KDBG_WRITE_CHAR(c);
 270 }
 271
 272
 273 void kputchar(char c)
 274 {
 275         /* Mask serial TX intr */
 276         kdbg_irqsave_t irqsave;
 277         KDBG_MASK_IRQ(irqsave);
 278
 279         __kputchar(c, 0);
 280
 281         /* Restore serial TX intr */
 282         KDBG_RESTORE_IRQ(irqsave);
 283 }
 284
 285
 286 void PGM_FUNC(kprintf)(const char * PGM_ATTR fmt, ...)
 287 {
 288         va_list ap;
 289
 290         /* Mask serial TX intr */
 291         kdbg_irqsave_t irqsave;
 292         KDBG_MASK_IRQ(irqsave);
 293
 294         va_start(ap, fmt);
 295         PGM_FUNC(_formatted_write)(fmt, __kputchar, 0, ap);
 296         va_end(ap);
 297
 298         /* Restore serial TX intr */
 299         KDBG_RESTORE_IRQ(irqsave);
 300 }
 301
 302
 303 void PGM_FUNC(kputs)(const char * PGM_ATTR str)
 304 {
 305         char c;
 306
 307         /* Mask serial TX intr */
 308         kdbg_irqsave_t irqsave;
 309         KDBG_MASK_IRQ(irqsave);
 310
 311         while ((c = PGM_READ_CHAR(str++)))
 312                 __kputchar(c, 0);
 313
 314         KDBG_RESTORE_IRQ(irqsave);
 315 }
 316
 317
 318 int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char * PGM_ATTR file, int line)
 319 {
 320         PGM_FUNC(kputs)(file);
 321         PGM_FUNC(kprintf)(PSTR(":%d: Assertion failed: "), line);
 322         PGM_FUNC(kputs)(cond);
 323         PGM_FUNC(kputs)(PSTR("\n"));
 324         return 1;
 325 }
 326
 327
 328 int PGM_FUNC(__invalid_ptr)(void *value, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
 329 {
 330         PGM_FUNC(kputs)(file);
 331         PGM_FUNC(kprintf)(PSTR(":%d: Invalid pointer: "), line);
 332         PGM_FUNC(kputs)(name);
 333         PGM_FUNC(kprintf)(PSTR(" = 0x%x\n"), value);
 334         return 1;
 335 }
 336
 337
 338 void __init_wall(long *wall, int size)
 339 {
 340         while(size--)
 341                 *wall++ = WALL_VALUE;
 342 }
 343
 344
 345 int __check_wall(long *wall, int size, const char *name, const char *file, int line)
 346 {
 347         int i, fail = 0;
 348
 349         for (i = 0; i < size; i++)
 350         {
 351                 if (wall[i] != WALL_VALUE)
 352                 {
 353                         kprintf("%s:%d: Wall broken: %s[%d] (0x%p) = 0x%lx\n",
 354                                 file, line, name, i, wall + i, wall[i]);
 355                         fail = 1;
 356                 }
 357         }
 358
 359         return fail;
 360 }
 361
 362
 363 /*!
 364  * Dump binary data in hex
 365  */
 366 void kdump(const void *_buf, size_t len)
 367 {
 368         const unsigned char *buf = (const unsigned char *)_buf;
 369
 370         while (len--)
 371                 kprintf("%02X", *buf++);
 372         kputchar('\n');
 373 }
 374
 375 #endif /* _DEBUG */