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

/*
 * Copyright (c) 2014 The Chromium OS Authors.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <common.h>
#include <dm.h>
#include <environment.h>
#include <errno.h>
#include <fdtdec.h>
#include <os.h>
#include <serial.h>
#include <stdio_dev.h>
#include <watchdog.h>
#include <dm/lists.h>
#include <dm/device-internal.h>

DECLARE_GLOBAL_DATA_PTR;

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

#ifndef CONFIG_SYS_MALLOC_F_LEN
#error "Serial is required before relocation - define CONFIG_SYS_MALLOC_F_LEN to make this work"
#endif

static void serial_find_console_or_panic(void)
{
	const void *blob = gd->fdt_blob;
	struct udevice *dev;
	int node;

	if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
		uclass_first_device(UCLASS_SERIAL, &dev);
		if (dev) {
			gd->cur_serial_dev = dev;
			return;
		}
	} else if (CONFIG_IS_ENABLED(OF_CONTROL) && blob) {
		/* Check for a chosen console */
		node = fdtdec_get_chosen_node(blob, "stdout-path");
		if (node < 0) {
			const char *str, *p, *name;

			/*
			 * Deal with things like
			 *	stdout-path = "serial0:115200n8";
			 *
			 * We need to look up the alias and then follow it to
			 * the correct node.
			 */
			str = fdtdec_get_chosen_prop(blob, "stdout-path");
			if (str) {
				p = strchr(str, ':');
				name = fdt_get_alias_namelen(blob, str,
						p ? p - str : strlen(str));
				if (name)
					node = fdt_path_offset(blob, name);
			}
		}
		if (node < 0)
			node = fdt_path_offset(blob, "console");
		if (!uclass_get_device_by_of_offset(UCLASS_SERIAL, node,
						    &dev)) {
			gd->cur_serial_dev = dev;
			return;
		}

		/*
		 * If the console is not marked to be bound before relocation,
		 * bind it anyway.
		 */
		if (node > 0 &&
		    !lists_bind_fdt(gd->dm_root, blob, node, &dev)) {
			if (!device_probe(dev)) {
				gd->cur_serial_dev = dev;
				return;
			}
		}
	}
	if (!SPL_BUILD || !CONFIG_IS_ENABLED(OF_CONTROL) || !blob) {
		/*
		 * Try to use CONFIG_CONS_INDEX if available (it is numbered
		 * from 1!).
		 *
		 * Failing that, get the device with sequence number 0, or in
		 * extremis just the first serial device we can find. But we
		 * insist on having a console (even if it is silent).
		 */
#ifdef CONFIG_CONS_INDEX
#define INDEX (CONFIG_CONS_INDEX - 1)
#else
#define INDEX 0
#endif
		if (!uclass_get_device_by_seq(UCLASS_SERIAL, INDEX, &dev) ||
		    !uclass_get_device(UCLASS_SERIAL, INDEX, &dev) ||
		    (!uclass_first_device(UCLASS_SERIAL, &dev) && dev)) {
			gd->cur_serial_dev = dev;
			return;
		}
#undef INDEX
	}

#ifdef CONFIG_REQUIRE_SERIAL_CONSOLE
	panic_str("No serial driver found");
#endif
}

/* Called prior to relocation */
int serial_init(void)
{
	serial_find_console_or_panic();
	gd->flags |= GD_FLG_SERIAL_READY;

	return 0;
}

/* Called after relocation */
void serial_initialize(void)
{
	serial_init();
}

static void _serial_putc(struct udevice *dev, char ch)
{
	struct dm_serial_ops *ops = serial_get_ops(dev);
	int err;

	if (ch == '\n')
		_serial_putc(dev, '\r');

	do {
		err = ops->putc(dev, ch);
	} while (err == -EAGAIN);
}

static void _serial_puts(struct udevice *dev, const char *str)
{
	while (*str)
		_serial_putc(dev, *str++);
}

static int _serial_getc(struct udevice *dev)
{
	struct dm_serial_ops *ops = serial_get_ops(dev);
	int err;

	do {
		err = ops->getc(dev);
		if (err == -EAGAIN)
			WATCHDOG_RESET();
	} while (err == -EAGAIN);

	return err >= 0 ? err : 0;
}

static int _serial_tstc(struct udevice *dev)
{
	struct dm_serial_ops *ops = serial_get_ops(dev);

	if (ops->pending)
		return ops->pending(dev, true);

	return 1;
}

void serial_putc(char ch)
{
	if (gd->cur_serial_dev)
		_serial_putc(gd->cur_serial_dev, ch);
}

