[people/ms/u-boot.git] / drivers / serial / serial.c

/*
 * (C) Copyright 2004
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <common.h>
#include <environment.h>
#include <serial.h>
#include <stdio_dev.h>
#include <post.h>
#include <linux/compiler.h>
#include <errno.h>

DECLARE_GLOBAL_DATA_PTR;

static struct serial_device *serial_devices;
static struct serial_device *serial_current;
/*
 * Table with supported baudrates (defined in config_xyz.h)
 */
static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;

/**
 * serial_null() - Void registration routine of a serial driver
 *
 * This routine implements a void registration routine of a serial
 * driver. The registration routine of a particular driver is aliased
 * to this empty function in case the driver is not compiled into
 * U-Boot.
 */
static void serial_null(void)
{
}

/**
 * on_baudrate() - Update the actual baudrate when the env var changes
 *
 * This will check for a valid baudrate and only apply it if valid.
 */
static int on_baudrate(const char *name, const char *value, enum env_op op,
	int flags)
{
	int i;
	int baudrate;

	switch (op) {
	case env_op_create:
	case env_op_overwrite:
		/*
		 * Switch to new baudrate if new baudrate is supported
		 */
		baudrate = simple_strtoul(value, NULL, 10);

		/* Not actually changing */
		if (gd->baudrate == baudrate)
			return 0;

		for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
			if (baudrate == baudrate_table[i])
				break;
		}
		if (i == ARRAY_SIZE(baudrate_table)) {
			if ((flags & H_FORCE) == 0)
				printf("## Baudrate %d bps not supported\n",
					baudrate);
			return 1;
		}
		if ((flags & H_INTERACTIVE) != 0) {
			printf("## Switch baudrate to %d"
				" bps and press ENTER ...\n", baudrate);
			udelay(50000);
		}

		gd->baudrate = baudrate;
#if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
		gd->bd->bi_baudrate = baudrate;
#endif

		serial_setbrg();

		udelay(50000);

		if ((flags & H_INTERACTIVE) != 0)
			while (1) {
				if (getc() == '\r')
					break;
			}

		return 0;
	case env_op_delete:
		printf("## Baudrate may not be deleted\n");
		return 1;
	default:
		return 0;
	}
}
U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);

/**
 * serial_initfunc() - Forward declare of driver registration routine
 * @name:	Name of the real driver registration routine.
 *
 * This macro expands onto forward declaration of a driver registration
 * routine, which is then used below in serial_initialize() function.
 * The declaration is made weak and aliases to serial_null() so in case
 * the driver is not compiled in, the function is still declared and can
 * be used, but aliases to serial_null() and thus is optimized away.
 */
#define serial_initfunc(name)					\
	void name(void)						\
		__attribute__((weak, alias("serial_null")));

serial_initfunc(mpc8xx_serial_initialize);
serial_initfunc(ns16550_serial_initialize);
serial_initfunc(pxa_serial_initialize);
serial_initfunc(s3c24xx_serial_initialize);
serial_initfunc(s5p_serial_initialize);
serial_initfunc(zynq_serial_initalize);
serial_initfunc(bfin_serial_initialize);
serial_initfunc(bfin_jtag_initialize);
serial_initfunc(mpc512x_serial_initialize);
serial_initfunc(uartlite_serial_initialize);
serial_initfunc(au1x00_serial_initialize);
serial_initfunc(asc_serial_initialize);
serial_initfunc(jz_serial_initialize);
serial_initfunc(mpc5xx_serial_initialize);
serial_initfunc(mpc8260_scc_serial_initialize);
serial_initfunc(mpc8260_smc_serial_initialize);
serial_initfunc(mpc85xx_serial_initialize);
serial_initfunc(iop480_serial_initialize);
serial_initfunc(leon2_serial_initialize);
serial_initfunc(leon3_serial_initialize);
serial_initfunc(marvell_serial_initialize);
serial_initfunc(amirix_serial_initialize);
serial_initfunc(bmw_serial_initialize);
serial_initfunc(cogent_serial_initialize);
serial_initfunc(cpci750_serial_initialize);
serial_initfunc(evb64260_serial_initialize);
serial_initfunc(ml2_serial_initialize);
serial_initfunc(sconsole_serial_initialize);
serial_initfunc(p3mx_serial_initialize);
serial_initfunc(altera_jtag_serial_initialize);
serial_initfunc(altera_serial_initialize);
serial_initfunc(atmel_serial_initialize);
serial_initfunc(lpc32xx_serial_initialize);
serial_initfunc(mcf_serial_initialize);
serial_initfunc(oc_serial_initialize);
serial_initfunc(sandbox_serial_initialize);
serial_initfunc(clps7111_serial_initialize);
serial_initfunc(imx_serial_initialize);
serial_initfunc(ixp_serial_initialize);
serial_initfunc(ks8695_serial_initialize);
serial_initfunc(lh7a40x_serial_initialize);
serial_initfunc(max3100_serial_initialize);
serial_initfunc(mxc_serial_initialize);
serial_initfunc(pl01x_serial_initialize);
serial_initfunc(sa1100_serial_initialize);
serial_initfunc(sh_serial_initialize);
serial_initfunc(arm_dcc_initialize);
serial_initfunc(mxs_auart_initialize);
serial_initfunc(arc_serial_initialize);

