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;
42 * serial_null() - Void registration routine of a serial driver
44 * This routine implements a void registration routine of a serial
45 * driver. The registration routine of a particular driver is aliased
46 * to this empty function in case the driver is not compiled into
49 static void serial_null(void)
54 * on_baudrate() - Update the actual baudrate when the env var changes
56 * This will check for a valid baudrate and only apply it if valid.
58 static int on_baudrate(const char *name, const char *value, enum env_op op,
66 case env_op_overwrite:
68 * Switch to new baudrate if new baudrate is supported
70 baudrate = simple_strtoul(value, NULL, 10);
72 /* Not actually changing */
73 if (gd->baudrate == baudrate)
76 for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
77 if (baudrate == baudrate_table[i])
80 if (i == ARRAY_SIZE(baudrate_table)) {
81 if ((flags & H_FORCE) == 0)
82 printf("## Baudrate %d bps not supported\n",
86 if ((flags & H_INTERACTIVE) != 0) {
87 printf("## Switch baudrate to %d"
88 " bps and press ENTER ...\n", baudrate);
92 gd->baudrate = baudrate;
93 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
94 gd->bd->bi_baudrate = baudrate;
101 if ((flags & H_INTERACTIVE) != 0)
109 printf("## Baudrate may not be deleted\n");
115 U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
118 * serial_initfunc() - Forward declare of driver registration routine
119 * @name: Name of the real driver registration routine.
121 * This macro expands onto forward declaration of a driver registration
122 * routine, which is then used below in serial_initialize() function.
123 * The declaration is made weak and aliases to serial_null() so in case
124 * the driver is not compiled in, the function is still declared and can
125 * be used, but aliases to serial_null() and thus is optimized away.
127 #define serial_initfunc(name) \
129 __attribute__((weak, alias("serial_null")));
131 serial_initfunc(mpc8xx_serial_initialize);
132 serial_initfunc(ns16550_serial_initialize);
133 serial_initfunc(pxa_serial_initialize);
134 serial_initfunc(s3c24xx_serial_initialize);
135 serial_initfunc(s5p_serial_initialize);
136 serial_initfunc(zynq_serial_initalize);
137 serial_initfunc(bfin_serial_initialize);
138 serial_initfunc(bfin_jtag_initialize);
139 serial_initfunc(mpc512x_serial_initialize);
140 serial_initfunc(uartlite_serial_initialize);
141 serial_initfunc(au1x00_serial_initialize);
142 serial_initfunc(asc_serial_initialize);
143 serial_initfunc(jz_serial_initialize);
144 serial_initfunc(mpc5xx_serial_initialize);
145 serial_initfunc(mpc8260_scc_serial_initialize);
146 serial_initfunc(mpc8260_smc_serial_initialize);
147 serial_initfunc(mpc85xx_serial_initialize);
148 serial_initfunc(iop480_serial_initialize);
149 serial_initfunc(leon2_serial_initialize);
150 serial_initfunc(leon3_serial_initialize);
151 serial_initfunc(marvell_serial_initialize);
152 serial_initfunc(amirix_serial_initialize);
153 serial_initfunc(bmw_serial_initialize);
154 serial_initfunc(cogent_serial_initialize);
155 serial_initfunc(cpci750_serial_initialize);
156 serial_initfunc(evb64260_serial_initialize);
157 serial_initfunc(ml2_serial_initialize);
158 serial_initfunc(sconsole_serial_initialize);
159 serial_initfunc(p3mx_serial_initialize);
160 serial_initfunc(altera_jtag_serial_initialize);
161 serial_initfunc(altera_serial_initialize);
162 serial_initfunc(atmel_serial_initialize);
163 serial_initfunc(lpc32xx_serial_initialize);
164 serial_initfunc(mcf_serial_initialize);
165 serial_initfunc(oc_serial_initialize);
166 serial_initfunc(sandbox_serial_initialize);
167 serial_initfunc(clps7111_serial_initialize);
168 serial_initfunc(imx_serial_initialize);
169 serial_initfunc(ixp_serial_initialize);
170 serial_initfunc(ks8695_serial_initialize);
171 serial_initfunc(lh7a40x_serial_initialize);
172 serial_initfunc(max3100_serial_initialize);
173 serial_initfunc(mxc_serial_initialize);
174 serial_initfunc(pl01x_serial_initialize);
175 serial_initfunc(s3c44b0_serial_initialize);
176 serial_initfunc(sa1100_serial_initialize);
177 serial_initfunc(sh_serial_initialize);
180 * serial_register() - Register serial driver with serial driver core
181 * @dev: Pointer to the serial driver structure
183 * This function registers the serial driver supplied via @dev with
184 * serial driver core, thus making U-Boot aware of it and making it
185 * available for U-Boot to use. On platforms that still require manual
186 * relocation of constant variables, relocation of the supplied structure
189 void serial_register(struct serial_device *dev)
191 #ifdef CONFIG_NEEDS_MANUAL_RELOC
193 dev->start += gd->reloc_off;
195 dev->stop += gd->reloc_off;
197 dev->setbrg += gd->reloc_off;
199 dev->getc += gd->reloc_off;
201 dev->tstc += gd->reloc_off;
203 dev->putc += gd->reloc_off;
205 dev->puts += gd->reloc_off;
208 dev->next = serial_devices;
209 serial_devices = dev;
213 * serial_initialize() - Register all compiled-in serial port drivers
215 * This function registers all serial port drivers that are compiled
216 * into the U-Boot binary with the serial core, thus making them
217 * available to U-Boot to use. Lastly, this function assigns a default
218 * serial port to the serial core. That serial port is then used as a
221 void serial_initialize(void)
223 mpc8xx_serial_initialize();
224 ns16550_serial_initialize();
225 pxa_serial_initialize();
226 s3c24xx_serial_initialize();
227 s5p_serial_initialize();
228 mpc512x_serial_initialize();
229 bfin_serial_initialize();
230 bfin_jtag_initialize();
231 uartlite_serial_initialize();
232 zynq_serial_initalize();
233 au1x00_serial_initialize();
234 asc_serial_initialize();
235 jz_serial_initialize();
236 mpc5xx_serial_initialize();
237 mpc8260_scc_serial_initialize();
238 mpc8260_smc_serial_initialize();
239 mpc85xx_serial_initialize();
240 iop480_serial_initialize();
241 leon2_serial_initialize();
242 leon3_serial_initialize();
243 marvell_serial_initialize();
244 amirix_serial_initialize();
245 bmw_serial_initialize();
246 cogent_serial_initialize();
247 cpci750_serial_initialize();
248 evb64260_serial_initialize();
249 ml2_serial_initialize();
250 sconsole_serial_initialize();
251 p3mx_serial_initialize();
252 altera_jtag_serial_initialize();
253 altera_serial_initialize();
254 atmel_serial_initialize();
255 lpc32xx_serial_initialize();
256 mcf_serial_initialize();
257 oc_serial_initialize();
258 sandbox_serial_initialize();
259 clps7111_serial_initialize();
260 imx_serial_initialize();
261 ixp_serial_initialize();
262 ks8695_serial_initialize();
263 lh7a40x_serial_initialize();
264 max3100_serial_initialize();
265 mxc_serial_initialize();
266 pl01x_serial_initialize();
267 s3c44b0_serial_initialize();
268 sa1100_serial_initialize();
269 sh_serial_initialize();
271 serial_assign(default_serial_console()->name);
275 * serial_stdio_init() - Register serial ports with STDIO core
277 * This function generates a proxy driver for each serial port driver.
278 * These proxy drivers then register with the STDIO core, making the
279 * serial drivers available as STDIO devices.
281 void serial_stdio_init(void)
283 struct stdio_dev dev;
284 struct serial_device *s = serial_devices;
287 memset(&dev, 0, sizeof(dev));
289 strcpy(dev.name, s->name);
290 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
292 dev.start = s->start;
299 stdio_register(&dev);
306 * serial_assign() - Select the serial output device by name
307 * @name: Name of the serial driver to be used as default output
309 * This function configures the serial output multiplexing by
310 * selecting which serial device will be used as default. In case
311 * the STDIO "serial" device is selected as stdin/stdout/stderr,
312 * the serial device previously configured by this function will be
313 * used for the particular operation.
315 * Returns 0 on success, negative on error.
317 int serial_assign(const char *name)
319 struct serial_device *s;
321 for (s = serial_devices; s; s = s->next) {
322 if (strcmp(s->name, name))
332 * serial_reinit_all() - Reinitialize all compiled-in serial ports
334 * This function reinitializes all serial ports that are compiled
335 * into U-Boot by calling their serial_start() functions.
337 void serial_reinit_all(void)
339 struct serial_device *s;
341 for (s = serial_devices; s; s = s->next)
346 * get_current() - Return pointer to currently selected serial port
348 * This function returns a pointer to currently selected serial port.
349 * The currently selected serial port is altered by serial_assign()
352 * In case this function is called before relocation or before any serial
353 * port is configured, this function calls default_serial_console() to
354 * determine the serial port. Otherwise, the configured serial port is
357 * Returns pointer to the currently selected serial port on success,
360 static struct serial_device *get_current(void)
362 struct serial_device *dev;
364 if (!(gd->flags & GD_FLG_RELOC))
365 dev = default_serial_console();
366 else if (!serial_current)
367 dev = default_serial_console();
369 dev = serial_current;
371 /* We must have a console device */
373 #ifdef CONFIG_SPL_BUILD
374 puts("Cannot find console\n");
377 panic("Cannot find console\n");
385 * serial_init() - Initialize currently selected serial port
387 * This function initializes the currently selected serial port. This
388 * usually involves setting up the registers of that particular port,
389 * enabling clock and such. This function uses the get_current() call
390 * to determine which port is selected.
392 * Returns 0 on success, negative on error.
394 int serial_init(void)
396 return get_current()->start();
400 * serial_setbrg() - Configure baud-rate of currently selected serial port
402 * This function configures the baud-rate of the currently selected
403 * serial port. The baud-rate is retrieved from global data within
404 * the serial port driver. This function uses the get_current() call
405 * to determine which port is selected.
407 * Returns 0 on success, negative on error.
409 void serial_setbrg(void)
411 get_current()->setbrg();
415 * serial_getc() - Read character from currently selected serial port
417 * This function retrieves a character from currently selected serial
418 * port. In case there is no character waiting on the serial port,
419 * this function will block and wait for the character to appear. This
420 * function uses the get_current() call to determine which port is
423 * Returns the character on success, negative on error.
425 int serial_getc(void)
427 return get_current()->getc();
431 * serial_tstc() - Test if data is available on currently selected serial port
433 * This function tests if one or more characters are available on
434 * currently selected serial port. This function never blocks. This
435 * function uses the get_current() call to determine which port is
438 * Returns positive if character is available, zero otherwise.
440 int serial_tstc(void)
442 return get_current()->tstc();
446 * serial_putc() - Output character via currently selected serial port
447 * @c: Single character to be output from the serial port.
449 * This function outputs a character via currently selected serial
450 * port. This character is passed to the serial port driver responsible
451 * for controlling the hardware. The hardware may still be in process
452 * of transmitting another character, therefore this function may block
453 * for a short amount of time. This function uses the get_current()
454 * call to determine which port is selected.
456 void serial_putc(const char c)
458 get_current()->putc(c);
462 * serial_puts() - Output string via currently selected serial port
463 * @s: Zero-terminated string to be output from the serial port.
465 * This function outputs a zero-terminated string via currently
466 * selected serial port. This function behaves as an accelerator
467 * in case the hardware can queue multiple characters for transfer.
468 * The whole string that is to be output is available to the function
469 * implementing the hardware manipulation. Transmitting the whole
470 * string may take some time, thus this function may block for some
471 * amount of time. This function uses the get_current() call to
472 * determine which port is selected.
474 void serial_puts(const char *s)
476 get_current()->puts(s);
480 * default_serial_puts() - Output string by calling serial_putc() in loop
481 * @s: Zero-terminated string to be output from the serial port.
483 * This function outputs a zero-terminated string by calling serial_putc()
484 * in a loop. Most drivers do not support queueing more than one byte for
485 * transfer, thus this function precisely implements their serial_puts().
487 * To optimize the number of get_current() calls, this function only
488 * calls get_current() once and then directly accesses the putc() call
489 * of the &struct serial_device .
491 void default_serial_puts(const char *s)
493 struct serial_device *dev = get_current();
498 #if CONFIG_POST & CONFIG_SYS_POST_UART
499 static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
502 * uart_post_test() - Test the currently selected serial port using POST
503 * @flags: POST framework flags
505 * Do a loopback test of the currently selected serial port. This
506 * function is only useful in the context of the POST testing framwork.
507 * The serial port is firstly configured into loopback mode and then
508 * characters are sent through it.
510 * Returns 0 on success, value otherwise.
512 /* Mark weak until post/cpu/.../uart.c migrate over */
514 int uart_post_test(int flags)
517 int ret, saved_baud, b;
518 struct serial_device *saved_dev, *s;
521 /* Save current serial state */
523 saved_dev = serial_current;
524 saved_baud = bd->bi_baudrate;
526 for (s = serial_devices; s; s = s->next) {
527 /* If this driver doesn't support loop back, skip it */
531 /* Test the next device */
538 /* Consume anything that happens to be queued */
539 while (serial_tstc())
542 /* Enable loop back */
545 /* Test every available baud rate */
546 for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
547 bd->bi_baudrate = bauds[b];
551 * Stick to printable chars to avoid issues:
552 * - terminal corruption
553 * - serial program reacting to sequences and sending
554 * back random extra data
555 * - most serial drivers add in extra chars (like \r\n)
557 for (c = 0x20; c < 0x7f; ++c) {
561 /* Make sure it's the same one */
562 ret = (c != serial_getc());
568 /* Clean up the output in case it was sent */
570 ret = ('\b' != serial_getc());
578 /* Disable loop back */
581 /* XXX: There is no serial_stop() !? */
587 /* Restore previous serial state */
588 serial_current = saved_dev;
589 bd->bi_baudrate = saved_baud;