GNU Linux-libre 6.8.9-gnu
[releases.git] / drivers / tty / serial / arc_uart.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * ARC On-Chip(fpga) UART Driver
4  *
5  * Copyright (C) 2010-2012 Synopsys, Inc. (www.synopsys.com)
6  *
7  * vineetg: July 10th 2012
8  *  -Decoupled the driver from arch/arc
9  *    +Using platform_get_resource() for irq/membase (thx to bfin_uart.c)
10  *    +Using early_platform_xxx() for early console (thx to mach-shmobile/xxx)
11  *
12  * Vineetg: Aug 21st 2010
13  *  -Is uart_tx_stopped() not done in tty write path as it has already been
14  *   taken care of, in serial core
15  *
16  * Vineetg: Aug 18th 2010
17  *  -New Serial Core based ARC UART driver
18  *  -Derived largely from blackfin driver albiet with some major tweaks
19  *
20  * TODO:
21  *  -check if sysreq works
22  */
23
24 #include <linux/module.h>
25 #include <linux/serial.h>
26 #include <linux/console.h>
27 #include <linux/sysrq.h>
28 #include <linux/platform_device.h>
29 #include <linux/tty.h>
30 #include <linux/tty_flip.h>
31 #include <linux/serial_core.h>
32 #include <linux/io.h>
33 #include <linux/of_irq.h>
34 #include <linux/of_address.h>
35
36 /*************************************
37  * ARC UART Hardware Specs
38  ************************************/
39 #define ARC_UART_TX_FIFO_SIZE  1
40
41 /*
42  * UART Register set (this is not a Standards Compliant IP)
43  * Also each reg is Word aligned, but only 8 bits wide
44  */
45 #define R_ID0   0
46 #define R_ID1   4
47 #define R_ID2   8
48 #define R_ID3   12
49 #define R_DATA  16
50 #define R_STS   20
51 #define R_BAUDL 24
52 #define R_BAUDH 28
53
54 /* Bits for UART Status Reg (R/W) */
55 #define RXIENB  0x04    /* Receive Interrupt Enable */
56 #define TXIENB  0x40    /* Transmit Interrupt Enable */
57
58 #define RXEMPTY 0x20    /* Receive FIFO Empty: No char receivede */
59 #define TXEMPTY 0x80    /* Transmit FIFO Empty, thus char can be written into */
60
61 #define RXFULL  0x08    /* Receive FIFO full */
62 #define RXFULL1 0x10    /* Receive FIFO has space for 1 char (tot space=4) */
63
64 #define RXFERR  0x01    /* Frame Error: Stop Bit not detected */
65 #define RXOERR  0x02    /* OverFlow Err: Char recv but RXFULL still set */
66
67 /* Uart bit fiddling helpers: lowest level */
68 #define RBASE(port, reg)      (port->membase + reg)
69 #define UART_REG_SET(u, r, v) writeb((v), RBASE(u, r))
70 #define UART_REG_GET(u, r)    readb(RBASE(u, r))
71
72 #define UART_REG_OR(u, r, v)  UART_REG_SET(u, r, UART_REG_GET(u, r) | (v))
73 #define UART_REG_CLR(u, r, v) UART_REG_SET(u, r, UART_REG_GET(u, r) & ~(v))
74
75 /* Uart bit fiddling helpers: API level */
76 #define UART_SET_DATA(uart, val)   UART_REG_SET(uart, R_DATA, val)
77 #define UART_GET_DATA(uart)        UART_REG_GET(uart, R_DATA)
78
79 #define UART_SET_BAUDH(uart, val)  UART_REG_SET(uart, R_BAUDH, val)
80 #define UART_SET_BAUDL(uart, val)  UART_REG_SET(uart, R_BAUDL, val)
81
82 #define UART_CLR_STATUS(uart, val) UART_REG_CLR(uart, R_STS, val)
83 #define UART_GET_STATUS(uart)      UART_REG_GET(uart, R_STS)
84
85 #define UART_ALL_IRQ_DISABLE(uart) UART_REG_CLR(uart, R_STS, RXIENB|TXIENB)
86 #define UART_RX_IRQ_DISABLE(uart)  UART_REG_CLR(uart, R_STS, RXIENB)
87 #define UART_TX_IRQ_DISABLE(uart)  UART_REG_CLR(uart, R_STS, TXIENB)
88
89 #define UART_ALL_IRQ_ENABLE(uart)  UART_REG_OR(uart, R_STS, RXIENB|TXIENB)
90 #define UART_RX_IRQ_ENABLE(uart)   UART_REG_OR(uart, R_STS, RXIENB)
91 #define UART_TX_IRQ_ENABLE(uart)   UART_REG_OR(uart, R_STS, TXIENB)
92
93 #define ARC_SERIAL_DEV_NAME     "ttyARC"
94
95 struct arc_uart_port {
96         struct uart_port port;
97         unsigned long baud;
98 };
99
100 #define to_arc_port(uport)  container_of(uport, struct arc_uart_port, port)
101
102 static struct arc_uart_port arc_uart_ports[CONFIG_SERIAL_ARC_NR_PORTS];
103
104 #ifdef CONFIG_SERIAL_ARC_CONSOLE
105 static struct console arc_console;
106 #endif
107
108 #define DRIVER_NAME     "arc-uart"
109
110 static struct uart_driver arc_uart_driver = {
111         .owner          = THIS_MODULE,
112         .driver_name    = DRIVER_NAME,
113         .dev_name       = ARC_SERIAL_DEV_NAME,
114         .major          = 0,
115         .minor          = 0,
116         .nr             = CONFIG_SERIAL_ARC_NR_PORTS,
117 #ifdef CONFIG_SERIAL_ARC_CONSOLE
118         .cons           = &arc_console,
119 #endif
120 };
121
122 static void arc_serial_stop_rx(struct uart_port *port)
123 {
124         UART_RX_IRQ_DISABLE(port);
125 }
126
127 static void arc_serial_stop_tx(struct uart_port *port)
128 {
129         while (!(UART_GET_STATUS(port) & TXEMPTY))
130                 cpu_relax();
131
132         UART_TX_IRQ_DISABLE(port);
133 }
134
135 /*
136  * Return TIOCSER_TEMT when transmitter is not busy.
137  */
138 static unsigned int arc_serial_tx_empty(struct uart_port *port)
139 {
140         unsigned int stat;
141
142         stat = UART_GET_STATUS(port);
143         if (stat & TXEMPTY)
144                 return TIOCSER_TEMT;
145
146         return 0;
147 }
148
149 /*
150  * Driver internal routine, used by both tty(serial core) as well as tx-isr
151  *  -Called under spinlock in either cases
152  *  -also tty->flow.stopped has already been checked
153  *     = by uart_start( ) before calling us
154  *     = tx_ist checks that too before calling
155  */
156 static void arc_serial_tx_chars(struct uart_port *port)
157 {
158         struct circ_buf *xmit = &port->state->xmit;
159         int sent = 0;
160         unsigned char ch;
161
162         if (unlikely(port->x_char)) {
163                 UART_SET_DATA(port, port->x_char);
164                 port->icount.tx++;
165                 port->x_char = 0;
166                 sent = 1;
167         } else if (!uart_circ_empty(xmit)) {
168                 ch = xmit->buf[xmit->tail];
169                 uart_xmit_advance(port, 1);
170                 while (!(UART_GET_STATUS(port) & TXEMPTY))
171                         cpu_relax();
172                 UART_SET_DATA(port, ch);
173                 sent = 1;
174         }
175
176         /*
177          * If num chars in xmit buffer are too few, ask tty layer for more.
178          * By Hard ISR to schedule processing in software interrupt part
179          */
180         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
181                 uart_write_wakeup(port);
182
183         if (sent)
184                 UART_TX_IRQ_ENABLE(port);
185 }
186
187 /*
188  * port is locked and interrupts are disabled
189  * uart_start( ) calls us under the port spinlock irqsave
190  */
191 static void arc_serial_start_tx(struct uart_port *port)
192 {
193         arc_serial_tx_chars(port);
194 }
195
196 static void arc_serial_rx_chars(struct uart_port *port, unsigned int status)
197 {
198         /*
199          * UART has 4 deep RX-FIFO. Driver's recongnition of this fact
200          * is very subtle. Here's how ...
201          * Upon getting a RX-Intr, such that RX-EMPTY=0, meaning data available,
202          * driver reads the DATA Reg and keeps doing that in a loop, until
203          * RX-EMPTY=1. Multiple chars being avail, with a single Interrupt,
204          * before RX-EMPTY=0, implies some sort of buffering going on in the
205          * controller, which is indeed the Rx-FIFO.
206          */
207         do {
208                 u8 ch, flg = TTY_NORMAL;
209
210                 /*
211                  * This could be an Rx Intr for err (no data),
212                  * so check err and clear that Intr first
213                  */
214                 if (status & RXOERR) {
215                         port->icount.overrun++;
216                         flg = TTY_OVERRUN;
217                         UART_CLR_STATUS(port, RXOERR);
218                 }
219
220                 if (status & RXFERR) {
221                         port->icount.frame++;
222                         flg = TTY_FRAME;
223                         UART_CLR_STATUS(port, RXFERR);
224                 }
225
226                 if (status & RXEMPTY)
227                         continue;
228
229                 ch = UART_GET_DATA(port);
230                 port->icount.rx++;
231
232                 if (!(uart_handle_sysrq_char(port, ch)))
233                         uart_insert_char(port, status, RXOERR, ch, flg);
234
235                 tty_flip_buffer_push(&port->state->port);
236         } while (!((status = UART_GET_STATUS(port)) & RXEMPTY));
237 }
238
239 /*
240  * A note on the Interrupt handling state machine of this driver
241  *
242  * kernel printk writes funnel thru the console driver framework and in order
243  * to keep things simple as well as efficient, it writes to UART in polled
244  * mode, in one shot, and exits.
245  *
246  * OTOH, Userland output (via tty layer), uses interrupt based writes as there
247  * can be undeterministic delay between char writes.
248  *
249  * Thus Rx-interrupts are always enabled, while tx-interrupts are by default
250  * disabled.
251  *
252  * When tty has some data to send out, serial core calls driver's start_tx
253  * which
254  *   -checks-if-tty-buffer-has-char-to-send
255  *   -writes-data-to-uart
256  *   -enable-tx-intr
257  *
258  * Once data bits are pushed out, controller raises the Tx-room-avail-Interrupt.
259  * The first thing Tx ISR does is disable further Tx interrupts (as this could
260  * be the last char to send, before settling down into the quiet polled mode).
261  * It then calls the exact routine used by tty layer write to send out any
262  * more char in tty buffer. In case of sending, it re-enables Tx-intr. In case
263  * of no data, it remains disabled.
264  * This is how the transmit state machine is dynamically switched on/off
265  */
266
267 static irqreturn_t arc_serial_isr(int irq, void *dev_id)
268 {
269         struct uart_port *port = dev_id;
270         unsigned int status;
271
272         status = UART_GET_STATUS(port);
273
274         /*
275          * Single IRQ for both Rx (data available) Tx (room available) Interrupt
276          * notifications from the UART Controller.
277          * To demultiplex between the two, we check the relevant bits
278          */
279         if (status & RXIENB) {
280
281                 /* already in ISR, no need of xx_irqsave */
282                 uart_port_lock(port);
283                 arc_serial_rx_chars(port, status);
284                 uart_port_unlock(port);
285         }
286
287         if ((status & TXIENB) && (status & TXEMPTY)) {
288
289                 /* Unconditionally disable further Tx-Interrupts.
290                  * will be enabled by tx_chars() if needed.
291                  */
292                 UART_TX_IRQ_DISABLE(port);
293
294                 uart_port_lock(port);
295
296                 if (!uart_tx_stopped(port))
297                         arc_serial_tx_chars(port);
298
299                 uart_port_unlock(port);
300         }
301
302         return IRQ_HANDLED;
303 }
304
305 static unsigned int arc_serial_get_mctrl(struct uart_port *port)
306 {
307         /*
308          * Pretend we have a Modem status reg and following bits are
309          *  always set, to satify the serial core state machine
310          *  (DSR) Data Set Ready
311          *  (CTS) Clear To Send
312          *  (CAR) Carrier Detect
313          */
314         return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
315 }
316
317 static void arc_serial_set_mctrl(struct uart_port *port, unsigned int mctrl)
318 {
319         /* MCR not present */
320 }
321
322 static void arc_serial_break_ctl(struct uart_port *port, int break_state)
323 {
324         /* ARC UART doesn't support sending Break signal */
325 }
326
327 static int arc_serial_startup(struct uart_port *port)
328 {
329         /* Before we hook up the ISR, Disable all UART Interrupts */
330         UART_ALL_IRQ_DISABLE(port);
331
332         if (request_irq(port->irq, arc_serial_isr, 0, "arc uart rx-tx", port)) {
333                 dev_warn(port->dev, "Unable to attach ARC UART intr\n");
334                 return -EBUSY;
335         }
336
337         UART_RX_IRQ_ENABLE(port); /* Only Rx IRQ enabled to begin with */
338
339         return 0;
340 }
341
342 /* This is not really needed */
343 static void arc_serial_shutdown(struct uart_port *port)
344 {
345         free_irq(port->irq, port);
346 }
347
348 static void
349 arc_serial_set_termios(struct uart_port *port, struct ktermios *new,
350                        const struct ktermios *old)
351 {
352         struct arc_uart_port *uart = to_arc_port(port);
353         unsigned int baud, uartl, uarth, hw_val;
354         unsigned long flags;
355
356         /*
357          * Use the generic handler so that any specially encoded baud rates
358          * such as SPD_xx flags or "%B0" can be handled
359          * Max Baud I suppose will not be more than current 115K * 4
360          * Formula for ARC UART is: hw-val = ((CLK/(BAUD*4)) -1)
361          * spread over two 8-bit registers
362          */
363         baud = uart_get_baud_rate(port, new, old, 0, 460800);
364
365         hw_val = port->uartclk / (uart->baud * 4) - 1;
366         uartl = hw_val & 0xFF;
367         uarth = (hw_val >> 8) & 0xFF;
368
369         uart_port_lock_irqsave(port, &flags);
370
371         UART_ALL_IRQ_DISABLE(port);
372
373         UART_SET_BAUDL(port, uartl);
374         UART_SET_BAUDH(port, uarth);
375
376         UART_RX_IRQ_ENABLE(port);
377
378         /*
379          * UART doesn't support Parity/Hardware Flow Control;
380          * Only supports 8N1 character size
381          */
382         new->c_cflag &= ~(CMSPAR|CRTSCTS|CSIZE);
383         new->c_cflag |= CS8;
384
385         if (old)
386                 tty_termios_copy_hw(new, old);
387
388         /* Don't rewrite B0 */
389         if (tty_termios_baud_rate(new))
390                 tty_termios_encode_baud_rate(new, baud, baud);
391
392         uart_update_timeout(port, new->c_cflag, baud);
393
394         uart_port_unlock_irqrestore(port, flags);
395 }
396
397 static const char *arc_serial_type(struct uart_port *port)
398 {
399         return port->type == PORT_ARC ? DRIVER_NAME : NULL;
400 }
401
402 static void arc_serial_release_port(struct uart_port *port)
403 {
404 }
405
406 static int arc_serial_request_port(struct uart_port *port)
407 {
408         return 0;
409 }
410
411 /*
412  * Verify the new serial_struct (for TIOCSSERIAL).
413  */
414 static int
415 arc_serial_verify_port(struct uart_port *port, struct serial_struct *ser)
416 {
417         if (port->type != PORT_UNKNOWN && ser->type != PORT_ARC)
418                 return -EINVAL;
419
420         return 0;
421 }
422
423 /*
424  * Configure/autoconfigure the port.
425  */
426 static void arc_serial_config_port(struct uart_port *port, int flags)
427 {
428         if (flags & UART_CONFIG_TYPE)
429                 port->type = PORT_ARC;
430 }
431
432 #ifdef CONFIG_CONSOLE_POLL
433
434 static void arc_serial_poll_putchar(struct uart_port *port, unsigned char chr)
435 {
436         while (!(UART_GET_STATUS(port) & TXEMPTY))
437                 cpu_relax();
438
439         UART_SET_DATA(port, chr);
440 }
441
442 static int arc_serial_poll_getchar(struct uart_port *port)
443 {
444         unsigned char chr;
445
446         while (!(UART_GET_STATUS(port) & RXEMPTY))
447                 cpu_relax();
448
449         chr = UART_GET_DATA(port);
450         return chr;
451 }
452 #endif
453
454 static const struct uart_ops arc_serial_pops = {
455         .tx_empty       = arc_serial_tx_empty,
456         .set_mctrl      = arc_serial_set_mctrl,
457         .get_mctrl      = arc_serial_get_mctrl,
458         .stop_tx        = arc_serial_stop_tx,
459         .start_tx       = arc_serial_start_tx,
460         .stop_rx        = arc_serial_stop_rx,
461         .break_ctl      = arc_serial_break_ctl,
462         .startup        = arc_serial_startup,
463         .shutdown       = arc_serial_shutdown,
464         .set_termios    = arc_serial_set_termios,
465         .type           = arc_serial_type,
466         .release_port   = arc_serial_release_port,
467         .request_port   = arc_serial_request_port,
468         .config_port    = arc_serial_config_port,
469         .verify_port    = arc_serial_verify_port,
470 #ifdef CONFIG_CONSOLE_POLL
471         .poll_put_char = arc_serial_poll_putchar,
472         .poll_get_char = arc_serial_poll_getchar,
473 #endif
474 };
475
476 #ifdef CONFIG_SERIAL_ARC_CONSOLE
477
478 static int arc_serial_console_setup(struct console *co, char *options)
479 {
480         struct uart_port *port;
481         int baud = 115200;
482         int bits = 8;
483         int parity = 'n';
484         int flow = 'n';
485
486         if (co->index < 0 || co->index >= CONFIG_SERIAL_ARC_NR_PORTS)
487                 return -ENODEV;
488
489         /*
490          * The uart port backing the console (e.g. ttyARC1) might not have been
491          * init yet. If so, defer the console setup to after the port.
492          */
493         port = &arc_uart_ports[co->index].port;
494         if (!port->membase)
495                 return -ENODEV;
496
497         if (options)
498                 uart_parse_options(options, &baud, &parity, &bits, &flow);
499
500         /*
501          * Serial core will call port->ops->set_termios( )
502          * which will set the baud reg
503          */
504         return uart_set_options(port, co, baud, parity, bits, flow);
505 }
506
507 static void arc_serial_console_putchar(struct uart_port *port, unsigned char ch)
508 {
509         while (!(UART_GET_STATUS(port) & TXEMPTY))
510                 cpu_relax();
511
512         UART_SET_DATA(port, (unsigned char)ch);
513 }
514
515 /*
516  * Interrupts are disabled on entering
517  */
518 static void arc_serial_console_write(struct console *co, const char *s,
519                                      unsigned int count)
520 {
521         struct uart_port *port = &arc_uart_ports[co->index].port;
522         unsigned long flags;
523
524         uart_port_lock_irqsave(port, &flags);
525         uart_console_write(port, s, count, arc_serial_console_putchar);
526         uart_port_unlock_irqrestore(port, flags);
527 }
528
529 static struct console arc_console = {
530         .name   = ARC_SERIAL_DEV_NAME,
531         .write  = arc_serial_console_write,
532         .device = uart_console_device,
533         .setup  = arc_serial_console_setup,
534         .flags  = CON_PRINTBUFFER,
535         .index  = -1,
536         .data   = &arc_uart_driver
537 };
538
539 static void arc_early_serial_write(struct console *con, const char *s,
540                                    unsigned int n)
541 {
542         struct earlycon_device *dev = con->data;
543
544         uart_console_write(&dev->port, s, n, arc_serial_console_putchar);
545 }
546
547 static int __init arc_early_console_setup(struct earlycon_device *dev,
548                                           const char *opt)
549 {
550         struct uart_port *port = &dev->port;
551         unsigned int l, h, hw_val;
552
553         if (!dev->port.membase)
554                 return -ENODEV;
555
556         hw_val = port->uartclk / (dev->baud * 4) - 1;
557         l = hw_val & 0xFF;
558         h = (hw_val >> 8) & 0xFF;
559
560         UART_SET_BAUDL(port, l);
561         UART_SET_BAUDH(port, h);
562
563         dev->con->write = arc_early_serial_write;
564         return 0;
565 }
566 OF_EARLYCON_DECLARE(arc_uart, "snps,arc-uart", arc_early_console_setup);
567
568 #endif  /* CONFIG_SERIAL_ARC_CONSOLE */
569
570 static int arc_serial_probe(struct platform_device *pdev)
571 {
572         struct device_node *np = pdev->dev.of_node;
573         struct arc_uart_port *uart;
574         struct uart_port *port;
575         int dev_id;
576         u32 val;
577
578         /* no device tree device */
579         if (!np)
580                 return -ENODEV;
581
582         dev_id = of_alias_get_id(np, "serial");
583         if (dev_id < 0)
584                 dev_id = 0;
585
586         if (dev_id >= ARRAY_SIZE(arc_uart_ports)) {
587                 dev_err(&pdev->dev, "serial%d out of range\n", dev_id);
588                 return -EINVAL;
589         }
590
591         uart = &arc_uart_ports[dev_id];
592         port = &uart->port;
593
594         if (of_property_read_u32(np, "clock-frequency", &val)) {
595                 dev_err(&pdev->dev, "clock-frequency property NOTset\n");
596                 return -EINVAL;
597         }
598         port->uartclk = val;
599
600         if (of_property_read_u32(np, "current-speed", &val)) {
601                 dev_err(&pdev->dev, "current-speed property NOT set\n");
602                 return -EINVAL;
603         }
604         uart->baud = val;
605
606         port->membase = devm_platform_ioremap_resource(pdev, 0);
607         if (IS_ERR(port->membase)) {
608                 /* No point of dev_err since UART itself is hosed here */
609                 return PTR_ERR(port->membase);
610         }
611
612         port->irq = irq_of_parse_and_map(np, 0);
613
614         port->dev = &pdev->dev;
615         port->iotype = UPIO_MEM;
616         port->flags = UPF_BOOT_AUTOCONF;
617         port->line = dev_id;
618         port->ops = &arc_serial_pops;
619         port->has_sysrq = IS_ENABLED(CONFIG_SERIAL_ARC_CONSOLE);
620
621         port->fifosize = ARC_UART_TX_FIFO_SIZE;
622
623         /*
624          * uart_insert_char( ) uses it in decideding whether to ignore a
625          * char or not. Explicitly setting it here, removes the subtelty
626          */
627         port->ignore_status_mask = 0;
628
629         return uart_add_one_port(&arc_uart_driver, &arc_uart_ports[dev_id].port);
630 }
631
632 static const struct of_device_id arc_uart_dt_ids[] = {
633         { .compatible = "snps,arc-uart" },
634         { /* Sentinel */ }
635 };
636 MODULE_DEVICE_TABLE(of, arc_uart_dt_ids);
637
638 static struct platform_driver arc_platform_driver = {
639         .probe = arc_serial_probe,
640         .driver = {
641                 .name = DRIVER_NAME,
642                 .of_match_table  = arc_uart_dt_ids,
643          },
644 };
645
646 static int __init arc_serial_init(void)
647 {
648         int ret;
649
650         ret = uart_register_driver(&arc_uart_driver);
651         if (ret)
652                 return ret;
653
654         ret = platform_driver_register(&arc_platform_driver);
655         if (ret)
656                 uart_unregister_driver(&arc_uart_driver);
657
658         return ret;
659 }
660
661 static void __exit arc_serial_exit(void)
662 {
663         platform_driver_unregister(&arc_platform_driver);
664         uart_unregister_driver(&arc_uart_driver);
665 }
666
667 module_init(arc_serial_init);
668 module_exit(arc_serial_exit);
669
670 MODULE_LICENSE("GPL");
671 MODULE_ALIAS("platform:" DRIVER_NAME);
672 MODULE_AUTHOR("Vineet Gupta");
673 MODULE_DESCRIPTION("ARC(Synopsys) On-Chip(fpga) serial driver");