void serial_puts(const char *str)
{
	if (gd->cur_serial_dev)
		_serial_puts(gd->cur_serial_dev, str);
}

int serial_getc(void)
{
	if (!gd->cur_serial_dev)
		return 0;

	return _serial_getc(gd->cur_serial_dev);
}

int serial_tstc(void)
{
	if (!gd->cur_serial_dev)
		return 0;

	return _serial_tstc(gd->cur_serial_dev);
}

void serial_setbrg(void)
{
	struct dm_serial_ops *ops;

	if (!gd->cur_serial_dev)
		return;

	ops = serial_get_ops(gd->cur_serial_dev);
	if (ops->setbrg)
		ops->setbrg(gd->cur_serial_dev, gd->baudrate);
}

void serial_stdio_init(void)
{
}

#if defined(CONFIG_DM_STDIO) && CONFIG_IS_ENABLED(SERIAL_PRESENT)
static void serial_stub_putc(struct stdio_dev *sdev, const char ch)
{
	_serial_putc(sdev->priv, ch);
}
#endif

void serial_stub_puts(struct stdio_dev *sdev, const char *str)
{
	_serial_puts(sdev->priv, str);
}

int serial_stub_getc(struct stdio_dev *sdev)
{
	return _serial_getc(sdev->priv);
}

int serial_stub_tstc(struct stdio_dev *sdev)
{
	return _serial_tstc(sdev->priv);
}

/**
 * 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;

		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);

#if CONFIG_IS_ENABLED(SERIAL_PRESENT)
static int serial_post_probe(struct udevice *dev)
{
	struct dm_serial_ops *ops = serial_get_ops(dev);
#ifdef CONFIG_DM_STDIO
	struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
	struct stdio_dev sdev;
#endif
	int ret;

#if defined(CONFIG_NEEDS_MANUAL_RELOC)
	if (ops->setbrg)
		ops->setbrg += gd->reloc_off;
	if (ops->getc)
		ops->getc += gd->reloc_off;
	if (ops->putc)
		ops->putc += gd->reloc_off;
	if (ops->pending)
		ops->pending += gd->reloc_off;
	if (ops->clear)
		ops->clear += gd->reloc_off;
#if CONFIG_POST & CONFIG_SYS_POST_UART
	if (ops->loop)
		ops->loop += gd->reloc_off
#endif
#endif
	/* Set the baud rate */
	if (ops->setbrg) {
		ret = ops->setbrg(dev, gd->baudrate);
		if (ret)
			return ret;
	}

#ifdef CONFIG_DM_STDIO
	if (!(gd->flags & GD_FLG_RELOC))
		return 0;
	memset(&sdev, '\0', sizeof(sdev));

	strncpy(sdev.name, dev->name, sizeof(sdev.name));
	sdev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
	sdev.priv = dev;
	sdev.putc = serial_stub_putc;
	sdev.puts = serial_stub_puts;
	sdev.getc = serial_stub_getc;
	sdev.tstc = serial_stub_tstc;
	stdio_register_dev(&sdev, &upriv->sdev);
#endif
	return 0;
}

static int serial_pre_remove(struct udevice *dev)
{
#if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
	struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);

	if (stdio_deregister_dev(upriv->sdev, 0))
		return -EPERM;
#endif

	return 0;
}

UCLASS_DRIVER(serial) = {
	.id		= UCLASS_SERIAL,
	.name		= "serial",
	.flags		= DM_UC_FLAG_SEQ_ALIAS,
	.post_probe	= serial_post_probe,
	.pre_remove	= serial_pre_remove,
	.per_device_auto_alloc_size = sizeof(struct serial_dev_priv),
};
#endif
Commit	Line	Data
57d92753 SG	1	/*
	2	* Copyright (c) 2014 The Chromium OS Authors.
	3	*
	4	* SPDX-License-Identifier: GPL-2.0+
	5	*/
	6
	7	#include <common.h>
	8	#include <dm.h>
ad1b81c8	9	#include <environment.h>
57d92753 SG	10	#include <errno.h>
	11	#include <fdtdec.h>
	12	#include <os.h>
	13	#include <serial.h>
	14	#include <stdio_dev.h>
c487fd47	15	#include <watchdog.h>
57d92753 SG	16	#include <dm/lists.h>
	17	#include <dm/device-internal.h>
	18
	19	DECLARE_GLOBAL_DATA_PTR;
	20
ad1b81c8 SG	21	/*
	22	* Table with supported baudrates (defined in config_xyz.h)
	23	*/
	24	static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
	25
