projects / deliverable / linux.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge remote-tracking branch 'drm/drm-next'
[deliverable/linux.git] / drivers / tty / serial / 8250 / 8250_dw.c
1 /*
2 * Synopsys DesignWare 8250 driver.
3 *
4 * Copyright 2011 Picochip, Jamie Iles.
5 * Copyright 2013 Intel Corporation
6 *
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.
11 *
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.
15 */
16 #include <linux/device.h>
17 #include <linux/io.h>
18 #include <linux/module.h>
19 #include <linux/serial_8250.h>
20 #include <linux/serial_reg.h>
21 #include <linux/of.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>
30
31 #include <asm/byteorder.h>
32
33 #include "8250.h"
34
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 */
39
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)
55
56
57 struct dw8250_data {
58 u8 usr_reg;
59 int line;
60 int msr_mask_on;
61 int msr_mask_off;
62 struct clk *clk;
63 struct clk *pclk;
64 struct reset_control *rst;
65 struct uart_8250_dma dma;
66
67 unsigned int skip_autocfg:1;
68 unsigned int uart_16550_compatible:1;
69 };
70
71 static inline int dw8250_modify_msr(struct uart_port *p, int offset, int value)
72 {
73 struct dw8250_data *d = p->private_data;
74
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;
79 }
80
81 return value;
82 }
83
84 static void dw8250_force_idle(struct uart_port *p)
85 {
86 struct uart_8250_port *up = up_to_u8250p(p);
87
88 serial8250_clear_and_reinit_fifos(up);
89 (void)p->serial_in(p, UART_RX);
90 }
91
92 static void dw8250_check_lcr(struct uart_port *p, int value)
93 {
94 void __iomem *offset = p->membase + (UART_LCR << p->regshift);
95 int tries = 1000;
96
97 /* Make sure LCR write wasn't ignored */
98 while (tries--) {
99 unsigned int lcr = p->serial_in(p, UART_LCR);
100
101 if ((value & ~UART_LCR_SPAR) == (lcr & ~UART_LCR_SPAR))
102 return;
103
104 dw8250_force_idle(p);
105
106 #ifdef CONFIG_64BIT
107 if (p->type == PORT_OCTEON)
108 __raw_writeq(value & 0xff, offset);
109 else
110 #endif
111 if (p->iotype == UPIO_MEM32)
112 writel(value, offset);
113 else if (p->iotype == UPIO_MEM32BE)
114 iowrite32be(value, offset);
115 else
116 writeb(value, offset);
117 }
118 /*
119 * FIXME: this deadlocks if port->lock is already held
120 * dev_err(p->dev, "Couldn't set LCR to %d\n", value);
121 */
122 }
123
124 static void dw8250_serial_out(struct uart_port *p, int offset, int value)
125 {
126 struct dw8250_data *d = p->private_data;
127
128 writeb(value, p->membase + (offset << p->regshift));
129
130 if (offset == UART_LCR && !d->uart_16550_compatible)
131 dw8250_check_lcr(p, value);
132 }
133
134 static unsigned int dw8250_serial_in(struct uart_port *p, int offset)
135 {
136 unsigned int value = readb(p->membase + (offset << p->regshift));
137
138 return dw8250_modify_msr(p, offset, value);
139 }
140
141 #ifdef CONFIG_64BIT
142 static unsigned int dw8250_serial_inq(struct uart_port *p, int offset)
143 {
144 unsigned int value;
145
146 value = (u8)__raw_readq(p->membase + (offset << p->regshift));
147
148 return dw8250_modify_msr(p, offset, value);
149 }
150
151 static void dw8250_serial_outq(struct uart_port *p, int offset, int value)
152 {
153 struct dw8250_data *d = p->private_data;
154
155 value &= 0xff;
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));
159
160 if (offset == UART_LCR && !d->uart_16550_compatible)
161 dw8250_check_lcr(p, value);
162 }
163 #endif /* CONFIG_64BIT */
164
165 static void dw8250_serial_out32(struct uart_port *p, int offset, int value)
166 {
167 struct dw8250_data *d = p->private_data;
168
169 writel(value, p->membase + (offset << p->regshift));
170
171 if (offset == UART_LCR && !d->uart_16550_compatible)
172 dw8250_check_lcr(p, value);
173 }
174
175 static unsigned int dw8250_serial_in32(struct uart_port *p, int offset)
176 {
177 unsigned int value = readl(p->membase + (offset << p->regshift));
178
179 return dw8250_modify_msr(p, offset, value);
180 }
181
182 static void dw8250_serial_out32be(struct uart_port *p, int offset, int value)
183 {
184 struct dw8250_data *d = p->private_data;
185
186 iowrite32be(value, p->membase + (offset << p->regshift));
187
188 if (offset == UART_LCR && !d->uart_16550_compatible)
189 dw8250_check_lcr(p, value);
190 }
191
192 static unsigned int dw8250_serial_in32be(struct uart_port *p, int offset)
193 {
194 unsigned int value = ioread32be(p->membase + (offset << p->regshift));
195
196 return dw8250_modify_msr(p, offset, value);
197 }
198
199
200 static int dw8250_handle_irq(struct uart_port *p)
201 {
202 struct dw8250_data *d = p->private_data;
203 unsigned int iir = p->serial_in(p, UART_IIR);
204
205 if (serial8250_handle_irq(p, iir))
206 return 1;
207
208 if ((iir & UART_IIR_BUSY) == UART_IIR_BUSY) {
209 /* Clear the USR */
210 (void)p->serial_in(p, d->usr_reg);
211
212 return 1;
213 }
214
215 return 0;
216 }
217
218 static void
219 dw8250_do_pm(struct uart_port *port, unsigned int state, unsigned int old)
220 {
221 if (!state)
222 pm_runtime_get_sync(port->dev);
223
224 serial8250_do_pm(port, state, old);
225
226 if (state)
227 pm_runtime_put_sync_suspend(port->dev);
228 }
229
230 static void dw8250_set_termios(struct uart_port *p, struct ktermios *termios,
231 struct ktermios *old)
232 {
233 unsigned int baud = tty_termios_baud_rate(termios);
234 struct dw8250_data *d = p->private_data;
235 unsigned int rate;
236 int ret;
237
238 if (IS_ERR(d->clk) || !old)
239 goto out;
240
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);
245
246 if (!ret)
247 p->uartclk = rate;
248
249 p->status &= ~UPSTAT_AUTOCTS;
250 if (termios->c_cflag & CRTSCTS)
251 p->status |= UPSTAT_AUTOCTS;
252
253 out:
254 serial8250_do_set_termios(p, termios, old);
255 }
256
257 /*
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.
261 *
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.
264 */
265 static bool dw8250_fallback_dma_filter(struct dma_chan *chan, void *param)
266 {
267 return false;
268 }
269
270 static bool dw8250_idma_filter(struct dma_chan *chan, void *param)
271 {
272 return param == chan->device->dev->parent;
273 }
274
275 static void dw8250_quirks(struct uart_port *p, struct dw8250_data *data)
276 {
277 if (p->dev->of_node) {
278 struct device_node *np = p->dev->of_node;
279 int id;
280
281 /* get index of serial line, if found in DT aliases */
282 id = of_alias_get_id(np, "serial");
283 if (id >= 0)
284 p->line = id;
285 #ifdef CONFIG_64BIT
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;
293 }
294 #endif
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;
299 }
300 } else if (has_acpi_companion(p->dev)) {
301 const struct acpi_device_id *id;
302
303 id = acpi_match_device(p->dev->driver->acpi_match_table,
304 p->dev);
305 if (id && !strcmp(id->id, "APMC0D08")) {
306 p->iotype = UPIO_MEM32;
307 p->regshift = 2;
308 p->serial_in = dw8250_serial_in32;
309 data->uart_16550_compatible = true;
310 }
311 p->set_termios = dw8250_set_termios;
312 }
313
314 /* Platforms with iDMA */
315 if (platform_get_resource_byname(to_platform_device(p->dev),
316 IORESOURCE_MEM, "lpss_priv")) {
317 p->set_termios = dw8250_set_termios;
318 data->dma.rx_param = p->dev->parent;
319 data->dma.tx_param = p->dev->parent;
320 data->dma.fn = dw8250_idma_filter;
321 }
322 }
323
324 static void dw8250_setup_port(struct uart_port *p)
325 {
326 struct uart_8250_port *up = up_to_u8250p(p);
327 u32 reg;
328
329 /*
330 * If the Component Version Register returns zero, we know that
331 * ADDITIONAL_FEATURES are not enabled. No need to go any further.
332 */
333 if (p->iotype == UPIO_MEM32BE)
334 reg = ioread32be(p->membase + DW_UART_UCV);
335 else
336 reg = readl(p->membase + DW_UART_UCV);
337 if (!reg)
338 return;
339
340 dev_dbg(p->dev, "Designware UART version %c.%c%c\n",
341 (reg >> 24) & 0xff, (reg >> 16) & 0xff, (reg >> 8) & 0xff);
342
343 if (p->iotype == UPIO_MEM32BE)
344 reg = ioread32be(p->membase + DW_UART_CPR);
345 else
346 reg = readl(p->membase + DW_UART_CPR);
347 if (!reg)
348 return;
349
350 /* Select the type based on fifo */
351 if (reg & DW_UART_CPR_FIFO_MODE) {
352 p->type = PORT_16550A;
353 p->flags |= UPF_FIXED_TYPE;
354 p->fifosize = DW_UART_CPR_FIFO_SIZE(reg);
355 up->capabilities = UART_CAP_FIFO;
356 }
357
358 if (reg & DW_UART_CPR_AFCE_MODE)
359 up->capabilities |= UART_CAP_AFE;
360 }
361
362 static int dw8250_probe(struct platform_device *pdev)
363 {
364 struct uart_8250_port uart = {};
365 struct resource *regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
366 int irq = platform_get_irq(pdev, 0);
367 struct uart_port *p = &uart.port;
368 struct dw8250_data *data;
369 int err;
370 u32 val;
371
372 if (!regs) {
373 dev_err(&pdev->dev, "no registers defined\n");
374 return -EINVAL;
375 }
376
377 if (irq < 0) {
378 if (irq != -EPROBE_DEFER)
379 dev_err(&pdev->dev, "cannot get irq\n");
380 return irq;
381 }
382
383 spin_lock_init(&p->lock);
384 p->mapbase = regs->start;
385 p->irq = irq;
386 p->handle_irq = dw8250_handle_irq;
387 p->pm = dw8250_do_pm;
388 p->type = PORT_8250;
389 p->flags = UPF_SHARE_IRQ | UPF_FIXED_PORT;
390 p->dev = &pdev->dev;
391 p->iotype = UPIO_MEM;
392 p->serial_in = dw8250_serial_in;
393 p->serial_out = dw8250_serial_out;
394
395 p->membase = devm_ioremap(&pdev->dev, regs->start, resource_size(regs));
396 if (!p->membase)
397 return -ENOMEM;
398
399 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
400 if (!data)
401 return -ENOMEM;
402
403 data->dma.fn = dw8250_fallback_dma_filter;
404 data->usr_reg = DW_UART_USR;
405 p->private_data = data;
406
407 data->uart_16550_compatible = device_property_read_bool(p->dev,
408 "snps,uart-16550-compatible");
409
410 err = device_property_read_u32(p->dev, "reg-shift", &val);
411 if (!err)
412 p->regshift = val;
413
414 err = device_property_read_u32(p->dev, "reg-io-width", &val);
415 if (!err && val == 4) {
416 p->iotype = UPIO_MEM32;
417 p->serial_in = dw8250_serial_in32;
418 p->serial_out = dw8250_serial_out32;
419 }
420
421 if (device_property_read_bool(p->dev, "dcd-override")) {
422 /* Always report DCD as active */
423 data->msr_mask_on |= UART_MSR_DCD;
424 data->msr_mask_off |= UART_MSR_DDCD;
425 }
426
427 if (device_property_read_bool(p->dev, "dsr-override")) {
428 /* Always report DSR as active */
429 data->msr_mask_on |= UART_MSR_DSR;
430 data->msr_mask_off |= UART_MSR_DDSR;
431 }
432
433 if (device_property_read_bool(p->dev, "cts-override")) {
434 /* Always report CTS as active */
435 data->msr_mask_on |= UART_MSR_CTS;
436 data->msr_mask_off |= UART_MSR_DCTS;
437 }
438
439 if (device_property_read_bool(p->dev, "ri-override")) {
440 /* Always report Ring indicator as inactive */
441 data->msr_mask_off |= UART_MSR_RI;
442 data->msr_mask_off |= UART_MSR_TERI;
443 }
444
445 /* Always ask for fixed clock rate from a property. */
446 device_property_read_u32(p->dev, "clock-frequency", &p->uartclk);
447
448 /* If there is separate baudclk, get the rate from it. */
449 data->clk = devm_clk_get(&pdev->dev, "baudclk");
450 if (IS_ERR(data->clk) && PTR_ERR(data->clk) != -EPROBE_DEFER)
451 data->clk = devm_clk_get(&pdev->dev, NULL);
452 if (IS_ERR(data->clk) && PTR_ERR(data->clk) == -EPROBE_DEFER)
453 return -EPROBE_DEFER;
454 if (!IS_ERR_OR_NULL(data->clk)) {
455 err = clk_prepare_enable(data->clk);
456 if (err)
457 dev_warn(&pdev->dev, "could not enable optional baudclk: %d\n",
458 err);
459 else
460 p->uartclk = clk_get_rate(data->clk);
461 }
462
463 /* If no clock rate is defined, fail. */
464 if (!p->uartclk) {
465 dev_err(&pdev->dev, "clock rate not defined\n");
466 return -EINVAL;
467 }
468
469 data->pclk = devm_clk_get(&pdev->dev, "apb_pclk");
470 if (IS_ERR(data->clk) && PTR_ERR(data->clk) == -EPROBE_DEFER) {
471 err = -EPROBE_DEFER;
472 goto err_clk;
473 }
474 if (!IS_ERR(data->pclk)) {
475 err = clk_prepare_enable(data->pclk);
476 if (err) {
477 dev_err(&pdev->dev, "could not enable apb_pclk\n");
478 goto err_clk;
479 }
480 }
481
482 data->rst = devm_reset_control_get_optional(&pdev->dev, NULL);
483 if (IS_ERR(data->rst) && PTR_ERR(data->rst) == -EPROBE_DEFER) {
484 err = -EPROBE_DEFER;
485 goto err_pclk;
486 }
487 if (!IS_ERR(data->rst))
488 reset_control_deassert(data->rst);
489
490 dw8250_quirks(p, data);
491
492 /* If the Busy Functionality is not implemented, don't handle it */
493 if (data->uart_16550_compatible)
494 p->handle_irq = NULL;
495
496 if (!data->skip_autocfg)
497 dw8250_setup_port(p);
498
499 /* If we have a valid fifosize, try hooking up DMA */
500 if (p->fifosize) {
501 data->dma.rxconf.src_maxburst = p->fifosize / 4;
502 data->dma.txconf.dst_maxburst = p->fifosize / 4;
503 uart.dma = &data->dma;
504 }
505
506 data->line = serial8250_register_8250_port(&uart);
507 if (data->line < 0) {
508 err = data->line;
509 goto err_reset;
510 }
511
512 platform_set_drvdata(pdev, data);
513
514 pm_runtime_set_active(&pdev->dev);
515 pm_runtime_enable(&pdev->dev);
516
517 return 0;
518
519 err_reset:
520 if (!IS_ERR(data->rst))
521 reset_control_assert(data->rst);
522
523 err_pclk:
524 if (!IS_ERR(data->pclk))
525 clk_disable_unprepare(data->pclk);
526
527 err_clk:
528 if (!IS_ERR(data->clk))
529 clk_disable_unprepare(data->clk);
530
531 return err;
532 }
533
534 static int dw8250_remove(struct platform_device *pdev)
535 {
536 struct dw8250_data *data = platform_get_drvdata(pdev);
537
538 pm_runtime_get_sync(&pdev->dev);
539
540 serial8250_unregister_port(data->line);
541
542 if (!IS_ERR(data->rst))
543 reset_control_assert(data->rst);
544
545 if (!IS_ERR(data->pclk))
546 clk_disable_unprepare(data->pclk);
547
548 if (!IS_ERR(data->clk))
549 clk_disable_unprepare(data->clk);
550
551 pm_runtime_disable(&pdev->dev);
552 pm_runtime_put_noidle(&pdev->dev);
553
554 return 0;
555 }
556
557 #ifdef CONFIG_PM_SLEEP
558 static int dw8250_suspend(struct device *dev)
559 {
560 struct dw8250_data *data = dev_get_drvdata(dev);
561
562 serial8250_suspend_port(data->line);
563
564 return 0;
565 }
566
567 static int dw8250_resume(struct device *dev)
568 {
569 struct dw8250_data *data = dev_get_drvdata(dev);
570
571 serial8250_resume_port(data->line);
572
573 return 0;
574 }
575 #endif /* CONFIG_PM_SLEEP */
576
577 #ifdef CONFIG_PM
578 static int dw8250_runtime_suspend(struct device *dev)
579 {
580 struct dw8250_data *data = dev_get_drvdata(dev);
581
582 if (!IS_ERR(data->clk))
583 clk_disable_unprepare(data->clk);
584
585 if (!IS_ERR(data->pclk))
586 clk_disable_unprepare(data->pclk);
587
588 return 0;
589 }
590
591 static int dw8250_runtime_resume(struct device *dev)
592 {
593 struct dw8250_data *data = dev_get_drvdata(dev);
594
595 if (!IS_ERR(data->pclk))
596 clk_prepare_enable(data->pclk);
597
598 if (!IS_ERR(data->clk))
599 clk_prepare_enable(data->clk);
600
601 return 0;
602 }
603 #endif
604
605 static const struct dev_pm_ops dw8250_pm_ops = {
606 SET_SYSTEM_SLEEP_PM_OPS(dw8250_suspend, dw8250_resume)
607 SET_RUNTIME_PM_OPS(dw8250_runtime_suspend, dw8250_runtime_resume, NULL)
608 };
609
610 static const struct of_device_id dw8250_of_match[] = {
611 { .compatible = "snps,dw-apb-uart" },
612 { .compatible = "cavium,octeon-3860-uart" },
613 { /* Sentinel */ }
614 };
615 MODULE_DEVICE_TABLE(of, dw8250_of_match);
616
617 static const struct acpi_device_id dw8250_acpi_match[] = {
618 { "INT33C4", 0 },
619 { "INT33C5", 0 },
620 { "INT3434", 0 },
621 { "INT3435", 0 },
622 { "80860F0A", 0 },
623 { "8086228A", 0 },
624 { "APMC0D08", 0},
625 { "AMD0020", 0 },
626 { "AMDI0020", 0 },
627 { },
628 };
629 MODULE_DEVICE_TABLE(acpi, dw8250_acpi_match);
630
631 static struct platform_driver dw8250_platform_driver = {
632 .driver = {
633 .name = "dw-apb-uart",
634 .pm = &dw8250_pm_ops,
635 .of_match_table = dw8250_of_match,
636 .acpi_match_table = ACPI_PTR(dw8250_acpi_match),
637 },
638 .probe = dw8250_probe,
639 .remove = dw8250_remove,
640 };
641
642 module_platform_driver(dw8250_platform_driver);
643
644 MODULE_AUTHOR("Jamie Iles");
645 MODULE_LICENSE("GPL");
646 MODULE_DESCRIPTION("Synopsys DesignWare 8250 serial port driver");
647 MODULE_ALIAS("platform:dw-apb-uart");
Linux kernel - Deliverables
This page took 0.045204 seconds and 6 git commands to generate.