]> git.sur5r.net Git - u-boot/blob - drivers/serial/ns16550.c
8d028de46afd8d802c061c35e35d356fb9a0f580
[u-boot] / 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(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 static void ns16550_writeb(NS16550_t port, int offset, int value)
94 {
95         struct ns16550_platdata *plat = port->plat;
96         unsigned char *addr;
97
98         offset *= 1 << plat->reg_shift;
99         addr = map_physmem(plat->base, 0, MAP_NOCACHE) + offset;
100         /*
101          * As far as we know it doesn't make sense to support selection of
102          * these options at run-time, so use the existing CONFIG options.
103          */
104         serial_out_shift(addr, plat->reg_shift, value);
105 }
106
107 static int ns16550_readb(NS16550_t port, int offset)
108 {
109         struct ns16550_platdata *plat = port->plat;
110         unsigned char *addr;
111
112         offset *= 1 << plat->reg_shift;
113         addr = map_physmem(plat->base, 0, MAP_NOCACHE) + offset;
114
115         return serial_in_shift(addr, plat->reg_shift);
116 }
117
118 /* We can clean these up once everything is moved to driver model */
119 #define serial_out(value, addr) \
120         ns16550_writeb(com_port, \
121                 (unsigned char *)addr - (unsigned char *)com_port, value)
122 #define serial_in(addr) \
123         ns16550_readb(com_port, \
124                 (unsigned char *)addr - (unsigned char *)com_port)
125 #endif
126
127 static inline int calc_divisor(NS16550_t port, int clock, int baudrate)
128 {
129         const unsigned int mode_x_div = 16;
130
131         return DIV_ROUND_CLOSEST(clock, mode_x_div * baudrate);
132 }
133
134 int ns16550_calc_divisor(NS16550_t port, int clock, int baudrate)
135 {
136 #ifdef CONFIG_OMAP1510
137         /* If can't cleanly clock 115200 set div to 1 */
138         if ((clock == 12000000) && (baudrate == 115200)) {
139                 port->osc_12m_sel = OSC_12M_SEL;  /* enable 6.5 * divisor */
140                 return 1;                       /* return 1 for base divisor */
141         }
142         port->osc_12m_sel = 0;                  /* clear if previsouly set */
143 #endif
144
145         return calc_divisor(port, clock, baudrate);
146 }
147
148 static void NS16550_setbrg(NS16550_t com_port, int baud_divisor)
149 {
150         serial_out(UART_LCR_BKSE | UART_LCRVAL, &com_port->lcr);
151         serial_out(baud_divisor & 0xff, &com_port->dll);
152         serial_out((baud_divisor >> 8) & 0xff, &com_port->dlm);
153         serial_out(UART_LCRVAL, &com_port->lcr);
154 }
155
156 void NS16550_init(NS16550_t com_port, int baud_divisor)
157 {
158 #if (defined(CONFIG_SPL_BUILD) && \
159                 (defined(CONFIG_OMAP34XX) || defined(CONFIG_OMAP44XX)))
160         /*
161          * On some OMAP3/OMAP4 devices when UART3 is configured for boot mode
162          * before SPL starts only THRE bit is set. We have to empty the
163          * transmitter before initialization starts.
164          */
165         if ((serial_in(&com_port->lsr) & (UART_LSR_TEMT | UART_LSR_THRE))
166              == UART_LSR_THRE) {
167                 if (baud_divisor != -1)
168                         NS16550_setbrg(com_port, baud_divisor);
169                 serial_out(0, &com_port->mdr1);
170         }
171 #endif
172
173         while (!(serial_in(&com_port->lsr) & UART_LSR_TEMT))
174                 ;
175
176         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
177 #if defined(CONFIG_OMAP) || defined(CONFIG_AM33XX) || \
178                         defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
179         serial_out(0x7, &com_port->mdr1);       /* mode select reset TL16C750*/
180 #endif
181         serial_out(UART_MCRVAL, &com_port->mcr);
182         serial_out(UART_FCRVAL, &com_port->fcr);
183         if (baud_divisor != -1)
184                 NS16550_setbrg(com_port, baud_divisor);
185 #if defined(CONFIG_OMAP) || \
186         defined(CONFIG_AM33XX) || defined(CONFIG_SOC_DA8XX) || \
187         defined(CONFIG_TI81XX) || defined(CONFIG_AM43XX)
188
189         /* /16 is proper to hit 115200 with 48MHz */
190         serial_out(0, &com_port->mdr1);
191 #endif /* CONFIG_OMAP */
192 #if defined(CONFIG_SOC_KEYSTONE)
193         serial_out(UART_REG_VAL_PWREMU_MGMT_UART_ENABLE, &com_port->regC);
194 #endif
195 }
196
197 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
198 void NS16550_reinit(NS16550_t com_port, int baud_divisor)
199 {
200         serial_out(CONFIG_SYS_NS16550_IER, &com_port->ier);
201         NS16550_setbrg(com_port, 0);
202         serial_out(UART_MCRVAL, &com_port->mcr);
203         serial_out(UART_FCRVAL, &com_port->fcr);
204         NS16550_setbrg(com_port, baud_divisor);
205 }
206 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
207
208 void NS16550_putc(NS16550_t com_port, char c)
209 {
210         while ((serial_in(&com_port->lsr) & UART_LSR_THRE) == 0)
211                 ;
212         serial_out(c, &com_port->thr);
213
214         /*
215          * Call watchdog_reset() upon newline. This is done here in putc
216          * since the environment code uses a single puts() to print the complete
217          * environment upon "printenv". So we can't put this watchdog call
218          * in puts().
219          */
220         if (c == '\n')
221                 WATCHDOG_RESET();
222 }
223
224 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
225 char NS16550_getc(NS16550_t com_port)
226 {
227         while ((serial_in(&com_port->lsr) & UART_LSR_DR) == 0) {
228 #if !defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_TTY)
229                 extern void usbtty_poll(void);
230                 usbtty_poll();
231 #endif
232                 WATCHDOG_RESET();
233         }
234         return serial_in(&com_port->rbr);
235 }
236
237 int NS16550_tstc(NS16550_t com_port)
238 {
239         return (serial_in(&com_port->lsr) & UART_LSR_DR) != 0;
240 }
241
242 #endif /* CONFIG_NS16550_MIN_FUNCTIONS */
243
244 #ifdef CONFIG_DEBUG_UART_NS16550
245
246 #include <debug_uart.h>
247
248 #define serial_dout(reg, value) \
249         serial_out_shift((char *)com_port + \
250                 ((char *)reg - (char *)com_port) * \
251                         (1 << CONFIG_DEBUG_UART_SHIFT), \
252                 CONFIG_DEBUG_UART_SHIFT, value)
253 #define serial_din(reg) \
254         serial_in_shift((char *)com_port + \
255                 ((char *)reg - (char *)com_port) * \
256                         (1 << CONFIG_DEBUG_UART_SHIFT), \
257                 CONFIG_DEBUG_UART_SHIFT)
258
259 static inline void _debug_uart_init(void)
260 {
261         struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
262         int baud_divisor;
263
264         /*
265          * We copy the code from above because it is already horribly messy.
266          * Trying to refactor to nicely remove the duplication doesn't seem
267          * feasible. The better fix is to move all users of this driver to
268          * driver model.
269          */
270         baud_divisor = calc_divisor(com_port, CONFIG_DEBUG_UART_CLOCK,
271                                     CONFIG_BAUDRATE);
272         serial_dout(&com_port->ier, CONFIG_SYS_NS16550_IER);
273         serial_dout(&com_port->mcr, UART_MCRVAL);
274         serial_dout(&com_port->fcr, UART_FCRVAL);
275
276         serial_dout(&com_port->lcr, UART_LCR_BKSE | UART_LCRVAL);
277         serial_dout(&com_port->dll, baud_divisor & 0xff);
278         serial_dout(&com_port->dlm, (baud_divisor >> 8) & 0xff);
279         serial_dout(&com_port->lcr, UART_LCRVAL);
280 }
281
282 static inline void _debug_uart_putc(int ch)
283 {
284         struct NS16550 *com_port = (struct NS16550 *)CONFIG_DEBUG_UART_BASE;
285
286         while (!(serial_din(&com_port->lsr) & UART_LSR_THRE))
287                 ;
288         serial_dout(&com_port->thr, ch);
289 }
290
291 DEBUG_UART_FUNCS
292
293 #endif
294
295 #ifdef CONFIG_DM_SERIAL
296 static int ns16550_serial_putc(struct udevice *dev, const char ch)
297 {
298         struct NS16550 *const com_port = dev_get_priv(dev);
299
300         if (!(serial_in(&com_port->lsr) & UART_LSR_THRE))
301                 return -EAGAIN;
302         serial_out(ch, &com_port->thr);
303
304         /*
305          * Call watchdog_reset() upon newline. This is done here in putc
306          * since the environment code uses a single puts() to print the complete
307          * environment upon "printenv". So we can't put this watchdog call
308          * in puts().
309          */
310         if (ch == '\n')
311                 WATCHDOG_RESET();
312
313         return 0;
314 }
315
316 static int ns16550_serial_pending(struct udevice *dev, bool input)
317 {
318         struct NS16550 *const com_port = dev_get_priv(dev);
319
320         if (input)
321                 return serial_in(&com_port->lsr) & UART_LSR_DR ? 1 : 0;
322         else
323                 return serial_in(&com_port->lsr) & UART_LSR_THRE ? 0 : 1;
324 }
325
326 static int ns16550_serial_getc(struct udevice *dev)
327 {
328         struct NS16550 *const com_port = dev_get_priv(dev);
329
330         if (!(serial_in(&com_port->lsr) & UART_LSR_DR))
331                 return -EAGAIN;
332
333         return serial_in(&com_port->rbr);
334 }
335
336 static int ns16550_serial_setbrg(struct udevice *dev, int baudrate)
337 {
338         struct NS16550 *const com_port = dev_get_priv(dev);
339         struct ns16550_platdata *plat = com_port->plat;
340         int clock_divisor;
341
342         clock_divisor = ns16550_calc_divisor(com_port, plat->clock, baudrate);
343
344         NS16550_setbrg(com_port, clock_divisor);
345
346         return 0;
347 }
348
349 int ns16550_serial_probe(struct udevice *dev)
350 {
351         struct NS16550 *const com_port = dev_get_priv(dev);
352
353         com_port->plat = dev_get_platdata(dev);
354         NS16550_init(com_port, -1);
355
356         return 0;
357 }
358
359 #if CONFIG_IS_ENABLED(OF_CONTROL)
360 int ns16550_serial_ofdata_to_platdata(struct udevice *dev)
361 {
362         struct ns16550_platdata *plat = dev->platdata;
363         fdt_addr_t addr;
364
365         /* try Processor Local Bus device first */
366         addr = dev_get_addr(dev);
367 #ifdef CONFIG_PCI
368         if (addr == FDT_ADDR_T_NONE) {
369                 /* then try pci device */
370                 struct fdt_pci_addr pci_addr;
371                 u32 bar;
372                 int ret;
373
374                 /* we prefer to use a memory-mapped register */
375                 ret = fdtdec_get_pci_addr(gd->fdt_blob, dev->of_offset,
376                                           FDT_PCI_SPACE_MEM32, "reg",
377                                           &pci_addr);
378                 if (ret) {
379                         /* try if there is any i/o-mapped register */
380                         ret = fdtdec_get_pci_addr(gd->fdt_blob,
381                                                   dev->of_offset,
382                                                   FDT_PCI_SPACE_IO,
383                                                   "reg", &pci_addr);
384                         if (ret)
385                                 return ret;
386                 }
387
388                 ret = fdtdec_get_pci_bar32(gd->fdt_blob, dev->of_offset,
389                                            &pci_addr, &bar);
390                 if (ret)
391                         return ret;
392
393                 addr = bar;
394         }
395 #endif
396
397         if (addr == FDT_ADDR_T_NONE)
398                 return -EINVAL;
399
400         plat->base = addr;
401         plat->reg_shift = fdtdec_get_int(gd->fdt_blob, dev->of_offset,
402                                          "reg-shift", 1);
403
404         return 0;
405 }
406 #endif
407
408 const struct dm_serial_ops ns16550_serial_ops = {
409         .putc = ns16550_serial_putc,
410         .pending = ns16550_serial_pending,
411         .getc = ns16550_serial_getc,
412         .setbrg = ns16550_serial_setbrg,
413 };
414 #endif /* CONFIG_DM_SERIAL */