blob: 95c992a5a30d0493669598d533e20dac2332b2c6 [file] [log] [blame]
wdenk7ac16102004-08-01 22:48:16 +00001/*
2 * (C) Copyright 2004
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
Wolfgang Denkd79de1d2013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenk7ac16102004-08-01 22:48:16 +00006 */
7
8#include <common.h>
Joe Hershberger3928bb62012-12-11 22:16:27 -06009#include <environment.h>
wdenk7ac16102004-08-01 22:48:16 +000010#include <serial.h>
Jean-Christophe PLAGNIOL-VILLARD2a7a0312009-05-16 12:14:54 +020011#include <stdio_dev.h>
Mike Frysinger078f2f12011-05-14 06:56:15 +000012#include <post.h>
13#include <linux/compiler.h>
Marek Vasut0e1b5772012-10-06 14:07:03 +000014#include <errno.h>
wdenk7ac16102004-08-01 22:48:16 +000015
Wolfgang Denk6405a152006-03-31 18:32:53 +020016DECLARE_GLOBAL_DATA_PTR;
17
Gerlando Falauto34148d62011-11-18 06:49:11 +000018static struct serial_device *serial_devices;
19static struct serial_device *serial_current;
Joe Hershberger3928bb62012-12-11 22:16:27 -060020/*
21 * Table with supported baudrates (defined in config_xyz.h)
22 */
23static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
wdenk7ac16102004-08-01 22:48:16 +000024
Marek Vasut95656ea2012-10-08 11:36:39 +000025/**
26 * serial_null() - Void registration routine of a serial driver
27 *
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
31 * U-Boot.
32 */
Marek Vasutf6af0482012-09-12 17:49:58 +020033static void serial_null(void)
34{
Joe Hershberger3928bb62012-12-11 22:16:27 -060035}
36
37/**
38 * on_baudrate() - Update the actual baudrate when the env var changes
39 *
40 * This will check for a valid baudrate and only apply it if valid.
41 */
42static int on_baudrate(const char *name, const char *value, enum env_op op,
43 int flags)
44{
45 int i;
46 int baudrate;
47
48 switch (op) {
49 case env_op_create:
50 case env_op_overwrite:
51 /*
52 * Switch to new baudrate if new baudrate is supported
53 */
54 baudrate = simple_strtoul(value, NULL, 10);
55
56 /* Not actually changing */
57 if (gd->baudrate == baudrate)
58 return 0;
59
Axel Linebca8732013-06-23 00:46:41 +080060 for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
Joe Hershberger3928bb62012-12-11 22:16:27 -060061 if (baudrate == baudrate_table[i])
62 break;
63 }
Axel Linebca8732013-06-23 00:46:41 +080064 if (i == ARRAY_SIZE(baudrate_table)) {
Joe Hershberger3928bb62012-12-11 22:16:27 -060065 if ((flags & H_FORCE) == 0)
66 printf("## Baudrate %d bps not supported\n",
67 baudrate);
68 return 1;
69 }
70 if ((flags & H_INTERACTIVE) != 0) {
71 printf("## Switch baudrate to %d"
72 " bps and press ENTER ...\n", baudrate);
73 udelay(50000);
74 }
75
76 gd->baudrate = baudrate;
Joe Hershberger3928bb62012-12-11 22:16:27 -060077
78 serial_setbrg();
79
80 udelay(50000);
81
82 if ((flags & H_INTERACTIVE) != 0)
83 while (1) {
84 if (getc() == '\r')
85 break;
86 }
87
88 return 0;
89 case env_op_delete:
90 printf("## Baudrate may not be deleted\n");
91 return 1;
92 default:
93 return 0;
94 }
Marek Vasutf6af0482012-09-12 17:49:58 +020095}
Joe Hershberger3928bb62012-12-11 22:16:27 -060096U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
Marek Vasutf6af0482012-09-12 17:49:58 +020097
Marek Vasut95656ea2012-10-08 11:36:39 +000098/**
99 * serial_initfunc() - Forward declare of driver registration routine
100 * @name: Name of the real driver registration routine.
101 *
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.
107 */
Marek Vasutf6af0482012-09-12 17:49:58 +0200108#define serial_initfunc(name) \
109 void name(void) \
110 __attribute__((weak, alias("serial_null")));
111
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100112serial_initfunc(altera_jtag_serial_initialize);
113serial_initfunc(altera_serial_initialize);
Marek Vasut42cde132012-09-13 12:27:37 +0200114serial_initfunc(amirix_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100115serial_initfunc(arc_serial_initialize);
116serial_initfunc(arm_dcc_initialize);
117serial_initfunc(asc_serial_initialize);
118serial_initfunc(atmel_serial_initialize);
119serial_initfunc(au1x00_serial_initialize);
120serial_initfunc(bfin_jtag_initialize);
121serial_initfunc(bfin_serial_initialize);
Marek Vasutbf5314b2012-09-13 12:28:07 +0200122serial_initfunc(bmw_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100123serial_initfunc(clps7111_serial_initialize);
Marek Vasutf7284022012-09-13 12:29:31 +0200124serial_initfunc(cogent_serial_initialize);
Marek Vasut7aa03ef2012-09-13 12:32:56 +0200125serial_initfunc(cpci750_serial_initialize);
Marek Vasutadede692012-09-13 12:33:50 +0200126serial_initfunc(evb64260_serial_initialize);
Marek Vasut9784bde2012-09-14 22:34:51 +0200127serial_initfunc(imx_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100128serial_initfunc(iop480_serial_initialize);
129serial_initfunc(jz_serial_initialize);
Marek Vasut5ee46562012-09-14 22:35:43 +0200130serial_initfunc(ks8695_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100131serial_initfunc(leon2_serial_initialize);
132serial_initfunc(leon3_serial_initialize);
Marek Vasut58177b72012-09-14 22:36:27 +0200133serial_initfunc(lh7a40x_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100134serial_initfunc(lpc32xx_serial_initialize);
135serial_initfunc(marvell_serial_initialize);
Marek Vasut00797862012-09-14 22:37:17 +0200136serial_initfunc(max3100_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100137serial_initfunc(mcf_serial_initialize);
138serial_initfunc(ml2_serial_initialize);
139serial_initfunc(mpc512x_serial_initialize);
140serial_initfunc(mpc5xx_serial_initialize);
141serial_initfunc(mpc8260_scc_serial_initialize);
142serial_initfunc(mpc8260_smc_serial_initialize);
143serial_initfunc(mpc85xx_serial_initialize);
144serial_initfunc(mpc8xx_serial_initialize);
Marek Vasut64c60552012-09-14 22:37:43 +0200145serial_initfunc(mxc_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100146serial_initfunc(mxs_auart_initialize);
147serial_initfunc(ns16550_serial_initialize);
148serial_initfunc(oc_serial_initialize);
149serial_initfunc(p3mx_serial_initialize);
Marek Vasut46e4d5f2012-09-14 22:38:46 +0200150serial_initfunc(pl01x_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100151serial_initfunc(pxa_serial_initialize);
152serial_initfunc(s3c24xx_serial_initialize);
153serial_initfunc(s5p_serial_initialize);
Marek Vasut0d19c022012-09-14 22:39:44 +0200154serial_initfunc(sa1100_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100155serial_initfunc(sandbox_serial_initialize);
156serial_initfunc(sconsole_serial_initialize);
Marek Vasut904d3d72012-09-14 22:40:08 +0200157serial_initfunc(sh_serial_initialize);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100158serial_initfunc(uartlite_serial_initialize);
159serial_initfunc(zynq_serial_initialize);
Marek Vasut419d8942012-09-12 13:50:56 +0200160
Marek Vasut95656ea2012-10-08 11:36:39 +0000161/**
162 * serial_register() - Register serial driver with serial driver core
163 * @dev: Pointer to the serial driver structure
164 *
165 * This function registers the serial driver supplied via @dev with
166 * serial driver core, thus making U-Boot aware of it and making it
167 * available for U-Boot to use. On platforms that still require manual
168 * relocation of constant variables, relocation of the supplied structure
169 * is performed.
170 */
Mike Frysingerffadc822011-04-29 18:03:30 +0000171void serial_register(struct serial_device *dev)
wdenk7ac16102004-08-01 22:48:16 +0000172{
Wolfgang Denkd0813e52010-10-28 20:00:11 +0200173#ifdef CONFIG_NEEDS_MANUAL_RELOC
Marek Vasut2206b342012-09-16 18:54:22 +0200174 if (dev->start)
175 dev->start += gd->reloc_off;
176 if (dev->stop)
177 dev->stop += gd->reloc_off;
178 if (dev->setbrg)
179 dev->setbrg += gd->reloc_off;
180 if (dev->getc)
181 dev->getc += gd->reloc_off;
182 if (dev->tstc)
183 dev->tstc += gd->reloc_off;
184 if (dev->putc)
185 dev->putc += gd->reloc_off;
186 if (dev->puts)
187 dev->puts += gd->reloc_off;
Peter Tyser9057cbf2009-09-21 11:20:36 -0500188#endif
wdenk7ac16102004-08-01 22:48:16 +0000189
190 dev->next = serial_devices;
191 serial_devices = dev;
wdenk7ac16102004-08-01 22:48:16 +0000192}
193
Marek Vasut95656ea2012-10-08 11:36:39 +0000194/**
195 * serial_initialize() - Register all compiled-in serial port drivers
196 *
197 * This function registers all serial port drivers that are compiled
198 * into the U-Boot binary with the serial core, thus making them
199 * available to U-Boot to use. Lastly, this function assigns a default
200 * serial port to the serial core. That serial port is then used as a
201 * default output.
202 */
Gerlando Falauto34148d62011-11-18 06:49:11 +0000203void serial_initialize(void)
wdenk7ac16102004-08-01 22:48:16 +0000204{
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100205 altera_jtag_serial_initialize();
206 altera_serial_initialize();
Marek Vasut42cde132012-09-13 12:27:37 +0200207 amirix_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100208 arc_serial_initialize();
209 arm_dcc_initialize();
210 asc_serial_initialize();
211 atmel_serial_initialize();
212 au1x00_serial_initialize();
213 bfin_jtag_initialize();
214 bfin_serial_initialize();
Marek Vasutbf5314b2012-09-13 12:28:07 +0200215 bmw_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100216 clps7111_serial_initialize();
Marek Vasutf7284022012-09-13 12:29:31 +0200217 cogent_serial_initialize();
Marek Vasut7aa03ef2012-09-13 12:32:56 +0200218 cpci750_serial_initialize();
Marek Vasutadede692012-09-13 12:33:50 +0200219 evb64260_serial_initialize();
Marek Vasut9784bde2012-09-14 22:34:51 +0200220 imx_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100221 iop480_serial_initialize();
222 jz_serial_initialize();
Marek Vasut5ee46562012-09-14 22:35:43 +0200223 ks8695_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100224 leon2_serial_initialize();
225 leon3_serial_initialize();
Marek Vasut58177b72012-09-14 22:36:27 +0200226 lh7a40x_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100227 lpc32xx_serial_initialize();
228 marvell_serial_initialize();
Marek Vasut00797862012-09-14 22:37:17 +0200229 max3100_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100230 mcf_serial_initialize();
231 ml2_serial_initialize();
232 mpc512x_serial_initialize();
233 mpc5xx_serial_initialize();
234 mpc8260_scc_serial_initialize();
235 mpc8260_smc_serial_initialize();
236 mpc85xx_serial_initialize();
237 mpc8xx_serial_initialize();
Marek Vasut64c60552012-09-14 22:37:43 +0200238 mxc_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100239 mxs_auart_initialize();
240 ns16550_serial_initialize();
241 oc_serial_initialize();
242 p3mx_serial_initialize();
Marek Vasut46e4d5f2012-09-14 22:38:46 +0200243 pl01x_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100244 pxa_serial_initialize();
245 s3c24xx_serial_initialize();
246 s5p_serial_initialize();
Marek Vasut0d19c022012-09-14 22:39:44 +0200247 sa1100_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100248 sandbox_serial_initialize();
249 sconsole_serial_initialize();
Marek Vasut904d3d72012-09-14 22:40:08 +0200250 sh_serial_initialize();
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100251 uartlite_serial_initialize();
252 zynq_serial_initialize();
Marek Vasut01f9ea82012-09-13 01:16:50 +0200253
Gerlando Falauto34148d62011-11-18 06:49:11 +0000254 serial_assign(default_serial_console()->name);
wdenk7ac16102004-08-01 22:48:16 +0000255}
256
Jeroen Hofstee169eda62014-10-08 22:57:44 +0200257static int serial_stub_start(struct stdio_dev *sdev)
Simon Glass0d1e1f72014-07-23 06:54:59 -0600258{
259 struct serial_device *dev = sdev->priv;
260
261 return dev->start();
262}
263
Jeroen Hofstee169eda62014-10-08 22:57:44 +0200264static int serial_stub_stop(struct stdio_dev *sdev)
Simon Glass0d1e1f72014-07-23 06:54:59 -0600265{
266 struct serial_device *dev = sdev->priv;
267
268 return dev->stop();
269}
270
Jeroen Hofstee169eda62014-10-08 22:57:44 +0200271static void serial_stub_putc(struct stdio_dev *sdev, const char ch)
Simon Glass0d1e1f72014-07-23 06:54:59 -0600272{
273 struct serial_device *dev = sdev->priv;
274
275 dev->putc(ch);
276}
277
Jeroen Hofstee169eda62014-10-08 22:57:44 +0200278static void serial_stub_puts(struct stdio_dev *sdev, const char *str)
Simon Glass0d1e1f72014-07-23 06:54:59 -0600279{
280 struct serial_device *dev = sdev->priv;
281
282 dev->puts(str);
283}
284
285int serial_stub_getc(struct stdio_dev *sdev)
286{
287 struct serial_device *dev = sdev->priv;
288
289 return dev->getc();
290}
291
292int serial_stub_tstc(struct stdio_dev *sdev)
293{
294 struct serial_device *dev = sdev->priv;
295
296 return dev->tstc();
297}
298
Marek Vasut95656ea2012-10-08 11:36:39 +0000299/**
300 * serial_stdio_init() - Register serial ports with STDIO core
301 *
302 * This function generates a proxy driver for each serial port driver.
303 * These proxy drivers then register with the STDIO core, making the
304 * serial drivers available as STDIO devices.
305 */
Gerlando Falauto34148d62011-11-18 06:49:11 +0000306void serial_stdio_init(void)
wdenk7ac16102004-08-01 22:48:16 +0000307{
Jean-Christophe PLAGNIOL-VILLARD2a7a0312009-05-16 12:14:54 +0200308 struct stdio_dev dev;
wdenk7ac16102004-08-01 22:48:16 +0000309 struct serial_device *s = serial_devices;
310
wdenk8f08c5b2004-10-11 22:43:02 +0000311 while (s) {
Gerlando Falauto34148d62011-11-18 06:49:11 +0000312 memset(&dev, 0, sizeof(dev));
wdenk7ac16102004-08-01 22:48:16 +0000313
Gerlando Falauto34148d62011-11-18 06:49:11 +0000314 strcpy(dev.name, s->name);
wdenk7ac16102004-08-01 22:48:16 +0000315 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
316
Simon Glass0d1e1f72014-07-23 06:54:59 -0600317 dev.start = serial_stub_start;
318 dev.stop = serial_stub_stop;
319 dev.putc = serial_stub_putc;
320 dev.puts = serial_stub_puts;
321 dev.getc = serial_stub_getc;
322 dev.tstc = serial_stub_tstc;
Simon Glassac2a14f2014-09-04 16:27:23 -0600323 dev.priv = s;
wdenk7ac16102004-08-01 22:48:16 +0000324
Gerlando Falauto34148d62011-11-18 06:49:11 +0000325 stdio_register(&dev);
wdenk7ac16102004-08-01 22:48:16 +0000326
327 s = s->next;
328 }
329}
330
Marek Vasut95656ea2012-10-08 11:36:39 +0000331/**
332 * serial_assign() - Select the serial output device by name
333 * @name: Name of the serial driver to be used as default output
334 *
335 * This function configures the serial output multiplexing by
336 * selecting which serial device will be used as default. In case
337 * the STDIO "serial" device is selected as stdin/stdout/stderr,
338 * the serial device previously configured by this function will be
339 * used for the particular operation.
340 *
341 * Returns 0 on success, negative on error.
342 */
Gerlando Falauto92999582011-11-18 06:49:12 +0000343int serial_assign(const char *name)
wdenk7ac16102004-08-01 22:48:16 +0000344{
345 struct serial_device *s;
346
wdenk8f08c5b2004-10-11 22:43:02 +0000347 for (s = serial_devices; s; s = s->next) {
Marek Vasut0e1b5772012-10-06 14:07:03 +0000348 if (strcmp(s->name, name))
349 continue;
350 serial_current = s;
351 return 0;
wdenk7ac16102004-08-01 22:48:16 +0000352 }
353
Marek Vasut0e1b5772012-10-06 14:07:03 +0000354 return -EINVAL;
wdenk7ac16102004-08-01 22:48:16 +0000355}
356
Marek Vasut95656ea2012-10-08 11:36:39 +0000357/**
358 * serial_reinit_all() - Reinitialize all compiled-in serial ports
359 *
360 * This function reinitializes all serial ports that are compiled
361 * into U-Boot by calling their serial_start() functions.
362 */
Gerlando Falauto34148d62011-11-18 06:49:11 +0000363void serial_reinit_all(void)
wdenk7ac16102004-08-01 22:48:16 +0000364{
365 struct serial_device *s;
366
Gerlando Falauto34148d62011-11-18 06:49:11 +0000367 for (s = serial_devices; s; s = s->next)
Marek Vasutb46931d2012-09-07 14:35:31 +0200368 s->start();
wdenk7ac16102004-08-01 22:48:16 +0000369}
370
Marek Vasut95656ea2012-10-08 11:36:39 +0000371/**
372 * get_current() - Return pointer to currently selected serial port
373 *
374 * This function returns a pointer to currently selected serial port.
375 * The currently selected serial port is altered by serial_assign()
376 * function.
377 *
378 * In case this function is called before relocation or before any serial
379 * port is configured, this function calls default_serial_console() to
380 * determine the serial port. Otherwise, the configured serial port is
381 * returned.
382 *
383 * Returns pointer to the currently selected serial port on success,
384 * NULL on error.
385 */
Simon Glass8f4e6f12011-08-19 11:09:43 +0000386static struct serial_device *get_current(void)
wdenk7ac16102004-08-01 22:48:16 +0000387{
Simon Glass8f4e6f12011-08-19 11:09:43 +0000388 struct serial_device *dev;
389
Marek Vasutbdad8072012-10-06 14:07:04 +0000390 if (!(gd->flags & GD_FLG_RELOC))
Simon Glass8f4e6f12011-08-19 11:09:43 +0000391 dev = default_serial_console();
Marek Vasutbdad8072012-10-06 14:07:04 +0000392 else if (!serial_current)
393 dev = default_serial_console();
394 else
395 dev = serial_current;
wdenk8f08c5b2004-10-11 22:43:02 +0000396
Marek Vasutbdad8072012-10-06 14:07:04 +0000397 /* We must have a console device */
398 if (!dev) {
Marek Vasuta6f63342012-09-15 10:33:51 +0200399#ifdef CONFIG_SPL_BUILD
Marek Vasutbdad8072012-10-06 14:07:04 +0000400 puts("Cannot find console\n");
401 hang();
Marek Vasuta6f63342012-09-15 10:33:51 +0200402#else
Marek Vasutbdad8072012-10-06 14:07:04 +0000403 panic("Cannot find console\n");
Marek Vasuta6f63342012-09-15 10:33:51 +0200404#endif
Marek Vasutbdad8072012-10-06 14:07:04 +0000405 }
406
Simon Glass8f4e6f12011-08-19 11:09:43 +0000407 return dev;
408}
wdenk7ac16102004-08-01 22:48:16 +0000409
Marek Vasut95656ea2012-10-08 11:36:39 +0000410/**
411 * serial_init() - Initialize currently selected serial port
412 *
413 * This function initializes the currently selected serial port. This
414 * usually involves setting up the registers of that particular port,
415 * enabling clock and such. This function uses the get_current() call
416 * to determine which port is selected.
417 *
418 * Returns 0 on success, negative on error.
419 */
Simon Glass8f4e6f12011-08-19 11:09:43 +0000420int serial_init(void)
421{
Simon Glassb9d5f6b2014-07-23 06:55:07 -0600422 gd->flags |= GD_FLG_SERIAL_READY;
Marek Vasutb46931d2012-09-07 14:35:31 +0200423 return get_current()->start();
wdenk7ac16102004-08-01 22:48:16 +0000424}
425
Marek Vasut95656ea2012-10-08 11:36:39 +0000426/**
427 * serial_setbrg() - Configure baud-rate of currently selected serial port
428 *
429 * This function configures the baud-rate of the currently selected
430 * serial port. The baud-rate is retrieved from global data within
431 * the serial port driver. This function uses the get_current() call
432 * to determine which port is selected.
433 *
434 * Returns 0 on success, negative on error.
435 */
Gerlando Falauto34148d62011-11-18 06:49:11 +0000436void serial_setbrg(void)
wdenk7ac16102004-08-01 22:48:16 +0000437{
Simon Glass8f4e6f12011-08-19 11:09:43 +0000438 get_current()->setbrg();
wdenk7ac16102004-08-01 22:48:16 +0000439}
440
Marek Vasut95656ea2012-10-08 11:36:39 +0000441/**
442 * serial_getc() - Read character from currently selected serial port
443 *
444 * This function retrieves a character from currently selected serial
445 * port. In case there is no character waiting on the serial port,
446 * this function will block and wait for the character to appear. This
447 * function uses the get_current() call to determine which port is
448 * selected.
449 *
450 * Returns the character on success, negative on error.
451 */
Gerlando Falauto34148d62011-11-18 06:49:11 +0000452int serial_getc(void)
wdenk7ac16102004-08-01 22:48:16 +0000453{
Simon Glass8f4e6f12011-08-19 11:09:43 +0000454 return get_current()->getc();
wdenk7ac16102004-08-01 22:48:16 +0000455}
456
Marek Vasut95656ea2012-10-08 11:36:39 +0000457/**
458 * serial_tstc() - Test if data is available on currently selected serial port
459 *
460 * This function tests if one or more characters are available on
461 * currently selected serial port. This function never blocks. This
462 * function uses the get_current() call to determine which port is
463 * selected.
464 *
465 * Returns positive if character is available, zero otherwise.
466 */
Gerlando Falauto34148d62011-11-18 06:49:11 +0000467int serial_tstc(void)
wdenk7ac16102004-08-01 22:48:16 +0000468{
Simon Glass8f4e6f12011-08-19 11:09:43 +0000469 return get_current()->tstc();
wdenk7ac16102004-08-01 22:48:16 +0000470}
471
Marek Vasut95656ea2012-10-08 11:36:39 +0000472/**
473 * serial_putc() - Output character via currently selected serial port
474 * @c: Single character to be output from the serial port.
475 *
476 * This function outputs a character via currently selected serial
477 * port. This character is passed to the serial port driver responsible
478 * for controlling the hardware. The hardware may still be in process
479 * of transmitting another character, therefore this function may block
480 * for a short amount of time. This function uses the get_current()
481 * call to determine which port is selected.
482 */
Gerlando Falauto34148d62011-11-18 06:49:11 +0000483void serial_putc(const char c)
wdenk7ac16102004-08-01 22:48:16 +0000484{
Simon Glass8f4e6f12011-08-19 11:09:43 +0000485 get_current()->putc(c);
wdenk7ac16102004-08-01 22:48:16 +0000486}
487
Marek Vasut95656ea2012-10-08 11:36:39 +0000488/**
489 * serial_puts() - Output string via currently selected serial port
490 * @s: Zero-terminated string to be output from the serial port.
491 *
492 * This function outputs a zero-terminated string via currently
493 * selected serial port. This function behaves as an accelerator
494 * in case the hardware can queue multiple characters for transfer.
495 * The whole string that is to be output is available to the function
496 * implementing the hardware manipulation. Transmitting the whole
497 * string may take some time, thus this function may block for some
498 * amount of time. This function uses the get_current() call to
499 * determine which port is selected.
500 */
Gerlando Falauto34148d62011-11-18 06:49:11 +0000501void serial_puts(const char *s)
wdenk7ac16102004-08-01 22:48:16 +0000502{
Simon Glass8f4e6f12011-08-19 11:09:43 +0000503 get_current()->puts(s);
wdenk7ac16102004-08-01 22:48:16 +0000504}
Mike Frysinger078f2f12011-05-14 06:56:15 +0000505
Marek Vasut95656ea2012-10-08 11:36:39 +0000506/**
507 * default_serial_puts() - Output string by calling serial_putc() in loop
508 * @s: Zero-terminated string to be output from the serial port.
509 *
510 * This function outputs a zero-terminated string by calling serial_putc()
511 * in a loop. Most drivers do not support queueing more than one byte for
512 * transfer, thus this function precisely implements their serial_puts().
513 *
514 * To optimize the number of get_current() calls, this function only
515 * calls get_current() once and then directly accesses the putc() call
516 * of the &struct serial_device .
517 */
Marek Vasut6b9124e2012-10-06 14:07:01 +0000518void default_serial_puts(const char *s)
519{
520 struct serial_device *dev = get_current();
521 while (*s)
522 dev->putc(*s++);
523}
524
Mike Frysinger078f2f12011-05-14 06:56:15 +0000525#if CONFIG_POST & CONFIG_SYS_POST_UART
526static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
527
Marek Vasut95656ea2012-10-08 11:36:39 +0000528/**
529 * uart_post_test() - Test the currently selected serial port using POST
530 * @flags: POST framework flags
531 *
532 * Do a loopback test of the currently selected serial port. This
533 * function is only useful in the context of the POST testing framwork.
534 * The serial port is firstly configured into loopback mode and then
535 * characters are sent through it.
536 *
537 * Returns 0 on success, value otherwise.
538 */
Mike Frysinger078f2f12011-05-14 06:56:15 +0000539/* Mark weak until post/cpu/.../uart.c migrate over */
540__weak
541int uart_post_test(int flags)
542{
543 unsigned char c;
544 int ret, saved_baud, b;
545 struct serial_device *saved_dev, *s;
Mike Frysinger078f2f12011-05-14 06:56:15 +0000546
547 /* Save current serial state */
548 ret = 0;
549 saved_dev = serial_current;
Masahiro Yamada197c7202014-04-04 20:09:58 +0900550 saved_baud = gd->baudrate;
Mike Frysinger078f2f12011-05-14 06:56:15 +0000551
552 for (s = serial_devices; s; s = s->next) {
553 /* If this driver doesn't support loop back, skip it */
554 if (!s->loop)
555 continue;
556
557 /* Test the next device */
558 serial_current = s;
559
560 ret = serial_init();
561 if (ret)
562 goto done;
563
564 /* Consume anything that happens to be queued */
565 while (serial_tstc())
566 serial_getc();
567
568 /* Enable loop back */
569 s->loop(1);
570
571 /* Test every available baud rate */
572 for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
Masahiro Yamada197c7202014-04-04 20:09:58 +0900573 gd->baudrate = bauds[b];
Mike Frysinger078f2f12011-05-14 06:56:15 +0000574 serial_setbrg();
575
576 /*
577 * Stick to printable chars to avoid issues:
578 * - terminal corruption
579 * - serial program reacting to sequences and sending
580 * back random extra data
581 * - most serial drivers add in extra chars (like \r\n)
582 */
583 for (c = 0x20; c < 0x7f; ++c) {
584 /* Send it out */
585 serial_putc(c);
586
587 /* Make sure it's the same one */
588 ret = (c != serial_getc());
589 if (ret) {
590 s->loop(0);
591 goto done;
592 }
593
594 /* Clean up the output in case it was sent */
595 serial_putc('\b');
596 ret = ('\b' != serial_getc());
597 if (ret) {
598 s->loop(0);
599 goto done;
600 }
601 }
602 }
603
604 /* Disable loop back */
605 s->loop(0);
606
Marek Vasutb46931d2012-09-07 14:35:31 +0200607 /* XXX: There is no serial_stop() !? */
608 if (s->stop)
609 s->stop();
Mike Frysinger078f2f12011-05-14 06:56:15 +0000610 }
611
612 done:
613 /* Restore previous serial state */
614 serial_current = saved_dev;
Masahiro Yamada197c7202014-04-04 20:09:58 +0900615 gd->baudrate = saved_baud;
Mike Frysinger078f2f12011-05-14 06:56:15 +0000616 serial_reinit_all();
617 serial_setbrg();
618
619 return ret;
620}
621#endif