1 // SPDX-License-Identifier: GPL-2.0
3 * timbuart.c timberdale FPGA UART driver
4 * Copyright (c) 2009 Intel Corporation
11 #include <linux/pci.h>
12 #include <linux/interrupt.h>
13 #include <linux/serial_core.h>
14 #include <linux/tty.h>
15 #include <linux/tty_flip.h>
16 #include <linux/kernel.h>
17 #include <linux/platform_device.h>
18 #include <linux/ioport.h>
19 #include <linux/slab.h>
20 #include <linux/module.h>
24 struct timbuart_port
{
25 struct uart_port port
;
26 struct tasklet_struct tasklet
;
29 struct platform_device
*dev
;
32 static int baudrates
[] = {9600, 19200, 38400, 57600, 115200, 230400, 460800,
33 921600, 1843200, 3250000};
35 static void timbuart_mctrl_check(struct uart_port
*port
, u32 isr
, u32
*ier
);
37 static irqreturn_t
timbuart_handleinterrupt(int irq
, void *devid
);
39 static void timbuart_stop_rx(struct uart_port
*port
)
41 /* spin lock held by upper layer, disable all RX interrupts */
42 u32 ier
= ioread32(port
->membase
+ TIMBUART_IER
) & ~RXFLAGS
;
43 iowrite32(ier
, port
->membase
+ TIMBUART_IER
);
46 static void timbuart_stop_tx(struct uart_port
*port
)
48 /* spinlock held by upper layer, disable TX interrupt */
49 u32 ier
= ioread32(port
->membase
+ TIMBUART_IER
) & ~TXBAE
;
50 iowrite32(ier
, port
->membase
+ TIMBUART_IER
);
53 static void timbuart_start_tx(struct uart_port
*port
)
55 struct timbuart_port
*uart
=
56 container_of(port
, struct timbuart_port
, port
);
58 /* do not transfer anything here -> fire off the tasklet */
59 tasklet_schedule(&uart
->tasklet
);
62 static unsigned int timbuart_tx_empty(struct uart_port
*port
)
64 u32 isr
= ioread32(port
->membase
+ TIMBUART_ISR
);
66 return (isr
& TXBE
) ? TIOCSER_TEMT
: 0;
69 static void timbuart_flush_buffer(struct uart_port
*port
)
71 if (!timbuart_tx_empty(port
)) {
72 u8 ctl
= ioread8(port
->membase
+ TIMBUART_CTRL
) |
75 iowrite8(ctl
, port
->membase
+ TIMBUART_CTRL
);
76 iowrite32(TXBF
, port
->membase
+ TIMBUART_ISR
);
80 static void timbuart_rx_chars(struct uart_port
*port
)
82 struct tty_port
*tport
= &port
->state
->port
;
84 while (ioread32(port
->membase
+ TIMBUART_ISR
) & RXDP
) {
85 u8 ch
= ioread8(port
->membase
+ TIMBUART_RXFIFO
);
87 tty_insert_flip_char(tport
, ch
, TTY_NORMAL
);
90 spin_unlock(&port
->lock
);
91 tty_flip_buffer_push(tport
);
92 spin_lock(&port
->lock
);
94 dev_dbg(port
->dev
, "%s - total read %d bytes\n",
95 __func__
, port
->icount
.rx
);
98 static void timbuart_tx_chars(struct uart_port
*port
)
100 struct circ_buf
*xmit
= &port
->state
->xmit
;
102 while (!(ioread32(port
->membase
+ TIMBUART_ISR
) & TXBF
) &&
103 !uart_circ_empty(xmit
)) {
104 iowrite8(xmit
->buf
[xmit
->tail
],
105 port
->membase
+ TIMBUART_TXFIFO
);
106 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
- 1);
111 "%s - total written %d bytes, CTL: %x, RTS: %x, baud: %x\n",
114 ioread8(port
->membase
+ TIMBUART_CTRL
),
115 port
->mctrl
& TIOCM_RTS
,
116 ioread8(port
->membase
+ TIMBUART_BAUDRATE
));
119 static void timbuart_handle_tx_port(struct uart_port
*port
, u32 isr
, u32
*ier
)
121 struct timbuart_port
*uart
=
122 container_of(port
, struct timbuart_port
, port
);
123 struct circ_buf
*xmit
= &port
->state
->xmit
;
125 if (uart_circ_empty(xmit
) || uart_tx_stopped(port
))
132 timbuart_tx_chars(port
);
133 /* clear all TX interrupts */
134 iowrite32(TXFLAGS
, port
->membase
+ TIMBUART_ISR
);
136 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
137 uart_write_wakeup(port
);
139 /* Re-enable any tx interrupt */
140 *ier
|= uart
->last_ier
& TXFLAGS
;
142 /* enable interrupts if there are chars in the transmit buffer,
143 * Or if we delivered some bytes and want the almost empty interrupt
144 * we wake up the upper layer later when we got the interrupt
145 * to give it some time to go out...
147 if (!uart_circ_empty(xmit
))
150 dev_dbg(port
->dev
, "%s - leaving\n", __func__
);
153 static void timbuart_handle_rx_port(struct uart_port
*port
, u32 isr
, u32
*ier
)
156 /* Some RX status is set */
158 u8 ctl
= ioread8(port
->membase
+ TIMBUART_CTRL
) |
159 TIMBUART_CTRL_FLSHRX
;
160 iowrite8(ctl
, port
->membase
+ TIMBUART_CTRL
);
161 port
->icount
.overrun
++;
162 } else if (isr
& (RXDP
))
163 timbuart_rx_chars(port
);
165 /* ack all RX interrupts */
166 iowrite32(RXFLAGS
, port
->membase
+ TIMBUART_ISR
);
169 /* always have the RX interrupts enabled */
170 *ier
|= RXBAF
| RXBF
| RXTT
;
172 dev_dbg(port
->dev
, "%s - leaving\n", __func__
);
175 static void timbuart_tasklet(unsigned long arg
)
177 struct timbuart_port
*uart
= (struct timbuart_port
*)arg
;
180 spin_lock(&uart
->port
.lock
);
182 isr
= ioread32(uart
->port
.membase
+ TIMBUART_ISR
);
183 dev_dbg(uart
->port
.dev
, "%s ISR: %x\n", __func__
, isr
);
186 timbuart_handle_tx_port(&uart
->port
, isr
, &ier
);
188 timbuart_mctrl_check(&uart
->port
, isr
, &ier
);
191 timbuart_handle_rx_port(&uart
->port
, isr
, &ier
);
193 iowrite32(ier
, uart
->port
.membase
+ TIMBUART_IER
);
195 spin_unlock(&uart
->port
.lock
);
196 dev_dbg(uart
->port
.dev
, "%s leaving\n", __func__
);
199 static unsigned int timbuart_get_mctrl(struct uart_port
*port
)
201 u8 cts
= ioread8(port
->membase
+ TIMBUART_CTRL
);
202 dev_dbg(port
->dev
, "%s - cts %x\n", __func__
, cts
);
204 if (cts
& TIMBUART_CTRL_CTS
)
205 return TIOCM_CTS
| TIOCM_DSR
| TIOCM_CAR
;
207 return TIOCM_DSR
| TIOCM_CAR
;
210 static void timbuart_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
212 dev_dbg(port
->dev
, "%s - %x\n", __func__
, mctrl
);
214 if (mctrl
& TIOCM_RTS
)
215 iowrite8(TIMBUART_CTRL_RTS
, port
->membase
+ TIMBUART_CTRL
);
217 iowrite8(0, port
->membase
+ TIMBUART_CTRL
);
220 static void timbuart_mctrl_check(struct uart_port
*port
, u32 isr
, u32
*ier
)
224 if (isr
& CTS_DELTA
) {
226 iowrite32(CTS_DELTA
, port
->membase
+ TIMBUART_ISR
);
227 cts
= timbuart_get_mctrl(port
);
228 uart_handle_cts_change(port
, cts
& TIOCM_CTS
);
229 wake_up_interruptible(&port
->state
->port
.delta_msr_wait
);
235 static void timbuart_break_ctl(struct uart_port
*port
, int ctl
)
240 static int timbuart_startup(struct uart_port
*port
)
242 struct timbuart_port
*uart
=
243 container_of(port
, struct timbuart_port
, port
);
245 dev_dbg(port
->dev
, "%s\n", __func__
);
247 iowrite8(TIMBUART_CTRL_FLSHRX
, port
->membase
+ TIMBUART_CTRL
);
248 iowrite32(0x1ff, port
->membase
+ TIMBUART_ISR
);
249 /* Enable all but TX interrupts */
250 iowrite32(RXBAF
| RXBF
| RXTT
| CTS_DELTA
,
251 port
->membase
+ TIMBUART_IER
);
253 return request_irq(port
->irq
, timbuart_handleinterrupt
, IRQF_SHARED
,
257 static void timbuart_shutdown(struct uart_port
*port
)
259 struct timbuart_port
*uart
=
260 container_of(port
, struct timbuart_port
, port
);
261 dev_dbg(port
->dev
, "%s\n", __func__
);
262 free_irq(port
->irq
, uart
);
263 iowrite32(0, port
->membase
+ TIMBUART_IER
);
265 timbuart_flush_buffer(port
);
268 static int get_bindex(int baud
)
272 for (i
= 0; i
< ARRAY_SIZE(baudrates
); i
++)
273 if (baud
<= baudrates
[i
])
279 static void timbuart_set_termios(struct uart_port
*port
,
280 struct ktermios
*termios
,
281 struct ktermios
*old
)
287 baud
= uart_get_baud_rate(port
, termios
, old
, 0, port
->uartclk
/ 16);
288 bindex
= get_bindex(baud
);
289 dev_dbg(port
->dev
, "%s - bindex %d\n", __func__
, bindex
);
293 baud
= baudrates
[bindex
];
295 /* The serial layer calls into this once with old = NULL when setting
298 tty_termios_copy_hw(termios
, old
);
299 tty_termios_encode_baud_rate(termios
, baud
, baud
);
301 spin_lock_irqsave(&port
->lock
, flags
);
302 iowrite8((u8
)bindex
, port
->membase
+ TIMBUART_BAUDRATE
);
303 uart_update_timeout(port
, termios
->c_cflag
, baud
);
304 spin_unlock_irqrestore(&port
->lock
, flags
);
307 static const char *timbuart_type(struct uart_port
*port
)
309 return port
->type
== PORT_UNKNOWN
? "timbuart" : NULL
;
312 /* We do not request/release mappings of the registers here,
313 * currently it's done in the proble function.
315 static void timbuart_release_port(struct uart_port
*port
)
317 struct platform_device
*pdev
= to_platform_device(port
->dev
);
319 resource_size(platform_get_resource(pdev
, IORESOURCE_MEM
, 0));
321 if (port
->flags
& UPF_IOREMAP
) {
322 iounmap(port
->membase
);
323 port
->membase
= NULL
;
326 release_mem_region(port
->mapbase
, size
);
329 static int timbuart_request_port(struct uart_port
*port
)
331 struct platform_device
*pdev
= to_platform_device(port
->dev
);
333 resource_size(platform_get_resource(pdev
, IORESOURCE_MEM
, 0));
335 if (!request_mem_region(port
->mapbase
, size
, "timb-uart"))
338 if (port
->flags
& UPF_IOREMAP
) {
339 port
->membase
= ioremap(port
->mapbase
, size
);
340 if (port
->membase
== NULL
) {
341 release_mem_region(port
->mapbase
, size
);
349 static irqreturn_t
timbuart_handleinterrupt(int irq
, void *devid
)
351 struct timbuart_port
*uart
= (struct timbuart_port
*)devid
;
353 if (ioread8(uart
->port
.membase
+ TIMBUART_IPR
)) {
354 uart
->last_ier
= ioread32(uart
->port
.membase
+ TIMBUART_IER
);
356 /* disable interrupts, the tasklet enables them again */
357 iowrite32(0, uart
->port
.membase
+ TIMBUART_IER
);
359 /* fire off bottom half */
360 tasklet_schedule(&uart
->tasklet
);
368 * Configure/autoconfigure the port.
370 static void timbuart_config_port(struct uart_port
*port
, int flags
)
372 if (flags
& UART_CONFIG_TYPE
) {
373 port
->type
= PORT_TIMBUART
;
374 timbuart_request_port(port
);
378 static int timbuart_verify_port(struct uart_port
*port
,
379 struct serial_struct
*ser
)
381 /* we don't want the core code to modify any port params */
385 static const struct uart_ops timbuart_ops
= {
386 .tx_empty
= timbuart_tx_empty
,
387 .set_mctrl
= timbuart_set_mctrl
,
388 .get_mctrl
= timbuart_get_mctrl
,
389 .stop_tx
= timbuart_stop_tx
,
390 .start_tx
= timbuart_start_tx
,
391 .flush_buffer
= timbuart_flush_buffer
,
392 .stop_rx
= timbuart_stop_rx
,
393 .break_ctl
= timbuart_break_ctl
,
394 .startup
= timbuart_startup
,
395 .shutdown
= timbuart_shutdown
,
396 .set_termios
= timbuart_set_termios
,
397 .type
= timbuart_type
,
398 .release_port
= timbuart_release_port
,
399 .request_port
= timbuart_request_port
,
400 .config_port
= timbuart_config_port
,
401 .verify_port
= timbuart_verify_port
404 static struct uart_driver timbuart_driver
= {
405 .owner
= THIS_MODULE
,
406 .driver_name
= "timberdale_uart",
408 .major
= TIMBUART_MAJOR
,
409 .minor
= TIMBUART_MINOR
,
413 static int timbuart_probe(struct platform_device
*dev
)
416 struct timbuart_port
*uart
;
417 struct resource
*iomem
;
419 dev_dbg(&dev
->dev
, "%s\n", __func__
);
421 uart
= kzalloc(sizeof(*uart
), GFP_KERNEL
);
429 uart
->port
.uartclk
= 3250000 * 16;
430 uart
->port
.fifosize
= TIMBUART_FIFO_SIZE
;
431 uart
->port
.regshift
= 2;
432 uart
->port
.iotype
= UPIO_MEM
;
433 uart
->port
.ops
= &timbuart_ops
;
435 uart
->port
.flags
= UPF_BOOT_AUTOCONF
| UPF_IOREMAP
;
437 uart
->port
.dev
= &dev
->dev
;
439 iomem
= platform_get_resource(dev
, IORESOURCE_MEM
, 0);
444 uart
->port
.mapbase
= iomem
->start
;
445 uart
->port
.membase
= NULL
;
447 irq
= platform_get_irq(dev
, 0);
452 uart
->port
.irq
= irq
;
454 tasklet_init(&uart
->tasklet
, timbuart_tasklet
, (unsigned long)uart
);
456 err
= uart_register_driver(&timbuart_driver
);
460 err
= uart_add_one_port(&timbuart_driver
, &uart
->port
);
464 platform_set_drvdata(dev
, uart
);
469 uart_unregister_driver(&timbuart_driver
);
473 printk(KERN_ERR
"timberdale: Failed to register Timberdale UART: %d\n",
479 static int timbuart_remove(struct platform_device
*dev
)
481 struct timbuart_port
*uart
= platform_get_drvdata(dev
);
483 tasklet_kill(&uart
->tasklet
);
484 uart_remove_one_port(&timbuart_driver
, &uart
->port
);
485 uart_unregister_driver(&timbuart_driver
);
491 static struct platform_driver timbuart_platform_driver
= {
495 .probe
= timbuart_probe
,
496 .remove
= timbuart_remove
,
499 module_platform_driver(timbuart_platform_driver
);
501 MODULE_DESCRIPTION("Timberdale UART driver");
502 MODULE_LICENSE("GPL v2");
503 MODULE_ALIAS("platform:timb-uart");