3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
9 #include <environment.h>
11 #include <stdio_dev.h>
13 #include <linux/compiler.h>
16 DECLARE_GLOBAL_DATA_PTR;
18 static struct serial_device *serial_devices;
19 static struct serial_device *serial_current;
21 * Table with supported baudrates (defined in config_xyz.h)
23 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
26 * serial_null() - Void registration routine of a serial driver
28 * This routine implements a void registration routine of a serial
29 * driver. The registration routine of a particular driver is aliased
30 * to this empty function in case the driver is not compiled into
33 static void serial_null(void)
38 * on_baudrate() - Update the actual baudrate when the env var changes
40 * This will check for a valid baudrate and only apply it if valid.
42 static int on_baudrate(const char *name, const char *value, enum env_op op,
50 case env_op_overwrite:
52 * Switch to new baudrate if new baudrate is supported
54 baudrate = simple_strtoul(value, NULL, 10);
56 /* Not actually changing */
57 if (gd->baudrate == baudrate)
60 for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
61 if (baudrate == baudrate_table[i])
64 if (i == ARRAY_SIZE(baudrate_table)) {
65 if ((flags & H_FORCE) == 0)
66 printf("## Baudrate %d bps not supported\n",
70 if ((flags & H_INTERACTIVE) != 0) {
71 printf("## Switch baudrate to %d"
72 " bps and press ENTER ...\n", baudrate);
76 gd->baudrate = baudrate;
82 if ((flags & H_INTERACTIVE) != 0)
90 printf("## Baudrate may not be deleted\n");
96 U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
99 * serial_initfunc() - Forward declare of driver registration routine
100 * @name: Name of the real driver registration routine.
102 * This macro expands onto forward declaration of a driver registration
103 * routine, which is then used below in serial_initialize() function.
104 * The declaration is made weak and aliases to serial_null() so in case
105 * the driver is not compiled in, the function is still declared and can
106 * be used, but aliases to serial_null() and thus is optimized away.
108 #define serial_initfunc(name) \
110 __attribute__((weak, alias("serial_null")));
112 serial_initfunc(mpc8xx_serial_initialize);
113 serial_initfunc(ns16550_serial_initialize);
114 serial_initfunc(pxa_serial_initialize);
115 serial_initfunc(s3c24xx_serial_initialize);
116 serial_initfunc(s5p_serial_initialize);
117 serial_initfunc(zynq_serial_initialize);
118 serial_initfunc(bfin_serial_initialize);
119 serial_initfunc(bfin_jtag_initialize);
120 serial_initfunc(mpc512x_serial_initialize);
121 serial_initfunc(uartlite_serial_initialize);
122 serial_initfunc(au1x00_serial_initialize);
123 serial_initfunc(asc_serial_initialize);
124 serial_initfunc(jz_serial_initialize);
125 serial_initfunc(mpc5xx_serial_initialize);
126 serial_initfunc(mpc8260_scc_serial_initialize);
127 serial_initfunc(mpc8260_smc_serial_initialize);
128 serial_initfunc(mpc85xx_serial_initialize);
129 serial_initfunc(iop480_serial_initialize);
130 serial_initfunc(leon2_serial_initialize);
131 serial_initfunc(leon3_serial_initialize);
132 serial_initfunc(marvell_serial_initialize);
133 serial_initfunc(amirix_serial_initialize);
134 serial_initfunc(bmw_serial_initialize);
135 serial_initfunc(cogent_serial_initialize);
136 serial_initfunc(cpci750_serial_initialize);
137 serial_initfunc(evb64260_serial_initialize);
138 serial_initfunc(ml2_serial_initialize);
139 serial_initfunc(sconsole_serial_initialize);
140 serial_initfunc(p3mx_serial_initialize);
141 serial_initfunc(altera_jtag_serial_initialize);
142 serial_initfunc(altera_serial_initialize);
143 serial_initfunc(atmel_serial_initialize);
144 serial_initfunc(lpc32xx_serial_initialize);
145 serial_initfunc(mcf_serial_initialize);
146 serial_initfunc(oc_serial_initialize);
147 serial_initfunc(sandbox_serial_initialize);
148 serial_initfunc(clps7111_serial_initialize);
149 serial_initfunc(imx_serial_initialize);
150 serial_initfunc(ks8695_serial_initialize);
151 serial_initfunc(lh7a40x_serial_initialize);
152 serial_initfunc(max3100_serial_initialize);
153 serial_initfunc(mxc_serial_initialize);
154 serial_initfunc(pl01x_serial_initialize);
155 serial_initfunc(sa1100_serial_initialize);
156 serial_initfunc(sh_serial_initialize);
157 serial_initfunc(arm_dcc_initialize);
158 serial_initfunc(mxs_auart_initialize);
159 serial_initfunc(arc_serial_initialize);
160 serial_initfunc(uniphier_serial_initialize);
163 * serial_register() - Register serial driver with serial driver core
164 * @dev: Pointer to the serial driver structure
166 * This function registers the serial driver supplied via @dev with
167 * serial driver core, thus making U-Boot aware of it and making it
168 * available for U-Boot to use. On platforms that still require manual
169 * relocation of constant variables, relocation of the supplied structure
172 void serial_register(struct serial_device *dev)
174 #ifdef CONFIG_NEEDS_MANUAL_RELOC
176 dev->start += gd->reloc_off;
178 dev->stop += gd->reloc_off;
180 dev->setbrg += gd->reloc_off;
182 dev->getc += gd->reloc_off;
184 dev->tstc += gd->reloc_off;
186 dev->putc += gd->reloc_off;
188 dev->puts += gd->reloc_off;
191 dev->next = serial_devices;
192 serial_devices = dev;
196 * serial_initialize() - Register all compiled-in serial port drivers
198 * This function registers all serial port drivers that are compiled
199 * into the U-Boot binary with the serial core, thus making them
200 * available to U-Boot to use. Lastly, this function assigns a default
201 * serial port to the serial core. That serial port is then used as a
204 void serial_initialize(void)
206 mpc8xx_serial_initialize();
207 ns16550_serial_initialize();
208 pxa_serial_initialize();
209 s3c24xx_serial_initialize();
210 s5p_serial_initialize();
211 mpc512x_serial_initialize();
212 bfin_serial_initialize();
213 bfin_jtag_initialize();
214 uartlite_serial_initialize();
215 zynq_serial_initialize();
216 au1x00_serial_initialize();
217 asc_serial_initialize();
218 jz_serial_initialize();
219 mpc5xx_serial_initialize();
220 mpc8260_scc_serial_initialize();
221 mpc8260_smc_serial_initialize();
222 mpc85xx_serial_initialize();
223 iop480_serial_initialize();
224 leon2_serial_initialize();
225 leon3_serial_initialize();
226 marvell_serial_initialize();
227 amirix_serial_initialize();
228 bmw_serial_initialize();
229 cogent_serial_initialize();
230 cpci750_serial_initialize();
231 evb64260_serial_initialize();
232 ml2_serial_initialize();
233 sconsole_serial_initialize();
234 p3mx_serial_initialize();
235 altera_jtag_serial_initialize();
236 altera_serial_initialize();
237 atmel_serial_initialize();
238 lpc32xx_serial_initialize();
239 mcf_serial_initialize();
240 oc_serial_initialize();
241 sandbox_serial_initialize();
242 clps7111_serial_initialize();
243 imx_serial_initialize();
244 ks8695_serial_initialize();
245 lh7a40x_serial_initialize();
246 max3100_serial_initialize();
247 mxc_serial_initialize();
248 pl01x_serial_initialize();
249 sa1100_serial_initialize();
250 sh_serial_initialize();
251 arm_dcc_initialize();
252 mxs_auart_initialize();
253 arc_serial_initialize();
254 uniphier_serial_initialize();
256 serial_assign(default_serial_console()->name);
259 int serial_stub_start(struct stdio_dev *sdev)
261 struct serial_device *dev = sdev->priv;
266 int serial_stub_stop(struct stdio_dev *sdev)
268 struct serial_device *dev = sdev->priv;
273 void serial_stub_putc(struct stdio_dev *sdev, const char ch)
275 struct serial_device *dev = sdev->priv;
280 void serial_stub_puts(struct stdio_dev *sdev, const char *str)
282 struct serial_device *dev = sdev->priv;
287 int serial_stub_getc(struct stdio_dev *sdev)
289 struct serial_device *dev = sdev->priv;
294 int serial_stub_tstc(struct stdio_dev *sdev)
296 struct serial_device *dev = sdev->priv;
302 * serial_stdio_init() - Register serial ports with STDIO core
304 * This function generates a proxy driver for each serial port driver.
305 * These proxy drivers then register with the STDIO core, making the
306 * serial drivers available as STDIO devices.
308 void serial_stdio_init(void)
310 struct stdio_dev dev;
311 struct serial_device *s = serial_devices;
314 memset(&dev, 0, sizeof(dev));
316 strcpy(dev.name, s->name);
317 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
319 dev.start = serial_stub_start;
320 dev.stop = serial_stub_stop;
321 dev.putc = serial_stub_putc;
322 dev.puts = serial_stub_puts;
323 dev.getc = serial_stub_getc;
324 dev.tstc = serial_stub_tstc;
327 stdio_register(&dev);
334 * serial_assign() - Select the serial output device by name
335 * @name: Name of the serial driver to be used as default output
337 * This function configures the serial output multiplexing by
338 * selecting which serial device will be used as default. In case
339 * the STDIO "serial" device is selected as stdin/stdout/stderr,
340 * the serial device previously configured by this function will be
341 * used for the particular operation.
343 * Returns 0 on success, negative on error.
345 int serial_assign(const char *name)
347 struct serial_device *s;
349 for (s = serial_devices; s; s = s->next) {
350 if (strcmp(s->name, name))
360 * serial_reinit_all() - Reinitialize all compiled-in serial ports
362 * This function reinitializes all serial ports that are compiled
363 * into U-Boot by calling their serial_start() functions.
365 void serial_reinit_all(void)
367 struct serial_device *s;
369 for (s = serial_devices; s; s = s->next)
374 * get_current() - Return pointer to currently selected serial port
376 * This function returns a pointer to currently selected serial port.
377 * The currently selected serial port is altered by serial_assign()
380 * In case this function is called before relocation or before any serial
381 * port is configured, this function calls default_serial_console() to
382 * determine the serial port. Otherwise, the configured serial port is
385 * Returns pointer to the currently selected serial port on success,
388 static struct serial_device *get_current(void)
390 struct serial_device *dev;
392 if (!(gd->flags & GD_FLG_RELOC))
393 dev = default_serial_console();
394 else if (!serial_current)
395 dev = default_serial_console();
397 dev = serial_current;
399 /* We must have a console device */
401 #ifdef CONFIG_SPL_BUILD
402 puts("Cannot find console\n");
405 panic("Cannot find console\n");
413 * serial_init() - Initialize currently selected serial port
415 * This function initializes the currently selected serial port. This
416 * usually involves setting up the registers of that particular port,
417 * enabling clock and such. This function uses the get_current() call
418 * to determine which port is selected.
420 * Returns 0 on success, negative on error.
422 int serial_init(void)
424 gd->flags |= GD_FLG_SERIAL_READY;
425 return get_current()->start();
429 * serial_setbrg() - Configure baud-rate of currently selected serial port
431 * This function configures the baud-rate of the currently selected
432 * serial port. The baud-rate is retrieved from global data within
433 * the serial port driver. This function uses the get_current() call
434 * to determine which port is selected.
436 * Returns 0 on success, negative on error.
438 void serial_setbrg(void)
440 get_current()->setbrg();
444 * serial_getc() - Read character from currently selected serial port
446 * This function retrieves a character from currently selected serial
447 * port. In case there is no character waiting on the serial port,
448 * this function will block and wait for the character to appear. This
449 * function uses the get_current() call to determine which port is
452 * Returns the character on success, negative on error.
454 int serial_getc(void)
456 return get_current()->getc();
460 * serial_tstc() - Test if data is available on currently selected serial port
462 * This function tests if one or more characters are available on
463 * currently selected serial port. This function never blocks. This
464 * function uses the get_current() call to determine which port is
467 * Returns positive if character is available, zero otherwise.
469 int serial_tstc(void)
471 return get_current()->tstc();
475 * serial_putc() - Output character via currently selected serial port
476 * @c: Single character to be output from the serial port.
478 * This function outputs a character via currently selected serial
479 * port. This character is passed to the serial port driver responsible
480 * for controlling the hardware. The hardware may still be in process
481 * of transmitting another character, therefore this function may block
482 * for a short amount of time. This function uses the get_current()
483 * call to determine which port is selected.
485 void serial_putc(const char c)
487 get_current()->putc(c);
491 * serial_puts() - Output string via currently selected serial port
492 * @s: Zero-terminated string to be output from the serial port.
494 * This function outputs a zero-terminated string via currently
495 * selected serial port. This function behaves as an accelerator
496 * in case the hardware can queue multiple characters for transfer.
497 * The whole string that is to be output is available to the function
498 * implementing the hardware manipulation. Transmitting the whole
499 * string may take some time, thus this function may block for some
500 * amount of time. This function uses the get_current() call to
501 * determine which port is selected.
503 void serial_puts(const char *s)
505 get_current()->puts(s);
509 * default_serial_puts() - Output string by calling serial_putc() in loop
510 * @s: Zero-terminated string to be output from the serial port.
512 * This function outputs a zero-terminated string by calling serial_putc()
513 * in a loop. Most drivers do not support queueing more than one byte for
514 * transfer, thus this function precisely implements their serial_puts().
516 * To optimize the number of get_current() calls, this function only
517 * calls get_current() once and then directly accesses the putc() call
518 * of the &struct serial_device .
520 void default_serial_puts(const char *s)
522 struct serial_device *dev = get_current();
527 #if CONFIG_POST & CONFIG_SYS_POST_UART
528 static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
531 * uart_post_test() - Test the currently selected serial port using POST
532 * @flags: POST framework flags
534 * Do a loopback test of the currently selected serial port. This
535 * function is only useful in the context of the POST testing framwork.
536 * The serial port is firstly configured into loopback mode and then
537 * characters are sent through it.
539 * Returns 0 on success, value otherwise.
541 /* Mark weak until post/cpu/.../uart.c migrate over */
543 int uart_post_test(int flags)
546 int ret, saved_baud, b;
547 struct serial_device *saved_dev, *s;
549 /* Save current serial state */
551 saved_dev = serial_current;
552 saved_baud = gd->baudrate;
554 for (s = serial_devices; s; s = s->next) {
555 /* If this driver doesn't support loop back, skip it */
559 /* Test the next device */
566 /* Consume anything that happens to be queued */
567 while (serial_tstc())
570 /* Enable loop back */
573 /* Test every available baud rate */
574 for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
575 gd->baudrate = bauds[b];
579 * Stick to printable chars to avoid issues:
580 * - terminal corruption
581 * - serial program reacting to sequences and sending
582 * back random extra data
583 * - most serial drivers add in extra chars (like \r\n)
585 for (c = 0x20; c < 0x7f; ++c) {
589 /* Make sure it's the same one */
590 ret = (c != serial_getc());
596 /* Clean up the output in case it was sent */
598 ret = ('\b' != serial_getc());
606 /* Disable loop back */
609 /* XXX: There is no serial_stop() !? */
615 /* Restore previous serial state */
616 serial_current = saved_dev;
617 gd->baudrate = saved_baud;