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