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