1 // SPDX-License-Identifier: GPL-2.0+
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>
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.
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
);
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
);
112 static void altera_uart_set_mctrl(struct uart_port
*port
, unsigned int sigs
)
114 struct altera_uart
*pp
= container_of(port
, struct altera_uart
, port
);
117 if (sigs
& TIOCM_RTS
)
118 pp
->imr
|= ALTERA_UART_CONTROL_RTS_MSK
;
120 pp
->imr
&= ~ALTERA_UART_CONTROL_RTS_MSK
;
121 altera_uart_writel(port
, pp
->imr
, ALTERA_UART_CONTROL_REG
);
124 static void altera_uart_start_tx(struct uart_port
*port
)
126 struct altera_uart
*pp
= container_of(port
, struct altera_uart
, port
);
128 pp
->imr
|= ALTERA_UART_CONTROL_TRDY_MSK
;
129 altera_uart_writel(port
, pp
->imr
, ALTERA_UART_CONTROL_REG
);
132 static void altera_uart_stop_tx(struct uart_port
*port
)
134 struct altera_uart
*pp
= container_of(port
, struct altera_uart
, port
);
136 pp
->imr
&= ~ALTERA_UART_CONTROL_TRDY_MSK
;
137 altera_uart_writel(port
, pp
->imr
, ALTERA_UART_CONTROL_REG
);
140 static void altera_uart_stop_rx(struct uart_port
*port
)
142 struct altera_uart
*pp
= container_of(port
, struct altera_uart
, port
);
144 pp
->imr
&= ~ALTERA_UART_CONTROL_RRDY_MSK
;
145 altera_uart_writel(port
, pp
->imr
, ALTERA_UART_CONTROL_REG
);
148 static void altera_uart_break_ctl(struct uart_port
*port
, int break_state
)
150 struct altera_uart
*pp
= container_of(port
, struct altera_uart
, port
);
153 spin_lock_irqsave(&port
->lock
, flags
);
154 if (break_state
== -1)
155 pp
->imr
|= ALTERA_UART_CONTROL_TRBK_MSK
;
157 pp
->imr
&= ~ALTERA_UART_CONTROL_TRBK_MSK
;
158 altera_uart_writel(port
, pp
->imr
, ALTERA_UART_CONTROL_REG
);
159 spin_unlock_irqrestore(&port
->lock
, flags
);
162 static void altera_uart_set_termios(struct uart_port
*port
,
163 struct ktermios
*termios
,
164 struct ktermios
*old
)
167 unsigned int baud
, baudclk
;
169 baud
= uart_get_baud_rate(port
, termios
, old
, 0, 4000000);
170 baudclk
= port
->uartclk
/ baud
;
173 tty_termios_copy_hw(termios
, old
);
174 tty_termios_encode_baud_rate(termios
, baud
, baud
);
176 spin_lock_irqsave(&port
->lock
, flags
);
177 uart_update_timeout(port
, termios
->c_cflag
, baud
);
178 altera_uart_writel(port
, baudclk
, ALTERA_UART_DIVISOR_REG
);
179 spin_unlock_irqrestore(&port
->lock
, flags
);
182 * FIXME: port->read_status_mask and port->ignore_status_mask
183 * need to be initialized based on termios settings for
184 * INPCK, IGNBRK, IGNPAR, PARMRK, BRKINT
188 static void altera_uart_rx_chars(struct altera_uart
*pp
)
190 struct uart_port
*port
= &pp
->port
;
191 unsigned char ch
, flag
;
192 unsigned short status
;
194 while ((status
= altera_uart_readl(port
, ALTERA_UART_STATUS_REG
)) &
195 ALTERA_UART_STATUS_RRDY_MSK
) {
196 ch
= altera_uart_readl(port
, ALTERA_UART_RXDATA_REG
);
200 if (status
& ALTERA_UART_STATUS_E_MSK
) {
201 altera_uart_writel(port
, status
,
202 ALTERA_UART_STATUS_REG
);
204 if (status
& ALTERA_UART_STATUS_BRK_MSK
) {
206 if (uart_handle_break(port
))
208 } else if (status
& ALTERA_UART_STATUS_PE_MSK
) {
209 port
->icount
.parity
++;
210 } else if (status
& ALTERA_UART_STATUS_ROE_MSK
) {
211 port
->icount
.overrun
++;
212 } else if (status
& ALTERA_UART_STATUS_FE_MSK
) {
213 port
->icount
.frame
++;
216 status
&= port
->read_status_mask
;
218 if (status
& ALTERA_UART_STATUS_BRK_MSK
)
220 else if (status
& ALTERA_UART_STATUS_PE_MSK
)
222 else if (status
& ALTERA_UART_STATUS_FE_MSK
)
226 if (uart_handle_sysrq_char(port
, ch
))
228 uart_insert_char(port
, status
, ALTERA_UART_STATUS_ROE_MSK
, ch
,
232 spin_unlock(&port
->lock
);
233 tty_flip_buffer_push(&port
->state
->port
);
234 spin_lock(&port
->lock
);
237 static void altera_uart_tx_chars(struct altera_uart
*pp
)
239 struct uart_port
*port
= &pp
->port
;
240 struct circ_buf
*xmit
= &port
->state
->xmit
;
243 /* Send special char - probably flow control */
244 altera_uart_writel(port
, port
->x_char
, ALTERA_UART_TXDATA_REG
);
250 while (altera_uart_readl(port
, ALTERA_UART_STATUS_REG
) &
251 ALTERA_UART_STATUS_TRDY_MSK
) {
252 if (xmit
->head
== xmit
->tail
)
254 altera_uart_writel(port
, xmit
->buf
[xmit
->tail
],
255 ALTERA_UART_TXDATA_REG
);
256 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
- 1);
260 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
261 uart_write_wakeup(port
);
263 if (xmit
->head
== xmit
->tail
) {
264 pp
->imr
&= ~ALTERA_UART_CONTROL_TRDY_MSK
;
265 altera_uart_writel(port
, pp
->imr
, ALTERA_UART_CONTROL_REG
);
269 static irqreturn_t
altera_uart_interrupt(int irq
, void *data
)
271 struct uart_port
*port
= data
;
272 struct altera_uart
*pp
= container_of(port
, struct altera_uart
, port
);
275 isr
= altera_uart_readl(port
, ALTERA_UART_STATUS_REG
) & pp
->imr
;
277 spin_lock(&port
->lock
);
278 if (isr
& ALTERA_UART_STATUS_RRDY_MSK
)
279 altera_uart_rx_chars(pp
);
280 if (isr
& ALTERA_UART_STATUS_TRDY_MSK
)
281 altera_uart_tx_chars(pp
);
282 spin_unlock(&port
->lock
);
284 return IRQ_RETVAL(isr
);
287 static void altera_uart_timer(struct timer_list
*t
)
289 struct altera_uart
*pp
= from_timer(pp
, t
, tmr
);
290 struct uart_port
*port
= &pp
->port
;
292 altera_uart_interrupt(0, port
);
293 mod_timer(&pp
->tmr
, jiffies
+ uart_poll_timeout(port
));
296 static void altera_uart_config_port(struct uart_port
*port
, int flags
)
298 port
->type
= PORT_ALTERA_UART
;
300 /* Clear mask, so no surprise interrupts. */
301 altera_uart_writel(port
, 0, ALTERA_UART_CONTROL_REG
);
302 /* Clear status register */
303 altera_uart_writel(port
, 0, ALTERA_UART_STATUS_REG
);
306 static int altera_uart_startup(struct uart_port
*port
)
308 struct altera_uart
*pp
= container_of(port
, struct altera_uart
, port
);
313 timer_setup(&pp
->tmr
, altera_uart_timer
, 0);
314 mod_timer(&pp
->tmr
, jiffies
+ uart_poll_timeout(port
));
318 ret
= request_irq(port
->irq
, altera_uart_interrupt
, 0,
321 pr_err(DRV_NAME
": unable to attach Altera UART %d "
322 "interrupt vector=%d\n", port
->line
, port
->irq
);
326 spin_lock_irqsave(&port
->lock
, flags
);
328 /* Enable RX interrupts now */
329 pp
->imr
= ALTERA_UART_CONTROL_RRDY_MSK
;
330 writel(pp
->imr
, port
->membase
+ ALTERA_UART_CONTROL_REG
);
332 spin_unlock_irqrestore(&port
->lock
, flags
);
337 static void altera_uart_shutdown(struct uart_port
*port
)
339 struct altera_uart
*pp
= container_of(port
, struct altera_uart
, port
);
342 spin_lock_irqsave(&port
->lock
, flags
);
344 /* Disable all interrupts now */
346 writel(pp
->imr
, port
->membase
+ ALTERA_UART_CONTROL_REG
);
348 spin_unlock_irqrestore(&port
->lock
, flags
);
351 free_irq(port
->irq
, port
);
353 del_timer_sync(&pp
->tmr
);
356 static const char *altera_uart_type(struct uart_port
*port
)
358 return (port
->type
== PORT_ALTERA_UART
) ? "Altera UART" : NULL
;
361 static int altera_uart_request_port(struct uart_port
*port
)
363 /* UARTs always present */
367 static void altera_uart_release_port(struct uart_port
*port
)
369 /* Nothing to release... */
372 static int altera_uart_verify_port(struct uart_port
*port
,
373 struct serial_struct
*ser
)
375 if ((ser
->type
!= PORT_UNKNOWN
) && (ser
->type
!= PORT_ALTERA_UART
))
380 #ifdef CONFIG_CONSOLE_POLL
381 static int altera_uart_poll_get_char(struct uart_port
*port
)
383 while (!(altera_uart_readl(port
, ALTERA_UART_STATUS_REG
) &
384 ALTERA_UART_STATUS_RRDY_MSK
))
387 return altera_uart_readl(port
, ALTERA_UART_RXDATA_REG
);
390 static void altera_uart_poll_put_char(struct uart_port
*port
, unsigned char c
)
392 while (!(altera_uart_readl(port
, ALTERA_UART_STATUS_REG
) &
393 ALTERA_UART_STATUS_TRDY_MSK
))
396 altera_uart_writel(port
, c
, ALTERA_UART_TXDATA_REG
);
401 * Define the basic serial functions we support.
403 static const struct uart_ops altera_uart_ops
= {
404 .tx_empty
= altera_uart_tx_empty
,
405 .get_mctrl
= altera_uart_get_mctrl
,
406 .set_mctrl
= altera_uart_set_mctrl
,
407 .start_tx
= altera_uart_start_tx
,
408 .stop_tx
= altera_uart_stop_tx
,
409 .stop_rx
= altera_uart_stop_rx
,
410 .break_ctl
= altera_uart_break_ctl
,
411 .startup
= altera_uart_startup
,
412 .shutdown
= altera_uart_shutdown
,
413 .set_termios
= altera_uart_set_termios
,
414 .type
= altera_uart_type
,
415 .request_port
= altera_uart_request_port
,
416 .release_port
= altera_uart_release_port
,
417 .config_port
= altera_uart_config_port
,
418 .verify_port
= altera_uart_verify_port
,
419 #ifdef CONFIG_CONSOLE_POLL
420 .poll_get_char
= altera_uart_poll_get_char
,
421 .poll_put_char
= altera_uart_poll_put_char
,
425 static struct altera_uart altera_uart_ports
[CONFIG_SERIAL_ALTERA_UART_MAXPORTS
];
427 #if defined(CONFIG_SERIAL_ALTERA_UART_CONSOLE)
429 static void altera_uart_console_putc(struct uart_port
*port
, int c
)
431 while (!(altera_uart_readl(port
, ALTERA_UART_STATUS_REG
) &
432 ALTERA_UART_STATUS_TRDY_MSK
))
435 writel(c
, port
->membase
+ ALTERA_UART_TXDATA_REG
);
438 static void altera_uart_console_write(struct console
*co
, const char *s
,
441 struct uart_port
*port
= &(altera_uart_ports
+ co
->index
)->port
;
443 uart_console_write(port
, s
, count
, altera_uart_console_putc
);
446 static int __init
altera_uart_console_setup(struct console
*co
, char *options
)
448 struct uart_port
*port
;
449 int baud
= CONFIG_SERIAL_ALTERA_UART_BAUDRATE
;
454 if (co
->index
< 0 || co
->index
>= CONFIG_SERIAL_ALTERA_UART_MAXPORTS
)
456 port
= &altera_uart_ports
[co
->index
].port
;
461 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
463 return uart_set_options(port
, co
, baud
, parity
, bits
, flow
);
466 static struct uart_driver altera_uart_driver
;
468 static struct console altera_uart_console
= {
470 .write
= altera_uart_console_write
,
471 .device
= uart_console_device
,
472 .setup
= altera_uart_console_setup
,
473 .flags
= CON_PRINTBUFFER
,
475 .data
= &altera_uart_driver
,
478 static int __init
altera_uart_console_init(void)
480 register_console(&altera_uart_console
);
484 console_initcall(altera_uart_console_init
);
486 #define ALTERA_UART_CONSOLE (&altera_uart_console)
488 static void altera_uart_earlycon_write(struct console
*co
, const char *s
,
491 struct earlycon_device
*dev
= co
->data
;
493 uart_console_write(&dev
->port
, s
, count
, altera_uart_console_putc
);
496 static int __init
altera_uart_earlycon_setup(struct earlycon_device
*dev
,
499 struct uart_port
*port
= &dev
->port
;
504 /* Enable RX interrupts now */
505 writel(ALTERA_UART_CONTROL_RRDY_MSK
,
506 port
->membase
+ ALTERA_UART_CONTROL_REG
);
509 unsigned int baudclk
= port
->uartclk
/ dev
->baud
;
511 writel(baudclk
, port
->membase
+ ALTERA_UART_DIVISOR_REG
);
514 dev
->con
->write
= altera_uart_earlycon_write
;
518 OF_EARLYCON_DECLARE(uart
, "altr,uart-1.0", altera_uart_earlycon_setup
);
522 #define ALTERA_UART_CONSOLE NULL
524 #endif /* CONFIG_SERIAL_ALTERA_UART_CONSOLE */
527 * Define the altera_uart UART driver structure.
529 static struct uart_driver altera_uart_driver
= {
530 .owner
= THIS_MODULE
,
531 .driver_name
= DRV_NAME
,
533 .major
= SERIAL_ALTERA_MAJOR
,
534 .minor
= SERIAL_ALTERA_MINOR
,
535 .nr
= CONFIG_SERIAL_ALTERA_UART_MAXPORTS
,
536 .cons
= ALTERA_UART_CONSOLE
,
539 static int altera_uart_probe(struct platform_device
*pdev
)
541 struct altera_uart_platform_uart
*platp
= dev_get_platdata(&pdev
->dev
);
542 struct uart_port
*port
;
543 struct resource
*res_mem
;
544 struct resource
*res_irq
;
548 /* if id is -1 scan for a free id and use that one */
550 for (i
= 0; i
< CONFIG_SERIAL_ALTERA_UART_MAXPORTS
; i
++)
551 if (altera_uart_ports
[i
].port
.mapbase
== 0)
555 if (i
< 0 || i
>= CONFIG_SERIAL_ALTERA_UART_MAXPORTS
)
558 port
= &altera_uart_ports
[i
].port
;
560 res_mem
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
562 port
->mapbase
= res_mem
->start
;
564 port
->mapbase
= platp
->mapbase
;
568 res_irq
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
570 port
->irq
= res_irq
->start
;
572 port
->irq
= platp
->irq
;
574 /* Check platform data first so we can override device node data */
576 port
->uartclk
= platp
->uartclk
;
578 ret
= of_property_read_u32(pdev
->dev
.of_node
, "clock-frequency",
584 port
->membase
= ioremap(port
->mapbase
, ALTERA_UART_SIZE
);
589 port
->regshift
= platp
->bus_shift
;
594 port
->type
= PORT_ALTERA_UART
;
595 port
->iotype
= SERIAL_IO_MEM
;
596 port
->ops
= &altera_uart_ops
;
597 port
->flags
= UPF_BOOT_AUTOCONF
;
598 port
->dev
= &pdev
->dev
;
600 platform_set_drvdata(pdev
, port
);
602 uart_add_one_port(&altera_uart_driver
, port
);
607 static int altera_uart_remove(struct platform_device
*pdev
)
609 struct uart_port
*port
= platform_get_drvdata(pdev
);
612 uart_remove_one_port(&altera_uart_driver
, port
);
614 iounmap(port
->membase
);
621 static const struct of_device_id altera_uart_match
[] = {
622 { .compatible
= "ALTR,uart-1.0", },
623 { .compatible
= "altr,uart-1.0", },
626 MODULE_DEVICE_TABLE(of
, altera_uart_match
);
627 #endif /* CONFIG_OF */
629 static struct platform_driver altera_uart_platform_driver
= {
630 .probe
= altera_uart_probe
,
631 .remove
= altera_uart_remove
,
634 .of_match_table
= of_match_ptr(altera_uart_match
),
638 static int __init
altera_uart_init(void)
642 rc
= uart_register_driver(&altera_uart_driver
);
645 rc
= platform_driver_register(&altera_uart_platform_driver
);
647 uart_unregister_driver(&altera_uart_driver
);
651 static void __exit
altera_uart_exit(void)
653 platform_driver_unregister(&altera_uart_platform_driver
);
654 uart_unregister_driver(&altera_uart_driver
);
657 module_init(altera_uart_init
);
658 module_exit(altera_uart_exit
);
660 MODULE_DESCRIPTION("Altera UART driver");
661 MODULE_AUTHOR("Thomas Chou <thomas@wytron.com.tw>");
662 MODULE_LICENSE("GPL");
663 MODULE_ALIAS("platform:" DRV_NAME
);
664 MODULE_ALIAS_CHARDEV_MAJOR(SERIAL_ALTERA_MAJOR
);