serial: ns16550: Support run-time configuration
[oweals/u-boot.git] / drivers / serial / ns16550.c
index 9b423a591d8a3226db9c456f7738c413e1b6e563..31f6cfe421c26e6e59b7301096a3525779b422dc 100644 (file)
@@ -4,12 +4,13 @@
  * modified to use CONFIG_SYS_ISA_MEM and new defines
  */
 
+#include <clock_legacy.h>
 #include <common.h>
 #include <clk.h>
 #include <dm.h>
 #include <errno.h>
-#include <fdtdec.h>
 #include <ns16550.h>
+#include <reset.h>
 #include <serial.h>
 #include <watchdog.h>
 #include <linux/types.h>
@@ -20,11 +21,8 @@ DECLARE_GLOBAL_DATA_PTR;
 #define UART_LCRVAL UART_LCR_8N1               /* 8 data, 1 stop, no parity */
 #define UART_MCRVAL (UART_MCR_DTR | \
                     UART_MCR_RTS)              /* RTS/DTR */
-#define UART_FCRVAL (UART_FCR_FIFO_EN |        \
-                    UART_FCR_RXSR |    \
-                    UART_FCR_TXSR)             /* Clear & enable FIFOs */
 
-#ifndef CONFIG_DM_SERIAL
+#if !CONFIG_IS_ENABLED(DM_SERIAL)
 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
 #define serial_out(x, y)       outb(x, (ulong)y)
 #define serial_in(y)           inb((ulong)y)
@@ -59,7 +57,7 @@ static inline void serial_out_shift(void *addr, int shift, int value)
 {
 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
        outb(value, (ulong)addr);
-#elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
+#elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_LITTLE_ENDIAN)
        out_le32(addr, value);
 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
        out_be32(addr, value);
@@ -76,7 +74,7 @@ static inline int serial_in_shift(void *addr, int shift)
 {
 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
        return inb((ulong)addr);
-#elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
+#elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_LITTLE_ENDIAN)
        return in_le32(addr);
 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
        return in_be32(addr);
@@ -89,25 +87,85 @@ static inline int serial_in_shift(void *addr, int shift)
 #endif
 }
 
-#ifdef CONFIG_DM_SERIAL
+#if CONFIG_IS_ENABLED(DM_SERIAL)
 
 #ifndef CONFIG_SYS_NS16550_CLK
 #define CONFIG_SYS_NS16550_CLK  0
 #endif
 
+/*
+ * Use this #ifdef for now since many platforms don't define in(), out(),
+ * out_le32(), etc. but we don't have #defines to indicate this.
+ *
+ * TODO(sjg@chromium.org): Add CONFIG options to indicate what I/O is available
+ * on a platform
+ */
+#ifdef CONFIG_NS16550_DYNAMIC
+static void serial_out_dynamic(struct ns16550_platdata *plat, u8 *addr,
+                              int value)
+{
+       if (plat->flags & NS16550_FLAG_IO) {
+               outb(value, addr);
+       } else if (plat->reg_width == 4) {
+               if (plat->flags & NS16550_FLAG_ENDIAN) {
+                       if (plat->flags & NS16550_FLAG_BE)
+                               out_be32(addr, value);
+                       else
+                               out_le32(addr, value);
+               } else {
+                       writel(value, addr);
+               }
+       } else if (plat->flags & NS16550_FLAG_BE) {
+               writeb(value, addr + (1 << plat->reg_shift) - 1);
+       } else {
+               writeb(value, addr);
+       }
+}
+
+static int serial_in_dynamic(struct ns16550_platdata *plat, u8 *addr)
+{
+       if (plat->flags & NS16550_FLAG_IO) {
+               return inb(addr);
+       } else if (plat->reg_width == 4) {
+               if (plat->flags & NS16550_FLAG_ENDIAN) {
+                       if (plat->flags & NS16550_FLAG_BE)
+                               return in_be32(addr);
+                       else
+                               return in_le32(addr);
+               } else {
+                       return readl(addr);
+               }
+       } else if (plat->flags & NS16550_FLAG_BE) {
+               return readb(addr + (1 << plat->reg_shift) - 1);
+       } else {
+               return readb(addr);
+       }
+}
+#else
+static inline void serial_out_dynamic(struct ns16550_platdata *plat, u8 *addr,
+                                     int value)
+{
+}
+
+static inline int serial_in_dynamic(struct ns16550_platdata *plat, u8 *addr)
+{
+       return 0;
+}
+
+#endif /* CONFIG_NS16550_DYNAMIC */
+
 static void ns16550_writeb(NS16550_t port, int offset, int value)
 {
        struct ns16550_platdata *plat = port->plat;
        unsigned char *addr;
 
        offset *= 1 << plat->reg_shift;
-       addr = (unsigned char *)plat->base + offset;
+       addr = (unsigned char *)plat->base + offset + plat->reg_offset;
 
-       /*
-        * As far as we know it doesn't make sense to support selection of
-        * these options at run-time, so use the existing CONFIG options.
-        */
-       serial_out_shift(addr + plat->reg_offset, plat->reg_shift, value);
+       if (IS_ENABLED(CONFIG_NS16550_DYNAMIC))
+               serial_out_dynamic(plat, addr, value);
+       else
+               serial_out_shift(addr, plat->reg_shift, value);
 }
 
 static int ns16550_readb(NS16550_t port, int offset)
@@ -116,9 +174,12 @@ static int ns16550_readb(NS16550_t port, int offset)
        unsigned char *addr;
 
        offset *= 1 << plat->reg_shift;
-       addr = (unsigned char *)plat->base + offset;
+       addr = (unsigned char *)plat->base + offset + plat->reg_offset;
 
-       return serial_in_shift(addr + plat->reg_offset, plat->reg_shift);
+       if (IS_ENABLED(CONFIG_NS16550_DYNAMIC))
+               return serial_in_dynamic(plat, addr);
+       else
+               return serial_in_shift(addr, plat->reg_shift);
 }
 
 static u32 ns16550_getfcr(NS16550_t port)
