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 <ns16550.h>
  12 #include <serial.h>
  13 #include <watchdog.h>
  14 #include <linux/types.h>
  15 #include <asm/io.h>
  16
  17 DECLARE_GLOBAL_DATA_PTR;
  18
  19 #define UART_LCRVAL UART_LCR_8N1                /* 8 data, 1 stop, no parity */
  20 #define UART_MCRVAL (UART_MCR_DTR | \
  21                      UART_MCR_RTS)              /* RTS/DTR */
  22 #define UART_FCRVAL (UART_FCR_FIFO_EN | \
  23                      UART_FCR_RXSR |    \
  24                      UART_FCR_TXSR)             /* Clear & enable FIFOs */
  25
  26 #ifndef CONFIG_DM_SERIAL
  27 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
  28 #define serial_out(x, y)        outb(x, (ulong)y)
  29 #define serial_in(y)            inb((ulong)y)
  30 #elif defined(CONFIG_SYS_NS16550_MEM32) && (CONFIG_SYS_NS16550_REG_SIZE > 0)
  31 #define serial_out(x, y)        out_be32(y, x)
  32 #define serial_in(y)            in_be32(y)
  33 #elif defined(CONFIG_SYS_NS16550_MEM32) && (CONFIG_SYS_NS16550_REG_SIZE < 0)
  34 #define serial_out(x, y)        out_le32(y, x)
  35 #define serial_in(y)            in_le32(y)
  36 #else
  37 #define serial_out(x, y)        writeb(x, y)
  38 #define serial_in(y)            readb(y)
  39 #endif
  40 #endif /* !CONFIG_DM_SERIAL */
  41
  42 #if defined(CONFIG_SOC_KEYSTONE)
  43 #define UART_REG_VAL_PWREMU_MGMT_UART_DISABLE   0
  44 #define UART_REG_VAL_PWREMU_MGMT_UART_ENABLE ((1 << 14) | (1 << 13) | (1 << 0))
  45 #undef UART_MCRVAL
  46 #ifdef CONFIG_SERIAL_HW_FLOW_CONTROL
  47 #define UART_MCRVAL             (UART_MCR_RTS | UART_MCR_AFE)
  48 #else
  49 #define UART_MCRVAL             (UART_MCR_RTS)
  50 #endif
  51 #endif
  52
  53 #ifndef CONFIG_SYS_NS16550_IER
  54 #define CONFIG_SYS_NS16550_IER  0x00
  55 #endif /* CONFIG_SYS_NS16550_IER */
  56
  57 #ifdef CONFIG_DM_SERIAL
  58
  59 static inline void serial_out_shift(unsigned char *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_BIG_ENDIAN)
  68         writeb(value, addr + (1 << shift) - 1);
  69 #else
  70         writeb(value, addr);
  71 #endif
  72 }
  73
  74 static inline int serial_in_shift(unsigned char *addr, int shift)
  75 {
  76 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
  77         return inb((ulong)addr);
  78 #elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
  79         return in_le32(addr);
  80 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
  81         return in_be32(addr);
  82 #elif defined(CONFIG_SYS_BIG_ENDIAN)
  83         return readb(addr + (1 << reg_shift) - 1);
  84 #else
  85         return readb(addr);
  86 #endif
  87 }
  88
  89 static void ns16550_writeb(NS16550_t port, int offset, int value)
  90 {
  91         struct ns16550_platdata *plat = port->plat;
  92         unsigned char *addr;
  93
  94         offset *= 1 << plat->reg_shift;
  95         addr = map_sysmem(plat->base, 0) + offset;
  96         /*
  97          * As far as we know it doesn't make sense to support selection of
  98          * these options at run-time, so use the existing CONFIG options.
  99          */
 100         serial_out_shift(addr, plat->reg_shift, value);
 101 }
 102
 103 static int ns16550_readb(NS16550_t port, int offset)
 104 {
 105         struct ns16550_platdata *plat = port->plat;
 106         unsigned char *addr;
 107
 108         offset *= 1 << plat->reg_shift;
 109         addr = map_sysmem(plat->base, 0) + offset;
 110
 111         return serial_in_shift(addr, plat->reg_shift);
 112 }
 113
 114 /* We can clean these up once everything is moved to driver model */
 115 #define serial_out(value, addr) \
 116         ns16550_writeb(com_port, addr - (unsigned char *)com_port, value)
 117 #define serial_in(addr) \
 118         ns16550_readb(com_port, addr - (unsigned char *)com_port)
 119 #endif
 120
 121 int ns16550_calc_divisor(NS16550_t port, int clock, int baudrate)
 122 {
 123         const unsigned int mode_x_div = 16;
 124
 125 #ifdef CONFIG_OMAP1510
 126         /* If can't cleanly clock 115200 set div to 1 */
 127         if ((clock == 12000000) && (baudrate == 115200)) {
 128                 port->osc_12m_sel = OSC_12M_SEL;  /* enable 6.5 * divisor */
 129                 return 1;                       /* return 1 for base divisor */
 130         }
 131         port->osc_12m_sel = 0;                  /* clear if previsouly set */
 132 #endif
 133
 134         return DIV_ROUND_CLOSEST(clock, mode_x_div * baudrate);
 135 }
 136
 137 static void NS16550_setbrg(NS16550_t com_port, int baud_divisor)
 138 {
 139         serial_out(UART_LCR_BKSE | UART_LCRVAL, &com_port->lcr);
 140         serial_out(baud_divisor & 0xff, &com_port->dll);
 141         serial_out((baud_divisor >> 8) & 0xff, &com_port->dlm);
 142         serial_out(UART_LCRVAL, &com_port->lcr);
 143 }
 144
 145 void NS16550_init(NS16550_t com_port, int baud_divisor)
 146 {
 147 #if (defined(CONFIG_SPL_BUILD) && \
 148                 (defined(CONFIG_OMAP34XX) || defined(CONFIG_OMAP44XX)))
 149         /*
 150          * On some OMAP3/OMAP4 devices when UART3 is configured for boot mode
 151          * before SPL starts only THRE bit is set. We have to empty the
 152          * transmitter before initialization starts.
 153          */
 154         if ((serial_in(&com_port->lsr) & (UART_LSR_TEMT | UART_LSR_THRE))
 155              == UART_LSR_THRE) {
 156                 if (baud_divisor != -1)
 157                         NS16550_setbrg(com_port, baud_divisor);
 158                 serial_out(0, &com_port->mdr1);
 159         }
 160 #endif
 161
 162         while (!(serial_in(&com_port->lsr) & UART_LSR_TEMT))
 163                 ;
 164
 165         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
 166 #if defined(CONFIG_OMAP) || defined(CONFIG_AM33XX) || \
 167                         defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
 168         serial_out(0x7, &com_port->mdr1);       /* mode select reset TL16C750*/
 169 #endif
 170         NS16550_setbrg(com_port, 0);
 171         serial_out(UART_MCRVAL, &com_port->mcr);
 172         serial_out(UART_FCRVAL, &com_port->fcr);
 173         if (baud_divisor != -1)
 174                 NS16550_setbrg(com_port, baud_divisor);
 175 #if defined(CONFIG_OMAP) || \
 176         defined(CONFIG_AM33XX) || defined(CONFIG_SOC_DA8XX) || \
 177         defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
 178
 179         /* /16 is proper to hit 115200 with 48MHz */
 180         serial_out(0, &com_port->mdr1);
 181 #endif /* CONFIG_OMAP */
 182 #if defined(CONFIG_SOC_KEYSTONE)
 183         serial_out(UART_REG_VAL_PWREMU_MGMT_UART_ENABLE, &com_port->regC);
 184 #endif
 185 }
 186
 187 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
 188 void NS16550_reinit(NS16550_t com_port, int baud_divisor)
 189 {
 190         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
 191         NS16550_setbrg(com_port, 0);
 192         serial_out(UART_MCRVAL, &com_port->mcr);
 193         serial_out(UART_FCRVAL, &com_port->fcr);
 194         NS16550_setbrg(com_port, baud_divisor);
 195 }
 196 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
 197
 198 void NS16550_putc(NS16550_t com_port, char c)
 199 {
 200         while ((serial_in(&com_port->lsr) & UART_LSR_THRE) == 0)
 201                 ;
 202         serial_out(c, &com_port->thr);
 203
 204         /*
 205          * Call watchdog_reset() upon newline. This is done here in putc
 206          * since the environment code uses a single puts() to print the complete
 207          * environment upon "printenv". So we can't put this watchdog call
 208          * in puts().
 209          */
 210         if (c == '\n')
 211                 WATCHDOG_RESET();
 212 }
 213
 214 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
 215 char NS16550_getc(NS16550_t com_port)
 216 {
 217         while ((serial_in(&com_port->lsr) & UART_LSR_DR) == 0) {
 218 #if !defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_TTY)
 219                 extern void usbtty_poll(void);
 220                 usbtty_poll();
 221 #endif
 222                 WATCHDOG_RESET();
 223         }
 224         return serial_in(&com_port->rbr);
 225 }
 226
 227 int NS16550_tstc(NS16550_t com_port)
 228 {
 229         return (serial_in(&com_port->lsr) & UART_LSR_DR) != 0;
 230 }
 231
 232 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
 233
 234 #ifdef CONFIG_DM_SERIAL
 235 static int ns16550_serial_putc(struct udevice *dev, const char ch)
 236 {
 237         struct NS16550 *const com_port = dev_get_priv(dev);
 238
 239         if (!(serial_in(&com_port->lsr) & UART_LSR_THRE))
 240                 return -EAGAIN;
 241         serial_out(ch, &com_port->thr);
 242
 243         /*
 244          * Call watchdog_reset() upon newline. This is done here in putc
 245          * since the environment code uses a single puts() to print the complete
 246          * environment upon "printenv". So we can't put this watchdog call
 247          * in puts().
 248          */
 249         if (ch == '\n')
 250                 WATCHDOG_RESET();
 251
 252         return 0;
 253 }
 254
 255 static int ns16550_serial_pending(struct udevice *dev, bool input)
 256 {
 257         struct NS16550 *const com_port = dev_get_priv(dev);
 258
 259         if (input)
 260                 return serial_in(&com_port->lsr) & UART_LSR_DR ? 1 : 0;
 261         else
 262                 return serial_in(&com_port->lsr) & UART_LSR_THRE ? 0 : 1;
 263 }
 264
 265 static int ns16550_serial_getc(struct udevice *dev)
 266 {
 267         struct NS16550 *const com_port = dev_get_priv(dev);
 268
 269         if (!(serial_in(&com_port->lsr) & UART_LSR_DR))
 270                 return -EAGAIN;
 271
 272         return serial_in(&com_port->rbr);
 273 }
 274
 275 static int ns16550_serial_setbrg(struct udevice *dev, int baudrate)
 276 {
 277         struct NS16550 *const com_port = dev_get_priv(dev);
 278         struct ns16550_platdata *plat = com_port->plat;
 279         int clock_divisor;
 280
 281         clock_divisor = ns16550_calc_divisor(com_port, plat->clock, baudrate);
 282
 283         NS16550_setbrg(com_port, clock_divisor);
 284
 285         return 0;
 286 }
 287
 288 int ns16550_serial_probe(struct udevice *dev)
 289 {
 290         struct NS16550 *const com_port = dev_get_priv(dev);
 291
 292         com_port->plat = dev_get_platdata(dev);
 293         NS16550_init(com_port, -1);
 294
 295         return 0;
 296 }
 297
 298 #ifdef CONFIG_OF_CONTROL
 299 int ns16550_serial_ofdata_to_platdata(struct udevice *dev)
 300 {
 301         struct ns16550_platdata *plat = dev->platdata;
 302         fdt_addr_t addr;
 303
 304         /* try Processor Local Bus device first */
 305         addr = fdtdec_get_addr(gd->fdt_blob, dev->of_offset, "reg");
 306 #ifdef CONFIG_PCI
 307         if (addr == FDT_ADDR_T_NONE) {
 308                 /* then try pci device */
 309                 struct fdt_pci_addr pci_addr;
 310                 u32 bar;
 311                 int ret;
 312
 313                 /* we prefer to use a memory-mapped register */
 314                 ret = fdtdec_get_pci_addr(gd->fdt_blob, dev->of_offset,
 315                                           FDT_PCI_SPACE_MEM32, "reg",
 316                                           &pci_addr);
 317                 if (ret) {
 318                         /* try if there is any i/o-mapped register */
 319                         ret = fdtdec_get_pci_addr(gd->fdt_blob,
 320                                                   dev->of_offset,
 321                                                   FDT_PCI_SPACE_IO,
 322                                                   "reg", &pci_addr);
 323                         if (ret)
 324                                 return ret;
 325                 }
 326
 327                 ret = fdtdec_get_pci_bar32(gd->fdt_blob, dev->of_offset,
 328                                            &pci_addr, &bar);
 329                 if (ret)
 330                         return ret;
 331
 332                 addr = bar;
 333         }
 334 #endif
 335
 336         if (addr == FDT_ADDR_T_NONE)
 337                 return -EINVAL;
 338
 339         plat->base = addr;
 340         plat->reg_shift = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
 341                                          "reg-shift", 1);
 342
 343         return 0;
 344 }
 345 #endif
 346
 347 const struct dm_serial_ops ns16550_serial_ops = {
 348         .putc = ns16550_serial_putc,
 349         .pending = ns16550_serial_pending,
 350         .getc = ns16550_serial_getc,
 351         .setbrg = ns16550_serial_setbrg,
 352 };
 353 #endif /* CONFIG_DM_SERIAL */