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