xref: /rk3399_rockchip-uboot/drivers/serial/serial-uclass.c (revision bac644675ac900e27dc079cf062b55fa71a4c211)
157d92753SSimon Glass /*
257d92753SSimon Glass  * Copyright (c) 2014 The Chromium OS Authors.
357d92753SSimon Glass  *
457d92753SSimon Glass  * SPDX-License-Identifier:	GPL-2.0+
557d92753SSimon Glass  */
657d92753SSimon Glass 
757d92753SSimon Glass #include <common.h>
857d92753SSimon Glass #include <dm.h>
957d92753SSimon Glass #include <errno.h>
1057d92753SSimon Glass #include <fdtdec.h>
1157d92753SSimon Glass #include <os.h>
1257d92753SSimon Glass #include <serial.h>
1357d92753SSimon Glass #include <stdio_dev.h>
14c487fd47SSimon Glass #include <watchdog.h>
1557d92753SSimon Glass #include <dm/lists.h>
1657d92753SSimon Glass #include <dm/device-internal.h>
1757d92753SSimon Glass 
18c487fd47SSimon Glass #include <ns16550.h>
19c487fd47SSimon Glass 
2057d92753SSimon Glass DECLARE_GLOBAL_DATA_PTR;
2157d92753SSimon Glass 
2257d92753SSimon Glass /* The currently-selected console serial device */
2357d92753SSimon Glass struct udevice *cur_dev __attribute__ ((section(".data")));
2457d92753SSimon Glass 
2557d92753SSimon Glass #ifndef CONFIG_SYS_MALLOC_F_LEN
2657d92753SSimon Glass #error "Serial is required before relocation - define CONFIG_SYS_MALLOC_F_LEN to make this work"
2757d92753SSimon Glass #endif
2857d92753SSimon Glass 
2957d92753SSimon Glass static void serial_find_console_or_panic(void)
3057d92753SSimon Glass {
3159990bf0SSimon Glass #ifdef CONFIG_OF_CONTROL
3257d92753SSimon Glass 	int node;
3357d92753SSimon Glass 
3457d92753SSimon Glass 	/* Check for a chosen console */
3557d92753SSimon Glass 	node = fdtdec_get_chosen_node(gd->fdt_blob, "stdout-path");
3657d92753SSimon Glass 	if (node < 0)
3757d92753SSimon Glass 		node = fdtdec_get_alias_node(gd->fdt_blob, "console");
3857d92753SSimon Glass 	if (!uclass_get_device_by_of_offset(UCLASS_SERIAL, node, &cur_dev))
3957d92753SSimon Glass 		return;
4057d92753SSimon Glass 
4157d92753SSimon Glass 	/*
4257d92753SSimon Glass 	 * If the console is not marked to be bound before relocation, bind
4357d92753SSimon Glass 	 * it anyway.
4457d92753SSimon Glass 	 */
4557d92753SSimon Glass 	if (node > 0 &&
4657d92753SSimon Glass 	    !lists_bind_fdt(gd->dm_root, gd->fdt_blob, node, &cur_dev)) {
4757d92753SSimon Glass 		if (!device_probe(cur_dev))
4857d92753SSimon Glass 			return;
4957d92753SSimon Glass 		cur_dev = NULL;
5057d92753SSimon Glass 	}
5159990bf0SSimon Glass #endif
5257d92753SSimon Glass 	/*
5391155c65SSimon Glass 	 * Try to use CONFIG_CONS_INDEX if available (it is numbered from 1!).
5491155c65SSimon Glass 	 *
5557d92753SSimon Glass 	 * Failing that, get the device with sequence number 0, or in extremis
5657d92753SSimon Glass 	 * just the first serial device we can find. But we insist on having
5757d92753SSimon Glass 	 * a console (even if it is silent).
5857d92753SSimon Glass 	 */
5991155c65SSimon Glass #ifdef CONFIG_CONS_INDEX
6091155c65SSimon Glass #define INDEX (CONFIG_CONS_INDEX - 1)
6191155c65SSimon Glass #else
6291155c65SSimon Glass #define INDEX 0
6391155c65SSimon Glass #endif
6491155c65SSimon Glass 	if (uclass_get_device_by_seq(UCLASS_SERIAL, INDEX, &cur_dev) &&
6591155c65SSimon Glass 	    uclass_get_device(UCLASS_SERIAL, INDEX, &cur_dev) &&
6657d92753SSimon Glass 	    (uclass_first_device(UCLASS_SERIAL, &cur_dev) || !cur_dev))
6757d92753SSimon Glass 		panic("No serial driver found");
6891155c65SSimon Glass #undef INDEX
6957d92753SSimon Glass }
7057d92753SSimon Glass 
7157d92753SSimon Glass /* Called prior to relocation */
7257d92753SSimon Glass int serial_init(void)
7357d92753SSimon Glass {
7457d92753SSimon Glass 	serial_find_console_or_panic();
7557d92753SSimon Glass 	gd->flags |= GD_FLG_SERIAL_READY;
7657d92753SSimon Glass 
7757d92753SSimon Glass 	return 0;
7857d92753SSimon Glass }
7957d92753SSimon Glass 
8057d92753SSimon Glass /* Called after relocation */
8157d92753SSimon Glass void serial_initialize(void)
8257d92753SSimon Glass {
8357d92753SSimon Glass 	serial_find_console_or_panic();
8457d92753SSimon Glass }
8557d92753SSimon Glass 
86b8893327SSimon Glass static void serial_putc_dev(struct udevice *dev, char ch)
8757d92753SSimon Glass {
88*bac64467SMasahiro Yamada 	struct dm_serial_ops *ops = serial_get_ops(dev);
8957d92753SSimon Glass 	int err;
9057d92753SSimon Glass 
9157d92753SSimon Glass 	do {
92*bac64467SMasahiro Yamada 		err = ops->putc(dev, ch);
9357d92753SSimon Glass 	} while (err == -EAGAIN);
9457d92753SSimon Glass 	if (ch == '\n')
95*bac64467SMasahiro Yamada 		serial_putc_dev(dev, '\r');
9657d92753SSimon Glass }
9757d92753SSimon Glass 
98b8893327SSimon Glass void serial_putc(char ch)
99b8893327SSimon Glass {
100b8893327SSimon Glass 	serial_putc_dev(cur_dev, ch);
101b8893327SSimon Glass }
102b8893327SSimon Glass 
10357d92753SSimon Glass void serial_setbrg(void)
10457d92753SSimon Glass {
10557d92753SSimon Glass 	struct dm_serial_ops *ops = serial_get_ops(cur_dev);
10657d92753SSimon Glass 
10757d92753SSimon Glass 	if (ops->setbrg)
10857d92753SSimon Glass 		ops->setbrg(cur_dev, gd->baudrate);
10957d92753SSimon Glass }
11057d92753SSimon Glass 
11157d92753SSimon Glass void serial_puts(const char *str)
11257d92753SSimon Glass {
11357d92753SSimon Glass 	while (*str)
11457d92753SSimon Glass 		serial_putc(*str++);
11557d92753SSimon Glass }
11657d92753SSimon Glass 
11757d92753SSimon Glass int serial_tstc(void)
11857d92753SSimon Glass {
11957d92753SSimon Glass 	struct dm_serial_ops *ops = serial_get_ops(cur_dev);
12057d92753SSimon Glass 
12157d92753SSimon Glass 	if (ops->pending)
12257d92753SSimon Glass 		return ops->pending(cur_dev, true);
12357d92753SSimon Glass 
12457d92753SSimon Glass 	return 1;
12557d92753SSimon Glass }
12657d92753SSimon Glass 
127b8893327SSimon Glass static int serial_getc_dev(struct udevice *dev)
12857d92753SSimon Glass {
129b8893327SSimon Glass 	struct dm_serial_ops *ops = serial_get_ops(dev);
13057d92753SSimon Glass 	int err;
13157d92753SSimon Glass 
13257d92753SSimon Glass 	do {
133b8893327SSimon Glass 		err = ops->getc(dev);
134c487fd47SSimon Glass 		if (err == -EAGAIN)
135c487fd47SSimon Glass 			WATCHDOG_RESET();
13657d92753SSimon Glass 	} while (err == -EAGAIN);
13757d92753SSimon Glass 
13857d92753SSimon Glass 	return err >= 0 ? err : 0;
13957d92753SSimon Glass }
14057d92753SSimon Glass 
141b8893327SSimon Glass int serial_getc(void)
142b8893327SSimon Glass {
143b8893327SSimon Glass 	return serial_getc_dev(cur_dev);
144b8893327SSimon Glass }
145b8893327SSimon Glass 
14657d92753SSimon Glass void serial_stdio_init(void)
14757d92753SSimon Glass {
14857d92753SSimon Glass }
14957d92753SSimon Glass 
150b8893327SSimon Glass static void serial_stub_putc(struct stdio_dev *sdev, const char ch)
15157d92753SSimon Glass {
15257d92753SSimon Glass 	struct udevice *dev = sdev->priv;
15357d92753SSimon Glass 
154b8893327SSimon Glass 	serial_putc_dev(dev, ch);
15557d92753SSimon Glass }
15657d92753SSimon Glass 
15757d92753SSimon Glass void serial_stub_puts(struct stdio_dev *sdev, const char *str)
15857d92753SSimon Glass {
15957d92753SSimon Glass 	while (*str)
16057d92753SSimon Glass 		serial_stub_putc(sdev, *str++);
16157d92753SSimon Glass }
16257d92753SSimon Glass 
16357d92753SSimon Glass int serial_stub_getc(struct stdio_dev *sdev)
16457d92753SSimon Glass {
16557d92753SSimon Glass 	struct udevice *dev = sdev->priv;
16657d92753SSimon Glass 
167b8893327SSimon Glass 	return serial_getc_dev(dev);
16857d92753SSimon Glass }
16957d92753SSimon Glass 
17057d92753SSimon Glass int serial_stub_tstc(struct stdio_dev *sdev)
17157d92753SSimon Glass {
17257d92753SSimon Glass 	struct udevice *dev = sdev->priv;
17357d92753SSimon Glass 	struct dm_serial_ops *ops = serial_get_ops(dev);
17457d92753SSimon Glass 
17557d92753SSimon Glass 	if (ops->pending)
17657d92753SSimon Glass 		return ops->pending(dev, true);
17757d92753SSimon Glass 
17857d92753SSimon Glass 	return 1;
17957d92753SSimon Glass }
18057d92753SSimon Glass 
18157d92753SSimon Glass static int serial_post_probe(struct udevice *dev)
18257d92753SSimon Glass {
18357d92753SSimon Glass 	struct stdio_dev sdev;
18457d92753SSimon Glass 	struct dm_serial_ops *ops = serial_get_ops(dev);
18557d92753SSimon Glass 	struct serial_dev_priv *upriv = dev->uclass_priv;
18657d92753SSimon Glass 	int ret;
18757d92753SSimon Glass 
18857d92753SSimon Glass 	/* Set the baud rate */
18957d92753SSimon Glass 	if (ops->setbrg) {
19057d92753SSimon Glass 		ret = ops->setbrg(dev, gd->baudrate);
19157d92753SSimon Glass 		if (ret)
19257d92753SSimon Glass 			return ret;
19357d92753SSimon Glass 	}
19457d92753SSimon Glass 
19557d92753SSimon Glass 	if (!(gd->flags & GD_FLG_RELOC))
19657d92753SSimon Glass 		return 0;
19757d92753SSimon Glass 
19857d92753SSimon Glass 	memset(&sdev, '\0', sizeof(sdev));
19957d92753SSimon Glass 
20057d92753SSimon Glass 	strncpy(sdev.name, dev->name, sizeof(sdev.name));
20157d92753SSimon Glass 	sdev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
20257d92753SSimon Glass 	sdev.priv = dev;
20357d92753SSimon Glass 	sdev.putc = serial_stub_putc;
20457d92753SSimon Glass 	sdev.puts = serial_stub_puts;
20557d92753SSimon Glass 	sdev.getc = serial_stub_getc;
20657d92753SSimon Glass 	sdev.tstc = serial_stub_tstc;
20757d92753SSimon Glass 	stdio_register_dev(&sdev, &upriv->sdev);
20857d92753SSimon Glass 
20957d92753SSimon Glass 	return 0;
21057d92753SSimon Glass }
21157d92753SSimon Glass 
21257d92753SSimon Glass static int serial_pre_remove(struct udevice *dev)
21357d92753SSimon Glass {
21457d92753SSimon Glass #ifdef CONFIG_SYS_STDIO_DEREGISTER
21557d92753SSimon Glass 	struct serial_dev_priv *upriv = dev->uclass_priv;
21657d92753SSimon Glass 
2174a74298cSHans de Goede 	if (stdio_deregister_dev(upriv->sdev, 0))
21857d92753SSimon Glass 		return -EPERM;
21957d92753SSimon Glass #endif
22057d92753SSimon Glass 
22157d92753SSimon Glass 	return 0;
22257d92753SSimon Glass }
22357d92753SSimon Glass 
22457d92753SSimon Glass UCLASS_DRIVER(serial) = {
22557d92753SSimon Glass 	.id		= UCLASS_SERIAL,
22657d92753SSimon Glass 	.name		= "serial",
22757d92753SSimon Glass 	.post_probe	= serial_post_probe,
22857d92753SSimon Glass 	.pre_remove	= serial_pre_remove,
22957d92753SSimon Glass 	.per_device_auto_alloc_size = sizeof(struct serial_dev_priv),
23057d92753SSimon Glass };
231