drivers/tty/serial/xilinx_uartps.c

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