drivers/tty/serial/8250/8250_omap.c

   1 /*
   2  * 8250-core based driver for the OMAP internal UART
   3  *
   4  * based on omap-serial.c, Copyright (C) 2010 Texas Instruments.
   5  *
   6  * Copyright (C) 2014 Sebastian Andrzej Siewior
   7  *
   8  */
   9
  10 #include <linux/device.h>
  11 #include <linux/io.h>
  12 #include <linux/module.h>
  13 #include <linux/serial_8250.h>
  14 #include <linux/serial_reg.h>
  15 #include <linux/tty_flip.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/slab.h>
  18 #include <linux/of.h>
  19 #include <linux/of_device.h>
  20 #include <linux/of_gpio.h>
  21 #include <linux/of_irq.h>
  22 #include <linux/delay.h>
  23 #include <linux/pm_runtime.h>
  24 #include <linux/console.h>
  25 #include <linux/pm_qos.h>
  26 #include <linux/pm_wakeirq.h>
  27 #include <linux/dma-mapping.h>
  28
  29 #include "8250.h"
  30
  31 #define DEFAULT_CLK_SPEED       48000000
  32
  33 #define UART_ERRATA_i202_MDR1_ACCESS    (1 << 0)
  34 #define OMAP_UART_WER_HAS_TX_WAKEUP     (1 << 1)
  35 #define OMAP_DMA_TX_KICK                (1 << 2)
  36 /*
  37  * See Advisory 21 in AM437x errata SPRZ408B, updated April 2015.
  38  * The same errata is applicable to AM335x and DRA7x processors too.
  39  */
  40 #define UART_ERRATA_CLOCK_DISABLE       (1 << 3)
  41
  42 #define OMAP_UART_FCR_RX_TRIG           6
  43 #define OMAP_UART_FCR_TX_TRIG           4
  44
  45 /* SCR register bitmasks */
  46 #define OMAP_UART_SCR_RX_TRIG_GRANU1_MASK       (1 << 7)
  47 #define OMAP_UART_SCR_TX_TRIG_GRANU1_MASK       (1 << 6)
  48 #define OMAP_UART_SCR_TX_EMPTY                  (1 << 3)
  49 #define OMAP_UART_SCR_DMAMODE_MASK              (3 << 1)
  50 #define OMAP_UART_SCR_DMAMODE_1                 (1 << 1)
  51 #define OMAP_UART_SCR_DMAMODE_CTL               (1 << 0)
  52
  53 /* MVR register bitmasks */
  54 #define OMAP_UART_MVR_SCHEME_SHIFT      30
  55 #define OMAP_UART_LEGACY_MVR_MAJ_MASK   0xf0
  56 #define OMAP_UART_LEGACY_MVR_MAJ_SHIFT  4
  57 #define OMAP_UART_LEGACY_MVR_MIN_MASK   0x0f
  58 #define OMAP_UART_MVR_MAJ_MASK          0x700
  59 #define OMAP_UART_MVR_MAJ_SHIFT         8
  60 #define OMAP_UART_MVR_MIN_MASK          0x3f
  61
  62 /* SYSC register bitmasks */
  63 #define OMAP_UART_SYSC_SOFTRESET        (1 << 1)
  64
  65 /* SYSS register bitmasks */
  66 #define OMAP_UART_SYSS_RESETDONE        (1 << 0)
  67
  68 #define UART_TI752_TLR_TX       0
  69 #define UART_TI752_TLR_RX       4
  70
  71 #define TRIGGER_TLR_MASK(x)     ((x & 0x3c) >> 2)
  72 #define TRIGGER_FCR_MASK(x)     (x & 3)
  73
  74 /* Enable XON/XOFF flow control on output */
  75 #define OMAP_UART_SW_TX         0x08
  76 /* Enable XON/XOFF flow control on input */
  77 #define OMAP_UART_SW_RX         0x02
  78
  79 #define OMAP_UART_WER_MOD_WKUP  0x7f
  80 #define OMAP_UART_TX_WAKEUP_EN  (1 << 7)
  81
  82 #define TX_TRIGGER      1
  83 #define RX_TRIGGER      48
  84
  85 #define OMAP_UART_TCR_RESTORE(x)        ((x / 4) << 4)
  86 #define OMAP_UART_TCR_HALT(x)           ((x / 4) << 0)
  87
  88 #define UART_BUILD_REVISION(x, y)       (((x) << 8) | (y))
  89
  90 #define OMAP_UART_REV_46 0x0406
  91 #define OMAP_UART_REV_52 0x0502
  92 #define OMAP_UART_REV_63 0x0603
  93
  94 struct omap8250_priv {
  95         int line;
  96         u8 habit;
  97         u8 mdr1;
  98         u8 efr;
  99         u8 scr;
 100         u8 wer;
 101         u8 xon;
 102         u8 xoff;
 103         u8 delayed_restore;
 104         u16 quot;
 105
 106         bool is_suspending;
 107         int wakeirq;
 108         int wakeups_enabled;
 109         u32 latency;
 110         u32 calc_latency;
 111         struct pm_qos_request pm_qos_request;
 112         struct work_struct qos_work;
 113         struct uart_8250_dma omap8250_dma;
 114         spinlock_t rx_dma_lock;
 115         bool rx_dma_broken;
 116 };
 117
 118 static u32 uart_read(struct uart_8250_port *up, u32 reg)
 119 {
 120         return readl(up->port.membase + (reg << up->port.regshift));
 121 }
 122
 123 static void omap8250_set_mctrl(struct uart_port *port, unsigned int mctrl)
 124 {
 125         struct uart_8250_port *up = up_to_u8250p(port);
 126         struct omap8250_priv *priv = up->port.private_data;
 127         u8 lcr;
 128
 129         serial8250_do_set_mctrl(port, mctrl);
 130
 131         /*
 132          * Turn off autoRTS if RTS is lowered and restore autoRTS setting
 133          * if RTS is raised
 134          */
 135         lcr = serial_in(up, UART_LCR);
 136         serial_out(up, UART_LCR, UART_LCR_CONF_MODE_B);
 137         if ((mctrl & TIOCM_RTS) && (port->status & UPSTAT_AUTORTS))
 138                 priv->efr |= UART_EFR_RTS;
 139         else
 140                 priv->efr &= ~UART_EFR_RTS;
 141         serial_out(up, UART_EFR, priv->efr);
 142         serial_out(up, UART_LCR, lcr);
 143 }
 144
 145 /*
 146  * Work Around for Errata i202 (2430, 3430, 3630, 4430 and 4460)
 147  * The access to uart register after MDR1 Access
 148  * causes UART to corrupt data.
 149  *
 150  * Need a delay =
 151  * 5 L4 clock cycles + 5 UART functional clock cycle (@48MHz = ~0.2uS)
 152  * give 10 times as much
 153  */
 154 static void omap_8250_mdr1_errataset(struct uart_8250_port *up,
 155                                      struct omap8250_priv *priv)
 156 {
 157         u8 timeout = 255;
 158         u8 old_mdr1;
 159
 160         old_mdr1 = serial_in(up, UART_OMAP_MDR1);
 161         if (old_mdr1 == priv->mdr1)
 162                 return;
 163
 164         serial_out(up, UART_OMAP_MDR1, priv->mdr1);
 165         udelay(2);
 166         serial_out(up, UART_FCR, up->fcr | UART_FCR_CLEAR_XMIT |
 167                         UART_FCR_CLEAR_RCVR);
 168         /*
 169          * Wait for FIFO to empty: when empty, RX_FIFO_E bit is 0 and
 170          * TX_FIFO_E bit is 1.
 171          */
 172         while (UART_LSR_THRE != (serial_in(up, UART_LSR) &
 173                                 (UART_LSR_THRE | UART_LSR_DR))) {
 174                 timeout--;
 175                 if (!timeout) {
 176                         /* Should *never* happen. we warn and carry on */
 177                         dev_crit(up->port.dev, "Errata i202: timedout %x\n",
 178                                  serial_in(up, UART_LSR));
 179                         break;
 180                 }
 181                 udelay(1);
 182         }
 183 }
 184
 185 static void omap_8250_get_divisor(struct uart_port *port, unsigned int baud,
 186                                   struct omap8250_priv *priv)
 187 {
 188         unsigned int uartclk = port->uartclk;
 189         unsigned int div_13, div_16;
 190         unsigned int abs_d13, abs_d16;
 191
 192         /*
 193          * Old custom speed handling.
 194          */
 195         if (baud == 38400 && (port->flags & UPF_SPD_MASK) == UPF_SPD_CUST) {
 196                 priv->quot = port->custom_divisor & 0xffff;
 197                 /*
 198                  * I assume that nobody is using this. But hey, if somebody
 199                  * would like to specify the divisor _and_ the mode then the
 200                  * driver is ready and waiting for it.
 201                  */
 202                 if (port->custom_divisor & (1 << 16))
 203                         priv->mdr1 = UART_OMAP_MDR1_13X_MODE;
 204                 else
 205                         priv->mdr1 = UART_OMAP_MDR1_16X_MODE;
 206                 return;
 207         }
 208         div_13 = DIV_ROUND_CLOSEST(uartclk, 13 * baud);
 209         div_16 = DIV_ROUND_CLOSEST(uartclk, 16 * baud);
 210
 211         if (!div_13)
 212                 div_13 = 1;
 213         if (!div_16)
 214                 div_16 = 1;
 215
 216         abs_d13 = abs(baud - uartclk / 13 / div_13);
 217         abs_d16 = abs(baud - uartclk / 16 / div_16);
 218
 219         if (abs_d13 >= abs_d16) {
 220                 priv->mdr1 = UART_OMAP_MDR1_16X_MODE;
 221                 priv->quot = div_16;
 222         } else {
 223                 priv->mdr1 = UART_OMAP_MDR1_13X_MODE;
 224                 priv->quot = div_13;
 225         }
 226 }
 227
 228 static void omap8250_update_scr(struct uart_8250_port *up,
 229                                 struct omap8250_priv *priv)
 230 {
 231         u8 old_scr;
 232
 233         old_scr = serial_in(up, UART_OMAP_SCR);
 234         if (old_scr == priv->scr)
 235                 return;
 236
 237         /*
 238          * The manual recommends not to enable the DMA mode selector in the SCR
 239          * (instead of the FCR) register _and_ selecting the DMA mode as one
 240          * register write because this may lead to malfunction.
 241          */
 242         if (priv->scr & OMAP_UART_SCR_DMAMODE_MASK)
 243                 serial_out(up, UART_OMAP_SCR,
 244                            priv->scr & ~OMAP_UART_SCR_DMAMODE_MASK);
 245         serial_out(up, UART_OMAP_SCR, priv->scr);
 246 }
 247
 248 static void omap8250_update_mdr1(struct uart_8250_port *up,
 249                                  struct omap8250_priv *priv)
 250 {
 251         if (priv->habit & UART_ERRATA_i202_MDR1_ACCESS)
 252                 omap_8250_mdr1_errataset(up, priv);
 253         else
 254                 serial_out(up, UART_OMAP_MDR1, priv->mdr1);
 255 }
 256
 257 static void omap8250_restore_regs(struct uart_8250_port *up)
 258 {
 259         struct omap8250_priv *priv = up->port.private_data;
 260         struct uart_8250_dma    *dma = up->dma;
 261
 262         if (dma && dma->tx_running) {
 263                 /*
 264                  * TCSANOW requests the change to occur immediately however if
 265                  * we have a TX-DMA operation in progress then it has been
 266                  * observed that it might stall and never complete. Therefore we
 267                  * delay DMA completes to prevent this hang from happen.
 268                  */
 269                 priv->delayed_restore = 1;
 270                 return;
 271         }
 272
 273         serial_out(up, UART_LCR, UART_LCR_CONF_MODE_B);
 274         serial_out(up, UART_EFR, UART_EFR_ECB);
 275
 276         serial_out(up, UART_LCR, UART_LCR_CONF_MODE_A);
 277         serial_out(up, UART_MCR, UART_MCR_TCRTLR);
 278         serial_out(up, UART_FCR, up->fcr);
 279
 280         omap8250_update_scr(up, priv);
 281
 282         serial_out(up, UART_LCR, UART_LCR_CONF_MODE_B);
 283
 284         serial_out(up, UART_TI752_TCR, OMAP_UART_TCR_RESTORE(16) |
 285                         OMAP_UART_TCR_HALT(52));
 286         serial_out(up, UART_TI752_TLR,
 287                    TRIGGER_TLR_MASK(TX_TRIGGER) << UART_TI752_TLR_TX |
 288                    TRIGGER_TLR_MASK(RX_TRIGGER) << UART_TI752_TLR_RX);
 289
 290         serial_out(up, UART_LCR, 0);
 291
 292         /* drop TCR + TLR access, we setup XON/XOFF later */
 293         serial_out(up, UART_MCR, up->mcr);
 294         serial_out(up, UART_IER, up->ier);
 295
 296         serial_out(up, UART_LCR, UART_LCR_CONF_MODE_B);
 297         serial_dl_write(up, priv->quot);
 298
 299         serial_out(up, UART_EFR, priv->efr);
 300
 301         /* Configure flow control */
 302         serial_out(up, UART_LCR, UART_LCR_CONF_MODE_B);
 303         serial_out(up, UART_XON1, priv->xon);
 304         serial_out(up, UART_XOFF1, priv->xoff);
 305
 306         serial_out(up, UART_LCR, up->lcr);
 307
 308         omap8250_update_mdr1(up, priv);
 309
 310         up->port.ops->set_mctrl(&up->port, up->port.mctrl);
 311 }
 312
 313 /*
 314  * OMAP can use "CLK / (16 or 13) / div" for baud rate. And then we have have
 315  * some differences in how we want to handle flow control.
 316  */
 317 static void omap_8250_set_termios(struct uart_port *port,
 318                                   struct ktermios *termios,
 319                                   struct ktermios *old)
 320 {
 321         struct uart_8250_port *up =
 322                 container_of(port, struct uart_8250_port, port);
 323         struct omap8250_priv *priv = up->port.private_data;
 324         unsigned char cval = 0;
 325         unsigned int baud;
 326
 327         switch (termios->c_cflag & CSIZE) {
 328         case CS5:
 329                 cval = UART_LCR_WLEN5;
 330                 break;
 331         case CS6:
 332                 cval = UART_LCR_WLEN6;
 333                 break;
 334         case CS7:
 335                 cval = UART_LCR_WLEN7;
 336                 break;
 337         default:
 338         case CS8:
 339                 cval = UART_LCR_WLEN8;
 340                 break;
 341         }
 342
 343         if (termios->c_cflag & CSTOPB)
 344                 cval |= UART_LCR_STOP;
 345         if (termios->c_cflag & PARENB)
 346                 cval |= UART_LCR_PARITY;
 347         if (!(termios->c_cflag & PARODD))
 348                 cval |= UART_LCR_EPAR;
 349         if (termios->c_cflag & CMSPAR)
 350                 cval |= UART_LCR_SPAR;
 351
 352         /*
 353          * Ask the core to calculate the divisor for us.
 354          */
 355         baud = uart_get_baud_rate(port, termios, old,
 356                                   port->uartclk / 16 / 0xffff,
 357                                   port->uartclk / 13);
 358         omap_8250_get_divisor(port, baud, priv);
 359
 360         /*
 361          * Ok, we're now changing the port state. Do it with
 362          * interrupts disabled.
 363          */
 364         pm_runtime_get_sync(port->dev);
 365         spin_lock_irq(&port->lock);
 366
 367         /*
 368          * Update the per-port timeout.
 369          */
 370         uart_update_timeout(port, termios->c_cflag, baud);
 371
 372         up->port.read_status_mask = UART_LSR_OE | UART_LSR_THRE | UART_LSR_DR;
 373         if (termios->c_iflag & INPCK)
 374                 up->port.read_status_mask |= UART_LSR_FE | UART_LSR_PE;
 375         if (termios->c_iflag & (IGNBRK | PARMRK))
 376                 up->port.read_status_mask |= UART_LSR_BI;
 377
 378         /*
 379          * Characters to ignore
 380          */
 381         up->port.ignore_status_mask = 0;
 382         if (termios->c_iflag & IGNPAR)
 383                 up->port.ignore_status_mask |= UART_LSR_PE | UART_LSR_FE;
 384         if (termios->c_iflag & IGNBRK) {
 385                 up->port.ignore_status_mask |= UART_LSR_BI;
 386                 /*
 387                  * If we're ignoring parity and break indicators,
 388                  * ignore overruns too (for real raw support).
 389                  */
 390                 if (termios->c_iflag & IGNPAR)
 391                         up->port.ignore_status_mask |= UART_LSR_OE;
 392         }
 393
 394         /*
 395          * ignore all characters if CREAD is not set
 396          */
 397         if ((termios->c_cflag & CREAD) == 0)
 398                 up->port.ignore_status_mask |= UART_LSR_DR;
 399
 400         /*
 401          * Modem status interrupts
 402          */
 403         up->ier &= ~UART_IER_MSI;
 404         if (UART_ENABLE_MS(&up->port, termios->c_cflag))
 405                 up->ier |= UART_IER_MSI;
 406
 407         up->lcr = cval;
 408         /* Up to here it was mostly serial8250_do_set_termios() */
 409
 410         /*
 411          * We enable TRIG_GRANU for RX and TX and additionaly we set
 412          * SCR_TX_EMPTY bit. The result is the following:
 413          * - RX_TRIGGER amount of bytes in the FIFO will cause an interrupt.
 414          * - less than RX_TRIGGER number of bytes will also cause an interrupt
 415          *   once the UART decides that there no new bytes arriving.
 416          * - Once THRE is enabled, the interrupt will be fired once the FIFO is
 417          *   empty - the trigger level is ignored here.
 418          *
 419          * Once DMA is enabled:
 420          * - UART will assert the TX DMA line once there is room for TX_TRIGGER
 421          *   bytes in the TX FIFO. On each assert the DMA engine will move
 422          *   TX_TRIGGER bytes into the FIFO.
 423          * - UART will assert the RX DMA line once there are RX_TRIGGER bytes in
 424          *   the FIFO and move RX_TRIGGER bytes.
 425          * This is because threshold and trigger values are the same.
 426          */
 427         up->fcr = UART_FCR_ENABLE_FIFO;
 428         up->fcr |= TRIGGER_FCR_MASK(TX_TRIGGER) << OMAP_UART_FCR_TX_TRIG;
 429         up->fcr |= TRIGGER_FCR_MASK(RX_TRIGGER) << OMAP_UART_FCR_RX_TRIG;
 430
 431         priv->scr = OMAP_UART_SCR_RX_TRIG_GRANU1_MASK | OMAP_UART_SCR_TX_EMPTY |
 432                 OMAP_UART_SCR_TX_TRIG_GRANU1_MASK;
 433
 434         if (up->dma)
 435                 priv->scr |= OMAP_UART_SCR_DMAMODE_1 |
 436                         OMAP_UART_SCR_DMAMODE_CTL;
 437
 438         priv->xon = termios->c_cc[VSTART];
 439         priv->xoff = termios->c_cc[VSTOP];
 440
 441         priv->efr = 0;
 442         up->port.status &= ~(UPSTAT_AUTOCTS | UPSTAT_AUTORTS | UPSTAT_AUTOXOFF);
 443
 444         if (termios->c_cflag & CRTSCTS && up->port.flags & UPF_HARD_FLOW) {
 445                 /* Enable AUTOCTS (autoRTS is enabled when RTS is raised) */
 446                 up->port.status |= UPSTAT_AUTOCTS | UPSTAT_AUTORTS;
 447                 priv->efr |= UART_EFR_CTS;
 448         } else  if (up->port.flags & UPF_SOFT_FLOW) {
 449                 /*
 450                  * OMAP rx s/w flow control is borked; the transmitter remains
 451                  * stuck off even if rx flow control is subsequently disabled
 452                  */
 453
 454                 /*
 455                  * IXOFF Flag:
 456                  * Enable XON/XOFF flow control on output.
 457                  * Transmit XON1, XOFF1
 458                  */
 459                 if (termios->c_iflag & IXOFF) {
 460                         up->port.status |= UPSTAT_AUTOXOFF;
 461                         priv->efr |= OMAP_UART_SW_TX;
 462                 }
 463         }
 464         omap8250_restore_regs(up);
 465
 466         spin_unlock_irq(&up->port.lock);
 467         pm_runtime_mark_last_busy(port->dev);
 468         pm_runtime_put_autosuspend(port->dev);
 469
 470         /* calculate wakeup latency constraint */
 471         priv->calc_latency = USEC_PER_SEC * 64 * 8 / baud;
 472         priv->latency = priv->calc_latency;
 473
 474         schedule_work(&priv->qos_work);
 475
 476         /* Don't rewrite B0 */
 477         if (tty_termios_baud_rate(termios))
 478                 tty_termios_encode_baud_rate(termios, baud, baud);
 479 }
 480
 481 /* same as 8250 except that we may have extra flow bits set in EFR */
 482 static void omap_8250_pm(struct uart_port *port, unsigned int state,
 483                          unsigned int oldstate)
 484 {
 485         struct uart_8250_port *up = up_to_u8250p(port);
 486         u8 efr;
 487
 488         pm_runtime_get_sync(port->dev);
 489         serial_out(up, UART_LCR, UART_LCR_CONF_MODE_B);
 490         efr = serial_in(up, UART_EFR);
 491         serial_out(up, UART_EFR, efr | UART_EFR_ECB);
 492         serial_out(up, UART_LCR, 0);
 493
 494         serial_out(up, UART_IER, (state != 0) ? UART_IERX_SLEEP : 0);
 495         serial_out(up, UART_LCR, UART_LCR_CONF_MODE_B);
 496         serial_out(up, UART_EFR, efr);
 497         serial_out(up, UART_LCR, 0);
 498
 499         pm_runtime_mark_last_busy(port->dev);
 500         pm_runtime_put_autosuspend(port->dev);
 501 }
 502
 503 static void omap_serial_fill_features_erratas(struct uart_8250_port *up,
 504                                               struct omap8250_priv *priv)
 505 {
 506         u32 mvr, scheme;
 507         u16 revision, major, minor;
 508
 509         mvr = uart_read(up, UART_OMAP_MVER);
 510
 511         /* Check revision register scheme */
 512         scheme = mvr >> OMAP_UART_MVR_SCHEME_SHIFT;
 513
 514         switch (scheme) {
 515         case 0: /* Legacy Scheme: OMAP2/3 */
 516                 /* MINOR_REV[0:4], MAJOR_REV[4:7] */
 517                 major = (mvr & OMAP_UART_LEGACY_MVR_MAJ_MASK) >>
 518                         OMAP_UART_LEGACY_MVR_MAJ_SHIFT;
 519                 minor = (mvr & OMAP_UART_LEGACY_MVR_MIN_MASK);
 520                 break;
 521         case 1:
 522                 /* New Scheme: OMAP4+ */
 523                 /* MINOR_REV[0:5], MAJOR_REV[8:10] */
 524                 major = (mvr & OMAP_UART_MVR_MAJ_MASK) >>
 525                         OMAP_UART_MVR_MAJ_SHIFT;
 526                 minor = (mvr & OMAP_UART_MVR_MIN_MASK);
 527                 break;
 528         default:
 529                 dev_warn(up->port.dev,
 530                          "Unknown revision, defaulting to highest\n");
 531                 /* highest possible revision */
 532                 major = 0xff;
 533                 minor = 0xff;
 534         }
 535         /* normalize revision for the driver */
 536         revision = UART_BUILD_REVISION(major, minor);
 537
 538         switch (revision) {
 539         case OMAP_UART_REV_46:
 540                 priv->habit |= UART_ERRATA_i202_MDR1_ACCESS;
 541                 break;
 542         case OMAP_UART_REV_52:
 543                 priv->habit |= UART_ERRATA_i202_MDR1_ACCESS |
 544                                 OMAP_UART_WER_HAS_TX_WAKEUP;
 545                 break;
 546         case OMAP_UART_REV_63:
 547                 priv->habit |= UART_ERRATA_i202_MDR1_ACCESS |
 548                         OMAP_UART_WER_HAS_TX_WAKEUP;
 549                 break;
 550         default:
 551                 break;
 552         }
 553 }
 554
 555 static void omap8250_uart_qos_work(struct work_struct *work)
 556 {
 557         struct omap8250_priv *priv;
 558
 559         priv = container_of(work, struct omap8250_priv, qos_work);
 560         pm_qos_update_request(&priv->pm_qos_request, priv->latency);
 561 }
 562
 563 #ifdef CONFIG_SERIAL_8250_DMA
 564 static int omap_8250_dma_handle_irq(struct uart_port *port);
 565 #endif
 566
 567 static irqreturn_t omap8250_irq(int irq, void *dev_id)
 568 {
 569         struct uart_port *port = dev_id;
 570         struct uart_8250_port *up = up_to_u8250p(port);
 571         unsigned int iir;
 572         int ret;
 573
 574 #ifdef CONFIG_SERIAL_8250_DMA
 575         if (up->dma) {
 576                 ret = omap_8250_dma_handle_irq(port);
 577                 return IRQ_RETVAL(ret);
 578         }
 579 #endif
 580
 581         serial8250_rpm_get(up);
 582         iir = serial_port_in(port, UART_IIR);
 583         ret = serial8250_handle_irq(port, iir);
 584         serial8250_rpm_put(up);
 585
 586         return IRQ_RETVAL(ret);
 587 }
 588
 589 static int omap_8250_startup(struct uart_port *port)
 590 {
 591         struct uart_8250_port *up = up_to_u8250p(port);
 592         struct omap8250_priv *priv = port->private_data;
 593         int ret;
 594
 595         if (priv->wakeirq) {
 596                 ret = dev_pm_set_dedicated_wake_irq(port->dev, priv->wakeirq);
 597                 if (ret)
 598                         return ret;
 599         }
 600
 601         pm_runtime_get_sync(port->dev);
 602
 603         up->mcr = 0;
 604         serial_out(up, UART_FCR, UART_FCR_CLEAR_RCVR | UART_FCR_CLEAR_XMIT);
 605
 606         serial_out(up, UART_LCR, UART_LCR_WLEN8);
 607
 608         up->lsr_saved_flags = 0;
 609         up->msr_saved_flags = 0;
 610
 611         if (up->dma) {
 612                 ret = serial8250_request_dma(up);
 613                 if (ret) {
 614                         dev_warn_ratelimited(port->dev,
 615                                              "failed to request DMA\n");
 616                         up->dma = NULL;
 617                 }
 618         }
 619
 620         ret = request_irq(port->irq, omap8250_irq, IRQF_SHARED,
 621                           dev_name(port->dev), port);
 622         if (ret < 0)
 623                 goto err;
 624
 625         up->ier = UART_IER_RLSI | UART_IER_RDI;
 626         serial_out(up, UART_IER, up->ier);
 627
 628 #ifdef CONFIG_PM
 629         up->capabilities |= UART_CAP_RPM;
 630 #endif
 631
 632         /* Enable module level wake up */
 633         priv->wer = OMAP_UART_WER_MOD_WKUP;
 634         if (priv->habit & OMAP_UART_WER_HAS_TX_WAKEUP)
 635                 priv->wer |= OMAP_UART_TX_WAKEUP_EN;
 636         serial_out(up, UART_OMAP_WER, priv->wer);
 637
 638         if (up->dma)
 639                 up->dma->rx_dma(up, 0);
 640
 641         pm_runtime_mark_last_busy(port->dev);
 642         pm_runtime_put_autosuspend(port->dev);
 643         return 0;
 644 err:
 645         pm_runtime_mark_last_busy(port->dev);
 646         pm_runtime_put_autosuspend(port->dev);
 647         dev_pm_clear_wake_irq(port->dev);
 648         return ret;
 649 }
 650
 651 static void omap_8250_shutdown(struct uart_port *port)
 652 {
 653         struct uart_8250_port *up = up_to_u8250p(port);
 654         struct omap8250_priv *priv = port->private_data;
 655
 656         flush_work(&priv->qos_work);
 657         if (up->dma)
 658                 up->dma->rx_dma(up, UART_IIR_RX_TIMEOUT);
 659
 660         pm_runtime_get_sync(port->dev);
 661
 662         serial_out(up, UART_OMAP_WER, 0);
 663
 664         up->ier = 0;
 665         serial_out(up, UART_IER, 0);
 666
 667         if (up->dma)
 668                 serial8250_release_dma(up);
 669
 670         /*
 671          * Disable break condition and FIFOs
 672          */
 673         if (up->lcr & UART_LCR_SBC)
 674                 serial_out(up, UART_LCR, up->lcr & ~UART_LCR_SBC);
 675         serial_out(up, UART_FCR, UART_FCR_CLEAR_RCVR | UART_FCR_CLEAR_XMIT);
 676
 677         pm_runtime_mark_last_busy(port->dev);
 678         pm_runtime_put_autosuspend(port->dev);
 679         free_irq(port->irq, port);
 680         dev_pm_clear_wake_irq(port->dev);
 681 }
 682
 683 static void omap_8250_throttle(struct uart_port *port)
 684 {
 685         unsigned long flags;
 686         struct uart_8250_port *up =
 687                 container_of(port, struct uart_8250_port, port);
 688
 689         pm_runtime_get_sync(port->dev);
 690
 691         spin_lock_irqsave(&port->lock, flags);
 692         up->ier &= ~(UART_IER_RLSI | UART_IER_RDI);
 693         serial_out(up, UART_IER, up->ier);
 694         spin_unlock_irqrestore(&port->lock, flags);
 695
 696         pm_runtime_mark_last_busy(port->dev);
 697         pm_runtime_put_autosuspend(port->dev);
 698 }
 699
 700 static int omap_8250_rs485_config(struct uart_port *port,
 701                                   struct serial_rs485 *rs485)
 702 {
 703         struct uart_8250_port *up = up_to_u8250p(port);
 704
 705         /* Clamp the delays to [0, 100ms] */
 706         rs485->delay_rts_before_send = min(rs485->delay_rts_before_send, 100U);
 707         rs485->delay_rts_after_send  = min(rs485->delay_rts_after_send, 100U);
 708
 709         port->rs485 = *rs485;
 710
 711         /*
 712          * Both serial8250_em485_init and serial8250_em485_destroy
 713          * are idempotent
 714          */
 715         if (rs485->flags & SER_RS485_ENABLED) {
 716                 int ret = serial8250_em485_init(up);
 717
 718                 if (ret) {
 719                         rs485->flags &= ~SER_RS485_ENABLED;
 720                         port->rs485.flags &= ~SER_RS485_ENABLED;
 721                 }
 722                 return ret;
 723         }
 724
 725         serial8250_em485_destroy(up);
 726
 727         return 0;
 728 }
 729
 730 static void omap_8250_unthrottle(struct uart_port *port)
 731 {
 732         unsigned long flags;
 733         struct uart_8250_port *up =
 734                 container_of(port, struct uart_8250_port, port);
 735
 736         pm_runtime_get_sync(port->dev);
 737
 738         spin_lock_irqsave(&port->lock, flags);
 739         up->ier |= UART_IER_RLSI | UART_IER_RDI;
 740         serial_out(up, UART_IER, up->ier);
 741         spin_unlock_irqrestore(&port->lock, flags);
 742
 743         pm_runtime_mark_last_busy(port->dev);
 744         pm_runtime_put_autosuspend(port->dev);
 745 }
 746
 747 #ifdef CONFIG_SERIAL_8250_DMA
 748 static int omap_8250_rx_dma(struct uart_8250_port *p, unsigned int iir);
 749
 750 static void __dma_rx_do_complete(struct uart_8250_port *p, bool error)
 751 {
 752         struct omap8250_priv    *priv = p->port.private_data;
 753         struct uart_8250_dma    *dma = p->dma;
 754         struct tty_port         *tty_port = &p->port.state->port;
 755         struct dma_tx_state     state;
 756         int                     count;
 757         unsigned long           flags;
 758         int                     ret;
 759
 760         dma_sync_single_for_cpu(dma->rxchan->device->dev, dma->rx_addr,
 761                                 dma->rx_size, DMA_FROM_DEVICE);
 762
 763         spin_lock_irqsave(&priv->rx_dma_lock, flags);
 764
 765         if (!dma->rx_running)
 766                 goto unlock;
 767
 768         dma->rx_running = 0;
 769         dmaengine_tx_status(dma->rxchan, dma->rx_cookie, &state);
 770         dmaengine_terminate_all(dma->rxchan);
 771
 772         count = dma->rx_size - state.residue;
 773
 774         ret = tty_insert_flip_string(tty_port, dma->rx_buf, count);
 775
 776         p->port.icount.rx += ret;
 777         p->port.icount.buf_overrun += count - ret;
 778 unlock:
 779         spin_unlock_irqrestore(&priv->rx_dma_lock, flags);
 780
 781         if (!error)
 782                 omap_8250_rx_dma(p, 0);
 783
 784         tty_flip_buffer_push(tty_port);
 785 }
 786
 787 static void __dma_rx_complete(void *param)
 788 {
 789         __dma_rx_do_complete(param, false);
 790 }
 791
 792 static void omap_8250_rx_dma_flush(struct uart_8250_port *p)
 793 {
 794         struct omap8250_priv    *priv = p->port.private_data;
 795         struct uart_8250_dma    *dma = p->dma;
 796         unsigned long           flags;
 797         int ret;
 798
 799         spin_lock_irqsave(&priv->rx_dma_lock, flags);
 800
 801         if (!dma->rx_running) {
 802                 spin_unlock_irqrestore(&priv->rx_dma_lock, flags);
 803                 return;
 804         }
 805
 806         ret = dmaengine_pause(dma->rxchan);
 807         if (WARN_ON_ONCE(ret))
 808                 priv->rx_dma_broken = true;
 809
 810         spin_unlock_irqrestore(&priv->rx_dma_lock, flags);
 811
 812         __dma_rx_do_complete(p, true);
 813 }
 814
 815 static int omap_8250_rx_dma(struct uart_8250_port *p, unsigned int iir)
 816 {
 817         struct omap8250_priv            *priv = p->port.private_data;
 818         struct uart_8250_dma            *dma = p->dma;
 819         int                             err = 0;
 820         struct dma_async_tx_descriptor  *desc;
 821         unsigned long                   flags;
 822
 823         switch (iir & 0x3f) {
 824         case UART_IIR_RLSI:
 825                 /* 8250_core handles errors and break interrupts */
 826                 omap_8250_rx_dma_flush(p);
 827                 return -EIO;
 828         case UART_IIR_RX_TIMEOUT:
 829                 /*
 830                  * If RCVR FIFO trigger level was not reached, complete the
 831                  * transfer and let 8250_core copy the remaining data.
 832                  */
 833                 omap_8250_rx_dma_flush(p);
 834                 return -ETIMEDOUT;
 835         case UART_IIR_RDI:
 836                 /*
 837                  * The OMAP UART is a special BEAST. If we receive RDI we _have_
 838                  * a DMA transfer programmed but it didn't work. One reason is
 839                  * that we were too slow and there were too many bytes in the
 840                  * FIFO, the UART counted wrong and never kicked the DMA engine
 841                  * to do anything. That means once we receive RDI on OMAP then
 842                  * the DMA won't do anything soon so we have to cancel the DMA
 843                  * transfer and purge the FIFO manually.
 844                  */
 845                 omap_8250_rx_dma_flush(p);
 846                 return -ETIMEDOUT;
 847
 848         default:
 849                 break;
 850         }
 851
 852         if (priv->rx_dma_broken)
 853                 return -EINVAL;
 854
 855         spin_lock_irqsave(&priv->rx_dma_lock, flags);
 856
 857         if (dma->rx_running)
 858                 goto out;
 859
 860         desc = dmaengine_prep_slave_single(dma->rxchan, dma->rx_addr,
 861                                            dma->rx_size, DMA_DEV_TO_MEM,
 862                                            DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 863         if (!desc) {
 864                 err = -EBUSY;
 865                 goto out;
 866         }
 867
 868         dma->rx_running = 1;
 869         desc->callback = __dma_rx_complete;
 870         desc->callback_param = p;
 871
 872         dma->rx_cookie = dmaengine_submit(desc);
 873
 874         dma_sync_single_for_device(dma->rxchan->device->dev, dma->rx_addr,
 875                                    dma->rx_size, DMA_FROM_DEVICE);
 876
 877         dma_async_issue_pending(dma->rxchan);
 878 out:
 879         spin_unlock_irqrestore(&priv->rx_dma_lock, flags);
 880         return err;
 881 }
 882
 883 static int omap_8250_tx_dma(struct uart_8250_port *p);
 884
 885 static void omap_8250_dma_tx_complete(void *param)
 886 {
 887         struct uart_8250_port   *p = param;
 888         struct uart_8250_dma    *dma = p->dma;
 889         struct circ_buf         *xmit = &p->port.state->xmit;
 890         unsigned long           flags;
 891         bool                    en_thri = false;
 892         struct omap8250_priv    *priv = p->port.private_data;
 893
 894         dma_sync_single_for_cpu(dma->txchan->device->dev, dma->tx_addr,
 895                                 UART_XMIT_SIZE, DMA_TO_DEVICE);
 896
 897         spin_lock_irqsave(&p->port.lock, flags);
 898
 899         dma->tx_running = 0;
 900
 901         xmit->tail += dma->tx_size;
 902         xmit->tail &= UART_XMIT_SIZE - 1;
 903         p->port.icount.tx += dma->tx_size;
 904
 905         if (priv->delayed_restore) {
 906                 priv->delayed_restore = 0;
 907                 omap8250_restore_regs(p);
 908         }
 909
 910         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 911                 uart_write_wakeup(&p->port);
 912
 913         if (!uart_circ_empty(xmit) && !uart_tx_stopped(&p->port)) {
 914                 int ret;
 915
 916                 ret = omap_8250_tx_dma(p);
 917                 if (ret)
 918                         en_thri = true;
 919
 920         } else if (p->capabilities & UART_CAP_RPM) {
 921                 en_thri = true;
 922         }
 923
 924         if (en_thri) {
 925                 dma->tx_err = 1;
 926                 p->ier |= UART_IER_THRI;
 927                 serial_port_out(&p->port, UART_IER, p->ier);
 928         }
 929
 930         spin_unlock_irqrestore(&p->port.lock, flags);
 931 }
 932
 933 static int omap_8250_tx_dma(struct uart_8250_port *p)
 934 {
 935         struct uart_8250_dma            *dma = p->dma;
 936         struct omap8250_priv            *priv = p->port.private_data;
 937         struct circ_buf                 *xmit = &p->port.state->xmit;
 938         struct dma_async_tx_descriptor  *desc;
 939         unsigned int    skip_byte = 0;
 940         int ret;
 941
 942         if (dma->tx_running)
 943                 return 0;
 944         if (uart_tx_stopped(&p->port) || uart_circ_empty(xmit)) {
 945
 946                 /*
 947                  * Even if no data, we need to return an error for the two cases
 948                  * below so serial8250_tx_chars() is invoked and properly clears
 949                  * THRI and/or runtime suspend.
 950                  */
 951                 if (dma->tx_err || p->capabilities & UART_CAP_RPM) {
 952                         ret = -EBUSY;
 953                         goto err;
 954                 }
 955                 if (p->ier & UART_IER_THRI) {
 956                         p->ier &= ~UART_IER_THRI;
 957                         serial_out(p, UART_IER, p->ier);
 958                 }
 959                 return 0;
 960         }
 961
 962         dma->tx_size = CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE);
 963         if (priv->habit & OMAP_DMA_TX_KICK) {
 964                 u8 tx_lvl;
 965
 966                 /*
 967                  * We need to put the first byte into the FIFO in order to start
 968                  * the DMA transfer. For transfers smaller than four bytes we
 969                  * don't bother doing DMA at all. It seem not matter if there
 970                  * are still bytes in the FIFO from the last transfer (in case
 971                  * we got here directly from omap_8250_dma_tx_complete()). Bytes
 972                  * leaving the FIFO seem not to trigger the DMA transfer. It is
 973                  * really the byte that we put into the FIFO.
 974                  * If the FIFO is already full then we most likely got here from
 975                  * omap_8250_dma_tx_complete(). And this means the DMA engine
 976                  * just completed its work. We don't have to wait the complete
 977                  * 86us at 115200,8n1 but around 60us (not to mention lower
 978                  * baudrates). So in that case we take the interrupt and try
 979                  * again with an empty FIFO.
 980                  */
 981                 tx_lvl = serial_in(p, UART_OMAP_TX_LVL);
 982                 if (tx_lvl == p->tx_loadsz) {
 983                         ret = -EBUSY;
 984                         goto err;
 985                 }
 986                 if (dma->tx_size < 4) {
 987                         ret = -EINVAL;
 988                         goto err;
 989                 }
 990                 skip_byte = 1;
 991         }
 992
 993         desc = dmaengine_prep_slave_single(dma->txchan,
 994                         dma->tx_addr + xmit->tail + skip_byte,
 995                         dma->tx_size - skip_byte, DMA_MEM_TO_DEV,
 996                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 997         if (!desc) {
 998                 ret = -EBUSY;
 999                 goto err;
1000         }
1001
1002         dma->tx_running = 1;
1003
1004         desc->callback = omap_8250_dma_tx_complete;
1005         desc->callback_param = p;
1006
1007         dma->tx_cookie = dmaengine_submit(desc);
1008
1009         dma_sync_single_for_device(dma->txchan->device->dev, dma->tx_addr,
1010                                    UART_XMIT_SIZE, DMA_TO_DEVICE);
1011
1012         dma_async_issue_pending(dma->txchan);
1013         if (dma->tx_err)
1014                 dma->tx_err = 0;
1015
1016         if (p->ier & UART_IER_THRI) {
1017                 p->ier &= ~UART_IER_THRI;
1018                 serial_out(p, UART_IER, p->ier);
1019         }
1020         if (skip_byte)
1021                 serial_out(p, UART_TX, xmit->buf[xmit->tail]);
1022         return 0;
1023 err:
1024         dma->tx_err = 1;
1025         return ret;
1026 }
1027
1028 /*
1029  * This is mostly serial8250_handle_irq(). We have a slightly different DMA
1030  * hoook for RX/TX and need different logic for them in the ISR. Therefore we
1031  * use the default routine in the non-DMA case and this one for with DMA.
1032  */
1033 static int omap_8250_dma_handle_irq(struct uart_port *port)
1034 {
1035         struct uart_8250_port *up = up_to_u8250p(port);
1036         unsigned char status;
1037         unsigned long flags;
1038         u8 iir;
1039         int dma_err = 0;
1040
1041         serial8250_rpm_get(up);
1042
1043         iir = serial_port_in(port, UART_IIR);
1044         if (iir & UART_IIR_NO_INT) {
1045                 serial8250_rpm_put(up);
1046                 return 0;
1047         }
1048
1049         spin_lock_irqsave(&port->lock, flags);
1050
1051         status = serial_port_in(port, UART_LSR);
1052
1053         if (status & (UART_LSR_DR | UART_LSR_BI)) {
1054
1055                 dma_err = omap_8250_rx_dma(up, iir);
1056                 if (dma_err) {
1057                         status = serial8250_rx_chars(up, status);
1058                         omap_8250_rx_dma(up, 0);
1059                 }
1060         }
1061         serial8250_modem_status(up);
1062         if (status & UART_LSR_THRE && up->dma->tx_err) {
1063                 if (uart_tx_stopped(&up->port) ||
1064                     uart_circ_empty(&up->port.state->xmit)) {
1065                         up->dma->tx_err = 0;
1066                         serial8250_tx_chars(up);
1067                 } else  {
1068                         /*
1069                          * try again due to an earlier failer which
1070                          * might have been resolved by now.
1071                          */
1072                         dma_err = omap_8250_tx_dma(up);
1073                         if (dma_err)
1074                                 serial8250_tx_chars(up);
1075                 }
1076         }
1077
1078         spin_unlock_irqrestore(&port->lock, flags);
1079         serial8250_rpm_put(up);
1080         return 1;
1081 }
1082
1083 static bool the_no_dma_filter_fn(struct dma_chan *chan, void *param)
1084 {
1085         return false;
1086 }
1087
1088 #else
1089
1090 static inline int omap_8250_rx_dma(struct uart_8250_port *p, unsigned int iir)
1091 {
1092         return -EINVAL;
1093 }
1094 #endif
1095
1096 static int omap8250_no_handle_irq(struct uart_port *port)
1097 {
1098         /* IRQ has not been requested but handling irq? */
1099         WARN_ONCE(1, "Unexpected irq handling before port startup\n");
1100         return 0;
1101 }
1102
1103 static const u8 am3352_habit = OMAP_DMA_TX_KICK | UART_ERRATA_CLOCK_DISABLE;
1104 static const u8 am4372_habit = UART_ERRATA_CLOCK_DISABLE;
1105
1106 static const struct of_device_id omap8250_dt_ids[] = {
1107         { .compatible = "ti,omap2-uart" },
1108         { .compatible = "ti,omap3-uart" },
1109         { .compatible = "ti,omap4-uart" },
1110         { .compatible = "ti,am3352-uart", .data = &am3352_habit, },
1111         { .compatible = "ti,am4372-uart", .data = &am4372_habit, },
1112         { .compatible = "ti,dra742-uart", .data = &am4372_habit, },
1113         {},
1114 };
1115 MODULE_DEVICE_TABLE(of, omap8250_dt_ids);
1116
1117 static int omap8250_probe(struct platform_device *pdev)
1118 {
1119         struct resource *regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1120         struct resource *irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
1121         struct omap8250_priv *priv;
1122         struct uart_8250_port up;
1123         int ret;
1124         void __iomem *membase;
1125
1126         if (!regs || !irq) {
1127                 dev_err(&pdev->dev, "missing registers or irq\n");
1128                 return -EINVAL;
1129         }
1130
1131         priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
1132         if (!priv)
1133                 return -ENOMEM;
1134
1135         membase = devm_ioremap_nocache(&pdev->dev, regs->start,
1136                                        resource_size(regs));
1137         if (!membase)
1138                 return -ENODEV;
1139
1140         memset(&up, 0, sizeof(up));
1141         up.port.dev = &pdev->dev;
1142         up.port.mapbase = regs->start;
1143         up.port.membase = membase;
1144         up.port.irq = irq->start;
1145         /*
1146          * It claims to be 16C750 compatible however it is a little different.
1147          * It has EFR and has no FCR7_64byte bit. The AFE (which it claims to
1148          * have) is enabled via EFR instead of MCR. The type is set here 8250
1149          * just to get things going. UNKNOWN does not work for a few reasons and
1150          * we don't need our own type since we don't use 8250's set_termios()
1151          * or pm callback.
1152          */
1153         up.port.type = PORT_8250;
1154         up.port.iotype = UPIO_MEM;
1155         up.port.flags = UPF_FIXED_PORT | UPF_FIXED_TYPE | UPF_SOFT_FLOW |
1156                 UPF_HARD_FLOW;
1157         up.port.private_data = priv;
1158
1159         up.port.regshift = 2;
1160         up.port.fifosize = 64;
1161         up.tx_loadsz = 64;
1162         up.capabilities = UART_CAP_FIFO;
1163 #ifdef CONFIG_PM
1164         /*
1165          * Runtime PM is mostly transparent. However to do it right we need to a
1166          * TX empty interrupt before we can put the device to auto idle. So if
1167          * PM is not enabled we don't add that flag and can spare that one extra
1168          * interrupt in the TX path.
1169          */
1170         up.capabilities |= UART_CAP_RPM;
1171 #endif
1172         up.port.set_termios = omap_8250_set_termios;
1173         up.port.set_mctrl = omap8250_set_mctrl;
1174         up.port.pm = omap_8250_pm;
1175         up.port.startup = omap_8250_startup;
1176         up.port.shutdown = omap_8250_shutdown;
1177         up.port.throttle = omap_8250_throttle;
1178         up.port.unthrottle = omap_8250_unthrottle;
1179         up.port.rs485_config = omap_8250_rs485_config;
1180
1181         if (pdev->dev.of_node) {
1182                 const struct of_device_id *id;
1183
1184                 ret = of_alias_get_id(pdev->dev.of_node, "serial");
1185
1186                 of_property_read_u32(pdev->dev.of_node, "clock-frequency",
1187                                      &up.port.uartclk);
1188                 priv->wakeirq = irq_of_parse_and_map(pdev->dev.of_node, 1);
1189
1190                 id = of_match_device(of_match_ptr(omap8250_dt_ids), &pdev->dev);
1191                 if (id && id->data)
1192                         priv->habit |= *(u8 *)id->data;
1193         } else {
1194                 ret = pdev->id;
1195         }
1196         if (ret < 0) {
1197                 dev_err(&pdev->dev, "failed to get alias/pdev id\n");
1198                 return ret;
1199         }
1200         up.port.line = ret;
1201
1202         if (!up.port.uartclk) {
1203                 up.port.uartclk = DEFAULT_CLK_SPEED;
1204                 dev_warn(&pdev->dev,
1205                          "No clock speed specified: using default: %d\n",
1206                          DEFAULT_CLK_SPEED);
1207         }
1208
1209         priv->latency = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE;
1210         priv->calc_latency = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE;
1211         pm_qos_add_request(&priv->pm_qos_request, PM_QOS_CPU_DMA_LATENCY,
1212                            priv->latency);
1213         INIT_WORK(&priv->qos_work, omap8250_uart_qos_work);
1214
1215         spin_lock_init(&priv->rx_dma_lock);
1216
1217         device_init_wakeup(&pdev->dev, true);
1218         pm_runtime_use_autosuspend(&pdev->dev);
1219         pm_runtime_set_autosuspend_delay(&pdev->dev, -1);
1220
1221         pm_runtime_irq_safe(&pdev->dev);
1222         pm_runtime_enable(&pdev->dev);
1223
1224         pm_runtime_get_sync(&pdev->dev);
1225
1226         omap_serial_fill_features_erratas(&up, priv);
1227         up.port.handle_irq = omap8250_no_handle_irq;
1228 #ifdef CONFIG_SERIAL_8250_DMA
1229         if (pdev->dev.of_node) {
1230                 /*
1231                  * Oh DMA support. If there are no DMA properties in the DT then
1232                  * we will fall back to a generic DMA channel which does not
1233                  * really work here. To ensure that we do not get a generic DMA
1234                  * channel assigned, we have the the_no_dma_filter_fn() here.
1235                  * To avoid "failed to request DMA" messages we check for DMA
1236                  * properties in DT.
1237                  */
1238                 ret = of_property_count_strings(pdev->dev.of_node, "dma-names");
1239                 if (ret == 2) {
1240                         up.dma = &priv->omap8250_dma;
1241                         priv->omap8250_dma.fn = the_no_dma_filter_fn;
1242                         priv->omap8250_dma.tx_dma = omap_8250_tx_dma;
1243                         priv->omap8250_dma.rx_dma = omap_8250_rx_dma;
1244                         priv->omap8250_dma.rx_size = RX_TRIGGER;
1245                         priv->omap8250_dma.rxconf.src_maxburst = RX_TRIGGER;
1246                         priv->omap8250_dma.txconf.dst_maxburst = TX_TRIGGER;
1247
1248                         if (of_machine_is_compatible("ti,am33xx"))
1249                                 priv->habit |= OMAP_DMA_TX_KICK;
1250                         /*
1251                          * pause is currently not supported atleast on omap-sdma
1252                          * and edma on most earlier kernels.
1253                          */
1254                         priv->rx_dma_broken = true;
1255                 }
1256         }
1257 #endif
1258         ret = serial8250_register_8250_port(&up);
1259         if (ret < 0) {
1260                 dev_err(&pdev->dev, "unable to register 8250 port\n");
1261                 goto err;
1262         }
1263         priv->line = ret;
1264         platform_set_drvdata(pdev, priv);
1265         pm_runtime_mark_last_busy(&pdev->dev);
1266         pm_runtime_put_autosuspend(&pdev->dev);
1267         return 0;
1268 err:
1269         pm_runtime_put(&pdev->dev);
1270         pm_runtime_disable(&pdev->dev);
1271         return ret;
1272 }
1273
1274 static int omap8250_remove(struct platform_device *pdev)
1275 {
1276         struct omap8250_priv *priv = platform_get_drvdata(pdev);
1277
1278         pm_runtime_put_sync(&pdev->dev);
1279         pm_runtime_disable(&pdev->dev);
1280         serial8250_unregister_port(priv->line);
1281         pm_qos_remove_request(&priv->pm_qos_request);
1282         device_init_wakeup(&pdev->dev, false);
1283         return 0;
1284 }
1285
1286 #ifdef CONFIG_PM_SLEEP
1287 static int omap8250_prepare(struct device *dev)
1288 {
1289         struct omap8250_priv *priv = dev_get_drvdata(dev);
1290
1291         if (!priv)
1292                 return 0;
1293         priv->is_suspending = true;
1294         return 0;
1295 }
1296
1297 static void omap8250_complete(struct device *dev)
1298 {
1299         struct omap8250_priv *priv = dev_get_drvdata(dev);
1300
1301         if (!priv)
1302                 return;
1303         priv->is_suspending = false;
1304 }
1305
1306 static int omap8250_suspend(struct device *dev)
1307 {
1308         struct omap8250_priv *priv = dev_get_drvdata(dev);
1309
1310         serial8250_suspend_port(priv->line);
1311         flush_work(&priv->qos_work);
1312         return 0;
1313 }
1314
1315 static int omap8250_resume(struct device *dev)
1316 {
1317         struct omap8250_priv *priv = dev_get_drvdata(dev);
1318
1319         serial8250_resume_port(priv->line);
1320         return 0;
1321 }
1322 #else
1323 #define omap8250_prepare NULL
1324 #define omap8250_complete NULL
1325 #endif
1326
1327 #ifdef CONFIG_PM
1328 static int omap8250_lost_context(struct uart_8250_port *up)
1329 {
1330         u32 val;
1331
1332         val = serial_in(up, UART_OMAP_SCR);
1333         /*
1334          * If we lose context, then SCR is set to its reset value of zero.
1335          * After set_termios() we set bit 3 of SCR (TX_EMPTY_CTL_IT) to 1,
1336          * among other bits, to never set the register back to zero again.
1337          */
1338         if (!val)
1339                 return 1;
1340         return 0;
1341 }
1342
1343 /* TODO: in future, this should happen via API in drivers/reset/ */
1344 static int omap8250_soft_reset(struct device *dev)
1345 {
1346         struct omap8250_priv *priv = dev_get_drvdata(dev);
1347         struct uart_8250_port *up = serial8250_get_port(priv->line);
1348         int timeout = 100;
1349         int sysc;
1350         int syss;
1351
1352         sysc = serial_in(up, UART_OMAP_SYSC);
1353
1354         /* softreset the UART */
1355         sysc |= OMAP_UART_SYSC_SOFTRESET;
1356         serial_out(up, UART_OMAP_SYSC, sysc);
1357
1358         /* By experiments, 1us enough for reset complete on AM335x */
1359         do {
1360                 udelay(1);
1361                 syss = serial_in(up, UART_OMAP_SYSS);
1362         } while (--timeout && !(syss & OMAP_UART_SYSS_RESETDONE));
1363
1364         if (!timeout) {
1365                 dev_err(dev, "timed out waiting for reset done\n");
1366                 return -ETIMEDOUT;
1367         }
1368
1369         return 0;
1370 }
1371
1372 static int omap8250_runtime_suspend(struct device *dev)
1373 {
1374         struct omap8250_priv *priv = dev_get_drvdata(dev);
1375         struct uart_8250_port *up;
1376
1377         up = serial8250_get_port(priv->line);
1378         /*
1379          * When using 'no_console_suspend', the console UART must not be
1380          * suspended. Since driver suspend is managed by runtime suspend,
1381          * preventing runtime suspend (by returning error) will keep device
1382          * active during suspend.
1383          */
1384         if (priv->is_suspending && !console_suspend_enabled) {
1385                 if (uart_console(&up->port))
1386                         return -EBUSY;
1387         }
1388
1389         if (priv->habit & UART_ERRATA_CLOCK_DISABLE) {
1390                 int ret;
1391
1392                 ret = omap8250_soft_reset(dev);
1393                 if (ret)
1394                         return ret;
1395
1396                 /* Restore to UART mode after reset (for wakeup) */
1397                 omap8250_update_mdr1(up, priv);
1398         }
1399
1400         if (up->dma && up->dma->rxchan)
1401                 omap_8250_rx_dma(up, UART_IIR_RX_TIMEOUT);
1402
1403         priv->latency = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE;
1404         schedule_work(&priv->qos_work);
1405
1406         return 0;
1407 }
1408
1409 static int omap8250_runtime_resume(struct device *dev)
1410 {
1411         struct omap8250_priv *priv = dev_get_drvdata(dev);
1412         struct uart_8250_port *up;
1413         int loss_cntx;
1414
1415         /* In case runtime-pm tries this before we are setup */
1416         if (!priv)
1417                 return 0;
1418
1419         up = serial8250_get_port(priv->line);
1420         loss_cntx = omap8250_lost_context(up);
1421
1422         if (loss_cntx)
1423                 omap8250_restore_regs(up);
1424
1425         if (up->dma && up->dma->rxchan)
1426                 omap_8250_rx_dma(up, 0);
1427
1428         priv->latency = priv->calc_latency;
1429         schedule_work(&priv->qos_work);
1430         return 0;
1431 }
1432 #endif
1433
1434 #ifdef CONFIG_SERIAL_8250_OMAP_TTYO_FIXUP
1435 static int __init omap8250_console_fixup(void)
1436 {
1437         char *omap_str;
1438         char *options;
1439         u8 idx;
1440
1441         if (strstr(boot_command_line, "console=ttyS"))
1442                 /* user set a ttyS based name for the console */
1443                 return 0;
1444
1445         omap_str = strstr(boot_command_line, "console=ttyO");
1446         if (!omap_str)
1447                 /* user did not set ttyO based console, so we don't care */
1448                 return 0;
1449
1450         omap_str += 12;
1451         if ('0' <= *omap_str && *omap_str <= '9')
1452                 idx = *omap_str - '0';
1453         else
1454                 return 0;
1455
1456         omap_str++;
1457         if (omap_str[0] == ',') {
1458                 omap_str++;
1459                 options = omap_str;
1460         } else {
1461                 options = NULL;
1462         }
1463
1464         add_preferred_console("ttyS", idx, options);
1465         pr_err("WARNING: Your 'console=ttyO%d' has been replaced by 'ttyS%d'\n",
1466                idx, idx);
1467         pr_err("This ensures that you still see kernel messages. Please\n");
1468         pr_err("update your kernel commandline.\n");
1469         return 0;
1470 }
1471 console_initcall(omap8250_console_fixup);
1472 #endif
1473
1474 static const struct dev_pm_ops omap8250_dev_pm_ops = {
1475         SET_SYSTEM_SLEEP_PM_OPS(omap8250_suspend, omap8250_resume)
1476         SET_RUNTIME_PM_OPS(omap8250_runtime_suspend,
1477                            omap8250_runtime_resume, NULL)
1478         .prepare        = omap8250_prepare,
1479         .complete       = omap8250_complete,
1480 };
1481
1482 static struct platform_driver omap8250_platform_driver = {
1483         .driver = {
1484                 .name           = "omap8250",
1485                 .pm             = &omap8250_dev_pm_ops,
1486                 .of_match_table = omap8250_dt_ids,
1487         },
1488         .probe                  = omap8250_probe,
1489         .remove                 = omap8250_remove,
1490 };
1491 module_platform_driver(omap8250_platform_driver);
1492
1493 MODULE_AUTHOR("Sebastian Andrzej Siewior");
1494 MODULE_DESCRIPTION("OMAP 8250 Driver");
1495 MODULE_LICENSE("GPL v2");