xref: /openbmc/u-boot/drivers/serial/serial_ns16550.c (revision dd84058d24ff54d6b32818ffe44aeb4bba2cfae6)
1 /*
2  * (C) Copyright 2000
3  * Rob Taylor, Flying Pig Systems. robt@flyingpig.com.
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #include <common.h>
9 #include <linux/compiler.h>
10 
11 #include <ns16550.h>
12 #ifdef CONFIG_NS87308
13 #include <ns87308.h>
14 #endif
15 
16 #include <serial.h>
17 
18 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
19 
20 DECLARE_GLOBAL_DATA_PTR;
21 
22 #if !defined(CONFIG_CONS_INDEX)
23 #elif (CONFIG_CONS_INDEX < 1) || (CONFIG_CONS_INDEX > 6)
24 #error	"Invalid console index value."
25 #endif
26 
27 #if CONFIG_CONS_INDEX == 1 && !defined(CONFIG_SYS_NS16550_COM1)
28 #error	"Console port 1 defined but not configured."
29 #elif CONFIG_CONS_INDEX == 2 && !defined(CONFIG_SYS_NS16550_COM2)
30 #error	"Console port 2 defined but not configured."
31 #elif CONFIG_CONS_INDEX == 3 && !defined(CONFIG_SYS_NS16550_COM3)
32 #error	"Console port 3 defined but not configured."
33 #elif CONFIG_CONS_INDEX == 4 && !defined(CONFIG_SYS_NS16550_COM4)
34 #error	"Console port 4 defined but not configured."
35 #elif CONFIG_CONS_INDEX == 5 && !defined(CONFIG_SYS_NS16550_COM5)
36 #error	"Console port 5 defined but not configured."
37 #elif CONFIG_CONS_INDEX == 6 && !defined(CONFIG_SYS_NS16550_COM6)
38 #error	"Console port 6 defined but not configured."
39 #endif
40 
41 /* Note: The port number specified in the functions is 1 based.
42  *	 the array is 0 based.
43  */
44 static NS16550_t serial_ports[6] = {
45 #ifdef CONFIG_SYS_NS16550_COM1
46 	(NS16550_t)CONFIG_SYS_NS16550_COM1,
47 #else
48 	NULL,
49 #endif
50 #ifdef CONFIG_SYS_NS16550_COM2
51 	(NS16550_t)CONFIG_SYS_NS16550_COM2,
52 #else
53 	NULL,
54 #endif
55 #ifdef CONFIG_SYS_NS16550_COM3
56 	(NS16550_t)CONFIG_SYS_NS16550_COM3,
57 #else
58 	NULL,
59 #endif
60 #ifdef CONFIG_SYS_NS16550_COM4
61 	(NS16550_t)CONFIG_SYS_NS16550_COM4,
62 #else
63 	NULL,
64 #endif
65 #ifdef CONFIG_SYS_NS16550_COM5
66 	(NS16550_t)CONFIG_SYS_NS16550_COM5,
67 #else
68 	NULL,
69 #endif
70 #ifdef CONFIG_SYS_NS16550_COM6
71 	(NS16550_t)CONFIG_SYS_NS16550_COM6
72 #else
73 	NULL
74 #endif
75 };
76 
77 #define PORT	serial_ports[port-1]
78 
79 /* Multi serial device functions */
80 #define DECLARE_ESERIAL_FUNCTIONS(port) \
81 	static int  eserial##port##_init(void) \
82 	{ \
83 		int clock_divisor; \
84 		clock_divisor = calc_divisor(serial_ports[port-1]); \
85 		NS16550_init(serial_ports[port-1], clock_divisor); \
86 		return 0 ; \
87 	} \
88 	static void eserial##port##_setbrg(void) \
89 	{ \
90 		serial_setbrg_dev(port); \
91 	} \
92 	static int  eserial##port##_getc(void) \
93 	{ \
94 		return serial_getc_dev(port); \
95 	} \
96 	static int  eserial##port##_tstc(void) \
97 	{ \
98 		return serial_tstc_dev(port); \
99 	} \
100 	static void eserial##port##_putc(const char c) \
101 	{ \
102 		serial_putc_dev(port, c); \
103 	} \
104 	static void eserial##port##_puts(const char *s) \
105 	{ \
106 		serial_puts_dev(port, s); \
107 	}
108 
109 /* Serial device descriptor */
110 #define INIT_ESERIAL_STRUCTURE(port, __name) {	\
111 	.name	= __name,			\
112 	.start	= eserial##port##_init,		\
113 	.stop	= NULL,				\
114 	.setbrg	= eserial##port##_setbrg,	\
115 	.getc	= eserial##port##_getc,		\
116 	.tstc	= eserial##port##_tstc,		\
117 	.putc	= eserial##port##_putc,		\
118 	.puts	= eserial##port##_puts,		\
119 }
120 
121 static int calc_divisor (NS16550_t port)
122 {
123 	const unsigned int mode_x_div = 16;
124 
125 #ifdef CONFIG_OMAP1510
126 	/* If can't cleanly clock 115200 set div to 1 */
127 	if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
128 		port->osc_12m_sel = OSC_12M_SEL;	/* enable 6.5 * divisor */
129 		return (1);				/* return 1 for base divisor */
130 	}
131 	port->osc_12m_sel = 0;			/* clear if previsouly set */
132 #endif
133 
134 	return DIV_ROUND_CLOSEST(CONFIG_SYS_NS16550_CLK,
135 						mode_x_div * gd->baudrate);
136 }
137 
138 void
139 _serial_putc(const char c,const int port)
140 {
141 	if (c == '\n')
142 		NS16550_putc(PORT, '\r');
143 
144 	NS16550_putc(PORT, c);
145 }
146 
147 void
148 _serial_putc_raw(const char c,const int port)
149 {
150 	NS16550_putc(PORT, c);
151 }
152 
153 void
154 _serial_puts (const char *s,const int port)
155 {
156 	while (*s) {
157 		_serial_putc (*s++,port);
158 	}
159 }
160 
161 
162 int
163 _serial_getc(const int port)
164 {
165 	return NS16550_getc(PORT);
166 }
167 
168 int
169 _serial_tstc(const int port)
170 {
171 	return NS16550_tstc(PORT);
172 }
173 
174 void
175 _serial_setbrg (const int port)
176 {
177 	int clock_divisor;
178 
179 	clock_divisor = calc_divisor(PORT);
180 	NS16550_reinit(PORT, clock_divisor);
181 }
182 
183 static inline void
184 serial_putc_dev(unsigned int dev_index,const char c)
185 {
186 	_serial_putc(c,dev_index);
187 }
188 
189 static inline void
190 serial_putc_raw_dev(unsigned int dev_index,const char c)
191 {
192 	_serial_putc_raw(c,dev_index);
193 }
194 
195 static inline void
196 serial_puts_dev(unsigned int dev_index,const char *s)
197 {
198 	_serial_puts(s,dev_index);
199 }
200 
201 static inline int
202 serial_getc_dev(unsigned int dev_index)
203 {
204 	return _serial_getc(dev_index);
205 }
206 
207 static inline int
208 serial_tstc_dev(unsigned int dev_index)
209 {
210 	return _serial_tstc(dev_index);
211 }
212 
213 static inline void
214 serial_setbrg_dev(unsigned int dev_index)
215 {
216 	_serial_setbrg(dev_index);
217 }
218 
219 #if defined(CONFIG_SYS_NS16550_COM1)
220 DECLARE_ESERIAL_FUNCTIONS(1);
221 struct serial_device eserial1_device =
222 	INIT_ESERIAL_STRUCTURE(1, "eserial0");
223 #endif
224 #if defined(CONFIG_SYS_NS16550_COM2)
225 DECLARE_ESERIAL_FUNCTIONS(2);
226 struct serial_device eserial2_device =
227 	INIT_ESERIAL_STRUCTURE(2, "eserial1");
228 #endif
229 #if defined(CONFIG_SYS_NS16550_COM3)
230 DECLARE_ESERIAL_FUNCTIONS(3);
231 struct serial_device eserial3_device =
232 	INIT_ESERIAL_STRUCTURE(3, "eserial2");
233 #endif
234 #if defined(CONFIG_SYS_NS16550_COM4)
235 DECLARE_ESERIAL_FUNCTIONS(4);
236 struct serial_device eserial4_device =
237 	INIT_ESERIAL_STRUCTURE(4, "eserial3");
238 #endif
239 #if defined(CONFIG_SYS_NS16550_COM5)
240 DECLARE_ESERIAL_FUNCTIONS(5);
241 struct serial_device eserial5_device =
242 	INIT_ESERIAL_STRUCTURE(5, "eserial4");
243 #endif
244 #if defined(CONFIG_SYS_NS16550_COM6)
245 DECLARE_ESERIAL_FUNCTIONS(6);
246 struct serial_device eserial6_device =
247 	INIT_ESERIAL_STRUCTURE(6, "eserial5");
248 #endif
249 
250 __weak struct serial_device *default_serial_console(void)
251 {
252 #if CONFIG_CONS_INDEX == 1
253 	return &eserial1_device;
254 #elif CONFIG_CONS_INDEX == 2
255 	return &eserial2_device;
256 #elif CONFIG_CONS_INDEX == 3
257 	return &eserial3_device;
258 #elif CONFIG_CONS_INDEX == 4
259 	return &eserial4_device;
260 #elif CONFIG_CONS_INDEX == 5
261 	return &eserial5_device;
262 #elif CONFIG_CONS_INDEX == 6
263 	return &eserial6_device;
264 #else
265 #error "Bad CONFIG_CONS_INDEX."
266 #endif
267 }
268 
269 void ns16550_serial_initialize(void)
270 {
271 #if defined(CONFIG_SYS_NS16550_COM1)
272 	serial_register(&eserial1_device);
273 #endif
274 #if defined(CONFIG_SYS_NS16550_COM2)
275 	serial_register(&eserial2_device);
276 #endif
277 #if defined(CONFIG_SYS_NS16550_COM3)
278 	serial_register(&eserial3_device);
279 #endif
280 #if defined(CONFIG_SYS_NS16550_COM4)
281 	serial_register(&eserial4_device);
282 #endif
283 #if defined(CONFIG_SYS_NS16550_COM5)
284 	serial_register(&eserial5_device);
285 #endif
286 #if defined(CONFIG_SYS_NS16550_COM6)
287 	serial_register(&eserial6_device);
288 #endif
289 }
290 
291 #endif /* !CONFIG_NS16550_MIN_FUNCTIONS */
292