2 * Atheros AR933X SoC built-in UART driver
4 * Copyright (C) 2011 Gabor Juhos <juhosg@openwrt.org>
6 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published
10 * by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/ioport.h>
15 #include <linux/init.h>
16 #include <linux/console.h>
17 #include <linux/sysrq.h>
18 #include <linux/delay.h>
19 #include <linux/platform_device.h>
21 #include <linux/of_platform.h>
22 #include <linux/tty.h>
23 #include <linux/tty_flip.h>
24 #include <linux/serial_core.h>
25 #include <linux/serial.h>
26 #include <linux/slab.h>
28 #include <linux/irq.h>
29 #include <linux/clk.h>
31 #include <asm/div64.h>
33 #include <asm/mach-ath79/ar933x_uart.h>
35 #define DRIVER_NAME "ar933x-uart"
37 #define AR933X_UART_MAX_SCALE 0xff
38 #define AR933X_UART_MAX_STEP 0xffff
40 #define AR933X_UART_MIN_BAUD 300
41 #define AR933X_UART_MAX_BAUD 3000000
43 #define AR933X_DUMMY_STATUS_RD 0x01
45 static struct uart_driver ar933x_uart_driver
;
47 struct ar933x_uart_port
{
48 struct uart_port port
;
49 unsigned int ier
; /* shadow Interrupt Enable Register */
50 unsigned int min_baud
;
51 unsigned int max_baud
;
55 static inline bool ar933x_uart_console_enabled(void)
57 return IS_ENABLED(CONFIG_SERIAL_AR933X_CONSOLE
);
60 static inline unsigned int ar933x_uart_read(struct ar933x_uart_port
*up
,
63 return readl(up
->port
.membase
+ offset
);
66 static inline void ar933x_uart_write(struct ar933x_uart_port
*up
,
67 int offset
, unsigned int value
)
69 writel(value
, up
->port
.membase
+ offset
);
72 static inline void ar933x_uart_rmw(struct ar933x_uart_port
*up
,
79 t
= ar933x_uart_read(up
, offset
);
82 ar933x_uart_write(up
, offset
, t
);
85 static inline void ar933x_uart_rmw_set(struct ar933x_uart_port
*up
,
89 ar933x_uart_rmw(up
, offset
, 0, val
);
92 static inline void ar933x_uart_rmw_clear(struct ar933x_uart_port
*up
,
96 ar933x_uart_rmw(up
, offset
, val
, 0);
99 static inline void ar933x_uart_start_tx_interrupt(struct ar933x_uart_port
*up
)
101 up
->ier
|= AR933X_UART_INT_TX_EMPTY
;
102 ar933x_uart_write(up
, AR933X_UART_INT_EN_REG
, up
->ier
);
105 static inline void ar933x_uart_stop_tx_interrupt(struct ar933x_uart_port
*up
)
107 up
->ier
&= ~AR933X_UART_INT_TX_EMPTY
;
108 ar933x_uart_write(up
, AR933X_UART_INT_EN_REG
, up
->ier
);
111 static inline void ar933x_uart_putc(struct ar933x_uart_port
*up
, int ch
)
115 rdata
= ch
& AR933X_UART_DATA_TX_RX_MASK
;
116 rdata
|= AR933X_UART_DATA_TX_CSR
;
117 ar933x_uart_write(up
, AR933X_UART_DATA_REG
, rdata
);
120 static unsigned int ar933x_uart_tx_empty(struct uart_port
*port
)
122 struct ar933x_uart_port
*up
=
123 container_of(port
, struct ar933x_uart_port
, port
);
127 spin_lock_irqsave(&up
->port
.lock
, flags
);
128 rdata
= ar933x_uart_read(up
, AR933X_UART_DATA_REG
);
129 spin_unlock_irqrestore(&up
->port
.lock
, flags
);
131 return (rdata
& AR933X_UART_DATA_TX_CSR
) ? 0 : TIOCSER_TEMT
;
134 static unsigned int ar933x_uart_get_mctrl(struct uart_port
*port
)
139 static void ar933x_uart_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
143 static void ar933x_uart_start_tx(struct uart_port
*port
)
145 struct ar933x_uart_port
*up
=
146 container_of(port
, struct ar933x_uart_port
, port
);
148 ar933x_uart_start_tx_interrupt(up
);
151 static void ar933x_uart_stop_tx(struct uart_port
*port
)
153 struct ar933x_uart_port
*up
=
154 container_of(port
, struct ar933x_uart_port
, port
);
156 ar933x_uart_stop_tx_interrupt(up
);
159 static void ar933x_uart_stop_rx(struct uart_port
*port
)
161 struct ar933x_uart_port
*up
=
162 container_of(port
, struct ar933x_uart_port
, port
);
164 up
->ier
&= ~AR933X_UART_INT_RX_VALID
;
165 ar933x_uart_write(up
, AR933X_UART_INT_EN_REG
, up
->ier
);
168 static void ar933x_uart_break_ctl(struct uart_port
*port
, int break_state
)
170 struct ar933x_uart_port
*up
=
171 container_of(port
, struct ar933x_uart_port
, port
);
174 spin_lock_irqsave(&up
->port
.lock
, flags
);
175 if (break_state
== -1)
176 ar933x_uart_rmw_set(up
, AR933X_UART_CS_REG
,
177 AR933X_UART_CS_TX_BREAK
);
179 ar933x_uart_rmw_clear(up
, AR933X_UART_CS_REG
,
180 AR933X_UART_CS_TX_BREAK
);
181 spin_unlock_irqrestore(&up
->port
.lock
, flags
);
185 * baudrate = (clk / (scale + 1)) * (step * (1 / 2^17))
187 static unsigned long ar933x_uart_get_baud(unsigned int clk
,
194 div
= (2 << 16) * (scale
+ 1);
203 static void ar933x_uart_get_scale_step(unsigned int clk
,
215 for (tscale
= 0; tscale
< AR933X_UART_MAX_SCALE
; tscale
++) {
219 tstep
= baud
* (tscale
+ 1);
223 if (tstep
> AR933X_UART_MAX_STEP
)
226 diff
= abs(ar933x_uart_get_baud(clk
, tscale
, tstep
) - baud
);
227 if (diff
< min_diff
) {
235 static void ar933x_uart_set_termios(struct uart_port
*port
,
236 struct ktermios
*new,
237 struct ktermios
*old
)
239 struct ar933x_uart_port
*up
=
240 container_of(port
, struct ar933x_uart_port
, port
);
243 unsigned int baud
, scale
, step
;
245 /* Only CS8 is supported */
246 new->c_cflag
&= ~CSIZE
;
249 /* Only one stop bit is supported */
250 new->c_cflag
&= ~CSTOPB
;
253 if (new->c_cflag
& PARENB
) {
254 if (!(new->c_cflag
& PARODD
))
255 cs
|= AR933X_UART_CS_PARITY_EVEN
;
257 cs
|= AR933X_UART_CS_PARITY_ODD
;
259 cs
|= AR933X_UART_CS_PARITY_NONE
;
262 /* Mark/space parity is not supported */
263 new->c_cflag
&= ~CMSPAR
;
265 baud
= uart_get_baud_rate(port
, new, old
, up
->min_baud
, up
->max_baud
);
266 ar933x_uart_get_scale_step(port
->uartclk
, baud
, &scale
, &step
);
269 * Ok, we're now changing the port state. Do it with
270 * interrupts disabled.
272 spin_lock_irqsave(&up
->port
.lock
, flags
);
274 /* disable the UART */
275 ar933x_uart_rmw_clear(up
, AR933X_UART_CS_REG
,
276 AR933X_UART_CS_IF_MODE_M
<< AR933X_UART_CS_IF_MODE_S
);
278 /* Update the per-port timeout. */
279 uart_update_timeout(port
, new->c_cflag
, baud
);
281 up
->port
.ignore_status_mask
= 0;
283 /* ignore all characters if CREAD is not set */
284 if ((new->c_cflag
& CREAD
) == 0)
285 up
->port
.ignore_status_mask
|= AR933X_DUMMY_STATUS_RD
;
287 ar933x_uart_write(up
, AR933X_UART_CLOCK_REG
,
288 scale
<< AR933X_UART_CLOCK_SCALE_S
| step
);
290 /* setup configuration register */
291 ar933x_uart_rmw(up
, AR933X_UART_CS_REG
, AR933X_UART_CS_PARITY_M
, cs
);
293 /* enable host interrupt */
294 ar933x_uart_rmw_set(up
, AR933X_UART_CS_REG
,
295 AR933X_UART_CS_HOST_INT_EN
);
297 /* reenable the UART */
298 ar933x_uart_rmw(up
, AR933X_UART_CS_REG
,
299 AR933X_UART_CS_IF_MODE_M
<< AR933X_UART_CS_IF_MODE_S
,
300 AR933X_UART_CS_IF_MODE_DCE
<< AR933X_UART_CS_IF_MODE_S
);
302 spin_unlock_irqrestore(&up
->port
.lock
, flags
);
304 if (tty_termios_baud_rate(new))
305 tty_termios_encode_baud_rate(new, baud
, baud
);
308 static void ar933x_uart_rx_chars(struct ar933x_uart_port
*up
)
310 struct tty_port
*port
= &up
->port
.state
->port
;
317 rdata
= ar933x_uart_read(up
, AR933X_UART_DATA_REG
);
318 if ((rdata
& AR933X_UART_DATA_RX_CSR
) == 0)
321 /* remove the character from the FIFO */
322 ar933x_uart_write(up
, AR933X_UART_DATA_REG
,
323 AR933X_UART_DATA_RX_CSR
);
325 up
->port
.icount
.rx
++;
326 ch
= rdata
& AR933X_UART_DATA_TX_RX_MASK
;
328 if (uart_handle_sysrq_char(&up
->port
, ch
))
331 if ((up
->port
.ignore_status_mask
& AR933X_DUMMY_STATUS_RD
) == 0)
332 tty_insert_flip_char(port
, ch
, TTY_NORMAL
);
333 } while (max_count
-- > 0);
335 spin_unlock(&up
->port
.lock
);
336 tty_flip_buffer_push(port
);
337 spin_lock(&up
->port
.lock
);
340 static void ar933x_uart_tx_chars(struct ar933x_uart_port
*up
)
342 struct circ_buf
*xmit
= &up
->port
.state
->xmit
;
345 if (uart_tx_stopped(&up
->port
))
348 count
= up
->port
.fifosize
;
352 rdata
= ar933x_uart_read(up
, AR933X_UART_DATA_REG
);
353 if ((rdata
& AR933X_UART_DATA_TX_CSR
) == 0)
356 if (up
->port
.x_char
) {
357 ar933x_uart_putc(up
, up
->port
.x_char
);
358 up
->port
.icount
.tx
++;
363 if (uart_circ_empty(xmit
))
366 ar933x_uart_putc(up
, xmit
->buf
[xmit
->tail
]);
368 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
- 1);
369 up
->port
.icount
.tx
++;
370 } while (--count
> 0);
372 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
373 uart_write_wakeup(&up
->port
);
375 if (!uart_circ_empty(xmit
))
376 ar933x_uart_start_tx_interrupt(up
);
379 static irqreturn_t
ar933x_uart_interrupt(int irq
, void *dev_id
)
381 struct ar933x_uart_port
*up
= dev_id
;
384 status
= ar933x_uart_read(up
, AR933X_UART_CS_REG
);
385 if ((status
& AR933X_UART_CS_HOST_INT
) == 0)
388 spin_lock(&up
->port
.lock
);
390 status
= ar933x_uart_read(up
, AR933X_UART_INT_REG
);
391 status
&= ar933x_uart_read(up
, AR933X_UART_INT_EN_REG
);
393 if (status
& AR933X_UART_INT_RX_VALID
) {
394 ar933x_uart_write(up
, AR933X_UART_INT_REG
,
395 AR933X_UART_INT_RX_VALID
);
396 ar933x_uart_rx_chars(up
);
399 if (status
& AR933X_UART_INT_TX_EMPTY
) {
400 ar933x_uart_write(up
, AR933X_UART_INT_REG
,
401 AR933X_UART_INT_TX_EMPTY
);
402 ar933x_uart_stop_tx_interrupt(up
);
403 ar933x_uart_tx_chars(up
);
406 spin_unlock(&up
->port
.lock
);
411 static int ar933x_uart_startup(struct uart_port
*port
)
413 struct ar933x_uart_port
*up
=
414 container_of(port
, struct ar933x_uart_port
, port
);
418 ret
= request_irq(up
->port
.irq
, ar933x_uart_interrupt
,
419 up
->port
.irqflags
, dev_name(up
->port
.dev
), up
);
423 spin_lock_irqsave(&up
->port
.lock
, flags
);
425 /* Enable HOST interrupts */
426 ar933x_uart_rmw_set(up
, AR933X_UART_CS_REG
,
427 AR933X_UART_CS_HOST_INT_EN
);
429 /* Enable RX interrupts */
430 up
->ier
= AR933X_UART_INT_RX_VALID
;
431 ar933x_uart_write(up
, AR933X_UART_INT_EN_REG
, up
->ier
);
433 spin_unlock_irqrestore(&up
->port
.lock
, flags
);
438 static void ar933x_uart_shutdown(struct uart_port
*port
)
440 struct ar933x_uart_port
*up
=
441 container_of(port
, struct ar933x_uart_port
, port
);
443 /* Disable all interrupts */
445 ar933x_uart_write(up
, AR933X_UART_INT_EN_REG
, up
->ier
);
447 /* Disable break condition */
448 ar933x_uart_rmw_clear(up
, AR933X_UART_CS_REG
,
449 AR933X_UART_CS_TX_BREAK
);
451 free_irq(up
->port
.irq
, up
);
454 static const char *ar933x_uart_type(struct uart_port
*port
)
456 return (port
->type
== PORT_AR933X
) ? "AR933X UART" : NULL
;
459 static void ar933x_uart_release_port(struct uart_port
*port
)
461 /* Nothing to release ... */
464 static int ar933x_uart_request_port(struct uart_port
*port
)
466 /* UARTs always present */
470 static void ar933x_uart_config_port(struct uart_port
*port
, int flags
)
472 if (flags
& UART_CONFIG_TYPE
)
473 port
->type
= PORT_AR933X
;
476 static int ar933x_uart_verify_port(struct uart_port
*port
,
477 struct serial_struct
*ser
)
479 struct ar933x_uart_port
*up
=
480 container_of(port
, struct ar933x_uart_port
, port
);
482 if (ser
->type
!= PORT_UNKNOWN
&&
483 ser
->type
!= PORT_AR933X
)
486 if (ser
->irq
< 0 || ser
->irq
>= NR_IRQS
)
489 if (ser
->baud_base
< up
->min_baud
||
490 ser
->baud_base
> up
->max_baud
)
496 static struct uart_ops ar933x_uart_ops
= {
497 .tx_empty
= ar933x_uart_tx_empty
,
498 .set_mctrl
= ar933x_uart_set_mctrl
,
499 .get_mctrl
= ar933x_uart_get_mctrl
,
500 .stop_tx
= ar933x_uart_stop_tx
,
501 .start_tx
= ar933x_uart_start_tx
,
502 .stop_rx
= ar933x_uart_stop_rx
,
503 .break_ctl
= ar933x_uart_break_ctl
,
504 .startup
= ar933x_uart_startup
,
505 .shutdown
= ar933x_uart_shutdown
,
506 .set_termios
= ar933x_uart_set_termios
,
507 .type
= ar933x_uart_type
,
508 .release_port
= ar933x_uart_release_port
,
509 .request_port
= ar933x_uart_request_port
,
510 .config_port
= ar933x_uart_config_port
,
511 .verify_port
= ar933x_uart_verify_port
,
514 static struct ar933x_uart_port
*
515 ar933x_console_ports
[CONFIG_SERIAL_AR933X_NR_UARTS
];
517 static void ar933x_uart_wait_xmitr(struct ar933x_uart_port
*up
)
520 unsigned int timeout
= 60000;
522 /* Wait up to 60ms for the character(s) to be sent. */
524 status
= ar933x_uart_read(up
, AR933X_UART_DATA_REG
);
528 } while ((status
& AR933X_UART_DATA_TX_CSR
) == 0);
531 static void ar933x_uart_console_putchar(struct uart_port
*port
, int ch
)
533 struct ar933x_uart_port
*up
=
534 container_of(port
, struct ar933x_uart_port
, port
);
536 ar933x_uart_wait_xmitr(up
);
537 ar933x_uart_putc(up
, ch
);
540 static void ar933x_uart_console_write(struct console
*co
, const char *s
,
543 struct ar933x_uart_port
*up
= ar933x_console_ports
[co
->index
];
548 local_irq_save(flags
);
552 else if (oops_in_progress
)
553 locked
= spin_trylock(&up
->port
.lock
);
555 spin_lock(&up
->port
.lock
);
558 * First save the IER then disable the interrupts
560 int_en
= ar933x_uart_read(up
, AR933X_UART_INT_EN_REG
);
561 ar933x_uart_write(up
, AR933X_UART_INT_EN_REG
, 0);
563 uart_console_write(&up
->port
, s
, count
, ar933x_uart_console_putchar
);
566 * Finally, wait for transmitter to become empty
567 * and restore the IER
569 ar933x_uart_wait_xmitr(up
);
570 ar933x_uart_write(up
, AR933X_UART_INT_EN_REG
, int_en
);
572 ar933x_uart_write(up
, AR933X_UART_INT_REG
, AR933X_UART_INT_ALLINTS
);
575 spin_unlock(&up
->port
.lock
);
577 local_irq_restore(flags
);
580 static int ar933x_uart_console_setup(struct console
*co
, char *options
)
582 struct ar933x_uart_port
*up
;
588 if (co
->index
< 0 || co
->index
>= CONFIG_SERIAL_AR933X_NR_UARTS
)
591 up
= ar933x_console_ports
[co
->index
];
596 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
598 return uart_set_options(&up
->port
, co
, baud
, parity
, bits
, flow
);
601 static struct console ar933x_uart_console
= {
603 .write
= ar933x_uart_console_write
,
604 .device
= uart_console_device
,
605 .setup
= ar933x_uart_console_setup
,
606 .flags
= CON_PRINTBUFFER
,
608 .data
= &ar933x_uart_driver
,
611 static void ar933x_uart_add_console_port(struct ar933x_uart_port
*up
)
613 if (!ar933x_uart_console_enabled())
616 ar933x_console_ports
[up
->port
.line
] = up
;
619 static struct uart_driver ar933x_uart_driver
= {
620 .owner
= THIS_MODULE
,
621 .driver_name
= DRIVER_NAME
,
622 .dev_name
= "ttyATH",
623 .nr
= CONFIG_SERIAL_AR933X_NR_UARTS
,
624 .cons
= NULL
, /* filled in runtime */
627 static int ar933x_uart_probe(struct platform_device
*pdev
)
629 struct ar933x_uart_port
*up
;
630 struct uart_port
*port
;
631 struct resource
*mem_res
;
632 struct resource
*irq_res
;
633 struct device_node
*np
;
638 np
= pdev
->dev
.of_node
;
639 if (IS_ENABLED(CONFIG_OF
) && np
) {
640 id
= of_alias_get_id(np
, "serial");
642 dev_err(&pdev
->dev
, "unable to get alias id, err=%d\n",
652 if (id
>= CONFIG_SERIAL_AR933X_NR_UARTS
)
655 irq_res
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
657 dev_err(&pdev
->dev
, "no IRQ resource\n");
661 up
= devm_kzalloc(&pdev
->dev
, sizeof(struct ar933x_uart_port
),
666 up
->clk
= devm_clk_get(&pdev
->dev
, "uart");
667 if (IS_ERR(up
->clk
)) {
668 dev_err(&pdev
->dev
, "unable to get UART clock\n");
669 return PTR_ERR(up
->clk
);
674 mem_res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
675 port
->membase
= devm_ioremap_resource(&pdev
->dev
, mem_res
);
676 if (IS_ERR(port
->membase
))
677 return PTR_ERR(port
->membase
);
679 ret
= clk_prepare_enable(up
->clk
);
683 port
->uartclk
= clk_get_rate(up
->clk
);
684 if (!port
->uartclk
) {
686 goto err_disable_clk
;
689 port
->mapbase
= mem_res
->start
;
691 port
->irq
= irq_res
->start
;
692 port
->dev
= &pdev
->dev
;
693 port
->type
= PORT_AR933X
;
694 port
->iotype
= UPIO_MEM32
;
697 port
->fifosize
= AR933X_UART_FIFO_SIZE
;
698 port
->ops
= &ar933x_uart_ops
;
700 baud
= ar933x_uart_get_baud(port
->uartclk
, AR933X_UART_MAX_SCALE
, 1);
701 up
->min_baud
= max_t(unsigned int, baud
, AR933X_UART_MIN_BAUD
);
703 baud
= ar933x_uart_get_baud(port
->uartclk
, 0, AR933X_UART_MAX_STEP
);
704 up
->max_baud
= min_t(unsigned int, baud
, AR933X_UART_MAX_BAUD
);
706 ar933x_uart_add_console_port(up
);
708 ret
= uart_add_one_port(&ar933x_uart_driver
, &up
->port
);
710 goto err_disable_clk
;
712 platform_set_drvdata(pdev
, up
);
716 clk_disable_unprepare(up
->clk
);
720 static int ar933x_uart_remove(struct platform_device
*pdev
)
722 struct ar933x_uart_port
*up
;
724 up
= platform_get_drvdata(pdev
);
727 uart_remove_one_port(&ar933x_uart_driver
, &up
->port
);
728 clk_disable_unprepare(up
->clk
);
735 static const struct of_device_id ar933x_uart_of_ids
[] = {
736 { .compatible
= "qca,ar9330-uart" },
739 MODULE_DEVICE_TABLE(of
, ar933x_uart_of_ids
);
742 static struct platform_driver ar933x_uart_platform_driver
= {
743 .probe
= ar933x_uart_probe
,
744 .remove
= ar933x_uart_remove
,
747 .of_match_table
= of_match_ptr(ar933x_uart_of_ids
),
751 static int __init
ar933x_uart_init(void)
755 if (ar933x_uart_console_enabled())
756 ar933x_uart_driver
.cons
= &ar933x_uart_console
;
758 ret
= uart_register_driver(&ar933x_uart_driver
);
762 ret
= platform_driver_register(&ar933x_uart_platform_driver
);
764 goto err_unregister_uart_driver
;
768 err_unregister_uart_driver
:
769 uart_unregister_driver(&ar933x_uart_driver
);
774 static void __exit
ar933x_uart_exit(void)
776 platform_driver_unregister(&ar933x_uart_platform_driver
);
777 uart_unregister_driver(&ar933x_uart_driver
);
780 module_init(ar933x_uart_init
);
781 module_exit(ar933x_uart_exit
);
783 MODULE_DESCRIPTION("Atheros AR933X UART driver");
784 MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
785 MODULE_LICENSE("GPL v2");
786 MODULE_ALIAS("platform:" DRIVER_NAME
);