xref: /rk3399_rockchip-uboot/drivers/serial/serial_ns16550.c (revision 619dd5de69bc506e4f4607aa1e698b2fd61b99fe)
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 #include <linux/compiler.h>
26 
27 #include <ns16550.h>
28 #ifdef CONFIG_NS87308
29 #include <ns87308.h>
30 #endif
31 
32 #include <serial.h>
33 
34 DECLARE_GLOBAL_DATA_PTR;
35 
36 #if !defined(CONFIG_CONS_INDEX)
37 #elif (CONFIG_CONS_INDEX < 1) || (CONFIG_CONS_INDEX > 4)
38 #error	"Invalid console index value."
39 #endif
40 
41 #if CONFIG_CONS_INDEX == 1 && !defined(CONFIG_SYS_NS16550_COM1)
42 #error	"Console port 1 defined but not configured."
43 #elif CONFIG_CONS_INDEX == 2 && !defined(CONFIG_SYS_NS16550_COM2)
44 #error	"Console port 2 defined but not configured."
45 #elif CONFIG_CONS_INDEX == 3 && !defined(CONFIG_SYS_NS16550_COM3)
46 #error	"Console port 3 defined but not configured."
47 #elif CONFIG_CONS_INDEX == 4 && !defined(CONFIG_SYS_NS16550_COM4)
48 #error	"Console port 4 defined but not configured."
49 #endif
50 
51 /* Note: The port number specified in the functions is 1 based.
52  *	 the array is 0 based.
53  */
54 static NS16550_t serial_ports[4] = {
55 #ifdef CONFIG_SYS_NS16550_COM1
56 	(NS16550_t)CONFIG_SYS_NS16550_COM1,
57 #else
58 	NULL,
59 #endif
60 #ifdef CONFIG_SYS_NS16550_COM2
61 	(NS16550_t)CONFIG_SYS_NS16550_COM2,
62 #else
63 	NULL,
64 #endif
65 #ifdef CONFIG_SYS_NS16550_COM3
66 	(NS16550_t)CONFIG_SYS_NS16550_COM3,
67 #else
68 	NULL,
69 #endif
70 #ifdef CONFIG_SYS_NS16550_COM4
71 	(NS16550_t)CONFIG_SYS_NS16550_COM4
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 #ifdef CONFIG_OMAP1510
124 	/* If can't cleanly clock 115200 set div to 1 */
125 	if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
126 		port->osc_12m_sel = OSC_12M_SEL;	/* enable 6.5 * divisor */
127 		return (1);				/* return 1 for base divisor */
128 	}
129 	port->osc_12m_sel = 0;			/* clear if previsouly set */
130 #endif
131 #ifdef CONFIG_OMAP1610
132 	/* If can't cleanly clock 115200 set div to 1 */
133 	if ((CONFIG_SYS_NS16550_CLK == 48000000) && (gd->baudrate == 115200)) {
134 		return (26);		/* return 26 for base divisor */
135 	}
136 #endif
137 
138 #ifdef CONFIG_APTIX
139 #define MODE_X_DIV 13
140 #else
141 #define MODE_X_DIV 16
142 #endif
143 
144 	/* Compute divisor value. Normally, we should simply return:
145 	 *   CONFIG_SYS_NS16550_CLK) / MODE_X_DIV / gd->baudrate
146 	 * but we need to round that value by adding 0.5.
147 	 * Rounding is especially important at high baud rates.
148 	 */
149 	return (CONFIG_SYS_NS16550_CLK + (gd->baudrate * (MODE_X_DIV / 2))) /
150 		(MODE_X_DIV * gd->baudrate);
151 }
152 
153 void
154 _serial_putc(const char c,const int port)
155 {
156 	if (c == '\n')
157 		NS16550_putc(PORT, '\r');
158 
159 	NS16550_putc(PORT, c);
160 }
161 
162 void
163 _serial_putc_raw(const char c,const int port)
164 {
165 	NS16550_putc(PORT, c);
166 }
167 
168 void
169 _serial_puts (const char *s,const int port)
170 {
171 	while (*s) {
172 		_serial_putc (*s++,port);
173 	}
174 }
175 
176 
177 int
178 _serial_getc(const int port)
179 {
180 	return NS16550_getc(PORT);
181 }
182 
183 int
184 _serial_tstc(const int port)
185 {
186 	return NS16550_tstc(PORT);
187 }
188 
189 void
190 _serial_setbrg (const int port)
191 {
192 	int clock_divisor;
193 
194 	clock_divisor = calc_divisor(PORT);
195 	NS16550_reinit(PORT, clock_divisor);
196 }
197 
198 static inline void
199 serial_putc_dev(unsigned int dev_index,const char c)
200 {
201 	_serial_putc(c,dev_index);
202 }
203 
204 static inline void
205 serial_putc_raw_dev(unsigned int dev_index,const char c)
206 {
207 	_serial_putc_raw(c,dev_index);
208 }
209 
210 static inline void
211 serial_puts_dev(unsigned int dev_index,const char *s)
212 {
213 	_serial_puts(s,dev_index);
214 }
215 
216 static inline int
217 serial_getc_dev(unsigned int dev_index)
218 {
219 	return _serial_getc(dev_index);
220 }
221 
222 static inline int
223 serial_tstc_dev(unsigned int dev_index)
224 {
225 	return _serial_tstc(dev_index);
226 }
227 
228 static inline void
229 serial_setbrg_dev(unsigned int dev_index)
230 {
231 	_serial_setbrg(dev_index);
232 }
233 
234 DECLARE_ESERIAL_FUNCTIONS(1);
235 struct serial_device eserial1_device =
236 	INIT_ESERIAL_STRUCTURE(1, "eserial0");
237 DECLARE_ESERIAL_FUNCTIONS(2);
238 struct serial_device eserial2_device =
239 	INIT_ESERIAL_STRUCTURE(2, "eserial1");
240 DECLARE_ESERIAL_FUNCTIONS(3);
241 struct serial_device eserial3_device =
242 	INIT_ESERIAL_STRUCTURE(3, "eserial2");
243 DECLARE_ESERIAL_FUNCTIONS(4);
244 struct serial_device eserial4_device =
245 	INIT_ESERIAL_STRUCTURE(4, "eserial3");
246 
247 __weak struct serial_device *default_serial_console(void)
248 {
249 #if CONFIG_CONS_INDEX == 1
250 	return &eserial1_device;
251 #elif CONFIG_CONS_INDEX == 2
252 	return &eserial2_device;
253 #elif CONFIG_CONS_INDEX == 3
254 	return &eserial3_device;
255 #elif CONFIG_CONS_INDEX == 4
256 	return &eserial4_device;
257 #else
258 #error "Bad CONFIG_CONS_INDEX."
259 #endif
260 }
261 
262 void ns16550_serial_initialize(void)
263 {
264 #if defined(CONFIG_SYS_NS16550_COM1)
265 	serial_register(&eserial1_device);
266 #endif
267 #if defined(CONFIG_SYS_NS16550_COM2)
268 	serial_register(&eserial2_device);
269 #endif
270 #if defined(CONFIG_SYS_NS16550_COM3)
271 	serial_register(&eserial3_device);
272 #endif
273 #if defined(CONFIG_SYS_NS16550_COM4)
274 	serial_register(&eserial4_device);
275 #endif
276 }
277