2 * Synopsys DesignWare 8250 driver.
4 * Copyright 2011 Picochip, Jamie Iles.
5 * Copyright 2013 Intel Corporation
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * The Synopsys DesignWare 8250 has an extra feature whereby it detects if the
13 * LCR is written whilst busy. If it is, then a busy detect interrupt is
14 * raised, the LCR needs to be rewritten and the uart status register read.
16 #include <linux/device.h>
18 #include <linux/module.h>
19 #include <linux/serial_8250.h>
20 #include <linux/serial_reg.h>
22 #include <linux/of_irq.h>
23 #include <linux/of_platform.h>
24 #include <linux/platform_device.h>
25 #include <linux/slab.h>
26 #include <linux/acpi.h>
27 #include <linux/clk.h>
28 #include <linux/reset.h>
29 #include <linux/pm_runtime.h>
31 #include <asm/byteorder.h>
35 /* Offsets for the DesignWare specific registers */
36 #define DW_UART_USR 0x1f /* UART Status Register */
37 #define DW_UART_CPR 0xf4 /* Component Parameter Register */
38 #define DW_UART_UCV 0xf8 /* UART Component Version */
40 /* Component Parameter Register bits */
41 #define DW_UART_CPR_ABP_DATA_WIDTH (3 << 0)
42 #define DW_UART_CPR_AFCE_MODE (1 << 4)
43 #define DW_UART_CPR_THRE_MODE (1 << 5)
44 #define DW_UART_CPR_SIR_MODE (1 << 6)
45 #define DW_UART_CPR_SIR_LP_MODE (1 << 7)
46 #define DW_UART_CPR_ADDITIONAL_FEATURES (1 << 8)
47 #define DW_UART_CPR_FIFO_ACCESS (1 << 9)
48 #define DW_UART_CPR_FIFO_STAT (1 << 10)
49 #define DW_UART_CPR_SHADOW (1 << 11)
50 #define DW_UART_CPR_ENCODED_PARMS (1 << 12)
51 #define DW_UART_CPR_DMA_EXTRA (1 << 13)
52 #define DW_UART_CPR_FIFO_MODE (0xff << 16)
53 /* Helper for fifo size calculation */
54 #define DW_UART_CPR_FIFO_SIZE(a) (((a >> 16) & 0xff) * 16)
64 struct reset_control
*rst
;
65 struct uart_8250_dma dma
;
67 unsigned int skip_autocfg
:1;
68 unsigned int uart_16550_compatible
:1;
71 static inline int dw8250_modify_msr(struct uart_port
*p
, int offset
, int value
)
73 struct dw8250_data
*d
= p
->private_data
;
75 /* Override any modem control signals if needed */
76 if (offset
== UART_MSR
) {
77 value
|= d
->msr_mask_on
;
78 value
&= ~d
->msr_mask_off
;
84 static void dw8250_force_idle(struct uart_port
*p
)
86 struct uart_8250_port
*up
= up_to_u8250p(p
);
88 serial8250_clear_and_reinit_fifos(up
);
89 (void)p
->serial_in(p
, UART_RX
);
92 static void dw8250_check_lcr(struct uart_port
*p
, int value
)
94 void __iomem
*offset
= p
->membase
+ (UART_LCR
<< p
->regshift
);
97 /* Make sure LCR write wasn't ignored */
99 unsigned int lcr
= p
->serial_in(p
, UART_LCR
);
101 if ((value
& ~UART_LCR_SPAR
) == (lcr
& ~UART_LCR_SPAR
))
104 dw8250_force_idle(p
);
107 if (p
->type
== PORT_OCTEON
)
108 __raw_writeq(value
& 0xff, offset
);
111 if (p
->iotype
== UPIO_MEM32
)
112 writel(value
, offset
);
113 else if (p
->iotype
== UPIO_MEM32BE
)
114 iowrite32be(value
, offset
);
116 writeb(value
, offset
);
119 * FIXME: this deadlocks if port->lock is already held
120 * dev_err(p->dev, "Couldn't set LCR to %d\n", value);
124 static void dw8250_serial_out(struct uart_port
*p
, int offset
, int value
)
126 struct dw8250_data
*d
= p
->private_data
;
128 writeb(value
, p
->membase
+ (offset
<< p
->regshift
));
130 if (offset
== UART_LCR
&& !d
->uart_16550_compatible
)
131 dw8250_check_lcr(p
, value
);
134 static unsigned int dw8250_serial_in(struct uart_port
*p
, int offset
)
136 unsigned int value
= readb(p
->membase
+ (offset
<< p
->regshift
));
138 return dw8250_modify_msr(p
, offset
, value
);
142 static unsigned int dw8250_serial_inq(struct uart_port
*p
, int offset
)
146 value
= (u8
)__raw_readq(p
->membase
+ (offset
<< p
->regshift
));
148 return dw8250_modify_msr(p
, offset
, value
);
151 static void dw8250_serial_outq(struct uart_port
*p
, int offset
, int value
)
153 struct dw8250_data
*d
= p
->private_data
;
156 __raw_writeq(value
, p
->membase
+ (offset
<< p
->regshift
));
157 /* Read back to ensure register write ordering. */
158 __raw_readq(p
->membase
+ (UART_LCR
<< p
->regshift
));
160 if (offset
== UART_LCR
&& !d
->uart_16550_compatible
)
161 dw8250_check_lcr(p
, value
);
163 #endif /* CONFIG_64BIT */
165 static void dw8250_serial_out32(struct uart_port
*p
, int offset
, int value
)
167 struct dw8250_data
*d
= p
->private_data
;
169 writel(value
, p
->membase
+ (offset
<< p
->regshift
));
171 if (offset
== UART_LCR
&& !d
->uart_16550_compatible
)
172 dw8250_check_lcr(p
, value
);
175 static unsigned int dw8250_serial_in32(struct uart_port
*p
, int offset
)
177 unsigned int value
= readl(p
->membase
+ (offset
<< p
->regshift
));
179 return dw8250_modify_msr(p
, offset
, value
);
182 static void dw8250_serial_out32be(struct uart_port
*p
, int offset
, int value
)
184 struct dw8250_data
*d
= p
->private_data
;
186 iowrite32be(value
, p
->membase
+ (offset
<< p
->regshift
));
188 if (offset
== UART_LCR
&& !d
->uart_16550_compatible
)
189 dw8250_check_lcr(p
, value
);
192 static unsigned int dw8250_serial_in32be(struct uart_port
*p
, int offset
)
194 unsigned int value
= ioread32be(p
->membase
+ (offset
<< p
->regshift
));
196 return dw8250_modify_msr(p
, offset
, value
);
200 static int dw8250_handle_irq(struct uart_port
*p
)
202 struct dw8250_data
*d
= p
->private_data
;
203 unsigned int iir
= p
->serial_in(p
, UART_IIR
);
205 if (serial8250_handle_irq(p
, iir
))
208 if ((iir
& UART_IIR_BUSY
) == UART_IIR_BUSY
) {
210 (void)p
->serial_in(p
, d
->usr_reg
);
219 dw8250_do_pm(struct uart_port
*port
, unsigned int state
, unsigned int old
)
222 pm_runtime_get_sync(port
->dev
);
224 serial8250_do_pm(port
, state
, old
);
227 pm_runtime_put_sync_suspend(port
->dev
);
230 static void dw8250_set_termios(struct uart_port
*p
, struct ktermios
*termios
,
231 struct ktermios
*old
)
233 unsigned int baud
= tty_termios_baud_rate(termios
);
234 struct dw8250_data
*d
= p
->private_data
;
238 if (IS_ERR(d
->clk
) || !old
)
241 clk_disable_unprepare(d
->clk
);
242 rate
= clk_round_rate(d
->clk
, baud
* 16);
243 ret
= clk_set_rate(d
->clk
, rate
);
244 clk_prepare_enable(d
->clk
);
249 p
->status
&= ~UPSTAT_AUTOCTS
;
250 if (termios
->c_cflag
& CRTSCTS
)
251 p
->status
|= UPSTAT_AUTOCTS
;
254 serial8250_do_set_termios(p
, termios
, old
);
258 * dw8250_fallback_dma_filter will prevent the UART from getting just any free
259 * channel on platforms that have DMA engines, but don't have any channels
260 * assigned to the UART.
262 * REVISIT: This is a work around for limitation in the DMA Engine API. Once the
263 * core problem is fixed, this function is no longer needed.
265 static bool dw8250_fallback_dma_filter(struct dma_chan
*chan
, void *param
)
270 static bool dw8250_idma_filter(struct dma_chan
*chan
, void *param
)
272 return param
== chan
->device
->dev
->parent
;
275 static void dw8250_quirks(struct uart_port
*p
, struct dw8250_data
*data
)
277 if (p
->dev
->of_node
) {
278 struct device_node
*np
= p
->dev
->of_node
;
281 /* get index of serial line, if found in DT aliases */
282 id
= of_alias_get_id(np
, "serial");
286 if (of_device_is_compatible(np
, "cavium,octeon-3860-uart")) {
287 p
->serial_in
= dw8250_serial_inq
;
288 p
->serial_out
= dw8250_serial_outq
;
289 p
->flags
= UPF_SKIP_TEST
| UPF_SHARE_IRQ
| UPF_FIXED_TYPE
;
290 p
->type
= PORT_OCTEON
;
291 data
->usr_reg
= 0x27;
292 data
->skip_autocfg
= true;
295 if (of_device_is_big_endian(p
->dev
->of_node
)) {
296 p
->iotype
= UPIO_MEM32BE
;
297 p
->serial_in
= dw8250_serial_in32be
;
298 p
->serial_out
= dw8250_serial_out32be
;
300 } else if (has_acpi_companion(p
->dev
)) {
301 p
->iotype
= UPIO_MEM32
;
303 p
->serial_in
= dw8250_serial_in32
;
304 p
->set_termios
= dw8250_set_termios
;
305 /* So far none of there implement the Busy Functionality */
306 data
->uart_16550_compatible
= true;
309 /* Platforms with iDMA */
310 if (platform_get_resource_byname(to_platform_device(p
->dev
),
311 IORESOURCE_MEM
, "lpss_priv")) {
312 p
->set_termios
= dw8250_set_termios
;
313 data
->dma
.rx_param
= p
->dev
->parent
;
314 data
->dma
.tx_param
= p
->dev
->parent
;
315 data
->dma
.fn
= dw8250_idma_filter
;
319 static void dw8250_setup_port(struct uart_port
*p
)
321 struct uart_8250_port
*up
= up_to_u8250p(p
);
325 * If the Component Version Register returns zero, we know that
326 * ADDITIONAL_FEATURES are not enabled. No need to go any further.
328 if (p
->iotype
== UPIO_MEM32BE
)
329 reg
= ioread32be(p
->membase
+ DW_UART_UCV
);
331 reg
= readl(p
->membase
+ DW_UART_UCV
);
335 dev_dbg(p
->dev
, "Designware UART version %c.%c%c\n",
336 (reg
>> 24) & 0xff, (reg
>> 16) & 0xff, (reg
>> 8) & 0xff);
338 if (p
->iotype
== UPIO_MEM32BE
)
339 reg
= ioread32be(p
->membase
+ DW_UART_CPR
);
341 reg
= readl(p
->membase
+ DW_UART_CPR
);
345 /* Select the type based on fifo */
346 if (reg
& DW_UART_CPR_FIFO_MODE
) {
347 p
->type
= PORT_16550A
;
348 p
->flags
|= UPF_FIXED_TYPE
;
349 p
->fifosize
= DW_UART_CPR_FIFO_SIZE(reg
);
350 up
->capabilities
= UART_CAP_FIFO
;
353 if (reg
& DW_UART_CPR_AFCE_MODE
)
354 up
->capabilities
|= UART_CAP_AFE
;
357 static int dw8250_probe(struct platform_device
*pdev
)
359 struct uart_8250_port uart
= {};
360 struct resource
*regs
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
361 int irq
= platform_get_irq(pdev
, 0);
362 struct uart_port
*p
= &uart
.port
;
363 struct device
*dev
= &pdev
->dev
;
364 struct dw8250_data
*data
;
369 dev_err(dev
, "no registers defined\n");
374 if (irq
!= -EPROBE_DEFER
)
375 dev_err(dev
, "cannot get irq\n");
379 spin_lock_init(&p
->lock
);
380 p
->mapbase
= regs
->start
;
382 p
->handle_irq
= dw8250_handle_irq
;
383 p
->pm
= dw8250_do_pm
;
385 p
->flags
= UPF_SHARE_IRQ
| UPF_FIXED_PORT
;
387 p
->iotype
= UPIO_MEM
;
388 p
->serial_in
= dw8250_serial_in
;
389 p
->serial_out
= dw8250_serial_out
;
391 p
->membase
= devm_ioremap(dev
, regs
->start
, resource_size(regs
));
395 data
= devm_kzalloc(dev
, sizeof(*data
), GFP_KERNEL
);
399 data
->dma
.fn
= dw8250_fallback_dma_filter
;
400 data
->usr_reg
= DW_UART_USR
;
401 p
->private_data
= data
;
403 data
->uart_16550_compatible
= device_property_read_bool(dev
,
404 "snps,uart-16550-compatible");
406 err
= device_property_read_u32(dev
, "reg-shift", &val
);
410 err
= device_property_read_u32(dev
, "reg-io-width", &val
);
411 if (!err
&& val
== 4) {
412 p
->iotype
= UPIO_MEM32
;
413 p
->serial_in
= dw8250_serial_in32
;
414 p
->serial_out
= dw8250_serial_out32
;
417 if (device_property_read_bool(dev
, "dcd-override")) {
418 /* Always report DCD as active */
419 data
->msr_mask_on
|= UART_MSR_DCD
;
420 data
->msr_mask_off
|= UART_MSR_DDCD
;
423 if (device_property_read_bool(dev
, "dsr-override")) {
424 /* Always report DSR as active */
425 data
->msr_mask_on
|= UART_MSR_DSR
;
426 data
->msr_mask_off
|= UART_MSR_DDSR
;
429 if (device_property_read_bool(dev
, "cts-override")) {
430 /* Always report CTS as active */
431 data
->msr_mask_on
|= UART_MSR_CTS
;
432 data
->msr_mask_off
|= UART_MSR_DCTS
;
435 if (device_property_read_bool(dev
, "ri-override")) {
436 /* Always report Ring indicator as inactive */
437 data
->msr_mask_off
|= UART_MSR_RI
;
438 data
->msr_mask_off
|= UART_MSR_TERI
;
441 /* Always ask for fixed clock rate from a property. */
442 device_property_read_u32(dev
, "clock-frequency", &p
->uartclk
);
444 /* If there is separate baudclk, get the rate from it. */
445 data
->clk
= devm_clk_get(dev
, "baudclk");
446 if (IS_ERR(data
->clk
) && PTR_ERR(data
->clk
) != -EPROBE_DEFER
)
447 data
->clk
= devm_clk_get(dev
, NULL
);
448 if (IS_ERR(data
->clk
) && PTR_ERR(data
->clk
) == -EPROBE_DEFER
)
449 return -EPROBE_DEFER
;
450 if (!IS_ERR_OR_NULL(data
->clk
)) {
451 err
= clk_prepare_enable(data
->clk
);
453 dev_warn(dev
, "could not enable optional baudclk: %d\n",
456 p
->uartclk
= clk_get_rate(data
->clk
);
459 /* If no clock rate is defined, fail. */
461 dev_err(dev
, "clock rate not defined\n");
465 data
->pclk
= devm_clk_get(dev
, "apb_pclk");
466 if (IS_ERR(data
->pclk
) && PTR_ERR(data
->pclk
) == -EPROBE_DEFER
) {
470 if (!IS_ERR(data
->pclk
)) {
471 err
= clk_prepare_enable(data
->pclk
);
473 dev_err(dev
, "could not enable apb_pclk\n");
478 data
->rst
= devm_reset_control_get_optional(dev
, NULL
);
479 if (IS_ERR(data
->rst
) && PTR_ERR(data
->rst
) == -EPROBE_DEFER
) {
483 if (!IS_ERR(data
->rst
))
484 reset_control_deassert(data
->rst
);
486 dw8250_quirks(p
, data
);
488 /* If the Busy Functionality is not implemented, don't handle it */
489 if (data
->uart_16550_compatible
)
490 p
->handle_irq
= NULL
;
492 if (!data
->skip_autocfg
)
493 dw8250_setup_port(p
);
495 /* If we have a valid fifosize, try hooking up DMA */
497 data
->dma
.rxconf
.src_maxburst
= p
->fifosize
/ 4;
498 data
->dma
.txconf
.dst_maxburst
= p
->fifosize
/ 4;
499 uart
.dma
= &data
->dma
;
502 data
->line
= serial8250_register_8250_port(&uart
);
503 if (data
->line
< 0) {
508 platform_set_drvdata(pdev
, data
);
510 pm_runtime_set_active(dev
);
511 pm_runtime_enable(dev
);
516 if (!IS_ERR(data
->rst
))
517 reset_control_assert(data
->rst
);
520 if (!IS_ERR(data
->pclk
))
521 clk_disable_unprepare(data
->pclk
);
524 if (!IS_ERR(data
->clk
))
525 clk_disable_unprepare(data
->clk
);
530 static int dw8250_remove(struct platform_device
*pdev
)
532 struct dw8250_data
*data
= platform_get_drvdata(pdev
);
534 pm_runtime_get_sync(&pdev
->dev
);
536 serial8250_unregister_port(data
->line
);
538 if (!IS_ERR(data
->rst
))
539 reset_control_assert(data
->rst
);
541 if (!IS_ERR(data
->pclk
))
542 clk_disable_unprepare(data
->pclk
);
544 if (!IS_ERR(data
->clk
))
545 clk_disable_unprepare(data
->clk
);
547 pm_runtime_disable(&pdev
->dev
);
548 pm_runtime_put_noidle(&pdev
->dev
);
553 #ifdef CONFIG_PM_SLEEP
554 static int dw8250_suspend(struct device
*dev
)
556 struct dw8250_data
*data
= dev_get_drvdata(dev
);
558 serial8250_suspend_port(data
->line
);
563 static int dw8250_resume(struct device
*dev
)
565 struct dw8250_data
*data
= dev_get_drvdata(dev
);
567 serial8250_resume_port(data
->line
);
571 #endif /* CONFIG_PM_SLEEP */
574 static int dw8250_runtime_suspend(struct device
*dev
)
576 struct dw8250_data
*data
= dev_get_drvdata(dev
);
578 if (!IS_ERR(data
->clk
))
579 clk_disable_unprepare(data
->clk
);
581 if (!IS_ERR(data
->pclk
))
582 clk_disable_unprepare(data
->pclk
);
587 static int dw8250_runtime_resume(struct device
*dev
)
589 struct dw8250_data
*data
= dev_get_drvdata(dev
);
591 if (!IS_ERR(data
->pclk
))
592 clk_prepare_enable(data
->pclk
);
594 if (!IS_ERR(data
->clk
))
595 clk_prepare_enable(data
->clk
);
601 static const struct dev_pm_ops dw8250_pm_ops
= {
602 SET_SYSTEM_SLEEP_PM_OPS(dw8250_suspend
, dw8250_resume
)
603 SET_RUNTIME_PM_OPS(dw8250_runtime_suspend
, dw8250_runtime_resume
, NULL
)
606 static const struct of_device_id dw8250_of_match
[] = {
607 { .compatible
= "snps,dw-apb-uart" },
608 { .compatible
= "cavium,octeon-3860-uart" },
611 MODULE_DEVICE_TABLE(of
, dw8250_of_match
);
613 static const struct acpi_device_id dw8250_acpi_match
[] = {
625 MODULE_DEVICE_TABLE(acpi
, dw8250_acpi_match
);
627 static struct platform_driver dw8250_platform_driver
= {
629 .name
= "dw-apb-uart",
630 .pm
= &dw8250_pm_ops
,
631 .of_match_table
= dw8250_of_match
,
632 .acpi_match_table
= ACPI_PTR(dw8250_acpi_match
),
634 .probe
= dw8250_probe
,
635 .remove
= dw8250_remove
,
638 module_platform_driver(dw8250_platform_driver
);
640 MODULE_AUTHOR("Jamie Iles");
641 MODULE_LICENSE("GPL");
642 MODULE_DESCRIPTION("Synopsys DesignWare 8250 serial port driver");
643 MODULE_ALIAS("platform:dw-apb-uart");