drivers/serial/ns16550.c

   1 /*
   2  * COM1 NS16550 support
   3  * originally from linux source (arch/powerpc/boot/ns16550.c)
   4  * modified to use CONFIG_SYS_ISA_MEM and new defines
   5  */
   6
   7 #include <common.h>
   8 #include <clk.h>
   9 #include <dm.h>
  10 #include <errno.h>
  11 #include <fdtdec.h>
  12 #include <ns16550.h>
  13 #include <serial.h>
  14 #include <watchdog.h>
  15 #include <linux/types.h>
  16 #include <linux/compiler.h>
  17 #include <asm/io.h>
  18
  19 DECLARE_GLOBAL_DATA_PTR;
  20
  21 #define UART_LCRVAL UART_LCR_8N1                /* 8 data, 1 stop, no parity */
  22 #define UART_MCRVAL (UART_MCR_DTR | \
  23                      UART_MCR_RTS)              /* RTS/DTR */
  24 #define UART_FCRVAL (UART_FCR_FIFO_EN | \
  25                      UART_FCR_RXSR |    \
  26                      UART_FCR_TXSR)             /* Clear & enable FIFOs */
  27
  28 #ifndef CONFIG_DM_SERIAL
  29 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
  30 #define serial_out(x, y)        outb(x, (ulong)y)
  31 #define serial_in(y)            inb((ulong)y)
  32 #elif defined(CONFIG_SYS_NS16550_MEM32) && (CONFIG_SYS_NS16550_REG_SIZE > 0)
  33 #define serial_out(x, y)        out_be32(y, x)
  34 #define serial_in(y)            in_be32(y)
  35 #elif defined(CONFIG_SYS_NS16550_MEM32) && (CONFIG_SYS_NS16550_REG_SIZE < 0)
  36 #define serial_out(x, y)        out_le32(y, x)
  37 #define serial_in(y)            in_le32(y)
  38 #else
  39 #define serial_out(x, y)        writeb(x, y)
  40 #define serial_in(y)            readb(y)
  41 #endif
  42 #endif /* !CONFIG_DM_SERIAL */
  43
  44 #if defined(CONFIG_SOC_KEYSTONE)
  45 #define UART_REG_VAL_PWREMU_MGMT_UART_DISABLE   0
  46 #define UART_REG_VAL_PWREMU_MGMT_UART_ENABLE ((1 << 14) | (1 << 13) | (1 << 0))
  47 #undef UART_MCRVAL
  48 #ifdef CONFIG_SERIAL_HW_FLOW_CONTROL
  49 #define UART_MCRVAL             (UART_MCR_RTS | UART_MCR_AFE)
  50 #else
  51 #define UART_MCRVAL             (UART_MCR_RTS)
  52 #endif
  53 #endif
  54
  55 #ifndef CONFIG_SYS_NS16550_IER
  56 #define CONFIG_SYS_NS16550_IER  0x00
  57 #endif /* CONFIG_SYS_NS16550_IER */
  58
  59 static inline void serial_out_shift(void *addr, int shift, int value)
  60 {
  61 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
  62         outb(value, (ulong)addr);
  63 #elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
  64         out_le32(addr, value);
  65 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
  66         out_be32(addr, value);
  67 #elif defined(CONFIG_SYS_NS16550_MEM32)
  68         writel(value, addr);
  69 #elif defined(CONFIG_SYS_BIG_ENDIAN)
  70         writeb(value, addr + (1 << shift) - 1);
  71 #else
  72         writeb(value, addr);
  73 #endif
  74 }
  75
  76 static inline int serial_in_shift(void *addr, int shift)
  77 {
  78 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
  79         return inb((ulong)addr);
  80 #elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
  81         return in_le32(addr);
  82 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
  83         return in_be32(addr);
  84 #elif defined(CONFIG_SYS_NS16550_MEM32)
  85         return readl(addr);
  86 #elif defined(CONFIG_SYS_BIG_ENDIAN)
  87         return readb(addr + (1 << shift) - 1);
  88 #else
  89         return readb(addr);
  90 #endif
  91 }
  92
  93 #ifdef CONFIG_DM_SERIAL
  94
  95 #ifndef CONFIG_SYS_NS16550_CLK
  96 #define CONFIG_SYS_NS16550_CLK  0
  97 #endif
  98
  99 static void ns16550_writeb(NS16550_t port, int offset, int value)
 100 {
 101         struct ns16550_platdata *plat = port->plat;
 102         unsigned char *addr;
 103
 104         offset *= 1 << plat->reg_shift;
 105         addr = (unsigned char *)plat->base + offset;
 106
 107         /*
 108          * As far as we know it doesn't make sense to support selection of
 109          * these options at run-time, so use the existing CONFIG options.
 110          */
 111         serial_out_shift(addr + plat->reg_offset, plat->reg_shift, value);
 112 }
 113
 114 static int ns16550_readb(NS16550_t port, int offset)
 115 {
 116         struct ns16550_platdata *plat = port->plat;
 117         unsigned char *addr;
 118
 119         offset *= 1 << plat->reg_shift;
 120         addr = (unsigned char *)plat->base + offset;
 121
 122         return serial_in_shift(addr + plat->reg_offset, plat->reg_shift);
 123 }
 124
 125 /* We can clean these up once everything is moved to driver model */
 126 #define serial_out(value, addr) \
 127         ns16550_writeb(com_port, \
 128                 (unsigned char *)addr - (unsigned char *)com_port, value)
 129 #define serial_in(addr) \
 130         ns16550_readb(com_port, \
 131                 (unsigned char *)addr - (unsigned char *)com_port)
 132 #endif
 133
 134 int ns16550_calc_divisor(NS16550_t port, int clock, int baudrate)
 135 {
 136         const unsigned int mode_x_div = 16;
 137
 138         return DIV_ROUND_CLOSEST(clock, mode_x_div * baudrate);
 139 }
 140
 141 static void NS16550_setbrg(NS16550_t com_port, int baud_divisor)
 142 {
 143         serial_out(UART_LCR_BKSE | UART_LCRVAL, &com_port->lcr);
 144         serial_out(baud_divisor & 0xff, &com_port->dll);
 145         serial_out((baud_divisor >> 8) & 0xff, &com_port->dlm);
 146         serial_out(UART_LCRVAL, &com_port->lcr);
 147 }
 148
 149 void NS16550_init(NS16550_t com_port, int baud_divisor)
 150 {
 151 #if (defined(CONFIG_SPL_BUILD) && \
 152                 (defined(CONFIG_OMAP34XX) || defined(CONFIG_OMAP44XX)))
 153         /*
 154          * On some OMAP3/OMAP4 devices when UART3 is configured for boot mode
 155          * before SPL starts only THRE bit is set. We have to empty the
 156          * transmitter before initialization starts.
 157          */
 158         if ((serial_in(&com_port->lsr) & (UART_LSR_TEMT | UART_LSR_THRE))
 159              == UART_LSR_THRE) {
 160                 if (baud_divisor != -1)
 161                         NS16550_setbrg(com_port, baud_divisor);
 162                 serial_out(0, &com_port->mdr1);
 163         }
 164 #endif
 165
 166         while (!(serial_in(&com_port->lsr) & UART_LSR_TEMT))
 167                 ;
 168
 169         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
 170 #if defined(CONFIG_OMAP) || defined(CONFIG_AM33XX) || \
 171                         defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
 172         serial_out(0x7, &com_port->mdr1);       /* mode select reset TL16C750*/
 173 #endif
 174         serial_out(UART_MCRVAL, &com_port->mcr);
 175         serial_out(UART_FCRVAL, &com_port->fcr);
 176         if (baud_divisor != -1)
 177                 NS16550_setbrg(com_port, baud_divisor);
 178 #if defined(CONFIG_OMAP) || \
 179         defined(CONFIG_AM33XX) || defined(CONFIG_SOC_DA8XX) || \
 180         defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
 181
 182         /* /16 is proper to hit 115200 with 48MHz */
 183         serial_out(0, &com_port->mdr1);
 184 #endif /* CONFIG_OMAP */
 185 #if defined(CONFIG_SOC_KEYSTONE)
 186         serial_out(UART_REG_VAL_PWREMU_MGMT_UART_ENABLE, &com_port->regC);
 187 #endif
 188 }
 189
 190 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
 191 void NS16550_reinit(NS16550_t com_port, int baud_divisor)
 192 {
 193         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
 194         NS16550_setbrg(com_port, 0);
 195         serial_out(UART_MCRVAL, &com_port->mcr);
 196         serial_out(UART_FCRVAL, &com_port->fcr);
 197         NS16550_setbrg(com_port, baud_divisor);
 198 }
 199 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
 200
 201 void NS16550_putc(NS16550_t com_port, char c)
 202 {
 203         while ((serial_in(&com_port->lsr) & UART_LSR_THRE) == 0)
 204                 ;
 205         serial_out(c, &com_port->thr);
 206
 207         /*
 208          * Call watchdog_reset() upon newline. This is done here in putc
 209          * since the environment code uses a single puts() to print the complete
 210          * environment upon "printenv". So we can't put this watchdog call
 211          * in puts().
 212          */
 213         if (c == '\n')
 214                 WATCHDOG_RESET();
 215 }
 216
 217 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
 218 char NS16550_getc(NS16550_t com_port)
 219 {
 220         while ((serial_in(&com_port->lsr) & UART_LSR_DR) == 0) {
 221 #if !defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_TTY)
 222                 extern void usbtty_poll(void);
 223                 usbtty_poll();
 224 #endif
 225                 WATCHDOG_RESET();
 226         }
 227         return serial_in(&com_port->rbr);
 228 }
 229
 230 int NS16550_tstc(NS16550_t com_port)
 231 {
 232         return (serial_in(&com_port->lsr) & UART_LSR_DR) != 0;
 233 }
 234
 235 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
 236
 237 #ifdef CONFIG_DEBUG_UART_NS16550
 238
 239 #include <debug_uart.h>
 240
 241 #define serial_dout(reg, value) \
 242         serial_out_shift((char *)com_port + \
 243                 ((char *)reg - (char *)com_port) * \
 244                         (1 << CONFIG_DEBUG_UART_SHIFT), \
 245                 CONFIG_DEBUG_UART_SHIFT, value)
 246 #define serial_din(reg) \
 247         serial_in_shift((char *)com_port + \
 248                 ((char *)reg - (char *)com_port) * \
 249                         (1 << CONFIG_DEBUG_UART_SHIFT), \
 250                 CONFIG_DEBUG_UART_SHIFT)
 251
 252 static inline void _debug_uart_init(void)
 253 {
 254         struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
 255         int baud_divisor;
 256
 257         /*
 258          * We copy the code from above because it is already horribly messy.
 259          * Trying to refactor to nicely remove the duplication doesn't seem
 260          * feasible. The better fix is to move all users of this driver to
 261          * driver model.
 262          */
 263         baud_divisor = ns16550_calc_divisor(com_port, CONFIG_DEBUG_UART_CLOCK,
 264                                             CONFIG_BAUDRATE);
 265         serial_dout(&com_port->ier, CONFIG_SYS_NS16550_IER);
 266         serial_dout(&com_port->mcr, UART_MCRVAL);
 267         serial_dout(&com_port->fcr, UART_FCRVAL);
 268
 269         serial_dout(&com_port->lcr, UART_LCR_BKSE | UART_LCRVAL);
 270         serial_dout(&com_port->dll, baud_divisor & 0xff);
 271         serial_dout(&com_port->dlm, (baud_divisor >> 8) & 0xff);
 272         serial_dout(&com_port->lcr, UART_LCRVAL);
 273 }
 274
 275 static inline void _debug_uart_putc(int ch)
 276 {
 277         struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
 278
 279         while (!(serial_din(&com_port->lsr) & UART_LSR_THRE))
 280                 ;
 281         serial_dout(&com_port->thr, ch);
 282 }
 283
 284 DEBUG_UART_FUNCS
 285
 286 #endif
 287
 288 #ifdef CONFIG_DM_SERIAL
 289 static int ns16550_serial_putc(struct udevice *dev, const char ch)
 290 {
 291         struct NS16550 *const com_port = dev_get_priv(dev);
 292
 293         if (!(serial_in(&com_port->lsr) & UART_LSR_THRE))
 294                 return -EAGAIN;
 295         serial_out(ch, &com_port->thr);
 296
 297         /*
 298          * Call watchdog_reset() upon newline. This is done here in putc
 299          * since the environment code uses a single puts() to print the complete
 300          * environment upon "printenv". So we can't put this watchdog call
 301          * in puts().
 302          */
 303         if (ch == '\n')
 304                 WATCHDOG_RESET();
 305
 306         return 0;
 307 }
 308
 309 static int ns16550_serial_pending(struct udevice *dev, bool input)
 310 {
 311         struct NS16550 *const com_port = dev_get_priv(dev);
 312
 313         if (input)
 314                 return serial_in(&com_port->lsr) & UART_LSR_DR ? 1 : 0;
 315         else
 316                 return serial_in(&com_port->lsr) & UART_LSR_THRE ? 0 : 1;
 317 }
 318
 319 static int ns16550_serial_getc(struct udevice *dev)
 320 {
 321         struct NS16550 *const com_port = dev_get_priv(dev);
 322
 323         if (!(serial_in(&com_port->lsr) & UART_LSR_DR))
 324                 return -EAGAIN;
 325
 326         return serial_in(&com_port->rbr);
 327 }
 328
 329 static int ns16550_serial_setbrg(struct udevice *dev, int baudrate)
 330 {
 331         struct NS16550 *const com_port = dev_get_priv(dev);
 332         struct ns16550_platdata *plat = com_port->plat;
 333         int clock_divisor;
 334
 335         clock_divisor = ns16550_calc_divisor(com_port, plat->clock, baudrate);
 336
 337         NS16550_setbrg(com_port, clock_divisor);
 338
 339         return 0;
 340 }
 341
 342 int ns16550_serial_probe(struct udevice *dev)
 343 {
 344         struct NS16550 *const com_port = dev_get_priv(dev);
 345
 346         com_port->plat = dev_get_platdata(dev);
 347         NS16550_init(com_port, -1);
 348
 349         return 0;
 350 }
 351
 352 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
 353 int ns16550_serial_ofdata_to_platdata(struct udevice *dev)
 354 {
 355         struct ns16550_platdata *plat = dev->platdata;
 356         fdt_addr_t addr;
 357         __maybe_unused struct clk clk;
 358         __maybe_unused int err;
 359
 360         /* try Processor Local Bus device first */
 361         addr = dev_get_addr(dev);
 362 #if defined(CONFIG_PCI) && defined(CONFIG_DM_PCI)
 363         if (addr == FDT_ADDR_T_NONE) {
 364                 /* then try pci device */
 365                 struct fdt_pci_addr pci_addr;
 366                 u32 bar;
 367                 int ret;
 368
 369                 /* we prefer to use a memory-mapped register */
 370                 ret = fdtdec_get_pci_addr(gd->fdt_blob, dev->of_offset,
 371                                           FDT_PCI_SPACE_MEM32, "reg",
 372                                           &pci_addr);
 373                 if (ret) {
 374                         /* try if there is any i/o-mapped register */
 375                         ret = fdtdec_get_pci_addr(gd->fdt_blob,
 376                                                   dev->of_offset,
 377                                                   FDT_PCI_SPACE_IO,
 378                                                   "reg", &pci_addr);
 379                         if (ret)
 380                                 return ret;
 381                 }
 382
 383                 ret = fdtdec_get_pci_bar32(dev, &pci_addr, &bar);
 384                 if (ret)
 385                         return ret;
 386
 387                 addr = bar;
 388         }
 389 #endif
 390
 391         if (addr == FDT_ADDR_T_NONE)
 392                 return -EINVAL;
 393
 394 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
 395         plat->base = addr;
 396 #else
 397         plat->base = (unsigned long)map_physmem(addr, 0, MAP_NOCACHE);
 398 #endif
 399
 400         plat->reg_offset = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
 401                                      "reg-offset", 0);
 402         plat->reg_shift = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
 403                                          "reg-shift", 0);
 404
 405 #ifdef CONFIG_CLK
 406         err = clk_get_by_index(dev, 0, &clk);
 407         if (!err) {
 408                 err = clk_get_rate(&clk);
 409                 if (!IS_ERR_VALUE(err))
 410                         plat->clock = err;
 411         } else if (err != -ENOENT && err != -ENODEV && err != -ENOSYS) {
 412                 debug("ns16550 failed to get clock\n");
 413                 return err;
 414         }
 415 #endif
 416
 417         if (!plat->clock)
 418                 plat->clock = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
 419                                              "clock-frequency",
 420                                              CONFIG_SYS_NS16550_CLK);
 421         if (!plat->clock) {
 422                 debug("ns16550 clock not defined\n");
 423                 return -EINVAL;
 424         }
 425
 426         return 0;
 427 }
 428 #endif
 429
 430 const struct dm_serial_ops ns16550_serial_ops = {
 431         .putc = ns16550_serial_putc,
 432         .pending = ns16550_serial_pending,
 433         .getc = ns16550_serial_getc,
 434         .setbrg = ns16550_serial_setbrg,
 435 };
 436
 437 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
 438 #if CONFIG_IS_ENABLED(OF_CONTROL)
 439 /*
 440  * Please consider existing compatible strings before adding a new
 441  * one to keep this table compact. Or you may add a generic "ns16550"
 442  * compatible string to your dts.
 443  */
 444 static const struct udevice_id ns16550_serial_ids[] = {
 445         { .compatible = "ns16550" },
 446         { .compatible = "ns16550a" },
 447         { .compatible = "nvidia,tegra20-uart" },
 448         { .compatible = "snps,dw-apb-uart" },
 449         { .compatible = "ti,omap2-uart" },
 450         { .compatible = "ti,omap3-uart" },
 451         { .compatible = "ti,omap4-uart" },
 452         { .compatible = "ti,am3352-uart" },
 453         { .compatible = "ti,am4372-uart" },
 454         { .compatible = "ti,dra742-uart" },
 455         {}
 456 };
 457 #endif
 458
 459 #if CONFIG_IS_ENABLED(SERIAL_PRESENT)
 460 U_BOOT_DRIVER(ns16550_serial) = {
 461         .name   = "ns16550_serial",
 462         .id     = UCLASS_SERIAL,
 463 #if CONFIG_IS_ENABLED(OF_CONTROL)
 464         .of_match = ns16550_serial_ids,
 465         .ofdata_to_platdata = ns16550_serial_ofdata_to_platdata,
 466         .platdata_auto_alloc_size = sizeof(struct ns16550_platdata),
 467 #endif
 468         .priv_auto_alloc_size = sizeof(struct NS16550),
 469         .probe = ns16550_serial_probe,
 470         .ops    = &ns16550_serial_ops,
 471         .flags  = DM_FLAG_PRE_RELOC,
 472 };
 473 #endif
 474 #endif /* !OF_PLATDATA */
 475 #endif /* CONFIG_DM_SERIAL */