Improve U-Boot Porting Guide in the README
[platform/kernel/u-boot.git] / drivers / serial / serial.c
1 /*
2  * (C) Copyright 2000
3  * Rob Taylor, Flying Pig Systems. robt@flyingpig.com.
4  *
5  * See file CREDITS for list of people who contributed to this
6  * project.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of
11  * the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23
24 #include <common.h>
25
26 #include <ns16550.h>
27 #ifdef CONFIG_NS87308
28 #include <ns87308.h>
29 #endif
30 #ifdef CONFIG_KIRKWOOD
31 #include <asm/arch/kirkwood.h>
32 #endif
33
34 #if defined (CONFIG_SERIAL_MULTI)
35 #include <serial.h>
36 #endif
37
38 DECLARE_GLOBAL_DATA_PTR;
39
40 #if !defined(CONFIG_CONS_INDEX)
41 #if defined (CONFIG_SERIAL_MULTI)
42 /*   with CONFIG_SERIAL_MULTI we might have no console
43  *  on these devices
44  */
45 #else
46 #error  "No console index specified."
47 #endif /* CONFIG_SERIAL_MULTI */
48 #elif (CONFIG_CONS_INDEX < 1) || (CONFIG_CONS_INDEX > 4)
49 #error  "Invalid console index value."
50 #endif
51
52 #if CONFIG_CONS_INDEX == 1 && !defined(CONFIG_SYS_NS16550_COM1)
53 #error  "Console port 1 defined but not configured."
54 #elif CONFIG_CONS_INDEX == 2 && !defined(CONFIG_SYS_NS16550_COM2)
55 #error  "Console port 2 defined but not configured."
56 #elif CONFIG_CONS_INDEX == 3 && !defined(CONFIG_SYS_NS16550_COM3)
57 #error  "Console port 3 defined but not configured."
58 #elif CONFIG_CONS_INDEX == 4 && !defined(CONFIG_SYS_NS16550_COM4)
59 #error  "Console port 4 defined but not configured."
60 #endif
61
62 /* Note: The port number specified in the functions is 1 based.
63  *       the array is 0 based.
64  */
65 static NS16550_t serial_ports[4] = {
66 #ifdef CONFIG_SYS_NS16550_COM1
67         (NS16550_t)CONFIG_SYS_NS16550_COM1,
68 #else
69         NULL,
70 #endif
71 #ifdef CONFIG_SYS_NS16550_COM2
72         (NS16550_t)CONFIG_SYS_NS16550_COM2,
73 #else
74         NULL,
75 #endif
76 #ifdef CONFIG_SYS_NS16550_COM3
77         (NS16550_t)CONFIG_SYS_NS16550_COM3,
78 #else
79         NULL,
80 #endif
81 #ifdef CONFIG_SYS_NS16550_COM4
82         (NS16550_t)CONFIG_SYS_NS16550_COM4
83 #else
84         NULL
85 #endif
86 };
87
88 #define PORT    serial_ports[port-1]
89 #if defined(CONFIG_CONS_INDEX)
90 #define CONSOLE (serial_ports[CONFIG_CONS_INDEX-1])
91 #endif
92
93 #if defined(CONFIG_SERIAL_MULTI)
94
95 /* Multi serial device functions */
96 #define DECLARE_ESERIAL_FUNCTIONS(port) \
97     int  eserial##port##_init (void) {\
98         int clock_divisor; \
99         clock_divisor = calc_divisor(serial_ports[port-1]); \
100         NS16550_init(serial_ports[port-1], clock_divisor); \
101         return(0);}\
102     void eserial##port##_setbrg (void) {\
103         serial_setbrg_dev(port);}\
104     int  eserial##port##_getc (void) {\
105         return serial_getc_dev(port);}\
106     int  eserial##port##_tstc (void) {\
107         return serial_tstc_dev(port);}\
108     void eserial##port##_putc (const char c) {\
109         serial_putc_dev(port, c);}\
110     void eserial##port##_puts (const char *s) {\
111         serial_puts_dev(port, s);}
112
113 /* Serial device descriptor */
114 #define INIT_ESERIAL_STRUCTURE(port,name,bus) {\
115         name,\
116         bus,\
117         eserial##port##_init,\
118         eserial##port##_setbrg,\
119         eserial##port##_getc,\
120         eserial##port##_tstc,\
121         eserial##port##_putc,\
122         eserial##port##_puts, }
123
124 #endif /* CONFIG_SERIAL_MULTI */
125
126 static int calc_divisor (NS16550_t port)
127 {
128 #ifdef CONFIG_OMAP1510
129         /* If can't cleanly clock 115200 set div to 1 */
130         if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
131                 port->osc_12m_sel = OSC_12M_SEL;        /* enable 6.5 * divisor */
132                 return (1);                             /* return 1 for base divisor */
133         }
134         port->osc_12m_sel = 0;                  /* clear if previsouly set */
135 #endif
136 #ifdef CONFIG_OMAP1610
137         /* If can't cleanly clock 115200 set div to 1 */
138         if ((CONFIG_SYS_NS16550_CLK == 48000000) && (gd->baudrate == 115200)) {
139                 return (26);            /* return 26 for base divisor */
140         }
141 #endif
142
143 #ifdef CONFIG_APTIX
144 #define MODE_X_DIV 13
145 #else
146 #define MODE_X_DIV 16
147 #endif
148
149         /* Compute divisor value. Normally, we should simply return:
150          *   CONFIG_SYS_NS16550_CLK) / MODE_X_DIV / gd->baudrate
151          * but we need to round that value by adding 0.5.
152          * Rounding is especially important at high baud rates.
153          */
154         return (CONFIG_SYS_NS16550_CLK + (gd->baudrate * (MODE_X_DIV / 2))) /
155                 (MODE_X_DIV * gd->baudrate);
156 }
157
158 #if !defined(CONFIG_SERIAL_MULTI)
159 int serial_init (void)
160 {
161         int clock_divisor;
162
163 #ifdef CONFIG_NS87308
164         initialise_ns87308();
165 #endif
166
167 #ifdef CONFIG_SYS_NS16550_COM1
168         clock_divisor = calc_divisor(serial_ports[0]);
169         NS16550_init(serial_ports[0], clock_divisor);
170 #endif
171 #ifdef CONFIG_SYS_NS16550_COM2
172         clock_divisor = calc_divisor(serial_ports[1]);
173         NS16550_init(serial_ports[1], clock_divisor);
174 #endif
175 #ifdef CONFIG_SYS_NS16550_COM3
176         clock_divisor = calc_divisor(serial_ports[2]);
177         NS16550_init(serial_ports[2], clock_divisor);
178 #endif
179 #ifdef CONFIG_SYS_NS16550_COM4
180         clock_divisor = calc_divisor(serial_ports[3]);
181         NS16550_init(serial_ports[3], clock_divisor);
182 #endif
183
184         return (0);
185 }
186 #endif
187
188 void
189 _serial_putc(const char c,const int port)
190 {
191         if (c == '\n')
192                 NS16550_putc(PORT, '\r');
193
194         NS16550_putc(PORT, c);
195 }
196
197 void
198 _serial_putc_raw(const char c,const int port)
199 {
200         NS16550_putc(PORT, c);
201 }
202
203 void
204 _serial_puts (const char *s,const int port)
205 {
206         while (*s) {
207                 _serial_putc (*s++,port);
208         }
209 }
210
211
212 int
213 _serial_getc(const int port)
214 {
215         return NS16550_getc(PORT);
216 }
217
218 int
219 _serial_tstc(const int port)
220 {
221         return NS16550_tstc(PORT);
222 }
223
224 void
225 _serial_setbrg (const int port)
226 {
227         int clock_divisor;
228
229         clock_divisor = calc_divisor(PORT);
230         NS16550_reinit(PORT, clock_divisor);
231 }
232
233 #if defined(CONFIG_SERIAL_MULTI)
234 static inline void
235 serial_putc_dev(unsigned int dev_index,const char c)
236 {
237         _serial_putc(c,dev_index);
238 }
239 #else
240 void
241 serial_putc(const char c)
242 {
243         _serial_putc(c,CONFIG_CONS_INDEX);
244 }
245 #endif
246
247 #if defined(CONFIG_SERIAL_MULTI)
248 static inline void
249 serial_putc_raw_dev(unsigned int dev_index,const char c)
250 {
251         _serial_putc_raw(c,dev_index);
252 }
253 #else
254 void
255 serial_putc_raw(const char c)
256 {
257         _serial_putc_raw(c,CONFIG_CONS_INDEX);
258 }
259 #endif
260
261 #if defined(CONFIG_SERIAL_MULTI)
262 static inline void
263 serial_puts_dev(unsigned int dev_index,const char *s)
264 {
265         _serial_puts(s,dev_index);
266 }
267 #else
268 void
269 serial_puts(const char *s)
270 {
271         _serial_puts(s,CONFIG_CONS_INDEX);
272 }
273 #endif
274
275 #if defined(CONFIG_SERIAL_MULTI)
276 static inline int
277 serial_getc_dev(unsigned int dev_index)
278 {
279         return _serial_getc(dev_index);
280 }
281 #else
282 int
283 serial_getc(void)
284 {
285         return _serial_getc(CONFIG_CONS_INDEX);
286 }
287 #endif
288
289 #if defined(CONFIG_SERIAL_MULTI)
290 static inline int
291 serial_tstc_dev(unsigned int dev_index)
292 {
293         return _serial_tstc(dev_index);
294 }
295 #else
296 int
297 serial_tstc(void)
298 {
299         return _serial_tstc(CONFIG_CONS_INDEX);
300 }
301 #endif
302
303 #if defined(CONFIG_SERIAL_MULTI)
304 static inline void
305 serial_setbrg_dev(unsigned int dev_index)
306 {
307         _serial_setbrg(dev_index);
308 }
309 #else
310 void
311 serial_setbrg(void)
312 {
313         _serial_setbrg(CONFIG_CONS_INDEX);
314 }
315 #endif
316
317 #if defined(CONFIG_SERIAL_MULTI)
318
319 DECLARE_ESERIAL_FUNCTIONS(1);
320 struct serial_device eserial1_device =
321         INIT_ESERIAL_STRUCTURE(1,"eserial0","EUART1");
322 DECLARE_ESERIAL_FUNCTIONS(2);
323 struct serial_device eserial2_device =
324         INIT_ESERIAL_STRUCTURE(2,"eserial1","EUART2");
325 DECLARE_ESERIAL_FUNCTIONS(3);
326 struct serial_device eserial3_device =
327         INIT_ESERIAL_STRUCTURE(3,"eserial2","EUART3");
328 DECLARE_ESERIAL_FUNCTIONS(4);
329 struct serial_device eserial4_device =
330         INIT_ESERIAL_STRUCTURE(4,"eserial3","EUART4");
331 #endif /* CONFIG_SERIAL_MULTI */