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.
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.18 2004/12/08 08:52:00 bernie
19 *#* Save some more RAM on AVR.
21 *#* Revision 1.17 2004/10/03 18:41:28 bernie
22 *#* Restore \version header killed by mistake in previous commit.
24 *#* Revision 1.16 2004/10/03 18:40:50 bernie
25 *#* Use new CPU macros.
27 *#* Revision 1.15 2004/09/14 21:03:46 bernie
28 *#* Use debug.h instead of kdebug.h.
30 *#* Revision 1.14 2004/09/06 21:39:56 bernie
31 *#* Allow partial redefinition of BUS macros.
33 *#* Revision 1.13 2004/08/29 22:04:26 bernie
34 *#* Convert 485 macros to generic BUS macros;
35 *#* kputchar(): New public function.
37 *#* Revision 1.12 2004/08/25 14:12:08 rasky
38 *#* Aggiornato il comment block dei log RCS
40 *#* Revision 1.11 2004/08/24 16:19:08 bernie
41 *#* kputchar(): New public function; Add missing dummy inlines for \!_DEBUG.
43 *#* Revision 1.10 2004/08/04 15:57:50 rasky
44 *#* Cambiata la putchar per kdebug per DSP56k: la nuova funzione e' quella piu' a basso livello (assembly)
46 *#* Revision 1.9 2004/08/02 20:20:29 aleph
47 *#* Merge from project_ks
49 *#* Revision 1.8 2004/07/30 14:26:33 rasky
50 *#* Semplificato l'output dell'ASSERT
51 *#* Aggiunta ASSERT2 con stringa di help opzionalmente disattivabile
53 *#* Revision 1.7 2004/07/30 14:15:53 rasky
54 *#* Nuovo supporto unificato per detect della CPU
56 *#* Revision 1.6 2004/07/18 21:49:28 bernie
57 *#* Add ATmega8 support.
59 *#* Revision 1.5 2004/06/27 15:20:26 aleph
60 *#* Change UNUSED() macro to accept two arguments: type and name;
61 *#* Add macro GNUC_PREREQ to detect GCC version during build;
62 *#* Some spacing cleanups and typo fix
64 *#* Revision 1.4 2004/06/06 18:09:51 bernie
65 *#* Import DSP56800 changes; Print broken wall bricks in hex.
67 *#* Revision 1.3 2004/06/03 11:27:09 bernie
68 *#* Add dual-license information.
70 *#* Revision 1.2 2004/05/23 18:21:53 bernie
71 *#* Trim CVS logs and cleanup header info.
80 #include <mware/formatwr.h> /* for _formatted_write() */
86 #define KDBG_WAIT_READY() do { /*nop*/ } while(0)
87 #define KDBG_WRITE_CHAR(c) putchar((c))
88 #define KDBG_MASK_IRQ(old) do { (void)(old); } while(0)
89 #define KDBG_RESTORE_IRQ(old) do { /*nop*/ } while(0)
90 typedef char kdbg_irqsave_t; /* unused */
93 #define KDBG_WAIT_READY() do {} while (!(SP_STAT & (SPSF_TX_EMPTY | SPSF_TX_INT)))
94 #define KDBG_WRITE_CHAR(c) do { SBUF = (c); } while(0)
95 #define KDBG_MASK_IRQ(old) \
97 (old) = INT_MASK1 & INT1F_TI; \
98 INT_MASK1 &= ~INT1F_TI; \
100 #define KDBG_RESTORE_IRQ(old) do { INT_MASK1 |= (old); }
101 typedef uint16_t kdbg_irqsave_t; /* FIXME: unconfirmed */
105 #if CONFIG_KDEBUG_PORT == 0
108 * Support for special bus policies or external transceivers
109 * on UART0 (to be overridden in "hw.h").
111 #ifndef KDBG_UART0_BUS_INIT
112 #define KDBG_UART0_BUS_INIT do {} while (0)
114 #ifndef KDBG_UART0_BUS_RX
115 #define KDBG_UART0_BUS_RX do {} while (0)
117 #ifndef KDBG_UART0_BUS_TX
118 #define KDBG_UART0_BUS_TX do {} while (0)
125 #elif CPU_AVR_ATMEGA8
132 #define KDBG_WAIT_READY() do { loop_until_bit_is_set(USR, UDRE); } while(0)
133 #define KDBG_WAIT_TXDONE() do { loop_until_bit_is_set(USR, TXC); } while(0)
136 * We must clear the TXC flag before sending a new character to allow
137 * KDBG_WAIT_TXDONE() to work properly.
139 * BUG: if KDBG_WRITE_CHAR() is called after the TXC flag is set by hardware,
140 * a new TXC could be generated after we've cleared it and before the new
141 * character is written to UDR. On a 485 bus, the transceiver will be put
142 * in RX mode while still transmitting the last char.
144 #define KDBG_WRITE_CHAR(c) do { USR |= BV(TXC); UDR = (c); } while(0)
146 #define KDBG_MASK_IRQ(old) do { \
149 UCR &= ~(BV(TXCIE) | BV(UDRIE)); \
153 #define KDBG_RESTORE_IRQ(old) do { \
154 KDBG_WAIT_TXDONE(); \
159 typedef uint8_t kdbg_irqsave_t;
161 #elif CONFIG_KDEBUG_PORT == 1
164 * Support for special bus policies or external transceivers
165 * on UART1 (to be overridden in "hw.h").
167 #ifndef KDBG_UART1_BUS_INIT
168 #define KDBG_UART1_BUS_INIT do {} while (0)
170 #ifndef KDBG_UART1_BUS_RX
171 #define KDBG_UART1_BUS_RX do {} while (0)
173 #ifndef KDBG_UART1_BUS_TX
174 #define KDBG_UART1_BUS_TX do {} while (0)
177 #define KDBG_WAIT_READY() do { loop_until_bit_is_set(UCSR1A, UDRE); } while(0)
178 #define KDBG_WAIT_TXDONE() do { loop_until_bit_is_set(UCSR1A, TXC); } while(0)
179 #define KDBG_WRITE_CHAR(c) do { UCSR1A |= BV(TXC); UDR1 = (c); } while(0)
181 #define KDBG_MASK_IRQ(old) do { \
183 UCSR1B |= BV(TXEN); \
184 UCSR1B &= ~(BV(TXCIE) | BV(UDRIE)); \
188 #define KDBG_RESTORE_IRQ(old) do { \
189 KDBG_WAIT_TXDONE(); \
194 typedef uint8_t kdbg_irqsave_t;
196 #error CONFIG_KDEBUG_PORT should be either 0 or 1
198 #elif defined(__MWERKS__) && CPU_DSP56K
199 /* Debugging go through the JTAG interface. The MSL library already
200 implements the console I/O correctly. */
202 #define KDBG_WAIT_READY() do { } while (0)
203 #define KDBG_WRITE_CHAR(c) __put_char(c, stdout)
204 #define KDBG_MASK_IRQ(old) do { (void)(old); } while (0)
205 #define KDBG_RESTORE_IRQ(old) do { (void)(old); } while (0)
206 typedef uint8_t kdbg_irqsave_t; /* unused */
208 #error Unknown architecture
216 /* Set serial port for 19200bps 8N1 */
217 INT_MASK1 &= ~(INT1F_TI | INT1F_RI);
218 SP_CON = SPCF_RECEIVE_ENABLE | SPCF_MODE1;
219 ioc1_img |= IOC1F_TXD_SEL | IOC1F_EXTINT_SRC;
226 /* Compute the baud rate */
227 uint16_t period = (((CLOCK_FREQ / 16UL) + (CONFIG_KDEBUG_BAUDRATE / 2)) / CONFIG_KDEBUG_BAUDRATE) - 1;
230 #if CONFIG_KDEBUG_PORT == 0
231 UBRR0H = (uint8_t)(period>>8);
232 UBRR0L = (uint8_t)period;
234 #elif CONFIG_KDEBUG_PORT == 1
235 UBRR1H = (uint8_t)(period>>8);
236 UBRR1L = (uint8_t)period;
239 #error CONFIG_KDEBUG_PORT must be either 0 or 1
241 #elif CPU_AVR_ATMEGA8
242 UBRRH = (uint8_t)(period>>8);
243 UBRRL = (uint8_t)period;
244 #elif CPU_AVR_ATMEGA103
245 UBRR = (uint8_t)period;
251 #endif /* !CPU_I196 && !CPU_AVR */
253 kputs("\n\n*** DBG START ***\n");
258 * Output one character to the debug console
260 static void __kputchar(char c, UNUSED(void *, unused))
262 /* Poll while serial buffer is still busy */
265 /* Send '\n' as '\r\n' for dumb terminals */
268 KDBG_WRITE_CHAR('\r');
276 void kputchar(char c)
278 /* Mask serial TX intr */
279 kdbg_irqsave_t irqsave;
280 KDBG_MASK_IRQ(irqsave);
284 /* Restore serial TX intr */
285 KDBG_RESTORE_IRQ(irqsave);
289 void PGM_FUNC(kprintf)(const char * PGM_ATTR fmt, ...)
295 /* Mask serial TX intr */
296 kdbg_irqsave_t irqsave;
297 KDBG_MASK_IRQ(irqsave);
300 PGM_FUNC(_formatted_write)(fmt, __kputchar, 0, ap);
303 /* Restore serial TX intr */
304 KDBG_RESTORE_IRQ(irqsave);
306 /* A better than nothing printf() surrogate. */
307 PGM_FUNC(kputs)(fmt);
308 #endif /* CONFIG_PRINTF */
312 void PGM_FUNC(kputs)(const char * PGM_ATTR str)
316 /* Mask serial TX intr */
317 kdbg_irqsave_t irqsave;
318 KDBG_MASK_IRQ(irqsave);
320 while ((c = PGM_READ_CHAR(str++)))
323 KDBG_RESTORE_IRQ(irqsave);
328 * Cheap function to print small integers without using printf().
330 static int kputnum(int num)
338 digit = num / divisor;
341 if (digit || output_len || divisor == 1)
343 kputchar(digit + '0');
347 while (divisor /= 10);
353 static void klocation(const char * PGM_ATTR file, int line)
355 PGM_FUNC(kputs)(file);
358 PGM_FUNC(kputs)(PSTR(": "));
361 int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char * PGM_ATTR file, int line)
363 klocation(file, line);
364 PGM_FUNC(kputs)(PSTR("Assertion failed: "));
365 PGM_FUNC(kputs)(cond);
371 int PGM_FUNC(__invalid_ptr)(void *value, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
373 klocation(file, line);
374 PGM_FUNC(kputs)(PSTR("Invalid ptr: "));
375 PGM_FUNC(kputs)(name);
377 PGM_FUNC(kprintf)(PSTR(" = 0x%x\n"), value);
386 void __init_wall(long *wall, int size)
389 *wall++ = WALL_VALUE;
393 int PGM_FUNC(__check_wall)(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
397 for (i = 0; i < size; i++)
399 if (wall[i] != WALL_VALUE)
401 klocation(file, line);
402 PGM_FUNC(kputs)(PSTR("Wall broken: "));
403 PGM_FUNC(kputs)(name);
405 PGM_FUNC(kprintf)(PSTR("[%d] (0x%p) = 0x%lx\n"), i, wall + i, wall[i]);
420 * Dump binary data in hex
422 void kdump(const void *_buf, size_t len)
424 const unsigned char *buf = (const unsigned char *)_buf;
427 kprintf("%02X", *buf++);
431 #endif /* CONFIG_PRINTF */