1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2018 Socionext Inc.
7 #include <linux/console.h>
8 #include <linux/module.h>
9 #include <linux/of_irq.h>
10 #include <linux/platform_device.h>
11 #include <linux/serial_core.h>
12 #include <linux/tty.h>
13 #include <linux/tty_flip.h>
15 #define USIO_NAME "mlb-usio-uart"
16 #define USIO_UART_DEV_NAME "ttyUSI"
18 static struct uart_port mlb_usio_ports[CONFIG_SERIAL_MILBEAUT_USIO_PORTS];
22 static int mlb_usio_irq[CONFIG_SERIAL_MILBEAUT_USIO_PORTS][2];
24 #define MLB_USIO_REG_SMR 0
25 #define MLB_USIO_REG_SCR 1
26 #define MLB_USIO_REG_ESCR 2
27 #define MLB_USIO_REG_SSR 3
28 #define MLB_USIO_REG_DR 4
29 #define MLB_USIO_REG_BGR 6
30 #define MLB_USIO_REG_FCR 12
31 #define MLB_USIO_REG_FBYTE 14
33 #define MLB_USIO_SMR_SOE BIT(0)
34 #define MLB_USIO_SMR_SBL BIT(3)
35 #define MLB_USIO_SCR_TXE BIT(0)
36 #define MLB_USIO_SCR_RXE BIT(1)
37 #define MLB_USIO_SCR_TBIE BIT(2)
38 #define MLB_USIO_SCR_TIE BIT(3)
39 #define MLB_USIO_SCR_RIE BIT(4)
40 #define MLB_USIO_SCR_UPCL BIT(7)
41 #define MLB_USIO_ESCR_L_8BIT 0
42 #define MLB_USIO_ESCR_L_5BIT 1
43 #define MLB_USIO_ESCR_L_6BIT 2
44 #define MLB_USIO_ESCR_L_7BIT 3
45 #define MLB_USIO_ESCR_P BIT(3)
46 #define MLB_USIO_ESCR_PEN BIT(4)
47 #define MLB_USIO_ESCR_FLWEN BIT(7)
48 #define MLB_USIO_SSR_TBI BIT(0)
49 #define MLB_USIO_SSR_TDRE BIT(1)
50 #define MLB_USIO_SSR_RDRF BIT(2)
51 #define MLB_USIO_SSR_ORE BIT(3)
52 #define MLB_USIO_SSR_FRE BIT(4)
53 #define MLB_USIO_SSR_PE BIT(5)
54 #define MLB_USIO_SSR_REC BIT(7)
55 #define MLB_USIO_SSR_BRK BIT(8)
56 #define MLB_USIO_FCR_FE1 BIT(0)
57 #define MLB_USIO_FCR_FE2 BIT(1)
58 #define MLB_USIO_FCR_FCL1 BIT(2)
59 #define MLB_USIO_FCR_FCL2 BIT(3)
60 #define MLB_USIO_FCR_FSET BIT(4)
61 #define MLB_USIO_FCR_FTIE BIT(9)
62 #define MLB_USIO_FCR_FDRQ BIT(10)
63 #define MLB_USIO_FCR_FRIIE BIT(11)
65 static void mlb_usio_stop_tx(struct uart_port *port)
67 writew(readw(port->membase + MLB_USIO_REG_FCR) & ~MLB_USIO_FCR_FTIE,
68 port->membase + MLB_USIO_REG_FCR);
69 writeb(readb(port->membase + MLB_USIO_REG_SCR) & ~MLB_USIO_SCR_TBIE,
70 port->membase + MLB_USIO_REG_SCR);
73 static void mlb_usio_tx_chars(struct uart_port *port)
75 struct circ_buf *xmit = &port->state->xmit;
78 writew(readw(port->membase + MLB_USIO_REG_FCR) & ~MLB_USIO_FCR_FTIE,
79 port->membase + MLB_USIO_REG_FCR);
80 writeb(readb(port->membase + MLB_USIO_REG_SCR) &
81 ~(MLB_USIO_SCR_TIE | MLB_USIO_SCR_TBIE),
82 port->membase + MLB_USIO_REG_SCR);
85 writew(port->x_char, port->membase + MLB_USIO_REG_DR);
90 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
91 mlb_usio_stop_tx(port);
95 count = port->fifosize -
96 (readw(port->membase + MLB_USIO_REG_FBYTE) & 0xff);
99 writew(xmit->buf[xmit->tail], port->membase + MLB_USIO_REG_DR);
101 uart_xmit_advance(port, 1);
102 if (uart_circ_empty(xmit))
105 } while (--count > 0);
107 writew(readw(port->membase + MLB_USIO_REG_FCR) & ~MLB_USIO_FCR_FDRQ,
108 port->membase + MLB_USIO_REG_FCR);
110 writeb(readb(port->membase + MLB_USIO_REG_SCR) | MLB_USIO_SCR_TBIE,
111 port->membase + MLB_USIO_REG_SCR);
113 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
114 uart_write_wakeup(port);
116 if (uart_circ_empty(xmit))
117 mlb_usio_stop_tx(port);
120 static void mlb_usio_start_tx(struct uart_port *port)
122 u16 fcr = readw(port->membase + MLB_USIO_REG_FCR);
124 writew(fcr | MLB_USIO_FCR_FTIE, port->membase + MLB_USIO_REG_FCR);
125 if (!(fcr & MLB_USIO_FCR_FDRQ))
128 writeb(readb(port->membase + MLB_USIO_REG_SCR) | MLB_USIO_SCR_TBIE,
129 port->membase + MLB_USIO_REG_SCR);
131 if (readb(port->membase + MLB_USIO_REG_SSR) & MLB_USIO_SSR_TBI)
132 mlb_usio_tx_chars(port);
135 static void mlb_usio_stop_rx(struct uart_port *port)
137 writeb(readb(port->membase + MLB_USIO_REG_SCR) & ~MLB_USIO_SCR_RIE,
138 port->membase + MLB_USIO_REG_SCR);
141 static void mlb_usio_enable_ms(struct uart_port *port)
143 writeb(readb(port->membase + MLB_USIO_REG_SCR) |
144 MLB_USIO_SCR_RIE | MLB_USIO_SCR_RXE,
145 port->membase + MLB_USIO_REG_SCR);
148 static void mlb_usio_rx_chars(struct uart_port *port)
150 struct tty_port *ttyport = &port->state->port;
155 while (max_count--) {
156 status = readb(port->membase + MLB_USIO_REG_SSR);
158 if (!(status & MLB_USIO_SSR_RDRF))
161 if (!(status & (MLB_USIO_SSR_ORE | MLB_USIO_SSR_FRE |
163 ch = readw(port->membase + MLB_USIO_REG_DR);
166 if (uart_handle_sysrq_char(port, ch))
168 uart_insert_char(port, status, MLB_USIO_SSR_ORE,
172 if (status & MLB_USIO_SSR_PE)
173 port->icount.parity++;
174 if (status & MLB_USIO_SSR_ORE)
175 port->icount.overrun++;
176 status &= port->read_status_mask;
177 if (status & MLB_USIO_SSR_BRK) {
181 if (status & MLB_USIO_SSR_PE) {
185 if (status & MLB_USIO_SSR_FRE) {
190 uart_insert_char(port, status, MLB_USIO_SSR_ORE,
193 writeb(readb(port->membase + MLB_USIO_REG_SSR) |
195 port->membase + MLB_USIO_REG_SSR);
197 max_count = readw(port->membase + MLB_USIO_REG_FBYTE) >> 8;
198 writew(readw(port->membase + MLB_USIO_REG_FCR) |
199 MLB_USIO_FCR_FE2 | MLB_USIO_FCR_FRIIE,
200 port->membase + MLB_USIO_REG_FCR);
203 tty_flip_buffer_push(ttyport);
206 static irqreturn_t mlb_usio_rx_irq(int irq, void *dev_id)
208 struct uart_port *port = dev_id;
210 spin_lock(&port->lock);
211 mlb_usio_rx_chars(port);
212 spin_unlock(&port->lock);
217 static irqreturn_t mlb_usio_tx_irq(int irq, void *dev_id)
219 struct uart_port *port = dev_id;
221 spin_lock(&port->lock);
222 if (readb(port->membase + MLB_USIO_REG_SSR) & MLB_USIO_SSR_TBI)
223 mlb_usio_tx_chars(port);
224 spin_unlock(&port->lock);
229 static unsigned int mlb_usio_tx_empty(struct uart_port *port)
231 return (readb(port->membase + MLB_USIO_REG_SSR) & MLB_USIO_SSR_TBI) ?
235 static void mlb_usio_set_mctrl(struct uart_port *port, unsigned int mctrl)
239 static unsigned int mlb_usio_get_mctrl(struct uart_port *port)
241 return TIOCM_CAR | TIOCM_DSR | TIOCM_CTS;
245 static void mlb_usio_break_ctl(struct uart_port *port, int break_state)
249 static int mlb_usio_startup(struct uart_port *port)
251 const char *portname = to_platform_device(port->dev)->name;
253 int ret, index = port->line;
256 ret = request_irq(mlb_usio_irq[index][RX], mlb_usio_rx_irq,
260 ret = request_irq(mlb_usio_irq[index][TX], mlb_usio_tx_irq,
263 free_irq(mlb_usio_irq[index][RX], port);
267 escr = readb(port->membase + MLB_USIO_REG_ESCR);
268 if (of_property_read_bool(port->dev->of_node, "auto-flow-control"))
269 escr |= MLB_USIO_ESCR_FLWEN;
270 spin_lock_irqsave(&port->lock, flags);
271 writeb(0, port->membase + MLB_USIO_REG_SCR);
272 writeb(escr, port->membase + MLB_USIO_REG_ESCR);
273 writeb(MLB_USIO_SCR_UPCL, port->membase + MLB_USIO_REG_SCR);
274 writeb(MLB_USIO_SSR_REC, port->membase + MLB_USIO_REG_SSR);
275 writew(0, port->membase + MLB_USIO_REG_FCR);
276 writew(MLB_USIO_FCR_FCL1 | MLB_USIO_FCR_FCL2,
277 port->membase + MLB_USIO_REG_FCR);
278 writew(MLB_USIO_FCR_FE1 | MLB_USIO_FCR_FE2 | MLB_USIO_FCR_FRIIE,
279 port->membase + MLB_USIO_REG_FCR);
280 writew(0, port->membase + MLB_USIO_REG_FBYTE);
281 writew(BIT(12), port->membase + MLB_USIO_REG_FBYTE);
283 writeb(MLB_USIO_SCR_TXE | MLB_USIO_SCR_RIE | MLB_USIO_SCR_TBIE |
284 MLB_USIO_SCR_RXE, port->membase + MLB_USIO_REG_SCR);
285 spin_unlock_irqrestore(&port->lock, flags);
290 static void mlb_usio_shutdown(struct uart_port *port)
292 int index = port->line;
294 free_irq(mlb_usio_irq[index][RX], port);
295 free_irq(mlb_usio_irq[index][TX], port);
298 static void mlb_usio_set_termios(struct uart_port *port,
299 struct ktermios *termios,
300 const struct ktermios *old)
302 unsigned int escr, smr = MLB_USIO_SMR_SOE;
303 unsigned long flags, baud, quot;
305 switch (termios->c_cflag & CSIZE) {
307 escr = MLB_USIO_ESCR_L_5BIT;
310 escr = MLB_USIO_ESCR_L_6BIT;
313 escr = MLB_USIO_ESCR_L_7BIT;
317 escr = MLB_USIO_ESCR_L_8BIT;
321 if (termios->c_cflag & CSTOPB)
322 smr |= MLB_USIO_SMR_SBL;
324 if (termios->c_cflag & PARENB) {
325 escr |= MLB_USIO_ESCR_PEN;
326 if (termios->c_cflag & PARODD)
327 escr |= MLB_USIO_ESCR_P;
329 /* Set hard flow control */
330 if (of_property_read_bool(port->dev->of_node, "auto-flow-control") ||
331 (termios->c_cflag & CRTSCTS))
332 escr |= MLB_USIO_ESCR_FLWEN;
334 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk);
336 quot = port->uartclk / baud - 1;
340 spin_lock_irqsave(&port->lock, flags);
341 uart_update_timeout(port, termios->c_cflag, baud);
342 port->read_status_mask = MLB_USIO_SSR_ORE | MLB_USIO_SSR_RDRF |
344 if (termios->c_iflag & INPCK)
345 port->read_status_mask |= MLB_USIO_SSR_FRE | MLB_USIO_SSR_PE;
347 port->ignore_status_mask = 0;
348 if (termios->c_iflag & IGNPAR)
349 port->ignore_status_mask |= MLB_USIO_SSR_FRE | MLB_USIO_SSR_PE;
350 if ((termios->c_iflag & IGNBRK) && (termios->c_iflag & IGNPAR))
351 port->ignore_status_mask |= MLB_USIO_SSR_ORE;
352 if ((termios->c_cflag & CREAD) == 0)
353 port->ignore_status_mask |= MLB_USIO_SSR_RDRF;
355 writeb(0, port->membase + MLB_USIO_REG_SCR);
356 writeb(MLB_USIO_SCR_UPCL, port->membase + MLB_USIO_REG_SCR);
357 writeb(MLB_USIO_SSR_REC, port->membase + MLB_USIO_REG_SSR);
358 writew(0, port->membase + MLB_USIO_REG_FCR);
359 writeb(smr, port->membase + MLB_USIO_REG_SMR);
360 writeb(escr, port->membase + MLB_USIO_REG_ESCR);
361 writew(quot, port->membase + MLB_USIO_REG_BGR);
362 writew(0, port->membase + MLB_USIO_REG_FCR);
363 writew(MLB_USIO_FCR_FCL1 | MLB_USIO_FCR_FCL2 | MLB_USIO_FCR_FE1 |
364 MLB_USIO_FCR_FE2 | MLB_USIO_FCR_FRIIE,
365 port->membase + MLB_USIO_REG_FCR);
366 writew(0, port->membase + MLB_USIO_REG_FBYTE);
367 writew(BIT(12), port->membase + MLB_USIO_REG_FBYTE);
368 writeb(MLB_USIO_SCR_RIE | MLB_USIO_SCR_RXE | MLB_USIO_SCR_TBIE |
369 MLB_USIO_SCR_TXE, port->membase + MLB_USIO_REG_SCR);
370 spin_unlock_irqrestore(&port->lock, flags);
373 static const char *mlb_usio_type(struct uart_port *port)
375 return ((port->type == PORT_MLB_USIO) ? USIO_NAME : NULL);
378 static void mlb_usio_config_port(struct uart_port *port, int flags)
380 if (flags & UART_CONFIG_TYPE)
381 port->type = PORT_MLB_USIO;
384 static const struct uart_ops mlb_usio_ops = {
385 .tx_empty = mlb_usio_tx_empty,
386 .set_mctrl = mlb_usio_set_mctrl,
387 .get_mctrl = mlb_usio_get_mctrl,
388 .stop_tx = mlb_usio_stop_tx,
389 .start_tx = mlb_usio_start_tx,
390 .stop_rx = mlb_usio_stop_rx,
391 .enable_ms = mlb_usio_enable_ms,
392 .break_ctl = mlb_usio_break_ctl,
393 .startup = mlb_usio_startup,
394 .shutdown = mlb_usio_shutdown,
395 .set_termios = mlb_usio_set_termios,
396 .type = mlb_usio_type,
397 .config_port = mlb_usio_config_port,
400 #ifdef CONFIG_SERIAL_MILBEAUT_USIO_CONSOLE
402 static void mlb_usio_console_putchar(struct uart_port *port, unsigned char c)
404 while (!(readb(port->membase + MLB_USIO_REG_SSR) & MLB_USIO_SSR_TDRE))
407 writew(c, port->membase + MLB_USIO_REG_DR);
410 static void mlb_usio_console_write(struct console *co, const char *s,
413 struct uart_port *port = &mlb_usio_ports[co->index];
415 uart_console_write(port, s, count, mlb_usio_console_putchar);
418 static int __init mlb_usio_console_setup(struct console *co, char *options)
420 struct uart_port *port;
426 if (co->index >= CONFIG_SERIAL_MILBEAUT_USIO_PORTS)
429 port = &mlb_usio_ports[co->index];
435 uart_parse_options(options, &baud, &parity, &bits, &flow);
437 if (of_property_read_bool(port->dev->of_node, "auto-flow-control"))
440 return uart_set_options(port, co, baud, parity, bits, flow);
444 static struct uart_driver mlb_usio_uart_driver;
445 static struct console mlb_usio_console = {
446 .name = USIO_UART_DEV_NAME,
447 .write = mlb_usio_console_write,
448 .device = uart_console_device,
449 .setup = mlb_usio_console_setup,
450 .flags = CON_PRINTBUFFER,
452 .data = &mlb_usio_uart_driver,
455 static int __init mlb_usio_console_init(void)
457 register_console(&mlb_usio_console);
460 console_initcall(mlb_usio_console_init);
463 static void mlb_usio_early_console_write(struct console *co, const char *s,
466 struct earlycon_device *dev = co->data;
468 uart_console_write(&dev->port, s, count, mlb_usio_console_putchar);
471 static int __init mlb_usio_early_console_setup(struct earlycon_device *device,
474 if (!device->port.membase)
476 device->con->write = mlb_usio_early_console_write;
480 OF_EARLYCON_DECLARE(mlb_usio, "socionext,milbeaut-usio-uart",
481 mlb_usio_early_console_setup);
483 #define USIO_CONSOLE (&mlb_usio_console)
485 #define USIO_CONSOLE NULL
488 static struct uart_driver mlb_usio_uart_driver = {
489 .owner = THIS_MODULE,
490 .driver_name = USIO_NAME,
491 .dev_name = USIO_UART_DEV_NAME,
492 .cons = USIO_CONSOLE,
493 .nr = CONFIG_SERIAL_MILBEAUT_USIO_PORTS,
496 static int mlb_usio_probe(struct platform_device *pdev)
498 struct clk *clk = devm_clk_get(&pdev->dev, NULL);
499 struct uart_port *port;
500 struct resource *res;
505 dev_err(&pdev->dev, "Missing clock\n");
508 ret = clk_prepare_enable(clk);
510 dev_err(&pdev->dev, "Clock enable failed: %d\n", ret);
513 of_property_read_u32(pdev->dev.of_node, "index", &index);
514 port = &mlb_usio_ports[index];
516 port->private_data = (void *)clk;
517 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
519 dev_err(&pdev->dev, "Missing regs\n");
523 port->membase = devm_ioremap(&pdev->dev, res->start,
526 ret = platform_get_irq_byname(pdev, "rx");
527 mlb_usio_irq[index][RX] = ret;
529 ret = platform_get_irq_byname(pdev, "tx");
530 mlb_usio_irq[index][TX] = ret;
532 port->irq = mlb_usio_irq[index][RX];
533 port->uartclk = clk_get_rate(clk);
534 port->fifosize = 128;
535 port->has_sysrq = IS_ENABLED(CONFIG_SERIAL_MILBEAUT_USIO_CONSOLE);
536 port->iotype = UPIO_MEM32;
537 port->flags = UPF_BOOT_AUTOCONF | UPF_SPD_VHI;
539 port->ops = &mlb_usio_ops;
540 port->dev = &pdev->dev;
542 ret = uart_add_one_port(&mlb_usio_uart_driver, port);
544 dev_err(&pdev->dev, "Adding port failed: %d\n", ret);
550 clk_disable_unprepare(clk);
555 static int mlb_usio_remove(struct platform_device *pdev)
557 struct uart_port *port = &mlb_usio_ports[pdev->id];
558 struct clk *clk = port->private_data;
560 uart_remove_one_port(&mlb_usio_uart_driver, port);
561 clk_disable_unprepare(clk);
566 static const struct of_device_id mlb_usio_dt_ids[] = {
567 { .compatible = "socionext,milbeaut-usio-uart" },
570 MODULE_DEVICE_TABLE(of, mlb_usio_dt_ids);
572 static struct platform_driver mlb_usio_driver = {
573 .probe = mlb_usio_probe,
574 .remove = mlb_usio_remove,
577 .of_match_table = mlb_usio_dt_ids,
581 static int __init mlb_usio_init(void)
583 int ret = uart_register_driver(&mlb_usio_uart_driver);
586 pr_err("%s: uart registration failed: %d\n", __func__, ret);
589 ret = platform_driver_register(&mlb_usio_driver);
591 uart_unregister_driver(&mlb_usio_uart_driver);
592 pr_err("%s: drv registration failed: %d\n", __func__, ret);
599 static void __exit mlb_usio_exit(void)
601 platform_driver_unregister(&mlb_usio_driver);
602 uart_unregister_driver(&mlb_usio_uart_driver);
605 module_init(mlb_usio_init);
606 module_exit(mlb_usio_exit);
608 MODULE_AUTHOR("SOCIONEXT");
609 MODULE_DESCRIPTION("MILBEAUT_USIO/UART Driver");
610 MODULE_LICENSE("GPL");