xref: /openbmc/u-boot/drivers/serial/serial.c (revision 15855700)
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 	NULL,\
119 	eserial##port##_setbrg,\
120 	eserial##port##_getc,\
121 	eserial##port##_tstc,\
122 	eserial##port##_putc,\
123 	eserial##port##_puts, }
124 
125 #endif /* CONFIG_SERIAL_MULTI */
126 
127 static int calc_divisor (NS16550_t port)
128 {
129 #ifdef CONFIG_OMAP1510
130 	/* If can't cleanly clock 115200 set div to 1 */
131 	if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
132 		port->osc_12m_sel = OSC_12M_SEL;	/* enable 6.5 * divisor */
133 		return (1);				/* return 1 for base divisor */
134 	}
135 	port->osc_12m_sel = 0;			/* clear if previsouly set */
136 #endif
137 #ifdef CONFIG_OMAP1610
138 	/* If can't cleanly clock 115200 set div to 1 */
139 	if ((CONFIG_SYS_NS16550_CLK == 48000000) && (gd->baudrate == 115200)) {
140 		return (26);		/* return 26 for base divisor */
141 	}
142 #endif
143 
144 #ifdef CONFIG_APTIX
145 #define MODE_X_DIV 13
146 #else
147 #define MODE_X_DIV 16
148 #endif
149 
150 	/* Compute divisor value. Normally, we should simply return:
151 	 *   CONFIG_SYS_NS16550_CLK) / MODE_X_DIV / gd->baudrate
152 	 * but we need to round that value by adding 0.5.
153 	 * Rounding is especially important at high baud rates.
154 	 */
155 	return (CONFIG_SYS_NS16550_CLK + (gd->baudrate * (MODE_X_DIV / 2))) /
156 		(MODE_X_DIV * gd->baudrate);
157 }
158 
159 #if !defined(CONFIG_SERIAL_MULTI)
160 int serial_init (void)
161 {
162 	int clock_divisor;
163 
164 #ifdef CONFIG_NS87308
165 	initialise_ns87308();
166 #endif
167 
168 #ifdef CONFIG_SYS_NS16550_COM1
169 	clock_divisor = calc_divisor(serial_ports[0]);
170 	NS16550_init(serial_ports[0], clock_divisor);
171 #endif
172 #ifdef CONFIG_SYS_NS16550_COM2
173 	clock_divisor = calc_divisor(serial_ports[1]);
174 	NS16550_init(serial_ports[1], clock_divisor);
175 #endif
176 #ifdef CONFIG_SYS_NS16550_COM3
177 	clock_divisor = calc_divisor(serial_ports[2]);
178 	NS16550_init(serial_ports[2], clock_divisor);
179 #endif
180 #ifdef CONFIG_SYS_NS16550_COM4
181 	clock_divisor = calc_divisor(serial_ports[3]);
182 	NS16550_init(serial_ports[3], clock_divisor);
183 #endif
184 
185 	return (0);
186 }
187 #endif
188 
189 void
190 _serial_putc(const char c,const int port)
191 {
192 	if (c == '\n')
193 		NS16550_putc(PORT, '\r');
194 
195 	NS16550_putc(PORT, c);
196 }
197 
198 void
199 _serial_putc_raw(const char c,const int port)
200 {
201 	NS16550_putc(PORT, c);
202 }
203 
204 void
205 _serial_puts (const char *s,const int port)
206 {
207 	while (*s) {
208 		_serial_putc (*s++,port);
209 	}
210 }
211 
212 
213 int
214 _serial_getc(const int port)
215 {
216 	return NS16550_getc(PORT);
217 }
218 
219 int
220 _serial_tstc(const int port)
221 {
222 	return NS16550_tstc(PORT);
223 }
224 
225 void
226 _serial_setbrg (const int port)
227 {
228 	int clock_divisor;
229 
230 	clock_divisor = calc_divisor(PORT);
231 	NS16550_reinit(PORT, clock_divisor);
232 }
233 
234 #if defined(CONFIG_SERIAL_MULTI)
235 static inline void
236 serial_putc_dev(unsigned int dev_index,const char c)
237 {
238 	_serial_putc(c,dev_index);
239 }
240 #else
241 void
242 serial_putc(const char c)
243 {
244 	_serial_putc(c,CONFIG_CONS_INDEX);
245 }
246 #endif
247 
248 #if defined(CONFIG_SERIAL_MULTI)
249 static inline void
250 serial_putc_raw_dev(unsigned int dev_index,const char c)
251 {
252 	_serial_putc_raw(c,dev_index);
253 }
254 #else
255 void
256 serial_putc_raw(const char c)
257 {
258 	_serial_putc_raw(c,CONFIG_CONS_INDEX);
259 }
260 #endif
261 
262 #if defined(CONFIG_SERIAL_MULTI)
263 static inline void
264 serial_puts_dev(unsigned int dev_index,const char *s)
265 {
266 	_serial_puts(s,dev_index);
267 }
268 #else
269 void
270 serial_puts(const char *s)
271 {
272 	_serial_puts(s,CONFIG_CONS_INDEX);
273 }
274 #endif
275 
276 #if defined(CONFIG_SERIAL_MULTI)
277 static inline int
278 serial_getc_dev(unsigned int dev_index)
279 {
280 	return _serial_getc(dev_index);
281 }
282 #else
283 int
284 serial_getc(void)
285 {
286 	return _serial_getc(CONFIG_CONS_INDEX);
287 }
288 #endif
289 
290 #if defined(CONFIG_SERIAL_MULTI)
291 static inline int
292 serial_tstc_dev(unsigned int dev_index)
293 {
294 	return _serial_tstc(dev_index);
295 }
296 #else
297 int
298 serial_tstc(void)
299 {
300 	return _serial_tstc(CONFIG_CONS_INDEX);
301 }
302 #endif
303 
304 #if defined(CONFIG_SERIAL_MULTI)
305 static inline void
306 serial_setbrg_dev(unsigned int dev_index)
307 {
308 	_serial_setbrg(dev_index);
309 }
310 #else
311 void
312 serial_setbrg(void)
313 {
314 	_serial_setbrg(CONFIG_CONS_INDEX);
315 }
316 #endif
317 
318 #if defined(CONFIG_SERIAL_MULTI)
319 
320 DECLARE_ESERIAL_FUNCTIONS(1);
321 struct serial_device eserial1_device =
322 	INIT_ESERIAL_STRUCTURE(1,"eserial0","EUART1");
323 DECLARE_ESERIAL_FUNCTIONS(2);
324 struct serial_device eserial2_device =
325 	INIT_ESERIAL_STRUCTURE(2,"eserial1","EUART2");
326 DECLARE_ESERIAL_FUNCTIONS(3);
327 struct serial_device eserial3_device =
328 	INIT_ESERIAL_STRUCTURE(3,"eserial2","EUART3");
329 DECLARE_ESERIAL_FUNCTIONS(4);
330 struct serial_device eserial4_device =
331 	INIT_ESERIAL_STRUCTURE(4,"eserial3","EUART4");
332 #endif /* CONFIG_SERIAL_MULTI */
333