1 // SPDX-License-Identifier: GPL-2.0
3 * Based on meson_uart.c, by AMLOGIC, INC.
5 * Copyright (C) 2014 Carlo Caione <carlo@caione.org>
8 #if defined(CONFIG_SERIAL_MESON_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
12 #include <linux/clk.h>
13 #include <linux/console.h>
14 #include <linux/delay.h>
15 #include <linux/init.h>
17 #include <linux/module.h>
18 #include <linux/kernel.h>
20 #include <linux/platform_device.h>
21 #include <linux/serial.h>
22 #include <linux/serial_core.h>
23 #include <linux/tty.h>
24 #include <linux/tty_flip.h>
26 /* Register offsets */
27 #define AML_UART_WFIFO 0x00
28 #define AML_UART_RFIFO 0x04
29 #define AML_UART_CONTROL 0x08
30 #define AML_UART_STATUS 0x0c
31 #define AML_UART_MISC 0x10
32 #define AML_UART_REG5 0x14
34 /* AML_UART_CONTROL bits */
35 #define AML_UART_TX_EN BIT(12)
36 #define AML_UART_RX_EN BIT(13)
37 #define AML_UART_TWO_WIRE_EN BIT(15)
38 #define AML_UART_STOP_BIT_LEN_MASK (0x03 << 16)
39 #define AML_UART_STOP_BIT_1SB (0x00 << 16)
40 #define AML_UART_STOP_BIT_2SB (0x01 << 16)
41 #define AML_UART_PARITY_TYPE BIT(18)
42 #define AML_UART_PARITY_EN BIT(19)
43 #define AML_UART_TX_RST BIT(22)
44 #define AML_UART_RX_RST BIT(23)
45 #define AML_UART_CLEAR_ERR BIT(24)
46 #define AML_UART_RX_INT_EN BIT(27)
47 #define AML_UART_TX_INT_EN BIT(28)
48 #define AML_UART_DATA_LEN_MASK (0x03 << 20)
49 #define AML_UART_DATA_LEN_8BIT (0x00 << 20)
50 #define AML_UART_DATA_LEN_7BIT (0x01 << 20)
51 #define AML_UART_DATA_LEN_6BIT (0x02 << 20)
52 #define AML_UART_DATA_LEN_5BIT (0x03 << 20)
54 /* AML_UART_STATUS bits */
55 #define AML_UART_PARITY_ERR BIT(16)
56 #define AML_UART_FRAME_ERR BIT(17)
57 #define AML_UART_TX_FIFO_WERR BIT(18)
58 #define AML_UART_RX_EMPTY BIT(20)
59 #define AML_UART_TX_FULL BIT(21)
60 #define AML_UART_TX_EMPTY BIT(22)
61 #define AML_UART_XMIT_BUSY BIT(25)
62 #define AML_UART_ERR (AML_UART_PARITY_ERR | \
63 AML_UART_FRAME_ERR | \
64 AML_UART_TX_FIFO_WERR)
66 /* AML_UART_MISC bits */
67 #define AML_UART_XMIT_IRQ(c) (((c) & 0xff) << 8)
68 #define AML_UART_RECV_IRQ(c) ((c) & 0xff)
70 /* AML_UART_REG5 bits */
71 #define AML_UART_BAUD_MASK 0x7fffff
72 #define AML_UART_BAUD_USE BIT(23)
73 #define AML_UART_BAUD_XTAL BIT(24)
75 #define AML_UART_PORT_NUM 6
76 #define AML_UART_DEV_NAME "ttyAML"
79 static struct uart_driver meson_uart_driver
;
81 static struct uart_port
*meson_ports
[AML_UART_PORT_NUM
];
83 static void meson_uart_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
87 static unsigned int meson_uart_get_mctrl(struct uart_port
*port
)
92 static unsigned int meson_uart_tx_empty(struct uart_port
*port
)
96 val
= readl(port
->membase
+ AML_UART_STATUS
);
97 val
&= (AML_UART_TX_EMPTY
| AML_UART_XMIT_BUSY
);
98 return (val
== AML_UART_TX_EMPTY
) ? TIOCSER_TEMT
: 0;
101 static void meson_uart_stop_tx(struct uart_port
*port
)
105 val
= readl(port
->membase
+ AML_UART_CONTROL
);
106 val
&= ~AML_UART_TX_INT_EN
;
107 writel(val
, port
->membase
+ AML_UART_CONTROL
);
110 static void meson_uart_stop_rx(struct uart_port
*port
)
114 val
= readl(port
->membase
+ AML_UART_CONTROL
);
115 val
&= ~AML_UART_RX_EN
;
116 writel(val
, port
->membase
+ AML_UART_CONTROL
);
119 static void meson_uart_shutdown(struct uart_port
*port
)
124 free_irq(port
->irq
, port
);
126 spin_lock_irqsave(&port
->lock
, flags
);
128 val
= readl(port
->membase
+ AML_UART_CONTROL
);
129 val
&= ~AML_UART_RX_EN
;
130 val
&= ~(AML_UART_RX_INT_EN
| AML_UART_TX_INT_EN
);
131 writel(val
, port
->membase
+ AML_UART_CONTROL
);
133 spin_unlock_irqrestore(&port
->lock
, flags
);
136 static void meson_uart_start_tx(struct uart_port
*port
)
138 struct circ_buf
*xmit
= &port
->state
->xmit
;
142 if (uart_tx_stopped(port
)) {
143 meson_uart_stop_tx(port
);
147 while (!(readl(port
->membase
+ AML_UART_STATUS
) & AML_UART_TX_FULL
)) {
149 writel(port
->x_char
, port
->membase
+ AML_UART_WFIFO
);
155 if (uart_circ_empty(xmit
))
158 ch
= xmit
->buf
[xmit
->tail
];
159 writel(ch
, port
->membase
+ AML_UART_WFIFO
);
160 xmit
->tail
= (xmit
->tail
+1) & (SERIAL_XMIT_SIZE
- 1);
164 if (!uart_circ_empty(xmit
)) {
165 val
= readl(port
->membase
+ AML_UART_CONTROL
);
166 val
|= AML_UART_TX_INT_EN
;
167 writel(val
, port
->membase
+ AML_UART_CONTROL
);
170 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
171 uart_write_wakeup(port
);
174 static void meson_receive_chars(struct uart_port
*port
)
176 struct tty_port
*tport
= &port
->state
->port
;
178 u32 ostatus
, status
, ch
, mode
;
183 ostatus
= status
= readl(port
->membase
+ AML_UART_STATUS
);
185 if (status
& AML_UART_ERR
) {
186 if (status
& AML_UART_TX_FIFO_WERR
)
187 port
->icount
.overrun
++;
188 else if (status
& AML_UART_FRAME_ERR
)
189 port
->icount
.frame
++;
190 else if (status
& AML_UART_PARITY_ERR
)
191 port
->icount
.frame
++;
193 mode
= readl(port
->membase
+ AML_UART_CONTROL
);
194 mode
|= AML_UART_CLEAR_ERR
;
195 writel(mode
, port
->membase
+ AML_UART_CONTROL
);
197 /* It doesn't clear to 0 automatically */
198 mode
&= ~AML_UART_CLEAR_ERR
;
199 writel(mode
, port
->membase
+ AML_UART_CONTROL
);
201 status
&= port
->read_status_mask
;
202 if (status
& AML_UART_FRAME_ERR
)
204 else if (status
& AML_UART_PARITY_ERR
)
208 ch
= readl(port
->membase
+ AML_UART_RFIFO
);
211 if ((ostatus
& AML_UART_FRAME_ERR
) && (ch
== 0)) {
214 if (uart_handle_break(port
))
218 if (uart_handle_sysrq_char(port
, ch
))
221 if ((status
& port
->ignore_status_mask
) == 0)
222 tty_insert_flip_char(tport
, ch
, flag
);
224 if (status
& AML_UART_TX_FIFO_WERR
)
225 tty_insert_flip_char(tport
, 0, TTY_OVERRUN
);
227 } while (!(readl(port
->membase
+ AML_UART_STATUS
) & AML_UART_RX_EMPTY
));
229 spin_unlock(&port
->lock
);
230 tty_flip_buffer_push(tport
);
231 spin_lock(&port
->lock
);
234 static irqreturn_t
meson_uart_interrupt(int irq
, void *dev_id
)
236 struct uart_port
*port
= (struct uart_port
*)dev_id
;
238 spin_lock(&port
->lock
);
240 if (!(readl(port
->membase
+ AML_UART_STATUS
) & AML_UART_RX_EMPTY
))
241 meson_receive_chars(port
);
243 if (!(readl(port
->membase
+ AML_UART_STATUS
) & AML_UART_TX_FULL
)) {
244 if (readl(port
->membase
+ AML_UART_CONTROL
) & AML_UART_TX_INT_EN
)
245 meson_uart_start_tx(port
);
248 spin_unlock(&port
->lock
);
253 static const char *meson_uart_type(struct uart_port
*port
)
255 return (port
->type
== PORT_MESON
) ? "meson_uart" : NULL
;
258 static void meson_uart_reset(struct uart_port
*port
)
262 val
= readl(port
->membase
+ AML_UART_CONTROL
);
263 val
|= (AML_UART_RX_RST
| AML_UART_TX_RST
| AML_UART_CLEAR_ERR
);
264 writel(val
, port
->membase
+ AML_UART_CONTROL
);
266 val
&= ~(AML_UART_RX_RST
| AML_UART_TX_RST
| AML_UART_CLEAR_ERR
);
267 writel(val
, port
->membase
+ AML_UART_CONTROL
);
270 static int meson_uart_startup(struct uart_port
*port
)
275 val
= readl(port
->membase
+ AML_UART_CONTROL
);
276 val
|= AML_UART_CLEAR_ERR
;
277 writel(val
, port
->membase
+ AML_UART_CONTROL
);
278 val
&= ~AML_UART_CLEAR_ERR
;
279 writel(val
, port
->membase
+ AML_UART_CONTROL
);
281 val
|= (AML_UART_RX_EN
| AML_UART_TX_EN
);
282 writel(val
, port
->membase
+ AML_UART_CONTROL
);
284 val
|= (AML_UART_RX_INT_EN
| AML_UART_TX_INT_EN
);
285 writel(val
, port
->membase
+ AML_UART_CONTROL
);
287 val
= (AML_UART_RECV_IRQ(1) | AML_UART_XMIT_IRQ(port
->fifosize
/ 2));
288 writel(val
, port
->membase
+ AML_UART_MISC
);
290 ret
= request_irq(port
->irq
, meson_uart_interrupt
, 0,
296 static void meson_uart_change_speed(struct uart_port
*port
, unsigned long baud
)
300 while (!meson_uart_tx_empty(port
))
303 if (port
->uartclk
== 24000000) {
304 val
= ((port
->uartclk
/ 3) / baud
) - 1;
305 val
|= AML_UART_BAUD_XTAL
;
307 val
= ((port
->uartclk
* 10 / (baud
* 4) + 5) / 10) - 1;
309 val
|= AML_UART_BAUD_USE
;
310 writel(val
, port
->membase
+ AML_UART_REG5
);
313 static void meson_uart_set_termios(struct uart_port
*port
,
314 struct ktermios
*termios
,
315 struct ktermios
*old
)
317 unsigned int cflags
, iflags
, baud
;
321 spin_lock_irqsave(&port
->lock
, flags
);
323 cflags
= termios
->c_cflag
;
324 iflags
= termios
->c_iflag
;
326 val
= readl(port
->membase
+ AML_UART_CONTROL
);
328 val
&= ~AML_UART_DATA_LEN_MASK
;
329 switch (cflags
& CSIZE
) {
331 val
|= AML_UART_DATA_LEN_8BIT
;
334 val
|= AML_UART_DATA_LEN_7BIT
;
337 val
|= AML_UART_DATA_LEN_6BIT
;
340 val
|= AML_UART_DATA_LEN_5BIT
;
345 val
|= AML_UART_PARITY_EN
;
347 val
&= ~AML_UART_PARITY_EN
;
350 val
|= AML_UART_PARITY_TYPE
;
352 val
&= ~AML_UART_PARITY_TYPE
;
354 val
&= ~AML_UART_STOP_BIT_LEN_MASK
;
356 val
|= AML_UART_STOP_BIT_2SB
;
358 val
|= AML_UART_STOP_BIT_1SB
;
360 if (cflags
& CRTSCTS
)
361 val
&= ~AML_UART_TWO_WIRE_EN
;
363 val
|= AML_UART_TWO_WIRE_EN
;
365 writel(val
, port
->membase
+ AML_UART_CONTROL
);
367 baud
= uart_get_baud_rate(port
, termios
, old
, 50, 4000000);
368 meson_uart_change_speed(port
, baud
);
370 port
->read_status_mask
= AML_UART_TX_FIFO_WERR
;
372 port
->read_status_mask
|= AML_UART_PARITY_ERR
|
375 port
->ignore_status_mask
= 0;
377 port
->ignore_status_mask
|= AML_UART_PARITY_ERR
|
380 uart_update_timeout(port
, termios
->c_cflag
, baud
);
381 spin_unlock_irqrestore(&port
->lock
, flags
);
384 static int meson_uart_verify_port(struct uart_port
*port
,
385 struct serial_struct
*ser
)
389 if (port
->type
!= PORT_MESON
)
391 if (port
->irq
!= ser
->irq
)
393 if (ser
->baud_base
< 9600)
398 static void meson_uart_release_port(struct uart_port
*port
)
400 devm_iounmap(port
->dev
, port
->membase
);
401 port
->membase
= NULL
;
402 devm_release_mem_region(port
->dev
, port
->mapbase
, port
->mapsize
);
405 static int meson_uart_request_port(struct uart_port
*port
)
407 if (!devm_request_mem_region(port
->dev
, port
->mapbase
, port
->mapsize
,
408 dev_name(port
->dev
))) {
409 dev_err(port
->dev
, "Memory region busy\n");
413 port
->membase
= devm_ioremap_nocache(port
->dev
, port
->mapbase
,
421 static void meson_uart_config_port(struct uart_port
*port
, int flags
)
423 if (flags
& UART_CONFIG_TYPE
) {
424 port
->type
= PORT_MESON
;
425 meson_uart_request_port(port
);
429 static const struct uart_ops meson_uart_ops
= {
430 .set_mctrl
= meson_uart_set_mctrl
,
431 .get_mctrl
= meson_uart_get_mctrl
,
432 .tx_empty
= meson_uart_tx_empty
,
433 .start_tx
= meson_uart_start_tx
,
434 .stop_tx
= meson_uart_stop_tx
,
435 .stop_rx
= meson_uart_stop_rx
,
436 .startup
= meson_uart_startup
,
437 .shutdown
= meson_uart_shutdown
,
438 .set_termios
= meson_uart_set_termios
,
439 .type
= meson_uart_type
,
440 .config_port
= meson_uart_config_port
,
441 .request_port
= meson_uart_request_port
,
442 .release_port
= meson_uart_release_port
,
443 .verify_port
= meson_uart_verify_port
,
446 #ifdef CONFIG_SERIAL_MESON_CONSOLE
447 static void meson_uart_enable_tx_engine(struct uart_port
*port
)
451 val
= readl(port
->membase
+ AML_UART_CONTROL
);
452 val
|= AML_UART_TX_EN
;
453 writel(val
, port
->membase
+ AML_UART_CONTROL
);
456 static void meson_console_putchar(struct uart_port
*port
, int ch
)
461 while (readl(port
->membase
+ AML_UART_STATUS
) & AML_UART_TX_FULL
)
463 writel(ch
, port
->membase
+ AML_UART_WFIFO
);
466 static void meson_serial_port_write(struct uart_port
*port
, const char *s
,
473 local_irq_save(flags
);
476 } else if (oops_in_progress
) {
477 locked
= spin_trylock(&port
->lock
);
479 spin_lock(&port
->lock
);
483 val
= readl(port
->membase
+ AML_UART_CONTROL
);
484 tmp
= val
& ~(AML_UART_TX_INT_EN
| AML_UART_RX_INT_EN
);
485 writel(tmp
, port
->membase
+ AML_UART_CONTROL
);
487 uart_console_write(port
, s
, count
, meson_console_putchar
);
488 writel(val
, port
->membase
+ AML_UART_CONTROL
);
491 spin_unlock(&port
->lock
);
492 local_irq_restore(flags
);
495 static void meson_serial_console_write(struct console
*co
, const char *s
,
498 struct uart_port
*port
;
500 port
= meson_ports
[co
->index
];
504 meson_serial_port_write(port
, s
, count
);
507 static int meson_serial_console_setup(struct console
*co
, char *options
)
509 struct uart_port
*port
;
515 if (co
->index
< 0 || co
->index
>= AML_UART_PORT_NUM
)
518 port
= meson_ports
[co
->index
];
519 if (!port
|| !port
->membase
)
522 meson_uart_enable_tx_engine(port
);
525 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
527 return uart_set_options(port
, co
, baud
, parity
, bits
, flow
);
530 static struct console meson_serial_console
= {
531 .name
= AML_UART_DEV_NAME
,
532 .write
= meson_serial_console_write
,
533 .device
= uart_console_device
,
534 .setup
= meson_serial_console_setup
,
535 .flags
= CON_PRINTBUFFER
,
537 .data
= &meson_uart_driver
,
540 static int __init
meson_serial_console_init(void)
542 register_console(&meson_serial_console
);
545 console_initcall(meson_serial_console_init
);
547 static void meson_serial_early_console_write(struct console
*co
,
551 struct earlycon_device
*dev
= co
->data
;
553 meson_serial_port_write(&dev
->port
, s
, count
);
557 meson_serial_early_console_setup(struct earlycon_device
*device
, const char *opt
)
559 if (!device
->port
.membase
)
562 meson_uart_enable_tx_engine(&device
->port
);
563 device
->con
->write
= meson_serial_early_console_write
;
566 /* Legacy bindings, should be removed when no more used */
567 OF_EARLYCON_DECLARE(meson
, "amlogic,meson-uart",
568 meson_serial_early_console_setup
);
569 /* Stable bindings */
570 OF_EARLYCON_DECLARE(meson
, "amlogic,meson-ao-uart",
571 meson_serial_early_console_setup
);
573 #define MESON_SERIAL_CONSOLE (&meson_serial_console)
575 #define MESON_SERIAL_CONSOLE NULL
578 static struct uart_driver meson_uart_driver
= {
579 .owner
= THIS_MODULE
,
580 .driver_name
= "meson_uart",
581 .dev_name
= AML_UART_DEV_NAME
,
582 .nr
= AML_UART_PORT_NUM
,
583 .cons
= MESON_SERIAL_CONSOLE
,
586 static inline struct clk
*meson_uart_probe_clock(struct device
*dev
,
589 struct clk
*clk
= NULL
;
592 clk
= devm_clk_get(dev
, id
);
596 ret
= clk_prepare_enable(clk
);
598 dev_err(dev
, "couldn't enable clk\n");
602 devm_add_action_or_reset(dev
,
603 (void(*)(void *))clk_disable_unprepare
,
610 * This function gets clocks in the legacy non-stable DT bindings.
611 * This code will be remove once all the platforms switch to the
614 static int meson_uart_probe_clocks_legacy(struct platform_device
*pdev
,
615 struct uart_port
*port
)
617 struct clk
*clk
= NULL
;
619 clk
= meson_uart_probe_clock(&pdev
->dev
, NULL
);
623 port
->uartclk
= clk_get_rate(clk
);
628 static int meson_uart_probe_clocks(struct platform_device
*pdev
,
629 struct uart_port
*port
)
631 struct clk
*clk_xtal
= NULL
;
632 struct clk
*clk_pclk
= NULL
;
633 struct clk
*clk_baud
= NULL
;
635 clk_pclk
= meson_uart_probe_clock(&pdev
->dev
, "pclk");
636 if (IS_ERR(clk_pclk
))
637 return PTR_ERR(clk_pclk
);
639 clk_xtal
= meson_uart_probe_clock(&pdev
->dev
, "xtal");
640 if (IS_ERR(clk_xtal
))
641 return PTR_ERR(clk_xtal
);
643 clk_baud
= meson_uart_probe_clock(&pdev
->dev
, "baud");
644 if (IS_ERR(clk_baud
))
645 return PTR_ERR(clk_baud
);
647 port
->uartclk
= clk_get_rate(clk_baud
);
652 static int meson_uart_probe(struct platform_device
*pdev
)
654 struct resource
*res_mem
, *res_irq
;
655 struct uart_port
*port
;
658 if (pdev
->dev
.of_node
)
659 pdev
->id
= of_alias_get_id(pdev
->dev
.of_node
, "serial");
661 if (pdev
->id
< 0 || pdev
->id
>= AML_UART_PORT_NUM
)
664 res_mem
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
668 res_irq
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
672 if (meson_ports
[pdev
->id
]) {
673 dev_err(&pdev
->dev
, "port %d already allocated\n", pdev
->id
);
677 port
= devm_kzalloc(&pdev
->dev
, sizeof(struct uart_port
), GFP_KERNEL
);
681 /* Use legacy way until all platforms switch to new bindings */
682 if (of_device_is_compatible(pdev
->dev
.of_node
, "amlogic,meson-uart"))
683 ret
= meson_uart_probe_clocks_legacy(pdev
, port
);
685 ret
= meson_uart_probe_clocks(pdev
, port
);
690 port
->iotype
= UPIO_MEM
;
691 port
->mapbase
= res_mem
->start
;
692 port
->mapsize
= resource_size(res_mem
);
693 port
->irq
= res_irq
->start
;
694 port
->flags
= UPF_BOOT_AUTOCONF
| UPF_LOW_LATENCY
;
695 port
->dev
= &pdev
->dev
;
696 port
->line
= pdev
->id
;
697 port
->type
= PORT_MESON
;
699 port
->ops
= &meson_uart_ops
;
702 meson_ports
[pdev
->id
] = port
;
703 platform_set_drvdata(pdev
, port
);
705 /* reset port before registering (and possibly registering console) */
706 if (meson_uart_request_port(port
) >= 0) {
707 meson_uart_reset(port
);
708 meson_uart_release_port(port
);
711 ret
= uart_add_one_port(&meson_uart_driver
, port
);
713 meson_ports
[pdev
->id
] = NULL
;
718 static int meson_uart_remove(struct platform_device
*pdev
)
720 struct uart_port
*port
;
722 port
= platform_get_drvdata(pdev
);
723 uart_remove_one_port(&meson_uart_driver
, port
);
724 meson_ports
[pdev
->id
] = NULL
;
729 static const struct of_device_id meson_uart_dt_match
[] = {
730 /* Legacy bindings, should be removed when no more used */
731 { .compatible
= "amlogic,meson-uart" },
732 /* Stable bindings */
733 { .compatible
= "amlogic,meson6-uart" },
734 { .compatible
= "amlogic,meson8-uart" },
735 { .compatible
= "amlogic,meson8b-uart" },
736 { .compatible
= "amlogic,meson-gx-uart" },
739 MODULE_DEVICE_TABLE(of
, meson_uart_dt_match
);
741 static struct platform_driver meson_uart_platform_driver
= {
742 .probe
= meson_uart_probe
,
743 .remove
= meson_uart_remove
,
745 .name
= "meson_uart",
746 .of_match_table
= meson_uart_dt_match
,
750 static int __init
meson_uart_init(void)
754 ret
= uart_register_driver(&meson_uart_driver
);
758 ret
= platform_driver_register(&meson_uart_platform_driver
);
760 uart_unregister_driver(&meson_uart_driver
);
765 static void __exit
meson_uart_exit(void)
767 platform_driver_unregister(&meson_uart_platform_driver
);
768 uart_unregister_driver(&meson_uart_driver
);
771 module_init(meson_uart_init
);
772 module_exit(meson_uart_exit
);
774 MODULE_AUTHOR("Carlo Caione <carlo@caione.org>");
775 MODULE_DESCRIPTION("Amlogic Meson serial port driver");
776 MODULE_LICENSE("GPL v2");