1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2010 Alexey Charkov <alchark@gmail.com>
5 * Based on msm_serial.c, which is:
6 * Copyright (C) 2007 Google, Inc.
7 * Author: Robert Love <rlove@google.com>
10 #include <linux/hrtimer.h>
11 #include <linux/delay.h>
13 #include <linux/ioport.h>
14 #include <linux/irq.h>
15 #include <linux/init.h>
16 #include <linux/console.h>
17 #include <linux/tty.h>
18 #include <linux/tty_flip.h>
19 #include <linux/serial_core.h>
20 #include <linux/serial.h>
21 #include <linux/slab.h>
22 #include <linux/clk.h>
24 #include <linux/of_device.h>
25 #include <linux/err.h>
28 * UART Register offsets
31 #define VT8500_URTDR 0x0000 /* Transmit data */
32 #define VT8500_URRDR 0x0004 /* Receive data */
33 #define VT8500_URDIV 0x0008 /* Clock/Baud rate divisor */
34 #define VT8500_URLCR 0x000C /* Line control */
35 #define VT8500_URICR 0x0010 /* IrDA control */
36 #define VT8500_URIER 0x0014 /* Interrupt enable */
37 #define VT8500_URISR 0x0018 /* Interrupt status */
38 #define VT8500_URUSR 0x001c /* UART status */
39 #define VT8500_URFCR 0x0020 /* FIFO control */
40 #define VT8500_URFIDX 0x0024 /* FIFO index */
41 #define VT8500_URBKR 0x0028 /* Break signal count */
42 #define VT8500_URTOD 0x002c /* Time out divisor */
43 #define VT8500_TXFIFO 0x1000 /* Transmit FIFO (16x8) */
44 #define VT8500_RXFIFO 0x1020 /* Receive FIFO (16x10) */
47 * Interrupt enable and status bits
50 #define TXDE (1 << 0) /* Tx Data empty */
51 #define RXDF (1 << 1) /* Rx Data full */
52 #define TXFAE (1 << 2) /* Tx FIFO almost empty */
53 #define TXFE (1 << 3) /* Tx FIFO empty */
54 #define RXFAF (1 << 4) /* Rx FIFO almost full */
55 #define RXFF (1 << 5) /* Rx FIFO full */
56 #define TXUDR (1 << 6) /* Tx underrun */
57 #define RXOVER (1 << 7) /* Rx overrun */
58 #define PER (1 << 8) /* Parity error */
59 #define FER (1 << 9) /* Frame error */
60 #define TCTS (1 << 10) /* Toggle of CTS */
61 #define RXTOUT (1 << 11) /* Rx timeout */
62 #define BKDONE (1 << 12) /* Break signal done */
63 #define ERR (1 << 13) /* AHB error response */
65 #define RX_FIFO_INTS (RXFAF | RXFF | RXOVER | PER | FER | RXTOUT)
66 #define TX_FIFO_INTS (TXFAE | TXFE | TXUDR)
72 #define VT8500_TXEN (1 << 0) /* Enable transmit logic */
73 #define VT8500_RXEN (1 << 1) /* Enable receive logic */
74 #define VT8500_CS8 (1 << 2) /* 8-bit data length (vs. 7-bit) */
75 #define VT8500_CSTOPB (1 << 3) /* 2 stop bits (vs. 1) */
76 #define VT8500_PARENB (1 << 4) /* Enable parity */
77 #define VT8500_PARODD (1 << 5) /* Odd parity (vs. even) */
78 #define VT8500_RTS (1 << 6) /* Ready to send */
79 #define VT8500_LOOPBK (1 << 7) /* Enable internal loopback */
80 #define VT8500_DMA (1 << 8) /* Enable DMA mode (needs FIFO) */
81 #define VT8500_BREAK (1 << 9) /* Initiate break signal */
82 #define VT8500_PSLVERR (1 << 10) /* APB error upon empty RX FIFO read */
83 #define VT8500_SWRTSCTS (1 << 11) /* Software-controlled RTS/CTS */
86 * Capability flags (driver-internal)
89 #define VT8500_HAS_SWRTSCTS_SWITCH (1 << 1)
91 #define VT8500_RECOMMENDED_CLK 12000000
92 #define VT8500_OVERSAMPLING_DIVISOR 13
93 #define VT8500_MAX_PORTS 6
96 struct uart_port uart
;
99 unsigned int clk_predivisor
;
101 unsigned int vt8500_uart_flags
;
105 * we use this variable to keep track of which ports
106 * have been allocated as we can't use pdev->id in
109 static DECLARE_BITMAP(vt8500_ports_in_use
, VT8500_MAX_PORTS
);
111 static inline void vt8500_write(struct uart_port
*port
, unsigned int val
,
114 writel(val
, port
->membase
+ off
);
117 static inline unsigned int vt8500_read(struct uart_port
*port
, unsigned int off
)
119 return readl(port
->membase
+ off
);
122 static void vt8500_stop_tx(struct uart_port
*port
)
124 struct vt8500_port
*vt8500_port
= container_of(port
,
128 vt8500_port
->ier
&= ~TX_FIFO_INTS
;
129 vt8500_write(port
, vt8500_port
->ier
, VT8500_URIER
);
132 static void vt8500_stop_rx(struct uart_port
*port
)
134 struct vt8500_port
*vt8500_port
= container_of(port
,
138 vt8500_port
->ier
&= ~RX_FIFO_INTS
;
139 vt8500_write(port
, vt8500_port
->ier
, VT8500_URIER
);
142 static void vt8500_enable_ms(struct uart_port
*port
)
144 struct vt8500_port
*vt8500_port
= container_of(port
,
148 vt8500_port
->ier
|= TCTS
;
149 vt8500_write(port
, vt8500_port
->ier
, VT8500_URIER
);
152 static void handle_rx(struct uart_port
*port
)
154 struct tty_port
*tport
= &port
->state
->port
;
159 if ((vt8500_read(port
, VT8500_URISR
) & RXOVER
)) {
160 port
->icount
.overrun
++;
161 tty_insert_flip_char(tport
, 0, TTY_OVERRUN
);
164 /* and now the main RX loop */
165 while (vt8500_read(port
, VT8500_URFIDX
) & 0x1f00) {
167 char flag
= TTY_NORMAL
;
169 c
= readw(port
->membase
+ VT8500_RXFIFO
) & 0x3ff;
171 /* Mask conditions we're ignorning. */
172 c
&= ~port
->read_status_mask
;
175 port
->icount
.frame
++;
177 } else if (c
& PER
) {
178 port
->icount
.parity
++;
183 if (!uart_handle_sysrq_char(port
, c
))
184 tty_insert_flip_char(tport
, c
, flag
);
187 spin_unlock(&port
->lock
);
188 tty_flip_buffer_push(tport
);
189 spin_lock(&port
->lock
);
192 static void handle_tx(struct uart_port
*port
)
194 struct circ_buf
*xmit
= &port
->state
->xmit
;
197 writeb(port
->x_char
, port
->membase
+ VT8500_TXFIFO
);
201 if (uart_circ_empty(xmit
) || uart_tx_stopped(port
)) {
202 vt8500_stop_tx(port
);
206 while ((vt8500_read(port
, VT8500_URFIDX
) & 0x1f) < 16) {
207 if (uart_circ_empty(xmit
))
210 writeb(xmit
->buf
[xmit
->tail
], port
->membase
+ VT8500_TXFIFO
);
212 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
- 1);
216 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
217 uart_write_wakeup(port
);
219 if (uart_circ_empty(xmit
))
220 vt8500_stop_tx(port
);
223 static void vt8500_start_tx(struct uart_port
*port
)
225 struct vt8500_port
*vt8500_port
= container_of(port
,
229 vt8500_port
->ier
&= ~TX_FIFO_INTS
;
230 vt8500_write(port
, vt8500_port
->ier
, VT8500_URIER
);
232 vt8500_port
->ier
|= TX_FIFO_INTS
;
233 vt8500_write(port
, vt8500_port
->ier
, VT8500_URIER
);
236 static void handle_delta_cts(struct uart_port
*port
)
239 wake_up_interruptible(&port
->state
->port
.delta_msr_wait
);
242 static irqreturn_t
vt8500_irq(int irq
, void *dev_id
)
244 struct uart_port
*port
= dev_id
;
247 spin_lock(&port
->lock
);
248 isr
= vt8500_read(port
, VT8500_URISR
);
250 /* Acknowledge active status bits */
251 vt8500_write(port
, isr
, VT8500_URISR
);
253 if (isr
& RX_FIFO_INTS
)
255 if (isr
& TX_FIFO_INTS
)
258 handle_delta_cts(port
);
260 spin_unlock(&port
->lock
);
265 static unsigned int vt8500_tx_empty(struct uart_port
*port
)
267 return (vt8500_read(port
, VT8500_URFIDX
) & 0x1f) < 16 ?
271 static unsigned int vt8500_get_mctrl(struct uart_port
*port
)
275 usr
= vt8500_read(port
, VT8500_URUSR
);
282 static void vt8500_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
284 unsigned int lcr
= vt8500_read(port
, VT8500_URLCR
);
286 if (mctrl
& TIOCM_RTS
)
291 vt8500_write(port
, lcr
, VT8500_URLCR
);
294 static void vt8500_break_ctl(struct uart_port
*port
, int break_ctl
)
298 vt8500_read(port
, VT8500_URLCR
) | VT8500_BREAK
,
302 static int vt8500_set_baud_rate(struct uart_port
*port
, unsigned int baud
)
304 struct vt8500_port
*vt8500_port
=
305 container_of(port
, struct vt8500_port
, uart
);
307 unsigned int loops
= 1000;
309 div
= ((vt8500_port
->clk_predivisor
- 1) & 0xf) << 16;
310 div
|= (uart_get_divisor(port
, baud
) - 1) & 0x3ff;
312 /* Effective baud rate */
313 baud
= port
->uartclk
/ 16 / ((div
& 0x3ff) + 1);
315 while ((vt8500_read(port
, VT8500_URUSR
) & (1 << 5)) && --loops
)
318 vt8500_write(port
, div
, VT8500_URDIV
);
320 /* Break signal timing depends on baud rate, update accordingly */
321 vt8500_write(port
, mult_frac(baud
, 4096, 1000000), VT8500_URBKR
);
326 static int vt8500_startup(struct uart_port
*port
)
328 struct vt8500_port
*vt8500_port
=
329 container_of(port
, struct vt8500_port
, uart
);
332 snprintf(vt8500_port
->name
, sizeof(vt8500_port
->name
),
333 "vt8500_serial%d", port
->line
);
335 ret
= request_irq(port
->irq
, vt8500_irq
, IRQF_TRIGGER_HIGH
,
336 vt8500_port
->name
, port
);
340 vt8500_write(port
, 0x03, VT8500_URLCR
); /* enable TX & RX */
345 static void vt8500_shutdown(struct uart_port
*port
)
347 struct vt8500_port
*vt8500_port
=
348 container_of(port
, struct vt8500_port
, uart
);
350 vt8500_port
->ier
= 0;
352 /* disable interrupts and FIFOs */
353 vt8500_write(&vt8500_port
->uart
, 0, VT8500_URIER
);
354 vt8500_write(&vt8500_port
->uart
, 0x880, VT8500_URFCR
);
355 free_irq(port
->irq
, port
);
358 static void vt8500_set_termios(struct uart_port
*port
,
359 struct ktermios
*termios
,
360 struct ktermios
*old
)
362 struct vt8500_port
*vt8500_port
=
363 container_of(port
, struct vt8500_port
, uart
);
365 unsigned int baud
, lcr
;
366 unsigned int loops
= 1000;
368 spin_lock_irqsave(&port
->lock
, flags
);
370 /* calculate and set baud rate */
371 baud
= uart_get_baud_rate(port
, termios
, old
, 900, 921600);
372 baud
= vt8500_set_baud_rate(port
, baud
);
373 if (tty_termios_baud_rate(termios
))
374 tty_termios_encode_baud_rate(termios
, baud
, baud
);
376 /* calculate parity */
377 lcr
= vt8500_read(&vt8500_port
->uart
, VT8500_URLCR
);
378 lcr
&= ~(VT8500_PARENB
| VT8500_PARODD
);
379 if (termios
->c_cflag
& PARENB
) {
380 lcr
|= VT8500_PARENB
;
381 termios
->c_cflag
&= ~CMSPAR
;
382 if (termios
->c_cflag
& PARODD
)
383 lcr
|= VT8500_PARODD
;
386 /* calculate bits per char */
388 switch (termios
->c_cflag
& CSIZE
) {
394 termios
->c_cflag
&= ~CSIZE
;
395 termios
->c_cflag
|= CS8
;
399 /* calculate stop bits */
400 lcr
&= ~VT8500_CSTOPB
;
401 if (termios
->c_cflag
& CSTOPB
)
402 lcr
|= VT8500_CSTOPB
;
404 lcr
&= ~VT8500_SWRTSCTS
;
405 if (vt8500_port
->vt8500_uart_flags
& VT8500_HAS_SWRTSCTS_SWITCH
)
406 lcr
|= VT8500_SWRTSCTS
;
408 /* set parity, bits per char, and stop bit */
409 vt8500_write(&vt8500_port
->uart
, lcr
, VT8500_URLCR
);
411 /* Configure status bits to ignore based on termio flags. */
412 port
->read_status_mask
= 0;
413 if (termios
->c_iflag
& IGNPAR
)
414 port
->read_status_mask
= FER
| PER
;
416 uart_update_timeout(port
, termios
->c_cflag
, baud
);
419 vt8500_write(&vt8500_port
->uart
, 0x88c, VT8500_URFCR
);
420 while ((vt8500_read(&vt8500_port
->uart
, VT8500_URFCR
) & 0xc)
424 /* Every possible FIFO-related interrupt */
425 vt8500_port
->ier
= RX_FIFO_INTS
| TX_FIFO_INTS
;
430 if (UART_ENABLE_MS(&vt8500_port
->uart
, termios
->c_cflag
))
431 vt8500_port
->ier
|= TCTS
;
433 vt8500_write(&vt8500_port
->uart
, 0x881, VT8500_URFCR
);
434 vt8500_write(&vt8500_port
->uart
, vt8500_port
->ier
, VT8500_URIER
);
436 spin_unlock_irqrestore(&port
->lock
, flags
);
439 static const char *vt8500_type(struct uart_port
*port
)
441 struct vt8500_port
*vt8500_port
=
442 container_of(port
, struct vt8500_port
, uart
);
443 return vt8500_port
->name
;
446 static void vt8500_release_port(struct uart_port
*port
)
450 static int vt8500_request_port(struct uart_port
*port
)
455 static void vt8500_config_port(struct uart_port
*port
, int flags
)
457 port
->type
= PORT_VT8500
;
460 static int vt8500_verify_port(struct uart_port
*port
,
461 struct serial_struct
*ser
)
463 if (unlikely(ser
->type
!= PORT_UNKNOWN
&& ser
->type
!= PORT_VT8500
))
465 if (unlikely(port
->irq
!= ser
->irq
))
470 static struct vt8500_port
*vt8500_uart_ports
[VT8500_MAX_PORTS
];
471 static struct uart_driver vt8500_uart_driver
;
473 #ifdef CONFIG_SERIAL_VT8500_CONSOLE
475 static void wait_for_xmitr(struct uart_port
*port
)
477 unsigned int status
, tmout
= 10000;
479 /* Wait up to 10ms for the character(s) to be sent. */
481 status
= vt8500_read(port
, VT8500_URFIDX
);
486 } while (status
& 0x10);
489 static void vt8500_console_putchar(struct uart_port
*port
, int c
)
491 wait_for_xmitr(port
);
492 writeb(c
, port
->membase
+ VT8500_TXFIFO
);
495 static void vt8500_console_write(struct console
*co
, const char *s
,
498 struct vt8500_port
*vt8500_port
= vt8500_uart_ports
[co
->index
];
501 BUG_ON(co
->index
< 0 || co
->index
>= vt8500_uart_driver
.nr
);
503 ier
= vt8500_read(&vt8500_port
->uart
, VT8500_URIER
);
504 vt8500_write(&vt8500_port
->uart
, VT8500_URIER
, 0);
506 uart_console_write(&vt8500_port
->uart
, s
, count
,
507 vt8500_console_putchar
);
510 * Finally, wait for transmitter to become empty
511 * and switch back to FIFO
513 wait_for_xmitr(&vt8500_port
->uart
);
514 vt8500_write(&vt8500_port
->uart
, VT8500_URIER
, ier
);
517 static int __init
vt8500_console_setup(struct console
*co
, char *options
)
519 struct vt8500_port
*vt8500_port
;
525 if (unlikely(co
->index
>= vt8500_uart_driver
.nr
|| co
->index
< 0))
528 vt8500_port
= vt8500_uart_ports
[co
->index
];
534 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
536 return uart_set_options(&vt8500_port
->uart
,
537 co
, baud
, parity
, bits
, flow
);
540 static struct console vt8500_console
= {
542 .write
= vt8500_console_write
,
543 .device
= uart_console_device
,
544 .setup
= vt8500_console_setup
,
545 .flags
= CON_PRINTBUFFER
,
547 .data
= &vt8500_uart_driver
,
550 #define VT8500_CONSOLE (&vt8500_console)
553 #define VT8500_CONSOLE NULL
556 #ifdef CONFIG_CONSOLE_POLL
557 static int vt8500_get_poll_char(struct uart_port
*port
)
559 unsigned int status
= vt8500_read(port
, VT8500_URFIDX
);
561 if (!(status
& 0x1f00))
564 return vt8500_read(port
, VT8500_RXFIFO
) & 0xff;
567 static void vt8500_put_poll_char(struct uart_port
*port
, unsigned char c
)
569 unsigned int status
, tmout
= 10000;
572 status
= vt8500_read(port
, VT8500_URFIDX
);
577 } while (status
& 0x10);
579 vt8500_write(port
, c
, VT8500_TXFIFO
);
583 static const struct uart_ops vt8500_uart_pops
= {
584 .tx_empty
= vt8500_tx_empty
,
585 .set_mctrl
= vt8500_set_mctrl
,
586 .get_mctrl
= vt8500_get_mctrl
,
587 .stop_tx
= vt8500_stop_tx
,
588 .start_tx
= vt8500_start_tx
,
589 .stop_rx
= vt8500_stop_rx
,
590 .enable_ms
= vt8500_enable_ms
,
591 .break_ctl
= vt8500_break_ctl
,
592 .startup
= vt8500_startup
,
593 .shutdown
= vt8500_shutdown
,
594 .set_termios
= vt8500_set_termios
,
596 .release_port
= vt8500_release_port
,
597 .request_port
= vt8500_request_port
,
598 .config_port
= vt8500_config_port
,
599 .verify_port
= vt8500_verify_port
,
600 #ifdef CONFIG_CONSOLE_POLL
601 .poll_get_char
= vt8500_get_poll_char
,
602 .poll_put_char
= vt8500_put_poll_char
,
606 static struct uart_driver vt8500_uart_driver
= {
607 .owner
= THIS_MODULE
,
608 .driver_name
= "vt8500_serial",
609 .dev_name
= "ttyWMT",
611 .cons
= VT8500_CONSOLE
,
614 static unsigned int vt8500_flags
; /* none required so far */
615 static unsigned int wm8880_flags
= VT8500_HAS_SWRTSCTS_SWITCH
;
617 static const struct of_device_id wmt_dt_ids
[] = {
618 { .compatible
= "via,vt8500-uart", .data
= &vt8500_flags
},
619 { .compatible
= "wm,wm8880-uart", .data
= &wm8880_flags
},
623 static int vt8500_serial_probe(struct platform_device
*pdev
)
625 struct vt8500_port
*vt8500_port
;
626 struct resource
*mmres
, *irqres
;
627 struct device_node
*np
= pdev
->dev
.of_node
;
628 const struct of_device_id
*match
;
629 const unsigned int *flags
;
633 match
= of_match_device(wmt_dt_ids
, &pdev
->dev
);
639 mmres
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
640 irqres
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
641 if (!mmres
|| !irqres
)
645 port
= of_alias_get_id(np
, "serial");
646 if (port
>= VT8500_MAX_PORTS
)
653 /* calculate the port id */
654 port
= find_first_zero_bit(vt8500_ports_in_use
,
658 if (port
>= VT8500_MAX_PORTS
)
661 /* reserve the port id */
662 if (test_and_set_bit(port
, vt8500_ports_in_use
)) {
663 /* port already in use - shouldn't really happen */
667 vt8500_port
= devm_kzalloc(&pdev
->dev
, sizeof(struct vt8500_port
),
672 vt8500_port
->uart
.membase
= devm_ioremap_resource(&pdev
->dev
, mmres
);
673 if (IS_ERR(vt8500_port
->uart
.membase
))
674 return PTR_ERR(vt8500_port
->uart
.membase
);
676 vt8500_port
->clk
= of_clk_get(pdev
->dev
.of_node
, 0);
677 if (IS_ERR(vt8500_port
->clk
)) {
678 dev_err(&pdev
->dev
, "failed to get clock\n");
682 ret
= clk_prepare_enable(vt8500_port
->clk
);
684 dev_err(&pdev
->dev
, "failed to enable clock\n");
688 vt8500_port
->vt8500_uart_flags
= *flags
;
689 vt8500_port
->clk_predivisor
= DIV_ROUND_CLOSEST(
690 clk_get_rate(vt8500_port
->clk
),
691 VT8500_RECOMMENDED_CLK
693 vt8500_port
->uart
.type
= PORT_VT8500
;
694 vt8500_port
->uart
.iotype
= UPIO_MEM
;
695 vt8500_port
->uart
.mapbase
= mmres
->start
;
696 vt8500_port
->uart
.irq
= irqres
->start
;
697 vt8500_port
->uart
.fifosize
= 16;
698 vt8500_port
->uart
.ops
= &vt8500_uart_pops
;
699 vt8500_port
->uart
.line
= port
;
700 vt8500_port
->uart
.dev
= &pdev
->dev
;
701 vt8500_port
->uart
.flags
= UPF_IOREMAP
| UPF_BOOT_AUTOCONF
;
702 vt8500_port
->uart
.has_sysrq
= IS_ENABLED(CONFIG_SERIAL_VT8500_CONSOLE
);
704 /* Serial core uses the magic "16" everywhere - adjust for it */
705 vt8500_port
->uart
.uartclk
= 16 * clk_get_rate(vt8500_port
->clk
) /
706 vt8500_port
->clk_predivisor
/
707 VT8500_OVERSAMPLING_DIVISOR
;
709 snprintf(vt8500_port
->name
, sizeof(vt8500_port
->name
),
710 "VT8500 UART%d", pdev
->id
);
712 vt8500_uart_ports
[port
] = vt8500_port
;
714 uart_add_one_port(&vt8500_uart_driver
, &vt8500_port
->uart
);
716 platform_set_drvdata(pdev
, vt8500_port
);
721 static struct platform_driver vt8500_platform_driver
= {
722 .probe
= vt8500_serial_probe
,
724 .name
= "vt8500_serial",
725 .of_match_table
= wmt_dt_ids
,
726 .suppress_bind_attrs
= true,
730 static int __init
vt8500_serial_init(void)
734 ret
= uart_register_driver(&vt8500_uart_driver
);
738 ret
= platform_driver_register(&vt8500_platform_driver
);
741 uart_unregister_driver(&vt8500_uart_driver
);
745 device_initcall(vt8500_serial_init
);