]> Git Repo - linux.git/blob - drivers/tty/serial/arc_uart.c
arm64: avoid prototype warnings for syscalls
[linux.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         unsigned int ch, flg = 0;
199
200         /*
201          * UART has 4 deep RX-FIFO. Driver's recongnition of this fact
202          * is very subtle. Here's how ...
203          * Upon getting a RX-Intr, such that RX-EMPTY=0, meaning data available,
204          * driver reads the DATA Reg and keeps doing that in a loop, until
205          * RX-EMPTY=1. Multiple chars being avail, with a single Interrupt,
206          * before RX-EMPTY=0, implies some sort of buffering going on in the
207          * controller, which is indeed the Rx-FIFO.
208          */
209         do {
210                 /*
211                  * This could be an Rx Intr for err (no data),
212                  * so check err and clear that Intr first
213                  */
214                 if (unlikely(status & (RXOERR | RXFERR))) {
215                         if (status & RXOERR) {
216                                 port->icount.overrun++;
217                                 flg = TTY_OVERRUN;
218                                 UART_CLR_STATUS(port, RXOERR);
219                         }
220
221                         if (status & RXFERR) {
222                                 port->icount.frame++;
223                                 flg = TTY_FRAME;
224                                 UART_CLR_STATUS(port, RXFERR);
225                         }
226                 } else
227                         flg = TTY_NORMAL;
228
229                 if (status & RXEMPTY)
230                         continue;
231
232                 ch = UART_GET_DATA(port);
233                 port->icount.rx++;
234
235                 if (!(uart_handle_sysrq_char(port, ch)))
236                         uart_insert_char(port, status, RXOERR, ch, flg);
237
238                 tty_flip_buffer_push(&port->state->port);
239         } while (!((status = UART_GET_STATUS(port)) & RXEMPTY));
240 }
241
242 /*
243  * A note on the Interrupt handling state machine of this driver
244  *
245  * kernel printk writes funnel thru the console driver framework and in order
246  * to keep things simple as well as efficient, it writes to UART in polled
247  * mode, in one shot, and exits.
248  *
249  * OTOH, Userland output (via tty layer), uses interrupt based writes as there
250  * can be undeterministic delay between char writes.
251  *
252  * Thus Rx-interrupts are always enabled, while tx-interrupts are by default
253  * disabled.
254  *
255  * When tty has some data to send out, serial core calls driver's start_tx
256  * which
257  *   -checks-if-tty-buffer-has-char-to-send
258  *   -writes-data-to-uart
259  *   -enable-tx-intr
260  *
261  * Once data bits are pushed out, controller raises the Tx-room-avail-Interrupt.
262  * The first thing Tx ISR does is disable further Tx interrupts (as this could
263  * be the last char to send, before settling down into the quiet polled mode).
264  * It then calls the exact routine used by tty layer write to send out any
265  * more char in tty buffer. In case of sending, it re-enables Tx-intr. In case
266  * of no data, it remains disabled.
267  * This is how the transmit state machine is dynamically switched on/off
268  */
269
270 static irqreturn_t arc_serial_isr(int irq, void *dev_id)
271 {
272         struct uart_port *port = dev_id;
273         unsigned int status;
274
275         status = UART_GET_STATUS(port);
276
277         /*
278          * Single IRQ for both Rx (data available) Tx (room available) Interrupt
279          * notifications from the UART Controller.
280          * To demultiplex between the two, we check the relevant bits
281          */
282         if (status & RXIENB) {
283
284                 /* already in ISR, no need of xx_irqsave */
285                 spin_lock(&port->lock);
286                 arc_serial_rx_chars(port, status);
287                 spin_unlock(&port->lock);
288         }
289
290         if ((status & TXIENB) && (status & TXEMPTY)) {
291
292                 /* Unconditionally disable further Tx-Interrupts.
293                  * will be enabled by tx_chars() if needed.
294                  */
295                 UART_TX_IRQ_DISABLE(port);
296
297                 spin_lock(&port->lock);
298
299                 if (!uart_tx_stopped(port))
300                         arc_serial_tx_chars(port);
301
302                 spin_unlock(&port->lock);
303         }
304
305         return IRQ_HANDLED;
306 }
307
308 static unsigned int arc_serial_get_mctrl(struct uart_port *port)
309 {
310         /*
311          * Pretend we have a Modem status reg and following bits are
312          *  always set, to satify the serial core state machine
313          *  (DSR) Data Set Ready
314          *  (CTS) Clear To Send
315          *  (CAR) Carrier Detect
316          */
317         return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
318 }
319
320 static void arc_serial_set_mctrl(struct uart_port *port, unsigned int mctrl)
321 {
322         /* MCR not present */
323 }
324
325 static void arc_serial_break_ctl(struct uart_port *port, int break_state)
326 {
327         /* ARC UART doesn't support sending Break signal */
328 }
329
330 static int arc_serial_startup(struct uart_port *port)
331 {
332         /* Before we hook up the ISR, Disable all UART Interrupts */
333         UART_ALL_IRQ_DISABLE(port);
334
335         if (request_irq(port->irq, arc_serial_isr, 0, "arc uart rx-tx", port)) {
336                 dev_warn(port->dev, "Unable to attach ARC UART intr\n");
337                 return -EBUSY;
338         }
339
340         UART_RX_IRQ_ENABLE(port); /* Only Rx IRQ enabled to begin with */
341
342         return 0;
343 }
344
345 /* This is not really needed */
346 static void arc_serial_shutdown(struct uart_port *port)
347 {
348         free_irq(port->irq, port);
349 }
350
351 static void
352 arc_serial_set_termios(struct uart_port *port, struct ktermios *new,
353                        const struct ktermios *old)
354 {
355         struct arc_uart_port *uart = to_arc_port(port);
356         unsigned int baud, uartl, uarth, hw_val;
357         unsigned long flags;
358
359         /*
360          * Use the generic handler so that any specially encoded baud rates
361          * such as SPD_xx flags or "%B0" can be handled
362          * Max Baud I suppose will not be more than current 115K * 4
363          * Formula for ARC UART is: hw-val = ((CLK/(BAUD*4)) -1)
364          * spread over two 8-bit registers
365          */
366         baud = uart_get_baud_rate(port, new, old, 0, 460800);
367
368         hw_val = port->uartclk / (uart->baud * 4) - 1;
369         uartl = hw_val & 0xFF;
370         uarth = (hw_val >> 8) & 0xFF;
371
372         spin_lock_irqsave(&port->lock, flags);
373
374         UART_ALL_IRQ_DISABLE(port);
375
376         UART_SET_BAUDL(port, uartl);
377         UART_SET_BAUDH(port, uarth);
378
379         UART_RX_IRQ_ENABLE(port);
380
381         /*
382          * UART doesn't support Parity/Hardware Flow Control;
383          * Only supports 8N1 character size
384          */
385         new->c_cflag &= ~(CMSPAR|CRTSCTS|CSIZE);
386         new->c_cflag |= CS8;
387
388         if (old)
389                 tty_termios_copy_hw(new, old);
390
391         /* Don't rewrite B0 */
392         if (tty_termios_baud_rate(new))
393                 tty_termios_encode_baud_rate(new, baud, baud);
394
395         uart_update_timeout(port, new->c_cflag, baud);
396
397         spin_unlock_irqrestore(&port->lock, flags);
398 }
399
400 static const char *arc_serial_type(struct uart_port *port)
401 {
402         return port->type == PORT_ARC ? DRIVER_NAME : NULL;
403 }
404
405 static void arc_serial_release_port(struct uart_port *port)
406 {
407 }
408
409 static int arc_serial_request_port(struct uart_port *port)
410 {
411         return 0;
412 }
413
414 /*
415  * Verify the new serial_struct (for TIOCSSERIAL).
416  */
417 static int
418 arc_serial_verify_port(struct uart_port *port, struct serial_struct *ser)
419 {
420         if (port->type != PORT_UNKNOWN && ser->type != PORT_ARC)
421                 return -EINVAL;
422
423         return 0;
424 }
425
426 /*
427  * Configure/autoconfigure the port.
428  */
429 static void arc_serial_config_port(struct uart_port *port, int flags)
430 {
431         if (flags & UART_CONFIG_TYPE)
432                 port->type = PORT_ARC;
433 }
434
435 #ifdef CONFIG_CONSOLE_POLL
436
437 static void arc_serial_poll_putchar(struct uart_port *port, unsigned char chr)
438 {
439         while (!(UART_GET_STATUS(port) & TXEMPTY))
440                 cpu_relax();
441
442         UART_SET_DATA(port, chr);
443 }
444
445 static int arc_serial_poll_getchar(struct uart_port *port)
446 {
447         unsigned char chr;
448
449         while (!(UART_GET_STATUS(port) & RXEMPTY))
450                 cpu_relax();
451
452         chr = UART_GET_DATA(port);
453         return chr;
454 }
455 #endif
456
457 static const struct uart_ops arc_serial_pops = {
458         .tx_empty       = arc_serial_tx_empty,
459         .set_mctrl      = arc_serial_set_mctrl,
460         .get_mctrl      = arc_serial_get_mctrl,
461         .stop_tx        = arc_serial_stop_tx,
462         .start_tx       = arc_serial_start_tx,
463         .stop_rx        = arc_serial_stop_rx,
464         .break_ctl      = arc_serial_break_ctl,
465         .startup        = arc_serial_startup,
466         .shutdown       = arc_serial_shutdown,
467         .set_termios    = arc_serial_set_termios,
468         .type           = arc_serial_type,
469         .release_port   = arc_serial_release_port,
470         .request_port   = arc_serial_request_port,
471         .config_port    = arc_serial_config_port,
472         .verify_port    = arc_serial_verify_port,
473 #ifdef CONFIG_CONSOLE_POLL
474         .poll_put_char = arc_serial_poll_putchar,
475         .poll_get_char = arc_serial_poll_getchar,
476 #endif
477 };
478
479 #ifdef CONFIG_SERIAL_ARC_CONSOLE
480
481 static int arc_serial_console_setup(struct console *co, char *options)
482 {
483         struct uart_port *port;
484         int baud = 115200;
485         int bits = 8;
486         int parity = 'n';
487         int flow = 'n';
488
489         if (co->index < 0 || co->index >= CONFIG_SERIAL_ARC_NR_PORTS)
490                 return -ENODEV;
491
492         /*
493          * The uart port backing the console (e.g. ttyARC1) might not have been
494          * init yet. If so, defer the console setup to after the port.
495          */
496         port = &arc_uart_ports[co->index].port;
497         if (!port->membase)
498                 return -ENODEV;
499
500         if (options)
501                 uart_parse_options(options, &baud, &parity, &bits, &flow);
502
503         /*
504          * Serial core will call port->ops->set_termios( )
505          * which will set the baud reg
506          */
507         return uart_set_options(port, co, baud, parity, bits, flow);
508 }
509
510 static void arc_serial_console_putchar(struct uart_port *port, unsigned char ch)
511 {
512         while (!(UART_GET_STATUS(port) & TXEMPTY))
513                 cpu_relax();
514
515         UART_SET_DATA(port, (unsigned char)ch);
516 }
517
518 /*
519  * Interrupts are disabled on entering
520  */
521 static void arc_serial_console_write(struct console *co, const char *s,
522                                      unsigned int count)
523 {
524         struct uart_port *port = &arc_uart_ports[co->index].port;
525         unsigned long flags;
526
527         spin_lock_irqsave(&port->lock, flags);
528         uart_console_write(port, s, count, arc_serial_console_putchar);
529         spin_unlock_irqrestore(&port->lock, flags);
530 }
531
532 static struct console arc_console = {
533         .name   = ARC_SERIAL_DEV_NAME,
534         .write  = arc_serial_console_write,
535         .device = uart_console_device,
536         .setup  = arc_serial_console_setup,
537         .flags  = CON_PRINTBUFFER,
538         .index  = -1,
539         .data   = &arc_uart_driver
540 };
541
542 static void arc_early_serial_write(struct console *con, const char *s,
543                                    unsigned int n)
544 {
545         struct earlycon_device *dev = con->data;
546
547         uart_console_write(&dev->port, s, n, arc_serial_console_putchar);
548 }
549
550 static int __init arc_early_console_setup(struct earlycon_device *dev,
551                                           const char *opt)
552 {
553         struct uart_port *port = &dev->port;
554         unsigned int l, h, hw_val;
555
556         if (!dev->port.membase)
557                 return -ENODEV;
558
559         hw_val = port->uartclk / (dev->baud * 4) - 1;
560         l = hw_val & 0xFF;
561         h = (hw_val >> 8) & 0xFF;
562
563         UART_SET_BAUDL(port, l);
564         UART_SET_BAUDH(port, h);
565
566         dev->con->write = arc_early_serial_write;
567         return 0;
568 }
569 OF_EARLYCON_DECLARE(arc_uart, "snps,arc-uart", arc_early_console_setup);
570
571 #endif  /* CONFIG_SERIAL_ARC_CONSOLE */
572
573 static int arc_serial_probe(struct platform_device *pdev)
574 {
575         struct device_node *np = pdev->dev.of_node;
576         struct arc_uart_port *uart;
577         struct uart_port *port;
578         int dev_id;
579         u32 val;
580
581         /* no device tree device */
582         if (!np)
583                 return -ENODEV;
584
585         dev_id = of_alias_get_id(np, "serial");
586         if (dev_id < 0)
587                 dev_id = 0;
588
589         if (dev_id >= ARRAY_SIZE(arc_uart_ports)) {
590                 dev_err(&pdev->dev, "serial%d out of range\n", dev_id);
591                 return -EINVAL;
592         }
593
594         uart = &arc_uart_ports[dev_id];
595         port = &uart->port;
596
597         if (of_property_read_u32(np, "clock-frequency", &val)) {
598                 dev_err(&pdev->dev, "clock-frequency property NOTset\n");
599                 return -EINVAL;
600         }
601         port->uartclk = val;
602
603         if (of_property_read_u32(np, "current-speed", &val)) {
604                 dev_err(&pdev->dev, "current-speed property NOT set\n");
605                 return -EINVAL;
606         }
607         uart->baud = val;
608
609         port->membase = devm_platform_ioremap_resource(pdev, 0);
610         if (IS_ERR(port->membase)) {
611                 /* No point of dev_err since UART itself is hosed here */
612                 return PTR_ERR(port->membase);
613         }
614
615         port->irq = irq_of_parse_and_map(np, 0);
616
617         port->dev = &pdev->dev;
618         port->iotype = UPIO_MEM;
619         port->flags = UPF_BOOT_AUTOCONF;
620         port->line = dev_id;
621         port->ops = &arc_serial_pops;
622         port->has_sysrq = IS_ENABLED(CONFIG_SERIAL_ARC_CONSOLE);
623
624         port->fifosize = ARC_UART_TX_FIFO_SIZE;
625
626         /*
627          * uart_insert_char( ) uses it in decideding whether to ignore a
628          * char or not. Explicitly setting it here, removes the subtelty
629          */
630         port->ignore_status_mask = 0;
631
632         return uart_add_one_port(&arc_uart_driver, &arc_uart_ports[dev_id].port);
633 }
634
635 static const struct of_device_id arc_uart_dt_ids[] = {
636         { .compatible = "snps,arc-uart" },
637         { /* Sentinel */ }
638 };
639 MODULE_DEVICE_TABLE(of, arc_uart_dt_ids);
640
641 static struct platform_driver arc_platform_driver = {
642         .probe = arc_serial_probe,
643         .driver = {
644                 .name = DRIVER_NAME,
645                 .of_match_table  = arc_uart_dt_ids,
646          },
647 };
648
649 static int __init arc_serial_init(void)
650 {
651         int ret;
652
653         ret = uart_register_driver(&arc_uart_driver);
654         if (ret)
655                 return ret;
656
657         ret = platform_driver_register(&arc_platform_driver);
658         if (ret)
659                 uart_unregister_driver(&arc_uart_driver);
660
661         return ret;
662 }
663
664 static void __exit arc_serial_exit(void)
665 {
666         platform_driver_unregister(&arc_platform_driver);
667         uart_unregister_driver(&arc_uart_driver);
668 }
669
670 module_init(arc_serial_init);
671 module_exit(arc_serial_exit);
672
673 MODULE_LICENSE("GPL");
674 MODULE_ALIAS("platform:" DRIVER_NAME);
675 MODULE_AUTHOR("Vineet Gupta");
676 MODULE_DESCRIPTION("ARC(Synopsys) On-Chip(fpga) serial driver");
This page took 0.070762 seconds and 4 git commands to generate.