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