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