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