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.20 2005/01/25 08:36:40 bernie
19 *#* kputnum(): Export.
21 *#* Revision 1.19 2004/12/31 17:47:45 bernie
22 *#* Rename UNUSED() to UNUSED_ARG().
24 *#* Revision 1.18 2004/12/08 08:52:00 bernie
25 *#* Save some more RAM on AVR.
27 *#* Revision 1.17 2004/10/03 18:41:28 bernie
28 *#* Restore \version header killed by mistake in previous commit.
30 *#* Revision 1.16 2004/10/03 18:40:50 bernie
31 *#* Use new CPU macros.
33 *#* Revision 1.15 2004/09/14 21:03:46 bernie
34 *#* Use debug.h instead of kdebug.h.
36 *#* Revision 1.14 2004/09/06 21:39:56 bernie
37 *#* Allow partial redefinition of BUS macros.
39 *#* Revision 1.13 2004/08/29 22:04:26 bernie
40 *#* Convert 485 macros to generic BUS macros;
41 *#* kputchar(): New public function.
43 *#* Revision 1.12 2004/08/25 14:12:08 rasky
44 *#* Aggiornato il comment block dei log RCS
46 *#* Revision 1.11 2004/08/24 16:19:08 bernie
47 *#* kputchar(): New public function; Add missing dummy inlines for \!_DEBUG.
49 *#* Revision 1.10 2004/08/04 15:57:50 rasky
50 *#* Cambiata la putchar per kdebug per DSP56k: la nuova funzione e' quella piu' a basso livello (assembly)
52 *#* Revision 1.9 2004/08/02 20:20:29 aleph
53 *#* Merge from project_ks
55 *#* Revision 1.8 2004/07/30 14:26:33 rasky
56 *#* Semplificato l'output dell'ASSERT
57 *#* Aggiunta ASSERT2 con stringa di help opzionalmente disattivabile
59 *#* Revision 1.7 2004/07/30 14:15:53 rasky
60 *#* Nuovo supporto unificato per detect della CPU
62 *#* Revision 1.6 2004/07/18 21:49:28 bernie
63 *#* Add ATmega8 support.
65 *#* Revision 1.5 2004/06/27 15:20:26 aleph
66 *#* Change UNUSED() macro to accept two arguments: type and name;
67 *#* Add macro GNUC_PREREQ to detect GCC version during build;
68 *#* Some spacing cleanups and typo fix
70 *#* Revision 1.4 2004/06/06 18:09:51 bernie
71 *#* Import DSP56800 changes; Print broken wall bricks in hex.
73 *#* Revision 1.3 2004/06/03 11:27:09 bernie
74 *#* Add dual-license information.
76 *#* Revision 1.2 2004/05/23 18:21:53 bernie
77 *#* Trim CVS logs and cleanup header info.
83 #include <macros.h> /* for BV() */
87 #include <mware/formatwr.h> /* for _formatted_write() */
93 #define KDBG_WAIT_READY() do { /*nop*/ } while(0)
94 #define KDBG_WRITE_CHAR(c) putchar((c))
95 #define KDBG_MASK_IRQ(old) do { (void)(old); } while(0)
96 #define KDBG_RESTORE_IRQ(old) do { /*nop*/ } while(0)
97 typedef char kdbg_irqsave_t; /* unused */
100 #define KDBG_WAIT_READY() do {} while (!(SP_STAT & (SPSF_TX_EMPTY | SPSF_TX_INT)))
101 #define KDBG_WRITE_CHAR(c) do { SBUF = (c); } while(0)
102 #define KDBG_MASK_IRQ(old) \
104 (old) = INT_MASK1 & INT1F_TI; \
105 INT_MASK1 &= ~INT1F_TI; \
107 #define KDBG_RESTORE_IRQ(old) do { INT_MASK1 |= (old); }
108 typedef uint16_t kdbg_irqsave_t; /* FIXME: unconfirmed */
112 #if CONFIG_KDEBUG_PORT == 0
115 * Support for special bus policies or external transceivers
116 * on UART0 (to be overridden in "hw.h").
118 #ifndef KDBG_UART0_BUS_INIT
119 #define KDBG_UART0_BUS_INIT do {} while (0)
121 #ifndef KDBG_UART0_BUS_RX
122 #define KDBG_UART0_BUS_RX do {} while (0)
124 #ifndef KDBG_UART0_BUS_TX
125 #define KDBG_UART0_BUS_TX do {} while (0)
132 #elif CPU_AVR_ATMEGA8
139 #define KDBG_WAIT_READY() do { loop_until_bit_is_set(USR, UDRE); } while(0)
140 #define KDBG_WAIT_TXDONE() do { loop_until_bit_is_set(USR, TXC); } while(0)
143 * We must clear the TXC flag before sending a new character to allow
144 * KDBG_WAIT_TXDONE() to work properly.
146 * BUG: if KDBG_WRITE_CHAR() is called after the TXC flag is set by hardware,
147 * a new TXC could be generated after we've cleared it and before the new
148 * character is written to UDR. On a 485 bus, the transceiver will be put
149 * in RX mode while still transmitting the last char.
151 #define KDBG_WRITE_CHAR(c) do { USR |= BV(TXC); UDR = (c); } while(0)
153 #define KDBG_MASK_IRQ(old) do { \
156 UCR &= ~(BV(TXCIE) | BV(UDRIE)); \
160 #define KDBG_RESTORE_IRQ(old) do { \
161 KDBG_WAIT_TXDONE(); \
166 typedef uint8_t kdbg_irqsave_t;
168 #elif CONFIG_KDEBUG_PORT == 1
171 * Support for special bus policies or external transceivers
172 * on UART1 (to be overridden in "hw.h").
174 #ifndef KDBG_UART1_BUS_INIT
175 #define KDBG_UART1_BUS_INIT do {} while (0)
177 #ifndef KDBG_UART1_BUS_RX
178 #define KDBG_UART1_BUS_RX do {} while (0)
180 #ifndef KDBG_UART1_BUS_TX
181 #define KDBG_UART1_BUS_TX do {} while (0)
184 #define KDBG_WAIT_READY() do { loop_until_bit_is_set(UCSR1A, UDRE); } while(0)
185 #define KDBG_WAIT_TXDONE() do { loop_until_bit_is_set(UCSR1A, TXC); } while(0)
186 #define KDBG_WRITE_CHAR(c) do { UCSR1A |= BV(TXC); UDR1 = (c); } while(0)
188 #define KDBG_MASK_IRQ(old) do { \
190 UCSR1B |= BV(TXEN); \
191 UCSR1B &= ~(BV(TXCIE) | BV(UDRIE)); \
195 #define KDBG_RESTORE_IRQ(old) do { \
196 KDBG_WAIT_TXDONE(); \
201 typedef uint8_t kdbg_irqsave_t;
203 #error CONFIG_KDEBUG_PORT should be either 0 or 1
205 #elif defined(__MWERKS__) && CPU_DSP56K
206 /* Debugging go through the JTAG interface. The MSL library already
207 implements the console I/O correctly. */
209 #define KDBG_WAIT_READY() do { } while (0)
210 #define KDBG_WRITE_CHAR(c) __put_char(c, stdout)
211 #define KDBG_MASK_IRQ(old) do { (void)(old); } while (0)
212 #define KDBG_RESTORE_IRQ(old) do { (void)(old); } while (0)
213 typedef uint8_t kdbg_irqsave_t; /* unused */
215 #error Unknown architecture
223 /* Set serial port for 19200bps 8N1 */
224 INT_MASK1 &= ~(INT1F_TI | INT1F_RI);
225 SP_CON = SPCF_RECEIVE_ENABLE | SPCF_MODE1;
226 ioc1_img |= IOC1F_TXD_SEL | IOC1F_EXTINT_SRC;
233 /* Compute the baud rate */
234 uint16_t period = (((CLOCK_FREQ / 16UL) + (CONFIG_KDEBUG_BAUDRATE / 2)) / CONFIG_KDEBUG_BAUDRATE) - 1;
237 #if CONFIG_KDEBUG_PORT == 0
238 UBRR0H = (uint8_t)(period>>8);
239 UBRR0L = (uint8_t)period;
241 #elif CONFIG_KDEBUG_PORT == 1
242 UBRR1H = (uint8_t)(period>>8);
243 UBRR1L = (uint8_t)period;
246 #error CONFIG_KDEBUG_PORT must be either 0 or 1
248 #elif CPU_AVR_ATMEGA8
249 UBRRH = (uint8_t)(period>>8);
250 UBRRL = (uint8_t)period;
251 #elif CPU_AVR_ATMEGA103
252 UBRR = (uint8_t)period;
258 #endif /* !CPU_I196 && !CPU_AVR */
260 kputs("\n\n*** DBG START ***\n");
265 * Output one character to the debug console
267 static void __kputchar(char c, UNUSED_ARG(void *, unused))
269 /* Poll while serial buffer is still busy */
272 /* Send '\n' as '\r\n' for dumb terminals */
275 KDBG_WRITE_CHAR('\r');
283 void kputchar(char c)
285 /* Mask serial TX intr */
286 kdbg_irqsave_t irqsave;
287 KDBG_MASK_IRQ(irqsave);
291 /* Restore serial TX intr */
292 KDBG_RESTORE_IRQ(irqsave);
296 void PGM_FUNC(kprintf)(const char * PGM_ATTR fmt, ...)
302 /* Mask serial TX intr */
303 kdbg_irqsave_t irqsave;
304 KDBG_MASK_IRQ(irqsave);
307 PGM_FUNC(_formatted_write)(fmt, __kputchar, 0, ap);
310 /* Restore serial TX intr */
311 KDBG_RESTORE_IRQ(irqsave);
313 /* A better than nothing printf() surrogate. */
314 PGM_FUNC(kputs)(fmt);
315 #endif /* CONFIG_PRINTF */
319 void PGM_FUNC(kputs)(const char * PGM_ATTR str)
323 /* Mask serial TX intr */
324 kdbg_irqsave_t irqsave;
325 KDBG_MASK_IRQ(irqsave);
327 while ((c = PGM_READ_CHAR(str++)))
330 KDBG_RESTORE_IRQ(irqsave);
335 * Cheap function to print small integers without using printf().
345 digit = num / divisor;
348 if (digit || output_len || divisor == 1)
350 kputchar(digit + '0');
354 while (divisor /= 10);
360 static void klocation(const char * PGM_ATTR file, int line)
362 PGM_FUNC(kputs)(file);
365 PGM_FUNC(kputs)(PSTR(": "));
368 int PGM_FUNC(__assert)(const char * PGM_ATTR cond, const char * PGM_ATTR file, int line)
370 klocation(file, line);
371 PGM_FUNC(kputs)(PSTR("Assertion failed: "));
372 PGM_FUNC(kputs)(cond);
378 int PGM_FUNC(__invalid_ptr)(void *value, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
380 klocation(file, line);
381 PGM_FUNC(kputs)(PSTR("Invalid ptr: "));
382 PGM_FUNC(kputs)(name);
384 PGM_FUNC(kprintf)(PSTR(" = 0x%x\n"), value);
393 void __init_wall(long *wall, int size)
396 *wall++ = WALL_VALUE;
400 int PGM_FUNC(__check_wall)(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line)
404 for (i = 0; i < size; i++)
406 if (wall[i] != WALL_VALUE)
408 klocation(file, line);
409 PGM_FUNC(kputs)(PSTR("Wall broken: "));
410 PGM_FUNC(kputs)(name);
412 PGM_FUNC(kprintf)(PSTR("[%d] (0x%p) = 0x%lx\n"), i, wall + i, wall[i]);
427 * Dump binary data in hex
429 void kdump(const void *_buf, size_t len)
431 const unsigned char *buf = (const unsigned char *)_buf;
434 kprintf("%02X", *buf++);
438 #endif /* CONFIG_PRINTF */