/**
 * serial_register() - Register serial driver with serial driver core
 * @dev:	Pointer to the serial driver structure
 *
 * This function registers the serial driver supplied via @dev with
 * serial driver core, thus making U-Boot aware of it and making it
 * available for U-Boot to use. On platforms that still require manual
 * relocation of constant variables, relocation of the supplied structure
 * is performed.
 */
void serial_register(struct serial_device *dev)
{
#ifdef CONFIG_NEEDS_MANUAL_RELOC
	if (dev->start)
		dev->start += gd->reloc_off;
	if (dev->stop)
		dev->stop += gd->reloc_off;
	if (dev->setbrg)
		dev->setbrg += gd->reloc_off;
	if (dev->getc)
		dev->getc += gd->reloc_off;
	if (dev->tstc)
		dev->tstc += gd->reloc_off;
	if (dev->putc)
		dev->putc += gd->reloc_off;
	if (dev->puts)
		dev->puts += gd->reloc_off;
#endif

	dev->next = serial_devices;
	serial_devices = dev;
}

/**
 * serial_initialize() - Register all compiled-in serial port drivers
 *
 * This function registers all serial port drivers that are compiled
 * into the U-Boot binary with the serial core, thus making them
 * available to U-Boot to use. Lastly, this function assigns a default
 * serial port to the serial core. That serial port is then used as a
 * default output.
 */
void serial_initialize(void)
{
	mpc8xx_serial_initialize();
	ns16550_serial_initialize();
	pxa_serial_initialize();
	s3c24xx_serial_initialize();
	s5p_serial_initialize();
	mpc512x_serial_initialize();
	bfin_serial_initialize();
	bfin_jtag_initialize();
	uartlite_serial_initialize();
	zynq_serial_initalize();
	au1x00_serial_initialize();
	asc_serial_initialize();
	jz_serial_initialize();
	mpc5xx_serial_initialize();
	mpc8260_scc_serial_initialize();
	mpc8260_smc_serial_initialize();
	mpc85xx_serial_initialize();
	iop480_serial_initialize();
	leon2_serial_initialize();
	leon3_serial_initialize();
	marvell_serial_initialize();
	amirix_serial_initialize();
	bmw_serial_initialize();
	cogent_serial_initialize();
	cpci750_serial_initialize();
	evb64260_serial_initialize();
	ml2_serial_initialize();
	sconsole_serial_initialize();
	p3mx_serial_initialize();
	altera_jtag_serial_initialize();
	altera_serial_initialize();
	atmel_serial_initialize();
	lpc32xx_serial_initialize();
	mcf_serial_initialize();
	oc_serial_initialize();
	sandbox_serial_initialize();
	clps7111_serial_initialize();
	imx_serial_initialize();
	ixp_serial_initialize();
	ks8695_serial_initialize();
	lh7a40x_serial_initialize();
	max3100_serial_initialize();
	mxc_serial_initialize();
	pl01x_serial_initialize();
	sa1100_serial_initialize();
	sh_serial_initialize();
	arm_dcc_initialize();
	mxs_auart_initialize();
	arc_serial_initialize();

	serial_assign(default_serial_console()->name);
}

/**
 * serial_stdio_init() - Register serial ports with STDIO core
 *
 * This function generates a proxy driver for each serial port driver.
 * These proxy drivers then register with the STDIO core, making the
 * serial drivers available as STDIO devices.
 */
void serial_stdio_init(void)
{
	struct stdio_dev dev;
	struct serial_device *s = serial_devices;

	while (s) {
		memset(&dev, 0, sizeof(dev));

		strcpy(dev.name, s->name);
		dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;

		dev.start = s->start;
		dev.stop = s->stop;
		dev.putc = s->putc;
		dev.puts = s->puts;
		dev.getc = s->getc;
		dev.tstc = s->tstc;

		stdio_register(&dev);

		s = s->next;
	}
}

/**
 * serial_assign() - Select the serial output device by name
 * @name:	Name of the serial driver to be used as default output
 *
 * This function configures the serial output multiplexing by
 * selecting which serial device will be used as default. In case
 * the STDIO "serial" device is selected as stdin/stdout/stderr,
 * the serial device previously configured by this function will be
 * used for the particular operation.
 *
 * Returns 0 on success, negative on error.
 */
int serial_assign(const char *name)
{
	struct serial_device *s;

	for (s = serial_devices; s; s = s->next) {
		if (strcmp(s->name, name))
			continue;
		serial_current = s;
		return 0;
	}

	return -EINVAL;
}

