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