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 <dm.h>
   9 #include <errno.h>
  10 #include <fdtdec.h>
  11 #include <mapmem.h>
  12 #include <ns16550.h>
  13 #include <serial.h>
  14 #include <watchdog.h>
  15 #include <linux/types.h>
  16 #include <asm/io.h>
  17
  18 DECLARE_GLOBAL_DATA_PTR;
  19
  20 #define UART_LCRVAL UART_LCR_8N1                /* 8 data, 1 stop, no parity */
  21 #define UART_MCRVAL (UART_MCR_DTR | \
  22                      UART_MCR_RTS)              /* RTS/DTR */
  23 #define UART_FCRVAL (UART_FCR_FIFO_EN | \
  24                      UART_FCR_RXSR |    \
  25                      UART_FCR_TXSR)             /* Clear & enable FIFOs */
  26
  27 #ifndef CONFIG_DM_SERIAL
  28 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
  29 #define serial_out(x, y)        outb(x, (ulong)y)
  30 #define serial_in(y)            inb((ulong)y)
  31 #elif defined(CONFIG_SYS_NS16550_MEM32) && (CONFIG_SYS_NS16550_REG_SIZE > 0)
  32 #define serial_out(x, y)        out_be32(y, x)
  33 #define serial_in(y)            in_be32(y)
  34 #elif defined(CONFIG_SYS_NS16550_MEM32) && (CONFIG_SYS_NS16550_REG_SIZE < 0)
  35 #define serial_out(x, y)        out_le32(y, x)
  36 #define serial_in(y)            in_le32(y)
  37 #else
  38 #define serial_out(x, y)        writeb(x, y)
  39 #define serial_in(y)            readb(y)
  40 #endif
  41 #endif /* !CONFIG_DM_SERIAL */
  42
  43 #if defined(CONFIG_SOC_KEYSTONE)
  44 #define UART_REG_VAL_PWREMU_MGMT_UART_DISABLE   0
  45 #define UART_REG_VAL_PWREMU_MGMT_UART_ENABLE ((1 << 14) | (1 << 13) | (1 << 0))
  46 #undef UART_MCRVAL
  47 #ifdef CONFIG_SERIAL_HW_FLOW_CONTROL
  48 #define UART_MCRVAL             (UART_MCR_RTS | UART_MCR_AFE)
  49 #else
  50 #define UART_MCRVAL             (UART_MCR_RTS)
  51 #endif
  52 #endif
  53
  54 #ifndef CONFIG_SYS_NS16550_IER
  55 #define CONFIG_SYS_NS16550_IER  0x00
  56 #endif /* CONFIG_SYS_NS16550_IER */
  57
  58 #ifdef CONFIG_DM_SERIAL
  59
  60 static inline void serial_out_shift(void *addr, int shift, int value)
  61 {
  62 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
  63         outb(value, (ulong)addr);
  64 #elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
  65         out_le32(addr, value);
  66 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
  67         out_be32(addr, value);
  68 #elif defined(CONFIG_SYS_BIG_ENDIAN)
  69         writeb(value, addr + (1 << shift) - 1);
  70 #else
  71         writeb(value, addr);
  72 #endif
  73 }
  74
  75 static inline int serial_in_shift(void *addr, int shift)
  76 {
  77 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
  78         return inb((ulong)addr);
  79 #elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
  80         return in_le32(addr);
  81 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
  82         return in_be32(addr);
  83 #elif defined(CONFIG_SYS_BIG_ENDIAN)
  84         return readb(addr + (1 << shift) - 1);
  85 #else
  86         return readb(addr);
  87 #endif
  88 }
  89
  90 static void ns16550_writeb(NS16550_t port, int offset, int value)
  91 {
  92         struct ns16550_platdata *plat = port->plat;
  93         unsigned char *addr;
  94
  95         offset *= 1 << plat->reg_shift;
  96         addr = map_sysmem(plat->base, 0) + offset;
  97         /*
  98          * As far as we know it doesn't make sense to support selection of
  99          * these options at run-time, so use the existing CONFIG options.
 100          */
 101         serial_out_shift(addr, plat->reg_shift, value);
 102 }
 103
 104 static int ns16550_readb(NS16550_t port, int offset)
 105 {
 106         struct ns16550_platdata *plat = port->plat;
 107         unsigned char *addr;
 108
 109         offset *= 1 << plat->reg_shift;
 110         addr = map_sysmem(plat->base, 0) + offset;
 111
 112         return serial_in_shift(addr, plat->reg_shift);
 113 }
 114
 115 /* We can clean these up once everything is moved to driver model */
 116 #define serial_out(value, addr) \
 117         ns16550_writeb(com_port, \
 118                 (unsigned char *)addr - (unsigned char *)com_port, value)
 119 #define serial_in(addr) \
 120         ns16550_readb(com_port, \
 121                 (unsigned char *)addr - (unsigned char *)com_port)
 122 #endif
 123
 124 static inline int calc_divisor(NS16550_t port, int clock, int baudrate)
 125 {
 126         const unsigned int mode_x_div = 16;
 127
 128         return DIV_ROUND_CLOSEST(clock, mode_x_div * baudrate);
 129 }
 130
 131 int ns16550_calc_divisor(NS16550_t port, int clock, int baudrate)
 132 {
 133 #ifdef CONFIG_OMAP1510
 134         /* If can't cleanly clock 115200 set div to 1 */
 135         if ((clock == 12000000) && (baudrate == 115200)) {
 136                 port->osc_12m_sel = OSC_12M_SEL;  /* enable 6.5 * divisor */
 137                 return 1;                       /* return 1 for base divisor */
 138         }
 139         port->osc_12m_sel = 0;                  /* clear if previsouly set */
 140 #endif
 141
 142         return calc_divisor(port, clock, baudrate);
 143 }
 144
 145 static void NS16550_setbrg(NS16550_t com_port, int baud_divisor)
 146 {
 147         serial_out(UART_LCR_BKSE | UART_LCRVAL, &com_port->lcr);
 148         serial_out(baud_divisor & 0xff, &com_port->dll);
 149         serial_out((baud_divisor >> 8) & 0xff, &com_port->dlm);
 150         serial_out(UART_LCRVAL, &com_port->lcr);
 151 }
 152
 153 void NS16550_init(NS16550_t com_port, int baud_divisor)
 154 {
 155 #if (defined(CONFIG_SPL_BUILD) && \
 156                 (defined(CONFIG_OMAP34XX) || defined(CONFIG_OMAP44XX)))
 157         /*
 158          * On some OMAP3/OMAP4 devices when UART3 is configured for boot mode
 159          * before SPL starts only THRE bit is set. We have to empty the
 160          * transmitter before initialization starts.
 161          */
 162         if ((serial_in(&com_port->lsr) & (UART_LSR_TEMT | UART_LSR_THRE))
 163              == UART_LSR_THRE) {
 164                 if (baud_divisor != -1)
 165                         NS16550_setbrg(com_port, baud_divisor);
 166                 serial_out(0, &com_port->mdr1);
 167         }
 168 #endif
 169
 170         while (!(serial_in(&com_port->lsr) & UART_LSR_TEMT))
 171                 ;
 172
 173         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
 174 #if defined(CONFIG_OMAP) || defined(CONFIG_AM33XX) || \
 175                         defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
 176         serial_out(0x7, &com_port->mdr1);       /* mode select reset TL16C750*/
 177 #endif
 178         NS16550_setbrg(com_port, 0);
 179         serial_out(UART_MCRVAL, &com_port->mcr);
 180         serial_out(UART_FCRVAL, &com_port->fcr);
 181         if (baud_divisor != -1)
 182                 NS16550_setbrg(com_port, baud_divisor);
 183 #if defined(CONFIG_OMAP) || \
 184         defined(CONFIG_AM33XX) || defined(CONFIG_SOC_DA8XX) || \
 185         defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
 186
 187         /* /16 is proper to hit 115200 with 48MHz */
 188         serial_out(0, &com_port->mdr1);
 189 #endif /* CONFIG_OMAP */
 190 #if defined(CONFIG_SOC_KEYSTONE)
 191         serial_out(UART_REG_VAL_PWREMU_MGMT_UART_ENABLE, &com_port->regC);
 192 #endif
 193 }
 194
 195 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
 196 void NS16550_reinit(NS16550_t com_port, int baud_divisor)
 197 {
 198         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
 199         NS16550_setbrg(com_port, 0);
 200         serial_out(UART_MCRVAL, &com_port->mcr);
 201         serial_out(UART_FCRVAL, &com_port->fcr);
 202         NS16550_setbrg(com_port, baud_divisor);
 203 }
 204 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
 205
 206 void NS16550_putc(NS16550_t com_port, char c)
 207 {
 208         while ((serial_in(&com_port->lsr) & UART_LSR_THRE) == 0)
 209                 ;
 210         serial_out(c, &com_port->thr);
 211
 212         /*
 213          * Call watchdog_reset() upon newline. This is done here in putc
 214          * since the environment code uses a single puts() to print the complete
 215          * environment upon "printenv". So we can't put this watchdog call
 216          * in puts().
 217          */
 218         if (c == '\n')
 219                 WATCHDOG_RESET();
 220 }
 221
 222 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
 223 char NS16550_getc(NS16550_t com_port)
 224 {
 225         while ((serial_in(&com_port->lsr) & UART_LSR_DR) == 0) {
 226 #if !defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_TTY)
 227                 extern void usbtty_poll(void);
 228                 usbtty_poll();
 229 #endif
 230                 WATCHDOG_RESET();
 231         }
 232         return serial_in(&com_port->rbr);
 233 }
 234
 235 int NS16550_tstc(NS16550_t com_port)
 236 {
 237         return (serial_in(&com_port->lsr) & UART_LSR_DR) != 0;
 238 }
 239
 240 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
 241
 242 #ifdef CONFIG_DEBUG_UART_NS16550
 243
 244 #include <debug_uart.h>
 245
 246 void debug_uart_init(void)
 247 {
 248         struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
 249         int baud_divisor;
 250
 251         /*
 252          * We copy the code from above because it is already horribly messy.
 253          * Trying to refactor to nicely remove the duplication doesn't seem
 254          * feasible. The better fix is to move all users of this driver to
 255          * driver model.
 256          */
 257         baud_divisor = calc_divisor(com_port, CONFIG_DEBUG_UART_CLOCK,
 258                                     CONFIG_BAUDRATE);
 259         baud_divisor = 13;
 260         serial_out_shift(&com_port->ier, CONFIG_DEBUG_UART_SHIFT,
 261                          CONFIG_SYS_NS16550_IER);
 262         serial_out_shift(&com_port->mcr, CONFIG_DEBUG_UART_SHIFT, UART_MCRVAL);
 263         serial_out_shift(&com_port->fcr, CONFIG_DEBUG_UART_SHIFT, UART_FCRVAL);
 264
 265         serial_out_shift(&com_port->lcr, CONFIG_DEBUG_UART_SHIFT,
 266                          UART_LCR_BKSE | UART_LCRVAL);
 267         serial_out_shift(&com_port->dll, CONFIG_DEBUG_UART_SHIFT,
 268                          baud_divisor & 0xff);
 269         serial_out_shift(&com_port->dlm, CONFIG_DEBUG_UART_SHIFT,
 270                          (baud_divisor >> 8) & 0xff);
 271         serial_out_shift(&com_port->lcr, CONFIG_DEBUG_UART_SHIFT,
 272                          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_in_shift(&com_port->lsr, 0) & UART_LSR_THRE))
 280                 ;
 281         serial_out_shift(&com_port->thr, CONFIG_DEBUG_UART_SHIFT, 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 #ifdef CONFIG_OF_CONTROL
 353 int ns16550_serial_ofdata_to_platdata(struct udevice *dev)
 354 {
 355         struct ns16550_platdata *plat = dev->platdata;
 356         fdt_addr_t addr;
 357
 358         /* try Processor Local Bus device first */
 359         addr = fdtdec_get_addr(gd->fdt_blob, dev->of_offset, "reg");
 360 #ifdef CONFIG_PCI
 361         if (addr == FDT_ADDR_T_NONE) {
 362                 /* then try pci device */
 363                 struct fdt_pci_addr pci_addr;
 364                 u32 bar;
 365                 int ret;
 366
 367                 /* we prefer to use a memory-mapped register */
 368                 ret = fdtdec_get_pci_addr(gd->fdt_blob, dev->of_offset,
 369                                           FDT_PCI_SPACE_MEM32, "reg",
 370                                           &pci_addr);
 371                 if (ret) {
 372                         /* try if there is any i/o-mapped register */
 373                         ret = fdtdec_get_pci_addr(gd->fdt_blob,
 374                                                   dev->of_offset,
 375                                                   FDT_PCI_SPACE_IO,
 376                                                   "reg", &pci_addr);
 377                         if (ret)
 378                                 return ret;
 379                 }
 380
 381                 ret = fdtdec_get_pci_bar32(gd->fdt_blob, dev->of_offset,
 382                                            &pci_addr, &bar);
 383                 if (ret)
 384                         return ret;
 385
 386                 addr = bar;
 387         }
 388 #endif
 389
 390         if (addr == FDT_ADDR_T_NONE)
 391                 return -EINVAL;
 392
 393         plat->base = addr;
 394         plat->reg_shift = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
 395                                          "reg-shift", 1);
 396
 397         return 0;
 398 }
 399 #endif
 400
 401 const struct dm_serial_ops ns16550_serial_ops = {
 402         .putc = ns16550_serial_putc,
 403         .pending = ns16550_serial_pending,
 404         .getc = ns16550_serial_getc,
 405         .setbrg = ns16550_serial_setbrg,
 406 };
 407 #endif /* CONFIG_DM_SERIAL */