/**
 * serial_reinit_all() - Reinitialize all compiled-in serial ports
 *
 * This function reinitializes all serial ports that are compiled
 * into U-Boot by calling their serial_start() functions.
 */
void serial_reinit_all(void)
{
	struct serial_device *s;

	for (s = serial_devices; s; s = s->next)
		s->start();
}

/**
 * get_current() - Return pointer to currently selected serial port
 *
 * This function returns a pointer to currently selected serial port.
 * The currently selected serial port is altered by serial_assign()
 * function.
 *
 * In case this function is called before relocation or before any serial
 * port is configured, this function calls default_serial_console() to
 * determine the serial port. Otherwise, the configured serial port is
 * returned.
 *
 * Returns pointer to the currently selected serial port on success,
 * NULL on error.
 */
static struct serial_device *get_current(void)
{
	struct serial_device *dev;

	if (!(gd->flags & GD_FLG_RELOC))
		dev = default_serial_console();
	else if (!serial_current)
		dev = default_serial_console();
	else
		dev = serial_current;

	/* We must have a console device */
	if (!dev) {
#ifdef CONFIG_SPL_BUILD
		puts("Cannot find console\n");
		hang();
#else
		panic("Cannot find console\n");
#endif
	}

	return dev;
}

/**
 * serial_init() - Initialize currently selected serial port
 *
 * This function initializes the currently selected serial port. This
 * usually involves setting up the registers of that particular port,
 * enabling clock and such. This function uses the get_current() call
 * to determine which port is selected.
 *
 * Returns 0 on success, negative on error.
 */
int serial_init(void)
{
	return get_current()->start();
}

/**
 * serial_setbrg() - Configure baud-rate of currently selected serial port
 *
 * This function configures the baud-rate of the currently selected
 * serial port. The baud-rate is retrieved from global data within
 * the serial port driver. This function uses the get_current() call
 * to determine which port is selected.
 *
 * Returns 0 on success, negative on error.
 */
void serial_setbrg(void)
{
	get_current()->setbrg();
}

/**
 * serial_getc() - Read character from currently selected serial port
 *
 * This function retrieves a character from currently selected serial
 * port. In case there is no character waiting on the serial port,
 * this function will block and wait for the character to appear. This
 * function uses the get_current() call to determine which port is
 * selected.
 *
 * Returns the character on success, negative on error.
 */
int serial_getc(void)
{
	return get_current()->getc();
}

/**
 * serial_tstc() - Test if data is available on currently selected serial port
 *
 * This function tests if one or more characters are available on
 * currently selected serial port. This function never blocks. This
 * function uses the get_current() call to determine which port is
 * selected.
 *
 * Returns positive if character is available, zero otherwise.
 */
int serial_tstc(void)
{
	return get_current()->tstc();
}

/**
 * serial_putc() - Output character via currently selected serial port
 * @c:	Single character to be output from the serial port.
 *
 * This function outputs a character via currently selected serial
 * port. This character is passed to the serial port driver responsible
 * for controlling the hardware. The hardware may still be in process
 * of transmitting another character, therefore this function may block
 * for a short amount of time. This function uses the get_current()
 * call to determine which port is selected.
 */
void serial_putc(const char c)
{
	get_current()->putc(c);
}

/**
 * serial_puts() - Output string via currently selected serial port
 * @s:	Zero-terminated string to be output from the serial port.
 *
 * This function outputs a zero-terminated string via currently
 * selected serial port. This function behaves as an accelerator
 * in case the hardware can queue multiple characters for transfer.
 * The whole string that is to be output is available to the function
 * implementing the hardware manipulation. Transmitting the whole
 * string may take some time, thus this function may block for some
 * amount of time. This function uses the get_current() call to
 * determine which port is selected.
 */
void serial_puts(const char *s)
{
	get_current()->puts(s);
}

/**
 * default_serial_puts() - Output string by calling serial_putc() in loop
 * @s:	Zero-terminated string to be output from the serial port.
 *
 * This function outputs a zero-terminated string by calling serial_putc()
 * in a loop. Most drivers do not support queueing more than one byte for
 * transfer, thus this function precisely implements their serial_puts().
 *
 * To optimize the number of get_current() calls, this function only
 * calls get_current() once and then directly accesses the putc() call
 * of the &struct serial_device .
 */
void default_serial_puts(const char *s)
{
	struct serial_device *dev = get_current();
	while (*s)
		dev->putc(*s++);
}

#if CONFIG_POST & CONFIG_SYS_POST_UART
static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;

/**
 * uart_post_test() - Test the currently selected serial port using POST
 * @flags:	POST framework flags
 *
 * Do a loopback test of the currently selected serial port. This
 * function is only useful in the context of the POST testing framwork.
 * The serial port is firstly configured into loopback mode and then
 * characters are sent through it.
 *
 * Returns 0 on success, value otherwise.
 */
