Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * uartlite.c: Serial driver for Xilinx uartlite serial controller
4 *
5 * Copyright (C) 2006 Peter Korsgaard <jacmet@sunsite.dk>
6 * Copyright (C) 2007 Secret Lab Technologies Ltd.
7 */
8
9#include <linux/platform_device.h>
10#include <linux/module.h>
11#include <linux/bitfield.h>
12#include <linux/console.h>
13#include <linux/serial.h>
14#include <linux/serial_core.h>
15#include <linux/tty.h>
16#include <linux/tty_flip.h>
17#include <linux/delay.h>
18#include <linux/interrupt.h>
19#include <linux/init.h>
20#include <linux/io.h>
21#include <linux/iopoll.h>
22#include <linux/of.h>
23#include <linux/clk.h>
24#include <linux/pm_runtime.h>
25
26#define ULITE_NAME "ttyUL"
27#if CONFIG_SERIAL_UARTLITE_NR_UARTS > 4
28#define ULITE_MAJOR 0 /* use dynamic node allocation */
29#define ULITE_MINOR 0
30#else
31#define ULITE_MAJOR 204
32#define ULITE_MINOR 187
33#endif
34#define ULITE_NR_UARTS CONFIG_SERIAL_UARTLITE_NR_UARTS
35
36/* ---------------------------------------------------------------------
37 * Register definitions
38 *
39 * For register details see datasheet:
40 * https://www.xilinx.com/support/documentation/ip_documentation/opb_uartlite.pdf
41 */
42
43#define ULITE_RX 0x00
44#define ULITE_TX 0x04
45#define ULITE_STATUS 0x08
46#define ULITE_CONTROL 0x0c
47
48#define ULITE_REGION 16
49
50#define ULITE_STATUS_RXVALID 0x01
51#define ULITE_STATUS_RXFULL 0x02
52#define ULITE_STATUS_TXEMPTY 0x04
53#define ULITE_STATUS_TXFULL 0x08
54#define ULITE_STATUS_IE 0x10
55#define ULITE_STATUS_OVERRUN 0x20
56#define ULITE_STATUS_FRAME 0x40
57#define ULITE_STATUS_PARITY 0x80
58
59#define ULITE_CONTROL_RST_TX 0x01
60#define ULITE_CONTROL_RST_RX 0x02
61#define ULITE_CONTROL_IE 0x10
62#define UART_AUTOSUSPEND_TIMEOUT 3000 /* ms */
63
64/* Static pointer to console port */
65#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
66static struct uart_port *console_port;
67#endif
68
69/**
70 * struct uartlite_data - Driver private data
71 * @reg_ops: Functions to read/write registers
72 * @clk: Our parent clock, if present
73 * @baud: The baud rate configured when this device was synthesized
74 * @cflags: The cflags for parity and data bits
75 */
76struct uartlite_data {
77 const struct uartlite_reg_ops *reg_ops;
78 struct clk *clk;
79 unsigned int baud;
80 tcflag_t cflags;
81};
82
83struct uartlite_reg_ops {
84 u32 (*in)(void __iomem *addr);
85 void (*out)(u32 val, void __iomem *addr);
86};
87
88static u32 uartlite_inbe32(void __iomem *addr)
89{
90 return ioread32be(addr);
91}
92
93static void uartlite_outbe32(u32 val, void __iomem *addr)
94{
95 iowrite32be(val, addr);
96}
97
98static const struct uartlite_reg_ops uartlite_be = {
99 .in = uartlite_inbe32,
100 .out = uartlite_outbe32,
101};
102
103static u32 uartlite_inle32(void __iomem *addr)
104{
105 return ioread32(addr);
106}
107
108static void uartlite_outle32(u32 val, void __iomem *addr)
109{
110 iowrite32(val, addr);
111}
112
113static const struct uartlite_reg_ops uartlite_le = {
114 .in = uartlite_inle32,
115 .out = uartlite_outle32,
116};
117
118static inline u32 uart_in32(u32 offset, struct uart_port *port)
119{
120 struct uartlite_data *pdata = port->private_data;
121
122 return pdata->reg_ops->in(port->membase + offset);
123}
124
125static inline void uart_out32(u32 val, u32 offset, struct uart_port *port)
126{
127 struct uartlite_data *pdata = port->private_data;
128
129 pdata->reg_ops->out(val, port->membase + offset);
130}
131
132static struct uart_port ulite_ports[ULITE_NR_UARTS];
133
134static struct uart_driver ulite_uart_driver;
135
136/* ---------------------------------------------------------------------
137 * Core UART driver operations
138 */
139
140static int ulite_receive(struct uart_port *port, int stat)
141{
142 struct tty_port *tport = &port->state->port;
143 unsigned char ch = 0;
144 char flag = TTY_NORMAL;
145
146 if ((stat & (ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
147 | ULITE_STATUS_FRAME)) == 0)
148 return 0;
149
150 /* stats */
151 if (stat & ULITE_STATUS_RXVALID) {
152 port->icount.rx++;
153 ch = uart_in32(ULITE_RX, port);
154
155 if (stat & ULITE_STATUS_PARITY)
156 port->icount.parity++;
157 }
158
159 if (stat & ULITE_STATUS_OVERRUN)
160 port->icount.overrun++;
161
162 if (stat & ULITE_STATUS_FRAME)
163 port->icount.frame++;
164
165
166 /* drop byte with parity error if IGNPAR specificed */
167 if (stat & port->ignore_status_mask & ULITE_STATUS_PARITY)
168 stat &= ~ULITE_STATUS_RXVALID;
169
170 stat &= port->read_status_mask;
171
172 if (stat & ULITE_STATUS_PARITY)
173 flag = TTY_PARITY;
174
175
176 stat &= ~port->ignore_status_mask;
177
178 if (stat & ULITE_STATUS_RXVALID)
179 tty_insert_flip_char(tport, ch, flag);
180
181 if (stat & ULITE_STATUS_FRAME)
182 tty_insert_flip_char(tport, 0, TTY_FRAME);
183
184 if (stat & ULITE_STATUS_OVERRUN)
185 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
186
187 return 1;
188}
189
190static int ulite_transmit(struct uart_port *port, int stat)
191{
192 struct tty_port *tport = &port->state->port;
193 unsigned char ch;
194
195 if (stat & ULITE_STATUS_TXFULL)
196 return 0;
197
198 if (port->x_char) {
199 uart_out32(port->x_char, ULITE_TX, port);
200 port->x_char = 0;
201 port->icount.tx++;
202 return 1;
203 }
204
205 if (uart_tx_stopped(port))
206 return 0;
207
208 if (!uart_fifo_get(port, &ch))
209 return 0;
210
211 uart_out32(ch, ULITE_TX, port);
212
213 /* wake up */
214 if (kfifo_len(&tport->xmit_fifo) < WAKEUP_CHARS)
215 uart_write_wakeup(port);
216
217 return 1;
218}
219
220static irqreturn_t ulite_isr(int irq, void *dev_id)
221{
222 struct uart_port *port = dev_id;
223 int stat, busy, n = 0;
224 unsigned long flags;
225
226 do {
227 uart_port_lock_irqsave(port, &flags);
228 stat = uart_in32(ULITE_STATUS, port);
229 busy = ulite_receive(port, stat);
230 busy |= ulite_transmit(port, stat);
231 uart_port_unlock_irqrestore(port, flags);
232 n++;
233 } while (busy);
234
235 /* work done? */
236 if (n > 1) {
237 tty_flip_buffer_push(&port->state->port);
238 return IRQ_HANDLED;
239 } else {
240 return IRQ_NONE;
241 }
242}
243
244static unsigned int ulite_tx_empty(struct uart_port *port)
245{
246 unsigned long flags;
247 unsigned int ret;
248
249 uart_port_lock_irqsave(port, &flags);
250 ret = uart_in32(ULITE_STATUS, port);
251 uart_port_unlock_irqrestore(port, flags);
252
253 return ret & ULITE_STATUS_TXEMPTY ? TIOCSER_TEMT : 0;
254}
255
256static unsigned int ulite_get_mctrl(struct uart_port *port)
257{
258 return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
259}
260
261static void ulite_set_mctrl(struct uart_port *port, unsigned int mctrl)
262{
263 /* N/A */
264}
265
266static void ulite_stop_tx(struct uart_port *port)
267{
268 /* N/A */
269}
270
271static void ulite_start_tx(struct uart_port *port)
272{
273 ulite_transmit(port, uart_in32(ULITE_STATUS, port));
274}
275
276static void ulite_stop_rx(struct uart_port *port)
277{
278 /* don't forward any more data (like !CREAD) */
279 port->ignore_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
280 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
281}
282
283static void ulite_break_ctl(struct uart_port *port, int ctl)
284{
285 /* N/A */
286}
287
288static int ulite_startup(struct uart_port *port)
289{
290 struct uartlite_data *pdata = port->private_data;
291 int ret;
292
293 ret = clk_enable(pdata->clk);
294 if (ret) {
295 dev_err(port->dev, "Failed to enable clock\n");
296 return ret;
297 }
298
299 ret = request_irq(port->irq, ulite_isr, IRQF_SHARED | IRQF_TRIGGER_RISING,
300 "uartlite", port);
301 if (ret)
302 return ret;
303
304 uart_out32(ULITE_CONTROL_RST_RX | ULITE_CONTROL_RST_TX,
305 ULITE_CONTROL, port);
306 uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
307
308 return 0;
309}
310
311static void ulite_shutdown(struct uart_port *port)
312{
313 struct uartlite_data *pdata = port->private_data;
314
315 uart_out32(0, ULITE_CONTROL, port);
316 uart_in32(ULITE_CONTROL, port); /* dummy */
317 free_irq(port->irq, port);
318 clk_disable(pdata->clk);
319}
320
321static void ulite_set_termios(struct uart_port *port,
322 struct ktermios *termios,
323 const struct ktermios *old)
324{
325 unsigned long flags;
326 struct uartlite_data *pdata = port->private_data;
327
328 /* Set termios to what the hardware supports */
329 termios->c_iflag &= ~BRKINT;
330 termios->c_cflag &= ~(CSTOPB | PARENB | PARODD | CSIZE);
331 termios->c_cflag |= pdata->cflags & (PARENB | PARODD | CSIZE);
332 tty_termios_encode_baud_rate(termios, pdata->baud, pdata->baud);
333
334 uart_port_lock_irqsave(port, &flags);
335
336 port->read_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
337 | ULITE_STATUS_TXFULL;
338
339 if (termios->c_iflag & INPCK)
340 port->read_status_mask |=
341 ULITE_STATUS_PARITY | ULITE_STATUS_FRAME;
342
343 port->ignore_status_mask = 0;
344 if (termios->c_iflag & IGNPAR)
345 port->ignore_status_mask |= ULITE_STATUS_PARITY
346 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
347
348 /* ignore all characters if CREAD is not set */
349 if ((termios->c_cflag & CREAD) == 0)
350 port->ignore_status_mask |=
351 ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
352 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
353
354 /* update timeout */
355 uart_update_timeout(port, termios->c_cflag, pdata->baud);
356
357 uart_port_unlock_irqrestore(port, flags);
358}
359
360static const char *ulite_type(struct uart_port *port)
361{
362 return port->type == PORT_UARTLITE ? "uartlite" : NULL;
363}
364
365static void ulite_release_port(struct uart_port *port)
366{
367 release_mem_region(port->mapbase, ULITE_REGION);
368 iounmap(port->membase);
369 port->membase = NULL;
370}
371
372static int ulite_request_port(struct uart_port *port)
373{
374 struct uartlite_data *pdata = port->private_data;
375 int ret;
376
377 pr_debug("ulite console: port=%p; port->mapbase=%llx\n",
378 port, (unsigned long long) port->mapbase);
379
380 if (!request_mem_region(port->mapbase, ULITE_REGION, "uartlite")) {
381 dev_err(port->dev, "Memory region busy\n");
382 return -EBUSY;
383 }
384
385 port->membase = ioremap(port->mapbase, ULITE_REGION);
386 if (!port->membase) {
387 dev_err(port->dev, "Unable to map registers\n");
388 release_mem_region(port->mapbase, ULITE_REGION);
389 return -EBUSY;
390 }
391
392 pdata->reg_ops = &uartlite_be;
393 ret = uart_in32(ULITE_CONTROL, port);
394 uart_out32(ULITE_CONTROL_RST_TX, ULITE_CONTROL, port);
395 ret = uart_in32(ULITE_STATUS, port);
396 /* Endianess detection */
397 if ((ret & ULITE_STATUS_TXEMPTY) != ULITE_STATUS_TXEMPTY)
398 pdata->reg_ops = &uartlite_le;
399
400 return 0;
401}
402
403static void ulite_config_port(struct uart_port *port, int flags)
404{
405 if (!ulite_request_port(port))
406 port->type = PORT_UARTLITE;
407}
408
409static int ulite_verify_port(struct uart_port *port, struct serial_struct *ser)
410{
411 /* we don't want the core code to modify any port params */
412 return -EINVAL;
413}
414
415static void ulite_pm(struct uart_port *port, unsigned int state,
416 unsigned int oldstate)
417{
418 int ret;
419
420 if (!state) {
421 ret = pm_runtime_get_sync(port->dev);
422 if (ret < 0)
423 dev_err(port->dev, "Failed to enable clocks\n");
424 } else {
425 pm_runtime_mark_last_busy(port->dev);
426 pm_runtime_put_autosuspend(port->dev);
427 }
428}
429
430#ifdef CONFIG_CONSOLE_POLL
431static int ulite_get_poll_char(struct uart_port *port)
432{
433 if (!(uart_in32(ULITE_STATUS, port) & ULITE_STATUS_RXVALID))
434 return NO_POLL_CHAR;
435
436 return uart_in32(ULITE_RX, port);
437}
438
439static void ulite_put_poll_char(struct uart_port *port, unsigned char ch)
440{
441 while (uart_in32(ULITE_STATUS, port) & ULITE_STATUS_TXFULL)
442 cpu_relax();
443
444 /* write char to device */
445 uart_out32(ch, ULITE_TX, port);
446}
447#endif
448
449static const struct uart_ops ulite_ops = {
450 .tx_empty = ulite_tx_empty,
451 .set_mctrl = ulite_set_mctrl,
452 .get_mctrl = ulite_get_mctrl,
453 .stop_tx = ulite_stop_tx,
454 .start_tx = ulite_start_tx,
455 .stop_rx = ulite_stop_rx,
456 .break_ctl = ulite_break_ctl,
457 .startup = ulite_startup,
458 .shutdown = ulite_shutdown,
459 .set_termios = ulite_set_termios,
460 .type = ulite_type,
461 .release_port = ulite_release_port,
462 .request_port = ulite_request_port,
463 .config_port = ulite_config_port,
464 .verify_port = ulite_verify_port,
465 .pm = ulite_pm,
466#ifdef CONFIG_CONSOLE_POLL
467 .poll_get_char = ulite_get_poll_char,
468 .poll_put_char = ulite_put_poll_char,
469#endif
470};
471
472/* ---------------------------------------------------------------------
473 * Console driver operations
474 */
475
476#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
477static void ulite_console_wait_tx(struct uart_port *port)
478{
479 u8 val;
480
481 /*
482 * Spin waiting for TX fifo to have space available.
483 * When using the Microblaze Debug Module this can take up to 1s
484 */
485 if (read_poll_timeout_atomic(uart_in32, val, !(val & ULITE_STATUS_TXFULL),
486 0, 1000000, false, ULITE_STATUS, port))
487 dev_warn(port->dev,
488 "timeout waiting for TX buffer empty\n");
489}
490
491static void ulite_console_putchar(struct uart_port *port, unsigned char ch)
492{
493 ulite_console_wait_tx(port);
494 uart_out32(ch, ULITE_TX, port);
495}
496
497static void ulite_console_write(struct console *co, const char *s,
498 unsigned int count)
499{
500 struct uart_port *port = console_port;
501 unsigned long flags;
502 unsigned int ier;
503 int locked = 1;
504
505 if (oops_in_progress) {
506 locked = uart_port_trylock_irqsave(port, &flags);
507 } else
508 uart_port_lock_irqsave(port, &flags);
509
510 /* save and disable interrupt */
511 ier = uart_in32(ULITE_STATUS, port) & ULITE_STATUS_IE;
512 uart_out32(0, ULITE_CONTROL, port);
513
514 uart_console_write(port, s, count, ulite_console_putchar);
515
516 ulite_console_wait_tx(port);
517
518 /* restore interrupt state */
519 if (ier)
520 uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
521
522 if (locked)
523 uart_port_unlock_irqrestore(port, flags);
524}
525
526static int ulite_console_setup(struct console *co, char *options)
527{
528 struct uart_port *port = NULL;
529 int baud = 9600;
530 int bits = 8;
531 int parity = 'n';
532 int flow = 'n';
533
534 if (co->index >= 0 && co->index < ULITE_NR_UARTS)
535 port = ulite_ports + co->index;
536
537 /* Has the device been initialized yet? */
538 if (!port || !port->mapbase) {
539 pr_debug("console on ttyUL%i not present\n", co->index);
540 return -ENODEV;
541 }
542
543 console_port = port;
544
545 /* not initialized yet? */
546 if (!port->membase) {
547 if (ulite_request_port(port))
548 return -ENODEV;
549 }
550
551 if (options)
552 uart_parse_options(options, &baud, &parity, &bits, &flow);
553
554 return uart_set_options(port, co, baud, parity, bits, flow);
555}
556
557static struct console ulite_console = {
558 .name = ULITE_NAME,
559 .write = ulite_console_write,
560 .device = uart_console_device,
561 .setup = ulite_console_setup,
562 .flags = CON_PRINTBUFFER,
563 .index = -1, /* Specified on the cmdline (e.g. console=ttyUL0 ) */
564 .data = &ulite_uart_driver,
565};
566
567static void early_uartlite_putc(struct uart_port *port, unsigned char c)
568{
569 /*
570 * Limit how many times we'll spin waiting for TX FIFO status.
571 * This will prevent lockups if the base address is incorrectly
572 * set, or any other issue on the UARTLITE.
573 * This limit is pretty arbitrary, unless we are at about 10 baud
574 * we'll never timeout on a working UART.
575 */
576 unsigned retries = 1000000;
577
578 while (--retries &&
579 (readl(port->membase + ULITE_STATUS) & ULITE_STATUS_TXFULL))
580 ;
581
582 /* Only attempt the iowrite if we didn't timeout */
583 if (retries)
584 writel(c & 0xff, port->membase + ULITE_TX);
585}
586
587static void early_uartlite_write(struct console *console,
588 const char *s, unsigned n)
589{
590 struct earlycon_device *device = console->data;
591 uart_console_write(&device->port, s, n, early_uartlite_putc);
592}
593
594static int __init early_uartlite_setup(struct earlycon_device *device,
595 const char *options)
596{
597 if (!device->port.membase)
598 return -ENODEV;
599
600 device->con->write = early_uartlite_write;
601 return 0;
602}
603EARLYCON_DECLARE(uartlite, early_uartlite_setup);
604OF_EARLYCON_DECLARE(uartlite_b, "xlnx,opb-uartlite-1.00.b", early_uartlite_setup);
605OF_EARLYCON_DECLARE(uartlite_a, "xlnx,xps-uartlite-1.00.a", early_uartlite_setup);
606
607#endif /* CONFIG_SERIAL_UARTLITE_CONSOLE */
608
609static struct uart_driver ulite_uart_driver = {
610 .owner = THIS_MODULE,
611 .driver_name = "uartlite",
612 .dev_name = ULITE_NAME,
613 .major = ULITE_MAJOR,
614 .minor = ULITE_MINOR,
615 .nr = ULITE_NR_UARTS,
616#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
617 .cons = &ulite_console,
618#endif
619};
620
621/* ---------------------------------------------------------------------
622 * Port assignment functions (mapping devices to uart_port structures)
623 */
624
625/** ulite_assign: register a uartlite device with the driver
626 *
627 * @dev: pointer to device structure
628 * @id: requested id number. Pass -1 for automatic port assignment
629 * @base: base address of uartlite registers
630 * @irq: irq number for uartlite
631 * @pdata: private data for uartlite
632 *
633 * Returns: 0 on success, <0 otherwise
634 */
635static int ulite_assign(struct device *dev, int id, phys_addr_t base, int irq,
636 struct uartlite_data *pdata)
637{
638 struct uart_port *port;
639 int rc;
640
641 /* if id = -1; then scan for a free id and use that */
642 if (id < 0) {
643 for (id = 0; id < ULITE_NR_UARTS; id++)
644 if (ulite_ports[id].mapbase == 0)
645 break;
646 }
647 if (id < 0 || id >= ULITE_NR_UARTS) {
648 dev_err(dev, "%s%i too large\n", ULITE_NAME, id);
649 return -EINVAL;
650 }
651
652 if ((ulite_ports[id].mapbase) && (ulite_ports[id].mapbase != base)) {
653 dev_err(dev, "cannot assign to %s%i; it is already in use\n",
654 ULITE_NAME, id);
655 return -EBUSY;
656 }
657
658 port = &ulite_ports[id];
659
660 spin_lock_init(&port->lock);
661 port->fifosize = 16;
662 port->regshift = 2;
663 port->iotype = UPIO_MEM;
664 port->iobase = 1; /* mark port in use */
665 port->mapbase = base;
666 port->membase = NULL;
667 port->ops = &ulite_ops;
668 port->irq = irq;
669 port->flags = UPF_BOOT_AUTOCONF;
670 port->dev = dev;
671 port->type = PORT_UNKNOWN;
672 port->line = id;
673 port->private_data = pdata;
674
675 dev_set_drvdata(dev, port);
676
677 /* Register the port */
678 rc = uart_add_one_port(&ulite_uart_driver, port);
679 if (rc) {
680 dev_err(dev, "uart_add_one_port() failed; err=%i\n", rc);
681 port->mapbase = 0;
682 dev_set_drvdata(dev, NULL);
683 return rc;
684 }
685
686 return 0;
687}
688
689/** ulite_release: register a uartlite device with the driver
690 *
691 * @dev: pointer to device structure
692 */
693static void ulite_release(struct device *dev)
694{
695 struct uart_port *port = dev_get_drvdata(dev);
696
697 if (port) {
698 uart_remove_one_port(&ulite_uart_driver, port);
699 dev_set_drvdata(dev, NULL);
700 port->mapbase = 0;
701 }
702}
703
704/**
705 * ulite_suspend - Stop the device.
706 *
707 * @dev: handle to the device structure.
708 * Return: 0 always.
709 */
710static int __maybe_unused ulite_suspend(struct device *dev)
711{
712 struct uart_port *port = dev_get_drvdata(dev);
713
714 if (port)
715 uart_suspend_port(&ulite_uart_driver, port);
716
717 return 0;
718}
719
720/**
721 * ulite_resume - Resume the device.
722 *
723 * @dev: handle to the device structure.
724 * Return: 0 on success, errno otherwise.
725 */
726static int __maybe_unused ulite_resume(struct device *dev)
727{
728 struct uart_port *port = dev_get_drvdata(dev);
729
730 if (port)
731 uart_resume_port(&ulite_uart_driver, port);
732
733 return 0;
734}
735
736static int __maybe_unused ulite_runtime_suspend(struct device *dev)
737{
738 struct uart_port *port = dev_get_drvdata(dev);
739 struct uartlite_data *pdata = port->private_data;
740
741 clk_disable(pdata->clk);
742 return 0;
743};
744
745static int __maybe_unused ulite_runtime_resume(struct device *dev)
746{
747 struct uart_port *port = dev_get_drvdata(dev);
748 struct uartlite_data *pdata = port->private_data;
749 int ret;
750
751 ret = clk_enable(pdata->clk);
752 if (ret) {
753 dev_err(dev, "Cannot enable clock.\n");
754 return ret;
755 }
756 return 0;
757}
758
759/* ---------------------------------------------------------------------
760 * Platform bus binding
761 */
762
763static const struct dev_pm_ops ulite_pm_ops = {
764 SET_SYSTEM_SLEEP_PM_OPS(ulite_suspend, ulite_resume)
765 SET_RUNTIME_PM_OPS(ulite_runtime_suspend,
766 ulite_runtime_resume, NULL)
767};
768
769#if defined(CONFIG_OF)
770/* Match table for of_platform binding */
771static const struct of_device_id ulite_of_match[] = {
772 { .compatible = "xlnx,opb-uartlite-1.00.b", },
773 { .compatible = "xlnx,xps-uartlite-1.00.a", },
774 {}
775};
776MODULE_DEVICE_TABLE(of, ulite_of_match);
777#endif /* CONFIG_OF */
778
779static int ulite_probe(struct platform_device *pdev)
780{
781 struct resource *res;
782 struct uartlite_data *pdata;
783 int irq, ret;
784 int id = pdev->id;
785
786 pdata = devm_kzalloc(&pdev->dev, sizeof(struct uartlite_data),
787 GFP_KERNEL);
788 if (!pdata)
789 return -ENOMEM;
790
791 if (IS_ENABLED(CONFIG_OF)) {
792 const char *prop;
793 struct device_node *np = pdev->dev.of_node;
794 u32 val = 0;
795
796 prop = "port-number";
797 ret = of_property_read_u32(np, prop, &id);
798 if (ret && ret != -EINVAL)
799of_err:
800 return dev_err_probe(&pdev->dev, ret,
801 "could not read %s\n", prop);
802
803 prop = "current-speed";
804 ret = of_property_read_u32(np, prop, &pdata->baud);
805 if (ret)
806 goto of_err;
807
808 prop = "xlnx,use-parity";
809 ret = of_property_read_u32(np, prop, &val);
810 if (ret && ret != -EINVAL)
811 goto of_err;
812
813 if (val) {
814 prop = "xlnx,odd-parity";
815 ret = of_property_read_u32(np, prop, &val);
816 if (ret)
817 goto of_err;
818
819 if (val)
820 pdata->cflags |= PARODD;
821 pdata->cflags |= PARENB;
822 }
823
824 val = 8;
825 prop = "xlnx,data-bits";
826 ret = of_property_read_u32(np, prop, &val);
827 if (ret && ret != -EINVAL)
828 goto of_err;
829
830 switch (val) {
831 case 5:
832 pdata->cflags |= CS5;
833 break;
834 case 6:
835 pdata->cflags |= CS6;
836 break;
837 case 7:
838 pdata->cflags |= CS7;
839 break;
840 case 8:
841 pdata->cflags |= CS8;
842 break;
843 default:
844 return dev_err_probe(&pdev->dev, -EINVAL,
845 "bad data bits %d\n", val);
846 }
847 } else {
848 pdata->baud = 9600;
849 pdata->cflags = CS8;
850 }
851
852 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
853 if (!res)
854 return -ENODEV;
855
856 irq = platform_get_irq(pdev, 0);
857 if (irq < 0)
858 return irq;
859
860 pdata->clk = devm_clk_get(&pdev->dev, "s_axi_aclk");
861 if (IS_ERR(pdata->clk)) {
862 if (PTR_ERR(pdata->clk) != -ENOENT)
863 return PTR_ERR(pdata->clk);
864
865 /*
866 * Clock framework support is optional, continue on
867 * anyways if we don't find a matching clock.
868 */
869 pdata->clk = NULL;
870 }
871
872 ret = clk_prepare_enable(pdata->clk);
873 if (ret) {
874 dev_err(&pdev->dev, "Failed to prepare clock\n");
875 return ret;
876 }
877
878 pm_runtime_use_autosuspend(&pdev->dev);
879 pm_runtime_set_autosuspend_delay(&pdev->dev, UART_AUTOSUSPEND_TIMEOUT);
880 pm_runtime_set_active(&pdev->dev);
881 pm_runtime_enable(&pdev->dev);
882
883 if (!ulite_uart_driver.state) {
884 dev_dbg(&pdev->dev, "uartlite: calling uart_register_driver()\n");
885 ret = uart_register_driver(&ulite_uart_driver);
886 if (ret < 0) {
887 dev_err(&pdev->dev, "Failed to register driver\n");
888 clk_disable_unprepare(pdata->clk);
889 return ret;
890 }
891 }
892
893 ret = ulite_assign(&pdev->dev, id, res->start, irq, pdata);
894
895 pm_runtime_mark_last_busy(&pdev->dev);
896 pm_runtime_put_autosuspend(&pdev->dev);
897
898 return ret;
899}
900
901static void ulite_remove(struct platform_device *pdev)
902{
903 struct uart_port *port = dev_get_drvdata(&pdev->dev);
904 struct uartlite_data *pdata = port->private_data;
905
906 clk_disable_unprepare(pdata->clk);
907 ulite_release(&pdev->dev);
908 pm_runtime_disable(&pdev->dev);
909 pm_runtime_set_suspended(&pdev->dev);
910 pm_runtime_dont_use_autosuspend(&pdev->dev);
911}
912
913/* work with hotplug and coldplug */
914MODULE_ALIAS("platform:uartlite");
915
916static struct platform_driver ulite_platform_driver = {
917 .probe = ulite_probe,
918 .remove = ulite_remove,
919 .driver = {
920 .name = "uartlite",
921 .of_match_table = of_match_ptr(ulite_of_match),
922 .pm = &ulite_pm_ops,
923 },
924};
925
926/* ---------------------------------------------------------------------
927 * Module setup/teardown
928 */
929
930static int __init ulite_init(void)
931{
932
933 pr_debug("uartlite: calling platform_driver_register()\n");
934 return platform_driver_register(&ulite_platform_driver);
935}
936
937static void __exit ulite_exit(void)
938{
939 platform_driver_unregister(&ulite_platform_driver);
940 if (ulite_uart_driver.state)
941 uart_unregister_driver(&ulite_uart_driver);
942}
943
944module_init(ulite_init);
945module_exit(ulite_exit);
946
947MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
948MODULE_DESCRIPTION("Xilinx uartlite serial driver");
949MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * uartlite.c: Serial driver for Xilinx uartlite serial controller
4 *
5 * Copyright (C) 2006 Peter Korsgaard <jacmet@sunsite.dk>
6 * Copyright (C) 2007 Secret Lab Technologies Ltd.
7 */
8
9#include <linux/platform_device.h>
10#include <linux/module.h>
11#include <linux/bitfield.h>
12#include <linux/console.h>
13#include <linux/serial.h>
14#include <linux/serial_core.h>
15#include <linux/tty.h>
16#include <linux/tty_flip.h>
17#include <linux/delay.h>
18#include <linux/interrupt.h>
19#include <linux/init.h>
20#include <linux/io.h>
21#include <linux/iopoll.h>
22#include <linux/of.h>
23#include <linux/of_address.h>
24#include <linux/of_device.h>
25#include <linux/of_platform.h>
26#include <linux/clk.h>
27#include <linux/pm_runtime.h>
28
29#define ULITE_NAME "ttyUL"
30#define ULITE_MAJOR 204
31#define ULITE_MINOR 187
32#define ULITE_NR_UARTS CONFIG_SERIAL_UARTLITE_NR_UARTS
33
34/* ---------------------------------------------------------------------
35 * Register definitions
36 *
37 * For register details see datasheet:
38 * https://www.xilinx.com/support/documentation/ip_documentation/opb_uartlite.pdf
39 */
40
41#define ULITE_RX 0x00
42#define ULITE_TX 0x04
43#define ULITE_STATUS 0x08
44#define ULITE_CONTROL 0x0c
45
46#define ULITE_REGION 16
47
48#define ULITE_STATUS_RXVALID 0x01
49#define ULITE_STATUS_RXFULL 0x02
50#define ULITE_STATUS_TXEMPTY 0x04
51#define ULITE_STATUS_TXFULL 0x08
52#define ULITE_STATUS_IE 0x10
53#define ULITE_STATUS_OVERRUN 0x20
54#define ULITE_STATUS_FRAME 0x40
55#define ULITE_STATUS_PARITY 0x80
56
57#define ULITE_CONTROL_RST_TX 0x01
58#define ULITE_CONTROL_RST_RX 0x02
59#define ULITE_CONTROL_IE 0x10
60#define UART_AUTOSUSPEND_TIMEOUT 3000 /* ms */
61
62/* Static pointer to console port */
63#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
64static struct uart_port *console_port;
65#endif
66
67/**
68 * struct uartlite_data: Driver private data
69 * reg_ops: Functions to read/write registers
70 * clk: Our parent clock, if present
71 * baud: The baud rate configured when this device was synthesized
72 * cflags: The cflags for parity and data bits
73 */
74struct uartlite_data {
75 const struct uartlite_reg_ops *reg_ops;
76 struct clk *clk;
77 unsigned int baud;
78 tcflag_t cflags;
79};
80
81struct uartlite_reg_ops {
82 u32 (*in)(void __iomem *addr);
83 void (*out)(u32 val, void __iomem *addr);
84};
85
86static u32 uartlite_inbe32(void __iomem *addr)
87{
88 return ioread32be(addr);
89}
90
91static void uartlite_outbe32(u32 val, void __iomem *addr)
92{
93 iowrite32be(val, addr);
94}
95
96static const struct uartlite_reg_ops uartlite_be = {
97 .in = uartlite_inbe32,
98 .out = uartlite_outbe32,
99};
100
101static u32 uartlite_inle32(void __iomem *addr)
102{
103 return ioread32(addr);
104}
105
106static void uartlite_outle32(u32 val, void __iomem *addr)
107{
108 iowrite32(val, addr);
109}
110
111static const struct uartlite_reg_ops uartlite_le = {
112 .in = uartlite_inle32,
113 .out = uartlite_outle32,
114};
115
116static inline u32 uart_in32(u32 offset, struct uart_port *port)
117{
118 struct uartlite_data *pdata = port->private_data;
119
120 return pdata->reg_ops->in(port->membase + offset);
121}
122
123static inline void uart_out32(u32 val, u32 offset, struct uart_port *port)
124{
125 struct uartlite_data *pdata = port->private_data;
126
127 pdata->reg_ops->out(val, port->membase + offset);
128}
129
130static struct uart_port ulite_ports[ULITE_NR_UARTS];
131
132static struct uart_driver ulite_uart_driver;
133
134/* ---------------------------------------------------------------------
135 * Core UART driver operations
136 */
137
138static int ulite_receive(struct uart_port *port, int stat)
139{
140 struct tty_port *tport = &port->state->port;
141 unsigned char ch = 0;
142 char flag = TTY_NORMAL;
143
144 if ((stat & (ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
145 | ULITE_STATUS_FRAME)) == 0)
146 return 0;
147
148 /* stats */
149 if (stat & ULITE_STATUS_RXVALID) {
150 port->icount.rx++;
151 ch = uart_in32(ULITE_RX, port);
152
153 if (stat & ULITE_STATUS_PARITY)
154 port->icount.parity++;
155 }
156
157 if (stat & ULITE_STATUS_OVERRUN)
158 port->icount.overrun++;
159
160 if (stat & ULITE_STATUS_FRAME)
161 port->icount.frame++;
162
163
164 /* drop byte with parity error if IGNPAR specificed */
165 if (stat & port->ignore_status_mask & ULITE_STATUS_PARITY)
166 stat &= ~ULITE_STATUS_RXVALID;
167
168 stat &= port->read_status_mask;
169
170 if (stat & ULITE_STATUS_PARITY)
171 flag = TTY_PARITY;
172
173
174 stat &= ~port->ignore_status_mask;
175
176 if (stat & ULITE_STATUS_RXVALID)
177 tty_insert_flip_char(tport, ch, flag);
178
179 if (stat & ULITE_STATUS_FRAME)
180 tty_insert_flip_char(tport, 0, TTY_FRAME);
181
182 if (stat & ULITE_STATUS_OVERRUN)
183 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
184
185 return 1;
186}
187
188static int ulite_transmit(struct uart_port *port, int stat)
189{
190 struct circ_buf *xmit = &port->state->xmit;
191
192 if (stat & ULITE_STATUS_TXFULL)
193 return 0;
194
195 if (port->x_char) {
196 uart_out32(port->x_char, ULITE_TX, port);
197 port->x_char = 0;
198 port->icount.tx++;
199 return 1;
200 }
201
202 if (uart_circ_empty(xmit) || uart_tx_stopped(port))
203 return 0;
204
205 uart_out32(xmit->buf[xmit->tail], ULITE_TX, port);
206 uart_xmit_advance(port, 1);
207
208 /* wake up */
209 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
210 uart_write_wakeup(port);
211
212 return 1;
213}
214
215static irqreturn_t ulite_isr(int irq, void *dev_id)
216{
217 struct uart_port *port = dev_id;
218 int stat, busy, n = 0;
219 unsigned long flags;
220
221 do {
222 spin_lock_irqsave(&port->lock, flags);
223 stat = uart_in32(ULITE_STATUS, port);
224 busy = ulite_receive(port, stat);
225 busy |= ulite_transmit(port, stat);
226 spin_unlock_irqrestore(&port->lock, flags);
227 n++;
228 } while (busy);
229
230 /* work done? */
231 if (n > 1) {
232 tty_flip_buffer_push(&port->state->port);
233 return IRQ_HANDLED;
234 } else {
235 return IRQ_NONE;
236 }
237}
238
239static unsigned int ulite_tx_empty(struct uart_port *port)
240{
241 unsigned long flags;
242 unsigned int ret;
243
244 spin_lock_irqsave(&port->lock, flags);
245 ret = uart_in32(ULITE_STATUS, port);
246 spin_unlock_irqrestore(&port->lock, flags);
247
248 return ret & ULITE_STATUS_TXEMPTY ? TIOCSER_TEMT : 0;
249}
250
251static unsigned int ulite_get_mctrl(struct uart_port *port)
252{
253 return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
254}
255
256static void ulite_set_mctrl(struct uart_port *port, unsigned int mctrl)
257{
258 /* N/A */
259}
260
261static void ulite_stop_tx(struct uart_port *port)
262{
263 /* N/A */
264}
265
266static void ulite_start_tx(struct uart_port *port)
267{
268 ulite_transmit(port, uart_in32(ULITE_STATUS, port));
269}
270
271static void ulite_stop_rx(struct uart_port *port)
272{
273 /* don't forward any more data (like !CREAD) */
274 port->ignore_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
275 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
276}
277
278static void ulite_break_ctl(struct uart_port *port, int ctl)
279{
280 /* N/A */
281}
282
283static int ulite_startup(struct uart_port *port)
284{
285 struct uartlite_data *pdata = port->private_data;
286 int ret;
287
288 ret = clk_enable(pdata->clk);
289 if (ret) {
290 dev_err(port->dev, "Failed to enable clock\n");
291 return ret;
292 }
293
294 ret = request_irq(port->irq, ulite_isr, IRQF_SHARED | IRQF_TRIGGER_RISING,
295 "uartlite", port);
296 if (ret)
297 return ret;
298
299 uart_out32(ULITE_CONTROL_RST_RX | ULITE_CONTROL_RST_TX,
300 ULITE_CONTROL, port);
301 uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
302
303 return 0;
304}
305
306static void ulite_shutdown(struct uart_port *port)
307{
308 struct uartlite_data *pdata = port->private_data;
309
310 uart_out32(0, ULITE_CONTROL, port);
311 uart_in32(ULITE_CONTROL, port); /* dummy */
312 free_irq(port->irq, port);
313 clk_disable(pdata->clk);
314}
315
316static void ulite_set_termios(struct uart_port *port,
317 struct ktermios *termios,
318 const struct ktermios *old)
319{
320 unsigned long flags;
321 struct uartlite_data *pdata = port->private_data;
322
323 /* Set termios to what the hardware supports */
324 termios->c_iflag &= ~BRKINT;
325 termios->c_cflag &= ~(CSTOPB | PARENB | PARODD | CSIZE);
326 termios->c_cflag |= pdata->cflags & (PARENB | PARODD | CSIZE);
327 tty_termios_encode_baud_rate(termios, pdata->baud, pdata->baud);
328
329 spin_lock_irqsave(&port->lock, flags);
330
331 port->read_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
332 | ULITE_STATUS_TXFULL;
333
334 if (termios->c_iflag & INPCK)
335 port->read_status_mask |=
336 ULITE_STATUS_PARITY | ULITE_STATUS_FRAME;
337
338 port->ignore_status_mask = 0;
339 if (termios->c_iflag & IGNPAR)
340 port->ignore_status_mask |= ULITE_STATUS_PARITY
341 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
342
343 /* ignore all characters if CREAD is not set */
344 if ((termios->c_cflag & CREAD) == 0)
345 port->ignore_status_mask |=
346 ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
347 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
348
349 /* update timeout */
350 uart_update_timeout(port, termios->c_cflag, pdata->baud);
351
352 spin_unlock_irqrestore(&port->lock, flags);
353}
354
355static const char *ulite_type(struct uart_port *port)
356{
357 return port->type == PORT_UARTLITE ? "uartlite" : NULL;
358}
359
360static void ulite_release_port(struct uart_port *port)
361{
362 release_mem_region(port->mapbase, ULITE_REGION);
363 iounmap(port->membase);
364 port->membase = NULL;
365}
366
367static int ulite_request_port(struct uart_port *port)
368{
369 struct uartlite_data *pdata = port->private_data;
370 int ret;
371
372 pr_debug("ulite console: port=%p; port->mapbase=%llx\n",
373 port, (unsigned long long) port->mapbase);
374
375 if (!request_mem_region(port->mapbase, ULITE_REGION, "uartlite")) {
376 dev_err(port->dev, "Memory region busy\n");
377 return -EBUSY;
378 }
379
380 port->membase = ioremap(port->mapbase, ULITE_REGION);
381 if (!port->membase) {
382 dev_err(port->dev, "Unable to map registers\n");
383 release_mem_region(port->mapbase, ULITE_REGION);
384 return -EBUSY;
385 }
386
387 pdata->reg_ops = &uartlite_be;
388 ret = uart_in32(ULITE_CONTROL, port);
389 uart_out32(ULITE_CONTROL_RST_TX, ULITE_CONTROL, port);
390 ret = uart_in32(ULITE_STATUS, port);
391 /* Endianess detection */
392 if ((ret & ULITE_STATUS_TXEMPTY) != ULITE_STATUS_TXEMPTY)
393 pdata->reg_ops = &uartlite_le;
394
395 return 0;
396}
397
398static void ulite_config_port(struct uart_port *port, int flags)
399{
400 if (!ulite_request_port(port))
401 port->type = PORT_UARTLITE;
402}
403
404static int ulite_verify_port(struct uart_port *port, struct serial_struct *ser)
405{
406 /* we don't want the core code to modify any port params */
407 return -EINVAL;
408}
409
410static void ulite_pm(struct uart_port *port, unsigned int state,
411 unsigned int oldstate)
412{
413 int ret;
414
415 if (!state) {
416 ret = pm_runtime_get_sync(port->dev);
417 if (ret < 0)
418 dev_err(port->dev, "Failed to enable clocks\n");
419 } else {
420 pm_runtime_mark_last_busy(port->dev);
421 pm_runtime_put_autosuspend(port->dev);
422 }
423}
424
425#ifdef CONFIG_CONSOLE_POLL
426static int ulite_get_poll_char(struct uart_port *port)
427{
428 if (!(uart_in32(ULITE_STATUS, port) & ULITE_STATUS_RXVALID))
429 return NO_POLL_CHAR;
430
431 return uart_in32(ULITE_RX, port);
432}
433
434static void ulite_put_poll_char(struct uart_port *port, unsigned char ch)
435{
436 while (uart_in32(ULITE_STATUS, port) & ULITE_STATUS_TXFULL)
437 cpu_relax();
438
439 /* write char to device */
440 uart_out32(ch, ULITE_TX, port);
441}
442#endif
443
444static const struct uart_ops ulite_ops = {
445 .tx_empty = ulite_tx_empty,
446 .set_mctrl = ulite_set_mctrl,
447 .get_mctrl = ulite_get_mctrl,
448 .stop_tx = ulite_stop_tx,
449 .start_tx = ulite_start_tx,
450 .stop_rx = ulite_stop_rx,
451 .break_ctl = ulite_break_ctl,
452 .startup = ulite_startup,
453 .shutdown = ulite_shutdown,
454 .set_termios = ulite_set_termios,
455 .type = ulite_type,
456 .release_port = ulite_release_port,
457 .request_port = ulite_request_port,
458 .config_port = ulite_config_port,
459 .verify_port = ulite_verify_port,
460 .pm = ulite_pm,
461#ifdef CONFIG_CONSOLE_POLL
462 .poll_get_char = ulite_get_poll_char,
463 .poll_put_char = ulite_put_poll_char,
464#endif
465};
466
467/* ---------------------------------------------------------------------
468 * Console driver operations
469 */
470
471#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
472static void ulite_console_wait_tx(struct uart_port *port)
473{
474 u8 val;
475
476 /*
477 * Spin waiting for TX fifo to have space available.
478 * When using the Microblaze Debug Module this can take up to 1s
479 */
480 if (read_poll_timeout_atomic(uart_in32, val, !(val & ULITE_STATUS_TXFULL),
481 0, 1000000, false, ULITE_STATUS, port))
482 dev_warn(port->dev,
483 "timeout waiting for TX buffer empty\n");
484}
485
486static void ulite_console_putchar(struct uart_port *port, unsigned char ch)
487{
488 ulite_console_wait_tx(port);
489 uart_out32(ch, ULITE_TX, port);
490}
491
492static void ulite_console_write(struct console *co, const char *s,
493 unsigned int count)
494{
495 struct uart_port *port = console_port;
496 unsigned long flags;
497 unsigned int ier;
498 int locked = 1;
499
500 if (oops_in_progress) {
501 locked = spin_trylock_irqsave(&port->lock, flags);
502 } else
503 spin_lock_irqsave(&port->lock, flags);
504
505 /* save and disable interrupt */
506 ier = uart_in32(ULITE_STATUS, port) & ULITE_STATUS_IE;
507 uart_out32(0, ULITE_CONTROL, port);
508
509 uart_console_write(port, s, count, ulite_console_putchar);
510
511 ulite_console_wait_tx(port);
512
513 /* restore interrupt state */
514 if (ier)
515 uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
516
517 if (locked)
518 spin_unlock_irqrestore(&port->lock, flags);
519}
520
521static int ulite_console_setup(struct console *co, char *options)
522{
523 struct uart_port *port = NULL;
524 int baud = 9600;
525 int bits = 8;
526 int parity = 'n';
527 int flow = 'n';
528
529 if (co->index >= 0 && co->index < ULITE_NR_UARTS)
530 port = ulite_ports + co->index;
531
532 /* Has the device been initialized yet? */
533 if (!port || !port->mapbase) {
534 pr_debug("console on ttyUL%i not present\n", co->index);
535 return -ENODEV;
536 }
537
538 console_port = port;
539
540 /* not initialized yet? */
541 if (!port->membase) {
542 if (ulite_request_port(port))
543 return -ENODEV;
544 }
545
546 if (options)
547 uart_parse_options(options, &baud, &parity, &bits, &flow);
548
549 return uart_set_options(port, co, baud, parity, bits, flow);
550}
551
552static struct console ulite_console = {
553 .name = ULITE_NAME,
554 .write = ulite_console_write,
555 .device = uart_console_device,
556 .setup = ulite_console_setup,
557 .flags = CON_PRINTBUFFER,
558 .index = -1, /* Specified on the cmdline (e.g. console=ttyUL0 ) */
559 .data = &ulite_uart_driver,
560};
561
562static void early_uartlite_putc(struct uart_port *port, unsigned char c)
563{
564 /*
565 * Limit how many times we'll spin waiting for TX FIFO status.
566 * This will prevent lockups if the base address is incorrectly
567 * set, or any other issue on the UARTLITE.
568 * This limit is pretty arbitrary, unless we are at about 10 baud
569 * we'll never timeout on a working UART.
570 */
571 unsigned retries = 1000000;
572
573 while (--retries &&
574 (readl(port->membase + ULITE_STATUS) & ULITE_STATUS_TXFULL))
575 ;
576
577 /* Only attempt the iowrite if we didn't timeout */
578 if (retries)
579 writel(c & 0xff, port->membase + ULITE_TX);
580}
581
582static void early_uartlite_write(struct console *console,
583 const char *s, unsigned n)
584{
585 struct earlycon_device *device = console->data;
586 uart_console_write(&device->port, s, n, early_uartlite_putc);
587}
588
589static int __init early_uartlite_setup(struct earlycon_device *device,
590 const char *options)
591{
592 if (!device->port.membase)
593 return -ENODEV;
594
595 device->con->write = early_uartlite_write;
596 return 0;
597}
598EARLYCON_DECLARE(uartlite, early_uartlite_setup);
599OF_EARLYCON_DECLARE(uartlite_b, "xlnx,opb-uartlite-1.00.b", early_uartlite_setup);
600OF_EARLYCON_DECLARE(uartlite_a, "xlnx,xps-uartlite-1.00.a", early_uartlite_setup);
601
602#endif /* CONFIG_SERIAL_UARTLITE_CONSOLE */
603
604static struct uart_driver ulite_uart_driver = {
605 .owner = THIS_MODULE,
606 .driver_name = "uartlite",
607 .dev_name = ULITE_NAME,
608 .major = ULITE_MAJOR,
609 .minor = ULITE_MINOR,
610 .nr = ULITE_NR_UARTS,
611#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
612 .cons = &ulite_console,
613#endif
614};
615
616/* ---------------------------------------------------------------------
617 * Port assignment functions (mapping devices to uart_port structures)
618 */
619
620/** ulite_assign: register a uartlite device with the driver
621 *
622 * @dev: pointer to device structure
623 * @id: requested id number. Pass -1 for automatic port assignment
624 * @base: base address of uartlite registers
625 * @irq: irq number for uartlite
626 * @pdata: private data for uartlite
627 *
628 * Returns: 0 on success, <0 otherwise
629 */
630static int ulite_assign(struct device *dev, int id, phys_addr_t base, int irq,
631 struct uartlite_data *pdata)
632{
633 struct uart_port *port;
634 int rc;
635
636 /* if id = -1; then scan for a free id and use that */
637 if (id < 0) {
638 for (id = 0; id < ULITE_NR_UARTS; id++)
639 if (ulite_ports[id].mapbase == 0)
640 break;
641 }
642 if (id < 0 || id >= ULITE_NR_UARTS) {
643 dev_err(dev, "%s%i too large\n", ULITE_NAME, id);
644 return -EINVAL;
645 }
646
647 if ((ulite_ports[id].mapbase) && (ulite_ports[id].mapbase != base)) {
648 dev_err(dev, "cannot assign to %s%i; it is already in use\n",
649 ULITE_NAME, id);
650 return -EBUSY;
651 }
652
653 port = &ulite_ports[id];
654
655 spin_lock_init(&port->lock);
656 port->fifosize = 16;
657 port->regshift = 2;
658 port->iotype = UPIO_MEM;
659 port->iobase = 1; /* mark port in use */
660 port->mapbase = base;
661 port->membase = NULL;
662 port->ops = &ulite_ops;
663 port->irq = irq;
664 port->flags = UPF_BOOT_AUTOCONF;
665 port->dev = dev;
666 port->type = PORT_UNKNOWN;
667 port->line = id;
668 port->private_data = pdata;
669
670 dev_set_drvdata(dev, port);
671
672 /* Register the port */
673 rc = uart_add_one_port(&ulite_uart_driver, port);
674 if (rc) {
675 dev_err(dev, "uart_add_one_port() failed; err=%i\n", rc);
676 port->mapbase = 0;
677 dev_set_drvdata(dev, NULL);
678 return rc;
679 }
680
681 return 0;
682}
683
684/** ulite_release: register a uartlite device with the driver
685 *
686 * @dev: pointer to device structure
687 */
688static int ulite_release(struct device *dev)
689{
690 struct uart_port *port = dev_get_drvdata(dev);
691 int rc = 0;
692
693 if (port) {
694 rc = uart_remove_one_port(&ulite_uart_driver, port);
695 dev_set_drvdata(dev, NULL);
696 port->mapbase = 0;
697 }
698
699 return rc;
700}
701
702/**
703 * ulite_suspend - Stop the device.
704 *
705 * @dev: handle to the device structure.
706 * Return: 0 always.
707 */
708static int __maybe_unused ulite_suspend(struct device *dev)
709{
710 struct uart_port *port = dev_get_drvdata(dev);
711
712 if (port)
713 uart_suspend_port(&ulite_uart_driver, port);
714
715 return 0;
716}
717
718/**
719 * ulite_resume - Resume the device.
720 *
721 * @dev: handle to the device structure.
722 * Return: 0 on success, errno otherwise.
723 */
724static int __maybe_unused ulite_resume(struct device *dev)
725{
726 struct uart_port *port = dev_get_drvdata(dev);
727
728 if (port)
729 uart_resume_port(&ulite_uart_driver, port);
730
731 return 0;
732}
733
734static int __maybe_unused ulite_runtime_suspend(struct device *dev)
735{
736 struct uart_port *port = dev_get_drvdata(dev);
737 struct uartlite_data *pdata = port->private_data;
738
739 clk_disable(pdata->clk);
740 return 0;
741};
742
743static int __maybe_unused ulite_runtime_resume(struct device *dev)
744{
745 struct uart_port *port = dev_get_drvdata(dev);
746 struct uartlite_data *pdata = port->private_data;
747 int ret;
748
749 ret = clk_enable(pdata->clk);
750 if (ret) {
751 dev_err(dev, "Cannot enable clock.\n");
752 return ret;
753 }
754 return 0;
755}
756
757/* ---------------------------------------------------------------------
758 * Platform bus binding
759 */
760
761static const struct dev_pm_ops ulite_pm_ops = {
762 SET_SYSTEM_SLEEP_PM_OPS(ulite_suspend, ulite_resume)
763 SET_RUNTIME_PM_OPS(ulite_runtime_suspend,
764 ulite_runtime_resume, NULL)
765};
766
767#if defined(CONFIG_OF)
768/* Match table for of_platform binding */
769static const struct of_device_id ulite_of_match[] = {
770 { .compatible = "xlnx,opb-uartlite-1.00.b", },
771 { .compatible = "xlnx,xps-uartlite-1.00.a", },
772 {}
773};
774MODULE_DEVICE_TABLE(of, ulite_of_match);
775#endif /* CONFIG_OF */
776
777static int ulite_probe(struct platform_device *pdev)
778{
779 struct resource *res;
780 struct uartlite_data *pdata;
781 int irq, ret;
782 int id = pdev->id;
783
784 pdata = devm_kzalloc(&pdev->dev, sizeof(struct uartlite_data),
785 GFP_KERNEL);
786 if (!pdata)
787 return -ENOMEM;
788
789 if (IS_ENABLED(CONFIG_OF)) {
790 const char *prop;
791 struct device_node *np = pdev->dev.of_node;
792 u32 val = 0;
793
794 prop = "port-number";
795 ret = of_property_read_u32(np, prop, &id);
796 if (ret && ret != -EINVAL)
797of_err:
798 return dev_err_probe(&pdev->dev, ret,
799 "could not read %s\n", prop);
800
801 prop = "current-speed";
802 ret = of_property_read_u32(np, prop, &pdata->baud);
803 if (ret)
804 goto of_err;
805
806 prop = "xlnx,use-parity";
807 ret = of_property_read_u32(np, prop, &val);
808 if (ret && ret != -EINVAL)
809 goto of_err;
810
811 if (val) {
812 prop = "xlnx,odd-parity";
813 ret = of_property_read_u32(np, prop, &val);
814 if (ret)
815 goto of_err;
816
817 if (val)
818 pdata->cflags |= PARODD;
819 pdata->cflags |= PARENB;
820 }
821
822 val = 8;
823 prop = "xlnx,data-bits";
824 ret = of_property_read_u32(np, prop, &val);
825 if (ret && ret != -EINVAL)
826 goto of_err;
827
828 switch (val) {
829 case 5:
830 pdata->cflags |= CS5;
831 break;
832 case 6:
833 pdata->cflags |= CS6;
834 break;
835 case 7:
836 pdata->cflags |= CS7;
837 break;
838 case 8:
839 pdata->cflags |= CS8;
840 break;
841 default:
842 return dev_err_probe(&pdev->dev, -EINVAL,
843 "bad data bits %d\n", val);
844 }
845 } else {
846 pdata->baud = 9600;
847 pdata->cflags = CS8;
848 }
849
850 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
851 if (!res)
852 return -ENODEV;
853
854 irq = platform_get_irq(pdev, 0);
855 if (irq < 0)
856 return irq;
857
858 pdata->clk = devm_clk_get(&pdev->dev, "s_axi_aclk");
859 if (IS_ERR(pdata->clk)) {
860 if (PTR_ERR(pdata->clk) != -ENOENT)
861 return PTR_ERR(pdata->clk);
862
863 /*
864 * Clock framework support is optional, continue on
865 * anyways if we don't find a matching clock.
866 */
867 pdata->clk = NULL;
868 }
869
870 ret = clk_prepare_enable(pdata->clk);
871 if (ret) {
872 dev_err(&pdev->dev, "Failed to prepare clock\n");
873 return ret;
874 }
875
876 pm_runtime_use_autosuspend(&pdev->dev);
877 pm_runtime_set_autosuspend_delay(&pdev->dev, UART_AUTOSUSPEND_TIMEOUT);
878 pm_runtime_set_active(&pdev->dev);
879 pm_runtime_enable(&pdev->dev);
880
881 if (!ulite_uart_driver.state) {
882 dev_dbg(&pdev->dev, "uartlite: calling uart_register_driver()\n");
883 ret = uart_register_driver(&ulite_uart_driver);
884 if (ret < 0) {
885 dev_err(&pdev->dev, "Failed to register driver\n");
886 clk_disable_unprepare(pdata->clk);
887 return ret;
888 }
889 }
890
891 ret = ulite_assign(&pdev->dev, id, res->start, irq, pdata);
892
893 pm_runtime_mark_last_busy(&pdev->dev);
894 pm_runtime_put_autosuspend(&pdev->dev);
895
896 return ret;
897}
898
899static int ulite_remove(struct platform_device *pdev)
900{
901 struct uart_port *port = dev_get_drvdata(&pdev->dev);
902 struct uartlite_data *pdata = port->private_data;
903 int rc;
904
905 clk_disable_unprepare(pdata->clk);
906 rc = ulite_release(&pdev->dev);
907 pm_runtime_disable(&pdev->dev);
908 pm_runtime_set_suspended(&pdev->dev);
909 pm_runtime_dont_use_autosuspend(&pdev->dev);
910 return rc;
911}
912
913/* work with hotplug and coldplug */
914MODULE_ALIAS("platform:uartlite");
915
916static struct platform_driver ulite_platform_driver = {
917 .probe = ulite_probe,
918 .remove = ulite_remove,
919 .driver = {
920 .name = "uartlite",
921 .of_match_table = of_match_ptr(ulite_of_match),
922 .pm = &ulite_pm_ops,
923 },
924};
925
926/* ---------------------------------------------------------------------
927 * Module setup/teardown
928 */
929
930static int __init ulite_init(void)
931{
932
933 pr_debug("uartlite: calling platform_driver_register()\n");
934 return platform_driver_register(&ulite_platform_driver);
935}
936
937static void __exit ulite_exit(void)
938{
939 platform_driver_unregister(&ulite_platform_driver);
940 if (ulite_uart_driver.state)
941 uart_unregister_driver(&ulite_uart_driver);
942}
943
944module_init(ulite_init);
945module_exit(ulite_exit);
946
947MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
948MODULE_DESCRIPTION("Xilinx uartlite serial driver");
949MODULE_LICENSE("GPL");