3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * See file CREDITS for list of people who contributed to this
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.
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.
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,
25 #include <environment.h>
27 #include <stdio_dev.h>
29 #include <linux/compiler.h>
32 DECLARE_GLOBAL_DATA_PTR;
34 static struct serial_device *serial_devices;
35 static struct serial_device *serial_current;
37 * Table with supported baudrates (defined in config_xyz.h)
39 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
40 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
43 * serial_null() - Void registration routine of a serial driver
45 * This routine implements a void registration routine of a serial
46 * driver. The registration routine of a particular driver is aliased
47 * to this empty function in case the driver is not compiled into
50 static void serial_null(void)
55 * on_baudrate() - Update the actual baudrate when the env var changes
57 * This will check for a valid baudrate and only apply it if valid.
59 static int on_baudrate(const char *name, const char *value, enum env_op op,
67 case env_op_overwrite:
69 * Switch to new baudrate if new baudrate is supported
71 baudrate = simple_strtoul(value, NULL, 10);
73 /* Not actually changing */
74 if (gd->baudrate == baudrate)
77 for (i = 0; i < N_BAUDRATES; ++i) {
78 if (baudrate == baudrate_table[i])
81 if (i == N_BAUDRATES) {
82 if ((flags & H_FORCE) == 0)
83 printf("## Baudrate %d bps not supported\n",
87 if ((flags & H_INTERACTIVE) != 0) {
88 printf("## Switch baudrate to %d"
89 " bps and press ENTER ...\n", baudrate);
93 gd->baudrate = baudrate;
94 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
95 gd->bd->bi_baudrate = baudrate;
102 if ((flags & H_INTERACTIVE) != 0)
110 printf("## Baudrate may not be deleted\n");
116 U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
119 * serial_initfunc() - Forward declare of driver registration routine
120 * @name: Name of the real driver registration routine.
122 * This macro expands onto forward declaration of a driver registration
123 * routine, which is then used below in serial_initialize() function.
124 * The declaration is made weak and aliases to serial_null() so in case
125 * the driver is not compiled in, the function is still declared and can
126 * be used, but aliases to serial_null() and thus is optimized away.
128 #define serial_initfunc(name) \
130 __attribute__((weak, alias("serial_null")));
132 serial_initfunc(mpc8xx_serial_initialize);
133 serial_initfunc(ns16550_serial_initialize);
134 serial_initfunc(pxa_serial_initialize);
135 serial_initfunc(s3c24xx_serial_initialize);
136 serial_initfunc(s5p_serial_initialize);
137 serial_initfunc(zynq_serial_initalize);
138 serial_initfunc(bfin_serial_initialize);
139 serial_initfunc(bfin_jtag_initialize);
140 serial_initfunc(mpc512x_serial_initialize);
141 serial_initfunc(uartlite_serial_initialize);
142 serial_initfunc(au1x00_serial_initialize);
143 serial_initfunc(asc_serial_initialize);
144 serial_initfunc(jz_serial_initialize);
145 serial_initfunc(mpc5xx_serial_initialize);
146 serial_initfunc(mpc8220_serial_initialize);
147 serial_initfunc(mpc8260_scc_serial_initialize);
148 serial_initfunc(mpc8260_smc_serial_initialize);
149 serial_initfunc(mpc85xx_serial_initialize);
150 serial_initfunc(iop480_serial_initialize);
151 serial_initfunc(leon2_serial_initialize);
152 serial_initfunc(leon3_serial_initialize);
153 serial_initfunc(marvell_serial_initialize);
154 serial_initfunc(amirix_serial_initialize);
155 serial_initfunc(bmw_serial_initialize);
156 serial_initfunc(cogent_serial_initialize);
157 serial_initfunc(cpci750_serial_initialize);
158 serial_initfunc(evb64260_serial_initialize);
159 serial_initfunc(ml2_serial_initialize);
160 serial_initfunc(sconsole_serial_initialize);
161 serial_initfunc(p3mx_serial_initialize);
162 serial_initfunc(altera_jtag_serial_initialize);
163 serial_initfunc(altera_serial_initialize);
164 serial_initfunc(atmel_serial_initialize);
165 serial_initfunc(lpc32xx_serial_initialize);
166 serial_initfunc(mcf_serial_initialize);
167 serial_initfunc(oc_serial_initialize);
168 serial_initfunc(sandbox_serial_initialize);
169 serial_initfunc(clps7111_serial_initialize);
170 serial_initfunc(imx_serial_initialize);
171 serial_initfunc(ixp_serial_initialize);
172 serial_initfunc(ks8695_serial_initialize);
173 serial_initfunc(lh7a40x_serial_initialize);
174 serial_initfunc(max3100_serial_initialize);
175 serial_initfunc(mxc_serial_initialize);
176 serial_initfunc(pl01x_serial_initialize);
177 serial_initfunc(s3c44b0_serial_initialize);
178 serial_initfunc(sa1100_serial_initialize);
179 serial_initfunc(sh_serial_initialize);
182 * serial_register() - Register serial driver with serial driver core
183 * @dev: Pointer to the serial driver structure
185 * This function registers the serial driver supplied via @dev with
186 * serial driver core, thus making U-Boot aware of it and making it
187 * available for U-Boot to use. On platforms that still require manual
188 * relocation of constant variables, relocation of the supplied structure
191 void serial_register(struct serial_device *dev)
193 #ifdef CONFIG_NEEDS_MANUAL_RELOC
195 dev->start += gd->reloc_off;
197 dev->stop += gd->reloc_off;
199 dev->setbrg += gd->reloc_off;
201 dev->getc += gd->reloc_off;
203 dev->tstc += gd->reloc_off;
205 dev->putc += gd->reloc_off;
207 dev->puts += gd->reloc_off;
210 dev->next = serial_devices;
211 serial_devices = dev;
215 * serial_initialize() - Register all compiled-in serial port drivers
217 * This function registers all serial port drivers that are compiled
218 * into the U-Boot binary with the serial core, thus making them
219 * available to U-Boot to use. Lastly, this function assigns a default
220 * serial port to the serial core. That serial port is then used as a
223 void serial_initialize(void)
225 mpc8xx_serial_initialize();
226 ns16550_serial_initialize();
227 pxa_serial_initialize();
228 s3c24xx_serial_initialize();
229 s5p_serial_initialize();
230 mpc512x_serial_initialize();
231 bfin_serial_initialize();
232 bfin_jtag_initialize();
233 uartlite_serial_initialize();
234 zynq_serial_initalize();
235 au1x00_serial_initialize();
236 asc_serial_initialize();
237 jz_serial_initialize();
238 mpc5xx_serial_initialize();
239 mpc8220_serial_initialize();
240 mpc8260_scc_serial_initialize();
241 mpc8260_smc_serial_initialize();
242 mpc85xx_serial_initialize();
243 iop480_serial_initialize();
244 leon2_serial_initialize();
245 leon3_serial_initialize();
246 marvell_serial_initialize();
247 amirix_serial_initialize();
248 bmw_serial_initialize();
249 cogent_serial_initialize();
250 cpci750_serial_initialize();
251 evb64260_serial_initialize();
252 ml2_serial_initialize();
253 sconsole_serial_initialize();
254 p3mx_serial_initialize();
255 altera_jtag_serial_initialize();
256 altera_serial_initialize();
257 atmel_serial_initialize();
258 lpc32xx_serial_initialize();
259 mcf_serial_initialize();
260 oc_serial_initialize();
261 sandbox_serial_initialize();
262 clps7111_serial_initialize();
263 imx_serial_initialize();
264 ixp_serial_initialize();
265 ks8695_serial_initialize();
266 lh7a40x_serial_initialize();
267 max3100_serial_initialize();
268 mxc_serial_initialize();
269 pl01x_serial_initialize();
270 s3c44b0_serial_initialize();
271 sa1100_serial_initialize();
272 sh_serial_initialize();
274 serial_assign(default_serial_console()->name);
278 * serial_stdio_init() - Register serial ports with STDIO core
280 * This function generates a proxy driver for each serial port driver.
281 * These proxy drivers then register with the STDIO core, making the
282 * serial drivers available as STDIO devices.
284 void serial_stdio_init(void)
286 struct stdio_dev dev;
287 struct serial_device *s = serial_devices;
290 memset(&dev, 0, sizeof(dev));
292 strcpy(dev.name, s->name);
293 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
295 dev.start = s->start;
302 stdio_register(&dev);
309 * serial_assign() - Select the serial output device by name
310 * @name: Name of the serial driver to be used as default output
312 * This function configures the serial output multiplexing by
313 * selecting which serial device will be used as default. In case
314 * the STDIO "serial" device is selected as stdin/stdout/stderr,
315 * the serial device previously configured by this function will be
316 * used for the particular operation.
318 * Returns 0 on success, negative on error.
320 int serial_assign(const char *name)
322 struct serial_device *s;
324 for (s = serial_devices; s; s = s->next) {
325 if (strcmp(s->name, name))
335 * serial_reinit_all() - Reinitialize all compiled-in serial ports
337 * This function reinitializes all serial ports that are compiled
338 * into U-Boot by calling their serial_start() functions.
340 void serial_reinit_all(void)
342 struct serial_device *s;
344 for (s = serial_devices; s; s = s->next)
349 * get_current() - Return pointer to currently selected serial port
351 * This function returns a pointer to currently selected serial port.
352 * The currently selected serial port is altered by serial_assign()
355 * In case this function is called before relocation or before any serial
356 * port is configured, this function calls default_serial_console() to
357 * determine the serial port. Otherwise, the configured serial port is
360 * Returns pointer to the currently selected serial port on success,
363 static struct serial_device *get_current(void)
365 struct serial_device *dev;
367 if (!(gd->flags & GD_FLG_RELOC))
368 dev = default_serial_console();
369 else if (!serial_current)
370 dev = default_serial_console();
372 dev = serial_current;
374 /* We must have a console device */
376 #ifdef CONFIG_SPL_BUILD
377 puts("Cannot find console\n");
380 panic("Cannot find console\n");
388 * serial_init() - Initialize currently selected serial port
390 * This function initializes the currently selected serial port. This
391 * usually involves setting up the registers of that particular port,
392 * enabling clock and such. This function uses the get_current() call
393 * to determine which port is selected.
395 * Returns 0 on success, negative on error.
397 int serial_init(void)
399 return get_current()->start();
403 * serial_setbrg() - Configure baud-rate of currently selected serial port
405 * This function configures the baud-rate of the currently selected
406 * serial port. The baud-rate is retrieved from global data within
407 * the serial port driver. This function uses the get_current() call
408 * to determine which port is selected.
410 * Returns 0 on success, negative on error.
412 void serial_setbrg(void)
414 get_current()->setbrg();
418 * serial_getc() - Read character from currently selected serial port
420 * This function retrieves a character from currently selected serial
421 * port. In case there is no character waiting on the serial port,
422 * this function will block and wait for the character to appear. This
423 * function uses the get_current() call to determine which port is
426 * Returns the character on success, negative on error.
428 int serial_getc(void)
430 return get_current()->getc();
434 * serial_tstc() - Test if data is available on currently selected serial port
436 * This function tests if one or more characters are available on
437 * currently selected serial port. This function never blocks. This
438 * function uses the get_current() call to determine which port is
441 * Returns positive if character is available, zero otherwise.
443 int serial_tstc(void)
445 return get_current()->tstc();
449 * serial_putc() - Output character via currently selected serial port
450 * @c: Single character to be output from the serial port.
452 * This function outputs a character via currently selected serial
453 * port. This character is passed to the serial port driver responsible
454 * for controlling the hardware. The hardware may still be in process
455 * of transmitting another character, therefore this function may block
456 * for a short amount of time. This function uses the get_current()
457 * call to determine which port is selected.
459 void serial_putc(const char c)
461 get_current()->putc(c);
465 * serial_puts() - Output string via currently selected serial port
466 * @s: Zero-terminated string to be output from the serial port.
468 * This function outputs a zero-terminated string via currently
469 * selected serial port. This function behaves as an accelerator
470 * in case the hardware can queue multiple characters for transfer.
471 * The whole string that is to be output is available to the function
472 * implementing the hardware manipulation. Transmitting the whole
473 * string may take some time, thus this function may block for some
474 * amount of time. This function uses the get_current() call to
475 * determine which port is selected.
477 void serial_puts(const char *s)
479 get_current()->puts(s);
483 * default_serial_puts() - Output string by calling serial_putc() in loop
484 * @s: Zero-terminated string to be output from the serial port.
486 * This function outputs a zero-terminated string by calling serial_putc()
487 * in a loop. Most drivers do not support queueing more than one byte for
488 * transfer, thus this function precisely implements their serial_puts().
490 * To optimize the number of get_current() calls, this function only
491 * calls get_current() once and then directly accesses the putc() call
492 * of the &struct serial_device .
494 void default_serial_puts(const char *s)
496 struct serial_device *dev = get_current();
501 #if CONFIG_POST & CONFIG_SYS_POST_UART
502 static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
505 * uart_post_test() - Test the currently selected serial port using POST
506 * @flags: POST framework flags
508 * Do a loopback test of the currently selected serial port. This
509 * function is only useful in the context of the POST testing framwork.
510 * The serial port is firstly configured into loopback mode and then
511 * characters are sent through it.
513 * Returns 0 on success, value otherwise.
515 /* Mark weak until post/cpu/.../uart.c migrate over */
517 int uart_post_test(int flags)
520 int ret, saved_baud, b;
521 struct serial_device *saved_dev, *s;
524 /* Save current serial state */
526 saved_dev = serial_current;
527 saved_baud = bd->bi_baudrate;
529 for (s = serial_devices; s; s = s->next) {
530 /* If this driver doesn't support loop back, skip it */
534 /* Test the next device */
541 /* Consume anything that happens to be queued */
542 while (serial_tstc())
545 /* Enable loop back */
548 /* Test every available baud rate */
549 for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
550 bd->bi_baudrate = bauds[b];
554 * Stick to printable chars to avoid issues:
555 * - terminal corruption
556 * - serial program reacting to sequences and sending
557 * back random extra data
558 * - most serial drivers add in extra chars (like \r\n)
560 for (c = 0x20; c < 0x7f; ++c) {
564 /* Make sure it's the same one */
565 ret = (c != serial_getc());
571 /* Clean up the output in case it was sent */
573 ret = ('\b' != serial_getc());
581 /* Disable loop back */
584 /* XXX: There is no serial_stop() !? */
590 /* Restore previous serial state */
591 serial_current = saved_dev;
592 bd->bi_baudrate = saved_baud;