unified MX27, MX25, MX37 trees
[karo-tx-redboot.git] / packages / hal / arm / mx37 / karo / v1_0 / src / tx37_diag.c
1 /*=============================================================================
2 //
3 //      board_diag.c
4 //
5 //      HAL diagnostic output code
6 //
7 //=============================================================================
8 //####ECOSGPLCOPYRIGHTBEGIN####
9 // -------------------------------------------
10 // This file is part of eCos, the Embedded Configurable Operating System.
11 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
12 //
13 // eCos is free software; you can redistribute it and/or modify it under
14 // the terms of the GNU General Public License as published by the Free
15 // Software Foundation; either version 2 or (at your option) any later version.
16 //
17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
20 // for more details.
21 //
22 // You should have received a copy of the GNU General Public License along
23 // with eCos; if not, write to the Free Software Foundation, Inc.,
24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
25 //
26 // As a special exception, if other files instantiate templates or use macros
27 // or inline functions from this file, or you compile this file and link it
28 // with other works to produce a work based on this file, this file does not
29 // by itself cause the resulting work to be covered by the GNU General Public
30 // License. However the source code for this file must still be made available
31 // in accordance with section (3) of the GNU General Public License.
32 //
33 // This exception does not invalidate any other reasons why a work based on
34 // this file might be covered by the GNU General Public License.
35 //
36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
37 // at http://sources.redhat.com/ecos/ecos-license/
38 // -------------------------------------------
39 //####ECOSGPLCOPYRIGHTEND####
40 //===========================================================================*/
41
42 #include <pkgconf/hal.h>
43
44 #include <cyg/infra/cyg_type.h>         // base types
45 #include <cyg/infra/cyg_trac.h>         // tracing macros
46 #include <cyg/infra/cyg_ass.h>          // assertion macros
47
48 #include <cyg/hal/hal_arch.h>           // basic machine info
49 #include <cyg/hal/hal_intr.h>           // interrupt macros
50 #include <cyg/hal/hal_io.h>             // IO macros
51 #include <cyg/hal/hal_diag.h>
52 #include <cyg/hal/hal_if.h>             // Calling-if API
53 #include <cyg/hal/drv_api.h>            // driver API
54 #include <cyg/hal/hal_misc.h>           // Helper functions
55 #include <cyg/hal/hal_soc.h>            // Hardware definitions
56 #include <cyg/hal/karo_tx37.h>          // Platform specifics
57
58 extern void cyg_hal_plf_serial_init(void);
59
60 void cyg_hal_plf_comms_init(void)
61 {
62     static int initialized = 0;
63
64     if (initialized) {
65             return;
66     }
67     initialized = 1;
68     cyg_hal_plf_serial_init();
69 }
70
71 //-----------------------------------------------------------------------------
72 // Based on 3.6864 MHz xtal
73 #if CYGNUM_HAL_VIRTUAL_VECTOR_CONSOLE_CHANNEL_BAUD==9600
74 #define CYG_DEV_SERIAL_BAUD_MSB        0x00
75 #define CYG_DEV_SERIAL_BAUD_LSB        0x18
76 #endif
77 #if CYGNUM_HAL_VIRTUAL_VECTOR_CONSOLE_CHANNEL_BAUD==19200
78 #define CYG_DEV_SERIAL_BAUD_MSB        0x00
79 #define CYG_DEV_SERIAL_BAUD_LSB        0x0C
80 #endif
81 #if CYGNUM_HAL_VIRTUAL_VECTOR_CONSOLE_CHANNEL_BAUD==38400
82 #define CYG_DEV_SERIAL_BAUD_MSB        0x00
83 #define CYG_DEV_SERIAL_BAUD_LSB        0x06
84 #endif
85 #if CYGNUM_HAL_VIRTUAL_VECTOR_CONSOLE_CHANNEL_BAUD==57600
86 #define CYG_DEV_SERIAL_BAUD_MSB        0x00
87 #define CYG_DEV_SERIAL_BAUD_LSB        0x04
88 #endif
89 #if CYGNUM_HAL_VIRTUAL_VECTOR_CONSOLE_CHANNEL_BAUD==115200
90 #define CYG_DEV_SERIAL_BAUD_MSB        0x00
91 #define CYG_DEV_SERIAL_BAUD_LSB        0x02
92 #endif
93
94 #ifndef CYG_DEV_SERIAL_BAUD_MSB
95 #error Missing/incorrect serial baud rate defined - CDL error?
96 #endif
97
98 //-----------------------------------------------------------------------------
99 // Define the serial registers. The board is equipped with a 16552
100 // serial chip.
101
102 #if defined (EXT_UART_x16)
103 #define HAL_WRITE_UINT_UART HAL_WRITE_UINT16
104 #define HAL_READ_UINT_UART HAL_READ_UINT16
105 typedef cyg_uint16 uart_width;
106 #elif defined (EXT_UART_x32)
107 #define HAL_WRITE_UINT_UART HAL_WRITE_UINT32
108 #define HAL_READ_UINT_UART HAL_READ_UINT32
109 typedef cyg_uint32 uart_width;
110 #else  //_x8
111 #define HAL_WRITE_UINT_UART HAL_WRITE_UINT8
112 #define HAL_READ_UINT_UART HAL_READ_UINT8
113 typedef cyg_uint8 uart_width;
114 #endif
115
116 #define CYG_DEV_SERIAL_RHR   0x00 // receiver buffer register, read, dlab = 0
117 #define CYG_DEV_SERIAL_THR   0x00 // transmitter holding register, write, dlab = 0
118 #define CYG_DEV_SERIAL_DLL   0x00 // divisor latch (LS), read/write, dlab = 1
119 #define CYG_DEV_SERIAL_IER   0x01 // interrupt enable register, read/write, dlab = 0
120 #define CYG_DEV_SERIAL_DLM   0x01 // divisor latch (MS), read/write, dlab = 1
121 #define CYG_DEV_SERIAL_IIR   0x02 // interrupt identification register, read, dlab = 0
122 #define CYG_DEV_SERIAL_FCR   0x02 // fifo control register, write, dlab = 0
123 #define CYG_DEV_SERIAL_AFR   0x02 // alternate function register, read/write, dlab = 1
124 #define CYG_DEV_SERIAL_LCR   0x03 // line control register, read/write
125 #define CYG_DEV_SERIAL_MCR   0x04
126 #define CYG_DEV_SERIAL_MCR_A 0x04
127 #define CYG_DEV_SERIAL_MCR_B 0x04
128 #define CYG_DEV_SERIAL_LSR   0x05 // line status register, read
129 #define CYG_DEV_SERIAL_MSR   0x06 // modem status register, read
130 #define CYG_DEV_SERIAL_SCR   0x07 // scratch pad register
131
132 // The interrupt enable register bits.
133 #define SIO_IER_ERDAI   0x01            // enable received data available irq
134 #define SIO_IER_ETHREI  0x02            // enable THR empty interrupt
135 #define SIO_IER_ELSI    0x04            // enable receiver line status irq
136 #define SIO_IER_EMSI    0x08            // enable modem status interrupt
137
138 // The interrupt identification register bits.
139 #define SIO_IIR_IP      0x01            // 0 if interrupt pending
140 #define SIO_IIR_ID_MASK 0x0e            // mask for interrupt ID bits
141 #define ISR_Tx          0x02
142 #define ISR_Rx          0x04
143
144 // The line status register bits.
145 #define SIO_LSR_DR      0x01            // data ready
146 #define SIO_LSR_OE      0x02            // overrun error
147 #define SIO_LSR_PE      0x04            // parity error
148 #define SIO_LSR_FE      0x08            // framing error
149 #define SIO_LSR_BI      0x10            // break interrupt
150 #define SIO_LSR_THRE    0x20            // transmitter holding register empty
151 #define SIO_LSR_TEMT    0x40            // transmitter register empty
152 #define SIO_LSR_ERR     0x80            // any error condition
153
154 // The modem status register bits.
155 #define SIO_MSR_DCTS    0x01            // delta clear to send
156 #define SIO_MSR_DDSR    0x02            // delta data set ready
157 #define SIO_MSR_TERI    0x04            // trailing edge ring indicator
158 #define SIO_MSR_DDCD    0x08            // delta data carrier detect
159 #define SIO_MSR_CTS     0x10            // clear to send
160 #define SIO_MSR_DSR     0x20            // data set ready
161 #define SIO_MSR_RI      0x40            // ring indicator
162 #define SIO_MSR_DCD     0x80            // data carrier detect
163
164 // The line control register bits.
165 #define SIO_LCR_WLS0   0x01             // word length select bit 0
166 #define SIO_LCR_WLS1   0x02             // word length select bit 1
167 #define SIO_LCR_STB    0x04             // number of stop bits
168 #define SIO_LCR_PEN    0x08             // parity enable
169 #define SIO_LCR_EPS    0x10             // even parity select
170 #define SIO_LCR_SP     0x20             // stick parity
171 #define SIO_LCR_SB     0x40             // set break
172 #define SIO_LCR_DLAB   0x80             // divisor latch access bit
173
174 // The FIFO control register
175 #define SIO_FCR_FCR0   0x01             // enable xmit and rcvr fifos
176 #define SIO_FCR_FCR1   0x02             // clear RCVR FIFO
177 #define SIO_FCR_FCR2   0x04             // clear XMIT FIFO
178
179 //-----------------------------------------------------------------------------
180
181
182 //#define x_debug_uart_log_buf
183 #ifdef x_debug_uart_log_buf
184 #define x_DIAG_BUFSIZE 2048
185 static char __x_log_buf[x_DIAG_BUFSIZE];
186 static int x_diag_bp = 0;
187 #endif
188
189
190 //=============================================================================
191 // Compatibility with older stubs
192 //=============================================================================
193
194 #ifndef CYGSEM_HAL_VIRTUAL_VECTOR_DIAG
195
196 #include <cyg/hal/hal_stub.h>           // cyg_hal_gdb_interrupt
197
198
199 #ifdef __BASE
200
201 #ifdef CYGSEM_HAL_ROM_MONITOR
202 #define CYG_HAL_STARTUP_ROM
203 #define CYG_HAL_STARTUP_ROMRAM
204 #undef CYGDBG_HAL_DEBUG_GDB_INCLUDE_STUBS
205 #endif
206
207 #if (defined(CYG_HAL_STARTUP_ROM) || defined(CYG_HAL_STARTUP_ROMRAM)) && !defined(CYGDBG_HAL_DEBUG_GDB_INCLUDE_STUBS)
208 #define HAL_DIAG_USES_HARDWARE
209 #elif !defined(CYGDBG_HAL_DIAG_TO_DEBUG_CHAN)
210 #define HAL_DIAG_USES_HARDWARE
211 #elif CYGNUM_HAL_VIRTUAL_VECTOR_CONSOLE_CHANNEL != CYGNUM_HAL_VIRTUAL_VECTOR_DEBUG_CHANNEL
212 #define HAL_DIAG_USES_HARDWARE
213 #endif
214
215 static channel_data_t channel = {
216     (uart_width*) _BASE, 0, 0
217 };
218
219 #ifdef HAL_DIAG_USES_HARDWARE
220
221 void hal_diag_init(void)
222 {
223     static int init = 0;
224     char *msg = "\n\rARM eCos\n\r";
225     uart_width lcr;
226
227     if (init++) return;
228
229     init_duart_channel(&channel);
230
231     while (*msg) hal_diag_write_char(*msg++);
232 }
233
234 #ifdef DEBUG_DIAG
235 #if defined(CYGDBG_HAL_DEBUG_GDB_INCLUDE_STUBS)
236 #define DIAG_BUFSIZE 32
237 #else
238 #define DIAG_BUFSIZE 2048
239 #endif
240 static char diag_buffer[DIAG_BUFSIZE];
241 static int diag_bp = 0;
242 #endif
243
244 void hal_diag_write_char(char c)
245 {
246     uart_width lsr;
247
248     hal_diag_init();
249
250     cyg_hal_plf_duart_putc(&channel, c)
251
252 #ifdef DEBUG_DIAG
253     diag_buffer[diag_bp++] = c;
254     if (diag_bp == DIAG_BUFSIZE) {
255         while (1) ;
256         diag_bp = 0;
257     }
258 #endif
259 }
260
261 void hal_diag_read_char(char *c)
262 {
263     *c = cyg_hal_plf_duart_getc(&channel);
264 }
265
266 #else // HAL_DIAG relies on GDB
267
268 // Initialize diag port - assume GDB channel is already set up
269 void hal_diag_init(void)
270 {
271     if (0) init_duart_channel(&channel); // avoid warning
272 }
273
274 // Actually send character down the wire
275 static void hal_diag_write_char_serial(char c)
276 {
277     cyg_hal_plf_duart_putc(&channel, c);
278 }
279
280 static bool hal_diag_read_serial(char *c)
281 {
282     long timeout = 1000000000;  // A long time...
283
284     while (!cyg_hal_plf_duart_getc_nonblock(&channel, c))
285         if (0 == --timeout) return false;
286
287     return true;
288 }
289
290 void hal_diag_read_char(char *c)
291 {
292     while (!hal_diag_read_serial(c)) ;
293 }
294
295 void hal_diag_write_char(char c)
296 {
297     static char line[100];
298     static int pos = 0;
299
300     // No need to send CRs
301     if (c == '\r') return;
302
303     line[pos++] = c;
304
305     if (c == '\n' || pos == sizeof(line)) {
306         CYG_INTERRUPT_STATE old;
307
308         // Disable interrupts. This prevents GDB trying to interrupt us
309         // while we are in the middle of sending a packet. The serial
310         // receive interrupt will be seen when we re-enable interrupts
311         // later.
312
313 #ifdef CYGDBG_HAL_DEBUG_GDB_INCLUDE_STUBS
314         CYG_HAL_GDB_ENTER_CRITICAL_IO_REGION(old);
315 #else
316         HAL_DISABLE_INTERRUPTS(old);
317 #endif
318
319         while (1) {
320             static char hex[] = "0123456789ABCDEF";
321             cyg_uint8 csum = 0;
322             int i;
323             char c1;
324
325             hal_diag_write_char_serial('$');
326             hal_diag_write_char_serial('O');
327             csum += 'O';
328             for (i = 0; i < pos; i++) {
329                 char ch = line[i];
330                 char h = hex[(ch>>4)&0xF];
331                 char l = hex[ch&0xF];
332                 hal_diag_write_char_serial(h);
333                 hal_diag_write_char_serial(l);
334                 csum += h;
335                 csum += l;
336             }
337             hal_diag_write_char_serial('#');
338             hal_diag_write_char_serial(hex[(csum>>4)&0xF]);
339             hal_diag_write_char_serial(hex[csum&0xF]);
340
341             // Wait for the ACK character '+' from GDB here and handle
342             // receiving a ^C instead.  This is the reason for this clause
343             // being a loop.
344             if (!hal_diag_read_serial(&c1))
345                 continue;   // No response - try sending packet again
346
347             if ( c1 == '+' )
348                 break;          // a good acknowledge
349
350 #ifdef CYGDBG_HAL_DEBUG_GDB_BREAK_SUPPORT
351             cyg_drv_interrupt_acknowledge(CYG_DEV_SERIAL_INT);
352             if ( c1 == 3 ) {
353                 // Ctrl-C: breakpoint.
354                 cyg_hal_gdb_interrupt (__builtin_return_address(0));
355                 break;
356             }
357 #endif
358             // otherwise, loop round again
359         }
360
361         pos = 0;
362
363         // And re-enable interrupts
364 #ifdef CYGDBG_HAL_DEBUG_GDB_INCLUDE_STUBS
365         CYG_HAL_GDB_LEAVE_CRITICAL_IO_REGION(old);
366 #else
367         HAL_RESTORE_INTERRUPTS(old);
368 #endif
369
370     }
371 }
372 #endif
373
374 #endif // __BASE
375
376 #endif // CYGSEM_HAL_VIRTUAL_VECTOR_DIAG
377
378 /*---------------------------------------------------------------------------*/