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