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