Applied a modified version of holger's regparm patches.
[people/adir/gpxe.git] / src / core / serial.c
1 /*
2  * The serial port interface routines implement a simple polled i/o
3  * interface to a standard serial port.  Due to the space restrictions
4  * for the boot blocks, no BIOS support is used (since BIOS requires
5  * expensive real/protected mode switches), instead the rudimentary
6  * BIOS support is duplicated here.
7  *
8  * The base address and speed for the i/o port are passed from the
9  * Makefile in the COMCONSOLE and CONSPEED preprocessor macros.  The
10  * line control parameters are currently hard-coded to 8 bits, no
11  * parity, 1 stop bit (8N1).  This can be changed in init_serial().
12  */
13
14 #include "stddef.h"
15 #include "console.h"
16 #include <gpxe/init.h>
17 #include "io.h"
18 #include "timer.h"
19 #include "config/serial.h"
20
21 /* Set default values if none specified */
22
23 #ifndef COMCONSOLE
24 #define COMCONSOLE      0x3f8
25 #endif
26
27 #ifndef COMSPEED
28 #define COMSPEED        9600
29 #endif
30
31 #ifndef COMDATA
32 #define COMDATA         8
33 #endif
34
35 #ifndef COMPARITY
36 #define COMPARITY       0
37 #endif
38
39 #ifndef COMSTOP
40 #define COMSTOP         1
41 #endif
42
43 #undef UART_BASE
44 #define UART_BASE ( COMCONSOLE )
45
46 #undef UART_BAUD
47 #define UART_BAUD ( COMSPEED )
48
49 #if ((115200%UART_BAUD) != 0)
50 #error Bad ttys0 baud rate
51 #endif
52
53 #define COMBRD (115200/UART_BAUD)
54
55 /* Line Control Settings */
56 #define UART_LCS ( ( ( (COMDATA) - 5 )  << 0 ) | \
57                    ( ( (COMPARITY) )    << 3 ) | \
58                    ( ( (COMSTOP) - 1 )  << 2 ) )
59
60 /* Data */
61 #define UART_RBR 0x00
62 #define UART_TBR 0x00
63
64 /* Control */
65 #define UART_IER 0x01
66 #define UART_IIR 0x02
67 #define UART_FCR 0x02
68 #define UART_LCR 0x03
69 #define UART_MCR 0x04
70 #define UART_DLL 0x00
71 #define UART_DLM 0x01
72
73 /* Status */
74 #define UART_LSR 0x05
75 #define  UART_LSR_TEMPT 0x40    /* Transmitter empty */
76 #define  UART_LSR_THRE  0x20    /* Transmit-hold-register empty */
77 #define  UART_LSR_BI    0x10    /* Break interrupt indicator */
78 #define  UART_LSR_FE    0x08    /* Frame error indicator */
79 #define  UART_LSR_PE    0x04    /* Parity error indicator */
80 #define  UART_LSR_OE    0x02    /* Overrun error indicator */
81 #define  UART_LSR_DR    0x01    /* Receiver data ready */
82
83 #define UART_MSR 0x06
84 #define UART_SCR 0x07
85
86 #if defined(UART_MEM)
87 #define uart_readb(addr) readb((addr))
88 #define uart_writeb(val,addr) writeb((val),(addr))
89 #else
90 #define uart_readb(addr) inb((addr))
91 #define uart_writeb(val,addr) outb((val),(addr))
92 #endif
93
94 struct console_driver serial_console __console_driver;
95
96 /*
97  * void serial_putc(int ch);
98  *      Write character `ch' to port UART_BASE.
99  */
100 static void serial_putc ( int ch ) {
101         int i;
102         int status;
103         i = 1000; /* timeout */
104         while(--i > 0) {
105                 status = uart_readb(UART_BASE + UART_LSR);
106                 if (status & UART_LSR_THRE) { 
107                         /* TX buffer emtpy */
108                         uart_writeb(ch, UART_BASE + UART_TBR);
109                         break;
110                 }
111                 mdelay(2);
112         }
113 }
114
115 /*
116  * int serial_getc(void);
117  *      Read a character from port UART_BASE.
118  */
119 static int serial_getc ( void ) {
120         int status;
121         int ch;
122         do {
123                 status = uart_readb(UART_BASE + UART_LSR);
124         } while((status & 1) == 0);
125         ch = uart_readb(UART_BASE + UART_RBR);  /* fetch (first) character */
126         ch &= 0x7f;                             /* remove any parity bits we get */
127         if (ch == 0x7f) {                       /* Make DEL... look like BS */
128                 ch = 0x08;
129         }
130         return ch;
131 }
132
133 /*
134  * int serial_ischar(void);
135  *       If there is a character in the input buffer of port UART_BASE,
136  *       return nonzero; otherwise return 0.
137  */
138 static int serial_ischar ( void ) {
139         int status;
140         status = uart_readb(UART_BASE + UART_LSR);      /* line status reg; */
141         return status & 1;              /* rx char available */
142 }
143
144 /*
145  * int serial_init(void);
146  *      Initialize port UART_BASE to speed COMSPEED, line settings 8N1.
147  */
148 static void serial_init ( void ) {
149         int status;
150         int divisor, lcs;
151
152         DBG ( "Serial port %#x initialising\n", UART_BASE );
153
154         divisor = COMBRD;
155         lcs = UART_LCS;
156
157
158 #ifdef COMPRESERVE
159         lcs = uart_readb(UART_BASE + UART_LCR) & 0x7f;
160         uart_writeb(0x80 | lcs, UART_BASE + UART_LCR);
161         divisor = (uart_readb(UART_BASE + UART_DLM) << 8) | uart_readb(UART_BASE + UART_DLL);
162         uart_writeb(lcs, UART_BASE + UART_LCR);
163 #endif
164
165         /* Set Baud Rate Divisor to COMSPEED, and test to see if the
166          * serial port appears to be present.
167          */
168         uart_writeb(0x80 | lcs, UART_BASE + UART_LCR);
169         uart_writeb(0xaa, UART_BASE + UART_DLL);
170         if (uart_readb(UART_BASE + UART_DLL) != 0xaa) {
171                 DBG ( "Serial port %#x UART_DLL failed\n", UART_BASE );
172                 goto out;
173         }
174         uart_writeb(0x55, UART_BASE + UART_DLL);
175         if (uart_readb(UART_BASE + UART_DLL) != 0x55) {
176                 DBG ( "Serial port %#x UART_DLL failed\n", UART_BASE );
177                 goto out;
178         }
179         uart_writeb(divisor & 0xff, UART_BASE + UART_DLL);
180         if (uart_readb(UART_BASE + UART_DLL) != (divisor & 0xff)) {
181                 DBG ( "Serial port %#x UART_DLL failed\n", UART_BASE );
182                 goto out;
183         }
184         uart_writeb(0xaa, UART_BASE + UART_DLM);
185         if (uart_readb(UART_BASE + UART_DLM) != 0xaa) {
186                 DBG ( "Serial port %#x UART_DLM failed\n", UART_BASE );
187                 goto out;
188         }
189         uart_writeb(0x55, UART_BASE + UART_DLM);
190         if (uart_readb(UART_BASE + UART_DLM) != 0x55) {
191                 DBG ( "Serial port %#x UART_DLM failed\n", UART_BASE );
192                 goto out;
193         }
194         uart_writeb((divisor >> 8) & 0xff, UART_BASE + UART_DLM);
195         if (uart_readb(UART_BASE + UART_DLM) != ((divisor >> 8) & 0xff)) {
196                 DBG ( "Serial port %#x UART_DLM failed\n", UART_BASE );
197                 goto out;
198         }
199         uart_writeb(lcs, UART_BASE + UART_LCR);
200         
201         /* disable interrupts */
202         uart_writeb(0x0, UART_BASE + UART_IER);
203
204         /* disable fifo's */
205         uart_writeb(0x00, UART_BASE + UART_FCR);
206
207         /* Set clear to send, so flow control works... */
208         uart_writeb((1<<1), UART_BASE + UART_MCR);
209
210
211         /* Flush the input buffer. */
212         do {
213                 /* rx buffer reg
214                  * throw away (unconditionally the first time)
215                  */
216                 (void) uart_readb(UART_BASE + UART_RBR);
217                 /* line status reg */
218                 status = uart_readb(UART_BASE + UART_LSR);
219         } while(status & UART_LSR_DR);
220         serial_console.disabled = 0;
221  out:
222         return;
223 }
224
225 /*
226  * void serial_fini(void);
227  *      Cleanup our use of the serial port, in particular flush the
228  *      output buffer so we don't accidentially lose characters.
229  */
230 static void serial_fini ( void ) {
231         int i, status;
232         if (serial_console.disabled) {
233                 /* no serial interface */
234                 return;
235         }
236         /* Flush the output buffer to avoid dropping characters,
237          * if we are reinitializing the serial port.
238          */
239         i = 10000; /* timeout */
240         do {
241                 status = uart_readb(UART_BASE + UART_LSR);
242         } while((--i > 0) && !(status & UART_LSR_TEMPT));
243         /* Don't mark it as disabled; it's still usable */
244 }
245
246 struct console_driver serial_console __console_driver = {
247         .putchar = serial_putc,
248         .getchar = serial_getc,
249         .iskey = serial_ischar,
250         .disabled = 1,
251 };
252
253 /** Serial console startup function */
254 struct startup_fn serial_startup_fn __startup_fn ( STARTUP_NORMAL ) = {
255         .startup = serial_init,
256         .shutdown = serial_fini,
257 };
258
259 /**
260  * Serial console initialisation function
261  *
262  * Initialise console early on so that it is available to capture
263  * early debug messages.  It is safe to call serial_init() multiple
264  * times.
265  */
266 struct init_fn serial_init_fn __init_fn ( INIT_EARLY ) = {
267         .initialise = serial_init,
268 };