xref: /openbmc/u-boot/drivers/serial/serial.c (revision fc0db132)
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 #ifdef CONFIG_ORION5X
34 #include <asm/arch/orion5x.h>
35 #endif
36 
37 #if defined (CONFIG_SERIAL_MULTI)
38 #include <serial.h>
39 #endif
40 
41 DECLARE_GLOBAL_DATA_PTR;
42 
43 #if !defined(CONFIG_CONS_INDEX)
44 #if defined (CONFIG_SERIAL_MULTI)
45 /*   with CONFIG_SERIAL_MULTI we might have no console
46  *  on these devices
47  */
48 #else
49 #error	"No console index specified."
50 #endif /* CONFIG_SERIAL_MULTI */
51 #elif (CONFIG_CONS_INDEX < 1) || (CONFIG_CONS_INDEX > 4)
52 #error	"Invalid console index value."
53 #endif
54 
55 #if CONFIG_CONS_INDEX == 1 && !defined(CONFIG_SYS_NS16550_COM1)
56 #error	"Console port 1 defined but not configured."
57 #elif CONFIG_CONS_INDEX == 2 && !defined(CONFIG_SYS_NS16550_COM2)
58 #error	"Console port 2 defined but not configured."
59 #elif CONFIG_CONS_INDEX == 3 && !defined(CONFIG_SYS_NS16550_COM3)
60 #error	"Console port 3 defined but not configured."
61 #elif CONFIG_CONS_INDEX == 4 && !defined(CONFIG_SYS_NS16550_COM4)
62 #error	"Console port 4 defined but not configured."
63 #endif
64 
65 /* Note: The port number specified in the functions is 1 based.
66  *	 the array is 0 based.
67  */
68 static NS16550_t serial_ports[4] = {
69 #ifdef CONFIG_SYS_NS16550_COM1
70 	(NS16550_t)CONFIG_SYS_NS16550_COM1,
71 #else
72 	NULL,
73 #endif
74 #ifdef CONFIG_SYS_NS16550_COM2
75 	(NS16550_t)CONFIG_SYS_NS16550_COM2,
76 #else
77 	NULL,
78 #endif
79 #ifdef CONFIG_SYS_NS16550_COM3
80 	(NS16550_t)CONFIG_SYS_NS16550_COM3,
81 #else
82 	NULL,
83 #endif
84 #ifdef CONFIG_SYS_NS16550_COM4
85 	(NS16550_t)CONFIG_SYS_NS16550_COM4
86 #else
87 	NULL
88 #endif
89 };
90 
91 #define PORT	serial_ports[port-1]
92 #if defined(CONFIG_CONS_INDEX)
93 #define CONSOLE	(serial_ports[CONFIG_CONS_INDEX-1])
94 #endif
95 
96 #if defined(CONFIG_SERIAL_MULTI)
97 
98 /* Multi serial device functions */
99 #define DECLARE_ESERIAL_FUNCTIONS(port) \
100     int  eserial##port##_init (void) {\
101 	int clock_divisor; \
102 	clock_divisor = calc_divisor(serial_ports[port-1]); \
103 	NS16550_init(serial_ports[port-1], clock_divisor); \
104 	return(0);}\
105     void eserial##port##_setbrg (void) {\
106 	serial_setbrg_dev(port);}\
107     int  eserial##port##_getc (void) {\
108 	return serial_getc_dev(port);}\
109     int  eserial##port##_tstc (void) {\
110 	return serial_tstc_dev(port);}\
111     void eserial##port##_putc (const char c) {\
112 	serial_putc_dev(port, c);}\
113     void eserial##port##_puts (const char *s) {\
114 	serial_puts_dev(port, s);}
115 
116 /* Serial device descriptor */
117 #define INIT_ESERIAL_STRUCTURE(port,name,bus) {\
118 	name,\
119 	bus,\
120 	eserial##port##_init,\
121 	NULL,\
122 	eserial##port##_setbrg,\
123 	eserial##port##_getc,\
124 	eserial##port##_tstc,\
125 	eserial##port##_putc,\
126 	eserial##port##_puts, }
127 
128 #endif /* CONFIG_SERIAL_MULTI */
129 
130 static int calc_divisor (NS16550_t port)
131 {
132 #ifdef CONFIG_OMAP1510
133 	/* If can't cleanly clock 115200 set div to 1 */
134 	if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
135 		port->osc_12m_sel = OSC_12M_SEL;	/* enable 6.5 * divisor */
136 		return (1);				/* return 1 for base divisor */
137 	}
138 	port->osc_12m_sel = 0;			/* clear if previsouly set */
139 #endif
140 #ifdef CONFIG_OMAP1610
141 	/* If can't cleanly clock 115200 set div to 1 */
142 	if ((CONFIG_SYS_NS16550_CLK == 48000000) && (gd->baudrate == 115200)) {
143 		return (26);		/* return 26 for base divisor */
144 	}
145 #endif
146 
147 #ifdef CONFIG_APTIX
148 #define MODE_X_DIV 13
149 #else
150 #define MODE_X_DIV 16
151 #endif
152 
153 	/* Compute divisor value. Normally, we should simply return:
154 	 *   CONFIG_SYS_NS16550_CLK) / MODE_X_DIV / gd->baudrate
155 	 * but we need to round that value by adding 0.5.
156 	 * Rounding is especially important at high baud rates.
157 	 */
158 	return (CONFIG_SYS_NS16550_CLK + (gd->baudrate * (MODE_X_DIV / 2))) /
159 		(MODE_X_DIV * gd->baudrate);
160 }
161 
162 #if !defined(CONFIG_SERIAL_MULTI)
163 int serial_init (void)
164 {
165 	int clock_divisor;
166 
167 #ifdef CONFIG_NS87308
168 	initialise_ns87308();
169 #endif
170 
171 #ifdef CONFIG_SYS_NS16550_COM1
172 	clock_divisor = calc_divisor(serial_ports[0]);
173 	NS16550_init(serial_ports[0], clock_divisor);
174 #endif
175 #ifdef CONFIG_SYS_NS16550_COM2
176 	clock_divisor = calc_divisor(serial_ports[1]);
177 	NS16550_init(serial_ports[1], clock_divisor);
178 #endif
179 #ifdef CONFIG_SYS_NS16550_COM3
180 	clock_divisor = calc_divisor(serial_ports[2]);
181 	NS16550_init(serial_ports[2], clock_divisor);
182 #endif
183 #ifdef CONFIG_SYS_NS16550_COM4
184 	clock_divisor = calc_divisor(serial_ports[3]);
185 	NS16550_init(serial_ports[3], clock_divisor);
186 #endif
187 
188 	return (0);
189 }
190 #endif
191 
192 void
193 _serial_putc(const char c,const int port)
194 {
195 	if (c == '\n')
196 		NS16550_putc(PORT, '\r');
197 
198 	NS16550_putc(PORT, c);
199 }
200 
201 void
202 _serial_putc_raw(const char c,const int port)
203 {
204 	NS16550_putc(PORT, c);
205 }
206 
207 void
208 _serial_puts (const char *s,const int port)
209 {
210 	while (*s) {
211 		_serial_putc (*s++,port);
212 	}
213 }
214 
215 
216 int
217 _serial_getc(const int port)
218 {
219 	return NS16550_getc(PORT);
220 }
221 
222 int
223 _serial_tstc(const int port)
224 {
225 	return NS16550_tstc(PORT);
226 }
227 
228 void
229 _serial_setbrg (const int port)
230 {
231 	int clock_divisor;
232 
233 	clock_divisor = calc_divisor(PORT);
234 	NS16550_reinit(PORT, clock_divisor);
235 }
236 
237 #if defined(CONFIG_SERIAL_MULTI)
238 static inline void
239 serial_putc_dev(unsigned int dev_index,const char c)
240 {
241 	_serial_putc(c,dev_index);
242 }
243 #else
244 void
245 serial_putc(const char c)
246 {
247 	_serial_putc(c,CONFIG_CONS_INDEX);
248 }
249 #endif
250 
251 #if defined(CONFIG_SERIAL_MULTI)
252 static inline void
253 serial_putc_raw_dev(unsigned int dev_index,const char c)
254 {
255 	_serial_putc_raw(c,dev_index);
256 }
257 #else
258 void
259 serial_putc_raw(const char c)
260 {
261 	_serial_putc_raw(c,CONFIG_CONS_INDEX);
262 }
263 #endif
264 
265 #if defined(CONFIG_SERIAL_MULTI)
266 static inline void
267 serial_puts_dev(unsigned int dev_index,const char *s)
268 {
269 	_serial_puts(s,dev_index);
270 }
271 #else
272 void
273 serial_puts(const char *s)
274 {
275 	_serial_puts(s,CONFIG_CONS_INDEX);
276 }
277 #endif
278 
279 #if defined(CONFIG_SERIAL_MULTI)
280 static inline int
281 serial_getc_dev(unsigned int dev_index)
282 {
283 	return _serial_getc(dev_index);
284 }
285 #else
286 int
287 serial_getc(void)
288 {
289 	return _serial_getc(CONFIG_CONS_INDEX);
290 }
291 #endif
292 
293 #if defined(CONFIG_SERIAL_MULTI)
294 static inline int
295 serial_tstc_dev(unsigned int dev_index)
296 {
297 	return _serial_tstc(dev_index);
298 }
299 #else
300 int
301 serial_tstc(void)
302 {
303 	return _serial_tstc(CONFIG_CONS_INDEX);
304 }
305 #endif
306 
307 #if defined(CONFIG_SERIAL_MULTI)
308 static inline void
309 serial_setbrg_dev(unsigned int dev_index)
310 {
311 	_serial_setbrg(dev_index);
312 }
313 #else
314 void
315 serial_setbrg(void)
316 {
317 	_serial_setbrg(CONFIG_CONS_INDEX);
318 }
319 #endif
320 
321 #if defined(CONFIG_SERIAL_MULTI)
322 
323 DECLARE_ESERIAL_FUNCTIONS(1);
324 struct serial_device eserial1_device =
325 	INIT_ESERIAL_STRUCTURE(1,"eserial0","EUART1");
326 DECLARE_ESERIAL_FUNCTIONS(2);
327 struct serial_device eserial2_device =
328 	INIT_ESERIAL_STRUCTURE(2,"eserial1","EUART2");
329 DECLARE_ESERIAL_FUNCTIONS(3);
330 struct serial_device eserial3_device =
331 	INIT_ESERIAL_STRUCTURE(3,"eserial2","EUART3");
332 DECLARE_ESERIAL_FUNCTIONS(4);
333 struct serial_device eserial4_device =
334 	INIT_ESERIAL_STRUCTURE(4,"eserial3","EUART4");
335 #endif /* CONFIG_SERIAL_MULTI */
336