tty/serial/xilinx_uartps.c

   1 /*
   2  * Cadence UART driver (found in Xilinx Zynq)
   3  *
   4  * 2011 - 2014 (C) Xilinx Inc.
   5  *
   6  * This program is free software; you can redistribute it
   7  * and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation;
   9  * either version 2 of the License, or (at your option) any
  10  * later version.
  11  *
  12  * This driver has originally been pushed by Xilinx using a Zynq-branding. This
  13  * still shows in the naming of this file, the kconfig symbols and some symbols
  14  * in the code.
  15  */
  16
  17 #if defined(CONFIG_SERIAL_XILINX_PS_UART_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
  18 #define SUPPORT_SYSRQ
  19 #endif
  20
  21 #include <linux/platform_device.h>
  22 #include <linux/serial.h>
  23 #include <linux/console.h>
  24 #include <linux/serial_core.h>
  25 #include <linux/slab.h>
  26 #include <linux/tty.h>
  27 #include <linux/tty_flip.h>
  28 #include <linux/clk.h>
  29 #include <linux/irq.h>
  30 #include <linux/io.h>
  31 #include <linux/of.h>
  32 #include <linux/module.h>
  33 #include <linux/pm_runtime.h>
  34 #include <linux/iopoll.h>
  35
  36 #define CDNS_UART_TTY_NAME      "ttyPS"
  37 #define CDNS_UART_NAME          "xuartps"
  38 #define CDNS_UART_MAJOR         0       /* use dynamic node allocation */
  39 #define CDNS_UART_MINOR         0       /* works best with devtmpfs */
  40 #define CDNS_UART_NR_PORTS      2
  41 #define CDNS_UART_FIFO_SIZE     64      /* FIFO size */
  42 #define CDNS_UART_REGISTER_SPACE        0x1000
  43 #define TX_TIMEOUT              500000
  44
  45 /* Rx Trigger level */
  46 static int rx_trigger_level = 56;
  47 module_param(rx_trigger_level, uint, S_IRUGO);
  48 MODULE_PARM_DESC(rx_trigger_level, "Rx trigger level, 1-63 bytes");
  49
  50 /* Rx Timeout */
  51 static int rx_timeout = 10;
  52 module_param(rx_timeout, uint, S_IRUGO);
  53 MODULE_PARM_DESC(rx_timeout, "Rx timeout, 1-255");
  54
  55 /* Register offsets for the UART. */
  56 #define CDNS_UART_CR            0x00  /* Control Register */
  57 #define CDNS_UART_MR            0x04  /* Mode Register */
  58 #define CDNS_UART_IER           0x08  /* Interrupt Enable */
  59 #define CDNS_UART_IDR           0x0C  /* Interrupt Disable */
  60 #define CDNS_UART_IMR           0x10  /* Interrupt Mask */
  61 #define CDNS_UART_ISR           0x14  /* Interrupt Status */
  62 #define CDNS_UART_BAUDGEN       0x18  /* Baud Rate Generator */
  63 #define CDNS_UART_RXTOUT        0x1C  /* RX Timeout */
  64 #define CDNS_UART_RXWM          0x20  /* RX FIFO Trigger Level */
  65 #define CDNS_UART_MODEMCR       0x24  /* Modem Control */
  66 #define CDNS_UART_MODEMSR       0x28  /* Modem Status */
  67 #define CDNS_UART_SR            0x2C  /* Channel Status */
  68 #define CDNS_UART_FIFO          0x30  /* FIFO */
  69 #define CDNS_UART_BAUDDIV       0x34  /* Baud Rate Divider */
  70 #define CDNS_UART_FLOWDEL       0x38  /* Flow Delay */
  71 #define CDNS_UART_IRRX_PWIDTH   0x3C  /* IR Min Received Pulse Width */
  72 #define CDNS_UART_IRTX_PWIDTH   0x40  /* IR Transmitted pulse Width */
  73 #define CDNS_UART_TXWM          0x44  /* TX FIFO Trigger Level */
  74 #define CDNS_UART_RXBS          0x48  /* RX FIFO byte status register */
  75
  76 /* Control Register Bit Definitions */
  77 #define CDNS_UART_CR_STOPBRK    0x00000100  /* Stop TX break */
  78 #define CDNS_UART_CR_STARTBRK   0x00000080  /* Set TX break */
  79 #define CDNS_UART_CR_TX_DIS     0x00000020  /* TX disabled. */
  80 #define CDNS_UART_CR_TX_EN      0x00000010  /* TX enabled */
  81 #define CDNS_UART_CR_RX_DIS     0x00000008  /* RX disabled. */
  82 #define CDNS_UART_CR_RX_EN      0x00000004  /* RX enabled */
  83 #define CDNS_UART_CR_TXRST      0x00000002  /* TX logic reset */
  84 #define CDNS_UART_CR_RXRST      0x00000001  /* RX logic reset */
  85 #define CDNS_UART_CR_RST_TO     0x00000040  /* Restart Timeout Counter */
  86 #define CDNS_UART_RXBS_PARITY    0x00000001 /* Parity error status */
  87 #define CDNS_UART_RXBS_FRAMING   0x00000002 /* Framing error status */
  88 #define CDNS_UART_RXBS_BRK       0x00000004 /* Overrun error status */
  89
  90 /*
  91  * Mode Register:
  92  * The mode register (MR) defines the mode of transfer as well as the data
  93  * format. If this register is modified during transmission or reception,
  94  * data validity cannot be guaranteed.
  95  */
  96 #define CDNS_UART_MR_CLKSEL             0x00000001  /* Pre-scalar selection */
  97 #define CDNS_UART_MR_CHMODE_L_LOOP      0x00000200  /* Local loop back mode */
  98 #define CDNS_UART_MR_CHMODE_NORM        0x00000000  /* Normal mode */
  99 #define CDNS_UART_MR_CHMODE_MASK        0x00000300  /* Mask for mode bits */
 100
 101 #define CDNS_UART_MR_STOPMODE_2_BIT     0x00000080  /* 2 stop bits */
 102 #define CDNS_UART_MR_STOPMODE_1_BIT     0x00000000  /* 1 stop bit */
 103
 104 #define CDNS_UART_MR_PARITY_NONE        0x00000020  /* No parity mode */
 105 #define CDNS_UART_MR_PARITY_MARK        0x00000018  /* Mark parity mode */
 106 #define CDNS_UART_MR_PARITY_SPACE       0x00000010  /* Space parity mode */
 107 #define CDNS_UART_MR_PARITY_ODD         0x00000008  /* Odd parity mode */
 108 #define CDNS_UART_MR_PARITY_EVEN        0x00000000  /* Even parity mode */
 109
 110 #define CDNS_UART_MR_CHARLEN_6_BIT      0x00000006  /* 6 bits data */
 111 #define CDNS_UART_MR_CHARLEN_7_BIT      0x00000004  /* 7 bits data */
 112 #define CDNS_UART_MR_CHARLEN_8_BIT      0x00000000  /* 8 bits data */
 113
 114 /*
 115  * Interrupt Registers:
 116  * Interrupt control logic uses the interrupt enable register (IER) and the
 117  * interrupt disable register (IDR) to set the value of the bits in the
 118  * interrupt mask register (IMR). The IMR determines whether to pass an
 119  * interrupt to the interrupt status register (ISR).
 120  * Writing a 1 to IER Enables an interrupt, writing a 1 to IDR disables an
 121  * interrupt. IMR and ISR are read only, and IER and IDR are write only.
 122  * Reading either IER or IDR returns 0x00.
 123  * All four registers have the same bit definitions.
 124  */
 125 #define CDNS_UART_IXR_TOUT      0x00000100 /* RX Timeout error interrupt */
 126 #define CDNS_UART_IXR_PARITY    0x00000080 /* Parity error interrupt */
 127 #define CDNS_UART_IXR_FRAMING   0x00000040 /* Framing error interrupt */
 128 #define CDNS_UART_IXR_OVERRUN   0x00000020 /* Overrun error interrupt */
 129 #define CDNS_UART_IXR_TXFULL    0x00000010 /* TX FIFO Full interrupt */
 130 #define CDNS_UART_IXR_TXEMPTY   0x00000008 /* TX FIFO empty interrupt */
 131 #define CDNS_UART_ISR_RXEMPTY   0x00000002 /* RX FIFO empty interrupt */
 132 #define CDNS_UART_IXR_RXTRIG    0x00000001 /* RX FIFO trigger interrupt */
 133 #define CDNS_UART_IXR_RXFULL    0x00000004 /* RX FIFO full interrupt. */
 134 #define CDNS_UART_IXR_RXEMPTY   0x00000002 /* RX FIFO empty interrupt. */
 135 #define CDNS_UART_IXR_RXMASK    0x000021e7 /* Valid RX bit mask */
 136
 137         /*
 138          * Do not enable parity error interrupt for the following
 139          * reason: When parity error interrupt is enabled, each Rx
 140          * parity error always results in 2 events. The first one
 141          * being parity error interrupt and the second one with a
 142          * proper Rx interrupt with the incoming data.  Disabling
 143          * parity error interrupt ensures better handling of parity
 144          * error events. With this change, for a parity error case, we
 145          * get a Rx interrupt with parity error set in ISR register
 146          * and we still handle parity errors in the desired way.
 147          */
 148
 149 #define CDNS_UART_RX_IRQS       (CDNS_UART_IXR_FRAMING | \
 150                                  CDNS_UART_IXR_OVERRUN | \
 151                                  CDNS_UART_IXR_RXTRIG |  \
 152                                  CDNS_UART_IXR_TOUT)
 153
 154 /* Goes in read_status_mask for break detection as the HW doesn't do it*/
 155 #define CDNS_UART_IXR_BRK       0x00002000
 156
 157 #define CDNS_UART_RXBS_SUPPORT BIT(1)
 158 /*
 159  * Modem Control register:
 160  * The read/write Modem Control register controls the interface with the modem
 161  * or data set, or a peripheral device emulating a modem.
 162  */
 163 #define CDNS_UART_MODEMCR_FCM   0x00000020 /* Automatic flow control mode */
 164 #define CDNS_UART_MODEMCR_RTS   0x00000002 /* Request to send output control */
 165 #define CDNS_UART_MODEMCR_DTR   0x00000001 /* Data Terminal Ready */
 166
 167 /*
 168  * Channel Status Register:
 169  * The channel status register (CSR) is provided to enable the control logic
 170  * to monitor the status of bits in the channel interrupt status register,
 171  * even if these are masked out by the interrupt mask register.
 172  */
 173 #define CDNS_UART_SR_RXEMPTY    0x00000002 /* RX FIFO empty */
 174 #define CDNS_UART_SR_TXEMPTY    0x00000008 /* TX FIFO empty */
 175 #define CDNS_UART_SR_TXFULL     0x00000010 /* TX FIFO full */
 176 #define CDNS_UART_SR_RXTRIG     0x00000001 /* Rx Trigger */
 177
 178 /* baud dividers min/max values */
 179 #define CDNS_UART_BDIV_MIN      4
 180 #define CDNS_UART_BDIV_MAX      255
 181 #define CDNS_UART_CD_MAX        65535
 182 #define UART_AUTOSUSPEND_TIMEOUT        3000
 183
 184 /**
 185  * struct cdns_uart - device data
 186  * @port:               Pointer to the UART port
 187  * @uartclk:            Reference clock
 188  * @pclk:               APB clock
 189  * @baud:               Current baud rate
 190  * @clk_rate_change_nb: Notifier block for clock changes
 191  * @quirks:             Flags for RXBS support.
 192  */
 193 struct cdns_uart {
 194         struct uart_port        *port;
 195         struct clk              *uartclk;
 196         struct clk              *pclk;
 197         unsigned int            baud;
 198         struct notifier_block   clk_rate_change_nb;
 199         u32                     quirks;
 200 };
 201 struct cdns_platform_data {
 202         u32 quirks;
 203 };
 204 #define to_cdns_uart(_nb) container_of(_nb, struct cdns_uart, \
 205                 clk_rate_change_nb);
 206
 207 /**
 208  * cdns_uart_handle_rx - Handle the received bytes along with Rx errors.
 209  * @dev_id: Id of the UART port
 210  * @isrstatus: The interrupt status register value as read
 211  * Return: None
 212  */
 213 static void cdns_uart_handle_rx(void *dev_id, unsigned int isrstatus)
 214 {
 215         struct uart_port *port = (struct uart_port *)dev_id;
 216         struct cdns_uart *cdns_uart = port->private_data;
 217         unsigned int data;
 218         unsigned int rxbs_status = 0;
 219         unsigned int status_mask;
 220         unsigned int framerrprocessed = 0;
 221         char status = TTY_NORMAL;
 222         bool is_rxbs_support;
 223
 224         is_rxbs_support = cdns_uart->quirks & CDNS_UART_RXBS_SUPPORT;
 225
 226         while ((readl(port->membase + CDNS_UART_SR) &
 227                 CDNS_UART_SR_RXEMPTY) != CDNS_UART_SR_RXEMPTY) {
 228                 if (is_rxbs_support)
 229                         rxbs_status = readl(port->membase + CDNS_UART_RXBS);
 230                 data = readl(port->membase + CDNS_UART_FIFO);
 231                 port->icount.rx++;
 232                 /*
 233                  * There is no hardware break detection in Zynq, so we interpret
 234                  * framing error with all-zeros data as a break sequence.
 235                  * Most of the time, there's another non-zero byte at the
 236                  * end of the sequence.
 237                  */
 238                 if (!is_rxbs_support && (isrstatus & CDNS_UART_IXR_FRAMING)) {
 239                         if (!data) {
 240                                 port->read_status_mask |= CDNS_UART_IXR_BRK;
 241                                 framerrprocessed = 1;
 242                                 continue;
 243                         }
 244                 }
 245                 if (is_rxbs_support && (rxbs_status & CDNS_UART_RXBS_BRK)) {
 246                         port->icount.brk++;
 247                         status = TTY_BREAK;
 248                         if (uart_handle_break(port))
 249                                 continue;
 250                 }
 251
 252                 isrstatus &= port->read_status_mask;
 253                 isrstatus &= ~port->ignore_status_mask;
 254                 status_mask = port->read_status_mask;
 255                 status_mask &= ~port->ignore_status_mask;
 256
 257                 if (data &&
 258                     (port->read_status_mask & CDNS_UART_IXR_BRK)) {
 259                         port->read_status_mask &= ~CDNS_UART_IXR_BRK;
 260                         port->icount.brk++;
 261                         if (uart_handle_break(port))
 262                                 continue;
 263                 }
 264
 265                 if (uart_handle_sysrq_char(port, data))
 266                         continue;
 267
 268                 if (is_rxbs_support) {
 269                         if ((rxbs_status & CDNS_UART_RXBS_PARITY)
 270                             && (status_mask & CDNS_UART_IXR_PARITY)) {
 271                                 port->icount.parity++;
 272                                 status = TTY_PARITY;
 273                         }
 274                         if ((rxbs_status & CDNS_UART_RXBS_FRAMING)
 275                             && (status_mask & CDNS_UART_IXR_PARITY)) {
 276                                 port->icount.frame++;
 277                                 status = TTY_FRAME;
 278                         }
 279                 } else {
 280                         if (isrstatus & CDNS_UART_IXR_PARITY) {
 281                                 port->icount.parity++;
 282                                 status = TTY_PARITY;
 283                         }
 284                         if ((isrstatus & CDNS_UART_IXR_FRAMING) &&
 285                             !framerrprocessed) {
 286                                 port->icount.frame++;
 287                                 status = TTY_FRAME;
 288                         }
 289                 }
 290                 if (isrstatus & CDNS_UART_IXR_OVERRUN) {
 291                         port->icount.overrun++;
 292                         tty_insert_flip_char(&port->state->port, 0,
 293                                              TTY_OVERRUN);
 294                 }
 295                 tty_insert_flip_char(&port->state->port, data, status);
 296                 isrstatus = 0;
 297         }
 298         spin_unlock(&port->lock);
 299         tty_flip_buffer_push(&port->state->port);
 300         spin_lock(&port->lock);
 301 }
 302
 303 /**
 304  * cdns_uart_handle_tx - Handle the bytes to be Txed.
 305  * @dev_id: Id of the UART port
 306  * Return: None
 307  */
 308 static void cdns_uart_handle_tx(void *dev_id)
 309 {
 310         struct uart_port *port = (struct uart_port *)dev_id;
 311         unsigned int numbytes;
 312
 313         if (uart_circ_empty(&port->state->xmit)) {
 314                 writel(CDNS_UART_IXR_TXEMPTY, port->membase + CDNS_UART_IDR);
 315         } else {
 316                 numbytes = port->fifosize;
 317                 while (numbytes && !uart_circ_empty(&port->state->xmit) &&
 318                        !(readl(port->membase + CDNS_UART_SR) & CDNS_UART_SR_TXFULL)) {
 319                         /*
 320                          * Get the data from the UART circular buffer
 321                          * and write it to the cdns_uart's TX_FIFO
 322                          * register.
 323                          */
 324                         writel(
 325                                 port->state->xmit.buf[port->state->xmit.
 326                                 tail], port->membase + CDNS_UART_FIFO);
 327
 328                         port->icount.tx++;
 329
 330                         /*
 331                          * Adjust the tail of the UART buffer and wrap
 332                          * the buffer if it reaches limit.
 333                          */
 334                         port->state->xmit.tail =
 335                                 (port->state->xmit.tail + 1) &
 336                                         (UART_XMIT_SIZE - 1);
 337
 338                         numbytes--;
 339                 }
 340
 341                 if (uart_circ_chars_pending(
 342                                 &port->state->xmit) < WAKEUP_CHARS)
 343                         uart_write_wakeup(port);
 344         }
 345 }
 346
 347 /**
 348  * cdns_uart_isr - Interrupt handler
 349  * @irq: Irq number
 350  * @dev_id: Id of the port
 351  *
 352  * Return: IRQHANDLED
 353  */
 354 static irqreturn_t cdns_uart_isr(int irq, void *dev_id)
 355 {
 356         struct uart_port *port = (struct uart_port *)dev_id;
 357         unsigned int isrstatus;
 358
 359         spin_lock(&port->lock);
 360
 361         /* Read the interrupt status register to determine which
 362          * interrupt(s) is/are active and clear them.
 363          */
 364         isrstatus = readl(port->membase + CDNS_UART_ISR);
 365         writel(isrstatus, port->membase + CDNS_UART_ISR);
 366
 367         if (isrstatus & CDNS_UART_IXR_TXEMPTY) {
 368                 cdns_uart_handle_tx(dev_id);
 369                 isrstatus &= ~CDNS_UART_IXR_TXEMPTY;
 370         }
 371
 372         /*
 373          * Skip RX processing if RX is disabled as RXEMPTY will never be set
 374          * as read bytes will not be removed from the FIFO.
 375          */
 376         if (isrstatus & CDNS_UART_IXR_RXMASK &&
 377             !(readl(port->membase + CDNS_UART_CR) & CDNS_UART_CR_RX_DIS))
 378                 cdns_uart_handle_rx(dev_id, isrstatus);
 379
 380         spin_unlock(&port->lock);
 381         return IRQ_HANDLED;
 382 }
 383
 384 /**
 385  * cdns_uart_calc_baud_divs - Calculate baud rate divisors
 386  * @clk: UART module input clock
 387  * @baud: Desired baud rate
 388  * @rbdiv: BDIV value (return value)
 389  * @rcd: CD value (return value)
 390  * @div8: Value for clk_sel bit in mod (return value)
 391  * Return: baud rate, requested baud when possible, or actual baud when there
 392  *      was too much error, zero if no valid divisors are found.
 393  *
 394  * Formula to obtain baud rate is
 395  *      baud_tx/rx rate = clk/CD * (BDIV + 1)
 396  *      input_clk = (Uart User Defined Clock or Apb Clock)
 397  *              depends on UCLKEN in MR Reg
 398  *      clk = input_clk or input_clk/8;
 399  *              depends on CLKS in MR reg
 400  *      CD and BDIV depends on values in
 401  *                      baud rate generate register
 402  *                      baud rate clock divisor register
 403  */
 404 static unsigned int cdns_uart_calc_baud_divs(unsigned int clk,
 405                 unsigned int baud, u32 *rbdiv, u32 *rcd, int *div8)
 406 {
 407         u32 cd, bdiv;
 408         unsigned int calc_baud;
 409         unsigned int bestbaud = 0;
 410         unsigned int bauderror;
 411         unsigned int besterror = ~0;
 412
 413         if (baud < clk / ((CDNS_UART_BDIV_MAX + 1) * CDNS_UART_CD_MAX)) {
 414                 *div8 = 1;
 415                 clk /= 8;
 416         } else {
 417                 *div8 = 0;
 418         }
 419
 420         for (bdiv = CDNS_UART_BDIV_MIN; bdiv <= CDNS_UART_BDIV_MAX; bdiv++) {
 421                 cd = DIV_ROUND_CLOSEST(clk, baud * (bdiv + 1));
 422                 if (cd < 1 || cd > CDNS_UART_CD_MAX)
 423                         continue;
 424
 425                 calc_baud = clk / (cd * (bdiv + 1));
 426
 427                 if (baud > calc_baud)
 428                         bauderror = baud - calc_baud;
 429                 else
 430                         bauderror = calc_baud - baud;
 431
 432                 if (besterror > bauderror) {
 433                         *rbdiv = bdiv;
 434                         *rcd = cd;
 435                         bestbaud = calc_baud;
 436                         besterror = bauderror;
 437                 }
 438         }
 439         /* use the values when percent error is acceptable */
 440         if (((besterror * 100) / baud) < 3)
 441                 bestbaud = baud;
 442
 443         return bestbaud;
 444 }
 445
 446 /**
 447  * cdns_uart_set_baud_rate - Calculate and set the baud rate
 448  * @port: Handle to the uart port structure
 449  * @baud: Baud rate to set
 450  * Return: baud rate, requested baud when possible, or actual baud when there
 451  *         was too much error, zero if no valid divisors are found.
 452  */
 453 static unsigned int cdns_uart_set_baud_rate(struct uart_port *port,
 454                 unsigned int baud)
 455 {
 456         unsigned int calc_baud;
 457         u32 cd = 0, bdiv = 0;
 458         u32 mreg;
 459         int div8;
 460         struct cdns_uart *cdns_uart = port->private_data;
 461
 462         calc_baud = cdns_uart_calc_baud_divs(port->uartclk, baud, &bdiv, &cd,
 463                         &div8);
 464
 465         /* Write new divisors to hardware */
 466         mreg = readl(port->membase + CDNS_UART_MR);
 467         if (div8)
 468                 mreg |= CDNS_UART_MR_CLKSEL;
 469         else
 470                 mreg &= ~CDNS_UART_MR_CLKSEL;
 471         writel(mreg, port->membase + CDNS_UART_MR);
 472         writel(cd, port->membase + CDNS_UART_BAUDGEN);
 473         writel(bdiv, port->membase + CDNS_UART_BAUDDIV);
 474         cdns_uart->baud = baud;
 475
 476         return calc_baud;
 477 }
 478
 479 #ifdef CONFIG_COMMON_CLK
 480 /**
 481  * cdns_uart_clk_notitifer_cb - Clock notifier callback
 482  * @nb:         Notifier block
 483  * @event:      Notify event
 484  * @data:       Notifier data
 485  * Return:      NOTIFY_OK or NOTIFY_DONE on success, NOTIFY_BAD on error.
 486  */
 487 static int cdns_uart_clk_notifier_cb(struct notifier_block *nb,
 488                 unsigned long event, void *data)
 489 {
 490         u32 ctrl_reg;
 491         struct uart_port *port;
 492         int locked = 0;
 493         struct clk_notifier_data *ndata = data;
 494         unsigned long flags = 0;
 495         struct cdns_uart *cdns_uart = to_cdns_uart(nb);
 496
 497         port = cdns_uart->port;
 498         if (port->suspended)
 499                 return NOTIFY_OK;
 500
 501         switch (event) {
 502         case PRE_RATE_CHANGE:
 503         {
 504                 u32 bdiv, cd;
 505                 int div8;
 506
 507                 /*
 508                  * Find out if current baud-rate can be achieved with new clock
 509                  * frequency.
 510                  */
 511                 if (!cdns_uart_calc_baud_divs(ndata->new_rate, cdns_uart->baud,
 512                                         &bdiv, &cd, &div8)) {
 513                         dev_warn(port->dev, "clock rate change rejected\n");
 514                         return NOTIFY_BAD;
 515                 }
 516
 517                 spin_lock_irqsave(&cdns_uart->port->lock, flags);
 518
 519                 /* Disable the TX and RX to set baud rate */
 520                 ctrl_reg = readl(port->membase + CDNS_UART_CR);
 521                 ctrl_reg |= CDNS_UART_CR_TX_DIS | CDNS_UART_CR_RX_DIS;
 522                 writel(ctrl_reg, port->membase + CDNS_UART_CR);
 523
 524                 spin_unlock_irqrestore(&cdns_uart->port->lock, flags);
 525
 526                 return NOTIFY_OK;
 527         }
 528         case POST_RATE_CHANGE:
 529                 /*
 530                  * Set clk dividers to generate correct baud with new clock
 531                  * frequency.
 532                  */
 533
 534                 spin_lock_irqsave(&cdns_uart->port->lock, flags);
 535
 536                 locked = 1;
 537                 port->uartclk = ndata->new_rate;
 538
 539                 cdns_uart->baud = cdns_uart_set_baud_rate(cdns_uart->port,
 540                                 cdns_uart->baud);
 541                 /* fall through */
 542         case ABORT_RATE_CHANGE:
 543                 if (!locked)
 544                         spin_lock_irqsave(&cdns_uart->port->lock, flags);
 545
 546                 /* Set TX/RX Reset */
 547                 ctrl_reg = readl(port->membase + CDNS_UART_CR);
 548                 ctrl_reg |= CDNS_UART_CR_TXRST | CDNS_UART_CR_RXRST;
 549                 writel(ctrl_reg, port->membase + CDNS_UART_CR);
 550
 551                 while (readl(port->membase + CDNS_UART_CR) &
 552                                 (CDNS_UART_CR_TXRST | CDNS_UART_CR_RXRST))
 553                         cpu_relax();
 554
 555                 /*
 556                  * Clear the RX disable and TX disable bits and then set the TX
 557                  * enable bit and RX enable bit to enable the transmitter and
 558                  * receiver.
 559                  */
 560                 writel(rx_timeout, port->membase + CDNS_UART_RXTOUT);
 561                 ctrl_reg = readl(port->membase + CDNS_UART_CR);
 562                 ctrl_reg &= ~(CDNS_UART_CR_TX_DIS | CDNS_UART_CR_RX_DIS);
 563                 ctrl_reg |= CDNS_UART_CR_TX_EN | CDNS_UART_CR_RX_EN;
 564                 writel(ctrl_reg, port->membase + CDNS_UART_CR);
 565
 566                 spin_unlock_irqrestore(&cdns_uart->port->lock, flags);
 567
 568                 return NOTIFY_OK;
 569         default:
 570                 return NOTIFY_DONE;
 571         }
 572 }
 573 #endif
 574
 575 /**
 576  * cdns_uart_start_tx -  Start transmitting bytes
 577  * @port: Handle to the uart port structure
 578  */
 579 static void cdns_uart_start_tx(struct uart_port *port)
 580 {
 581         unsigned int status;
 582
 583         if (uart_tx_stopped(port))
 584                 return;
 585
 586         /*
 587          * Set the TX enable bit and clear the TX disable bit to enable the
 588          * transmitter.
 589          */
 590         status = readl(port->membase + CDNS_UART_CR);
 591         status &= ~CDNS_UART_CR_TX_DIS;
 592         status |= CDNS_UART_CR_TX_EN;
 593         writel(status, port->membase + CDNS_UART_CR);
 594
 595         if (uart_circ_empty(&port->state->xmit))
 596                 return;
 597
 598         cdns_uart_handle_tx(port);
 599
 600         writel(CDNS_UART_IXR_TXEMPTY, port->membase + CDNS_UART_ISR);
 601         /* Enable the TX Empty interrupt */
 602         writel(CDNS_UART_IXR_TXEMPTY, port->membase + CDNS_UART_IER);
 603 }
 604
 605 /**
 606  * cdns_uart_stop_tx - Stop TX
 607  * @port: Handle to the uart port structure
 608  */
 609 static void cdns_uart_stop_tx(struct uart_port *port)
 610 {
 611         unsigned int regval;
 612
 613         regval = readl(port->membase + CDNS_UART_CR);
 614         regval |= CDNS_UART_CR_TX_DIS;
 615         /* Disable the transmitter */
 616         writel(regval, port->membase + CDNS_UART_CR);
 617 }
 618
 619 /**
 620  * cdns_uart_stop_rx - Stop RX
 621  * @port: Handle to the uart port structure
 622  */
 623 static void cdns_uart_stop_rx(struct uart_port *port)
 624 {
 625         unsigned int regval;
 626
 627         /* Disable RX IRQs */
 628         writel(CDNS_UART_RX_IRQS, port->membase + CDNS_UART_IDR);
 629
 630         /* Disable the receiver */
 631         regval = readl(port->membase + CDNS_UART_CR);
 632         regval |= CDNS_UART_CR_RX_DIS;
 633         writel(regval, port->membase + CDNS_UART_CR);
 634 }
 635
 636 /**
 637  * cdns_uart_tx_empty -  Check whether TX is empty
 638  * @port: Handle to the uart port structure
 639  *
 640  * Return: TIOCSER_TEMT on success, 0 otherwise
 641  */
 642 static unsigned int cdns_uart_tx_empty(struct uart_port *port)
 643 {
 644         unsigned int status;
 645
 646         status = readl(port->membase + CDNS_UART_SR) &
 647                                 CDNS_UART_SR_TXEMPTY;
 648         return status ? TIOCSER_TEMT : 0;
 649 }
 650
 651 /**
 652  * cdns_uart_break_ctl - Based on the input ctl we have to start or stop
 653  *                      transmitting char breaks
 654  * @port: Handle to the uart port structure
 655  * @ctl: Value based on which start or stop decision is taken
 656  */
 657 static void cdns_uart_break_ctl(struct uart_port *port, int ctl)
 658 {
 659         unsigned int status;
 660         unsigned long flags;
 661
 662         spin_lock_irqsave(&port->lock, flags);
 663
 664         status = readl(port->membase + CDNS_UART_CR);
 665
 666         if (ctl == -1)
 667                 writel(CDNS_UART_CR_STARTBRK | status,
 668                                 port->membase + CDNS_UART_CR);
 669         else {
 670                 if ((status & CDNS_UART_CR_STOPBRK) == 0)
 671                         writel(CDNS_UART_CR_STOPBRK | status,
 672                                         port->membase + CDNS_UART_CR);
 673         }
 674         spin_unlock_irqrestore(&port->lock, flags);
 675 }
 676
 677 /**
 678  * cdns_uart_set_termios - termios operations, handling data length, parity,
 679  *                              stop bits, flow control, baud rate
 680  * @port: Handle to the uart port structure
 681  * @termios: Handle to the input termios structure
 682  * @old: Values of the previously saved termios structure
 683  */
 684 static void cdns_uart_set_termios(struct uart_port *port,
 685                                 struct ktermios *termios, struct ktermios *old)
 686 {
 687         unsigned int cval = 0;
 688         unsigned int baud, minbaud, maxbaud;
 689         unsigned long flags;
 690         unsigned int ctrl_reg, mode_reg, val;
 691         int err;
 692
 693         /* Wait for the transmit FIFO to empty before making changes */
 694         if (!(readl(port->membase + CDNS_UART_CR) &
 695                                 CDNS_UART_CR_TX_DIS)) {
 696                 err = readl_poll_timeout(port->membase + CDNS_UART_SR,
 697                                          val, (val & CDNS_UART_SR_TXEMPTY),
 698                                          1000, TX_TIMEOUT);
 699                 if (err) {
 700                         dev_err(port->dev, "timed out waiting for tx empty");
 701                         return;
 702                 }
 703         }
 704         spin_lock_irqsave(&port->lock, flags);
 705
 706         /* Disable the TX and RX to set baud rate */
 707         ctrl_reg = readl(port->membase + CDNS_UART_CR);
 708         ctrl_reg |= CDNS_UART_CR_TX_DIS | CDNS_UART_CR_RX_DIS;
 709         writel(ctrl_reg, port->membase + CDNS_UART_CR);
 710
 711         /*
 712          * Min baud rate = 6bps and Max Baud Rate is 10Mbps for 100Mhz clk
 713          * min and max baud should be calculated here based on port->uartclk.
 714          * this way we get a valid baud and can safely call set_baud()
 715          */
 716         minbaud = port->uartclk /
 717                         ((CDNS_UART_BDIV_MAX + 1) * CDNS_UART_CD_MAX * 8);
 718         maxbaud = port->uartclk / (CDNS_UART_BDIV_MIN + 1);
 719         baud = uart_get_baud_rate(port, termios, old, minbaud, maxbaud);
 720         baud = cdns_uart_set_baud_rate(port, baud);
 721         if (tty_termios_baud_rate(termios))
 722                 tty_termios_encode_baud_rate(termios, baud, baud);
 723
 724         /* Update the per-port timeout. */
 725         uart_update_timeout(port, termios->c_cflag, baud);
 726
 727         /* Set TX/RX Reset */
 728         ctrl_reg = readl(port->membase + CDNS_UART_CR);
 729         ctrl_reg |= CDNS_UART_CR_TXRST | CDNS_UART_CR_RXRST;
 730         writel(ctrl_reg, port->membase + CDNS_UART_CR);
 731
 732         while (readl(port->membase + CDNS_UART_CR) &
 733                 (CDNS_UART_CR_TXRST | CDNS_UART_CR_RXRST))
 734                 cpu_relax();
 735
 736         /*
 737          * Clear the RX disable and TX disable bits and then set the TX enable
 738          * bit and RX enable bit to enable the transmitter and receiver.
 739          */
 740         ctrl_reg = readl(port->membase + CDNS_UART_CR);
 741         ctrl_reg &= ~(CDNS_UART_CR_TX_DIS | CDNS_UART_CR_RX_DIS);
 742         ctrl_reg |= CDNS_UART_CR_TX_EN | CDNS_UART_CR_RX_EN;
 743         writel(ctrl_reg, port->membase + CDNS_UART_CR);
 744
 745         writel(rx_timeout, port->membase + CDNS_UART_RXTOUT);
 746
 747         port->read_status_mask = CDNS_UART_IXR_TXEMPTY | CDNS_UART_IXR_RXTRIG |
 748                         CDNS_UART_IXR_OVERRUN | CDNS_UART_IXR_TOUT;
 749         port->ignore_status_mask = 0;
 750
 751         if (termios->c_iflag & INPCK)
 752                 port->read_status_mask |= CDNS_UART_IXR_PARITY |
 753                 CDNS_UART_IXR_FRAMING;
 754
 755         if (termios->c_iflag & IGNPAR)
 756                 port->ignore_status_mask |= CDNS_UART_IXR_PARITY |
 757                         CDNS_UART_IXR_FRAMING | CDNS_UART_IXR_OVERRUN;
 758
 759         /* ignore all characters if CREAD is not set */
 760         if ((termios->c_cflag & CREAD) == 0)
 761                 port->ignore_status_mask |= CDNS_UART_IXR_RXTRIG |
 762                         CDNS_UART_IXR_TOUT | CDNS_UART_IXR_PARITY |
 763                         CDNS_UART_IXR_FRAMING | CDNS_UART_IXR_OVERRUN;
 764
 765         mode_reg = readl(port->membase + CDNS_UART_MR);
 766
 767         /* Handling Data Size */
 768         switch (termios->c_cflag & CSIZE) {
 769         case CS6:
 770                 cval |= CDNS_UART_MR_CHARLEN_6_BIT;
 771                 break;
 772         case CS7:
 773                 cval |= CDNS_UART_MR_CHARLEN_7_BIT;
 774                 break;
 775         default:
 776         case CS8:
 777                 cval |= CDNS_UART_MR_CHARLEN_8_BIT;
 778                 termios->c_cflag &= ~CSIZE;
 779                 termios->c_cflag |= CS8;
 780                 break;
 781         }
 782
 783         /* Handling Parity and Stop Bits length */
 784         if (termios->c_cflag & CSTOPB)
 785                 cval |= CDNS_UART_MR_STOPMODE_2_BIT; /* 2 STOP bits */
 786         else
 787                 cval |= CDNS_UART_MR_STOPMODE_1_BIT; /* 1 STOP bit */
 788
 789         if (termios->c_cflag & PARENB) {
 790                 /* Mark or Space parity */
 791                 if (termios->c_cflag & CMSPAR) {
 792                         if (termios->c_cflag & PARODD)
 793                                 cval |= CDNS_UART_MR_PARITY_MARK;
 794                         else
 795                                 cval |= CDNS_UART_MR_PARITY_SPACE;
 796                 } else {
 797                         if (termios->c_cflag & PARODD)
 798                                 cval |= CDNS_UART_MR_PARITY_ODD;
 799                         else
 800                                 cval |= CDNS_UART_MR_PARITY_EVEN;
 801                 }
 802         } else {
 803                 cval |= CDNS_UART_MR_PARITY_NONE;
 804         }
 805         cval |= mode_reg & 1;
 806         writel(cval, port->membase + CDNS_UART_MR);
 807
 808         spin_unlock_irqrestore(&port->lock, flags);
 809 }
 810
 811 /**
 812  * cdns_uart_startup - Called when an application opens a cdns_uart port
 813  * @port: Handle to the uart port structure
 814  *
 815  * Return: 0 on success, negative errno otherwise
 816  */
 817 static int cdns_uart_startup(struct uart_port *port)
 818 {
 819         struct cdns_uart *cdns_uart = port->private_data;
 820         bool is_brk_support;
 821         int ret;
 822         unsigned long flags;
 823         unsigned int status = 0;
 824
 825         is_brk_support = cdns_uart->quirks & CDNS_UART_RXBS_SUPPORT;
 826
 827         spin_lock_irqsave(&port->lock, flags);
 828
 829         /* Disable the TX and RX */
 830         writel(CDNS_UART_CR_TX_DIS | CDNS_UART_CR_RX_DIS,
 831                         port->membase + CDNS_UART_CR);
 832
 833         /* Set the Control Register with TX/RX Enable, TX/RX Reset,
 834          * no break chars.
 835          */
 836         writel(CDNS_UART_CR_TXRST | CDNS_UART_CR_RXRST,
 837                         port->membase + CDNS_UART_CR);
 838
 839         while (readl(port->membase + CDNS_UART_CR) &
 840                 (CDNS_UART_CR_TXRST | CDNS_UART_CR_RXRST))
 841                 cpu_relax();
 842
 843         /*
 844          * Clear the RX disable bit and then set the RX enable bit to enable
 845          * the receiver.
 846          */
 847         status = readl(port->membase + CDNS_UART_CR);
 848         status &= CDNS_UART_CR_RX_DIS;
 849         status |= CDNS_UART_CR_RX_EN;
 850         writel(status, port->membase + CDNS_UART_CR);
 851
 852         /* Set the Mode Register with normal mode,8 data bits,1 stop bit,
 853          * no parity.
 854          */
 855         writel(CDNS_UART_MR_CHMODE_NORM | CDNS_UART_MR_STOPMODE_1_BIT
 856                 | CDNS_UART_MR_PARITY_NONE | CDNS_UART_MR_CHARLEN_8_BIT,
 857                 port->membase + CDNS_UART_MR);
 858
 859         /*
 860          * Set the RX FIFO Trigger level to use most of the FIFO, but it
 861          * can be tuned with a module parameter
 862          */
 863         writel(rx_trigger_level, port->membase + CDNS_UART_RXWM);
 864
 865         /*
 866          * Receive Timeout register is enabled but it
 867          * can be tuned with a module parameter
 868          */
 869         writel(rx_timeout, port->membase + CDNS_UART_RXTOUT);
 870
 871         /* Clear out any pending interrupts before enabling them */
 872         writel(readl(port->membase + CDNS_UART_ISR),
 873                         port->membase + CDNS_UART_ISR);
 874
 875         spin_unlock_irqrestore(&port->lock, flags);
 876
 877         ret = request_irq(port->irq, cdns_uart_isr, 0, CDNS_UART_NAME, port);
 878         if (ret) {
 879                 dev_err(port->dev, "request_irq '%d' failed with %d\n",
 880                         port->irq, ret);
 881                 return ret;
 882         }
 883
 884         /* Set the Interrupt Registers with desired interrupts */
 885         if (is_brk_support)
 886                 writel(CDNS_UART_RX_IRQS | CDNS_UART_IXR_BRK,
 887                                         port->membase + CDNS_UART_IER);
 888         else
 889                 writel(CDNS_UART_RX_IRQS, port->membase + CDNS_UART_IER);
 890
 891         return 0;
 892 }
 893
 894 /**
 895  * cdns_uart_shutdown - Called when an application closes a cdns_uart port
 896  * @port: Handle to the uart port structure
 897  */
 898 static void cdns_uart_shutdown(struct uart_port *port)
 899 {
 900         int status;
 901         unsigned long flags;
 902
 903         spin_lock_irqsave(&port->lock, flags);
 904
 905         /* Disable interrupts */
 906         status = readl(port->membase + CDNS_UART_IMR);
 907         writel(status, port->membase + CDNS_UART_IDR);
 908         writel(0xffffffff, port->membase + CDNS_UART_ISR);
 909
 910         /* Disable the TX and RX */
 911         writel(CDNS_UART_CR_TX_DIS | CDNS_UART_CR_RX_DIS,
 912                         port->membase + CDNS_UART_CR);
 913
 914         spin_unlock_irqrestore(&port->lock, flags);
 915
 916         free_irq(port->irq, port);
 917 }
 918
 919 /**
 920  * cdns_uart_type - Set UART type to cdns_uart port
 921  * @port: Handle to the uart port structure
 922  *
 923  * Return: string on success, NULL otherwise
 924  */
 925 static const char *cdns_uart_type(struct uart_port *port)
 926 {
 927         return port->type == PORT_XUARTPS ? CDNS_UART_NAME : NULL;
 928 }
 929
 930 /**
 931  * cdns_uart_verify_port - Verify the port params
 932  * @port: Handle to the uart port structure
 933  * @ser: Handle to the structure whose members are compared
 934  *
 935  * Return: 0 on success, negative errno otherwise.
 936  */
 937 static int cdns_uart_verify_port(struct uart_port *port,
 938                                         struct serial_struct *ser)
 939 {
 940         if (ser->type != PORT_UNKNOWN && ser->type != PORT_XUARTPS)
 941                 return -EINVAL;
 942         if (port->irq != ser->irq)
 943                 return -EINVAL;
 944         if (ser->io_type != UPIO_MEM)
 945                 return -EINVAL;
 946         if (port->iobase != ser->port)
 947                 return -EINVAL;
 948         if (ser->hub6 != 0)
 949                 return -EINVAL;
 950         return 0;
 951 }
 952
 953 /**
 954  * cdns_uart_request_port - Claim the memory region attached to cdns_uart port,
 955  *                              called when the driver adds a cdns_uart port via
 956  *                              uart_add_one_port()
 957  * @port: Handle to the uart port structure
 958  *
 959  * Return: 0 on success, negative errno otherwise.
 960  */
 961 static int cdns_uart_request_port(struct uart_port *port)
 962 {
 963         if (!request_mem_region(port->mapbase, CDNS_UART_REGISTER_SPACE,
 964                                          CDNS_UART_NAME)) {
 965                 return -ENOMEM;
 966         }
 967
 968         port->membase = ioremap(port->mapbase, CDNS_UART_REGISTER_SPACE);
 969         if (!port->membase) {
 970                 dev_err(port->dev, "Unable to map registers\n");
 971                 release_mem_region(port->mapbase, CDNS_UART_REGISTER_SPACE);
 972                 return -ENOMEM;
 973         }
 974         return 0;
 975 }
 976
 977 /**
 978  * cdns_uart_release_port - Release UART port
 979  * @port: Handle to the uart port structure
 980  *
 981  * Release the memory region attached to a cdns_uart port. Called when the
 982  * driver removes a cdns_uart port via uart_remove_one_port().
 983  */
 984 static void cdns_uart_release_port(struct uart_port *port)
 985 {
 986         release_mem_region(port->mapbase, CDNS_UART_REGISTER_SPACE);
 987         iounmap(port->membase);
 988         port->membase = NULL;
 989 }
 990
 991 /**
 992  * cdns_uart_config_port - Configure UART port
 993  * @port: Handle to the uart port structure
 994  * @flags: If any
 995  */
 996 static void cdns_uart_config_port(struct uart_port *port, int flags)
 997 {
 998         if (flags & UART_CONFIG_TYPE && cdns_uart_request_port(port) == 0)
 999                 port->type = PORT_XUARTPS;
1000 }
1001
1002 /**
1003  * cdns_uart_get_mctrl - Get the modem control state
1004  * @port: Handle to the uart port structure
1005  *
1006  * Return: the modem control state
1007  */
1008 static unsigned int cdns_uart_get_mctrl(struct uart_port *port)
1009 {
1010         return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
1011 }
1012
1013 static void cdns_uart_set_mctrl(struct uart_port *port, unsigned int mctrl)
1014 {
1015         u32 val;
1016         u32 mode_reg;
1017
1018         val = readl(port->membase + CDNS_UART_MODEMCR);
1019         mode_reg = readl(port->membase + CDNS_UART_MR);
1020
1021         val &= ~(CDNS_UART_MODEMCR_RTS | CDNS_UART_MODEMCR_DTR);
1022         mode_reg &= ~CDNS_UART_MR_CHMODE_MASK;
1023
1024         if (mctrl & TIOCM_RTS)
1025                 val |= CDNS_UART_MODEMCR_RTS;
1026         if (mctrl & TIOCM_DTR)
1027                 val |= CDNS_UART_MODEMCR_DTR;
1028         if (mctrl & TIOCM_LOOP)
1029                 mode_reg |= CDNS_UART_MR_CHMODE_L_LOOP;
1030         else
1031                 mode_reg |= CDNS_UART_MR_CHMODE_NORM;
1032
1033         writel(val, port->membase + CDNS_UART_MODEMCR);
1034         writel(mode_reg, port->membase + CDNS_UART_MR);
1035 }
1036
1037 #ifdef CONFIG_CONSOLE_POLL
1038 static int cdns_uart_poll_get_char(struct uart_port *port)
1039 {
1040         int c;
1041         unsigned long flags;
1042
1043         spin_lock_irqsave(&port->lock, flags);
1044
1045         /* Check if FIFO is empty */
1046         if (readl(port->membase + CDNS_UART_SR) & CDNS_UART_SR_RXEMPTY)
1047                 c = NO_POLL_CHAR;
1048         else /* Read a character */
1049                 c = (unsigned char) readl(port->membase + CDNS_UART_FIFO);
1050
1051         spin_unlock_irqrestore(&port->lock, flags);
1052
1053         return c;
1054 }
1055
1056 static void cdns_uart_poll_put_char(struct uart_port *port, unsigned char c)
1057 {
1058         unsigned long flags;
1059
1060         spin_lock_irqsave(&port->lock, flags);
1061
1062         /* Wait until FIFO is empty */
1063         while (!(readl(port->membase + CDNS_UART_SR) & CDNS_UART_SR_TXEMPTY))
1064                 cpu_relax();
1065
1066         /* Write a character */
1067         writel(c, port->membase + CDNS_UART_FIFO);
1068
1069         /* Wait until FIFO is empty */
1070         while (!(readl(port->membase + CDNS_UART_SR) & CDNS_UART_SR_TXEMPTY))
1071                 cpu_relax();
1072
1073         spin_unlock_irqrestore(&port->lock, flags);
1074
1075         return;
1076 }
1077 #endif
1078
1079 static void cdns_uart_pm(struct uart_port *port, unsigned int state,
1080                    unsigned int oldstate)
1081 {
1082         switch (state) {
1083         case UART_PM_STATE_OFF:
1084                 pm_runtime_mark_last_busy(port->dev);
1085                 pm_runtime_put_autosuspend(port->dev);
1086                 break;
1087         default:
1088                 pm_runtime_get_sync(port->dev);
1089                 break;
1090         }
1091 }
1092
1093 static const struct uart_ops cdns_uart_ops = {
1094         .set_mctrl      = cdns_uart_set_mctrl,
1095         .get_mctrl      = cdns_uart_get_mctrl,
1096         .start_tx       = cdns_uart_start_tx,
1097         .stop_tx        = cdns_uart_stop_tx,
1098         .stop_rx        = cdns_uart_stop_rx,
1099         .tx_empty       = cdns_uart_tx_empty,
1100         .break_ctl      = cdns_uart_break_ctl,
1101         .set_termios    = cdns_uart_set_termios,
1102         .startup        = cdns_uart_startup,
1103         .shutdown       = cdns_uart_shutdown,
1104         .pm             = cdns_uart_pm,
1105         .type           = cdns_uart_type,
1106         .verify_port    = cdns_uart_verify_port,
1107         .request_port   = cdns_uart_request_port,
1108         .release_port   = cdns_uart_release_port,
1109         .config_port    = cdns_uart_config_port,
1110 #ifdef CONFIG_CONSOLE_POLL
1111         .poll_get_char  = cdns_uart_poll_get_char,
1112         .poll_put_char  = cdns_uart_poll_put_char,
1113 #endif
1114 };
1115
1116 static struct uart_port cdns_uart_port[CDNS_UART_NR_PORTS];
1117
1118 /**
1119  * cdns_uart_get_port - Configure the port from platform device resource info
1120  * @id: Port id
1121  *
1122  * Return: a pointer to a uart_port or NULL for failure
1123  */
1124 static struct uart_port *cdns_uart_get_port(int id)
1125 {
1126         struct uart_port *port;
1127
1128         /* Try the given port id if failed use default method */
1129         if (id < CDNS_UART_NR_PORTS && cdns_uart_port[id].mapbase != 0) {
1130                 /* Find the next unused port */
1131                 for (id = 0; id < CDNS_UART_NR_PORTS; id++)
1132                         if (cdns_uart_port[id].mapbase == 0)
1133                                 break;
1134         }
1135
1136         if (id >= CDNS_UART_NR_PORTS)
1137                 return NULL;
1138
1139         port = &cdns_uart_port[id];
1140
1141         /* At this point, we've got an empty uart_port struct, initialize it */
1142         spin_lock_init(&port->lock);
1143         port->membase   = NULL;
1144         port->irq       = 0;
1145         port->type      = PORT_UNKNOWN;
1146         port->iotype    = UPIO_MEM32;
1147         port->flags     = UPF_BOOT_AUTOCONF;
1148         port->ops       = &cdns_uart_ops;
1149         port->fifosize  = CDNS_UART_FIFO_SIZE;
1150         port->line      = id;
1151         port->dev       = NULL;
1152         return port;
1153 }
1154
1155 #ifdef CONFIG_SERIAL_XILINX_PS_UART_CONSOLE
1156 /**
1157  * cdns_uart_console_wait_tx - Wait for the TX to be full
1158  * @port: Handle to the uart port structure
1159  */
1160 static void cdns_uart_console_wait_tx(struct uart_port *port)
1161 {
1162         while (!(readl(port->membase + CDNS_UART_SR) & CDNS_UART_SR_TXEMPTY))
1163                 barrier();
1164 }
1165
1166 /**
1167  * cdns_uart_console_putchar - write the character to the FIFO buffer
1168  * @port: Handle to the uart port structure
1169  * @ch: Character to be written
1170  */
1171 static void cdns_uart_console_putchar(struct uart_port *port, int ch)
1172 {
1173         cdns_uart_console_wait_tx(port);
1174         writel(ch, port->membase + CDNS_UART_FIFO);
1175 }
1176
1177 static void cdns_early_write(struct console *con, const char *s,
1178                                     unsigned n)
1179 {
1180         struct earlycon_device *dev = con->data;
1181
1182         uart_console_write(&dev->port, s, n, cdns_uart_console_putchar);
1183 }
1184
1185 static int __init cdns_early_console_setup(struct earlycon_device *device,
1186                                            const char *opt)
1187 {
1188         struct uart_port *port = &device->port;
1189
1190         if (!port->membase)
1191                 return -ENODEV;
1192
1193         /* initialise control register */
1194         writel(CDNS_UART_CR_TX_EN|CDNS_UART_CR_TXRST|CDNS_UART_CR_RXRST,
1195                port->membase + CDNS_UART_CR);
1196
1197         /* only set baud if specified on command line - otherwise
1198          * assume it has been initialized by a boot loader.
1199          */
1200         if (device->baud) {
1201                 u32 cd = 0, bdiv = 0;
1202                 u32 mr;
1203                 int div8;
1204
1205                 cdns_uart_calc_baud_divs(port->uartclk, device->baud,
1206                                          &bdiv, &cd, &div8);
1207                 mr = CDNS_UART_MR_PARITY_NONE;
1208                 if (div8)
1209                         mr |= CDNS_UART_MR_CLKSEL;
1210
1211                 writel(mr,   port->membase + CDNS_UART_MR);
1212                 writel(cd,   port->membase + CDNS_UART_BAUDGEN);
1213                 writel(bdiv, port->membase + CDNS_UART_BAUDDIV);
1214         }
1215
1216         device->con->write = cdns_early_write;
1217
1218         return 0;
1219 }
1220 OF_EARLYCON_DECLARE(cdns, "xlnx,xuartps", cdns_early_console_setup);
1221 OF_EARLYCON_DECLARE(cdns, "cdns,uart-r1p8", cdns_early_console_setup);
1222 OF_EARLYCON_DECLARE(cdns, "cdns,uart-r1p12", cdns_early_console_setup);
1223 OF_EARLYCON_DECLARE(cdns, "xlnx,zynqmp-uart", cdns_early_console_setup);
1224
1225 /**
1226  * cdns_uart_console_write - perform write operation
1227  * @co: Console handle
1228  * @s: Pointer to character array
1229  * @count: No of characters
1230  */
1231 static void cdns_uart_console_write(struct console *co, const char *s,
1232                                 unsigned int count)
1233 {
1234         struct uart_port *port = &cdns_uart_port[co->index];
1235         unsigned long flags;
1236         unsigned int imr, ctrl;
1237         int locked = 1;
1238
1239         if (port->sysrq)
1240                 locked = 0;
1241         else if (oops_in_progress)
1242                 locked = spin_trylock_irqsave(&port->lock, flags);
1243         else
1244                 spin_lock_irqsave(&port->lock, flags);
1245
1246         /* save and disable interrupt */
1247         imr = readl(port->membase + CDNS_UART_IMR);
1248         writel(imr, port->membase + CDNS_UART_IDR);
1249
1250         /*
1251          * Make sure that the tx part is enabled. Set the TX enable bit and
1252          * clear the TX disable bit to enable the transmitter.
1253          */
1254         ctrl = readl(port->membase + CDNS_UART_CR);
1255         ctrl &= ~CDNS_UART_CR_TX_DIS;
1256         ctrl |= CDNS_UART_CR_TX_EN;
1257         writel(ctrl, port->membase + CDNS_UART_CR);
1258
1259         uart_console_write(port, s, count, cdns_uart_console_putchar);
1260         cdns_uart_console_wait_tx(port);
1261
1262         writel(ctrl, port->membase + CDNS_UART_CR);
1263
1264         /* restore interrupt state */
1265         writel(imr, port->membase + CDNS_UART_IER);
1266
1267         if (locked)
1268                 spin_unlock_irqrestore(&port->lock, flags);
1269 }
1270
1271 /**
1272  * cdns_uart_console_setup - Initialize the uart to default config
1273  * @co: Console handle
1274  * @options: Initial settings of uart
1275  *
1276  * Return: 0 on success, negative errno otherwise.
1277  */
1278 static int cdns_uart_console_setup(struct console *co, char *options)
1279 {
1280         struct uart_port *port = &cdns_uart_port[co->index];
1281         int baud = 9600;
1282         int bits = 8;
1283         int parity = 'n';
1284         int flow = 'n';
1285         unsigned long time_out;
1286
1287         if (co->index < 0 || co->index >= CDNS_UART_NR_PORTS)
1288                 return -EINVAL;
1289
1290         if (!port->membase) {
1291                 pr_debug("console on " CDNS_UART_TTY_NAME "%i not present\n",
1292                          co->index);
1293                 return -ENODEV;
1294         }
1295
1296         if (options)
1297                 uart_parse_options(options, &baud, &parity, &bits, &flow);
1298
1299         /* Wait for tx_empty before setting up the console */
1300         time_out = jiffies + usecs_to_jiffies(TX_TIMEOUT);
1301
1302         while (time_before(jiffies, time_out) &&
1303                cdns_uart_tx_empty(port) != TIOCSER_TEMT)
1304                 cpu_relax();
1305
1306         return uart_set_options(port, co, baud, parity, bits, flow);
1307 }
1308
1309 static struct uart_driver cdns_uart_uart_driver;
1310
1311 static struct console cdns_uart_console = {
1312         .name   = CDNS_UART_TTY_NAME,
1313         .write  = cdns_uart_console_write,
1314         .device = uart_console_device,
1315         .setup  = cdns_uart_console_setup,
1316         .flags  = CON_PRINTBUFFER,
1317         .index  = -1, /* Specified on the cmdline (e.g. console=ttyPS ) */
1318         .data   = &cdns_uart_uart_driver,
1319 };
1320
1321 /**
1322  * cdns_uart_console_init - Initialization call
1323  *
1324  * Return: 0 on success, negative errno otherwise
1325  */
1326 static int __init cdns_uart_console_init(void)
1327 {
1328         register_console(&cdns_uart_console);
1329         return 0;
1330 }
1331
1332 console_initcall(cdns_uart_console_init);
1333
1334 #endif /* CONFIG_SERIAL_XILINX_PS_UART_CONSOLE */
1335
1336 static struct uart_driver cdns_uart_uart_driver = {
1337         .owner          = THIS_MODULE,
1338         .driver_name    = CDNS_UART_NAME,
1339         .dev_name       = CDNS_UART_TTY_NAME,
1340         .major          = CDNS_UART_MAJOR,
1341         .minor          = CDNS_UART_MINOR,
1342         .nr             = CDNS_UART_NR_PORTS,
1343 #ifdef CONFIG_SERIAL_XILINX_PS_UART_CONSOLE
1344         .cons           = &cdns_uart_console,
1345 #endif
1346 };
1347
1348 #ifdef CONFIG_PM_SLEEP
1349 /**
1350  * cdns_uart_suspend - suspend event
1351  * @device: Pointer to the device structure
1352  *
1353  * Return: 0
1354  */
1355 static int cdns_uart_suspend(struct device *device)
1356 {
1357         struct uart_port *port = dev_get_drvdata(device);
1358         int may_wake;
1359
1360         may_wake = device_may_wakeup(device);
1361
1362         if (console_suspend_enabled && may_wake) {
1363                 unsigned long flags = 0;
1364
1365                 spin_lock_irqsave(&port->lock, flags);
1366                 /* Empty the receive FIFO 1st before making changes */
1367                 while (!(readl(port->membase + CDNS_UART_SR) &
1368                                         CDNS_UART_SR_RXEMPTY))
1369                         readl(port->membase + CDNS_UART_FIFO);
1370                 /* set RX trigger level to 1 */
1371                 writel(1, port->membase + CDNS_UART_RXWM);
1372                 /* disable RX timeout interrups */
1373                 writel(CDNS_UART_IXR_TOUT, port->membase + CDNS_UART_IDR);
1374                 spin_unlock_irqrestore(&port->lock, flags);
1375         }
1376
1377         /*
1378          * Call the API provided in serial_core.c file which handles
1379          * the suspend.
1380          */
1381         return uart_suspend_port(&cdns_uart_uart_driver, port);
1382 }
1383
1384 /**
1385  * cdns_uart_resume - Resume after a previous suspend
1386  * @device: Pointer to the device structure
1387  *
1388  * Return: 0
1389  */
1390 static int cdns_uart_resume(struct device *device)
1391 {
1392         struct uart_port *port = dev_get_drvdata(device);
1393         unsigned long flags = 0;
1394         u32 ctrl_reg;
1395         int may_wake;
1396
1397         may_wake = device_may_wakeup(device);
1398
1399         if (console_suspend_enabled && !may_wake) {
1400                 struct cdns_uart *cdns_uart = port->private_data;
1401
1402                 clk_enable(cdns_uart->pclk);
1403                 clk_enable(cdns_uart->uartclk);
1404
1405                 spin_lock_irqsave(&port->lock, flags);
1406
1407                 /* Set TX/RX Reset */
1408                 ctrl_reg = readl(port->membase + CDNS_UART_CR);
1409                 ctrl_reg |= CDNS_UART_CR_TXRST | CDNS_UART_CR_RXRST;
1410                 writel(ctrl_reg, port->membase + CDNS_UART_CR);
1411                 while (readl(port->membase + CDNS_UART_CR) &
1412                                 (CDNS_UART_CR_TXRST | CDNS_UART_CR_RXRST))
1413                         cpu_relax();
1414
1415                 /* restore rx timeout value */
1416                 writel(rx_timeout, port->membase + CDNS_UART_RXTOUT);
1417                 /* Enable Tx/Rx */
1418                 ctrl_reg = readl(port->membase + CDNS_UART_CR);
1419                 ctrl_reg &= ~(CDNS_UART_CR_TX_DIS | CDNS_UART_CR_RX_DIS);
1420                 ctrl_reg |= CDNS_UART_CR_TX_EN | CDNS_UART_CR_RX_EN;
1421                 writel(ctrl_reg, port->membase + CDNS_UART_CR);
1422
1423                 clk_disable(cdns_uart->uartclk);
1424                 clk_disable(cdns_uart->pclk);
1425                 spin_unlock_irqrestore(&port->lock, flags);
1426         } else {
1427                 spin_lock_irqsave(&port->lock, flags);
1428                 /* restore original rx trigger level */
1429                 writel(rx_trigger_level, port->membase + CDNS_UART_RXWM);
1430                 /* enable RX timeout interrupt */
1431                 writel(CDNS_UART_IXR_TOUT, port->membase + CDNS_UART_IER);
1432                 spin_unlock_irqrestore(&port->lock, flags);
1433         }
1434
1435         return uart_resume_port(&cdns_uart_uart_driver, port);
1436 }
1437 #endif /* ! CONFIG_PM_SLEEP */
1438 static int __maybe_unused cdns_runtime_suspend(struct device *dev)
1439 {
1440         struct platform_device *pdev = to_platform_device(dev);
1441         struct uart_port *port = platform_get_drvdata(pdev);
1442         struct cdns_uart *cdns_uart = port->private_data;
1443
1444         clk_disable(cdns_uart->uartclk);
1445         clk_disable(cdns_uart->pclk);
1446         return 0;
1447 };
1448
1449 static int __maybe_unused cdns_runtime_resume(struct device *dev)
1450 {
1451         struct platform_device *pdev = to_platform_device(dev);
1452         struct uart_port *port = platform_get_drvdata(pdev);
1453         struct cdns_uart *cdns_uart = port->private_data;
1454
1455         clk_enable(cdns_uart->pclk);
1456         clk_enable(cdns_uart->uartclk);
1457         return 0;
1458 };
1459
1460 static const struct dev_pm_ops cdns_uart_dev_pm_ops = {
1461         SET_SYSTEM_SLEEP_PM_OPS(cdns_uart_suspend, cdns_uart_resume)
1462         SET_RUNTIME_PM_OPS(cdns_runtime_suspend,
1463                            cdns_runtime_resume, NULL)
1464 };
1465
1466 static const struct cdns_platform_data zynqmp_uart_def = {
1467                                 .quirks = CDNS_UART_RXBS_SUPPORT, };
1468
1469 /* Match table for of_platform binding */
1470 static const struct of_device_id cdns_uart_of_match[] = {
1471         { .compatible = "xlnx,xuartps", },
1472         { .compatible = "cdns,uart-r1p8", },
1473         { .compatible = "cdns,uart-r1p12", .data = &zynqmp_uart_def },
1474         { .compatible = "xlnx,zynqmp-uart", .data = &zynqmp_uart_def },
1475         {}
1476 };
1477 MODULE_DEVICE_TABLE(of, cdns_uart_of_match);
1478
1479 /**
1480  * cdns_uart_probe - Platform driver probe
1481  * @pdev: Pointer to the platform device structure
1482  *
1483  * Return: 0 on success, negative errno otherwise
1484  */
1485 static int cdns_uart_probe(struct platform_device *pdev)
1486 {
1487         int rc, id, irq;
1488         struct uart_port *port;
1489         struct resource *res;
1490         struct cdns_uart *cdns_uart_data;
1491         const struct of_device_id *match;
1492
1493         cdns_uart_data = devm_kzalloc(&pdev->dev, sizeof(*cdns_uart_data),
1494                         GFP_KERNEL);
1495         if (!cdns_uart_data)
1496                 return -ENOMEM;
1497
1498         match = of_match_node(cdns_uart_of_match, pdev->dev.of_node);
1499         if (match && match->data) {
1500                 const struct cdns_platform_data *data = match->data;
1501
1502                 cdns_uart_data->quirks = data->quirks;
1503         }
1504
1505         cdns_uart_data->pclk = devm_clk_get(&pdev->dev, "pclk");
1506         if (IS_ERR(cdns_uart_data->pclk)) {
1507                 cdns_uart_data->pclk = devm_clk_get(&pdev->dev, "aper_clk");
1508                 if (!IS_ERR(cdns_uart_data->pclk))
1509                         dev_err(&pdev->dev, "clock name 'aper_clk' is deprecated.\n");
1510         }
1511         if (IS_ERR(cdns_uart_data->pclk)) {
1512                 dev_err(&pdev->dev, "pclk clock not found.\n");
1513                 return PTR_ERR(cdns_uart_data->pclk);
1514         }
1515
1516         cdns_uart_data->uartclk = devm_clk_get(&pdev->dev, "uart_clk");
1517         if (IS_ERR(cdns_uart_data->uartclk)) {
1518                 cdns_uart_data->uartclk = devm_clk_get(&pdev->dev, "ref_clk");
1519                 if (!IS_ERR(cdns_uart_data->uartclk))
1520                         dev_err(&pdev->dev, "clock name 'ref_clk' is deprecated.\n");
1521         }
1522         if (IS_ERR(cdns_uart_data->uartclk)) {
1523                 dev_err(&pdev->dev, "uart_clk clock not found.\n");
1524                 return PTR_ERR(cdns_uart_data->uartclk);
1525         }
1526
1527         rc = clk_prepare_enable(cdns_uart_data->pclk);
1528         if (rc) {
1529                 dev_err(&pdev->dev, "Unable to enable pclk clock.\n");
1530                 return rc;
1531         }
1532         rc = clk_prepare_enable(cdns_uart_data->uartclk);
1533         if (rc) {
1534                 dev_err(&pdev->dev, "Unable to enable device clock.\n");
1535                 goto err_out_clk_dis_pclk;
1536         }
1537
1538         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1539         if (!res) {
1540                 rc = -ENODEV;
1541                 goto err_out_clk_disable;
1542         }
1543
1544         irq = platform_get_irq(pdev, 0);
1545         if (irq <= 0) {
1546                 rc = -ENXIO;
1547                 goto err_out_clk_disable;
1548         }
1549
1550 #ifdef CONFIG_COMMON_CLK
1551         cdns_uart_data->clk_rate_change_nb.notifier_call =
1552                         cdns_uart_clk_notifier_cb;
1553         if (clk_notifier_register(cdns_uart_data->uartclk,
1554                                 &cdns_uart_data->clk_rate_change_nb))
1555                 dev_warn(&pdev->dev, "Unable to register clock notifier.\n");
1556 #endif
1557         /* Look for a serialN alias */
1558         id = of_alias_get_id(pdev->dev.of_node, "serial");
1559         if (id < 0)
1560                 id = 0;
1561
1562         /* Initialize the port structure */
1563         port = cdns_uart_get_port(id);
1564
1565         if (!port) {
1566                 dev_err(&pdev->dev, "Cannot get uart_port structure\n");
1567                 rc = -ENODEV;
1568                 goto err_out_notif_unreg;
1569         }
1570
1571         /*
1572          * Register the port.
1573          * This function also registers this device with the tty layer
1574          * and triggers invocation of the config_port() entry point.
1575          */
1576         port->mapbase = res->start;
1577         port->irq = irq;
1578         port->dev = &pdev->dev;
1579         port->uartclk = clk_get_rate(cdns_uart_data->uartclk);
1580         port->private_data = cdns_uart_data;
1581         cdns_uart_data->port = port;
1582         platform_set_drvdata(pdev, port);
1583
1584         pm_runtime_use_autosuspend(&pdev->dev);
1585         pm_runtime_set_autosuspend_delay(&pdev->dev, UART_AUTOSUSPEND_TIMEOUT);
1586         pm_runtime_set_active(&pdev->dev);
1587         pm_runtime_enable(&pdev->dev);
1588
1589         rc = uart_add_one_port(&cdns_uart_uart_driver, port);
1590         if (rc) {
1591                 dev_err(&pdev->dev,
1592                         "uart_add_one_port() failed; err=%i\n", rc);
1593                 goto err_out_pm_disable;
1594         }
1595
1596         return 0;
1597
1598 err_out_pm_disable:
1599         pm_runtime_disable(&pdev->dev);
1600         pm_runtime_set_suspended(&pdev->dev);
1601         pm_runtime_dont_use_autosuspend(&pdev->dev);
1602 err_out_notif_unreg:
1603 #ifdef CONFIG_COMMON_CLK
1604         clk_notifier_unregister(cdns_uart_data->uartclk,
1605                         &cdns_uart_data->clk_rate_change_nb);
1606 #endif
1607 err_out_clk_disable:
1608         clk_disable_unprepare(cdns_uart_data->uartclk);
1609 err_out_clk_dis_pclk:
1610         clk_disable_unprepare(cdns_uart_data->pclk);
1611
1612         return rc;
1613 }
1614
1615 /**
1616  * cdns_uart_remove - called when the platform driver is unregistered
1617  * @pdev: Pointer to the platform device structure
1618  *
1619  * Return: 0 on success, negative errno otherwise
1620  */
1621 static int cdns_uart_remove(struct platform_device *pdev)
1622 {
1623         struct uart_port *port = platform_get_drvdata(pdev);
1624         struct cdns_uart *cdns_uart_data = port->private_data;
1625         int rc;
1626
1627         /* Remove the cdns_uart port from the serial core */
1628 #ifdef CONFIG_COMMON_CLK
1629         clk_notifier_unregister(cdns_uart_data->uartclk,
1630                         &cdns_uart_data->clk_rate_change_nb);
1631 #endif
1632         rc = uart_remove_one_port(&cdns_uart_uart_driver, port);
1633         port->mapbase = 0;
1634         clk_disable_unprepare(cdns_uart_data->uartclk);
1635         clk_disable_unprepare(cdns_uart_data->pclk);
1636         pm_runtime_disable(&pdev->dev);
1637         pm_runtime_set_suspended(&pdev->dev);
1638         pm_runtime_dont_use_autosuspend(&pdev->dev);
1639         return rc;
1640 }
1641
1642 static struct platform_driver cdns_uart_platform_driver = {
1643         .probe   = cdns_uart_probe,
1644         .remove  = cdns_uart_remove,
1645         .driver  = {
1646                 .name = CDNS_UART_NAME,
1647                 .of_match_table = cdns_uart_of_match,
1648                 .pm = &cdns_uart_dev_pm_ops,
1649                 .suppress_bind_attrs = IS_BUILTIN(CONFIG_SERIAL_XILINX_PS_UART),
1650                 },
1651 };
1652
1653 static int __init cdns_uart_init(void)
1654 {
1655         int retval = 0;
1656
1657         /* Register the cdns_uart driver with the serial core */
1658         retval = uart_register_driver(&cdns_uart_uart_driver);
1659         if (retval)
1660                 return retval;
1661
1662         /* Register the platform driver */
1663         retval = platform_driver_register(&cdns_uart_platform_driver);
1664         if (retval)
1665                 uart_unregister_driver(&cdns_uart_uart_driver);
1666
1667         return retval;
1668 }
1669
1670 static void __exit cdns_uart_exit(void)
1671 {
1672         /* Unregister the platform driver */
1673         platform_driver_unregister(&cdns_uart_platform_driver);
1674
1675         /* Unregister the cdns_uart driver */
1676         uart_unregister_driver(&cdns_uart_uart_driver);
1677 }
1678
1679 module_init(cdns_uart_init);
1680 module_exit(cdns_uart_exit);
1681
1682 MODULE_DESCRIPTION("Driver for Cadence UART");
1683 MODULE_AUTHOR("Xilinx Inc.");
1684 MODULE_LICENSE("GPL");