57d92753 SG	26	#ifndef CONFIG_SYS_MALLOC_F_LEN
	27	#error "Serial is required before relocation - define CONFIG_SYS_MALLOC_F_LEN to make this work"
	28	#endif
	29
	30	static void serial_find_console_or_panic(void)
	31	{
6bdc593e	32	const void *blob = gd->fdt_blob;
469a579d	33	struct udevice *dev;
57d92753 SG	34	int node;
57d92753 SG	35
b484b0da SG	36	if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
	37	uclass_first_device(UCLASS_SERIAL, &dev);
	38	if (dev) {
	39	gd->cur_serial_dev = dev;
	40	return;
	41	}
	42	} else if (CONFIG_IS_ENABLED(OF_CONTROL) && blob) {
e9fc0583	43	/* Check for a chosen console */
6bdc593e SG	44	node = fdtdec_get_chosen_node(blob, "stdout-path");
	45	if (node < 0) {
	46	const char str, p, *name;
	47
	48	/*
	49	* Deal with things like
	50	* stdout-path = "serial0:115200n8";
	51	*
	52	* We need to look up the alias and then follow it to
	53	* the correct node.
	54	*/
	55	str = fdtdec_get_chosen_prop(blob, "stdout-path");
	56	if (str) {
	57	p = strchr(str, ':');
	58	name = fdt_get_alias_namelen(blob, str,
	59	p ? p - str : strlen(str));
	60	if (name)
	61	node = fdt_path_offset(blob, name);
	62	}
	63	}
e9fc0583	64	if (node < 0)
6bdc593e	65	node = fdt_path_offset(blob, "console");
e9fc0583 SG	66	if (!uclass_get_device_by_of_offset(UCLASS_SERIAL, node,
e9fc0583 SG	67	&dev)) {
469a579d	68	gd->cur_serial_dev = dev;
57d92753	69	return;
469a579d	70	}
e9fc0583 SG	71
e9fc0583 SG	72	/*
eb623b98 SR	73	* If the console is not marked to be bound before relocation,
	74	* bind it anyway.
	75	*/
e9fc0583	76	if (node > 0 &&
6bdc593e	77	!lists_bind_fdt(gd->dm_root, blob, node, &dev)) {
e9fc0583 SG	78	if (!device_probe(dev)) {
	79	gd->cur_serial_dev = dev;
	80	return;
	81	}
	82	}
af282245	83	}
6bdc593e	84	if (!SPL_BUILD \|\| !CONFIG_IS_ENABLED(OF_CONTROL) \|\| !blob) {
e9fc0583	85	/*
eb623b98 SR	86	* Try to use CONFIG_CONS_INDEX if available (it is numbered
	87	* from 1!).
	88	*
	89	* Failing that, get the device with sequence number 0, or in
	90	* extremis just the first serial device we can find. But we
	91	* insist on having a console (even if it is silent).
	92	*/
91155c65 SG	93	#ifdef CONFIG_CONS_INDEX
	94	#define INDEX (CONFIG_CONS_INDEX - 1)
	95	#else
	96	#define INDEX 0
	97	#endif
e9fc0583 SG	98	if (!uclass_get_device_by_seq(UCLASS_SERIAL, INDEX, &dev) \|\|
e9fc0583 SG	99	!uclass_get_device(UCLASS_SERIAL, INDEX, &dev) \|\|
753812cb	100	(!uclass_first_device(UCLASS_SERIAL, &dev) && dev)) {
e9fc0583 SG	101	gd->cur_serial_dev = dev;
	102	return;
	103	}
91155c65	104	#undef INDEX
e9fc0583 SG	105	}
e9fc0583 SG	106
8c458588	107	#ifdef CONFIG_REQUIRE_SERIAL_CONSOLE
e9fc0583	108	panic_str("No serial driver found");
8c458588	109	#endif
57d92753 SG	110	}
	111
	112	/* Called prior to relocation */
	113	int serial_init(void)
	114	{
	115	serial_find_console_or_panic();
	116	gd->flags \|= GD_FLG_SERIAL_READY;
	117
	118	return 0;
	119	}
	120
	121	/* Called after relocation */
	122	void serial_initialize(void)
	123	{
e4d6ab0c	124	serial_init();
57d92753 SG	125	}
57d92753 SG	126
eea5a4cc	127	static void _serial_putc(struct udevice *dev, char ch)
57d92753	128	{
bac64467	129	struct dm_serial_ops *ops = serial_get_ops(dev);
57d92753 SG	130	int err;
57d92753 SG	131
c5917b4b AW	132	if (ch == '\n')
	133	_serial_putc(dev, '\r');
	134
57d92753	135	do {
bac64467	136	err = ops->putc(dev, ch);
57d92753	137	} while (err == -EAGAIN);
57d92753 SG	138	}
57d92753 SG	139
eea5a4cc	140	static void _serial_puts(struct udevice dev, const char str)
b8893327	141	{
eea5a4cc MY	142	while (*str)
eea5a4cc MY	143	_serial_putc(dev, *str++);
b8893327 SG	144	}
b8893327 SG	145
eea5a4cc	146	static int _serial_getc(struct udevice *dev)
57d92753	147	{
eea5a4cc MY	148	struct dm_serial_ops *ops = serial_get_ops(dev);
eea5a4cc MY	149	int err;
57d92753	150
eea5a4cc MY	151	do {
	152	err = ops->getc(dev);
	153	if (err == -EAGAIN)
	154	WATCHDOG_RESET();
	155	} while (err == -EAGAIN);
57d92753	156
eea5a4cc	157	return err >= 0 ? err : 0;
57d92753 SG	158	}
57d92753 SG	159
eea5a4cc	160	static int _serial_tstc(struct udevice *dev)
57d92753	161	{
eea5a4cc	162	struct dm_serial_ops *ops = serial_get_ops(dev);
57d92753 SG	163
57d92753 SG	164	if (ops->pending)
eea5a4cc	165	return ops->pending(dev, true);
57d92753 SG	166
	167	return 1;
	168	}
	169