/* Mark weak until post/cpu/.../uart.c migrate over */
__weak
int uart_post_test(int flags)
{
	unsigned char c;
	int ret, saved_baud, b;
	struct serial_device *saved_dev, *s;
	bd_t *bd = gd->bd;

	/* Save current serial state */
	ret = 0;
	saved_dev = serial_current;
	saved_baud = bd->bi_baudrate;

	for (s = serial_devices; s; s = s->next) {
		/* If this driver doesn't support loop back, skip it */
		if (!s->loop)
			continue;

		/* Test the next device */
		serial_current = s;

		ret = serial_init();
		if (ret)
			goto done;

		/* Consume anything that happens to be queued */
		while (serial_tstc())
			serial_getc();

		/* Enable loop back */
		s->loop(1);

		/* Test every available baud rate */
		for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
			bd->bi_baudrate = bauds[b];
			serial_setbrg();

			/*
			 * Stick to printable chars to avoid issues:
			 *  - terminal corruption
			 *  - serial program reacting to sequences and sending
			 *    back random extra data
			 *  - most serial drivers add in extra chars (like \r\n)
			 */
			for (c = 0x20; c < 0x7f; ++c) {
				/* Send it out */
				serial_putc(c);

				/* Make sure it's the same one */
				ret = (c != serial_getc());
				if (ret) {
					s->loop(0);
					goto done;
				}

				/* Clean up the output in case it was sent */
				serial_putc('\b');
				ret = ('\b' != serial_getc());
				if (ret) {
					s->loop(0);
					goto done;
				}
			}
		}

		/* Disable loop back */
		s->loop(0);

		/* XXX: There is no serial_stop() !? */
		if (s->stop)
			s->stop();
	}

 done:
	/* Restore previous serial state */
	serial_current = saved_dev;
	bd->bi_baudrate = saved_baud;
	serial_reinit_all();
	serial_setbrg();

	return ret;
}
#endif
Commit	Line	Data
281e00a3 WD	1	/*
	2	* (C) Copyright 2004
	3	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
	4	*
1a459660	5	* SPDX-License-Identifier: GPL-2.0+
281e00a3 WD	6	*/
	7
	8	#include <common.h>
32057717	9	#include <environment.h>
281e00a3	10	#include <serial.h>
52cb4d4f	11	#include <stdio_dev.h>
7b826c2f MF	12	#include <post.h>
7b826c2f MF	13	#include <linux/compiler.h>
6d93e258	14	#include <errno.h>
281e00a3	15
d87080b7 WD	16	DECLARE_GLOBAL_DATA_PTR;
d87080b7 WD	17
a6e6f7f4 GF	18	static struct serial_device *serial_devices;
a6e6f7f4 GF	19	static struct serial_device *serial_current;
32057717 JH	20	/*
	21	* Table with supported baudrates (defined in config_xyz.h)
	22	*/
	23	static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
281e00a3	24
9cd2b9e4 MV	25	/**
	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	*/
2a333aeb MV	33	static void serial_null(void)
	34	{
	35	}
	36
32057717 JH	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	*/
	42	static 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
9935175f	60	for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
32057717 JH	61	if (baudrate == baudrate_table[i])
	62	break;
	63	}
9935175f	64	if (i == ARRAY_SIZE(baudrate_table)) {
32057717 JH	65	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;
	77	#if defined(CONFIG_PPC) \|\| defined(CONFIG_MCF52x2)
	78	gd->bd->bi_baudrate = baudrate;
	79	#endif
	80
	81	serial_setbrg();
	82
	83	udelay(50000);
	84
	85	if ((flags & H_INTERACTIVE) != 0)
	86	while (1) {
	87	if (getc() == '\r')
	88	break;
	89	}
	90
	91	return 0;
	92	case env_op_delete:
	93	printf("## Baudrate may not be deleted\n");
	94	return 1;
	95	default:
	96	return 0;
	97	}
	98	}
	99	U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
	100
9cd2b9e4 MV	101	/**
	102	* serial_initfunc() - Forward declare of driver registration routine
	103	* @name: Name of the real driver registration routine.
	104	*
	105	* This macro expands onto forward declaration of a driver registration
	106	* routine, which is then used below in serial_initialize() function.
	107	* The declaration is made weak and aliases to serial_null() so in case
	108	* the driver is not compiled in, the function is still declared and can
	109	* be used, but aliases to serial_null() and thus is optimized away.
	110	*/
2a333aeb MV	111	#define serial_initfunc(name) \
	112	void name(void) \
	113	__attribute__((weak, alias("serial_null")));
	114