@@ -138,7 +199,7 @@ static u32 ns16550_getfcr(NS16550_t port)
 #else
 static u32 ns16550_getfcr(NS16550_t port)
 {
-       return UART_FCRVAL;
+       return UART_FCR_DEFVAL;
 }
 #endif
 
@@ -151,10 +212,13 @@ int ns16550_calc_divisor(NS16550_t port, int clock, int baudrate)
 
 static void NS16550_setbrg(NS16550_t com_port, int baud_divisor)
 {
-       serial_out(UART_LCR_BKSE | UART_LCRVAL, &com_port->lcr);
+       /* to keep serial format, read lcr before writing BKSE */
+       int lcr_val = serial_in(&com_port->lcr) & ~UART_LCR_BKSE;
+
+       serial_out(UART_LCR_BKSE | lcr_val, &com_port->lcr);
        serial_out(baud_divisor & 0xff, &com_port->dll);
        serial_out((baud_divisor >> 8) & 0xff, &com_port->dlm);
-       serial_out(UART_LCRVAL, &com_port->lcr);
+       serial_out(lcr_val, &com_port->lcr);
 }
 
 void NS16550_init(NS16550_t com_port, int baud_divisor)
@@ -170,6 +234,13 @@ void NS16550_init(NS16550_t com_port, int baud_divisor)
             == UART_LSR_THRE) {
                if (baud_divisor != -1)
                        NS16550_setbrg(com_port, baud_divisor);
+               else {
+                       // Re-use old baud rate divisor to flush transmit reg.
+                       const int dll = serial_in(&com_port->dll);
+                       const int dlm = serial_in(&com_port->dlm);
+                       const int divisor = dll | (dlm << 8);
+                       NS16550_setbrg(com_port, divisor);
+               }
                serial_out(0, &com_port->mdr1);
        }
 #endif
@@ -178,21 +249,21 @@ void NS16550_init(NS16550_t com_port, int baud_divisor)
                ;
 
        serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
-#if defined(CONFIG_OMAP) || defined(CONFIG_AM33XX) || \
-                       defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
+#if defined(CONFIG_ARCH_OMAP2PLUS) || defined(CONFIG_OMAP_SERIAL)
        serial_out(0x7, &com_port->mdr1);       /* mode select reset TL16C750*/
 #endif
+
        serial_out(UART_MCRVAL, &com_port->mcr);
        serial_out(ns16550_getfcr(com_port), &com_port->fcr);