eea5a4cc	170	void serial_putc(char ch)
57d92753	171	{
8c458588 HG	172	if (gd->cur_serial_dev)
8c458588 HG	173	_serial_putc(gd->cur_serial_dev, ch);
eea5a4cc	174	}
57d92753	175
eea5a4cc MY	176	void serial_puts(const char *str)
eea5a4cc MY	177	{
8c458588 HG	178	if (gd->cur_serial_dev)
8c458588 HG	179	_serial_puts(gd->cur_serial_dev, str);
57d92753 SG	180	}
57d92753 SG	181
b8893327 SG	182	int serial_getc(void)
b8893327 SG	183	{
8c458588 HG	184	if (!gd->cur_serial_dev)
	185	return 0;
	186
469a579d	187	return _serial_getc(gd->cur_serial_dev);
eea5a4cc MY	188	}
	189
	190	int serial_tstc(void)
	191	{
8c458588 HG	192	if (!gd->cur_serial_dev)
	193	return 0;
	194
469a579d	195	return _serial_tstc(gd->cur_serial_dev);
eea5a4cc MY	196	}
	197
	198	void serial_setbrg(void)
	199	{
8c458588 HG	200	struct dm_serial_ops *ops;
	201
	202	if (!gd->cur_serial_dev)
	203	return;
eea5a4cc	204
8c458588	205	ops = serial_get_ops(gd->cur_serial_dev);
eea5a4cc	206	if (ops->setbrg)
469a579d	207	ops->setbrg(gd->cur_serial_dev, gd->baudrate);
b8893327 SG	208	}
b8893327 SG	209
57d92753 SG	210	void serial_stdio_init(void)
	211	{
	212	}
	213