f0eb1f61	115	serial_initfunc(mpc8xx_serial_initialize);
abc0ed8d	116	serial_initfunc(ns16550_serial_initialize);
1fe5c110	117	serial_initfunc(pxa_serial_initialize);
28af6385	118	serial_initfunc(s3c24xx_serial_initialize);
b4980515	119	serial_initfunc(s5p_serial_initialize);
51d8102f	120	serial_initfunc(zynq_serial_initalize);
5ae1de0d	121	serial_initfunc(bfin_serial_initialize);
41651cab	122	serial_initfunc(bfin_jtag_initialize);
918327c8	123	serial_initfunc(mpc512x_serial_initialize);
87d69229	124	serial_initfunc(uartlite_serial_initialize);
7b953c51	125	serial_initfunc(au1x00_serial_initialize);
01911422	126	serial_initfunc(asc_serial_initialize);
6cb3273d	127	serial_initfunc(jz_serial_initialize);
b57c6528	128	serial_initfunc(mpc5xx_serial_initialize);
d68f4da2 MV	129	serial_initfunc(mpc8260_scc_serial_initialize);
d68f4da2 MV	130	serial_initfunc(mpc8260_smc_serial_initialize);
7a311546	131	serial_initfunc(mpc85xx_serial_initialize);
fcc2074d	132	serial_initfunc(iop480_serial_initialize);
af7be3b6	133	serial_initfunc(leon2_serial_initialize);
29b5ff7f	134	serial_initfunc(leon3_serial_initialize);
afe4c389	135	serial_initfunc(marvell_serial_initialize);
5dee6f55	136	serial_initfunc(amirix_serial_initialize);
c45a14ad	137	serial_initfunc(bmw_serial_initialize);
d25c39d3	138	serial_initfunc(cogent_serial_initialize);
619c90bb	139	serial_initfunc(cpci750_serial_initialize);
829b3b2e	140	serial_initfunc(evb64260_serial_initialize);
d126f285	141	serial_initfunc(ml2_serial_initialize);
26d8eaaa	142	serial_initfunc(sconsole_serial_initialize);
088a4f3c	143	serial_initfunc(p3mx_serial_initialize);
8c085757	144	serial_initfunc(altera_jtag_serial_initialize);
b207d645	145	serial_initfunc(altera_serial_initialize);
cfba4573	146	serial_initfunc(atmel_serial_initialize);
e503f90a	147	serial_initfunc(lpc32xx_serial_initialize);
abaef69f	148	serial_initfunc(mcf_serial_initialize);
69ea8070	149	serial_initfunc(oc_serial_initialize);
cef46b77	150	serial_initfunc(sandbox_serial_initialize);
8b029db8	151	serial_initfunc(clps7111_serial_initialize);
7882e7c1	152	serial_initfunc(imx_serial_initialize);
b6cd0fef	153	serial_initfunc(ixp_serial_initialize);
a7ffb2fc	154	serial_initfunc(ks8695_serial_initialize);
1f673b4f	155	serial_initfunc(lh7a40x_serial_initialize);
7cd851a5	156	serial_initfunc(max3100_serial_initialize);
a943472c	157	serial_initfunc(mxc_serial_initialize);
39f61477	158	serial_initfunc(pl01x_serial_initialize);
a30a4220	159	serial_initfunc(sa1100_serial_initialize);
8bdd7efa	160	serial_initfunc(sh_serial_initialize);
a168d3af	161	serial_initfunc(arm_dcc_initialize);
661edaaf	162	serial_initfunc(mxs_auart_initialize);
22a240c3	163	serial_initfunc(arc_serial_initialize);
f0eb1f61	164
9cd2b9e4 MV	165	/**
	166	* serial_register() - Register serial driver with serial driver core
	167	* @dev: Pointer to the serial driver structure
	168	*
	169	* This function registers the serial driver supplied via @dev with
	170	* serial driver core, thus making U-Boot aware of it and making it
	171	* available for U-Boot to use. On platforms that still require manual
	172	* relocation of constant variables, relocation of the supplied structure
	173	* is performed.
	174	*/
c52b4f79	175	void serial_register(struct serial_device *dev)
281e00a3	176	{
2e5167cc	177	#ifdef CONFIG_NEEDS_MANUAL_RELOC
f2760c4a MV	178	if (dev->start)
	179	dev->start += gd->reloc_off;
	180	if (dev->stop)
	181	dev->stop += gd->reloc_off;
	182	if (dev->setbrg)
	183	dev->setbrg += gd->reloc_off;
	184	if (dev->getc)
	185	dev->getc += gd->reloc_off;
	186	if (dev->tstc)
	187	dev->tstc += gd->reloc_off;
	188	if (dev->putc)
	189	dev->putc += gd->reloc_off;
	190	if (dev->puts)
	191	dev->puts += gd->reloc_off;
521af04d	192	#endif
281e00a3 WD	193
	194	dev->next = serial_devices;
	195	serial_devices = dev;
281e00a3 WD	196	}
281e00a3 WD	197
9cd2b9e4 MV	198	/**
	199	* serial_initialize() - Register all compiled-in serial port drivers
	200	*
	201	* This function registers all serial port drivers that are compiled
	202	* into the U-Boot binary with the serial core, thus making them
	203	* available to U-Boot to use. Lastly, this function assigns a default
	204	* serial port to the serial core. That serial port is then used as a
	205	* default output.
	206	*/
