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