92c55b68	214	#if defined(CONFIG_DM_STDIO) && CONFIG_IS_ENABLED(SERIAL_PRESENT)
b8893327	215	static void serial_stub_putc(struct stdio_dev *sdev, const char ch)
57d92753	216	{
eea5a4cc	217	_serial_putc(sdev->priv, ch);
57d92753	218	}
236f2bd3	219	#endif
57d92753 SG	220
	221	void serial_stub_puts(struct stdio_dev sdev, const char str)
	222	{
eea5a4cc	223	_serial_puts(sdev->priv, str);
57d92753 SG	224	}
	225
	226	int serial_stub_getc(struct stdio_dev *sdev)
	227	{
eea5a4cc	228	return _serial_getc(sdev->priv);
57d92753 SG	229	}
	230
	231	int serial_stub_tstc(struct stdio_dev *sdev)
	232	{
eea5a4cc	233	return _serial_tstc(sdev->priv);
57d92753 SG	234	}
57d92753 SG	235
ad1b81c8 SG	236	/**
	237	* on_baudrate() - Update the actual baudrate when the env var changes
	238	*
	239	* This will check for a valid baudrate and only apply it if valid.
	240	*/
	241	static int on_baudrate(const char name, const char value, enum env_op op,
	242	int flags)
	243	{
	244	int i;
	245	int baudrate;
	246
	247	switch (op) {
	248	case env_op_create:
	249	case env_op_overwrite:
	250	/*
	251	* Switch to new baudrate if new baudrate is supported
	252	*/
	253	baudrate = simple_strtoul(value, NULL, 10);
	254
	255	/* Not actually changing */
	256	if (gd->baudrate == baudrate)
	257	return 0;
	258
	259	for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
	260	if (baudrate == baudrate_table[i])
	261	break;
	262	}
	263	if (i == ARRAY_SIZE(baudrate_table)) {
	264	if ((flags & H_FORCE) == 0)
	265	printf("## Baudrate %d bps not supported\n",
	266	baudrate);
	267	return 1;
	268	}
	269	if ((flags & H_INTERACTIVE) != 0) {
	270	printf("## Switch baudrate to %d bps and press ENTER ...\n",
	271	baudrate);
	272	udelay(50000);
	273	}
	274
	275	gd->baudrate = baudrate;
	276
	277	serial_setbrg();
	278
	279	udelay(50000);
	280
	281	if ((flags & H_INTERACTIVE) != 0)
	282	while (1) {
	283	if (getc() == '\r')
	284	break;
	285	}
	286
	287	return 0;
	288	case env_op_delete:
	289	printf("## Baudrate may not be deleted\n");
	290	return 1;
	291	default:
	292	return 0;
	293	}
	294	}
	295	U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
	296
92c55b68	297	#if CONFIG_IS_ENABLED(SERIAL_PRESENT)
57d92753 SG	298	static int serial_post_probe(struct udevice *dev)
57d92753 SG	299	{
57d92753	300	struct dm_serial_ops *ops = serial_get_ops(dev);
236f2bd3	301	#ifdef CONFIG_DM_STDIO
e564f054	302	struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
236f2bd3 SG	303	struct stdio_dev sdev;
236f2bd3 SG	304	#endif
57d92753 SG	305	int ret;
57d92753 SG	306
484fdf5b MS	307	#if defined(CONFIG_NEEDS_MANUAL_RELOC)
	308	if (ops->setbrg)
	309	ops->setbrg += gd->reloc_off;
	310	if (ops->getc)
	311	ops->getc += gd->reloc_off;
	312	if (ops->putc)
	313	ops->putc += gd->reloc_off;
	314	if (ops->pending)
	315	ops->pending += gd->reloc_off;
	316	if (ops->clear)
	317	ops->clear += gd->reloc_off;
	318	#if CONFIG_POST & CONFIG_SYS_POST_UART
	319	if (ops->loop)
	320	ops->loop += gd->reloc_off
	321	#endif
	322	#endif
57d92753 SG	323	/* Set the baud rate */
	324	if (ops->setbrg) {
	325	ret = ops->setbrg(dev, gd->baudrate);
	326	if (ret)
	327	return ret;
	328	}
	329
236f2bd3	330	#ifdef CONFIG_DM_STDIO
57d92753 SG	331	if (!(gd->flags & GD_FLG_RELOC))
57d92753 SG	332	return 0;
57d92753 SG	333	memset(&sdev, '\0', sizeof(sdev));
	334
	335	strncpy(sdev.name, dev->name, sizeof(sdev.name));
	336	sdev.flags = DEV_FLAGS_OUTPUT \| DEV_FLAGS_INPUT;
	337	sdev.priv = dev;
	338	sdev.putc = serial_stub_putc;
	339	sdev.puts = serial_stub_puts;
	340	sdev.getc = serial_stub_getc;
	341	sdev.tstc = serial_stub_tstc;
	342	stdio_register_dev(&sdev, &upriv->sdev);
236f2bd3	343	#endif
57d92753 SG	344	return 0;
	345	}
	346
	347	static int serial_pre_remove(struct udevice *dev)
	348	{
869588de	349	#if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
e564f054	350	struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
57d92753	351
4a74298c	352	if (stdio_deregister_dev(upriv->sdev, 0))
57d92753 SG	353	return -EPERM;
	354	#endif
	355
	356	return 0;
	357	}
	358
	359	UCLASS_DRIVER(serial) = {
	360	.id = UCLASS_SERIAL,
	361	.name = "serial",
9cc36a2b	362	.flags = DM_UC_FLAG_SEQ_ALIAS,
57d92753 SG	363	.post_probe = serial_post_probe,
	364	.pre_remove = serial_pre_remove,
	365	.per_device_auto_alloc_size = sizeof(struct serial_dev_priv),
	366	};
92c55b68	367	#endif