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.5  2004/06/27 15:20:26  aleph
  20  * Change UNUSED() macro to accept two arguments: type and name;
  21  * Add macro GNUC_PREREQ to detect GCC version during build;
  22  * Some spacing cleanups and typo fix
  23  *
  24  * Revision 1.4  2004/06/06 18:09:51  bernie
  25  * Import DSP56800 changes; Print broken wall bricks in hex.
  26  *
  27  * Revision 1.3  2004/06/03 11:27:09  bernie
  28  * Add dual-license information.
  29  *
  30  * Revision 1.2  2004/05/23 18:21:53  bernie
  31  * Trim CVS logs and cleanup header info.
  32  *
  33  */
  34
  35 #include "kdebug.h"
  36 #include "hw.h"
  37 #include "config.h"
  38
  39 #include <mware/formatwr.h> /* for _formatted_write() */
  40
  41 #ifdef _DEBUG
  42
  43 #if defined(_EMUL)
  44         #include <stdio.h>
  45         #define KDBG_WAIT_READY()      do {/*nop*/} while(0)
  46         #define KDBG_WRITE_CHAR(c)     putchar((c))
  47         #define KDBG_MASK_IRQ(old)     do {/*nop*/} while(0)
  48         #define KDBG_RESTORE_IRQ()     do {/*nop*/} while(0)
  49 #elif defined(__I196__)
  50         #include "Util196.h"
  51         #define KDBG_WAIT_READY()      do {} while (!(SP_STAT & (SPSF_TX_EMPTY | SPSF_TX_INT)))
  52         #define KDBG_WRITE_CHAR(c)     do { SBUF = (c); } while(0)
  53         #define KDBG_MASK_IRQ(old) \
  54                 do { \
  55                         (old) = INT_MASK1 & INT1F_TI; \
  56                         INT_MASK1 &= ~INT1F_TI; \
  57                 } while(0)
  58         #define KDBG_RESTORE_IRQ(old)  do { INT_MASK1 |= (old); }
  59 #elif defined(__AVR__)
  60         #include <avr/io.h>
  61         #if CONFIG_KDEBUG_PORT == 0
  62                 #ifndef __AVR_ATmega103__
  63                         #define UCR UCSR0B
  64                         #define UDR UDR0
  65                         #define USR UCSR0A
  66                 #endif
  67                 #define KDBG_WAIT_READY()     do { loop_until_bit_is_set(USR, UDRE); } while(0)
  68                 #define KDBG_WRITE_CHAR(c)    do { UCR |= BV(TXEN); UDR = (c); } while(0)
  69                 #define KDBG_MASK_IRQ(old)    do { (old) = UCR & BV(TXCIE); cbi(UCR, TXCIE); } while(0)
  70                 #define KDBG_RESTORE_IRQ(old) do { UCR |= (old); } while(0)
  71         #elif CONFIG_KDEBUG_PORT == 1
  72                 #define KDBG_WAIT_READY()     do { loop_until_bit_is_set(UCSR1A, UDRE); } while(0)
  73                 #define KDBG_WRITE_CHAR(c)    do { UCSR1B |= BV(TXEN); UDR1 = (c); } while(0)
  74                 #define KDBG_MASK_IRQ(old)    do { (old) = UCSR1B & BV(TXCIE); cbi(UCSR1B, TXCIE); } while(0)
  75                 #define KDBG_RESTORE_IRQ(old) do { UCSR1B |= (old); } while(0)
  76         #else
  77                 #error CONFIG_KDEBUG_PORT should be either 0 or 1
  78         #endif
  79 #elif defined(__MWERKS__) && (defined(__m56800E__) || defined(__m56800__))
  80         /* Debugging go through the JTAG interface. The MSL library already
  81            implements the console I/O correctly. */
  82         #include <stdio.h>
  83         #define KDBG_WAIT_READY()
  84         #define KDBG_WRITE_CHAR(c)        do { char ch=c; fwrite(&ch,1,1,stdout); } while (0)
  85         #define KDBG_MASK_IRQ(old)
  86         #define KDBG_RESTORE_IRQ(old)
  87 #else
  88         #error Unknown architecture
  89 #endif
  90
  91
  92 void kdbg_init(void)
  93 {
  94 #if defined(__I196__)
  95
  96         /* Set serial port for 19200bps 8N1 */
  97         INT_MASK1 &= ~(INT1F_TI | INT1F_RI);
  98         SP_CON = SPCF_RECEIVE_ENABLE | SPCF_MODE1;
  99         ioc1_img |= IOC1F_TXD_SEL | IOC1F_EXTINT_SRC;
 100         IOC1 = ioc1_img;
 101         BAUD_RATE = 0x33;
 102         BAUD_RATE = 0x80;
 103
 104 #elif defined(__AVR__)
 105
 106         /* Compute the baud rate */
 107         uint16_t period = (((CLOCK_FREQ / 16UL) + (CONFIG_KDEBUG_BAUDRATE / 2)) / CONFIG_KDEBUG_BAUDRATE) - 1;
 108
 109         #ifdef __AVR_ATmega64__
 110                 #if CONFIG_KDEBUG_PORT == 0
 111
 112                         /* Set the baud rate */
 113                         UBRR0H = (uint8_t)(period>>8);
 114                         UBRR0L = (uint8_t)period;
 115
 116                 #elif CONFIG_KDEBUG_PORT == 1
 117
 118                         UBRR1H = (uint8_t)(period>>8);
 119                         UBRR1L = (uint8_t)period;
 120
 121                 #else
 122                         #error CONFIG_KDEBUG_PORT should be either 0 or 1
 123                 #endif
 124         #elif defined (__AVR_ATmega103__)
 125
 126                 /* Set the baud rate */
 127                 UBRR = (uint8_t)period;
 128
 129         #else
 130                 #error Unknown arch
 131         #endif
 132
 133 #endif /* !__I196__ && !__AVR__ */
 134
 135         kputs("\n\n*** DBG START ***\n");
 136 }
 137
 138
 139 /*!
 140  * Output one character to the debug console
 141  */
 142 static void kputchar(char c, UNUSED(void *, unused))
 143 {
 144         /* Poll while serial buffer is still busy */
 145         KDBG_WAIT_READY();
 146
 147         /* Send '\n' as '\r\n' for dumb terminals */
 148         if (c == '\n')
 149         {
 150                 KDBG_WRITE_CHAR('\r');
 151                 KDBG_WAIT_READY();
 152         }
 153
 154         KDBG_WRITE_CHAR(c);
 155 }
 156
 157
 158 void PGM_FUNC(kprintf)(const char * PGM_ATTR fmt, ...)
 159 {
 160         va_list ap;
 161
 162         /* Mask serial TX intr */
 163         unsigned char irqsave;
 164         KDBG_MASK_IRQ(irqsave);
 165
 166         va_start(ap, fmt);
 167         PGM_FUNC(_formatted_write)(fmt, kputchar, 0, ap);
 168         va_end(ap);
 169
 170         /* Restore serial TX intr */
 171         KDBG_RESTORE_IRQ(irqsave);
 172 }
 173
 174
 175 void PGM_FUNC(kputs)(const char * PGM_ATTR str)
 176 {
 177         char c;
 178
 179         /* Mask serial TX intr */
 180         unsigned char irqsave;
 181         KDBG_MASK_IRQ(irqsave);
 182
 183         while ((c = PGM_READ_CHAR(str++)))
 184                 kputchar(c, 0);
 185
 186         KDBG_RESTORE_IRQ(irqsave);
 187 }
 188
 189
 190 int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char *file, int line)
 191 {
 192         PGM_FUNC(kputs)(file);
 193         PGM_FUNC(kprintf)(PSTR(":%d: Assertion failed: \""), line);
 194         PGM_FUNC(kputs)(cond);
 195         PGM_FUNC(kputs)(PSTR("\"\n"));
 196         return 1;
 197 }
 198
 199
 200 int PGM_FUNC(__invalid_ptr)(void *value, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
 201 {
 202         PGM_FUNC(kputs)(file);
 203         PGM_FUNC(kprintf)(PSTR(":%d: Invalid pointer: "), line);
 204         PGM_FUNC(kputs)(name);
 205         PGM_FUNC(kprintf)(PSTR(" = 0x%x\n"), value);
 206         return 1;
 207 }
 208
 209
 210 void __init_wall(long *wall, int size)
 211 {
 212         while(size--)
 213                 *wall++ = WALL_VALUE;
 214 }
 215
 216
 217 int __check_wall(long *wall, int size, const char *name, const char *file, int line)
 218 {
 219         int i, fail = 0;
 220
 221         for (i = 0; i < size; i++)
 222         {
 223                 if (wall[i] != WALL_VALUE)
 224                 {
 225                         kprintf("%s:%d: Wall broken: %s[%d] (0x%p) = 0x%lx\n",
 226                                 file, line, name, i, wall + i, wall[i]);
 227                         fail = 1;
 228                 }
 229         }
 230
 231         return fail;
 232 }
 233
 234
 235 /*!
 236  * Dump binary data in hex
 237  */
 238 void kdump(const void *_buf, size_t len)
 239 {
 240         const unsigned char *buf = (const unsigned char *)_buf;
 241
 242         while (len--)
 243                 kprintf("%02X", *buf++);
 244         kputs("\n");
 245 }
 246
 247 #endif /* _DEBUG */