Skip to contentSkip to conversation

SiFive UART support

PATCH Superseded Anup Patel 3 participants 11 messages Dec 5, 2018 – Dec 11, 2018

Subsystems (2)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Anup Patel

author
#0 lore raw

cover SiFive UART support

This patchset adds SiFive UART driver for SiFive UART found on SiFive boards.

The driver is tested on QEMU sifive_u machine. In fact, with this patchset same U-Boot binary boots on QEMU virt machine and QEMU sifive_u machine in both M-mode and S-mode.

The patches are based upon latest RISC-V UBoot tree
(git://git.denx.de/u-boot-riscv.git) at commit id ce41c65382300b4be2b84df3c06c2aa6c591741d

Anup Patel (2):
drivers: serial: Add SiFive UART driver
riscv: qemu: Enable SiFive UART driver in defconfigs

 configs/qemu-riscv32_defconfig       |   1 +
 configs/qemu-riscv32_smode_defconfig |   1 +
 configs/qemu-riscv64_defconfig       |   1 +
 configs/qemu-riscv64_smode_defconfig |   1 +
 drivers/serial/Kconfig               |  13 ++
 drivers/serial/Makefile              |   1 +
 drivers/serial/serial_sifive.c       | 193 +++++++++++++++++++++++++++
 7 files changed, 211 insertions(+)
 create mode 100644 drivers/serial/serial_sifive.c
Signature · 1 line
2.17.1
author
#1 lore raw

PATCH 1/2 drivers: serial: Add SiFive UART driver

This patch adds SiFive UART driver. The driver is 100% DM driver and it determines input clock using clk framework.

---
 drivers/serial/Kconfig         |  13 +++
 drivers/serial/Makefile        |   1 +
 drivers/serial/serial_sifive.c | 193 +++++++++++++++++++++++++++++++++
 3 files changed, 207 insertions(+)
 create mode 100644 drivers/serial/serial_sifive.c
drivers/serial/Kconfig +13 -0
index 3bcc61e731..30f7e00557 100644
@@ -343,6 +343,13 @@ config DEBUG_UART_SANDBOX
 	  start up driver model. The driver will be available until the real
 	  driver model serial is running.
 
+config DEBUG_UART_SIFIVE
+	bool "SiFive UART"
+	help
+	  Select this to enable a debug UART using the serial_sifive driver. You
+	  will need to provide parameters to make this work. The driver will
+	  be available until the real driver-model serial is running.
+
 config DEBUG_UART_STM32
 	bool "STMicroelectronics STM32"
 	depends on STM32_SERIAL
@@ -685,6 +692,12 @@ config PXA_SERIAL
 	  If you have a machine based on a Marvell XScale PXA2xx CPU you
 	  can enable its onboard serial ports by enabling this option.
 
+config SIFIVE_SERIAL
+	bool "SiFive UART support"
+	depends on DM_SERIAL
+	help
+	  This driver supports the SiFive UART. If unsure say N.
+
 config STI_ASC_SERIAL
 	bool "STMicroelectronics on-chip UART"
 	depends on DM_SERIAL && ARCH_STI
drivers/serial/Makefile +1 -0
index b6377b1076..b6781535a8 100644
@@ -68,6 +68,7 @@ obj-$(CONFIG_NULLDEV_SERIAL) += serial_nulldev.o
 obj-$(CONFIG_OWL_SERIAL) += serial_owl.o
 obj-$(CONFIG_OMAP_SERIAL) += serial_omap.o
 obj-$(CONFIG_MTK_SERIAL) += serial_mtk.o
+obj-$(CONFIG_SIFIVE_SERIAL) += serial_sifive.o
 
 ifndef CONFIG_SPL_BUILD
 obj-$(CONFIG_USB_TTY) += usbtty.o
drivers/serial/serial_sifive.c new file +193 -0

193 lines not on this page · raw message

Signature · 1 line
2.17.1
#2 lore raw

PATCH 1/2 drivers: serial: Add SiFive UART driver

Quoted 152 lines · anup at brainfault.org

This patch adds SiFive UART driver. The driver is 100% DM driver and it determines input clock using clk framework.

---
 drivers/serial/Kconfig         |  13 +++
 drivers/serial/Makefile        |   1 +
 drivers/serial/serial_sifive.c | 193 +++++++++++++++++++++++++++++++++
 3 files changed, 207 insertions(+)
 create mode 100644 drivers/serial/serial_sifive.c
drivers/serial/Kconfig +13 -0
index 3bcc61e731..30f7e00557 100644
@@ -343,6 +343,13 @@ config DEBUG_UART_SANDBOX
 	  start up driver model. The driver will be available until the real
 	  driver model serial is running.
 
+config DEBUG_UART_SIFIVE
+	bool "SiFive UART"
+	help
+	  Select this to enable a debug UART using the serial_sifive driver. You
+	  will need to provide parameters to make this work. The driver will
+	  be available until the real driver-model serial is running.
+
 config DEBUG_UART_STM32
 	bool "STMicroelectronics STM32"
 	depends on STM32_SERIAL
@@ -685,6 +692,12 @@ config PXA_SERIAL
 	  If you have a machine based on a Marvell XScale PXA2xx CPU you
 	  can enable its onboard serial ports by enabling this option.
 
+config SIFIVE_SERIAL
+	bool "SiFive UART support"
+	depends on DM_SERIAL
+	help
+	  This driver supports the SiFive UART. If unsure say N.
+
 config STI_ASC_SERIAL
 	bool "STMicroelectronics on-chip UART"
 	depends on DM_SERIAL && ARCH_STI
drivers/serial/Makefile +1 -0
index b6377b1076..b6781535a8 100644
@@ -68,6 +68,7 @@ obj-$(CONFIG_NULLDEV_SERIAL) += serial_nulldev.o
 obj-$(CONFIG_OWL_SERIAL) += serial_owl.o
 obj-$(CONFIG_OMAP_SERIAL) += serial_omap.o
 obj-$(CONFIG_MTK_SERIAL) += serial_mtk.o
+obj-$(CONFIG_SIFIVE_SERIAL) += serial_sifive.o
 
 ifndef CONFIG_SPL_BUILD
 obj-$(CONFIG_USB_TTY) += usbtty.o
drivers/serial/serial_sifive.c new file +92 -0
new file mode 100644
index 0000000000..cce05d5a01
@@ -0,0 +1,193 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright (C) 2012 Michal Simek <[email protected]>
+ * Copyright (C) 2011-2012 Xilinx, Inc. All rights reserved.
+ */
+
+#include <clk.h>
+#include <common.h>
+#include <debug_uart.h>
+#include <dm.h>
+#include <errno.h>
+#include <fdtdec.h>
+#include <watchdog.h>
+#include <asm/io.h>
+#include <linux/compiler.h>
+#include <serial.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+#define UART_TXFIFO_FULL	0x80000000
+#define UART_RXFIFO_EMPTY	0x80000000
+#define UART_RXFIFO_DATA	0x000000ff
+#define UART_TXCTRL_TXEN	0x1
+#define UART_RXCTRL_RXEN	0x1
+
+struct uart_sifive {
+	u32 txfifo;
+	u32 rxfifo;
+	u32 txctrl;
+	u32 rxctrl;
+	u32 ie;
+	u32 ip;
+	u32 div;
+};
+
+struct sifive_uart_platdata {
+	unsigned int clock;
+	struct uart_sifive *regs;
+};
+
+/* Set up the baud rate in gd struct */
+static void _sifive_serial_setbrg(struct uart_sifive *regs,
+				  unsigned long clock, unsigned long baud)
+{
+	writel((u32)((clock / baud) - 1), &regs->div);
+}
+
+static void _sifive_serial_init(struct uart_sifive *regs)
+{
+	writel(UART_TXCTRL_TXEN, &regs->txctrl);
+	writel(UART_RXCTRL_RXEN, &regs->rxctrl);
+	writel(0, &regs->ie);
+}
+
+static int _sifive_serial_putc(struct uart_sifive *regs, const char c)
+{
+	if (readl(&regs->txfifo) & UART_TXFIFO_FULL)
+		return -EAGAIN;
+
+	writel(c, &regs->txfifo);
+
+	return 0;
+}
+
+static int _sifive_serial_getc(struct uart_sifive *regs)
+{
+	int ch = readl(&regs->rxfifo);
+
+	if (ch & UART_RXFIFO_EMPTY)
+		return -EAGAIN;
+	ch &= UART_RXFIFO_DATA;
+
+	return (!ch) ? -EAGAIN : ch;
+}
+
+static int sifive_serial_setbrg(struct udevice *dev, int baudrate)
+{
+	int err;
+	struct clk clk;
+	struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+	err = clk_get_by_index(dev, 0, &clk);
+	if (!err) {
+		err = clk_get_rate(&clk);
+		if (!IS_ERR_VALUE(err))
+			platdata->clock = err;
+	} else if (err != -ENOENT && err != -ENODEV && err != -ENOSYS) {
+		debug("SiFive UART failed to get clock\n");
+		return err;
+	}
+
+	if (!platdata->clock)

drivers/serial/serial_sifive.c line 102

Quoted 10 lines
drivers/serial/serial_sifive.c new file +10 -0
+		platdata->clock = dev_read_u32_default(dev, "clock-frequency", 0);
+	if (!platdata->clock) {
+		debug("SiFive UART clock not defined\n");
+		return -EINVAL;
+	}
+
+	_sifive_serial_setbrg(platdata->regs, platdata->clock, baudrate);
+
+	return 0;
+}

I don't see anything that ensures the TX FIFO is drained before changing the baud rate. I don't know anything about u-boot so I'm not sure if that's expected.

Quoted 80 lines
drivers/serial/serial_sifive.c new file +80 -0
+static int sifive_serial_probe(struct udevice *dev)
+{
+	struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+	/* No need to reinitialize the UART after relocation */
+	if (gd->flags & GD_FLG_RELOC)
+		return 0;
+
+	_sifive_serial_init(platdata->regs);
+
+	return 0;
+}
+
+static int sifive_serial_getc(struct udevice *dev)
+{
+	int c;
+	struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+	struct uart_sifive *regs = platdata->regs;
+
+	while ((c = _sifive_serial_getc(regs)) == -EAGAIN) ;
+
+	return c;
+}
+
+static int sifive_serial_putc(struct udevice *dev, const char ch)
+{
+	int rc;
+	struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+	while ((rc = _sifive_serial_putc(platdata->regs, ch)) == -EAGAIN) ;
+
+	return rc;
+}
+
+static int sifive_serial_ofdata_to_platdata(struct udevice *dev)
+{
+	struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+	platdata->regs = (struct uart_sifive *)dev_read_addr(dev);
+	if (IS_ERR(platdata->regs))
+		return PTR_ERR(platdata->regs);
+
+	return 0;
+}
+
+static const struct dm_serial_ops sifive_serial_ops = {
+	.putc = sifive_serial_putc,
+	.getc = sifive_serial_getc,
+	.setbrg = sifive_serial_setbrg,
+};
+
+static const struct udevice_id sifive_serial_ids[] = {
+	{ .compatible = "sifive,uart0" },
+	{ }
+};
+
+U_BOOT_DRIVER(serial_sifive) = {
+	.name	= "serial_sifive",
+	.id	= UCLASS_SERIAL,
+	.of_match = sifive_serial_ids,
+	.ofdata_to_platdata = sifive_serial_ofdata_to_platdata,
+	.platdata_auto_alloc_size = sizeof(struct sifive_uart_platdata),
+	.probe = sifive_serial_probe,
+	.ops	= &sifive_serial_ops,
+	.priv_auto_alloc_size	= sizeof(struct sifive_uart_platdata),
+};
+
+#ifdef CONFIG_DEBUG_UART_SIFIVE
+static inline void _debug_uart_init(void)
+{
+	struct uart_sifive *regs =
+			(struct uart_sifive *)CONFIG_DEBUG_UART_BASE;
+
+	_sifive_serial_setbrg(regs, CONFIG_DEBUG_UART_CLOCK,
+			      CONFIG_BAUDRATE);
+	_sifive_serial_init(regs);
+}
+
+static inline void _debug_uart_putc(int ch)
+{

drivers/serial/serial_sifive.c line 193

Quoted 10 lines
drivers/serial/serial_sifive.c new file +10 -0
+	struct uart_sifive *regs =
+			(struct uart_sifive *)CONFIG_DEBUG_UART_BASE;
+
+	while (_sifive_serial_putc(regs, ch) == -EAGAIN)
+		WATCHDOG_RESET();
+}
+
+DEBUG_UART_FUNCS
+
+#endif

Thanks!

author
#3 lore raw

PATCH 1/2 drivers: serial: Add SiFive UART driver

Quoted 160 lines · Palmer Dabbelt
Quoted 158 lines · anup at brainfault.org

This patch adds SiFive UART driver. The driver is 100% DM driver and it determines input clock using clk framework.

---
 drivers/serial/Kconfig         |  13 +++
 drivers/serial/Makefile        |   1 +
 drivers/serial/serial_sifive.c | 193 +++++++++++++++++++++++++++++++++
 3 files changed, 207 insertions(+)
 create mode 100644 drivers/serial/serial_sifive.c
drivers/serial/Kconfig +13 -0
index 3bcc61e731..30f7e00557 100644
@@ -343,6 +343,13 @@ config DEBUG_UART_SANDBOX
        start up driver model. The driver will be available until the real
        driver model serial is running.
 
+config DEBUG_UART_SIFIVE
+     bool "SiFive UART"
+     help
+       Select this to enable a debug UART using the serial_sifive driver. You
+       will need to provide parameters to make this work. The driver will
+       be available until the real driver-model serial is running.
+
 config DEBUG_UART_STM32
      bool "STMicroelectronics STM32"
      depends on STM32_SERIAL
@@ -685,6 +692,12 @@ config PXA_SERIAL
        If you have a machine based on a Marvell XScale PXA2xx CPU you
        can enable its onboard serial ports by enabling this option.
 
+config SIFIVE_SERIAL
+     bool "SiFive UART support"
+     depends on DM_SERIAL
+     help
+       This driver supports the SiFive UART. If unsure say N.
+
 config STI_ASC_SERIAL
      bool "STMicroelectronics on-chip UART"
      depends on DM_SERIAL && ARCH_STI
drivers/serial/Makefile +1 -0
index b6377b1076..b6781535a8 100644
@@ -68,6 +68,7 @@ obj-$(CONFIG_NULLDEV_SERIAL) += serial_nulldev.o
 obj-$(CONFIG_OWL_SERIAL) += serial_owl.o
 obj-$(CONFIG_OMAP_SERIAL) += serial_omap.o
 obj-$(CONFIG_MTK_SERIAL) += serial_mtk.o
+obj-$(CONFIG_SIFIVE_SERIAL) += serial_sifive.o
 
 ifndef CONFIG_SPL_BUILD
 obj-$(CONFIG_USB_TTY) += usbtty.o
drivers/serial/serial_sifive.c new file +98 -0
new file mode 100644
index 0000000000..cce05d5a01
@@ -0,0 +1,193 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright (C) 2012 Michal Simek <[email protected]>
+ * Copyright (C) 2011-2012 Xilinx, Inc. All rights reserved.
+ */
+
+#include <clk.h>
+#include <common.h>
+#include <debug_uart.h>
+#include <dm.h>
+#include <errno.h>
+#include <fdtdec.h>
+#include <watchdog.h>
+#include <asm/io.h>
+#include <linux/compiler.h>
+#include <serial.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+#define UART_TXFIFO_FULL     0x80000000
+#define UART_RXFIFO_EMPTY    0x80000000
+#define UART_RXFIFO_DATA     0x000000ff
+#define UART_TXCTRL_TXEN     0x1
+#define UART_RXCTRL_RXEN     0x1
+
+struct uart_sifive {
+     u32 txfifo;
+     u32 rxfifo;
+     u32 txctrl;
+     u32 rxctrl;
+     u32 ie;
+     u32 ip;
+     u32 div;
+};
+
+struct sifive_uart_platdata {
+     unsigned int clock;
+     struct uart_sifive *regs;
+};
+
+/* Set up the baud rate in gd struct */
+static void _sifive_serial_setbrg(struct uart_sifive *regs,
+                               unsigned long clock, unsigned long baud)
+{
+     writel((u32)((clock / baud) - 1), &regs->div);
+}
+
+static void _sifive_serial_init(struct uart_sifive *regs)
+{
+     writel(UART_TXCTRL_TXEN, &regs->txctrl);
+     writel(UART_RXCTRL_RXEN, &regs->rxctrl);
+     writel(0, &regs->ie);
+}
+
+static int _sifive_serial_putc(struct uart_sifive *regs, const char c)
+{
+     if (readl(&regs->txfifo) & UART_TXFIFO_FULL)
+             return -EAGAIN;
+
+     writel(c, &regs->txfifo);
+
+     return 0;
+}
+
+static int _sifive_serial_getc(struct uart_sifive *regs)
+{
+     int ch = readl(&regs->rxfifo);
+
+     if (ch & UART_RXFIFO_EMPTY)
+             return -EAGAIN;
+     ch &= UART_RXFIFO_DATA;
+
+     return (!ch) ? -EAGAIN : ch;
+}
+
+static int sifive_serial_setbrg(struct udevice *dev, int baudrate)
+{
+     int err;
+     struct clk clk;
+     struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+     err = clk_get_by_index(dev, 0, &clk);
+     if (!err) {
+             err = clk_get_rate(&clk);
+             if (!IS_ERR_VALUE(err))
+                     platdata->clock = err;
+     } else if (err != -ENOENT && err != -ENODEV && err != -ENOSYS) {
+             debug("SiFive UART failed to get clock\n");
+             return err;
+     }
+
+     if (!platdata->clock)
+             platdata->clock = dev_read_u32_default(dev, "clock-frequency", 0);
+     if (!platdata->clock) {
+             debug("SiFive UART clock not defined\n");
+             return -EINVAL;
+     }
+
Quoted 8 lines

drivers/serial/serial_sifive.c line 102

Quoted 4 lines
drivers/serial/serial_sifive.c new file +4 -0
+     _sifive_serial_setbrg(platdata->regs, platdata->clock, baudrate);
+
+     return 0;
+}

I don't see anything that ensures the TX FIFO is drained before changing the baud rate. I don't know anything about u-boot so I'm not sure if that's expected.

Ohh yes, u-boot serial drivers usually don't drain TX FIFO.

If required we can add it via separate patch.

Quoted 85 lines
Quoted 85 lines
drivers/serial/serial_sifive.c new file +84 -0
+static int sifive_serial_probe(struct udevice *dev)
+{
+     struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+     /* No need to reinitialize the UART after relocation */
+     if (gd->flags & GD_FLG_RELOC)
+             return 0;
+
+     _sifive_serial_init(platdata->regs);
+
+     return 0;
+}
+
+static int sifive_serial_getc(struct udevice *dev)
+{
+     int c;
+     struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+     struct uart_sifive *regs = platdata->regs;
+
+     while ((c = _sifive_serial_getc(regs)) == -EAGAIN) ;
+
+     return c;
+}
+
+static int sifive_serial_putc(struct udevice *dev, const char ch)
+{
+     int rc;
+     struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+     while ((rc = _sifive_serial_putc(platdata->regs, ch)) == -EAGAIN) ;
+
+     return rc;
+}
+
+static int sifive_serial_ofdata_to_platdata(struct udevice *dev)
+{
+     struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+     platdata->regs = (struct uart_sifive *)dev_read_addr(dev);
+     if (IS_ERR(platdata->regs))
+             return PTR_ERR(platdata->regs);
+
+     return 0;
+}
+
+static const struct dm_serial_ops sifive_serial_ops = {
+     .putc = sifive_serial_putc,
+     .getc = sifive_serial_getc,
+     .setbrg = sifive_serial_setbrg,
+};
+
+static const struct udevice_id sifive_serial_ids[] = {
+     { .compatible = "sifive,uart0" },
+     { }
+};
+
+U_BOOT_DRIVER(serial_sifive) = {
+     .name   = "serial_sifive",
+     .id     = UCLASS_SERIAL,
+     .of_match = sifive_serial_ids,
+     .ofdata_to_platdata = sifive_serial_ofdata_to_platdata,
+     .platdata_auto_alloc_size = sizeof(struct sifive_uart_platdata),
+     .probe = sifive_serial_probe,
+     .ops    = &sifive_serial_ops,
+     .priv_auto_alloc_size   = sizeof(struct sifive_uart_platdata),
+};
+
+#ifdef CONFIG_DEBUG_UART_SIFIVE
+static inline void _debug_uart_init(void)
+{
+     struct uart_sifive *regs =
+                     (struct uart_sifive *)CONFIG_DEBUG_UART_BASE;
+
+     _sifive_serial_setbrg(regs, CONFIG_DEBUG_UART_CLOCK,
+                           CONFIG_BAUDRATE);
+     _sifive_serial_init(regs);
+}
+
+static inline void _debug_uart_putc(int ch)
+{
+     struct uart_sifive *regs =
+                     (struct uart_sifive *)CONFIG_DEBUG_UART_BASE;
+
+     while (_sifive_serial_putc(regs, ch) == -EAGAIN)
Quoted 9 lines

drivers/serial/serial_sifive.c line 193

Quoted 6 lines
drivers/serial/serial_sifive.c new file +6 -0
+             WATCHDOG_RESET();
+}
+
+DEBUG_UART_FUNCS
+
+#endif

Thanks,
Anup

#4 lore raw

PATCH 1/2 drivers: serial: Add SiFive UART driver

In reply to Anup Patel

Hi Anup,

Quoted 61 lines · Anup Patel

This patch adds SiFive UART driver. The driver is 100% DM driver and it determines input clock using clk framework.

---
 drivers/serial/Kconfig         |  13 +++
 drivers/serial/Makefile        |   1 +
 drivers/serial/serial_sifive.c | 193 +++++++++++++++++++++++++++++++++
 3 files changed, 207 insertions(+)
 create mode 100644 drivers/serial/serial_sifive.c
drivers/serial/Kconfig +13 -0
index 3bcc61e731..30f7e00557 100644
@@ -343,6 +343,13 @@ config DEBUG_UART_SANDBOX
          start up driver model. The driver will be available until the real
          driver model serial is running.
 
+config DEBUG_UART_SIFIVE
+       bool "SiFive UART"
+       help
+         Select this to enable a debug UART using the serial_sifive driver. You
+         will need to provide parameters to make this work. The driver will
+         be available until the real driver-model serial is running.
+
 config DEBUG_UART_STM32
        bool "STMicroelectronics STM32"
        depends on STM32_SERIAL
@@ -685,6 +692,12 @@ config PXA_SERIAL
          If you have a machine based on a Marvell XScale PXA2xx CPU you
          can enable its onboard serial ports by enabling this option.
 
+config SIFIVE_SERIAL
+       bool "SiFive UART support"
+       depends on DM_SERIAL
+       help
+         This driver supports the SiFive UART. If unsure say N.
+
 config STI_ASC_SERIAL
        bool "STMicroelectronics on-chip UART"
        depends on DM_SERIAL && ARCH_STI
drivers/serial/Makefile +1 -0
index b6377b1076..b6781535a8 100644
@@ -68,6 +68,7 @@ obj-$(CONFIG_NULLDEV_SERIAL) += serial_nulldev.o
 obj-$(CONFIG_OWL_SERIAL) += serial_owl.o
 obj-$(CONFIG_OMAP_SERIAL) += serial_omap.o
 obj-$(CONFIG_MTK_SERIAL) += serial_mtk.o
+obj-$(CONFIG_SIFIVE_SERIAL) += serial_sifive.o
 
 ifndef CONFIG_SPL_BUILD
 obj-$(CONFIG_USB_TTY) += usbtty.o
drivers/serial/serial_sifive.c new file +0 -0
new file mode 100644
index 0000000000..cce05d5a01

drivers/serial/serial_sifive.c line 4

Quoted 4 lines
drivers/serial/serial_sifive.c new file +4 -0
@@ -0,0 +1,193 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright (C) 2012 Michal Simek <[email protected]>
+ * Copyright (C) 2011-2012 Xilinx, Inc. All rights reserved.

nits: pls update the copyright notice

Quoted 154 lines
drivers/serial/serial_sifive.c new file +154 -0
+ */
+
+#include <clk.h>
+#include <common.h>
+#include <debug_uart.h>
+#include <dm.h>
+#include <errno.h>
+#include <fdtdec.h>
+#include <watchdog.h>
+#include <asm/io.h>
+#include <linux/compiler.h>
+#include <serial.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+#define UART_TXFIFO_FULL       0x80000000
+#define UART_RXFIFO_EMPTY      0x80000000
+#define UART_RXFIFO_DATA       0x000000ff
+#define UART_TXCTRL_TXEN       0x1
+#define UART_RXCTRL_RXEN       0x1
+
+struct uart_sifive {
+       u32 txfifo;
+       u32 rxfifo;
+       u32 txctrl;
+       u32 rxctrl;
+       u32 ie;
+       u32 ip;
+       u32 div;
+};
+
+struct sifive_uart_platdata {
+       unsigned int clock;
+       struct uart_sifive *regs;
+};
+
+/* Set up the baud rate in gd struct */
+static void _sifive_serial_setbrg(struct uart_sifive *regs,
+                                 unsigned long clock, unsigned long baud)
+{
+       writel((u32)((clock / baud) - 1), &regs->div);
+}
+
+static void _sifive_serial_init(struct uart_sifive *regs)
+{
+       writel(UART_TXCTRL_TXEN, &regs->txctrl);
+       writel(UART_RXCTRL_RXEN, &regs->rxctrl);
+       writel(0, &regs->ie);
+}
+
+static int _sifive_serial_putc(struct uart_sifive *regs, const char c)
+{
+       if (readl(&regs->txfifo) & UART_TXFIFO_FULL)
+               return -EAGAIN;
+
+       writel(c, &regs->txfifo);
+
+       return 0;
+}
+
+static int _sifive_serial_getc(struct uart_sifive *regs)
+{
+       int ch = readl(&regs->rxfifo);
+
+       if (ch & UART_RXFIFO_EMPTY)
+               return -EAGAIN;
+       ch &= UART_RXFIFO_DATA;
+
+       return (!ch) ? -EAGAIN : ch;
+}
+
+static int sifive_serial_setbrg(struct udevice *dev, int baudrate)
+{
+       int err;
+       struct clk clk;
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+       err = clk_get_by_index(dev, 0, &clk);
+       if (!err) {
+               err = clk_get_rate(&clk);
+               if (!IS_ERR_VALUE(err))
+                       platdata->clock = err;
+       } else if (err != -ENOENT && err != -ENODEV && err != -ENOSYS) {
+               debug("SiFive UART failed to get clock\n");
+               return err;
+       }
+
+       if (!platdata->clock)
+               platdata->clock = dev_read_u32_default(dev, "clock-frequency", 0);
+       if (!platdata->clock) {
+               debug("SiFive UART clock not defined\n");
+               return -EINVAL;
+       }
+
+       _sifive_serial_setbrg(platdata->regs, platdata->clock, baudrate);
+
+       return 0;
+}
+
+static int sifive_serial_probe(struct udevice *dev)
+{
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+       /* No need to reinitialize the UART after relocation */
+       if (gd->flags & GD_FLG_RELOC)
+               return 0;
+
+       _sifive_serial_init(platdata->regs);
+
+       return 0;
+}
+
+static int sifive_serial_getc(struct udevice *dev)
+{
+       int c;
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+       struct uart_sifive *regs = platdata->regs;
+
+       while ((c = _sifive_serial_getc(regs)) == -EAGAIN) ;
+
+       return c;
+}
+
+static int sifive_serial_putc(struct udevice *dev, const char ch)
+{
+       int rc;
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+       while ((rc = _sifive_serial_putc(platdata->regs, ch)) == -EAGAIN) ;
+
+       return rc;
+}
+
+static int sifive_serial_ofdata_to_platdata(struct udevice *dev)
+{
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+       platdata->regs = (struct uart_sifive *)dev_read_addr(dev);
+       if (IS_ERR(platdata->regs))
+               return PTR_ERR(platdata->regs);
+
+       return 0;
+}
+
+static const struct dm_serial_ops sifive_serial_ops = {
+       .putc = sifive_serial_putc,
+       .getc = sifive_serial_getc,
+       .setbrg = sifive_serial_setbrg,
+};
+
+static const struct udevice_id sifive_serial_ids[] = {
+       { .compatible = "sifive,uart0" },
+       { }
+};

drivers/serial/serial_sifive.c line 168

Quoted 10 lines
drivers/serial/serial_sifive.c new file +10 -0
+
+U_BOOT_DRIVER(serial_sifive) = {
+       .name   = "serial_sifive",
+       .id     = UCLASS_SERIAL,
+       .of_match = sifive_serial_ids,
+       .ofdata_to_platdata = sifive_serial_ofdata_to_platdata,
+       .platdata_auto_alloc_size = sizeof(struct sifive_uart_platdata),
+       .probe = sifive_serial_probe,
+       .ops    = &sifive_serial_ops,
+       .priv_auto_alloc_size   = sizeof(struct sifive_uart_platdata),

This is not used anywhere in this driver.

Quoted 16 lines
drivers/serial/serial_sifive.c new file +16 -0
+};
+
+#ifdef CONFIG_DEBUG_UART_SIFIVE
+static inline void _debug_uart_init(void)
+{
+       struct uart_sifive *regs =
+                       (struct uart_sifive *)CONFIG_DEBUG_UART_BASE;
+
+       _sifive_serial_setbrg(regs, CONFIG_DEBUG_UART_CLOCK,
+                             CONFIG_BAUDRATE);
+       _sifive_serial_init(regs);
+}
+
+static inline void _debug_uart_putc(int ch)
+{
+       struct uart_sifive *regs =

drivers/serial/serial_sifive.c

Quoted 10 lines
drivers/serial/serial_sifive.c new file +9 -1
+                       (struct uart_sifive *)CONFIG_DEBUG_UART_BASE;
+
+       while (_sifive_serial_putc(regs, ch) == -EAGAIN)
+               WATCHDOG_RESET();
+}
+
+DEBUG_UART_FUNCS
+
+#endif
--

Regards,
Bin

author
#5 lore raw

PATCH 1/2 drivers: serial: Add SiFive UART driver

Quoted 57 lines · Bin Meng

Hi Anup,

Quoted 53 lines · Anup Patel

This patch adds SiFive UART driver. The driver is 100% DM driver and it determines input clock using clk framework.

---
 drivers/serial/Kconfig         |  13 +++
 drivers/serial/Makefile        |   1 +
 drivers/serial/serial_sifive.c | 193 +++++++++++++++++++++++++++++++++
 3 files changed, 207 insertions(+)
 create mode 100644 drivers/serial/serial_sifive.c
drivers/serial/Kconfig +13 -0
index 3bcc61e731..30f7e00557 100644
@@ -343,6 +343,13 @@ config DEBUG_UART_SANDBOX
          start up driver model. The driver will be available until the real
          driver model serial is running.
 
+config DEBUG_UART_SIFIVE
+       bool "SiFive UART"
+       help
+         Select this to enable a debug UART using the serial_sifive driver. You
+         will need to provide parameters to make this work. The driver will
+         be available until the real driver-model serial is running.
+
 config DEBUG_UART_STM32
        bool "STMicroelectronics STM32"
        depends on STM32_SERIAL
@@ -685,6 +692,12 @@ config PXA_SERIAL
          If you have a machine based on a Marvell XScale PXA2xx CPU you
          can enable its onboard serial ports by enabling this option.
 
+config SIFIVE_SERIAL
+       bool "SiFive UART support"
+       depends on DM_SERIAL
+       help
+         This driver supports the SiFive UART. If unsure say N.
+
 config STI_ASC_SERIAL
        bool "STMicroelectronics on-chip UART"
        depends on DM_SERIAL && ARCH_STI
drivers/serial/Makefile +1 -0
index b6377b1076..b6781535a8 100644
@@ -68,6 +68,7 @@ obj-$(CONFIG_NULLDEV_SERIAL) += serial_nulldev.o
 obj-$(CONFIG_OWL_SERIAL) += serial_owl.o
 obj-$(CONFIG_OMAP_SERIAL) += serial_omap.o
 obj-$(CONFIG_MTK_SERIAL) += serial_mtk.o
+obj-$(CONFIG_SIFIVE_SERIAL) += serial_sifive.o
 
Quoted 14 lines

drivers/serial/serial_sifive.c line 4

Quoted 12 lines
drivers/serial/Makefile +0 -0
 ifndef CONFIG_SPL_BUILD
 obj-$(CONFIG_USB_TTY) += usbtty.o
drivers/serial/serial_sifive.c new file +4 -0
new file mode 100644
index 0000000000..cce05d5a01
@@ -0,0 +1,193 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright (C) 2012 Michal Simek <[email protected]>
+ * Copyright (C) 2011-2012 Xilinx, Inc. All rights reserved.

nits: pls update the copyright notice

Thanks for catching it. I will update it.

Quoted 159 lines
Quoted 159 lines
drivers/serial/serial_sifive.c new file +158 -0
+ */
+
+#include <clk.h>
+#include <common.h>
+#include <debug_uart.h>
+#include <dm.h>
+#include <errno.h>
+#include <fdtdec.h>
+#include <watchdog.h>
+#include <asm/io.h>
+#include <linux/compiler.h>
+#include <serial.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+#define UART_TXFIFO_FULL       0x80000000
+#define UART_RXFIFO_EMPTY      0x80000000
+#define UART_RXFIFO_DATA       0x000000ff
+#define UART_TXCTRL_TXEN       0x1
+#define UART_RXCTRL_RXEN       0x1
+
+struct uart_sifive {
+       u32 txfifo;
+       u32 rxfifo;
+       u32 txctrl;
+       u32 rxctrl;
+       u32 ie;
+       u32 ip;
+       u32 div;
+};
+
+struct sifive_uart_platdata {
+       unsigned int clock;
+       struct uart_sifive *regs;
+};
+
+/* Set up the baud rate in gd struct */
+static void _sifive_serial_setbrg(struct uart_sifive *regs,
+                                 unsigned long clock, unsigned long baud)
+{
+       writel((u32)((clock / baud) - 1), &regs->div);
+}
+
+static void _sifive_serial_init(struct uart_sifive *regs)
+{
+       writel(UART_TXCTRL_TXEN, &regs->txctrl);
+       writel(UART_RXCTRL_RXEN, &regs->rxctrl);
+       writel(0, &regs->ie);
+}
+
+static int _sifive_serial_putc(struct uart_sifive *regs, const char c)
+{
+       if (readl(&regs->txfifo) & UART_TXFIFO_FULL)
+               return -EAGAIN;
+
+       writel(c, &regs->txfifo);
+
+       return 0;
+}
+
+static int _sifive_serial_getc(struct uart_sifive *regs)
+{
+       int ch = readl(&regs->rxfifo);
+
+       if (ch & UART_RXFIFO_EMPTY)
+               return -EAGAIN;
+       ch &= UART_RXFIFO_DATA;
+
+       return (!ch) ? -EAGAIN : ch;
+}
+
+static int sifive_serial_setbrg(struct udevice *dev, int baudrate)
+{
+       int err;
+       struct clk clk;
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+       err = clk_get_by_index(dev, 0, &clk);
+       if (!err) {
+               err = clk_get_rate(&clk);
+               if (!IS_ERR_VALUE(err))
+                       platdata->clock = err;
+       } else if (err != -ENOENT && err != -ENODEV && err != -ENOSYS) {
+               debug("SiFive UART failed to get clock\n");
+               return err;
+       }
+
+       if (!platdata->clock)
+               platdata->clock = dev_read_u32_default(dev, "clock-frequency", 0);
+       if (!platdata->clock) {
+               debug("SiFive UART clock not defined\n");
+               return -EINVAL;
+       }
+
+       _sifive_serial_setbrg(platdata->regs, platdata->clock, baudrate);
+
+       return 0;
+}
+
+static int sifive_serial_probe(struct udevice *dev)
+{
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+       /* No need to reinitialize the UART after relocation */
+       if (gd->flags & GD_FLG_RELOC)
+               return 0;
+
+       _sifive_serial_init(platdata->regs);
+
+       return 0;
+}
+
+static int sifive_serial_getc(struct udevice *dev)
+{
+       int c;
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+       struct uart_sifive *regs = platdata->regs;
+
+       while ((c = _sifive_serial_getc(regs)) == -EAGAIN) ;
+
+       return c;
+}
+
+static int sifive_serial_putc(struct udevice *dev, const char ch)
+{
+       int rc;
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+       while ((rc = _sifive_serial_putc(platdata->regs, ch)) == -EAGAIN) ;
+
+       return rc;
+}
+
+static int sifive_serial_ofdata_to_platdata(struct udevice *dev)
+{
+       struct sifive_uart_platdata *platdata = dev_get_platdata(dev);
+
+       platdata->regs = (struct uart_sifive *)dev_read_addr(dev);
+       if (IS_ERR(platdata->regs))
+               return PTR_ERR(platdata->regs);
+
+       return 0;
+}
+
+static const struct dm_serial_ops sifive_serial_ops = {
+       .putc = sifive_serial_putc,
+       .getc = sifive_serial_getc,
+       .setbrg = sifive_serial_setbrg,
+};
+
+static const struct udevice_id sifive_serial_ids[] = {
+       { .compatible = "sifive,uart0" },
+       { }
+};
+
+U_BOOT_DRIVER(serial_sifive) = {
+       .name   = "serial_sifive",
+       .id     = UCLASS_SERIAL,
Quoted 8 lines

drivers/serial/serial_sifive.c line 168

Quoted 6 lines
drivers/serial/serial_sifive.c new file +6 -0
+       .of_match = sifive_serial_ids,
+       .ofdata_to_platdata = sifive_serial_ofdata_to_platdata,
+       .platdata_auto_alloc_size = sizeof(struct sifive_uart_platdata),
+       .probe = sifive_serial_probe,
+       .ops    = &sifive_serial_ops,
+       .priv_auto_alloc_size   = sizeof(struct sifive_uart_platdata),

This is not used anywhere in this driver.

Ok, I will remove priv_auto_alloc_size.

Quoted 22 lines
Quoted 22 lines
drivers/serial/serial_sifive.c new file +21 -0
+};
+
+#ifdef CONFIG_DEBUG_UART_SIFIVE
+static inline void _debug_uart_init(void)
+{
+       struct uart_sifive *regs =
+                       (struct uart_sifive *)CONFIG_DEBUG_UART_BASE;
+
+       _sifive_serial_setbrg(regs, CONFIG_DEBUG_UART_CLOCK,
+                             CONFIG_BAUDRATE);
+       _sifive_serial_init(regs);
+}
+
+static inline void _debug_uart_putc(int ch)
+{
+       struct uart_sifive *regs =
+                       (struct uart_sifive *)CONFIG_DEBUG_UART_BASE;
+
+       while (_sifive_serial_putc(regs, ch) == -EAGAIN)
+               WATCHDOG_RESET();
+}
Quoted 8 lines

drivers/serial/serial_sifive.c

Quoted 5 lines
drivers/serial/serial_sifive.c new file +4 -1
+
+DEBUG_UART_FUNCS
+
+#endif
--

Regards,
Bin

Regards,
Anup

author
#6 lore raw

PATCH 2/2 riscv: qemu: Enable SiFive UART driver in defconfigs

In reply to Anup Patel

This patch enables SiFive UART driver in all QEMU RISC-V defconfigs.

---
 configs/qemu-riscv32_defconfig       | 1 +
 configs/qemu-riscv32_smode_defconfig | 1 +
 configs/qemu-riscv64_defconfig       | 1 +
 configs/qemu-riscv64_smode_defconfig | 1 +
 4 files changed, 4 insertions(+)
configs/qemu-riscv32_defconfig +1 -0
index 6334d8c0fc..79c8d54cc7 100644
@@ -7,3 +7,4 @@ CONFIG_DISPLAY_CPUINFO=y
 CONFIG_DISPLAY_BOARDINFO=y
 # CONFIG_CMD_MII is not set
 CONFIG_OF_PRIOR_STAGE=y
+CONFIG_SIFIVE_SERIAL=y
configs/qemu-riscv32_smode_defconfig +1 -0
index 0a84ec1874..b733dbed2f 100644
@@ -8,3 +8,4 @@ CONFIG_DISPLAY_CPUINFO=y
 CONFIG_DISPLAY_BOARDINFO=y
 # CONFIG_CMD_MII is not set
 CONFIG_OF_PRIOR_STAGE=y
+CONFIG_SIFIVE_SERIAL=y
configs/qemu-riscv64_defconfig +1 -0
index 2d9ead93a2..a9d19a5574 100644
@@ -8,3 +8,4 @@ CONFIG_DISPLAY_CPUINFO=y
 CONFIG_DISPLAY_BOARDINFO=y
 # CONFIG_CMD_MII is not set
 CONFIG_OF_PRIOR_STAGE=y
+CONFIG_SIFIVE_SERIAL=y
configs/qemu-riscv64_smode_defconfig +1 -0
index b012443370..8adc23f826 100644
@@ -9,3 +9,4 @@ CONFIG_DISPLAY_CPUINFO=y
 CONFIG_DISPLAY_BOARDINFO=y
 # CONFIG_CMD_MII is not set
 CONFIG_OF_PRIOR_STAGE=y
+CONFIG_SIFIVE_SERIAL=y
Signature · 1 line
2.17.1
#7 lore raw

PATCH 2/2 riscv: qemu: Enable SiFive UART driver in defconfigs

Quoted 42 lines · anup at brainfault.org

This patch enables SiFive UART driver in all QEMU RISC-V defconfigs.

---
 configs/qemu-riscv32_defconfig       | 1 +
 configs/qemu-riscv32_smode_defconfig | 1 +
 configs/qemu-riscv64_defconfig       | 1 +
 configs/qemu-riscv64_smode_defconfig | 1 +
 4 files changed, 4 insertions(+)
configs/qemu-riscv32_defconfig +1 -0
index 6334d8c0fc..79c8d54cc7 100644
@@ -7,3 +7,4 @@ CONFIG_DISPLAY_CPUINFO=y
 CONFIG_DISPLAY_BOARDINFO=y
 # CONFIG_CMD_MII is not set
 CONFIG_OF_PRIOR_STAGE=y
+CONFIG_SIFIVE_SERIAL=y
configs/qemu-riscv32_smode_defconfig +1 -0
index 0a84ec1874..b733dbed2f 100644
@@ -8,3 +8,4 @@ CONFIG_DISPLAY_CPUINFO=y
 CONFIG_DISPLAY_BOARDINFO=y
 # CONFIG_CMD_MII is not set
 CONFIG_OF_PRIOR_STAGE=y
+CONFIG_SIFIVE_SERIAL=y
configs/qemu-riscv64_defconfig +1 -0
index 2d9ead93a2..a9d19a5574 100644
@@ -8,3 +8,4 @@ CONFIG_DISPLAY_CPUINFO=y
 CONFIG_DISPLAY_BOARDINFO=y
 # CONFIG_CMD_MII is not set
 CONFIG_OF_PRIOR_STAGE=y
+CONFIG_SIFIVE_SERIAL=y
configs/qemu-riscv64_smode_defconfig +0 -0
index b012443370..8adc23f826 100644

configs/qemu-riscv64_smode_defconfig CONFIG_DISPLAY_CPUINFO=y · line 12

Quoted 4 lines
configs/qemu-riscv64_smode_defconfig +1 -0
@@ -9,3 +9,4 @@ CONFIG_DISPLAY_CPUINFO=y
 CONFIG_DISPLAY_BOARDINFO=y
 # CONFIG_CMD_MII is not set
 CONFIG_OF_PRIOR_STAGE=y
+CONFIG_SIFIVE_SERIAL=y
#8 lore raw

PATCH 2/2 riscv: qemu: Enable SiFive UART driver in defconfigs

In reply to Anup Patel

Hi Anup,

Quoted 11 lines · Anup Patel

This patch enables SiFive UART driver in all QEMU RISC-V defconfigs.

---
 configs/qemu-riscv32_defconfig       | 1 +
 configs/qemu-riscv32_smode_defconfig | 1 +
 configs/qemu-riscv64_defconfig       | 1 +
 configs/qemu-riscv64_smode_defconfig | 1 +
 4 files changed, 4 insertions(+)

Can we "imply SIFIVE_SERIAL" in BOARD_SPECIFIC_OPTIONS in board/emulation/qemu-riscv/Kconfig instead?

[snip]

Regards,
Bin

author
#9 lore raw

PATCH 2/2 riscv: qemu: Enable SiFive UART driver in defconfigs

Quoted 16 lines · Bin Meng

Hi Anup,

Quoted 11 lines · Anup Patel

This patch enables SiFive UART driver in all QEMU RISC-V defconfigs.

---
 configs/qemu-riscv32_defconfig       | 1 +
 configs/qemu-riscv32_smode_defconfig | 1 +
 configs/qemu-riscv64_defconfig       | 1 +
 configs/qemu-riscv64_smode_defconfig | 1 +
 4 files changed, 4 insertions(+)
Quoted 2 lines

Can we "imply SIFIVE_SERIAL" in BOARD_SPECIFIC_OPTIONS in board/emulation/qemu-riscv/Kconfig instead?

Sure, will do. If it works then I will drop this patch.

Regards,
Anup

#10 lore raw

cover SiFive UART support

In reply to Anup Patel

Hi Anup,

Quoted 9 lines · Anup Patel

This patchset adds SiFive UART driver for SiFive UART found on SiFive boards.

The driver is tested on QEMU sifive_u machine. In fact, with this patchset same U-Boot binary boots on QEMU virt machine and QEMU sifive_u machine in both M-mode and S-mode.

I was unable to get this working with QEMU sifive_u target. I am using:

$ qemu-system-riscv64 -nographic -M sifive_u -kernel u-boot

with QEMU version 3.0.50

Quoted 4 lines

The patches are based upon latest RISC-V UBoot tree
(git://git.denx.de/u-boot-riscv.git) at commit id ce41c65382300b4be2b84df3c06c2aa6c591741d

Regards,
Bin