a6e6f7f4	207	void serial_initialize(void)
281e00a3	208	{
f0eb1f61	209	mpc8xx_serial_initialize();
abc0ed8d	210	ns16550_serial_initialize();
1fe5c110	211	pxa_serial_initialize();
28af6385	212	s3c24xx_serial_initialize();
b4980515	213	s5p_serial_initialize();
918327c8	214	mpc512x_serial_initialize();
5ae1de0d	215	bfin_serial_initialize();
41651cab	216	bfin_jtag_initialize();
87d69229	217	uartlite_serial_initialize();
51d8102f	218	zynq_serial_initalize();
7b953c51	219	au1x00_serial_initialize();
01911422	220	asc_serial_initialize();
6cb3273d	221	jz_serial_initialize();
b57c6528	222	mpc5xx_serial_initialize();
d68f4da2 MV	223	mpc8260_scc_serial_initialize();
d68f4da2 MV	224	mpc8260_smc_serial_initialize();
7a311546	225	mpc85xx_serial_initialize();
fcc2074d	226	iop480_serial_initialize();
af7be3b6	227	leon2_serial_initialize();
29b5ff7f	228	leon3_serial_initialize();
afe4c389	229	marvell_serial_initialize();
5dee6f55	230	amirix_serial_initialize();
c45a14ad	231	bmw_serial_initialize();
d25c39d3	232	cogent_serial_initialize();
619c90bb	233	cpci750_serial_initialize();
829b3b2e	234	evb64260_serial_initialize();
d126f285	235	ml2_serial_initialize();
26d8eaaa	236	sconsole_serial_initialize();
088a4f3c	237	p3mx_serial_initialize();
8c085757	238	altera_jtag_serial_initialize();
b207d645	239	altera_serial_initialize();
cfba4573	240	atmel_serial_initialize();
e503f90a	241	lpc32xx_serial_initialize();
abaef69f	242	mcf_serial_initialize();
69ea8070	243	oc_serial_initialize();
cef46b77	244	sandbox_serial_initialize();
8b029db8	245	clps7111_serial_initialize();
7882e7c1	246	imx_serial_initialize();
b6cd0fef	247	ixp_serial_initialize();
a7ffb2fc	248	ks8695_serial_initialize();
1f673b4f	249	lh7a40x_serial_initialize();
7cd851a5	250	max3100_serial_initialize();
a943472c	251	mxc_serial_initialize();
39f61477	252	pl01x_serial_initialize();
a30a4220	253	sa1100_serial_initialize();
8bdd7efa	254	sh_serial_initialize();
a168d3af	255	arm_dcc_initialize();
661edaaf	256	mxs_auart_initialize();
22a240c3	257	arc_serial_initialize();
7b953c51	258
a6e6f7f4	259	serial_assign(default_serial_console()->name);
281e00a3 WD	260	}
281e00a3 WD	261
9cd2b9e4 MV	262	/**
	263	* serial_stdio_init() - Register serial ports with STDIO core
	264	*
	265	* This function generates a proxy driver for each serial port driver.
	266	* These proxy drivers then register with the STDIO core, making the
	267	* serial drivers available as STDIO devices.
	268	*/
a6e6f7f4	269	void serial_stdio_init(void)
281e00a3	270	{
52cb4d4f	271	struct stdio_dev dev;
281e00a3 WD	272	struct serial_device *s = serial_devices;
281e00a3 WD	273
2ee66533	274	while (s) {
a6e6f7f4	275	memset(&dev, 0, sizeof(dev));
281e00a3	276
a6e6f7f4	277	strcpy(dev.name, s->name);
281e00a3 WD	278	dev.flags = DEV_FLAGS_OUTPUT \| DEV_FLAGS_INPUT;
281e00a3 WD	279
89143fb3 MV	280	dev.start = s->start;
89143fb3 MV	281	dev.stop = s->stop;
281e00a3 WD	282	dev.putc = s->putc;
	283	dev.puts = s->puts;
	284	dev.getc = s->getc;
	285	dev.tstc = s->tstc;
	286
a6e6f7f4	287	stdio_register(&dev);
281e00a3 WD	288
	289	s = s->next;
	290	}
	291	}
	292
9cd2b9e4 MV	293	/**
	294	* serial_assign() - Select the serial output device by name
	295	* @name: Name of the serial driver to be used as default output
	296	*
	297	* This function configures the serial output multiplexing by
	298	* selecting which serial device will be used as default. In case
	299	* the STDIO "serial" device is selected as stdin/stdout/stderr,
	300	* the serial device previously configured by this function will be
	301	* used for the particular operation.
	302	*
	303	* Returns 0 on success, negative on error.
	304	*/
