1 // SPDX-License-Identifier: GPL-2.0
3 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
5 * Copyright (C) 2004 Infineon IFAP DC COM CPE
6 * Copyright (C) 2007 Felix Fietkau <nbd@openwrt.org>
7 * Copyright (C) 2007 John Crispin <john@phrozen.org>
8 * Copyright (C) 2010 Thomas Langer, <thomas.langer@lantiq.com>
11 #include <linux/clk.h>
12 #include <linux/console.h>
13 #include <linux/device.h>
14 #include <linux/gpio.h>
15 #include <linux/init.h>
17 #include <linux/ioport.h>
18 #include <linux/lantiq.h>
19 #include <linux/of_address.h>
20 #include <linux/of_irq.h>
21 #include <linux/of_platform.h>
22 #include <linux/serial.h>
23 #include <linux/serial_core.h>
24 #include <linux/slab.h>
25 #include <linux/sysrq.h>
26 #include <linux/tty.h>
27 #include <linux/tty_flip.h>
29 #define PORT_LTQ_ASC 111
31 #define UART_DUMMY_UER_RX 1
32 #define DRVNAME "lantiq,asc"
34 #define LTQ_ASC_TBUF (0x0020 + 3)
35 #define LTQ_ASC_RBUF (0x0024 + 3)
37 #define LTQ_ASC_TBUF 0x0020
38 #define LTQ_ASC_RBUF 0x0024
40 #define LTQ_ASC_FSTAT 0x0048
41 #define LTQ_ASC_WHBSTATE 0x0018
42 #define LTQ_ASC_STATE 0x0014
43 #define LTQ_ASC_IRNCR 0x00F8
44 #define LTQ_ASC_CLC 0x0000
45 #define LTQ_ASC_ID 0x0008
46 #define LTQ_ASC_PISEL 0x0004
47 #define LTQ_ASC_TXFCON 0x0044
48 #define LTQ_ASC_RXFCON 0x0040
49 #define LTQ_ASC_CON 0x0010
50 #define LTQ_ASC_BG 0x0050
51 #define LTQ_ASC_IRNREN 0x00F4
53 #define ASC_IRNREN_TX 0x1
54 #define ASC_IRNREN_RX 0x2
55 #define ASC_IRNREN_ERR 0x4
56 #define ASC_IRNREN_TX_BUF 0x8
57 #define ASC_IRNCR_TIR 0x1
58 #define ASC_IRNCR_RIR 0x2
59 #define ASC_IRNCR_EIR 0x4
61 #define ASCOPT_CSIZE 0x3
64 #define ASCCLC_DISS 0x2
65 #define ASCCLC_RMCMASK 0x0000FF00
66 #define ASCCLC_RMCOFFSET 8
67 #define ASCCON_M_8ASYNC 0x0
68 #define ASCCON_M_7ASYNC 0x2
69 #define ASCCON_ODD 0x00000020
70 #define ASCCON_STP 0x00000080
71 #define ASCCON_BRS 0x00000100
72 #define ASCCON_FDE 0x00000200
73 #define ASCCON_R 0x00008000
74 #define ASCCON_FEN 0x00020000
75 #define ASCCON_ROEN 0x00080000
76 #define ASCCON_TOEN 0x00100000
77 #define ASCSTATE_PE 0x00010000
78 #define ASCSTATE_FE 0x00020000
79 #define ASCSTATE_ROE 0x00080000
80 #define ASCSTATE_ANY (ASCSTATE_ROE|ASCSTATE_PE|ASCSTATE_FE)
81 #define ASCWHBSTATE_CLRREN 0x00000001
82 #define ASCWHBSTATE_SETREN 0x00000002
83 #define ASCWHBSTATE_CLRPE 0x00000004
84 #define ASCWHBSTATE_CLRFE 0x00000008
85 #define ASCWHBSTATE_CLRROE 0x00000020
86 #define ASCTXFCON_TXFEN 0x0001
87 #define ASCTXFCON_TXFFLU 0x0002
88 #define ASCTXFCON_TXFITLMASK 0x3F00
89 #define ASCTXFCON_TXFITLOFF 8
90 #define ASCRXFCON_RXFEN 0x0001
91 #define ASCRXFCON_RXFFLU 0x0002
92 #define ASCRXFCON_RXFITLMASK 0x3F00
93 #define ASCRXFCON_RXFITLOFF 8
94 #define ASCFSTAT_RXFFLMASK 0x003F
95 #define ASCFSTAT_TXFFLMASK 0x3F00
96 #define ASCFSTAT_TXFREEMASK 0x3F000000
97 #define ASCFSTAT_TXFREEOFF 24
99 static void lqasc_tx_chars(struct uart_port *port);
100 static struct ltq_uart_port *lqasc_port[MAXPORTS];
101 static struct uart_driver lqasc_reg;
102 static DEFINE_SPINLOCK(ltq_asc_lock);
104 struct ltq_uart_port {
105 struct uart_port port;
106 /* clock used to derive divider */
108 /* clock gating of the ASC core */
112 unsigned int err_irq;
115 static inline void asc_update_bits(u32 clear, u32 set, void __iomem *reg)
117 u32 tmp = readl(reg);
119 writel((tmp & ~clear) | set, reg);
123 ltq_uart_port *to_ltq_uart_port(struct uart_port *port)
125 return container_of(port, struct ltq_uart_port, port);
129 lqasc_stop_tx(struct uart_port *port)
135 lqasc_start_tx(struct uart_port *port)
138 spin_lock_irqsave(<q_asc_lock, flags);
139 lqasc_tx_chars(port);
140 spin_unlock_irqrestore(<q_asc_lock, flags);
145 lqasc_stop_rx(struct uart_port *port)
147 writel(ASCWHBSTATE_CLRREN, port->membase + LTQ_ASC_WHBSTATE);
151 lqasc_rx_chars(struct uart_port *port)
153 struct tty_port *tport = &port->state->port;
154 unsigned int ch = 0, rsr = 0, fifocnt;
156 fifocnt = readl(port->membase + LTQ_ASC_FSTAT) & ASCFSTAT_RXFFLMASK;
158 u8 flag = TTY_NORMAL;
159 ch = readb(port->membase + LTQ_ASC_RBUF);
160 rsr = (readl(port->membase + LTQ_ASC_STATE)
161 & ASCSTATE_ANY) | UART_DUMMY_UER_RX;
162 tty_flip_buffer_push(tport);
166 * Note that the error handling code is
167 * out of the main execution path
169 if (rsr & ASCSTATE_ANY) {
170 if (rsr & ASCSTATE_PE) {
171 port->icount.parity++;
172 asc_update_bits(0, ASCWHBSTATE_CLRPE,
173 port->membase + LTQ_ASC_WHBSTATE);
174 } else if (rsr & ASCSTATE_FE) {
175 port->icount.frame++;
176 asc_update_bits(0, ASCWHBSTATE_CLRFE,
177 port->membase + LTQ_ASC_WHBSTATE);
179 if (rsr & ASCSTATE_ROE) {
180 port->icount.overrun++;
181 asc_update_bits(0, ASCWHBSTATE_CLRROE,
182 port->membase + LTQ_ASC_WHBSTATE);
185 rsr &= port->read_status_mask;
187 if (rsr & ASCSTATE_PE)
189 else if (rsr & ASCSTATE_FE)
193 if ((rsr & port->ignore_status_mask) == 0)
194 tty_insert_flip_char(tport, ch, flag);
196 if (rsr & ASCSTATE_ROE)
198 * Overrun is special, since it's reported
199 * immediately, and doesn't affect the current
202 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
206 tty_flip_buffer_push(tport);
212 lqasc_tx_chars(struct uart_port *port)
214 struct circ_buf *xmit = &port->state->xmit;
215 if (uart_tx_stopped(port)) {
220 while (((readl(port->membase + LTQ_ASC_FSTAT) &
221 ASCFSTAT_TXFREEMASK) >> ASCFSTAT_TXFREEOFF) != 0) {
223 writeb(port->x_char, port->membase + LTQ_ASC_TBUF);
229 if (uart_circ_empty(xmit))
232 writeb(port->state->xmit.buf[port->state->xmit.tail],
233 port->membase + LTQ_ASC_TBUF);
234 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
238 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
239 uart_write_wakeup(port);
243 lqasc_tx_int(int irq, void *_port)
246 struct uart_port *port = (struct uart_port *)_port;
247 spin_lock_irqsave(<q_asc_lock, flags);
248 writel(ASC_IRNCR_TIR, port->membase + LTQ_ASC_IRNCR);
249 spin_unlock_irqrestore(<q_asc_lock, flags);
250 lqasc_start_tx(port);
255 lqasc_err_int(int irq, void *_port)
258 struct uart_port *port = (struct uart_port *)_port;
259 spin_lock_irqsave(<q_asc_lock, flags);
260 /* clear any pending interrupts */
261 asc_update_bits(0, ASCWHBSTATE_CLRPE | ASCWHBSTATE_CLRFE |
262 ASCWHBSTATE_CLRROE, port->membase + LTQ_ASC_WHBSTATE);
263 spin_unlock_irqrestore(<q_asc_lock, flags);
268 lqasc_rx_int(int irq, void *_port)
271 struct uart_port *port = (struct uart_port *)_port;
272 spin_lock_irqsave(<q_asc_lock, flags);
273 writel(ASC_IRNCR_RIR, port->membase + LTQ_ASC_IRNCR);
274 lqasc_rx_chars(port);
275 spin_unlock_irqrestore(<q_asc_lock, flags);
280 lqasc_tx_empty(struct uart_port *port)
283 status = readl(port->membase + LTQ_ASC_FSTAT) & ASCFSTAT_TXFFLMASK;
284 return status ? 0 : TIOCSER_TEMT;
288 lqasc_get_mctrl(struct uart_port *port)
290 return TIOCM_CTS | TIOCM_CAR | TIOCM_DSR;
294 lqasc_set_mctrl(struct uart_port *port, u_int mctrl)
299 lqasc_break_ctl(struct uart_port *port, int break_state)
304 lqasc_startup(struct uart_port *port)
306 struct ltq_uart_port *ltq_port = to_ltq_uart_port(port);
309 if (!IS_ERR(ltq_port->clk))
310 clk_prepare_enable(ltq_port->clk);
311 port->uartclk = clk_get_rate(ltq_port->freqclk);
313 asc_update_bits(ASCCLC_DISS | ASCCLC_RMCMASK, (1 << ASCCLC_RMCOFFSET),
314 port->membase + LTQ_ASC_CLC);
316 writel(0, port->membase + LTQ_ASC_PISEL);
318 ((TXFIFO_FL << ASCTXFCON_TXFITLOFF) & ASCTXFCON_TXFITLMASK) |
319 ASCTXFCON_TXFEN | ASCTXFCON_TXFFLU,
320 port->membase + LTQ_ASC_TXFCON);
322 ((RXFIFO_FL << ASCRXFCON_RXFITLOFF) & ASCRXFCON_RXFITLMASK)
323 | ASCRXFCON_RXFEN | ASCRXFCON_RXFFLU,
324 port->membase + LTQ_ASC_RXFCON);
325 /* make sure other settings are written to hardware before
326 * setting enable bits
329 asc_update_bits(0, ASCCON_M_8ASYNC | ASCCON_FEN | ASCCON_TOEN |
330 ASCCON_ROEN, port->membase + LTQ_ASC_CON);
332 retval = request_irq(ltq_port->tx_irq, lqasc_tx_int,
335 pr_err("failed to request lqasc_tx_int\n");
339 retval = request_irq(ltq_port->rx_irq, lqasc_rx_int,
342 pr_err("failed to request lqasc_rx_int\n");
346 retval = request_irq(ltq_port->err_irq, lqasc_err_int,
349 pr_err("failed to request lqasc_err_int\n");
353 writel(ASC_IRNREN_RX | ASC_IRNREN_ERR | ASC_IRNREN_TX,
354 port->membase + LTQ_ASC_IRNREN);
358 free_irq(ltq_port->rx_irq, port);
360 free_irq(ltq_port->tx_irq, port);
365 lqasc_shutdown(struct uart_port *port)
367 struct ltq_uart_port *ltq_port = to_ltq_uart_port(port);
368 free_irq(ltq_port->tx_irq, port);
369 free_irq(ltq_port->rx_irq, port);
370 free_irq(ltq_port->err_irq, port);
372 writel(0, port->membase + LTQ_ASC_CON);
373 asc_update_bits(ASCRXFCON_RXFEN, ASCRXFCON_RXFFLU,
374 port->membase + LTQ_ASC_RXFCON);
375 asc_update_bits(ASCTXFCON_TXFEN, ASCTXFCON_TXFFLU,
376 port->membase + LTQ_ASC_TXFCON);
377 if (!IS_ERR(ltq_port->clk))
378 clk_disable_unprepare(ltq_port->clk);
382 lqasc_set_termios(struct uart_port *port,
383 struct ktermios *new, struct ktermios *old)
387 unsigned int divisor;
389 unsigned int con = 0;
392 cflag = new->c_cflag;
393 iflag = new->c_iflag;
395 switch (cflag & CSIZE) {
397 con = ASCCON_M_7ASYNC;
403 new->c_cflag &= ~ CSIZE;
405 con = ASCCON_M_8ASYNC;
409 cflag &= ~CMSPAR; /* Mark/Space parity is not supported */
414 if (cflag & PARENB) {
415 if (!(cflag & PARODD))
421 port->read_status_mask = ASCSTATE_ROE;
423 port->read_status_mask |= ASCSTATE_FE | ASCSTATE_PE;
425 port->ignore_status_mask = 0;
427 port->ignore_status_mask |= ASCSTATE_FE | ASCSTATE_PE;
429 if (iflag & IGNBRK) {
431 * If we're ignoring parity and break indicators,
432 * ignore overruns too (for real raw support).
435 port->ignore_status_mask |= ASCSTATE_ROE;
438 if ((cflag & CREAD) == 0)
439 port->ignore_status_mask |= UART_DUMMY_UER_RX;
441 /* set error signals - framing, parity and overrun, enable receiver */
442 con |= ASCCON_FEN | ASCCON_TOEN | ASCCON_ROEN;
444 spin_lock_irqsave(<q_asc_lock, flags);
447 asc_update_bits(0, con, port->membase + LTQ_ASC_CON);
449 /* Set baud rate - take a divider of 2 into account */
450 baud = uart_get_baud_rate(port, new, old, 0, port->uartclk / 16);
451 divisor = uart_get_divisor(port, baud);
452 divisor = divisor / 2 - 1;
454 /* disable the baudrate generator */
455 asc_update_bits(ASCCON_R, 0, port->membase + LTQ_ASC_CON);
457 /* make sure the fractional divider is off */
458 asc_update_bits(ASCCON_FDE, 0, port->membase + LTQ_ASC_CON);
460 /* set up to use divisor of 2 */
461 asc_update_bits(ASCCON_BRS, 0, port->membase + LTQ_ASC_CON);
463 /* now we can write the new baudrate into the register */
464 writel(divisor, port->membase + LTQ_ASC_BG);
466 /* turn the baudrate generator back on */
467 asc_update_bits(0, ASCCON_R, port->membase + LTQ_ASC_CON);
470 writel(ASCWHBSTATE_SETREN, port->membase + LTQ_ASC_WHBSTATE);
472 spin_unlock_irqrestore(<q_asc_lock, flags);
474 /* Don't rewrite B0 */
475 if (tty_termios_baud_rate(new))
476 tty_termios_encode_baud_rate(new, baud, baud);
478 uart_update_timeout(port, cflag, baud);
482 lqasc_type(struct uart_port *port)
484 if (port->type == PORT_LTQ_ASC)
491 lqasc_release_port(struct uart_port *port)
493 struct platform_device *pdev = to_platform_device(port->dev);
495 if (port->flags & UPF_IOREMAP) {
496 devm_iounmap(&pdev->dev, port->membase);
497 port->membase = NULL;
502 lqasc_request_port(struct uart_port *port)
504 struct platform_device *pdev = to_platform_device(port->dev);
505 struct resource *res;
508 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
510 dev_err(&pdev->dev, "cannot obtain I/O memory region");
513 size = resource_size(res);
515 res = devm_request_mem_region(&pdev->dev, res->start,
516 size, dev_name(&pdev->dev));
518 dev_err(&pdev->dev, "cannot request I/O memory region");
522 if (port->flags & UPF_IOREMAP) {
523 port->membase = devm_ioremap_nocache(&pdev->dev,
524 port->mapbase, size);
525 if (port->membase == NULL)
532 lqasc_config_port(struct uart_port *port, int flags)
534 if (flags & UART_CONFIG_TYPE) {
535 port->type = PORT_LTQ_ASC;
536 lqasc_request_port(port);
541 lqasc_verify_port(struct uart_port *port,
542 struct serial_struct *ser)
545 if (ser->type != PORT_UNKNOWN && ser->type != PORT_LTQ_ASC)
547 if (ser->irq < 0 || ser->irq >= NR_IRQS)
549 if (ser->baud_base < 9600)
554 static const struct uart_ops lqasc_pops = {
555 .tx_empty = lqasc_tx_empty,
556 .set_mctrl = lqasc_set_mctrl,
557 .get_mctrl = lqasc_get_mctrl,
558 .stop_tx = lqasc_stop_tx,
559 .start_tx = lqasc_start_tx,
560 .stop_rx = lqasc_stop_rx,
561 .break_ctl = lqasc_break_ctl,
562 .startup = lqasc_startup,
563 .shutdown = lqasc_shutdown,
564 .set_termios = lqasc_set_termios,
566 .release_port = lqasc_release_port,
567 .request_port = lqasc_request_port,
568 .config_port = lqasc_config_port,
569 .verify_port = lqasc_verify_port,
573 lqasc_console_putchar(struct uart_port *port, int ch)
581 fifofree = (readl(port->membase + LTQ_ASC_FSTAT)
582 & ASCFSTAT_TXFREEMASK) >> ASCFSTAT_TXFREEOFF;
583 } while (fifofree == 0);
584 writeb(ch, port->membase + LTQ_ASC_TBUF);
587 static void lqasc_serial_port_write(struct uart_port *port, const char *s,
592 spin_lock_irqsave(<q_asc_lock, flags);
593 uart_console_write(port, s, count, lqasc_console_putchar);
594 spin_unlock_irqrestore(<q_asc_lock, flags);
598 lqasc_console_write(struct console *co, const char *s, u_int count)
600 struct ltq_uart_port *ltq_port;
602 if (co->index >= MAXPORTS)
605 ltq_port = lqasc_port[co->index];
609 lqasc_serial_port_write(<q_port->port, s, count);
613 lqasc_console_setup(struct console *co, char *options)
615 struct ltq_uart_port *ltq_port;
616 struct uart_port *port;
622 if (co->index >= MAXPORTS)
625 ltq_port = lqasc_port[co->index];
629 port = <q_port->port;
631 if (!IS_ERR(ltq_port->clk))
632 clk_prepare_enable(ltq_port->clk);
634 port->uartclk = clk_get_rate(ltq_port->freqclk);
637 uart_parse_options(options, &baud, &parity, &bits, &flow);
638 return uart_set_options(port, co, baud, parity, bits, flow);
641 static struct console lqasc_console = {
643 .write = lqasc_console_write,
644 .device = uart_console_device,
645 .setup = lqasc_console_setup,
646 .flags = CON_PRINTBUFFER,
652 lqasc_console_init(void)
654 register_console(&lqasc_console);
657 console_initcall(lqasc_console_init);
659 static void lqasc_serial_early_console_write(struct console *co,
663 struct earlycon_device *dev = co->data;
665 lqasc_serial_port_write(&dev->port, s, count);
669 lqasc_serial_early_console_setup(struct earlycon_device *device,
672 if (!device->port.membase)
675 device->con->write = lqasc_serial_early_console_write;
678 OF_EARLYCON_DECLARE(lantiq, DRVNAME, lqasc_serial_early_console_setup);
680 static struct uart_driver lqasc_reg = {
681 .owner = THIS_MODULE,
682 .driver_name = DRVNAME,
683 .dev_name = "ttyLTQ",
687 .cons = &lqasc_console,
691 lqasc_probe(struct platform_device *pdev)
693 struct device_node *node = pdev->dev.of_node;
694 struct ltq_uart_port *ltq_port;
695 struct uart_port *port;
696 struct resource *mmres, irqres[3];
700 mmres = platform_get_resource(pdev, IORESOURCE_MEM, 0);
701 ret = of_irq_to_resource_table(node, irqres, 3);
702 if (!mmres || (ret != 3)) {
704 "failed to get memory/irq for serial port\n");
709 line = of_alias_get_id(node, "serial");
711 if (IS_ENABLED(CONFIG_LANTIQ)) {
712 if (mmres->start == CPHYSADDR(LTQ_EARLY_ASC))
717 dev_err(&pdev->dev, "failed to get alias id, errno %d\n",
723 if (lqasc_port[line]) {
724 dev_err(&pdev->dev, "port %d already allocated\n", line);
728 ltq_port = devm_kzalloc(&pdev->dev, sizeof(struct ltq_uart_port),
733 port = <q_port->port;
735 port->iotype = SERIAL_IO_MEM;
736 port->flags = UPF_BOOT_AUTOCONF | UPF_IOREMAP;
737 port->ops = &lqasc_pops;
739 port->type = PORT_LTQ_ASC,
741 port->dev = &pdev->dev;
742 /* unused, just to be backward-compatible */
743 port->irq = irqres[0].start;
744 port->mapbase = mmres->start;
746 if (IS_ENABLED(CONFIG_LANTIQ) && !IS_ENABLED(CONFIG_COMMON_CLK))
747 ltq_port->freqclk = clk_get_fpi();
749 ltq_port->freqclk = devm_clk_get(&pdev->dev, "freq");
752 if (IS_ERR(ltq_port->freqclk)) {
753 pr_err("failed to get fpi clk\n");
757 /* not all asc ports have clock gates, lets ignore the return code */
758 if (IS_ENABLED(CONFIG_LANTIQ) && !IS_ENABLED(CONFIG_COMMON_CLK))
759 ltq_port->clk = clk_get(&pdev->dev, NULL);
761 ltq_port->clk = devm_clk_get(&pdev->dev, "asc");
763 ltq_port->tx_irq = irqres[0].start;
764 ltq_port->rx_irq = irqres[1].start;
765 ltq_port->err_irq = irqres[2].start;
767 lqasc_port[line] = ltq_port;
768 platform_set_drvdata(pdev, ltq_port);
770 ret = uart_add_one_port(&lqasc_reg, port);
775 static const struct of_device_id ltq_asc_match[] = {
776 { .compatible = DRVNAME },
780 static struct platform_driver lqasc_driver = {
783 .of_match_table = ltq_asc_match,
792 ret = uart_register_driver(&lqasc_reg);
796 ret = platform_driver_probe(&lqasc_driver, lqasc_probe);
798 uart_unregister_driver(&lqasc_reg);
802 device_initcall(init_lqasc);