+       /* initialize serial config to 8N1 before writing baudrate */
+       serial_out(UART_LCRVAL, &com_port->lcr);
        if (baud_divisor != -1)
                NS16550_setbrg(com_port, baud_divisor);
-#if defined(CONFIG_OMAP) || \
-       defined(CONFIG_AM33XX) || defined(CONFIG_SOC_DA8XX) || \
-       defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
-
+#if defined(CONFIG_ARCH_OMAP2PLUS) || defined(CONFIG_SOC_DA8XX) || \
+       defined(CONFIG_OMAP_SERIAL)
        /* /16 is proper to hit 115200 with 48MHz */
        serial_out(0, &com_port->mdr1);
-#endif /* CONFIG_OMAP */
+#endif
 #if defined(CONFIG_SOC_KEYSTONE)
        serial_out(UART_REG_VAL_PWREMU_MGMT_UART_ENABLE, &com_port->regC);
 #endif
@@ -249,17 +320,6 @@ int NS16550_tstc(NS16550_t com_port)
 
 #include <debug_uart.h>
 
-#define serial_dout(reg, value)        \
-       serial_out_shift((char *)com_port + \
-               ((char *)reg - (char *)com_port) * \
-                       (1 << CONFIG_DEBUG_UART_SHIFT), \
-               CONFIG_DEBUG_UART_SHIFT, value)
-#define serial_din(reg) \
-       serial_in_shift((char *)com_port + \
-               ((char *)reg - (char *)com_port) * \
-                       (1 << CONFIG_DEBUG_UART_SHIFT), \
-               CONFIG_DEBUG_UART_SHIFT)
-
 static inline void _debug_uart_init(void)
 {
        struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
@@ -275,7 +335,7 @@ static inline void _debug_uart_init(void)
                                            CONFIG_BAUDRATE);
        serial_dout(&com_port->ier, CONFIG_SYS_NS16550_IER);
        serial_dout(&com_port->mcr, UART_MCRVAL);
-       serial_dout(&com_port->fcr, UART_FCRVAL);
+       serial_dout(&com_port->fcr, UART_FCR_DEFVAL);
 
        serial_dout(&com_port->lcr, UART_LCR_BKSE | UART_LCRVAL);
        serial_dout(&com_port->dll, baud_divisor & 0xff);
@@ -283,12 +343,28 @@ static inline void _debug_uart_init(void)
        serial_dout(&com_port->lcr, UART_LCRVAL);
 }
 
+static inline int NS16550_read_baud_divisor(struct NS16550 *com_port)
+{
+       int ret;
+
+       serial_dout(&com_port->lcr, UART_LCR_BKSE | UART_LCRVAL);
+       ret = serial_din(&com_port->dll) & 0xff;
+       ret |= (serial_din(&com_port->dlm) & 0xff) << 8;
+       serial_dout(&com_port->lcr, UART_LCRVAL);
+
+       return ret;
+}
+
 static inline void _debug_uart_putc(int ch)
 {
        struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
 
-       while (!(serial_din(&com_port->lsr) & UART_LSR_THRE))
-               ;
+       while (!(serial_din(&com_port->lsr) & UART_LSR_THRE)) {
+#ifdef CONFIG_DEBUG_UART_NS16550_CHECK_ENABLED
+               if (!NS16550_read_baud_divisor(com_port))
+                       return;
+#endif
+       }
        serial_dout(&com_port->thr, ch);
 }
 
@@ -296,7 +372,7 @@ DEBUG_UART_FUNCS
 
 #endif
 
-#ifdef CONFIG_DM_SERIAL
+#if CONFIG_IS_ENABLED(DM_SERIAL)
 static int ns16550_serial_putc(struct udevice *dev, const char ch)
 {
        struct NS16550 *const com_port = dev_get_priv(dev);
@@ -322,9 +398,9 @@ static int ns16550_serial_pending(struct udevice *dev, bool input)
        struct NS16550 *const com_port = dev_get_priv(dev);
 
        if (input)
-               return serial_in(&com_port->lsr) & UART_LSR_DR ? 1 : 0;
+               return (serial_in(&com_port->lsr) & UART_LSR_DR) ? 1 : 0;
        else
-               return serial_in(&com_port->lsr) & UART_LSR_THRE ? 0 : 1;
+               return (serial_in(&com_port->lsr) & UART_LSR_THRE) ? 0 : 1;
 }
 
 static int ns16550_serial_getc(struct udevice *dev)
