2 * Copyright (C) 2010 Alexey Charkov <alchark@gmail.com>
4 * Based on msm_serial.c, which is:
5 * Copyright (C) 2007 Google, Inc.
6 * Author: Robert Love <rlove@google.com>
8 * This software is licensed under the terms of the GNU General Public
9 * License version 2, as published by the Free Software Foundation, and
10 * may be copied, distributed, and modified under those terms.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #if defined(CONFIG_SERIAL_VT8500_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
19 # define SUPPORT_SYSRQ
22 #include <linux/hrtimer.h>
23 #include <linux/delay.h>
25 #include <linux/ioport.h>
26 #include <linux/irq.h>
27 #include <linux/init.h>
28 #include <linux/console.h>
29 #include <linux/tty.h>
30 #include <linux/tty_flip.h>
31 #include <linux/serial_core.h>
32 #include <linux/serial.h>
33 #include <linux/slab.h>
34 #include <linux/clk.h>
36 #include <linux/of_device.h>
37 #include <linux/err.h>
40 * UART Register offsets
43 #define VT8500_URTDR 0x0000 /* Transmit data */
44 #define VT8500_URRDR 0x0004 /* Receive data */
45 #define VT8500_URDIV 0x0008 /* Clock/Baud rate divisor */
46 #define VT8500_URLCR 0x000C /* Line control */
47 #define VT8500_URICR 0x0010 /* IrDA control */
48 #define VT8500_URIER 0x0014 /* Interrupt enable */
49 #define VT8500_URISR 0x0018 /* Interrupt status */
50 #define VT8500_URUSR 0x001c /* UART status */
51 #define VT8500_URFCR 0x0020 /* FIFO control */
52 #define VT8500_URFIDX 0x0024 /* FIFO index */
53 #define VT8500_URBKR 0x0028 /* Break signal count */
54 #define VT8500_URTOD 0x002c /* Time out divisor */
55 #define VT8500_TXFIFO 0x1000 /* Transmit FIFO (16x8) */
56 #define VT8500_RXFIFO 0x1020 /* Receive FIFO (16x10) */
59 * Interrupt enable and status bits
62 #define TXDE (1 << 0) /* Tx Data empty */
63 #define RXDF (1 << 1) /* Rx Data full */
64 #define TXFAE (1 << 2) /* Tx FIFO almost empty */
65 #define TXFE (1 << 3) /* Tx FIFO empty */
66 #define RXFAF (1 << 4) /* Rx FIFO almost full */
67 #define RXFF (1 << 5) /* Rx FIFO full */
68 #define TXUDR (1 << 6) /* Tx underrun */
69 #define RXOVER (1 << 7) /* Rx overrun */
70 #define PER (1 << 8) /* Parity error */
71 #define FER (1 << 9) /* Frame error */
72 #define TCTS (1 << 10) /* Toggle of CTS */
73 #define RXTOUT (1 << 11) /* Rx timeout */
74 #define BKDONE (1 << 12) /* Break signal done */
75 #define ERR (1 << 13) /* AHB error response */
77 #define RX_FIFO_INTS (RXFAF | RXFF | RXOVER | PER | FER | RXTOUT)
78 #define TX_FIFO_INTS (TXFAE | TXFE | TXUDR)
84 #define VT8500_TXEN (1 << 0) /* Enable transmit logic */
85 #define VT8500_RXEN (1 << 1) /* Enable receive logic */
86 #define VT8500_CS8 (1 << 2) /* 8-bit data length (vs. 7-bit) */
87 #define VT8500_CSTOPB (1 << 3) /* 2 stop bits (vs. 1) */
88 #define VT8500_PARENB (1 << 4) /* Enable parity */
89 #define VT8500_PARODD (1 << 5) /* Odd parity (vs. even) */
90 #define VT8500_RTS (1 << 6) /* Ready to send */
91 #define VT8500_LOOPBK (1 << 7) /* Enable internal loopback */
92 #define VT8500_DMA (1 << 8) /* Enable DMA mode (needs FIFO) */
93 #define VT8500_BREAK (1 << 9) /* Initiate break signal */
94 #define VT8500_PSLVERR (1 << 10) /* APB error upon empty RX FIFO read */
95 #define VT8500_SWRTSCTS (1 << 11) /* Software-controlled RTS/CTS */
98 * Capability flags (driver-internal)
101 #define VT8500_HAS_SWRTSCTS_SWITCH (1 << 1)
103 #define VT8500_RECOMMENDED_CLK 12000000
104 #define VT8500_OVERSAMPLING_DIVISOR 13
105 #define VT8500_MAX_PORTS 6
108 struct uart_port uart;
111 unsigned int clk_predivisor;
113 unsigned int vt8500_uart_flags;
117 * we use this variable to keep track of which ports
118 * have been allocated as we can't use pdev->id in
121 static DECLARE_BITMAP(vt8500_ports_in_use, VT8500_MAX_PORTS);
123 static inline void vt8500_write(struct uart_port *port, unsigned int val,
126 writel(val, port->membase + off);
129 static inline unsigned int vt8500_read(struct uart_port *port, unsigned int off)
131 return readl(port->membase + off);
134 static void vt8500_stop_tx(struct uart_port *port)
136 struct vt8500_port *vt8500_port = container_of(port,
140 vt8500_port->ier &= ~TX_FIFO_INTS;
141 vt8500_write(port, vt8500_port->ier, VT8500_URIER);
144 static void vt8500_stop_rx(struct uart_port *port)
146 struct vt8500_port *vt8500_port = container_of(port,
150 vt8500_port->ier &= ~RX_FIFO_INTS;
151 vt8500_write(port, vt8500_port->ier, VT8500_URIER);
154 static void vt8500_enable_ms(struct uart_port *port)
156 struct vt8500_port *vt8500_port = container_of(port,
160 vt8500_port->ier |= TCTS;
161 vt8500_write(port, vt8500_port->ier, VT8500_URIER);
164 static void handle_rx(struct uart_port *port)
166 struct tty_port *tport = &port->state->port;
171 if ((vt8500_read(port, VT8500_URISR) & RXOVER)) {
172 port->icount.overrun++;
173 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
176 /* and now the main RX loop */
177 while (vt8500_read(port, VT8500_URFIDX) & 0x1f00) {
179 char flag = TTY_NORMAL;
181 c = readw(port->membase + VT8500_RXFIFO) & 0x3ff;
183 /* Mask conditions we're ignorning. */
184 c &= ~port->read_status_mask;
187 port->icount.frame++;
189 } else if (c & PER) {
190 port->icount.parity++;
195 if (!uart_handle_sysrq_char(port, c))
196 tty_insert_flip_char(tport, c, flag);
199 spin_unlock(&port->lock);
200 tty_flip_buffer_push(tport);
201 spin_lock(&port->lock);
204 static void handle_tx(struct uart_port *port)
206 struct circ_buf *xmit = &port->state->xmit;
209 writeb(port->x_char, port->membase + VT8500_TXFIFO);
213 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
214 vt8500_stop_tx(port);
218 while ((vt8500_read(port, VT8500_URFIDX) & 0x1f) < 16) {
219 if (uart_circ_empty(xmit))
222 writeb(xmit->buf[xmit->tail], port->membase + VT8500_TXFIFO);
224 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
228 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
229 uart_write_wakeup(port);
231 if (uart_circ_empty(xmit))
232 vt8500_stop_tx(port);
235 static void vt8500_start_tx(struct uart_port *port)
237 struct vt8500_port *vt8500_port = container_of(port,
241 vt8500_port->ier &= ~TX_FIFO_INTS;
242 vt8500_write(port, vt8500_port->ier, VT8500_URIER);
244 vt8500_port->ier |= TX_FIFO_INTS;
245 vt8500_write(port, vt8500_port->ier, VT8500_URIER);
248 static void handle_delta_cts(struct uart_port *port)
251 wake_up_interruptible(&port->state->port.delta_msr_wait);
254 static irqreturn_t vt8500_irq(int irq, void *dev_id)
256 struct uart_port *port = dev_id;
259 spin_lock(&port->lock);
260 isr = vt8500_read(port, VT8500_URISR);
262 /* Acknowledge active status bits */
263 vt8500_write(port, isr, VT8500_URISR);
265 if (isr & RX_FIFO_INTS)
267 if (isr & TX_FIFO_INTS)
270 handle_delta_cts(port);
272 spin_unlock(&port->lock);
277 static unsigned int vt8500_tx_empty(struct uart_port *port)
279 return (vt8500_read(port, VT8500_URFIDX) & 0x1f) < 16 ?
283 static unsigned int vt8500_get_mctrl(struct uart_port *port)
287 usr = vt8500_read(port, VT8500_URUSR);
294 static void vt8500_set_mctrl(struct uart_port *port, unsigned int mctrl)
296 unsigned int lcr = vt8500_read(port, VT8500_URLCR);
298 if (mctrl & TIOCM_RTS)
303 vt8500_write(port, lcr, VT8500_URLCR);
306 static void vt8500_break_ctl(struct uart_port *port, int break_ctl)
310 vt8500_read(port, VT8500_URLCR) | VT8500_BREAK,
314 static int vt8500_set_baud_rate(struct uart_port *port, unsigned int baud)
316 struct vt8500_port *vt8500_port =
317 container_of(port, struct vt8500_port, uart);
319 unsigned int loops = 1000;
321 div = ((vt8500_port->clk_predivisor - 1) & 0xf) << 16;
322 div |= (uart_get_divisor(port, baud) - 1) & 0x3ff;
324 /* Effective baud rate */
325 baud = port->uartclk / 16 / ((div & 0x3ff) + 1);
327 while ((vt8500_read(port, VT8500_URUSR) & (1 << 5)) && --loops)
330 vt8500_write(port, div, VT8500_URDIV);
332 /* Break signal timing depends on baud rate, update accordingly */
333 vt8500_write(port, mult_frac(baud, 4096, 1000000), VT8500_URBKR);
338 static int vt8500_startup(struct uart_port *port)
340 struct vt8500_port *vt8500_port =
341 container_of(port, struct vt8500_port, uart);
344 snprintf(vt8500_port->name, sizeof(vt8500_port->name),
345 "vt8500_serial%d", port->line);
347 ret = request_irq(port->irq, vt8500_irq, IRQF_TRIGGER_HIGH,
348 vt8500_port->name, port);
352 vt8500_write(port, 0x03, VT8500_URLCR); /* enable TX & RX */
357 static void vt8500_shutdown(struct uart_port *port)
359 struct vt8500_port *vt8500_port =
360 container_of(port, struct vt8500_port, uart);
362 vt8500_port->ier = 0;
364 /* disable interrupts and FIFOs */
365 vt8500_write(&vt8500_port->uart, 0, VT8500_URIER);
366 vt8500_write(&vt8500_port->uart, 0x880, VT8500_URFCR);
367 free_irq(port->irq, port);
370 static void vt8500_set_termios(struct uart_port *port,
371 struct ktermios *termios,
372 struct ktermios *old)
374 struct vt8500_port *vt8500_port =
375 container_of(port, struct vt8500_port, uart);
377 unsigned int baud, lcr;
378 unsigned int loops = 1000;
380 spin_lock_irqsave(&port->lock, flags);
382 /* calculate and set baud rate */
383 baud = uart_get_baud_rate(port, termios, old, 900, 921600);
384 baud = vt8500_set_baud_rate(port, baud);
385 if (tty_termios_baud_rate(termios))
386 tty_termios_encode_baud_rate(termios, baud, baud);
388 /* calculate parity */
389 lcr = vt8500_read(&vt8500_port->uart, VT8500_URLCR);
390 lcr &= ~(VT8500_PARENB | VT8500_PARODD);
391 if (termios->c_cflag & PARENB) {
392 lcr |= VT8500_PARENB;
393 termios->c_cflag &= ~CMSPAR;
394 if (termios->c_cflag & PARODD)
395 lcr |= VT8500_PARODD;
398 /* calculate bits per char */
400 switch (termios->c_cflag & CSIZE) {
406 termios->c_cflag &= ~CSIZE;
407 termios->c_cflag |= CS8;
411 /* calculate stop bits */
412 lcr &= ~VT8500_CSTOPB;
413 if (termios->c_cflag & CSTOPB)
414 lcr |= VT8500_CSTOPB;
416 lcr &= ~VT8500_SWRTSCTS;
417 if (vt8500_port->vt8500_uart_flags & VT8500_HAS_SWRTSCTS_SWITCH)
418 lcr |= VT8500_SWRTSCTS;
420 /* set parity, bits per char, and stop bit */
421 vt8500_write(&vt8500_port->uart, lcr, VT8500_URLCR);
423 /* Configure status bits to ignore based on termio flags. */
424 port->read_status_mask = 0;
425 if (termios->c_iflag & IGNPAR)
426 port->read_status_mask = FER | PER;
428 uart_update_timeout(port, termios->c_cflag, baud);
431 vt8500_write(&vt8500_port->uart, 0x88c, VT8500_URFCR);
432 while ((vt8500_read(&vt8500_port->uart, VT8500_URFCR) & 0xc)
436 /* Every possible FIFO-related interrupt */
437 vt8500_port->ier = RX_FIFO_INTS | TX_FIFO_INTS;
442 if (UART_ENABLE_MS(&vt8500_port->uart, termios->c_cflag))
443 vt8500_port->ier |= TCTS;
445 vt8500_write(&vt8500_port->uart, 0x881, VT8500_URFCR);
446 vt8500_write(&vt8500_port->uart, vt8500_port->ier, VT8500_URIER);
448 spin_unlock_irqrestore(&port->lock, flags);
451 static const char *vt8500_type(struct uart_port *port)
453 struct vt8500_port *vt8500_port =
454 container_of(port, struct vt8500_port, uart);
455 return vt8500_port->name;
458 static void vt8500_release_port(struct uart_port *port)
462 static int vt8500_request_port(struct uart_port *port)
467 static void vt8500_config_port(struct uart_port *port, int flags)
469 port->type = PORT_VT8500;
472 static int vt8500_verify_port(struct uart_port *port,
473 struct serial_struct *ser)
475 if (unlikely(ser->type != PORT_UNKNOWN && ser->type != PORT_VT8500))
477 if (unlikely(port->irq != ser->irq))
482 static struct vt8500_port *vt8500_uart_ports[VT8500_MAX_PORTS];
483 static struct uart_driver vt8500_uart_driver;
485 #ifdef CONFIG_SERIAL_VT8500_CONSOLE
487 static void wait_for_xmitr(struct uart_port *port)
489 unsigned int status, tmout = 10000;
491 /* Wait up to 10ms for the character(s) to be sent. */
493 status = vt8500_read(port, VT8500_URFIDX);
498 } while (status & 0x10);
501 static void vt8500_console_putchar(struct uart_port *port, int c)
503 wait_for_xmitr(port);
504 writeb(c, port->membase + VT8500_TXFIFO);
507 static void vt8500_console_write(struct console *co, const char *s,
510 struct vt8500_port *vt8500_port = vt8500_uart_ports[co->index];
513 BUG_ON(co->index < 0 || co->index >= vt8500_uart_driver.nr);
515 ier = vt8500_read(&vt8500_port->uart, VT8500_URIER);
516 vt8500_write(&vt8500_port->uart, VT8500_URIER, 0);
518 uart_console_write(&vt8500_port->uart, s, count,
519 vt8500_console_putchar);
522 * Finally, wait for transmitter to become empty
523 * and switch back to FIFO
525 wait_for_xmitr(&vt8500_port->uart);
526 vt8500_write(&vt8500_port->uart, VT8500_URIER, ier);
529 static int __init vt8500_console_setup(struct console *co, char *options)
531 struct vt8500_port *vt8500_port;
537 if (unlikely(co->index >= vt8500_uart_driver.nr || co->index < 0))
540 vt8500_port = vt8500_uart_ports[co->index];
546 uart_parse_options(options, &baud, &parity, &bits, &flow);
548 return uart_set_options(&vt8500_port->uart,
549 co, baud, parity, bits, flow);
552 static struct console vt8500_console = {
554 .write = vt8500_console_write,
555 .device = uart_console_device,
556 .setup = vt8500_console_setup,
557 .flags = CON_PRINTBUFFER,
559 .data = &vt8500_uart_driver,
562 #define VT8500_CONSOLE (&vt8500_console)
565 #define VT8500_CONSOLE NULL
568 #ifdef CONFIG_CONSOLE_POLL
569 static int vt8500_get_poll_char(struct uart_port *port)
571 unsigned int status = vt8500_read(port, VT8500_URFIDX);
573 if (!(status & 0x1f00))
576 return vt8500_read(port, VT8500_RXFIFO) & 0xff;
579 static void vt8500_put_poll_char(struct uart_port *port, unsigned char c)
581 unsigned int status, tmout = 10000;
584 status = vt8500_read(port, VT8500_URFIDX);
589 } while (status & 0x10);
591 vt8500_write(port, c, VT8500_TXFIFO);
595 static struct uart_ops vt8500_uart_pops = {
596 .tx_empty = vt8500_tx_empty,
597 .set_mctrl = vt8500_set_mctrl,
598 .get_mctrl = vt8500_get_mctrl,
599 .stop_tx = vt8500_stop_tx,
600 .start_tx = vt8500_start_tx,
601 .stop_rx = vt8500_stop_rx,
602 .enable_ms = vt8500_enable_ms,
603 .break_ctl = vt8500_break_ctl,
604 .startup = vt8500_startup,
605 .shutdown = vt8500_shutdown,
606 .set_termios = vt8500_set_termios,
608 .release_port = vt8500_release_port,
609 .request_port = vt8500_request_port,
610 .config_port = vt8500_config_port,
611 .verify_port = vt8500_verify_port,
612 #ifdef CONFIG_CONSOLE_POLL
613 .poll_get_char = vt8500_get_poll_char,
614 .poll_put_char = vt8500_put_poll_char,
618 static struct uart_driver vt8500_uart_driver = {
619 .owner = THIS_MODULE,
620 .driver_name = "vt8500_serial",
621 .dev_name = "ttyWMT",
623 .cons = VT8500_CONSOLE,
626 static unsigned int vt8500_flags; /* none required so far */
627 static unsigned int wm8880_flags = VT8500_HAS_SWRTSCTS_SWITCH;
629 static const struct of_device_id wmt_dt_ids[] = {
630 { .compatible = "via,vt8500-uart", .data = &vt8500_flags},
631 { .compatible = "wm,wm8880-uart", .data = &wm8880_flags},
635 static int vt8500_serial_probe(struct platform_device *pdev)
637 struct vt8500_port *vt8500_port;
638 struct resource *mmres, *irqres;
639 struct device_node *np = pdev->dev.of_node;
640 const struct of_device_id *match;
641 const unsigned int *flags;
645 match = of_match_device(wmt_dt_ids, &pdev->dev);
651 mmres = platform_get_resource(pdev, IORESOURCE_MEM, 0);
652 irqres = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
653 if (!mmres || !irqres)
657 port = of_alias_get_id(np, "serial");
658 if (port >= VT8500_MAX_PORTS)
665 /* calculate the port id */
666 port = find_first_zero_bit(vt8500_ports_in_use,
670 if (port >= VT8500_MAX_PORTS)
673 /* reserve the port id */
674 if (test_and_set_bit(port, vt8500_ports_in_use)) {
675 /* port already in use - shouldn't really happen */
679 vt8500_port = devm_kzalloc(&pdev->dev, sizeof(struct vt8500_port),
684 vt8500_port->uart.membase = devm_ioremap_resource(&pdev->dev, mmres);
685 if (IS_ERR(vt8500_port->uart.membase))
686 return PTR_ERR(vt8500_port->uart.membase);
688 vt8500_port->clk = of_clk_get(pdev->dev.of_node, 0);
689 if (IS_ERR(vt8500_port->clk)) {
690 dev_err(&pdev->dev, "failed to get clock\n");
694 ret = clk_prepare_enable(vt8500_port->clk);
696 dev_err(&pdev->dev, "failed to enable clock\n");
700 vt8500_port->vt8500_uart_flags = *flags;
701 vt8500_port->clk_predivisor = DIV_ROUND_CLOSEST(
702 clk_get_rate(vt8500_port->clk),
703 VT8500_RECOMMENDED_CLK
705 vt8500_port->uart.type = PORT_VT8500;
706 vt8500_port->uart.iotype = UPIO_MEM;
707 vt8500_port->uart.mapbase = mmres->start;
708 vt8500_port->uart.irq = irqres->start;
709 vt8500_port->uart.fifosize = 16;
710 vt8500_port->uart.ops = &vt8500_uart_pops;
711 vt8500_port->uart.line = port;
712 vt8500_port->uart.dev = &pdev->dev;
713 vt8500_port->uart.flags = UPF_IOREMAP | UPF_BOOT_AUTOCONF;
715 /* Serial core uses the magic "16" everywhere - adjust for it */
716 vt8500_port->uart.uartclk = 16 * clk_get_rate(vt8500_port->clk) /
717 vt8500_port->clk_predivisor /
718 VT8500_OVERSAMPLING_DIVISOR;
720 snprintf(vt8500_port->name, sizeof(vt8500_port->name),
721 "VT8500 UART%d", pdev->id);
723 vt8500_uart_ports[port] = vt8500_port;
725 uart_add_one_port(&vt8500_uart_driver, &vt8500_port->uart);
727 platform_set_drvdata(pdev, vt8500_port);
732 static struct platform_driver vt8500_platform_driver = {
733 .probe = vt8500_serial_probe,
735 .name = "vt8500_serial",
736 .of_match_table = wmt_dt_ids,
737 .suppress_bind_attrs = true,
741 static int __init vt8500_serial_init(void)
745 ret = uart_register_driver(&vt8500_uart_driver);
749 ret = platform_driver_register(&vt8500_platform_driver);
752 uart_unregister_driver(&vt8500_uart_driver);
756 device_initcall(vt8500_serial_init);