7813ca9b	305	int serial_assign(const char *name)
281e00a3 WD	306	{
	307	struct serial_device *s;
	308
2ee66533	309	for (s = serial_devices; s; s = s->next) {
6d93e258 MV	310	if (strcmp(s->name, name))
	311	continue;
	312	serial_current = s;
	313	return 0;
281e00a3 WD	314	}
281e00a3 WD	315
6d93e258	316	return -EINVAL;
281e00a3 WD	317	}
281e00a3 WD	318
9cd2b9e4 MV	319	/**
	320	* serial_reinit_all() - Reinitialize all compiled-in serial ports
	321	*
	322	* This function reinitializes all serial ports that are compiled
	323	* into U-Boot by calling their serial_start() functions.
	324	*/
a6e6f7f4	325	void serial_reinit_all(void)
281e00a3 WD	326	{
	327	struct serial_device *s;
	328
a6e6f7f4	329	for (s = serial_devices; s; s = s->next)
89143fb3	330	s->start();
281e00a3 WD	331	}
281e00a3 WD	332
9cd2b9e4 MV	333	/**
	334	* get_current() - Return pointer to currently selected serial port
	335	*
	336	* This function returns a pointer to currently selected serial port.
	337	* The currently selected serial port is altered by serial_assign()
	338	* function.
	339	*
	340	* In case this function is called before relocation or before any serial
	341	* port is configured, this function calls default_serial_console() to
	342	* determine the serial port. Otherwise, the configured serial port is
	343	* returned.
	344	*
	345	* Returns pointer to the currently selected serial port on success,
	346	* NULL on error.
	347	*/
857c283e	348	static struct serial_device *get_current(void)
281e00a3	349	{
857c283e	350	struct serial_device *dev;
2ee66533	351
dee19416	352	if (!(gd->flags & GD_FLG_RELOC))
857c283e	353	dev = default_serial_console();
dee19416 MV	354	else if (!serial_current)
	355	dev = default_serial_console();
	356	else
	357	dev = serial_current;
857c283e	358
dee19416 MV	359	/* We must have a console device */
dee19416 MV	360	if (!dev) {
f1f1e9cb	361	#ifdef CONFIG_SPL_BUILD
dee19416 MV	362	puts("Cannot find console\n");
dee19416 MV	363	hang();
f1f1e9cb	364	#else
dee19416	365	panic("Cannot find console\n");
f1f1e9cb	366	#endif
dee19416 MV	367	}
dee19416 MV	368
857c283e SG	369	return dev;
857c283e SG	370	}
281e00a3	371
9cd2b9e4 MV	372	/**
	373	* serial_init() - Initialize currently selected serial port
	374	*
	375	* This function initializes the currently selected serial port. This
	376	* usually involves setting up the registers of that particular port,
	377	* enabling clock and such. This function uses the get_current() call
	378	* to determine which port is selected.
	379	*
	380	* Returns 0 on success, negative on error.
	381	*/
857c283e SG	382	int serial_init(void)
857c283e SG	383	{
89143fb3	384	return get_current()->start();
281e00a3 WD	385	}
281e00a3 WD	386
9cd2b9e4 MV	387	/**
	388	* serial_setbrg() - Configure baud-rate of currently selected serial port
	389	*
	390	* This function configures the baud-rate of the currently selected
	391	* serial port. The baud-rate is retrieved from global data within
	392	* the serial port driver. This function uses the get_current() call
	393	* to determine which port is selected.
	394	*
	395	* Returns 0 on success, negative on error.
	396	*/
a6e6f7f4	397	void serial_setbrg(void)
281e00a3	398	{
857c283e	399	get_current()->setbrg();
281e00a3 WD	400	}
281e00a3 WD	401
9cd2b9e4 MV	402	/**
	403	* serial_getc() - Read character from currently selected serial port
	404	*
	405	* This function retrieves a character from currently selected serial
	406	* port. In case there is no character waiting on the serial port,
	407	* this function will block and wait for the character to appear. This
	408	* function uses the get_current() call to determine which port is
	409	* selected.
	410	*
	411	* Returns the character on success, negative on error.
	412	*/
a6e6f7f4	413	int serial_getc(void)
281e00a3	414	{
857c283e	415	return get_current()->getc();
281e00a3 WD	416	}
281e00a3 WD	417
9cd2b9e4 MV	418	/**
	419	* serial_tstc() - Test if data is available on currently selected serial port
	420	*
	421	* This function tests if one or more characters are available on
	422	* currently selected serial port. This function never blocks. This
	423	* function uses the get_current() call to determine which port is
	424	* selected.
	425	*
	426	* Returns positive if character is available, zero otherwise.
	427	*/
a6e6f7f4	428	int serial_tstc(void)
281e00a3	429	{
857c283e	430	return get_current()->tstc();
281e00a3 WD	431	}
281e00a3 WD	432
9cd2b9e4 MV	433	/**
	434	* serial_putc() - Output character via currently selected serial port
	435	* @c: Single character to be output from the serial port.
	436	*
	437	* This function outputs a character via currently selected serial
	438	* port. This character is passed to the serial port driver responsible
	439	* for controlling the hardware. The hardware may still be in process
	440	* of transmitting another character, therefore this function may block
	441	* for a short amount of time. This function uses the get_current()
	442	* call to determine which port is selected.
	443	*/