@@ -350,9 +426,67 @@ static int ns16550_serial_setbrg(struct udevice *dev, int baudrate)
        return 0;
 }
 
+static int ns16550_serial_setconfig(struct udevice *dev, uint serial_config)
+{
+       struct NS16550 *const com_port = dev_get_priv(dev);
+       int lcr_val = UART_LCR_WLS_8;
+       uint parity = SERIAL_GET_PARITY(serial_config);
+       uint bits = SERIAL_GET_BITS(serial_config);
+       uint stop = SERIAL_GET_STOP(serial_config);
+
+       /*
+        * only parity config is implemented, check if other serial settings
+        * are the default one.
+        */
+       if (bits != SERIAL_8_BITS || stop != SERIAL_ONE_STOP)
+               return -ENOTSUPP; /* not supported in driver*/
+
+       switch (parity) {
+       case SERIAL_PAR_NONE:
+               /* no bits to add */
+               break;
+       case SERIAL_PAR_ODD:
+               lcr_val |= UART_LCR_PEN;
+               break;
+       case SERIAL_PAR_EVEN:
+               lcr_val |= UART_LCR_PEN | UART_LCR_EPS;
+               break;
+       default:
+               return -ENOTSUPP; /* not supported in driver*/
+       }
+
+       serial_out(lcr_val, &com_port->lcr);
+       return 0;
+}
+
+static int ns16550_serial_getinfo(struct udevice *dev,
+                                 struct serial_device_info *info)
+{
+       struct NS16550 *const com_port = dev_get_priv(dev);
+       struct ns16550_platdata *plat = com_port->plat;
+
+       info->type = SERIAL_CHIP_16550_COMPATIBLE;
+#ifdef CONFIG_SYS_NS16550_PORT_MAPPED
+       info->addr_space = SERIAL_ADDRESS_SPACE_IO;
+#else
+       info->addr_space = SERIAL_ADDRESS_SPACE_MEMORY;
+#endif
+       info->addr = plat->base;
+       info->reg_width = plat->reg_width;
+       info->reg_shift = plat->reg_shift;
+       info->reg_offset = plat->reg_offset;
+       return 0;
+}
+
 int ns16550_serial_probe(struct udevice *dev)
 {
        struct NS16550 *const com_port = dev_get_priv(dev);
+       struct reset_ctl_bulk reset_bulk;
+       int ret;
+
+       ret = reset_get_bulk(dev, &reset_bulk);
+       if (!ret)
+               reset_deassert_bulk(&reset_bulk);
 
        com_port->plat = dev_get_platdata(dev);
        NS16550_init(com_port, -1);
@@ -377,36 +511,7 @@ int ns16550_serial_ofdata_to_platdata(struct udevice *dev)
        int err;
 
        /* try Processor Local Bus device first */
-       addr = dev_get_addr(dev);
-#if defined(CONFIG_PCI) && defined(CONFIG_DM_PCI)
-       if (addr == FDT_ADDR_T_NONE) {
-               /* then try pci device */
-               struct fdt_pci_addr pci_addr;
-               u32 bar;
-               int ret;
-
-               /* we prefer to use a memory-mapped register */
-               ret = fdtdec_get_pci_addr(gd->fdt_blob, dev->of_offset,
-                                         FDT_PCI_SPACE_MEM32, "reg",
-                                         &pci_addr);
-               if (ret) {
-                       /* try if there is any i/o-mapped register */
-                       ret = fdtdec_get_pci_addr(gd->fdt_blob,
-                                                 dev->of_offset,
-                                                 FDT_PCI_SPACE_IO,
-                                                 "reg", &pci_addr);
-                       if (ret)
-                               return ret;
-               }
-
-               ret = fdtdec_get_pci_bar32(dev, &pci_addr, &bar);
-               if (ret)
-                       return ret;
-
-               addr = bar;
-       }
-#endif
-
+       addr = dev_read_addr_pci(dev);
        if (addr == FDT_ADDR_T_NONE)
                return -EINVAL;
 
@@ -416,10 +521,9 @@ int ns16550_serial_ofdata_to_platdata(struct udevice *dev)
        plat->base = (unsigned long)map_physmem(addr, 0, MAP_NOCACHE);
 #endif
 
-       plat->reg_offset = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
-                                    "reg-offset", 0);
-       plat->reg_shift = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
-                                        "reg-shift", 0);
+       plat->reg_offset = dev_read_u32_default(dev, "reg-offset", 0);
+       plat->reg_shift = dev_read_u32_default(dev, "reg-shift", 0);
+       plat->reg_width = dev_read_u32_default(dev, "reg-io-width", 1);
 
        err = clk_get_by_index(dev, 0, &clk);
        if (!err) {
@@ -432,15 +536,14 @@ int ns16550_serial_ofdata_to_platdata(struct udevice *dev)
        }
 
        if (!plat->clock)
