1 // SPDX-License-Identifier: GPL-2.0
3 * uartlite.c: Serial driver for Xilinx uartlite serial controller
5 * Copyright (C) 2006 Peter Korsgaard <jacmet@sunsite.dk>
6 * Copyright (C) 2007 Secret Lab Technologies Ltd.
9 #include <linux/platform_device.h>
10 #include <linux/module.h>
11 #include <linux/console.h>
12 #include <linux/serial.h>
13 #include <linux/serial_core.h>
14 #include <linux/tty.h>
15 #include <linux/tty_flip.h>
16 #include <linux/delay.h>
17 #include <linux/interrupt.h>
18 #include <linux/init.h>
21 #include <linux/of_address.h>
22 #include <linux/of_device.h>
23 #include <linux/of_platform.h>
25 #define ULITE_NAME "ttyUL"
26 #define ULITE_MAJOR 204
27 #define ULITE_MINOR 187
28 #define ULITE_NR_UARTS CONFIG_SERIAL_UARTLITE_NR_UARTS
30 /* ---------------------------------------------------------------------
31 * Register definitions
33 * For register details see datasheet:
34 * http://www.xilinx.com/support/documentation/ip_documentation/opb_uartlite.pdf
39 #define ULITE_STATUS 0x08
40 #define ULITE_CONTROL 0x0c
42 #define ULITE_REGION 16
44 #define ULITE_STATUS_RXVALID 0x01
45 #define ULITE_STATUS_RXFULL 0x02
46 #define ULITE_STATUS_TXEMPTY 0x04
47 #define ULITE_STATUS_TXFULL 0x08
48 #define ULITE_STATUS_IE 0x10
49 #define ULITE_STATUS_OVERRUN 0x20
50 #define ULITE_STATUS_FRAME 0x40
51 #define ULITE_STATUS_PARITY 0x80
53 #define ULITE_CONTROL_RST_TX 0x01
54 #define ULITE_CONTROL_RST_RX 0x02
55 #define ULITE_CONTROL_IE 0x10
57 struct uartlite_reg_ops
{
58 u32 (*in
)(void __iomem
*addr
);
59 void (*out
)(u32 val
, void __iomem
*addr
);
62 static u32
uartlite_inbe32(void __iomem
*addr
)
64 return ioread32be(addr
);
67 static void uartlite_outbe32(u32 val
, void __iomem
*addr
)
69 iowrite32be(val
, addr
);
72 static const struct uartlite_reg_ops uartlite_be
= {
73 .in
= uartlite_inbe32
,
74 .out
= uartlite_outbe32
,
77 static u32
uartlite_inle32(void __iomem
*addr
)
79 return ioread32(addr
);
82 static void uartlite_outle32(u32 val
, void __iomem
*addr
)
87 static const struct uartlite_reg_ops uartlite_le
= {
88 .in
= uartlite_inle32
,
89 .out
= uartlite_outle32
,
92 static inline u32
uart_in32(u32 offset
, struct uart_port
*port
)
94 const struct uartlite_reg_ops
*reg_ops
= port
->private_data
;
96 return reg_ops
->in(port
->membase
+ offset
);
99 static inline void uart_out32(u32 val
, u32 offset
, struct uart_port
*port
)
101 const struct uartlite_reg_ops
*reg_ops
= port
->private_data
;
103 reg_ops
->out(val
, port
->membase
+ offset
);
106 static struct uart_port ulite_ports
[ULITE_NR_UARTS
];
108 /* ---------------------------------------------------------------------
109 * Core UART driver operations
112 static int ulite_receive(struct uart_port
*port
, int stat
)
114 struct tty_port
*tport
= &port
->state
->port
;
115 unsigned char ch
= 0;
116 char flag
= TTY_NORMAL
;
118 if ((stat
& (ULITE_STATUS_RXVALID
| ULITE_STATUS_OVERRUN
119 | ULITE_STATUS_FRAME
)) == 0)
123 if (stat
& ULITE_STATUS_RXVALID
) {
125 ch
= uart_in32(ULITE_RX
, port
);
127 if (stat
& ULITE_STATUS_PARITY
)
128 port
->icount
.parity
++;
131 if (stat
& ULITE_STATUS_OVERRUN
)
132 port
->icount
.overrun
++;
134 if (stat
& ULITE_STATUS_FRAME
)
135 port
->icount
.frame
++;
138 /* drop byte with parity error if IGNPAR specificed */
139 if (stat
& port
->ignore_status_mask
& ULITE_STATUS_PARITY
)
140 stat
&= ~ULITE_STATUS_RXVALID
;
142 stat
&= port
->read_status_mask
;
144 if (stat
& ULITE_STATUS_PARITY
)
148 stat
&= ~port
->ignore_status_mask
;
150 if (stat
& ULITE_STATUS_RXVALID
)
151 tty_insert_flip_char(tport
, ch
, flag
);
153 if (stat
& ULITE_STATUS_FRAME
)
154 tty_insert_flip_char(tport
, 0, TTY_FRAME
);
156 if (stat
& ULITE_STATUS_OVERRUN
)
157 tty_insert_flip_char(tport
, 0, TTY_OVERRUN
);
162 static int ulite_transmit(struct uart_port
*port
, int stat
)
164 struct circ_buf
*xmit
= &port
->state
->xmit
;
166 if (stat
& ULITE_STATUS_TXFULL
)
170 uart_out32(port
->x_char
, ULITE_TX
, port
);
176 if (uart_circ_empty(xmit
) || uart_tx_stopped(port
))
179 uart_out32(xmit
->buf
[xmit
->tail
], ULITE_TX
, port
);
180 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
-1);
184 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
185 uart_write_wakeup(port
);
190 static irqreturn_t
ulite_isr(int irq
, void *dev_id
)
192 struct uart_port
*port
= dev_id
;
193 int stat
, busy
, n
= 0;
197 spin_lock_irqsave(&port
->lock
, flags
);
198 stat
= uart_in32(ULITE_STATUS
, port
);
199 busy
= ulite_receive(port
, stat
);
200 busy
|= ulite_transmit(port
, stat
);
201 spin_unlock_irqrestore(&port
->lock
, flags
);
207 tty_flip_buffer_push(&port
->state
->port
);
214 static unsigned int ulite_tx_empty(struct uart_port
*port
)
219 spin_lock_irqsave(&port
->lock
, flags
);
220 ret
= uart_in32(ULITE_STATUS
, port
);
221 spin_unlock_irqrestore(&port
->lock
, flags
);
223 return ret
& ULITE_STATUS_TXEMPTY
? TIOCSER_TEMT
: 0;
226 static unsigned int ulite_get_mctrl(struct uart_port
*port
)
228 return TIOCM_CTS
| TIOCM_DSR
| TIOCM_CAR
;
231 static void ulite_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
236 static void ulite_stop_tx(struct uart_port
*port
)
241 static void ulite_start_tx(struct uart_port
*port
)
243 ulite_transmit(port
, uart_in32(ULITE_STATUS
, port
));
246 static void ulite_stop_rx(struct uart_port
*port
)
248 /* don't forward any more data (like !CREAD) */
249 port
->ignore_status_mask
= ULITE_STATUS_RXVALID
| ULITE_STATUS_PARITY
250 | ULITE_STATUS_FRAME
| ULITE_STATUS_OVERRUN
;
253 static void ulite_break_ctl(struct uart_port
*port
, int ctl
)
258 static int ulite_startup(struct uart_port
*port
)
262 ret
= request_irq(port
->irq
, ulite_isr
, IRQF_SHARED
| IRQF_TRIGGER_RISING
,
267 uart_out32(ULITE_CONTROL_RST_RX
| ULITE_CONTROL_RST_TX
,
268 ULITE_CONTROL
, port
);
269 uart_out32(ULITE_CONTROL_IE
, ULITE_CONTROL
, port
);
274 static void ulite_shutdown(struct uart_port
*port
)
276 uart_out32(0, ULITE_CONTROL
, port
);
277 uart_in32(ULITE_CONTROL
, port
); /* dummy */
278 free_irq(port
->irq
, port
);
281 static void ulite_set_termios(struct uart_port
*port
, struct ktermios
*termios
,
282 struct ktermios
*old
)
287 spin_lock_irqsave(&port
->lock
, flags
);
289 port
->read_status_mask
= ULITE_STATUS_RXVALID
| ULITE_STATUS_OVERRUN
290 | ULITE_STATUS_TXFULL
;
292 if (termios
->c_iflag
& INPCK
)
293 port
->read_status_mask
|=
294 ULITE_STATUS_PARITY
| ULITE_STATUS_FRAME
;
296 port
->ignore_status_mask
= 0;
297 if (termios
->c_iflag
& IGNPAR
)
298 port
->ignore_status_mask
|= ULITE_STATUS_PARITY
299 | ULITE_STATUS_FRAME
| ULITE_STATUS_OVERRUN
;
301 /* ignore all characters if CREAD is not set */
302 if ((termios
->c_cflag
& CREAD
) == 0)
303 port
->ignore_status_mask
|=
304 ULITE_STATUS_RXVALID
| ULITE_STATUS_PARITY
305 | ULITE_STATUS_FRAME
| ULITE_STATUS_OVERRUN
;
308 baud
= uart_get_baud_rate(port
, termios
, old
, 0, 460800);
309 uart_update_timeout(port
, termios
->c_cflag
, baud
);
311 spin_unlock_irqrestore(&port
->lock
, flags
);
314 static const char *ulite_type(struct uart_port
*port
)
316 return port
->type
== PORT_UARTLITE
? "uartlite" : NULL
;
319 static void ulite_release_port(struct uart_port
*port
)
321 release_mem_region(port
->mapbase
, ULITE_REGION
);
322 iounmap(port
->membase
);
323 port
->membase
= NULL
;
326 static int ulite_request_port(struct uart_port
*port
)
330 pr_debug("ulite console: port=%p; port->mapbase=%llx\n",
331 port
, (unsigned long long) port
->mapbase
);
333 if (!request_mem_region(port
->mapbase
, ULITE_REGION
, "uartlite")) {
334 dev_err(port
->dev
, "Memory region busy\n");
338 port
->membase
= ioremap(port
->mapbase
, ULITE_REGION
);
339 if (!port
->membase
) {
340 dev_err(port
->dev
, "Unable to map registers\n");
341 release_mem_region(port
->mapbase
, ULITE_REGION
);
345 port
->private_data
= (void *)&uartlite_be
;
346 ret
= uart_in32(ULITE_CONTROL
, port
);
347 uart_out32(ULITE_CONTROL_RST_TX
, ULITE_CONTROL
, port
);
348 ret
= uart_in32(ULITE_STATUS
, port
);
349 /* Endianess detection */
350 if ((ret
& ULITE_STATUS_TXEMPTY
) != ULITE_STATUS_TXEMPTY
)
351 port
->private_data
= (void *)&uartlite_le
;
356 static void ulite_config_port(struct uart_port
*port
, int flags
)
358 if (!ulite_request_port(port
))
359 port
->type
= PORT_UARTLITE
;
362 static int ulite_verify_port(struct uart_port
*port
, struct serial_struct
*ser
)
364 /* we don't want the core code to modify any port params */
368 #ifdef CONFIG_CONSOLE_POLL
369 static int ulite_get_poll_char(struct uart_port
*port
)
371 if (!(uart_in32(ULITE_STATUS
, port
) & ULITE_STATUS_RXVALID
))
374 return uart_in32(ULITE_RX
, port
);
377 static void ulite_put_poll_char(struct uart_port
*port
, unsigned char ch
)
379 while (uart_in32(ULITE_STATUS
, port
) & ULITE_STATUS_TXFULL
)
382 /* write char to device */
383 uart_out32(ch
, ULITE_TX
, port
);
387 static const struct uart_ops ulite_ops
= {
388 .tx_empty
= ulite_tx_empty
,
389 .set_mctrl
= ulite_set_mctrl
,
390 .get_mctrl
= ulite_get_mctrl
,
391 .stop_tx
= ulite_stop_tx
,
392 .start_tx
= ulite_start_tx
,
393 .stop_rx
= ulite_stop_rx
,
394 .break_ctl
= ulite_break_ctl
,
395 .startup
= ulite_startup
,
396 .shutdown
= ulite_shutdown
,
397 .set_termios
= ulite_set_termios
,
399 .release_port
= ulite_release_port
,
400 .request_port
= ulite_request_port
,
401 .config_port
= ulite_config_port
,
402 .verify_port
= ulite_verify_port
,
403 #ifdef CONFIG_CONSOLE_POLL
404 .poll_get_char
= ulite_get_poll_char
,
405 .poll_put_char
= ulite_put_poll_char
,
409 /* ---------------------------------------------------------------------
410 * Console driver operations
413 #ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
414 static void ulite_console_wait_tx(struct uart_port
*port
)
417 unsigned long timeout
;
420 * Spin waiting for TX fifo to have space available.
421 * When using the Microblaze Debug Module this can take up to 1s
423 timeout
= jiffies
+ msecs_to_jiffies(1000);
425 val
= uart_in32(ULITE_STATUS
, port
);
426 if ((val
& ULITE_STATUS_TXFULL
) == 0)
428 if (time_after(jiffies
, timeout
)) {
430 "timeout waiting for TX buffer empty\n");
437 static void ulite_console_putchar(struct uart_port
*port
, int ch
)
439 ulite_console_wait_tx(port
);
440 uart_out32(ch
, ULITE_TX
, port
);
443 static void ulite_console_write(struct console
*co
, const char *s
,
446 struct uart_port
*port
= &ulite_ports
[co
->index
];
451 if (oops_in_progress
) {
452 locked
= spin_trylock_irqsave(&port
->lock
, flags
);
454 spin_lock_irqsave(&port
->lock
, flags
);
456 /* save and disable interrupt */
457 ier
= uart_in32(ULITE_STATUS
, port
) & ULITE_STATUS_IE
;
458 uart_out32(0, ULITE_CONTROL
, port
);
460 uart_console_write(port
, s
, count
, ulite_console_putchar
);
462 ulite_console_wait_tx(port
);
464 /* restore interrupt state */
466 uart_out32(ULITE_CONTROL_IE
, ULITE_CONTROL
, port
);
469 spin_unlock_irqrestore(&port
->lock
, flags
);
472 static int ulite_console_setup(struct console
*co
, char *options
)
474 struct uart_port
*port
;
480 if (co
->index
< 0 || co
->index
>= ULITE_NR_UARTS
)
483 port
= &ulite_ports
[co
->index
];
485 /* Has the device been initialized yet? */
486 if (!port
->mapbase
) {
487 pr_debug("console on ttyUL%i not present\n", co
->index
);
491 /* not initialized yet? */
492 if (!port
->membase
) {
493 if (ulite_request_port(port
))
498 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
500 return uart_set_options(port
, co
, baud
, parity
, bits
, flow
);
503 static struct uart_driver ulite_uart_driver
;
505 static struct console ulite_console
= {
507 .write
= ulite_console_write
,
508 .device
= uart_console_device
,
509 .setup
= ulite_console_setup
,
510 .flags
= CON_PRINTBUFFER
,
511 .index
= -1, /* Specified on the cmdline (e.g. console=ttyUL0 ) */
512 .data
= &ulite_uart_driver
,
515 static int __init
ulite_console_init(void)
517 register_console(&ulite_console
);
521 console_initcall(ulite_console_init
);
523 static void early_uartlite_putc(struct uart_port
*port
, int c
)
526 * Limit how many times we'll spin waiting for TX FIFO status.
527 * This will prevent lockups if the base address is incorrectly
528 * set, or any other issue on the UARTLITE.
529 * This limit is pretty arbitrary, unless we are at about 10 baud
530 * we'll never timeout on a working UART.
533 unsigned retries
= 1000000;
534 /* read status bit - 0x8 offset */
535 while (--retries
&& (readl(port
->membase
+ 8) & (1 << 3)))
538 /* Only attempt the iowrite if we didn't timeout */
539 /* write to TX_FIFO - 0x4 offset */
541 writel(c
& 0xff, port
->membase
+ 4);
544 static void early_uartlite_write(struct console
*console
,
545 const char *s
, unsigned n
)
547 struct earlycon_device
*device
= console
->data
;
548 uart_console_write(&device
->port
, s
, n
, early_uartlite_putc
);
551 static int __init
early_uartlite_setup(struct earlycon_device
*device
,
554 if (!device
->port
.membase
)
557 device
->con
->write
= early_uartlite_write
;
560 EARLYCON_DECLARE(uartlite
, early_uartlite_setup
);
561 OF_EARLYCON_DECLARE(uartlite_b
, "xlnx,opb-uartlite-1.00.b", early_uartlite_setup
);
562 OF_EARLYCON_DECLARE(uartlite_a
, "xlnx,xps-uartlite-1.00.a", early_uartlite_setup
);
564 #endif /* CONFIG_SERIAL_UARTLITE_CONSOLE */
566 static struct uart_driver ulite_uart_driver
= {
567 .owner
= THIS_MODULE
,
568 .driver_name
= "uartlite",
569 .dev_name
= ULITE_NAME
,
570 .major
= ULITE_MAJOR
,
571 .minor
= ULITE_MINOR
,
572 .nr
= ULITE_NR_UARTS
,
573 #ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
574 .cons
= &ulite_console
,
578 /* ---------------------------------------------------------------------
579 * Port assignment functions (mapping devices to uart_port structures)
582 /** ulite_assign: register a uartlite device with the driver
584 * @dev: pointer to device structure
585 * @id: requested id number. Pass -1 for automatic port assignment
586 * @base: base address of uartlite registers
587 * @irq: irq number for uartlite
589 * Returns: 0 on success, <0 otherwise
591 static int ulite_assign(struct device
*dev
, int id
, u32 base
, int irq
)
593 struct uart_port
*port
;
596 /* if id = -1; then scan for a free id and use that */
598 for (id
= 0; id
< ULITE_NR_UARTS
; id
++)
599 if (ulite_ports
[id
].mapbase
== 0)
602 if (id
< 0 || id
>= ULITE_NR_UARTS
) {
603 dev_err(dev
, "%s%i too large\n", ULITE_NAME
, id
);
607 if ((ulite_ports
[id
].mapbase
) && (ulite_ports
[id
].mapbase
!= base
)) {
608 dev_err(dev
, "cannot assign to %s%i; it is already in use\n",
613 port
= &ulite_ports
[id
];
615 spin_lock_init(&port
->lock
);
618 port
->iotype
= UPIO_MEM
;
619 port
->iobase
= 1; /* mark port in use */
620 port
->mapbase
= base
;
621 port
->membase
= NULL
;
622 port
->ops
= &ulite_ops
;
624 port
->flags
= UPF_BOOT_AUTOCONF
;
626 port
->type
= PORT_UNKNOWN
;
629 dev_set_drvdata(dev
, port
);
631 /* Register the port */
632 rc
= uart_add_one_port(&ulite_uart_driver
, port
);
634 dev_err(dev
, "uart_add_one_port() failed; err=%i\n", rc
);
636 dev_set_drvdata(dev
, NULL
);
643 /** ulite_release: register a uartlite device with the driver
645 * @dev: pointer to device structure
647 static int ulite_release(struct device
*dev
)
649 struct uart_port
*port
= dev_get_drvdata(dev
);
653 rc
= uart_remove_one_port(&ulite_uart_driver
, port
);
654 dev_set_drvdata(dev
, NULL
);
661 /* ---------------------------------------------------------------------
662 * Platform bus binding
665 #if defined(CONFIG_OF)
666 /* Match table for of_platform binding */
667 static const struct of_device_id ulite_of_match
[] = {
668 { .compatible
= "xlnx,opb-uartlite-1.00.b", },
669 { .compatible
= "xlnx,xps-uartlite-1.00.a", },
672 MODULE_DEVICE_TABLE(of
, ulite_of_match
);
673 #endif /* CONFIG_OF */
675 static int ulite_probe(struct platform_device
*pdev
)
677 struct resource
*res
;
683 prop
= of_get_property(pdev
->dev
.of_node
, "port-number", NULL
);
685 id
= be32_to_cpup(prop
);
688 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
692 irq
= platform_get_irq(pdev
, 0);
696 return ulite_assign(&pdev
->dev
, id
, res
->start
, irq
);
699 static int ulite_remove(struct platform_device
*pdev
)
701 return ulite_release(&pdev
->dev
);
704 /* work with hotplug and coldplug */
705 MODULE_ALIAS("platform:uartlite");
707 static struct platform_driver ulite_platform_driver
= {
708 .probe
= ulite_probe
,
709 .remove
= ulite_remove
,
712 .of_match_table
= of_match_ptr(ulite_of_match
),
716 /* ---------------------------------------------------------------------
717 * Module setup/teardown
720 static int __init
ulite_init(void)
724 pr_debug("uartlite: calling uart_register_driver()\n");
725 ret
= uart_register_driver(&ulite_uart_driver
);
729 pr_debug("uartlite: calling platform_driver_register()\n");
730 ret
= platform_driver_register(&ulite_platform_driver
);
737 uart_unregister_driver(&ulite_uart_driver
);
739 pr_err("registering uartlite driver failed: err=%i\n", ret
);
743 static void __exit
ulite_exit(void)
745 platform_driver_unregister(&ulite_platform_driver
);
746 uart_unregister_driver(&ulite_uart_driver
);
749 module_init(ulite_init
);
750 module_exit(ulite_exit
);
752 MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
753 MODULE_DESCRIPTION("Xilinx uartlite serial driver");
754 MODULE_LICENSE("GPL");