net: zynq_gem: Use ulong instead of u32 data type
[oweals/u-boot.git] / 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 <clock_legacy.h>
8 #include <common.h>
9 #include <clk.h>
10 #include <dm.h>
11 #include <errno.h>
12 #include <ns16550.h>
13 #include <reset.h>
14 #include <serial.h>
15 #include <watchdog.h>
16 #include <linux/err.h>
17 #include <linux/types.h>
18 #include <asm/io.h>
19
20 DECLARE_GLOBAL_DATA_PTR;
21
22 #define UART_LCRVAL UART_LCR_8N1                /* 8 data, 1 stop, no parity */
23 #define UART_MCRVAL (UART_MCR_DTR | \
24                      UART_MCR_RTS)              /* RTS/DTR */
25
26 #if !CONFIG_IS_ENABLED(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 static inline void serial_out_shift(void *addr, int shift, int value)
58 {
59 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
60         outb(value, (ulong)addr);
61 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_LITTLE_ENDIAN)
62         out_le32(addr, value);
63 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
64         out_be32(addr, value);
65 #elif defined(CONFIG_SYS_NS16550_MEM32)
66         writel(value, addr);
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(void *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_LITTLE_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_NS16550_MEM32)
83         return readl(addr);
84 #elif defined(CONFIG_SYS_BIG_ENDIAN)
85         return readb(addr + (1 << shift) - 1);
86 #else
87         return readb(addr);
88 #endif
89 }
90
91 #if CONFIG_IS_ENABLED(DM_SERIAL)
92
93 #ifndef CONFIG_SYS_NS16550_CLK
94 #define CONFIG_SYS_NS16550_CLK  0
95 #endif
96
97 /*
98  * Use this #ifdef for now since many platforms don't define in(), out(),
99  * out_le32(), etc. but we don't have #defines to indicate this.
100  *
101  * TODO(sjg@chromium.org): Add CONFIG options to indicate what I/O is available
102  * on a platform
103  */
104 #ifdef CONFIG_NS16550_DYNAMIC
105 static void serial_out_dynamic(struct ns16550_platdata *plat, u8 *addr,
106                                int value)
107 {
108         if (plat->flags & NS16550_FLAG_IO) {
109                 outb(value, addr);
110         } else if (plat->reg_width == 4) {
111                 if (plat->flags & NS16550_FLAG_ENDIAN) {
112                         if (plat->flags & NS16550_FLAG_BE)
113                                 out_be32(addr, value);
114                         else
115                                 out_le32(addr, value);
116                 } else {
117                         writel(value, addr);
118                 }
119         } else if (plat->flags & NS16550_FLAG_BE) {
120                 writeb(value, addr + (1 << plat->reg_shift) - 1);
121         } else {
122                 writeb(value, addr);
123         }
124 }
125
126 static int serial_in_dynamic(struct ns16550_platdata *plat, u8 *addr)
127 {
128         if (plat->flags & NS16550_FLAG_IO) {
129                 return inb(addr);
130         } else if (plat->reg_width == 4) {
131                 if (plat->flags & NS16550_FLAG_ENDIAN) {
132                         if (plat->flags & NS16550_FLAG_BE)
133                                 return in_be32(addr);
134                         else
135                                 return in_le32(addr);
136                 } else {
137                         return readl(addr);
138                 }
139         } else if (plat->flags & NS16550_FLAG_BE) {
140                 return readb(addr + (1 << plat->reg_shift) - 1);
141         } else {
142                 return readb(addr);
143         }
144 }
145 #else
146 static inline void serial_out_dynamic(struct ns16550_platdata *plat, u8 *addr,
147                                       int value)
148 {
149 }
150
151 static inline int serial_in_dynamic(struct ns16550_platdata *plat, u8 *addr)
152 {
153         return 0;
154 }
155
156 #endif /* CONFIG_NS16550_DYNAMIC */
157
158 static void ns16550_writeb(NS16550_t port, int offset, int value)
159 {
160         struct ns16550_platdata *plat = port->plat;
161         unsigned char *addr;
162
163         offset *= 1 << plat->reg_shift;
164         addr = (unsigned char *)plat->base + offset + plat->reg_offset;
165
166         if (IS_ENABLED(CONFIG_NS16550_DYNAMIC))
167                 serial_out_dynamic(plat, addr, value);
168         else
169                 serial_out_shift(addr, plat->reg_shift, value);
170 }
171
172 static int ns16550_readb(NS16550_t port, int offset)
173 {
174         struct ns16550_platdata *plat = port->plat;
175         unsigned char *addr;
176
177         offset *= 1 << plat->reg_shift;
178         addr = (unsigned char *)plat->base + offset + plat->reg_offset;
179
180         if (IS_ENABLED(CONFIG_NS16550_DYNAMIC))
181                 return serial_in_dynamic(plat, addr);
182         else
183                 return serial_in_shift(addr, plat->reg_shift);
184 }
185
186 static u32 ns16550_getfcr(NS16550_t port)
187 {
188         struct ns16550_platdata *plat = port->plat;
189
190         return plat->fcr;
191 }
192
193 /* We can clean these up once everything is moved to driver model */
194 #define serial_out(value, addr) \
195         ns16550_writeb(com_port, \
196                 (unsigned char *)addr - (unsigned char *)com_port, value)
197 #define serial_in(addr) \
198         ns16550_readb(com_port, \
199                 (unsigned char *)addr - (unsigned char *)com_port)
200 #else
201 static u32 ns16550_getfcr(NS16550_t port)
202 {
203         return UART_FCR_DEFVAL;
204 }
205 #endif
206
207 int ns16550_calc_divisor(NS16550_t port, int clock, int baudrate)
208 {
209         const unsigned int mode_x_div = 16;
210
211         return DIV_ROUND_CLOSEST(clock, mode_x_div * baudrate);
212 }
213
214 static void NS16550_setbrg(NS16550_t com_port, int baud_divisor)
215 {
216         /* to keep serial format, read lcr before writing BKSE */
217         int lcr_val = serial_in(&com_port->lcr) & ~UART_LCR_BKSE;
218
219         serial_out(UART_LCR_BKSE | lcr_val, &com_port->lcr);
220         serial_out(baud_divisor & 0xff, &com_port->dll);
221         serial_out((baud_divisor >> 8) & 0xff, &com_port->dlm);
222         serial_out(lcr_val, &com_port->lcr);
223 }
224
225 void NS16550_init(NS16550_t com_port, int baud_divisor)
226 {
227 #if (defined(CONFIG_SPL_BUILD) && \
228                 (defined(CONFIG_OMAP34XX) || defined(CONFIG_OMAP44XX)))
229         /*
230          * On some OMAP3/OMAP4 devices when UART3 is configured for boot mode
231          * before SPL starts only THRE bit is set. We have to empty the
232          * transmitter before initialization starts.
233          */
234         if ((serial_in(&com_port->lsr) & (UART_LSR_TEMT | UART_LSR_THRE))
235              == UART_LSR_THRE) {
236                 if (baud_divisor != -1)
237                         NS16550_setbrg(com_port, baud_divisor);
238                 else {
239                         // Re-use old baud rate divisor to flush transmit reg.
240                         const int dll = serial_in(&com_port->dll);
241                         const int dlm = serial_in(&com_port->dlm);
242                         const int divisor = dll | (dlm << 8);
243                         NS16550_setbrg(com_port, divisor);
244                 }
245                 serial_out(0, &com_port->mdr1);
246         }
247 #endif
248
249         while (!(serial_in(&com_port->lsr) & UART_LSR_TEMT))
250                 ;
251
252         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
253 #if defined(CONFIG_ARCH_OMAP2PLUS) || defined(CONFIG_OMAP_SERIAL)
254         serial_out(0x7, &com_port->mdr1);       /* mode select reset TL16C750*/
255 #endif
256
257         serial_out(UART_MCRVAL, &com_port->mcr);
258         serial_out(ns16550_getfcr(com_port), &com_port->fcr);
259         /* initialize serial config to 8N1 before writing baudrate */
260         serial_out(UART_LCRVAL, &com_port->lcr);
261         if (baud_divisor != -1)
262                 NS16550_setbrg(com_port, baud_divisor);
263 #if defined(CONFIG_ARCH_OMAP2PLUS) || defined(CONFIG_SOC_DA8XX) || \
264         defined(CONFIG_OMAP_SERIAL)
265         /* /16 is proper to hit 115200 with 48MHz */
266         serial_out(0, &com_port->mdr1);
267 #endif
268 #if defined(CONFIG_SOC_KEYSTONE)
269         serial_out(UART_REG_VAL_PWREMU_MGMT_UART_ENABLE, &com_port->regC);
270 #endif
271 }
272
273 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
274 void NS16550_reinit(NS16550_t com_port, int baud_divisor)
275 {
276         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
277         NS16550_setbrg(com_port, 0);
278         serial_out(UART_MCRVAL, &com_port->mcr);
279         serial_out(ns16550_getfcr(com_port), &com_port->fcr);
280         NS16550_setbrg(com_port, baud_divisor);
281 }
282 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
283
284 void NS16550_putc(NS16550_t com_port, char c)
285 {
286         while ((serial_in(&com_port->lsr) & UART_LSR_THRE) == 0)
287                 ;
288         serial_out(c, &com_port->thr);
289
290         /*
291          * Call watchdog_reset() upon newline. This is done here in putc
292          * since the environment code uses a single puts() to print the complete
293          * environment upon "printenv". So we can't put this watchdog call
294          * in puts().
295          */
296         if (c == '\n')
297                 WATCHDOG_RESET();
298 }
299
300 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
301 char NS16550_getc(NS16550_t com_port)
302 {
303         while ((serial_in(&com_port->lsr) & UART_LSR_DR) == 0) {
304 #if !defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_TTY)
305                 extern void usbtty_poll(void);
306                 usbtty_poll();
307 #endif
308                 WATCHDOG_RESET();
309         }
310         return serial_in(&com_port->rbr);
311 }
312
313 int NS16550_tstc(NS16550_t com_port)
314 {
315         return (serial_in(&com_port->lsr) & UART_LSR_DR) != 0;
316 }
317
318 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
319
320 #ifdef CONFIG_DEBUG_UART_NS16550
321
322 #include <debug_uart.h>
323
324 static inline void _debug_uart_init(void)
325 {
326         struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
327         int baud_divisor;
328
329         /*
330          * We copy the code from above because it is already horribly messy.
331          * Trying to refactor to nicely remove the duplication doesn't seem
332          * feasible. The better fix is to move all users of this driver to
333          * driver model.
334          */
335         baud_divisor = ns16550_calc_divisor(com_port, CONFIG_DEBUG_UART_CLOCK,
336                                             CONFIG_BAUDRATE);
337         serial_dout(&com_port->ier, CONFIG_SYS_NS16550_IER);
338         serial_dout(&com_port->mcr, UART_MCRVAL);
339         serial_dout(&com_port->fcr, UART_FCR_DEFVAL);
340
341         serial_dout(&com_port->lcr, UART_LCR_BKSE | UART_LCRVAL);
342         serial_dout(&com_port->dll, baud_divisor & 0xff);
343         serial_dout(&com_port->dlm, (baud_divisor >> 8) & 0xff);
344         serial_dout(&com_port->lcr, UART_LCRVAL);
345 }
346
347 static inline int NS16550_read_baud_divisor(struct NS16550 *com_port)
348 {
349         int ret;
350
351         serial_dout(&com_port->lcr, UART_LCR_BKSE | UART_LCRVAL);
352         ret = serial_din(&com_port->dll) & 0xff;
353         ret |= (serial_din(&com_port->dlm) & 0xff) << 8;
354         serial_dout(&com_port->lcr, UART_LCRVAL);
355
356         return ret;
357 }
358
359 static inline void _debug_uart_putc(int ch)
360 {
361         struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
362
363         while (!(serial_din(&com_port->lsr) & UART_LSR_THRE)) {
364 #ifdef CONFIG_DEBUG_UART_NS16550_CHECK_ENABLED
365                 if (!NS16550_read_baud_divisor(com_port))
366                         return;
367 #endif
368         }
369         serial_dout(&com_port->thr, ch);
370 }
371
372 DEBUG_UART_FUNCS
373
374 #endif
375
376 #if CONFIG_IS_ENABLED(DM_SERIAL)
377 static int ns16550_serial_putc(struct udevice *dev, const char ch)
378 {
379         struct NS16550 *const com_port = dev_get_priv(dev);
380
381         if (!(serial_in(&com_port->lsr) & UART_LSR_THRE))
382                 return -EAGAIN;
383         serial_out(ch, &com_port->thr);
384
385         /*
386          * Call watchdog_reset() upon newline. This is done here in putc
387          * since the environment code uses a single puts() to print the complete
388          * environment upon "printenv". So we can't put this watchdog call
389          * in puts().
390          */
391         if (ch == '\n')
392                 WATCHDOG_RESET();
393
394         return 0;
395 }
396
397 static int ns16550_serial_pending(struct udevice *dev, bool input)
398 {
399         struct NS16550 *const com_port = dev_get_priv(dev);
400
401         if (input)
402                 return (serial_in(&com_port->lsr) & UART_LSR_DR) ? 1 : 0;
403         else
404                 return (serial_in(&com_port->lsr) & UART_LSR_THRE) ? 0 : 1;
405 }
406
407 static int ns16550_serial_getc(struct udevice *dev)
408 {
409         struct NS16550 *const com_port = dev_get_priv(dev);
410
411         if (!(serial_in(&com_port->lsr) & UART_LSR_DR))
412                 return -EAGAIN;
413
414         return serial_in(&com_port->rbr);
415 }
416
417 static int ns16550_serial_setbrg(struct udevice *dev, int baudrate)
418 {
419         struct NS16550 *const com_port = dev_get_priv(dev);
420         struct ns16550_platdata *plat = com_port->plat;
421         int clock_divisor;
422
423         clock_divisor = ns16550_calc_divisor(com_port, plat->clock, baudrate);
424
425         NS16550_setbrg(com_port, clock_divisor);
426
427         return 0;
428 }
429
430 static int ns16550_serial_setconfig(struct udevice *dev, uint serial_config)
431 {
432         struct NS16550 *const com_port = dev_get_priv(dev);
433         int lcr_val = UART_LCR_WLS_8;
434         uint parity = SERIAL_GET_PARITY(serial_config);
435         uint bits = SERIAL_GET_BITS(serial_config);
436         uint stop = SERIAL_GET_STOP(serial_config);
437
438         /*
439          * only parity config is implemented, check if other serial settings
440          * are the default one.
441          */
442         if (bits != SERIAL_8_BITS || stop != SERIAL_ONE_STOP)
443                 return -ENOTSUPP; /* not supported in driver*/
444
445         switch (parity) {
446         case SERIAL_PAR_NONE:
447                 /* no bits to add */
448                 break;
449         case SERIAL_PAR_ODD:
450                 lcr_val |= UART_LCR_PEN;
451                 break;
452         case SERIAL_PAR_EVEN:
453                 lcr_val |= UART_LCR_PEN | UART_LCR_EPS;
454                 break;
455         default:
456                 return -ENOTSUPP; /* not supported in driver*/
457         }
458
459         serial_out(lcr_val, &com_port->lcr);
460         return 0;
461 }
462
463 static int ns16550_serial_getinfo(struct udevice *dev,
464                                   struct serial_device_info *info)
465 {
466         struct NS16550 *const com_port = dev_get_priv(dev);
467         struct ns16550_platdata *plat = com_port->plat;
468
469         info->type = SERIAL_CHIP_16550_COMPATIBLE;
470 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
471         info->addr_space = SERIAL_ADDRESS_SPACE_IO;
472 #else
473         info->addr_space = SERIAL_ADDRESS_SPACE_MEMORY;
474 #endif
475         info->addr = plat->base;
476         info->reg_width = plat->reg_width;
477         info->reg_shift = plat->reg_shift;
478         info->reg_offset = plat->reg_offset;
479         return 0;
480 }
481
482 int ns16550_serial_probe(struct udevice *dev)
483 {
484         struct NS16550 *const com_port = dev_get_priv(dev);
485         struct reset_ctl_bulk reset_bulk;
486         int ret;
487
488         ret = reset_get_bulk(dev, &reset_bulk);
489         if (!ret)
490                 reset_deassert_bulk(&reset_bulk);
491
492         com_port->plat = dev_get_platdata(dev);
493         NS16550_init(com_port, -1);
494
495         return 0;
496 }
497
498 #if CONFIG_IS_ENABLED(OF_CONTROL)
499 enum {
500         PORT_NS16550 = 0,
501         PORT_JZ4780,
502 };
503 #endif
504
505 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
506 int ns16550_serial_ofdata_to_platdata(struct udevice *dev)
507 {
508         struct ns16550_platdata *plat = dev->platdata;
509         const u32 port_type = dev_get_driver_data(dev);
510         fdt_addr_t addr;
511         struct clk clk;
512         int err;
513
514         /* try Processor Local Bus device first */
515         addr = dev_read_addr_pci(dev);
516         if (addr == FDT_ADDR_T_NONE)
517                 return -EINVAL;
518
519 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
520         plat->base = addr;
521 #else
522         plat->base = (unsigned long)map_physmem(addr, 0, MAP_NOCACHE);
523 #endif
524
525         plat->reg_offset = dev_read_u32_default(dev, "reg-offset", 0);
526         plat->reg_shift = dev_read_u32_default(dev, "reg-shift", 0);
527         plat->reg_width = dev_read_u32_default(dev, "reg-io-width", 1);
528
529         err = clk_get_by_index(dev, 0, &clk);
530         if (!err) {
531                 err = clk_get_rate(&clk);
532                 if (!IS_ERR_VALUE(err))
533                         plat->clock = err;
534         } else if (err != -ENOENT && err != -ENODEV && err != -ENOSYS) {
535                 debug("ns16550 failed to get clock\n");
536                 return err;
537         }
538
539         if (!plat->clock)
540                 plat->clock = dev_read_u32_default(dev, "clock-frequency",
541                                                    CONFIG_SYS_NS16550_CLK);
542         if (!plat->clock) {
543                 debug("ns16550 clock not defined\n");
544                 return -EINVAL;
545         }
546
547         plat->fcr = UART_FCR_DEFVAL;
548         if (port_type == PORT_JZ4780)
549                 plat->fcr |= UART_FCR_UME;
550
551         return 0;
552 }
553 #endif
554
555 const struct dm_serial_ops ns16550_serial_ops = {
556         .putc = ns16550_serial_putc,
557         .pending = ns16550_serial_pending,
558         .getc = ns16550_serial_getc,
559         .setbrg = ns16550_serial_setbrg,
560         .setconfig = ns16550_serial_setconfig,
561         .getinfo = ns16550_serial_getinfo,
562 };
563
564 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
565 /*
566  * Please consider existing compatible strings before adding a new
567  * one to keep this table compact. Or you may add a generic "ns16550"
568  * compatible string to your dts.
569  */
570 static const struct udevice_id ns16550_serial_ids[] = {
571         { .compatible = "ns16550",              .data = PORT_NS16550 },
572         { .compatible = "ns16550a",             .data = PORT_NS16550 },
573         { .compatible = "ingenic,jz4780-uart",  .data = PORT_JZ4780  },
574         { .compatible = "nvidia,tegra20-uart",  .data = PORT_NS16550 },
575         { .compatible = "snps,dw-apb-uart",     .data = PORT_NS16550 },
576         {}
577 };
578 #endif /* OF_CONTROL && !OF_PLATDATA */
579
580 #if CONFIG_IS_ENABLED(SERIAL_PRESENT)
581
582 /* TODO(sjg@chromium.org): Integrate this into a macro like CONFIG_IS_ENABLED */
583 #if !defined(CONFIG_TPL_BUILD) || defined(CONFIG_TPL_DM_SERIAL)
584 U_BOOT_DRIVER(ns16550_serial) = {
585         .name   = "ns16550_serial",
586         .id     = UCLASS_SERIAL,
587 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
588         .of_match = ns16550_serial_ids,
589         .ofdata_to_platdata = ns16550_serial_ofdata_to_platdata,
590         .platdata_auto_alloc_size = sizeof(struct ns16550_platdata),
591 #endif
592         .priv_auto_alloc_size = sizeof(struct NS16550),
593         .probe = ns16550_serial_probe,
594         .ops    = &ns16550_serial_ops,
595 #if !CONFIG_IS_ENABLED(OF_CONTROL)
596         .flags  = DM_FLAG_PRE_RELOC,
597 #endif
598 };
599 #endif
600 #endif /* SERIAL_PRESENT */
601
602 #endif /* CONFIG_DM_SERIAL */