-               plat->clock = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
-                                            "clock-frequency",
-                                            CONFIG_SYS_NS16550_CLK);
+               plat->clock = dev_read_u32_default(dev, "clock-frequency",
+                                                  CONFIG_SYS_NS16550_CLK);
        if (!plat->clock) {
                debug("ns16550 clock not defined\n");
                return -EINVAL;
        }
 
-       plat->fcr = UART_FCRVAL;
+       plat->fcr = UART_FCR_DEFVAL;
        if (port_type == PORT_JZ4780)
                plat->fcr |= UART_FCR_UME;
 
@@ -453,10 +556,11 @@ const struct dm_serial_ops ns16550_serial_ops = {
        .pending = ns16550_serial_pending,
        .getc = ns16550_serial_getc,
        .setbrg = ns16550_serial_setbrg,
+       .setconfig = ns16550_serial_setconfig,
+       .getinfo = ns16550_serial_getinfo,
 };
 
-#if !CONFIG_IS_ENABLED(OF_PLATDATA)
-#if CONFIG_IS_ENABLED(OF_CONTROL)
+#if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
 /*
  * Please consider existing compatible strings before adding a new
  * one to keep this table compact. Or you may add a generic "ns16550"
@@ -468,21 +572,18 @@ static const struct udevice_id ns16550_serial_ids[] = {
        { .compatible = "ingenic,jz4780-uart",  .data = PORT_JZ4780  },
        { .compatible = "nvidia,tegra20-uart",  .data = PORT_NS16550 },
        { .compatible = "snps,dw-apb-uart",     .data = PORT_NS16550 },
-       { .compatible = "ti,omap2-uart",        .data = PORT_NS16550 },
-       { .compatible = "ti,omap3-uart",        .data = PORT_NS16550 },
-       { .compatible = "ti,omap4-uart",        .data = PORT_NS16550 },
-       { .compatible = "ti,am3352-uart",       .data = PORT_NS16550 },
-       { .compatible = "ti,am4372-uart",       .data = PORT_NS16550 },
-       { .compatible = "ti,dra742-uart",       .data = PORT_NS16550 },
        {}
 };
-#endif
+#endif /* OF_CONTROL && !OF_PLATDATA */
 
 #if CONFIG_IS_ENABLED(SERIAL_PRESENT)
+
+/* TODO(sjg@chromium.org): Integrate this into a macro like CONFIG_IS_ENABLED */
+#if !defined(CONFIG_TPL_BUILD) || defined(CONFIG_TPL_DM_SERIAL)
 U_BOOT_DRIVER(ns16550_serial) = {
        .name   = "ns16550_serial",
        .id     = UCLASS_SERIAL,
-#if CONFIG_IS_ENABLED(OF_CONTROL)
+#if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
        .of_match = ns16550_serial_ids,
        .ofdata_to_platdata = ns16550_serial_ofdata_to_platdata,
        .platdata_auto_alloc_size = sizeof(struct ns16550_platdata),
@@ -490,8 +591,11 @@ U_BOOT_DRIVER(ns16550_serial) = {
        .priv_auto_alloc_size = sizeof(struct NS16550),
        .probe = ns16550_serial_probe,
        .ops    = &ns16550_serial_ops,
+#if !CONFIG_IS_ENABLED(OF_CONTROL)
        .flags  = DM_FLAG_PRE_RELOC,
+#endif
 };
 #endif
-#endif /* !OF_PLATDATA */
+#endif /* SERIAL_PRESENT */
+
 #endif /* CONFIG_DM_SERIAL */