a6e6f7f4	444	void serial_putc(const char c)
281e00a3	445	{
857c283e	446	get_current()->putc(c);
281e00a3 WD	447	}
281e00a3 WD	448
9cd2b9e4 MV	449	/**
	450	* serial_puts() - Output string via currently selected serial port
	451	* @s: Zero-terminated string to be output from the serial port.
	452	*
	453	* This function outputs a zero-terminated string via currently
	454	* selected serial port. This function behaves as an accelerator
	455	* in case the hardware can queue multiple characters for transfer.
	456	* The whole string that is to be output is available to the function
	457	* implementing the hardware manipulation. Transmitting the whole
	458	* string may take some time, thus this function may block for some
	459	* amount of time. This function uses the get_current() call to
	460	* determine which port is selected.
	461	*/
a6e6f7f4	462	void serial_puts(const char *s)
281e00a3	463	{
857c283e	464	get_current()->puts(s);
281e00a3	465	}
7b826c2f	466
9cd2b9e4 MV	467	/**
	468	* default_serial_puts() - Output string by calling serial_putc() in loop
	469	* @s: Zero-terminated string to be output from the serial port.
	470	*
	471	* This function outputs a zero-terminated string by calling serial_putc()
	472	* in a loop. Most drivers do not support queueing more than one byte for
	473	* transfer, thus this function precisely implements their serial_puts().
	474	*
	475	* To optimize the number of get_current() calls, this function only
	476	* calls get_current() once and then directly accesses the putc() call
	477	* of the &struct serial_device .
	478	*/
bfb7d7a3 MV	479	void default_serial_puts(const char *s)
	480	{
	481	struct serial_device *dev = get_current();
	482	while (*s)
	483	dev->putc(*s++);
	484	}
	485
7b826c2f MF	486	#if CONFIG_POST & CONFIG_SYS_POST_UART
	487	static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
	488
9cd2b9e4 MV	489	/**
	490	* uart_post_test() - Test the currently selected serial port using POST
	491	* @flags: POST framework flags
	492	*
	493	* Do a loopback test of the currently selected serial port. This
	494	* function is only useful in the context of the POST testing framwork.
	495	* The serial port is firstly configured into loopback mode and then
	496	* characters are sent through it.
	497	*
	498	* Returns 0 on success, value otherwise.
	499	*/
7b826c2f MF	500	/* Mark weak until post/cpu/.../uart.c migrate over */
	501	__weak
	502	int uart_post_test(int flags)
	503	{
	504	unsigned char c;
	505	int ret, saved_baud, b;
	506	struct serial_device saved_dev, s;
	507	bd_t *bd = gd->bd;
	508
	509	/* Save current serial state */
	510	ret = 0;
	511	saved_dev = serial_current;
	512	saved_baud = bd->bi_baudrate;
	513
	514	for (s = serial_devices; s; s = s->next) {
	515	/* If this driver doesn't support loop back, skip it */
	516	if (!s->loop)
	517	continue;
	518
	519	/* Test the next device */
	520	serial_current = s;
	521
	522	ret = serial_init();
	523	if (ret)
	524	goto done;
	525
	526	/* Consume anything that happens to be queued */
	527	while (serial_tstc())
	528	serial_getc();
	529
	530	/* Enable loop back */
	531	s->loop(1);
	532
	533	/* Test every available baud rate */
	534	for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
	535	bd->bi_baudrate = bauds[b];
	536	serial_setbrg();
	537
	538	/*
	539	* Stick to printable chars to avoid issues:
	540	* - terminal corruption
	541	* - serial program reacting to sequences and sending
	542	* back random extra data
	543	* - most serial drivers add in extra chars (like \r\n)
	544	*/
	545	for (c = 0x20; c < 0x7f; ++c) {
	546	/* Send it out */
	547	serial_putc(c);
	548
	549	/* Make sure it's the same one */
	550	ret = (c != serial_getc());
	551	if (ret) {
	552	s->loop(0);
	553	goto done;
	554	}
	555
	556	/* Clean up the output in case it was sent */
	557	serial_putc('\b');
	558	ret = ('\b' != serial_getc());
	559	if (ret) {
	560	s->loop(0);
	561	goto done;
	562	}
	563	}
564	}
565
566	/* Disable loop back */
567	s->loop(0);
568
89143fb3 MV	569	/* XXX: There is no serial_stop() !? */
	570	if (s->stop)
	571	s->stop();
7b826c2f MF	572	}
	573
	574	done:
	575	/* Restore previous serial state */
	576	serial_current = saved_dev;
	577	bd->bi_baudrate = saved_baud;
	578	serial_reinit_all();
	579	serial_setbrg();
	580
	581	return ret;
	582	}
	583	#endif