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 > 6)
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 #elif CONFIG_CONS_INDEX == 5 && !defined(CONFIG_SYS_NS16550_COM5)
50 #error	"Console port 5 defined but not configured."
51 #elif CONFIG_CONS_INDEX == 6 && !defined(CONFIG_SYS_NS16550_COM6)
52 #error	"Console port 6 defined but not configured."
53 #endif
54 
55 /* Note: The port number specified in the functions is 1 based.
56  *	 the array is 0 based.
57  */
58 static NS16550_t serial_ports[6] = {
59 #ifdef CONFIG_SYS_NS16550_COM1
60 	(NS16550_t)CONFIG_SYS_NS16550_COM1,
61 #else
62 	NULL,
63 #endif
64 #ifdef CONFIG_SYS_NS16550_COM2
65 	(NS16550_t)CONFIG_SYS_NS16550_COM2,
66 #else
67 	NULL,
68 #endif
69 #ifdef CONFIG_SYS_NS16550_COM3
70 	(NS16550_t)CONFIG_SYS_NS16550_COM3,
71 #else
72 	NULL,
73 #endif
74 #ifdef CONFIG_SYS_NS16550_COM4
75 	(NS16550_t)CONFIG_SYS_NS16550_COM4,
76 #else
77 	NULL,
78 #endif
79 #ifdef CONFIG_SYS_NS16550_COM5
80 	(NS16550_t)CONFIG_SYS_NS16550_COM5,
81 #else
82 	NULL,
83 #endif
84 #ifdef CONFIG_SYS_NS16550_COM6
85 	(NS16550_t)CONFIG_SYS_NS16550_COM6
86 #else
87 	NULL
88 #endif
89 };
90 
91 #define PORT	serial_ports[port-1]
92 
93 /* Multi serial device functions */
94 #define DECLARE_ESERIAL_FUNCTIONS(port) \
95 	static int  eserial##port##_init(void) \
96 	{ \
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 	} \
102 	static void eserial##port##_setbrg(void) \
103 	{ \
104 		serial_setbrg_dev(port); \
105 	} \
106 	static int  eserial##port##_getc(void) \
107 	{ \
108 		return serial_getc_dev(port); \
109 	} \
110 	static int  eserial##port##_tstc(void) \
111 	{ \
112 		return serial_tstc_dev(port); \
113 	} \
114 	static void eserial##port##_putc(const char c) \
115 	{ \
116 		serial_putc_dev(port, c); \
117 	} \
118 	static void eserial##port##_puts(const char *s) \
119 	{ \
120 		serial_puts_dev(port, s); \
121 	}
122 
123 /* Serial device descriptor */
124 #define INIT_ESERIAL_STRUCTURE(port, __name) {	\
125 	.name	= __name,			\
126 	.start	= eserial##port##_init,		\
127 	.stop	= NULL,				\
128 	.setbrg	= eserial##port##_setbrg,	\
129 	.getc	= eserial##port##_getc,		\
130 	.tstc	= eserial##port##_tstc,		\
131 	.putc	= eserial##port##_putc,		\
132 	.puts	= eserial##port##_puts,		\
133 }
134 
135 static int calc_divisor (NS16550_t port)
136 {
137 #ifdef CONFIG_OMAP1510
138 	/* If can't cleanly clock 115200 set div to 1 */
139 	if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
140 		port->osc_12m_sel = OSC_12M_SEL;	/* enable 6.5 * divisor */
141 		return (1);				/* return 1 for base divisor */
142 	}
143 	port->osc_12m_sel = 0;			/* clear if previsouly set */
144 #endif
145 #ifdef CONFIG_OMAP1610
146 	/* If can't cleanly clock 115200 set div to 1 */
147 	if ((CONFIG_SYS_NS16550_CLK == 48000000) && (gd->baudrate == 115200)) {
148 		return (26);		/* return 26 for base divisor */
149 	}
150 #endif
151 
152 #ifdef CONFIG_APTIX
153 #define MODE_X_DIV 13
154 #else
155 #define MODE_X_DIV 16
156 #endif
157 
158 	/* Compute divisor value. Normally, we should simply return:
159 	 *   CONFIG_SYS_NS16550_CLK) / MODE_X_DIV / gd->baudrate
160 	 * but we need to round that value by adding 0.5.
161 	 * Rounding is especially important at high baud rates.
162 	 */
163 	return (CONFIG_SYS_NS16550_CLK + (gd->baudrate * (MODE_X_DIV / 2))) /
164 		(MODE_X_DIV * gd->baudrate);
165 }
166 
167 void
168 _serial_putc(const char c,const int port)
169 {
170 	if (c == '\n')
171 		NS16550_putc(PORT, '\r');
172 
173 	NS16550_putc(PORT, c);
174 }
175 
176 void
177 _serial_putc_raw(const char c,const int port)
178 {
179 	NS16550_putc(PORT, c);
180 }
181 
182 void
183 _serial_puts (const char *s,const int port)
184 {
185 	while (*s) {
186 		_serial_putc (*s++,port);
187 	}
188 }
189 
190 
191 int
192 _serial_getc(const int port)
193 {
194 	return NS16550_getc(PORT);
195 }
196 
197 int
198 _serial_tstc(const int port)
199 {
200 	return NS16550_tstc(PORT);
201 }
202 
203 void
204 _serial_setbrg (const int port)
205 {
206 	int clock_divisor;
207 
208 	clock_divisor = calc_divisor(PORT);
209 	NS16550_reinit(PORT, clock_divisor);
210 }
211 
212 static inline void
213 serial_putc_dev(unsigned int dev_index,const char c)
214 {
215 	_serial_putc(c,dev_index);
216 }
217 
218 static inline void
219 serial_putc_raw_dev(unsigned int dev_index,const char c)
220 {
221 	_serial_putc_raw(c,dev_index);
222 }
223 
224 static inline void
225 serial_puts_dev(unsigned int dev_index,const char *s)
226 {
227 	_serial_puts(s,dev_index);
228 }
229 
230 static inline int
231 serial_getc_dev(unsigned int dev_index)
232 {
233 	return _serial_getc(dev_index);
234 }
235 
236 static inline int
237 serial_tstc_dev(unsigned int dev_index)
238 {
239 	return _serial_tstc(dev_index);
240 }
241 
242 static inline void
243 serial_setbrg_dev(unsigned int dev_index)
244 {
245 	_serial_setbrg(dev_index);
246 }
247 
248 DECLARE_ESERIAL_FUNCTIONS(1);
249 struct serial_device eserial1_device =
250 	INIT_ESERIAL_STRUCTURE(1, "eserial0");
251 DECLARE_ESERIAL_FUNCTIONS(2);
252 struct serial_device eserial2_device =
253 	INIT_ESERIAL_STRUCTURE(2, "eserial1");
254 DECLARE_ESERIAL_FUNCTIONS(3);
255 struct serial_device eserial3_device =
256 	INIT_ESERIAL_STRUCTURE(3, "eserial2");
257 DECLARE_ESERIAL_FUNCTIONS(4);
258 struct serial_device eserial4_device =
259 	INIT_ESERIAL_STRUCTURE(4, "eserial3");
260 DECLARE_ESERIAL_FUNCTIONS(5);
261 struct serial_device eserial5_device =
262 	INIT_ESERIAL_STRUCTURE(5, "eserial4");
263 DECLARE_ESERIAL_FUNCTIONS(6);
264 struct serial_device eserial6_device =
265 	INIT_ESERIAL_STRUCTURE(6, "eserial5");
266 
267 __weak struct serial_device *default_serial_console(void)
268 {
269 #if CONFIG_CONS_INDEX == 1
270 	return &eserial1_device;
271 #elif CONFIG_CONS_INDEX == 2
272 	return &eserial2_device;
273 #elif CONFIG_CONS_INDEX == 3
274 	return &eserial3_device;
275 #elif CONFIG_CONS_INDEX == 4
276 	return &eserial4_device;
277 #elif CONFIG_CONS_INDEX == 5
278 	return &eserial5_device;
279 #elif CONFIG_CONS_INDEX == 6
280 	return &eserial6_device;
281 #else
282 #error "Bad CONFIG_CONS_INDEX."
283 #endif
284 }
285 
286 void ns16550_serial_initialize(void)
287 {
288 #if defined(CONFIG_SYS_NS16550_COM1)
289 	serial_register(&eserial1_device);
290 #endif
291 #if defined(CONFIG_SYS_NS16550_COM2)
292 	serial_register(&eserial2_device);
293 #endif
294 #if defined(CONFIG_SYS_NS16550_COM3)
295 	serial_register(&eserial3_device);
296 #endif
297 #if defined(CONFIG_SYS_NS16550_COM4)
298 	serial_register(&eserial4_device);
299 #endif
300 #if defined(CONFIG_SYS_NS16550_COM5)
301 	serial_register(&eserial5_device);
302 #endif
303 #if defined(CONFIG_SYS_NS16550_COM6)
304 	serial_register(&eserial6_device);
305 #endif
306 }
307