4 * Copyright 2003, 2004, 2005 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 README.devlib for information.
9 * \brief General pourpose debug support for embedded systems (implementation).
12 * \author Bernardo Innocenti <bernie@develer.com>
13 * \author Stefano Fedrigo <aleph@develer.com>
18 *#* Revision 1.30 2007/01/28 09:18:06 batt
19 *#* Merge from project_ks.
21 *#* Revision 1.29 2006/11/23 13:19:39 batt
22 *#* Add BitBanged serial debug console.
24 *#* Revision 1.28 2006/07/19 12:56:25 bernie
25 *#* Convert to new Doxygen style.
27 *#* Revision 1.27 2006/06/01 12:32:06 marco
28 *#* Updated include reference.
30 *#* Revision 1.26 2006/04/27 05:40:27 bernie
31 *#* Break on assertion failures.
33 *#* Revision 1.25 2005/06/27 21:26:24 bernie
36 *#* Revision 1.24 2005/04/12 01:36:37 bernie
37 *#* Add hack to enable TX line at module initialization.
39 *#* Revision 1.23 2005/04/11 19:10:27 bernie
40 *#* Include top-level headers from cfg/ subdir.
42 *#* Revision 1.22 2005/02/18 11:18:33 bernie
43 *#* Fixes for Harvard processors from project_ks.
45 *#* Revision 1.21 2005/02/16 20:29:48 bernie
46 *#* TRACE(), TRACEMSG(): Reduce code and data footprint.
48 *#* Revision 1.20 2005/01/25 08:36:40 bernie
49 *#* kputnum(): Export.
51 *#* Revision 1.19 2004/12/31 17:47:45 bernie
52 *#* Rename UNUSED() to UNUSED_ARG().
55 #include <cfg/debug.h>
57 #include <cfg/macros.h> /* for BV() */
58 #include <appconfig.h>
59 #include <hw_cpu.h> /* for CLOCK_FREQ */
60 #include <hw_ser.h> /* Required for bus macros overrides */
62 #include <mware/formatwr.h> /* for _formatted_write() */
68 #define KDBG_WAIT_READY() do { /*nop*/ } while(0)
69 #define KDBG_WRITE_CHAR(c) putchar((c))
70 #define KDBG_MASK_IRQ(old) do { (void)(old); } while(0)
71 #define KDBG_RESTORE_IRQ(old) do { /*nop*/ } while(0)
72 typedef char kdbg_irqsave_t; /* unused */
74 #if CONFIG_KDEBUG_PORT == 666
75 #error BITBANG debug console missing for this platform
79 #define KDBG_WAIT_READY() do {} while (!(SP_STAT & (SPSF_TX_EMPTY | SPSF_TX_INT)))
80 #define KDBG_WRITE_CHAR(c) do { SBUF = (c); } while(0)
81 #define KDBG_MASK_IRQ(old) \
83 (old) = INT_MASK1 & INT1F_TI; \
84 INT_MASK1 &= ~INT1F_TI; \
86 #define KDBG_RESTORE_IRQ(old) do { INT_MASK1 |= (old); }
87 typedef uint16_t kdbg_irqsave_t; /* FIXME: unconfirmed */
89 #if CONFIG_KDEBUG_PORT == 666
90 #error BITBANG debug console missing for this platform
95 #if CONFIG_KDEBUG_PORT == 0
98 * Support for special bus policies or external transceivers
99 * on UART0 (to be overridden in "hw_ser.h").
101 * HACK: if we don't set TXEN, kdbg disables the transmitter
102 * after each output statement until the serial driver
103 * is initialized. These glitches confuse the debug
104 * terminal that ends up printing some trash.
106 #ifndef KDBG_UART0_BUS_INIT
107 #define KDBG_UART0_BUS_INIT do { \
111 #ifndef KDBG_UART0_BUS_RX
112 #define KDBG_UART0_BUS_RX do {} while (0)
114 #ifndef KDBG_UART0_BUS_TX
115 #define KDBG_UART0_BUS_TX do {} while (0)
118 #if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128
122 #elif CPU_AVR_ATMEGA8
129 #define KDBG_WAIT_READY() do { loop_until_bit_is_set(USR, UDRE); } while(0)
130 #define KDBG_WAIT_TXDONE() do { loop_until_bit_is_set(USR, TXC); } while(0)
133 * We must clear the TXC flag before sending a new character to allow
134 * KDBG_WAIT_TXDONE() to work properly.
136 * BUG: if KDBG_WRITE_CHAR() is called after the TXC flag is set by hardware,
137 * a new TXC could be generated after we've cleared it and before the new
138 * character is written to UDR. On a 485 bus, the transceiver will be put
139 * in RX mode while still transmitting the last char.
141 #define KDBG_WRITE_CHAR(c) do { USR |= BV(TXC); UDR = (c); } while(0)
143 #define KDBG_MASK_IRQ(old) do { \
146 UCR &= ~(BV(TXCIE) | BV(UDRIE)); \
150 #define KDBG_RESTORE_IRQ(old) do { \
151 KDBG_WAIT_TXDONE(); \
156 typedef uint8_t kdbg_irqsave_t;
158 #elif CONFIG_KDEBUG_PORT == 1
161 * Support for special bus policies or external transceivers
162 * on UART1 (to be overridden in "hw_ser.h").
164 * HACK: if we don't set TXEN, kdbg disables the transmitter
165 * after each output statement until the serial driver
166 * is initialized. These glitches confuse the debug
167 * terminal that ends up printing some trash.
169 #ifndef KDBG_UART1_BUS_INIT
170 #define KDBG_UART1_BUS_INIT do { \
174 #ifndef KDBG_UART1_BUS_RX
175 #define KDBG_UART1_BUS_RX do {} while (0)
177 #ifndef KDBG_UART1_BUS_TX
178 #define KDBG_UART1_BUS_TX do {} while (0)
181 #define KDBG_WAIT_READY() do { loop_until_bit_is_set(UCSR1A, UDRE); } while(0)
182 #define KDBG_WAIT_TXDONE() do { loop_until_bit_is_set(UCSR1A, TXC); } while(0)
183 #define KDBG_WRITE_CHAR(c) do { UCSR1A |= BV(TXC); UDR1 = (c); } while(0)
185 #define KDBG_MASK_IRQ(old) do { \
187 UCSR1B |= BV(TXEN); \
188 UCSR1B &= ~(BV(TXCIE) | BV(UDRIE)); \
192 #define KDBG_RESTORE_IRQ(old) do { \
193 KDBG_WAIT_TXDONE(); \
198 typedef uint8_t kdbg_irqsave_t;
201 * Special debug port for BitBanged Serial see below for details...
203 #elif CONFIG_KDEBUG_PORT == 666
205 #define KDBG_WAIT_READY() do { /*nop*/ } while(0)
206 #define KDBG_WRITE_CHAR(c) _kdebug_bitbang_putchar((c))
207 #define KDBG_MASK_IRQ(old) do { IRQ_SAVE_DISABLE((old)); } while(0)
208 #define KDBG_RESTORE_IRQ(old) do { IRQ_RESTORE((old)); } while(0)
209 typedef cpuflags_t kdbg_irqsave_t;
211 #define KDBG_DELAY (((CLOCK_FREQ + CONFIG_KDEBUG_BAUDRATE / 2) / CONFIG_KDEBUG_BAUDRATE) + 7) / 14
213 static void _kdebug_bitbang_delay(void)
217 for (i = 0; i < KDBG_DELAY; i++)
227 #error CONFIG_KDEBUG_PORT should be either 0, 1 or 666
229 #elif defined(__MWERKS__) && CPU_DSP56K
230 /* Debugging go through the JTAG interface. The MSL library already
231 implements the console I/O correctly. */
233 #define KDBG_WAIT_READY() do { } while (0)
234 #define KDBG_WRITE_CHAR(c) __put_char(c, stdout)
235 #define KDBG_MASK_IRQ(old) do { (void)(old); } while (0)
236 #define KDBG_RESTORE_IRQ(old) do { (void)(old); } while (0)
237 typedef uint8_t kdbg_irqsave_t; /* unused */
238 #if CONFIG_KDEBUG_PORT == 666
239 #error BITBANG debug console missing for this platform
242 #error Unknown architecture
245 #if CONFIG_KDEBUG_PORT == 666
247 * Putchar for BITBANG serial debug console.
248 * Sometimes, we can't permit to use a whole serial for debugging purpose.
249 * Since debug console is in output only it is usefull to use a single generic I/O pin for debug.
250 * This is achieved by this simple function, that shift out the data like a UART, but
252 * The only requirement is that SER_BITBANG_* macros will be defined somewhere (usually hw_ser.h)
253 * \note All interrupts are disabled during debug prints!
255 static void _kdebug_bitbang_putchar(char c)
268 for (i = 0; i < 10; i++)
274 _kdebug_bitbang_delay();
287 /* Set serial port for 19200bps 8N1 */
288 INT_MASK1 &= ~(INT1F_TI | INT1F_RI);
289 SP_CON = SPCF_RECEIVE_ENABLE | SPCF_MODE1;
290 ioc1_img |= IOC1F_TXD_SEL | IOC1F_EXTINT_SRC;
296 #if CONFIG_KDEBUG_PORT == 666
298 #else /* CONFIG_KDEBUG_PORT != 666 */
299 /* Compute the baud rate */
300 uint16_t period = (((CLOCK_FREQ / 16UL) + (CONFIG_KDEBUG_BAUDRATE / 2)) / CONFIG_KDEBUG_BAUDRATE) - 1;
302 #if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128
303 #if CONFIG_KDEBUG_PORT == 0
304 UBRR0H = (uint8_t)(period>>8);
305 UBRR0L = (uint8_t)period;
307 #elif CONFIG_KDEBUG_PORT == 1
308 UBRR1H = (uint8_t)(period>>8);
309 UBRR1L = (uint8_t)period;
312 #error CONFIG_KDEBUG_PORT must be either 0 or 1
314 #elif CPU_AVR_ATMEGA8
315 UBRRH = (uint8_t)(period>>8);
316 UBRRL = (uint8_t)period;
317 #elif CPU_AVR_ATMEGA103
318 UBRR = (uint8_t)period;
323 #endif /* CONFIG_KDEBUG_PORT == 666 */
325 #endif /* !CPU_I196 && !CPU_AVR */
327 kputs("\n\n*** DBG START ***\n");
332 * Output one character to the debug console
334 static void __kputchar(char c, UNUSED_ARG(void *, unused))
336 /* Poll while serial buffer is still busy */
339 /* Send '\n' as '\r\n' for dumb terminals */
342 KDBG_WRITE_CHAR('\r');
350 void kputchar(char c)
352 /* Mask serial TX intr */
353 kdbg_irqsave_t irqsave;
354 KDBG_MASK_IRQ(irqsave);
358 /* Restore serial TX intr */
359 KDBG_RESTORE_IRQ(irqsave);
363 static void PGM_FUNC(kvprintf)(const char * PGM_ATTR fmt, va_list ap)
366 /* Mask serial TX intr */
367 kdbg_irqsave_t irqsave;
368 KDBG_MASK_IRQ(irqsave);
370 PGM_FUNC(_formatted_write)(fmt, __kputchar, 0, ap);
372 /* Restore serial TX intr */
373 KDBG_RESTORE_IRQ(irqsave);
375 /* A better than nothing printf() surrogate. */
376 PGM_FUNC(kputs)(fmt);
377 #endif /* CONFIG_PRINTF */
380 void PGM_FUNC(kprintf)(const char * PGM_ATTR fmt, ...)
385 PGM_FUNC(kvprintf)(fmt, ap);
389 void PGM_FUNC(kputs)(const char * PGM_ATTR str)
393 /* Mask serial TX intr */
394 kdbg_irqsave_t irqsave;
395 KDBG_MASK_IRQ(irqsave);
397 while ((c = PGM_READ_CHAR(str++)))
400 KDBG_RESTORE_IRQ(irqsave);
405 * Cheap function to print small integers without using printf().
415 digit = num / divisor;
418 if (digit || output_len || divisor == 1)
420 kputchar(digit + '0');
424 while (divisor /= 10);
430 static void klocation(const char * PGM_ATTR file, int line)
432 PGM_FUNC(kputs)(file);
435 PGM_FUNC(kputs)(PGM_STR(": "));
438 int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char * PGM_ATTR file, int line)
440 klocation(file, line);
441 PGM_FUNC(kputs)(PGM_STR("Assertion failed: "));
442 PGM_FUNC(kputs)(cond);
449 * Unfortunately, there's no way to get __func__ in
450 * program memory, so we waste quite a lot of RAM in
451 * AVR and other Harvard processors.
453 void PGM_FUNC(__trace)(const char *name)
455 PGM_FUNC(kprintf)(PGM_STR("%s()\n"), name);
458 void PGM_FUNC(__tracemsg)(const char *name, const char * PGM_ATTR fmt, ...)
462 PGM_FUNC(kprintf)(PGM_STR("%s(): "), name);
464 PGM_FUNC(kvprintf)(fmt, ap);
469 int PGM_FUNC(__invalid_ptr)(void *value, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
471 klocation(file, line);
472 PGM_FUNC(kputs)(PGM_STR("Invalid ptr: "));
473 PGM_FUNC(kputs)(name);
475 PGM_FUNC(kprintf)(PGM_STR(" = 0x%x\n"), (unsigned int)value);
484 void __init_wall(long *wall, int size)
487 *wall++ = WALL_VALUE;
491 int PGM_FUNC(__check_wall)(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
495 for (i = 0; i < size; i++)
497 if (wall[i] != WALL_VALUE)
499 klocation(file, line);
500 PGM_FUNC(kputs)(PGM_STR("Wall broken: "));
501 PGM_FUNC(kputs)(name);
503 PGM_FUNC(kprintf)(PGM_STR("[%d] (0x%p) = 0x%lx\n"), i, wall + i, wall[i]);
518 * Dump binary data in hex
520 void kdump(const void *_buf, size_t len)
522 const unsigned char *buf = (const unsigned char *)_buf;
525 kprintf("%02X", *buf++);
529 #endif /* CONFIG_PRINTF */