Merge tag 'block-5.11-2021-01-10' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / drivers / tty / serial / altera_uart.c
blob0e487ce091ac99a0c2ac3243b233706f946c47a7
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * altera_uart.c -- Altera UART driver
5 * Based on mcf.c -- Freescale ColdFire UART driver
7 * (C) Copyright 2003-2007, Greg Ungerer <gerg@snapgear.com>
8 * (C) Copyright 2008, Thomas Chou <thomas@wytron.com.tw>
9 * (C) Copyright 2010, Tobias Klauser <tklauser@distanz.ch>
12 #include <linux/kernel.h>
13 #include <linux/init.h>
14 #include <linux/timer.h>
15 #include <linux/interrupt.h>
16 #include <linux/module.h>
17 #include <linux/console.h>
18 #include <linux/tty.h>
19 #include <linux/tty_flip.h>
20 #include <linux/serial.h>
21 #include <linux/serial_core.h>
22 #include <linux/platform_device.h>
23 #include <linux/of.h>
24 #include <linux/io.h>
25 #include <linux/altera_uart.h>
27 #define DRV_NAME "altera_uart"
28 #define SERIAL_ALTERA_MAJOR 204
29 #define SERIAL_ALTERA_MINOR 213
32 * Altera UART register definitions according to the Nios UART datasheet:
33 * http://www.altera.com/literature/ds/ds_nios_uart.pdf
36 #define ALTERA_UART_SIZE 32
38 #define ALTERA_UART_RXDATA_REG 0
39 #define ALTERA_UART_TXDATA_REG 4
40 #define ALTERA_UART_STATUS_REG 8
41 #define ALTERA_UART_CONTROL_REG 12
42 #define ALTERA_UART_DIVISOR_REG 16
43 #define ALTERA_UART_EOP_REG 20
45 #define ALTERA_UART_STATUS_PE_MSK 0x0001 /* parity error */
46 #define ALTERA_UART_STATUS_FE_MSK 0x0002 /* framing error */
47 #define ALTERA_UART_STATUS_BRK_MSK 0x0004 /* break */
48 #define ALTERA_UART_STATUS_ROE_MSK 0x0008 /* RX overrun error */
49 #define ALTERA_UART_STATUS_TOE_MSK 0x0010 /* TX overrun error */
50 #define ALTERA_UART_STATUS_TMT_MSK 0x0020 /* TX shift register state */
51 #define ALTERA_UART_STATUS_TRDY_MSK 0x0040 /* TX ready */
52 #define ALTERA_UART_STATUS_RRDY_MSK 0x0080 /* RX ready */
53 #define ALTERA_UART_STATUS_E_MSK 0x0100 /* exception condition */
54 #define ALTERA_UART_STATUS_DCTS_MSK 0x0400 /* CTS logic-level change */
55 #define ALTERA_UART_STATUS_CTS_MSK 0x0800 /* CTS logic state */
56 #define ALTERA_UART_STATUS_EOP_MSK 0x1000 /* EOP written/read */
58 /* Enable interrupt on... */
59 #define ALTERA_UART_CONTROL_PE_MSK 0x0001 /* ...parity error */
60 #define ALTERA_UART_CONTROL_FE_MSK 0x0002 /* ...framing error */
61 #define ALTERA_UART_CONTROL_BRK_MSK 0x0004 /* ...break */
62 #define ALTERA_UART_CONTROL_ROE_MSK 0x0008 /* ...RX overrun */
63 #define ALTERA_UART_CONTROL_TOE_MSK 0x0010 /* ...TX overrun */
64 #define ALTERA_UART_CONTROL_TMT_MSK 0x0020 /* ...TX shift register empty */
65 #define ALTERA_UART_CONTROL_TRDY_MSK 0x0040 /* ...TX ready */
66 #define ALTERA_UART_CONTROL_RRDY_MSK 0x0080 /* ...RX ready */
67 #define ALTERA_UART_CONTROL_E_MSK 0x0100 /* ...exception*/
69 #define ALTERA_UART_CONTROL_TRBK_MSK 0x0200 /* TX break */
70 #define ALTERA_UART_CONTROL_DCTS_MSK 0x0400 /* Interrupt on CTS change */
71 #define ALTERA_UART_CONTROL_RTS_MSK 0x0800 /* RTS signal */
72 #define ALTERA_UART_CONTROL_EOP_MSK 0x1000 /* Interrupt on EOP */
75 * Local per-uart structure.
77 struct altera_uart {
78 struct uart_port port;
79 struct timer_list tmr;
80 unsigned int sigs; /* Local copy of line sigs */
81 unsigned short imr; /* Local IMR mirror */
84 static u32 altera_uart_readl(struct uart_port *port, int reg)
86 return readl(port->membase + (reg << port->regshift));
89 static void altera_uart_writel(struct uart_port *port, u32 dat, int reg)
91 writel(dat, port->membase + (reg << port->regshift));
94 static unsigned int altera_uart_tx_empty(struct uart_port *port)
96 return (altera_uart_readl(port, ALTERA_UART_STATUS_REG) &
97 ALTERA_UART_STATUS_TMT_MSK) ? TIOCSER_TEMT : 0;
100 static unsigned int altera_uart_get_mctrl(struct uart_port *port)
102 struct altera_uart *pp = container_of(port, struct altera_uart, port);
103 unsigned int sigs;
105 sigs = (altera_uart_readl(port, ALTERA_UART_STATUS_REG) &
106 ALTERA_UART_STATUS_CTS_MSK) ? TIOCM_CTS : 0;
107 sigs |= (pp->sigs & TIOCM_RTS);
109 return sigs;
112 static void altera_uart_update_ctrl_reg(struct altera_uart *pp)
114 unsigned short imr = pp->imr;
117 * If the device doesn't have an irq, ensure that the irq bits are
118 * masked out to keep the irq line inactive.
120 if (!pp->port.irq)
121 imr &= ALTERA_UART_CONTROL_TRBK_MSK | ALTERA_UART_CONTROL_RTS_MSK;
123 altera_uart_writel(&pp->port, imr, ALTERA_UART_CONTROL_REG);
126 static void altera_uart_set_mctrl(struct uart_port *port, unsigned int sigs)
128 struct altera_uart *pp = container_of(port, struct altera_uart, port);
130 pp->sigs = sigs;
131 if (sigs & TIOCM_RTS)
132 pp->imr |= ALTERA_UART_CONTROL_RTS_MSK;
133 else
134 pp->imr &= ~ALTERA_UART_CONTROL_RTS_MSK;
135 altera_uart_update_ctrl_reg(pp);
138 static void altera_uart_start_tx(struct uart_port *port)
140 struct altera_uart *pp = container_of(port, struct altera_uart, port);
142 pp->imr |= ALTERA_UART_CONTROL_TRDY_MSK;
143 altera_uart_update_ctrl_reg(pp);
146 static void altera_uart_stop_tx(struct uart_port *port)
148 struct altera_uart *pp = container_of(port, struct altera_uart, port);
150 pp->imr &= ~ALTERA_UART_CONTROL_TRDY_MSK;
151 altera_uart_update_ctrl_reg(pp);
154 static void altera_uart_stop_rx(struct uart_port *port)
156 struct altera_uart *pp = container_of(port, struct altera_uart, port);
158 pp->imr &= ~ALTERA_UART_CONTROL_RRDY_MSK;
159 altera_uart_update_ctrl_reg(pp);
162 static void altera_uart_break_ctl(struct uart_port *port, int break_state)
164 struct altera_uart *pp = container_of(port, struct altera_uart, port);
165 unsigned long flags;
167 spin_lock_irqsave(&port->lock, flags);
168 if (break_state == -1)
169 pp->imr |= ALTERA_UART_CONTROL_TRBK_MSK;
170 else
171 pp->imr &= ~ALTERA_UART_CONTROL_TRBK_MSK;
172 altera_uart_update_ctrl_reg(pp);
173 spin_unlock_irqrestore(&port->lock, flags);
176 static void altera_uart_set_termios(struct uart_port *port,
177 struct ktermios *termios,
178 struct ktermios *old)
180 unsigned long flags;
181 unsigned int baud, baudclk;
183 baud = uart_get_baud_rate(port, termios, old, 0, 4000000);
184 baudclk = port->uartclk / baud;
186 if (old)
187 tty_termios_copy_hw(termios, old);
188 tty_termios_encode_baud_rate(termios, baud, baud);
190 spin_lock_irqsave(&port->lock, flags);
191 uart_update_timeout(port, termios->c_cflag, baud);
192 altera_uart_writel(port, baudclk, ALTERA_UART_DIVISOR_REG);
193 spin_unlock_irqrestore(&port->lock, flags);
196 * FIXME: port->read_status_mask and port->ignore_status_mask
197 * need to be initialized based on termios settings for
198 * INPCK, IGNBRK, IGNPAR, PARMRK, BRKINT
202 static void altera_uart_rx_chars(struct altera_uart *pp)
204 struct uart_port *port = &pp->port;
205 unsigned char ch, flag;
206 unsigned short status;
208 while ((status = altera_uart_readl(port, ALTERA_UART_STATUS_REG)) &
209 ALTERA_UART_STATUS_RRDY_MSK) {
210 ch = altera_uart_readl(port, ALTERA_UART_RXDATA_REG);
211 flag = TTY_NORMAL;
212 port->icount.rx++;
214 if (status & ALTERA_UART_STATUS_E_MSK) {
215 altera_uart_writel(port, status,
216 ALTERA_UART_STATUS_REG);
218 if (status & ALTERA_UART_STATUS_BRK_MSK) {
219 port->icount.brk++;
220 if (uart_handle_break(port))
221 continue;
222 } else if (status & ALTERA_UART_STATUS_PE_MSK) {
223 port->icount.parity++;
224 } else if (status & ALTERA_UART_STATUS_ROE_MSK) {
225 port->icount.overrun++;
226 } else if (status & ALTERA_UART_STATUS_FE_MSK) {
227 port->icount.frame++;
230 status &= port->read_status_mask;
232 if (status & ALTERA_UART_STATUS_BRK_MSK)
233 flag = TTY_BREAK;
234 else if (status & ALTERA_UART_STATUS_PE_MSK)
235 flag = TTY_PARITY;
236 else if (status & ALTERA_UART_STATUS_FE_MSK)
237 flag = TTY_FRAME;
240 if (uart_handle_sysrq_char(port, ch))
241 continue;
242 uart_insert_char(port, status, ALTERA_UART_STATUS_ROE_MSK, ch,
243 flag);
246 spin_unlock(&port->lock);
247 tty_flip_buffer_push(&port->state->port);
248 spin_lock(&port->lock);
251 static void altera_uart_tx_chars(struct altera_uart *pp)
253 struct uart_port *port = &pp->port;
254 struct circ_buf *xmit = &port->state->xmit;
256 if (port->x_char) {
257 /* Send special char - probably flow control */
258 altera_uart_writel(port, port->x_char, ALTERA_UART_TXDATA_REG);
259 port->x_char = 0;
260 port->icount.tx++;
261 return;
264 while (altera_uart_readl(port, ALTERA_UART_STATUS_REG) &
265 ALTERA_UART_STATUS_TRDY_MSK) {
266 if (xmit->head == xmit->tail)
267 break;
268 altera_uart_writel(port, xmit->buf[xmit->tail],
269 ALTERA_UART_TXDATA_REG);
270 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
271 port->icount.tx++;
274 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
275 uart_write_wakeup(port);
277 if (xmit->head == xmit->tail) {
278 pp->imr &= ~ALTERA_UART_CONTROL_TRDY_MSK;
279 altera_uart_update_ctrl_reg(pp);
283 static irqreturn_t altera_uart_interrupt(int irq, void *data)
285 struct uart_port *port = data;
286 struct altera_uart *pp = container_of(port, struct altera_uart, port);
287 unsigned int isr;
289 isr = altera_uart_readl(port, ALTERA_UART_STATUS_REG) & pp->imr;
291 spin_lock(&port->lock);
292 if (isr & ALTERA_UART_STATUS_RRDY_MSK)
293 altera_uart_rx_chars(pp);
294 if (isr & ALTERA_UART_STATUS_TRDY_MSK)
295 altera_uart_tx_chars(pp);
296 spin_unlock(&port->lock);
298 return IRQ_RETVAL(isr);
301 static void altera_uart_timer(struct timer_list *t)
303 struct altera_uart *pp = from_timer(pp, t, tmr);
304 struct uart_port *port = &pp->port;
306 altera_uart_interrupt(0, port);
307 mod_timer(&pp->tmr, jiffies + uart_poll_timeout(port));
310 static void altera_uart_config_port(struct uart_port *port, int flags)
312 port->type = PORT_ALTERA_UART;
314 /* Clear mask, so no surprise interrupts. */
315 altera_uart_writel(port, 0, ALTERA_UART_CONTROL_REG);
316 /* Clear status register */
317 altera_uart_writel(port, 0, ALTERA_UART_STATUS_REG);
320 static int altera_uart_startup(struct uart_port *port)
322 struct altera_uart *pp = container_of(port, struct altera_uart, port);
323 unsigned long flags;
325 if (!port->irq) {
326 timer_setup(&pp->tmr, altera_uart_timer, 0);
327 mod_timer(&pp->tmr, jiffies + uart_poll_timeout(port));
328 } else {
329 int ret;
331 ret = request_irq(port->irq, altera_uart_interrupt, 0,
332 DRV_NAME, port);
333 if (ret) {
334 pr_err(DRV_NAME ": unable to attach Altera UART %d "
335 "interrupt vector=%d\n", port->line, port->irq);
336 return ret;
340 spin_lock_irqsave(&port->lock, flags);
342 /* Enable RX interrupts now */
343 pp->imr = ALTERA_UART_CONTROL_RRDY_MSK;
344 altera_uart_update_ctrl_reg(pp);
346 spin_unlock_irqrestore(&port->lock, flags);
348 return 0;
351 static void altera_uart_shutdown(struct uart_port *port)
353 struct altera_uart *pp = container_of(port, struct altera_uart, port);
354 unsigned long flags;
356 spin_lock_irqsave(&port->lock, flags);
358 /* Disable all interrupts now */
359 pp->imr = 0;
360 altera_uart_update_ctrl_reg(pp);
362 spin_unlock_irqrestore(&port->lock, flags);
364 if (port->irq)
365 free_irq(port->irq, port);
366 else
367 del_timer_sync(&pp->tmr);
370 static const char *altera_uart_type(struct uart_port *port)
372 return (port->type == PORT_ALTERA_UART) ? "Altera UART" : NULL;
375 static int altera_uart_request_port(struct uart_port *port)
377 /* UARTs always present */
378 return 0;
381 static void altera_uart_release_port(struct uart_port *port)
383 /* Nothing to release... */
386 static int altera_uart_verify_port(struct uart_port *port,
387 struct serial_struct *ser)
389 if ((ser->type != PORT_UNKNOWN) && (ser->type != PORT_ALTERA_UART))
390 return -EINVAL;
391 return 0;
394 #ifdef CONFIG_CONSOLE_POLL
395 static int altera_uart_poll_get_char(struct uart_port *port)
397 while (!(altera_uart_readl(port, ALTERA_UART_STATUS_REG) &
398 ALTERA_UART_STATUS_RRDY_MSK))
399 cpu_relax();
401 return altera_uart_readl(port, ALTERA_UART_RXDATA_REG);
404 static void altera_uart_poll_put_char(struct uart_port *port, unsigned char c)
406 while (!(altera_uart_readl(port, ALTERA_UART_STATUS_REG) &
407 ALTERA_UART_STATUS_TRDY_MSK))
408 cpu_relax();
410 altera_uart_writel(port, c, ALTERA_UART_TXDATA_REG);
412 #endif
415 * Define the basic serial functions we support.
417 static const struct uart_ops altera_uart_ops = {
418 .tx_empty = altera_uart_tx_empty,
419 .get_mctrl = altera_uart_get_mctrl,
420 .set_mctrl = altera_uart_set_mctrl,
421 .start_tx = altera_uart_start_tx,
422 .stop_tx = altera_uart_stop_tx,
423 .stop_rx = altera_uart_stop_rx,
424 .break_ctl = altera_uart_break_ctl,
425 .startup = altera_uart_startup,
426 .shutdown = altera_uart_shutdown,
427 .set_termios = altera_uart_set_termios,
428 .type = altera_uart_type,
429 .request_port = altera_uart_request_port,
430 .release_port = altera_uart_release_port,
431 .config_port = altera_uart_config_port,
432 .verify_port = altera_uart_verify_port,
433 #ifdef CONFIG_CONSOLE_POLL
434 .poll_get_char = altera_uart_poll_get_char,
435 .poll_put_char = altera_uart_poll_put_char,
436 #endif
439 static struct altera_uart altera_uart_ports[CONFIG_SERIAL_ALTERA_UART_MAXPORTS];
441 #if defined(CONFIG_SERIAL_ALTERA_UART_CONSOLE)
443 static void altera_uart_console_putc(struct uart_port *port, int c)
445 while (!(altera_uart_readl(port, ALTERA_UART_STATUS_REG) &
446 ALTERA_UART_STATUS_TRDY_MSK))
447 cpu_relax();
449 altera_uart_writel(port, c, ALTERA_UART_TXDATA_REG);
452 static void altera_uart_console_write(struct console *co, const char *s,
453 unsigned int count)
455 struct uart_port *port = &(altera_uart_ports + co->index)->port;
457 uart_console_write(port, s, count, altera_uart_console_putc);
460 static int __init altera_uart_console_setup(struct console *co, char *options)
462 struct uart_port *port;
463 int baud = CONFIG_SERIAL_ALTERA_UART_BAUDRATE;
464 int bits = 8;
465 int parity = 'n';
466 int flow = 'n';
468 if (co->index < 0 || co->index >= CONFIG_SERIAL_ALTERA_UART_MAXPORTS)
469 return -EINVAL;
470 port = &altera_uart_ports[co->index].port;
471 if (!port->membase)
472 return -ENODEV;
474 if (options)
475 uart_parse_options(options, &baud, &parity, &bits, &flow);
477 return uart_set_options(port, co, baud, parity, bits, flow);
480 static struct uart_driver altera_uart_driver;
482 static struct console altera_uart_console = {
483 .name = "ttyAL",
484 .write = altera_uart_console_write,
485 .device = uart_console_device,
486 .setup = altera_uart_console_setup,
487 .flags = CON_PRINTBUFFER,
488 .index = -1,
489 .data = &altera_uart_driver,
492 static int __init altera_uart_console_init(void)
494 register_console(&altera_uart_console);
495 return 0;
498 console_initcall(altera_uart_console_init);
500 #define ALTERA_UART_CONSOLE (&altera_uart_console)
502 static void altera_uart_earlycon_write(struct console *co, const char *s,
503 unsigned int count)
505 struct earlycon_device *dev = co->data;
507 uart_console_write(&dev->port, s, count, altera_uart_console_putc);
510 static int __init altera_uart_earlycon_setup(struct earlycon_device *dev,
511 const char *options)
513 struct uart_port *port = &dev->port;
515 if (!port->membase)
516 return -ENODEV;
518 /* Enable RX interrupts now */
519 altera_uart_writel(port, ALTERA_UART_CONTROL_RRDY_MSK,
520 ALTERA_UART_CONTROL_REG);
522 if (dev->baud) {
523 unsigned int baudclk = port->uartclk / dev->baud;
525 altera_uart_writel(port, baudclk, ALTERA_UART_DIVISOR_REG);
528 dev->con->write = altera_uart_earlycon_write;
529 return 0;
532 OF_EARLYCON_DECLARE(uart, "altr,uart-1.0", altera_uart_earlycon_setup);
534 #else
536 #define ALTERA_UART_CONSOLE NULL
538 #endif /* CONFIG_SERIAL_ALTERA_UART_CONSOLE */
541 * Define the altera_uart UART driver structure.
543 static struct uart_driver altera_uart_driver = {
544 .owner = THIS_MODULE,
545 .driver_name = DRV_NAME,
546 .dev_name = "ttyAL",
547 .major = SERIAL_ALTERA_MAJOR,
548 .minor = SERIAL_ALTERA_MINOR,
549 .nr = CONFIG_SERIAL_ALTERA_UART_MAXPORTS,
550 .cons = ALTERA_UART_CONSOLE,
553 static int altera_uart_probe(struct platform_device *pdev)
555 struct altera_uart_platform_uart *platp = dev_get_platdata(&pdev->dev);
556 struct uart_port *port;
557 struct resource *res_mem;
558 struct resource *res_irq;
559 int i = pdev->id;
560 int ret;
562 /* if id is -1 scan for a free id and use that one */
563 if (i == -1) {
564 for (i = 0; i < CONFIG_SERIAL_ALTERA_UART_MAXPORTS; i++)
565 if (altera_uart_ports[i].port.mapbase == 0)
566 break;
569 if (i < 0 || i >= CONFIG_SERIAL_ALTERA_UART_MAXPORTS)
570 return -EINVAL;
572 port = &altera_uart_ports[i].port;
574 res_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
575 if (res_mem)
576 port->mapbase = res_mem->start;
577 else if (platp)
578 port->mapbase = platp->mapbase;
579 else
580 return -EINVAL;
582 res_irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
583 if (res_irq)
584 port->irq = res_irq->start;
585 else if (platp)
586 port->irq = platp->irq;
588 /* Check platform data first so we can override device node data */
589 if (platp)
590 port->uartclk = platp->uartclk;
591 else {
592 ret = of_property_read_u32(pdev->dev.of_node, "clock-frequency",
593 &port->uartclk);
594 if (ret)
595 return ret;
598 port->membase = ioremap(port->mapbase, ALTERA_UART_SIZE);
599 if (!port->membase)
600 return -ENOMEM;
602 if (platp)
603 port->regshift = platp->bus_shift;
604 else
605 port->regshift = 0;
607 port->line = i;
608 port->type = PORT_ALTERA_UART;
609 port->iotype = SERIAL_IO_MEM;
610 port->ops = &altera_uart_ops;
611 port->flags = UPF_BOOT_AUTOCONF;
612 port->dev = &pdev->dev;
614 platform_set_drvdata(pdev, port);
616 uart_add_one_port(&altera_uart_driver, port);
618 return 0;
621 static int altera_uart_remove(struct platform_device *pdev)
623 struct uart_port *port = platform_get_drvdata(pdev);
625 if (port) {
626 uart_remove_one_port(&altera_uart_driver, port);
627 port->mapbase = 0;
628 iounmap(port->membase);
631 return 0;
634 #ifdef CONFIG_OF
635 static const struct of_device_id altera_uart_match[] = {
636 { .compatible = "ALTR,uart-1.0", },
637 { .compatible = "altr,uart-1.0", },
640 MODULE_DEVICE_TABLE(of, altera_uart_match);
641 #endif /* CONFIG_OF */
643 static struct platform_driver altera_uart_platform_driver = {
644 .probe = altera_uart_probe,
645 .remove = altera_uart_remove,
646 .driver = {
647 .name = DRV_NAME,
648 .of_match_table = of_match_ptr(altera_uart_match),
652 static int __init altera_uart_init(void)
654 int rc;
656 rc = uart_register_driver(&altera_uart_driver);
657 if (rc)
658 return rc;
659 rc = platform_driver_register(&altera_uart_platform_driver);
660 if (rc)
661 uart_unregister_driver(&altera_uart_driver);
662 return rc;
665 static void __exit altera_uart_exit(void)
667 platform_driver_unregister(&altera_uart_platform_driver);
668 uart_unregister_driver(&altera_uart_driver);
671 module_init(altera_uart_init);
672 module_exit(altera_uart_exit);
674 MODULE_DESCRIPTION("Altera UART driver");
675 MODULE_AUTHOR("Thomas Chou <thomas@wytron.com.tw>");
676 MODULE_LICENSE("GPL");
677 MODULE_ALIAS("platform:" DRV_NAME);
678 MODULE_ALIAS_CHARDEV_MAJOR(SERIAL_ALTERA_MAJOR);