drivers/tty/serial/sc16is7xx.c

   1 /*
   2  * SC16IS7xx tty serial driver - Copyright (C) 2014 GridPoint
   3  * Author: Jon Ringle <jringle@gridpoint.com>
   4  *
   5  *  Based on max310x.c, by Alexander Shiyan <shc_work@mail.ru>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  */
  13
  14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  15
  16 #include <linux/bitops.h>
  17 #include <linux/clk.h>
  18 #include <linux/delay.h>
  19 #include <linux/device.h>
  20 #include <linux/gpio.h>
  21 #include <linux/i2c.h>
  22 #include <linux/module.h>
  23 #include <linux/of.h>
  24 #include <linux/of_device.h>
  25 #include <linux/regmap.h>
  26 #include <linux/serial_core.h>
  27 #include <linux/serial.h>
  28 #include <linux/tty.h>
  29 #include <linux/tty_flip.h>
  30 #include <linux/spi/spi.h>
  31 #include <linux/uaccess.h>
  32
  33 #define SC16IS7XX_NAME                  "sc16is7xx"
  34 #define SC16IS7XX_MAX_DEVS              8
  35
  36 /* SC16IS7XX register definitions */
  37 #define SC16IS7XX_RHR_REG               (0x00) /* RX FIFO */
  38 #define SC16IS7XX_THR_REG               (0x00) /* TX FIFO */
  39 #define SC16IS7XX_IER_REG               (0x01) /* Interrupt enable */
  40 #define SC16IS7XX_IIR_REG               (0x02) /* Interrupt Identification */
  41 #define SC16IS7XX_FCR_REG               (0x02) /* FIFO control */
  42 #define SC16IS7XX_LCR_REG               (0x03) /* Line Control */
  43 #define SC16IS7XX_MCR_REG               (0x04) /* Modem Control */
  44 #define SC16IS7XX_LSR_REG               (0x05) /* Line Status */
  45 #define SC16IS7XX_MSR_REG               (0x06) /* Modem Status */
  46 #define SC16IS7XX_SPR_REG               (0x07) /* Scratch Pad */
  47 #define SC16IS7XX_TXLVL_REG             (0x08) /* TX FIFO level */
  48 #define SC16IS7XX_RXLVL_REG             (0x09) /* RX FIFO level */
  49 #define SC16IS7XX_IODIR_REG             (0x0a) /* I/O Direction
  50                                                 * - only on 75x/76x
  51                                                 */
  52 #define SC16IS7XX_IOSTATE_REG           (0x0b) /* I/O State
  53                                                 * - only on 75x/76x
  54                                                 */
  55 #define SC16IS7XX_IOINTENA_REG          (0x0c) /* I/O Interrupt Enable
  56                                                 * - only on 75x/76x
  57                                                 */
  58 #define SC16IS7XX_IOCONTROL_REG         (0x0e) /* I/O Control
  59                                                 * - only on 75x/76x
  60                                                 */
  61 #define SC16IS7XX_EFCR_REG              (0x0f) /* Extra Features Control */
  62
  63 /* TCR/TLR Register set: Only if ((MCR[2] == 1) && (EFR[4] == 1)) */
  64 #define SC16IS7XX_TCR_REG               (0x06) /* Transmit control */
  65 #define SC16IS7XX_TLR_REG               (0x07) /* Trigger level */
  66
  67 /* Special Register set: Only if ((LCR[7] == 1) && (LCR != 0xBF)) */
  68 #define SC16IS7XX_DLL_REG               (0x00) /* Divisor Latch Low */
  69 #define SC16IS7XX_DLH_REG               (0x01) /* Divisor Latch High */
  70
  71 /* Enhanced Register set: Only if (LCR == 0xBF) */
  72 #define SC16IS7XX_EFR_REG               (0x02) /* Enhanced Features */
  73 #define SC16IS7XX_XON1_REG              (0x04) /* Xon1 word */
  74 #define SC16IS7XX_XON2_REG              (0x05) /* Xon2 word */
  75 #define SC16IS7XX_XOFF1_REG             (0x06) /* Xoff1 word */
  76 #define SC16IS7XX_XOFF2_REG             (0x07) /* Xoff2 word */
  77
  78 /* IER register bits */
  79 #define SC16IS7XX_IER_RDI_BIT           (1 << 0) /* Enable RX data interrupt */
  80 #define SC16IS7XX_IER_THRI_BIT          (1 << 1) /* Enable TX holding register
  81                                                   * interrupt */
  82 #define SC16IS7XX_IER_RLSI_BIT          (1 << 2) /* Enable RX line status
  83                                                   * interrupt */
  84 #define SC16IS7XX_IER_MSI_BIT           (1 << 3) /* Enable Modem status
  85                                                   * interrupt */
  86
  87 /* IER register bits - write only if (EFR[4] == 1) */
  88 #define SC16IS7XX_IER_SLEEP_BIT         (1 << 4) /* Enable Sleep mode */
  89 #define SC16IS7XX_IER_XOFFI_BIT         (1 << 5) /* Enable Xoff interrupt */
  90 #define SC16IS7XX_IER_RTSI_BIT          (1 << 6) /* Enable nRTS interrupt */
  91 #define SC16IS7XX_IER_CTSI_BIT          (1 << 7) /* Enable nCTS interrupt */
  92
  93 /* FCR register bits */
  94 #define SC16IS7XX_FCR_FIFO_BIT          (1 << 0) /* Enable FIFO */
  95 #define SC16IS7XX_FCR_RXRESET_BIT       (1 << 1) /* Reset RX FIFO */
  96 #define SC16IS7XX_FCR_TXRESET_BIT       (1 << 2) /* Reset TX FIFO */
  97 #define SC16IS7XX_FCR_RXLVLL_BIT        (1 << 6) /* RX Trigger level LSB */
  98 #define SC16IS7XX_FCR_RXLVLH_BIT        (1 << 7) /* RX Trigger level MSB */
  99
 100 /* FCR register bits - write only if (EFR[4] == 1) */
 101 #define SC16IS7XX_FCR_TXLVLL_BIT        (1 << 4) /* TX Trigger level LSB */
 102 #define SC16IS7XX_FCR_TXLVLH_BIT        (1 << 5) /* TX Trigger level MSB */
 103
 104 /* IIR register bits */
 105 #define SC16IS7XX_IIR_NO_INT_BIT        (1 << 0) /* No interrupts pending */
 106 #define SC16IS7XX_IIR_ID_MASK           0x3e     /* Mask for the interrupt ID */
 107 #define SC16IS7XX_IIR_THRI_SRC          0x02     /* TX holding register empty */
 108 #define SC16IS7XX_IIR_RDI_SRC           0x04     /* RX data interrupt */
 109 #define SC16IS7XX_IIR_RLSE_SRC          0x06     /* RX line status error */
 110 #define SC16IS7XX_IIR_RTOI_SRC          0x0c     /* RX time-out interrupt */
 111 #define SC16IS7XX_IIR_MSI_SRC           0x00     /* Modem status interrupt
 112                                                   * - only on 75x/76x
 113                                                   */
 114 #define SC16IS7XX_IIR_INPIN_SRC         0x30     /* Input pin change of state
 115                                                   * - only on 75x/76x
 116                                                   */
 117 #define SC16IS7XX_IIR_XOFFI_SRC         0x10     /* Received Xoff */
 118 #define SC16IS7XX_IIR_CTSRTS_SRC        0x20     /* nCTS,nRTS change of state
 119                                                   * from active (LOW)
 120                                                   * to inactive (HIGH)
 121                                                   */
 122 /* LCR register bits */
 123 #define SC16IS7XX_LCR_LENGTH0_BIT       (1 << 0) /* Word length bit 0 */
 124 #define SC16IS7XX_LCR_LENGTH1_BIT       (1 << 1) /* Word length bit 1
 125                                                   *
 126                                                   * Word length bits table:
 127                                                   * 00 -> 5 bit words
 128                                                   * 01 -> 6 bit words
 129                                                   * 10 -> 7 bit words
 130                                                   * 11 -> 8 bit words
 131                                                   */
 132 #define SC16IS7XX_LCR_STOPLEN_BIT       (1 << 2) /* STOP length bit
 133                                                   *
 134                                                   * STOP length bit table:
 135                                                   * 0 -> 1 stop bit
 136                                                   * 1 -> 1-1.5 stop bits if
 137                                                   *      word length is 5,
 138                                                   *      2 stop bits otherwise
 139                                                   */
 140 #define SC16IS7XX_LCR_PARITY_BIT        (1 << 3) /* Parity bit enable */
 141 #define SC16IS7XX_LCR_EVENPARITY_BIT    (1 << 4) /* Even parity bit enable */
 142 #define SC16IS7XX_LCR_FORCEPARITY_BIT   (1 << 5) /* 9-bit multidrop parity */
 143 #define SC16IS7XX_LCR_TXBREAK_BIT       (1 << 6) /* TX break enable */
 144 #define SC16IS7XX_LCR_DLAB_BIT          (1 << 7) /* Divisor Latch enable */
 145 #define SC16IS7XX_LCR_WORD_LEN_5        (0x00)
 146 #define SC16IS7XX_LCR_WORD_LEN_6        (0x01)
 147 #define SC16IS7XX_LCR_WORD_LEN_7        (0x02)
 148 #define SC16IS7XX_LCR_WORD_LEN_8        (0x03)
 149 #define SC16IS7XX_LCR_CONF_MODE_A       SC16IS7XX_LCR_DLAB_BIT /* Special
 150                                                                 * reg set */
 151 #define SC16IS7XX_LCR_CONF_MODE_B       0xBF                   /* Enhanced
 152                                                                 * reg set */
 153
 154 /* MCR register bits */
 155 #define SC16IS7XX_MCR_DTR_BIT           (1 << 0) /* DTR complement
 156                                                   * - only on 75x/76x
 157                                                   */
 158 #define SC16IS7XX_MCR_RTS_BIT           (1 << 1) /* RTS complement */
 159 #define SC16IS7XX_MCR_TCRTLR_BIT        (1 << 2) /* TCR/TLR register enable */
 160 #define SC16IS7XX_MCR_LOOP_BIT          (1 << 4) /* Enable loopback test mode */
 161 #define SC16IS7XX_MCR_XONANY_BIT        (1 << 5) /* Enable Xon Any
 162                                                   * - write enabled
 163                                                   * if (EFR[4] == 1)
 164                                                   */
 165 #define SC16IS7XX_MCR_IRDA_BIT          (1 << 6) /* Enable IrDA mode
 166                                                   * - write enabled
 167                                                   * if (EFR[4] == 1)
 168                                                   */
 169 #define SC16IS7XX_MCR_CLKSEL_BIT        (1 << 7) /* Divide clock by 4
 170                                                   * - write enabled
 171                                                   * if (EFR[4] == 1)
 172                                                   */
 173
 174 /* LSR register bits */
 175 #define SC16IS7XX_LSR_DR_BIT            (1 << 0) /* Receiver data ready */
 176 #define SC16IS7XX_LSR_OE_BIT            (1 << 1) /* Overrun Error */
 177 #define SC16IS7XX_LSR_PE_BIT            (1 << 2) /* Parity Error */
 178 #define SC16IS7XX_LSR_FE_BIT            (1 << 3) /* Frame Error */
 179 #define SC16IS7XX_LSR_BI_BIT            (1 << 4) /* Break Interrupt */
 180 #define SC16IS7XX_LSR_BRK_ERROR_MASK    0x1E     /* BI, FE, PE, OE bits */
 181 #define SC16IS7XX_LSR_THRE_BIT          (1 << 5) /* TX holding register empty */
 182 #define SC16IS7XX_LSR_TEMT_BIT          (1 << 6) /* Transmitter empty */
 183 #define SC16IS7XX_LSR_FIFOE_BIT         (1 << 7) /* Fifo Error */
 184
 185 /* MSR register bits */
 186 #define SC16IS7XX_MSR_DCTS_BIT          (1 << 0) /* Delta CTS Clear To Send */
 187 #define SC16IS7XX_MSR_DDSR_BIT          (1 << 1) /* Delta DSR Data Set Ready
 188                                                   * or (IO4)
 189                                                   * - only on 75x/76x
 190                                                   */
 191 #define SC16IS7XX_MSR_DRI_BIT           (1 << 2) /* Delta RI Ring Indicator
 192                                                   * or (IO7)
 193                                                   * - only on 75x/76x
 194                                                   */
 195 #define SC16IS7XX_MSR_DCD_BIT           (1 << 3) /* Delta CD Carrier Detect
 196                                                   * or (IO6)
 197                                                   * - only on 75x/76x
 198                                                   */
 199 #define SC16IS7XX_MSR_CTS_BIT           (1 << 0) /* CTS */
 200 #define SC16IS7XX_MSR_DSR_BIT           (1 << 1) /* DSR (IO4)
 201                                                   * - only on 75x/76x
 202                                                   */
 203 #define SC16IS7XX_MSR_RI_BIT            (1 << 2) /* RI (IO7)
 204                                                   * - only on 75x/76x
 205                                                   */
 206 #define SC16IS7XX_MSR_CD_BIT            (1 << 3) /* CD (IO6)
 207                                                   * - only on 75x/76x
 208                                                   */
 209 #define SC16IS7XX_MSR_DELTA_MASK        0x0F     /* Any of the delta bits! */
 210
 211 /*
 212  * TCR register bits
 213  * TCR trigger levels are available from 0 to 60 characters with a granularity
 214  * of four.
 215  * The programmer must program the TCR such that TCR[3:0] > TCR[7:4]. There is
 216  * no built-in hardware check to make sure this condition is met. Also, the TCR
 217  * must be programmed with this condition before auto RTS or software flow
 218  * control is enabled to avoid spurious operation of the device.
 219  */
 220 #define SC16IS7XX_TCR_RX_HALT(words)    ((((words) / 4) & 0x0f) << 0)
 221 #define SC16IS7XX_TCR_RX_RESUME(words)  ((((words) / 4) & 0x0f) << 4)
 222
 223 /*
 224  * TLR register bits
 225  * If TLR[3:0] or TLR[7:4] are logical 0, the selectable trigger levels via the
 226  * FIFO Control Register (FCR) are used for the transmit and receive FIFO
 227  * trigger levels. Trigger levels from 4 characters to 60 characters are
 228  * available with a granularity of four.
 229  *
 230  * When the trigger level setting in TLR is zero, the SC16IS740/750/760 uses the
 231  * trigger level setting defined in FCR. If TLR has non-zero trigger level value
 232  * the trigger level defined in FCR is discarded. This applies to both transmit
 233  * FIFO and receive FIFO trigger level setting.
 234  *
 235  * When TLR is used for RX trigger level control, FCR[7:6] should be left at the
 236  * default state, that is, '00'.
 237  */
 238 #define SC16IS7XX_TLR_TX_TRIGGER(words) ((((words) / 4) & 0x0f) << 0)
 239 #define SC16IS7XX_TLR_RX_TRIGGER(words) ((((words) / 4) & 0x0f) << 4)
 240
 241 /* IOControl register bits (Only 750/760) */
 242 #define SC16IS7XX_IOCONTROL_LATCH_BIT   (1 << 0) /* Enable input latching */
 243 #define SC16IS7XX_IOCONTROL_GPIO_BIT    (1 << 1) /* Enable GPIO[7:4] */
 244 #define SC16IS7XX_IOCONTROL_SRESET_BIT  (1 << 3) /* Software Reset */
 245
 246 /* EFCR register bits */
 247 #define SC16IS7XX_EFCR_9BIT_MODE_BIT    (1 << 0) /* Enable 9-bit or Multidrop
 248                                                   * mode (RS485) */
 249 #define SC16IS7XX_EFCR_RXDISABLE_BIT    (1 << 1) /* Disable receiver */
 250 #define SC16IS7XX_EFCR_TXDISABLE_BIT    (1 << 2) /* Disable transmitter */
 251 #define SC16IS7XX_EFCR_AUTO_RS485_BIT   (1 << 4) /* Auto RS485 RTS direction */
 252 #define SC16IS7XX_EFCR_RTS_INVERT_BIT   (1 << 5) /* RTS output inversion */
 253 #define SC16IS7XX_EFCR_IRDA_MODE_BIT    (1 << 7) /* IrDA mode
 254                                                   * 0 = rate upto 115.2 kbit/s
 255                                                   *   - Only 750/760
 256                                                   * 1 = rate upto 1.152 Mbit/s
 257                                                   *   - Only 760
 258                                                   */
 259
 260 /* EFR register bits */
 261 #define SC16IS7XX_EFR_AUTORTS_BIT       (1 << 6) /* Auto RTS flow ctrl enable */
 262 #define SC16IS7XX_EFR_AUTOCTS_BIT       (1 << 7) /* Auto CTS flow ctrl enable */
 263 #define SC16IS7XX_EFR_XOFF2_DETECT_BIT  (1 << 5) /* Enable Xoff2 detection */
 264 #define SC16IS7XX_EFR_ENABLE_BIT        (1 << 4) /* Enable enhanced functions
 265                                                   * and writing to IER[7:4],
 266                                                   * FCR[5:4], MCR[7:5]
 267                                                   */
 268 #define SC16IS7XX_EFR_SWFLOW3_BIT       (1 << 3) /* SWFLOW bit 3 */
 269 #define SC16IS7XX_EFR_SWFLOW2_BIT       (1 << 2) /* SWFLOW bit 2
 270                                                   *
 271                                                   * SWFLOW bits 3 & 2 table:
 272                                                   * 00 -> no transmitter flow
 273                                                   *       control
 274                                                   * 01 -> transmitter generates
 275                                                   *       XON2 and XOFF2
 276                                                   * 10 -> transmitter generates
 277                                                   *       XON1 and XOFF1
 278                                                   * 11 -> transmitter generates
 279                                                   *       XON1, XON2, XOFF1 and
 280                                                   *       XOFF2
 281                                                   */
 282 #define SC16IS7XX_EFR_SWFLOW1_BIT       (1 << 1) /* SWFLOW bit 2 */
 283 #define SC16IS7XX_EFR_SWFLOW0_BIT       (1 << 0) /* SWFLOW bit 3
 284                                                   *
 285                                                   * SWFLOW bits 3 & 2 table:
 286                                                   * 00 -> no received flow
 287                                                   *       control
 288                                                   * 01 -> receiver compares
 289                                                   *       XON2 and XOFF2
 290                                                   * 10 -> receiver compares
 291                                                   *       XON1 and XOFF1
 292                                                   * 11 -> receiver compares
 293                                                   *       XON1, XON2, XOFF1 and
 294                                                   *       XOFF2
 295                                                   */
 296
 297 /* Misc definitions */
 298 #define SC16IS7XX_FIFO_SIZE             (64)
 299 #define SC16IS7XX_REG_SHIFT             2
 300
 301 struct sc16is7xx_devtype {
 302         char    name[10];
 303         int     nr_gpio;
 304         int     nr_uart;
 305 };
 306
 307 #define SC16IS7XX_RECONF_MD             (1 << 0)
 308 #define SC16IS7XX_RECONF_IER            (1 << 1)
 309 #define SC16IS7XX_RECONF_RS485          (1 << 2)
 310
 311 struct sc16is7xx_one_config {
 312         unsigned int                    flags;
 313         u8                              ier_clear;
 314 };
 315
 316 struct sc16is7xx_one {
 317         struct uart_port                port;
 318         u8                              line;
 319         struct kthread_work             tx_work;
 320         struct kthread_work             reg_work;
 321         struct sc16is7xx_one_config     config;
 322 };
 323
 324 struct sc16is7xx_port {
 325         const struct sc16is7xx_devtype  *devtype;
 326         struct regmap                   *regmap;
 327         struct clk                      *clk;
 328 #ifdef CONFIG_GPIOLIB
 329         struct gpio_chip                gpio;
 330 #endif
 331         unsigned char                   buf[SC16IS7XX_FIFO_SIZE];
 332         struct kthread_worker           kworker;
 333         struct task_struct              *kworker_task;
 334         struct kthread_work             irq_work;
 335         struct mutex                    efr_lock;
 336         struct sc16is7xx_one            p[0];
 337 };
 338
 339 static unsigned long sc16is7xx_lines;
 340
 341 static struct uart_driver sc16is7xx_uart = {
 342         .owner          = THIS_MODULE,
 343         .dev_name       = "ttySC",
 344         .nr             = SC16IS7XX_MAX_DEVS,
 345 };
 346
 347 #define to_sc16is7xx_port(p,e)  ((container_of((p), struct sc16is7xx_port, e)))
 348 #define to_sc16is7xx_one(p,e)   ((container_of((p), struct sc16is7xx_one, e)))
 349
 350 static int sc16is7xx_line(struct uart_port *port)
 351 {
 352         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
 353
 354         return one->line;
 355 }
 356
 357 static u8 sc16is7xx_port_read(struct uart_port *port, u8 reg)
 358 {
 359         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 360         unsigned int val = 0;
 361         const u8 line = sc16is7xx_line(port);
 362
 363         regmap_read(s->regmap, (reg << SC16IS7XX_REG_SHIFT) | line, &val);
 364
 365         return val;
 366 }
 367
 368 static void sc16is7xx_port_write(struct uart_port *port, u8 reg, u8 val)
 369 {
 370         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 371         const u8 line = sc16is7xx_line(port);
 372
 373         regmap_write(s->regmap, (reg << SC16IS7XX_REG_SHIFT) | line, val);
 374 }
 375
 376 static void sc16is7xx_fifo_read(struct uart_port *port, unsigned int rxlen)
 377 {
 378         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 379         const u8 line = sc16is7xx_line(port);
 380         u8 addr = (SC16IS7XX_RHR_REG << SC16IS7XX_REG_SHIFT) | line;
 381
 382         regcache_cache_bypass(s->regmap, true);
 383         regmap_raw_read(s->regmap, addr, s->buf, rxlen);
 384         regcache_cache_bypass(s->regmap, false);
 385 }
 386
 387 static void sc16is7xx_fifo_write(struct uart_port *port, u8 to_send)
 388 {
 389         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 390         const u8 line = sc16is7xx_line(port);
 391         u8 addr = (SC16IS7XX_THR_REG << SC16IS7XX_REG_SHIFT) | line;
 392
 393         regcache_cache_bypass(s->regmap, true);
 394         regmap_raw_write(s->regmap, addr, s->buf, to_send);
 395         regcache_cache_bypass(s->regmap, false);
 396 }
 397
 398 static void sc16is7xx_port_update(struct uart_port *port, u8 reg,
 399                                   u8 mask, u8 val)
 400 {
 401         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 402         const u8 line = sc16is7xx_line(port);
 403
 404         regmap_update_bits(s->regmap, (reg << SC16IS7XX_REG_SHIFT) | line,
 405                            mask, val);
 406 }
 407
 408 static int sc16is7xx_alloc_line(void)
 409 {
 410         int i;
 411
 412         BUILD_BUG_ON(SC16IS7XX_MAX_DEVS > BITS_PER_LONG);
 413
 414         for (i = 0; i < SC16IS7XX_MAX_DEVS; i++)
 415                 if (!test_and_set_bit(i, &sc16is7xx_lines))
 416                         break;
 417
 418         return i;
 419 }
 420
 421 static void sc16is7xx_power(struct uart_port *port, int on)
 422 {
 423         sc16is7xx_port_update(port, SC16IS7XX_IER_REG,
 424                               SC16IS7XX_IER_SLEEP_BIT,
 425                               on ? 0 : SC16IS7XX_IER_SLEEP_BIT);
 426 }
 427
 428 static const struct sc16is7xx_devtype sc16is74x_devtype = {
 429         .name           = "SC16IS74X",
 430         .nr_gpio        = 0,
 431         .nr_uart        = 1,
 432 };
 433
 434 static const struct sc16is7xx_devtype sc16is750_devtype = {
 435         .name           = "SC16IS750",
 436         .nr_gpio        = 8,
 437         .nr_uart        = 1,
 438 };
 439
 440 static const struct sc16is7xx_devtype sc16is752_devtype = {
 441         .name           = "SC16IS752",
 442         .nr_gpio        = 8,
 443         .nr_uart        = 2,
 444 };
 445
 446 static const struct sc16is7xx_devtype sc16is760_devtype = {
 447         .name           = "SC16IS760",
 448         .nr_gpio        = 8,
 449         .nr_uart        = 1,
 450 };
 451
 452 static const struct sc16is7xx_devtype sc16is762_devtype = {
 453         .name           = "SC16IS762",
 454         .nr_gpio        = 8,
 455         .nr_uart        = 2,
 456 };
 457
 458 static bool sc16is7xx_regmap_volatile(struct device *dev, unsigned int reg)
 459 {
 460         switch (reg >> SC16IS7XX_REG_SHIFT) {
 461         case SC16IS7XX_RHR_REG:
 462         case SC16IS7XX_IIR_REG:
 463         case SC16IS7XX_LSR_REG:
 464         case SC16IS7XX_MSR_REG:
 465         case SC16IS7XX_TXLVL_REG:
 466         case SC16IS7XX_RXLVL_REG:
 467         case SC16IS7XX_IOSTATE_REG:
 468                 return true;
 469         default:
 470                 break;
 471         }
 472
 473         return false;
 474 }
 475
 476 static bool sc16is7xx_regmap_precious(struct device *dev, unsigned int reg)
 477 {
 478         switch (reg >> SC16IS7XX_REG_SHIFT) {
 479         case SC16IS7XX_RHR_REG:
 480                 return true;
 481         default:
 482                 break;
 483         }
 484
 485         return false;
 486 }
 487
 488 static int sc16is7xx_set_baud(struct uart_port *port, int baud)
 489 {
 490         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 491         u8 lcr;
 492         u8 prescaler = 0;
 493         unsigned long clk = port->uartclk, div = clk / 16 / baud;
 494
 495         if (div > 0xffff) {
 496                 prescaler = SC16IS7XX_MCR_CLKSEL_BIT;
 497                 div /= 4;
 498         }
 499
 500         /* In an amazing feat of design, the Enhanced Features Register shares
 501          * the address of the Interrupt Identification Register, and is
 502          * switched in by writing a magic value (0xbf) to the Line Control
 503          * Register. Any interrupt firing during this time will see the EFR
 504          * where it expects the IIR to be, leading to "Unexpected interrupt"
 505          * messages.
 506          *
 507          * Prevent this possibility by claiming a mutex while accessing the
 508          * EFR, and claiming the same mutex from within the interrupt handler.
 509          * This is similar to disabling the interrupt, but that doesn't work
 510          * because the bulk of the interrupt processing is run as a workqueue
 511          * job in thread context.
 512          */
 513         mutex_lock(&s->efr_lock);
 514
 515         lcr = sc16is7xx_port_read(port, SC16IS7XX_LCR_REG);
 516
 517         /* Open the LCR divisors for configuration */
 518         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG,
 519                              SC16IS7XX_LCR_CONF_MODE_B);
 520
 521         /* Enable enhanced features */
 522         regcache_cache_bypass(s->regmap, true);
 523         sc16is7xx_port_write(port, SC16IS7XX_EFR_REG,
 524                              SC16IS7XX_EFR_ENABLE_BIT);
 525         regcache_cache_bypass(s->regmap, false);
 526
 527         /* Put LCR back to the normal mode */
 528         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, lcr);
 529
 530         mutex_unlock(&s->efr_lock);
 531
 532         sc16is7xx_port_update(port, SC16IS7XX_MCR_REG,
 533                               SC16IS7XX_MCR_CLKSEL_BIT,
 534                               prescaler);
 535
 536         /* Open the LCR divisors for configuration */
 537         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG,
 538                              SC16IS7XX_LCR_CONF_MODE_A);
 539
 540         /* Write the new divisor */
 541         regcache_cache_bypass(s->regmap, true);
 542         sc16is7xx_port_write(port, SC16IS7XX_DLH_REG, div / 256);
 543         sc16is7xx_port_write(port, SC16IS7XX_DLL_REG, div % 256);
 544         regcache_cache_bypass(s->regmap, false);
 545
 546         /* Put LCR back to the normal mode */
 547         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, lcr);
 548
 549         return DIV_ROUND_CLOSEST(clk / 16, div);
 550 }
 551
 552 static void sc16is7xx_handle_rx(struct uart_port *port, unsigned int rxlen,
 553                                 unsigned int iir)
 554 {
 555         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 556         unsigned int lsr = 0, ch, flag, bytes_read, i;
 557         bool read_lsr = (iir == SC16IS7XX_IIR_RLSE_SRC) ? true : false;
 558
 559         if (unlikely(rxlen >= sizeof(s->buf))) {
 560                 dev_warn_ratelimited(port->dev,
 561                                      "ttySC%i: Possible RX FIFO overrun: %d\n",
 562                                      port->line, rxlen);
 563                 port->icount.buf_overrun++;
 564                 /* Ensure sanity of RX level */
 565                 rxlen = sizeof(s->buf);
 566         }
 567
 568         while (rxlen) {
 569                 /* Only read lsr if there are possible errors in FIFO */
 570                 if (read_lsr) {
 571                         lsr = sc16is7xx_port_read(port, SC16IS7XX_LSR_REG);
 572                         if (!(lsr & SC16IS7XX_LSR_FIFOE_BIT))
 573                                 read_lsr = false; /* No errors left in FIFO */
 574                 } else
 575                         lsr = 0;
 576
 577                 if (read_lsr) {
 578                         s->buf[0] = sc16is7xx_port_read(port, SC16IS7XX_RHR_REG);
 579                         bytes_read = 1;
 580                 } else {
 581                         sc16is7xx_fifo_read(port, rxlen);
 582                         bytes_read = rxlen;
 583                 }
 584
 585                 lsr &= SC16IS7XX_LSR_BRK_ERROR_MASK;
 586
 587                 port->icount.rx++;
 588                 flag = TTY_NORMAL;
 589
 590                 if (unlikely(lsr)) {
 591                         if (lsr & SC16IS7XX_LSR_BI_BIT) {
 592                                 port->icount.brk++;
 593                                 if (uart_handle_break(port))
 594                                         continue;
 595                         } else if (lsr & SC16IS7XX_LSR_PE_BIT)
 596                                 port->icount.parity++;
 597                         else if (lsr & SC16IS7XX_LSR_FE_BIT)
 598                                 port->icount.frame++;
 599                         else if (lsr & SC16IS7XX_LSR_OE_BIT)
 600                                 port->icount.overrun++;
 601
 602                         lsr &= port->read_status_mask;
 603                         if (lsr & SC16IS7XX_LSR_BI_BIT)
 604                                 flag = TTY_BREAK;
 605                         else if (lsr & SC16IS7XX_LSR_PE_BIT)
 606                                 flag = TTY_PARITY;
 607                         else if (lsr & SC16IS7XX_LSR_FE_BIT)
 608                                 flag = TTY_FRAME;
 609                         else if (lsr & SC16IS7XX_LSR_OE_BIT)
 610                                 flag = TTY_OVERRUN;
 611                 }
 612
 613                 for (i = 0; i < bytes_read; ++i) {
 614                         ch = s->buf[i];
 615                         if (uart_handle_sysrq_char(port, ch))
 616                                 continue;
 617
 618                         if (lsr & port->ignore_status_mask)
 619                                 continue;
 620
 621                         uart_insert_char(port, lsr, SC16IS7XX_LSR_OE_BIT, ch,
 622                                          flag);
 623                 }
 624                 rxlen -= bytes_read;
 625         }
 626
 627         tty_flip_buffer_push(&port->state->port);
 628 }
 629
 630 static void sc16is7xx_handle_tx(struct uart_port *port)
 631 {
 632         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 633         struct circ_buf *xmit = &port->state->xmit;
 634         unsigned int txlen, to_send, i;
 635
 636         if (unlikely(port->x_char)) {
 637                 sc16is7xx_port_write(port, SC16IS7XX_THR_REG, port->x_char);
 638                 port->icount.tx++;
 639                 port->x_char = 0;
 640                 return;
 641         }
 642
 643         if (uart_circ_empty(xmit) || uart_tx_stopped(port))
 644                 return;
 645
 646         /* Get length of data pending in circular buffer */
 647         to_send = uart_circ_chars_pending(xmit);
 648         if (likely(to_send)) {
 649                 /* Limit to size of TX FIFO */
 650                 txlen = sc16is7xx_port_read(port, SC16IS7XX_TXLVL_REG);
 651                 to_send = (to_send > txlen) ? txlen : to_send;
 652
 653                 /* Add data to send */
 654                 port->icount.tx += to_send;
 655
 656                 /* Convert to linear buffer */
 657                 for (i = 0; i < to_send; ++i) {
 658                         s->buf[i] = xmit->buf[xmit->tail];
 659                         xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
 660                 }
 661
 662                 sc16is7xx_fifo_write(port, to_send);
 663         }
 664
 665         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 666                 uart_write_wakeup(port);
 667 }
 668
 669 static bool sc16is7xx_port_irq(struct sc16is7xx_port *s, int portno)
 670 {
 671         struct uart_port *port = &s->p[portno].port;
 672
 673         do {
 674                 unsigned int iir, msr, rxlen;
 675
 676                 iir = sc16is7xx_port_read(port, SC16IS7XX_IIR_REG);
 677                 if (iir & SC16IS7XX_IIR_NO_INT_BIT)
 678                         return false;
 679
 680                 iir &= SC16IS7XX_IIR_ID_MASK;
 681
 682                 switch (iir) {
 683                 case SC16IS7XX_IIR_RDI_SRC:
 684                 case SC16IS7XX_IIR_RLSE_SRC:
 685                 case SC16IS7XX_IIR_RTOI_SRC:
 686                 case SC16IS7XX_IIR_XOFFI_SRC:
 687                         rxlen = sc16is7xx_port_read(port, SC16IS7XX_RXLVL_REG);
 688                         if (rxlen)
 689                                 sc16is7xx_handle_rx(port, rxlen, iir);
 690                         break;
 691
 692                 case SC16IS7XX_IIR_CTSRTS_SRC:
 693                         msr = sc16is7xx_port_read(port, SC16IS7XX_MSR_REG);
 694                         uart_handle_cts_change(port,
 695                                                !!(msr & SC16IS7XX_MSR_CTS_BIT));
 696                         break;
 697                 case SC16IS7XX_IIR_THRI_SRC:
 698                         sc16is7xx_handle_tx(port);
 699                         break;
 700                 default:
 701                         dev_err_ratelimited(port->dev,
 702                                             "ttySC%i: Unexpected interrupt: %x",
 703                                             port->line, iir);
 704                         break;
 705                 }
 706         } while (0);
 707         return true;
 708 }
 709
 710 static void sc16is7xx_ist(struct kthread_work *ws)
 711 {
 712         struct sc16is7xx_port *s = to_sc16is7xx_port(ws, irq_work);
 713
 714         mutex_lock(&s->efr_lock);
 715
 716         while (1) {
 717                 bool keep_polling = false;
 718                 int i;
 719
 720                 for (i = 0; i < s->devtype->nr_uart; ++i)
 721                         keep_polling |= sc16is7xx_port_irq(s, i);
 722                 if (!keep_polling)
 723                         break;
 724         }
 725
 726         mutex_unlock(&s->efr_lock);
 727 }
 728
 729 static irqreturn_t sc16is7xx_irq(int irq, void *dev_id)
 730 {
 731         struct sc16is7xx_port *s = (struct sc16is7xx_port *)dev_id;
 732
 733         queue_kthread_work(&s->kworker, &s->irq_work);
 734
 735         return IRQ_HANDLED;
 736 }
 737
 738 static void sc16is7xx_tx_proc(struct kthread_work *ws)
 739 {
 740         struct uart_port *port = &(to_sc16is7xx_one(ws, tx_work)->port);
 741
 742         if ((port->rs485.flags & SER_RS485_ENABLED) &&
 743             (port->rs485.delay_rts_before_send > 0))
 744                 msleep(port->rs485.delay_rts_before_send);
 745
 746         sc16is7xx_handle_tx(port);
 747 }
 748
 749 static void sc16is7xx_reconf_rs485(struct uart_port *port)
 750 {
 751         const u32 mask = SC16IS7XX_EFCR_AUTO_RS485_BIT |
 752                          SC16IS7XX_EFCR_RTS_INVERT_BIT;
 753         u32 efcr = 0;
 754         struct serial_rs485 *rs485 = &port->rs485;
 755         unsigned long irqflags;
 756
 757         spin_lock_irqsave(&port->lock, irqflags);
 758         if (rs485->flags & SER_RS485_ENABLED) {
 759                 efcr |= SC16IS7XX_EFCR_AUTO_RS485_BIT;
 760
 761                 if (rs485->flags & SER_RS485_RTS_AFTER_SEND)
 762                         efcr |= SC16IS7XX_EFCR_RTS_INVERT_BIT;
 763         }
 764         spin_unlock_irqrestore(&port->lock, irqflags);
 765
 766         sc16is7xx_port_update(port, SC16IS7XX_EFCR_REG, mask, efcr);
 767 }
 768
 769 static void sc16is7xx_reg_proc(struct kthread_work *ws)
 770 {
 771         struct sc16is7xx_one *one = to_sc16is7xx_one(ws, reg_work);
 772         struct sc16is7xx_one_config config;
 773         unsigned long irqflags;
 774
 775         spin_lock_irqsave(&one->port.lock, irqflags);
 776         config = one->config;
 777         memset(&one->config, 0, sizeof(one->config));
 778         spin_unlock_irqrestore(&one->port.lock, irqflags);
 779
 780         if (config.flags & SC16IS7XX_RECONF_MD)
 781                 sc16is7xx_port_update(&one->port, SC16IS7XX_MCR_REG,
 782                                       SC16IS7XX_MCR_LOOP_BIT,
 783                                       (one->port.mctrl & TIOCM_LOOP) ?
 784                                       SC16IS7XX_MCR_LOOP_BIT : 0);
 785
 786         if (config.flags & SC16IS7XX_RECONF_IER)
 787                 sc16is7xx_port_update(&one->port, SC16IS7XX_IER_REG,
 788                                       config.ier_clear, 0);
 789
 790         if (config.flags & SC16IS7XX_RECONF_RS485)
 791                 sc16is7xx_reconf_rs485(&one->port);
 792 }
 793
 794 static void sc16is7xx_ier_clear(struct uart_port *port, u8 bit)
 795 {
 796         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 797         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
 798
 799         one->config.flags |= SC16IS7XX_RECONF_IER;
 800         one->config.ier_clear |= bit;
 801         queue_kthread_work(&s->kworker, &one->reg_work);
 802 }
 803
 804 static void sc16is7xx_stop_tx(struct uart_port *port)
 805 {
 806         sc16is7xx_ier_clear(port, SC16IS7XX_IER_THRI_BIT);
 807 }
 808
 809 static void sc16is7xx_stop_rx(struct uart_port *port)
 810 {
 811         sc16is7xx_ier_clear(port, SC16IS7XX_IER_RDI_BIT);
 812 }
 813
 814 static void sc16is7xx_start_tx(struct uart_port *port)
 815 {
 816         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 817         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
 818
 819         queue_kthread_work(&s->kworker, &one->tx_work);
 820 }
 821
 822 static unsigned int sc16is7xx_tx_empty(struct uart_port *port)
 823 {
 824         unsigned int lsr;
 825
 826         lsr = sc16is7xx_port_read(port, SC16IS7XX_LSR_REG);
 827
 828         return (lsr & SC16IS7XX_LSR_TEMT_BIT) ? TIOCSER_TEMT : 0;
 829 }
 830
 831 static unsigned int sc16is7xx_get_mctrl(struct uart_port *port)
 832 {
 833         /* DCD and DSR are not wired and CTS/RTS is handled automatically
 834          * so just indicate DSR and CAR asserted
 835          */
 836         return TIOCM_DSR | TIOCM_CAR;
 837 }
 838
 839 static void sc16is7xx_set_mctrl(struct uart_port *port, unsigned int mctrl)
 840 {
 841         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 842         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
 843
 844         one->config.flags |= SC16IS7XX_RECONF_MD;
 845         queue_kthread_work(&s->kworker, &one->reg_work);
 846 }
 847
 848 static void sc16is7xx_break_ctl(struct uart_port *port, int break_state)
 849 {
 850         sc16is7xx_port_update(port, SC16IS7XX_LCR_REG,
 851                               SC16IS7XX_LCR_TXBREAK_BIT,
 852                               break_state ? SC16IS7XX_LCR_TXBREAK_BIT : 0);
 853 }
 854
 855 static void sc16is7xx_set_termios(struct uart_port *port,
 856                                   struct ktermios *termios,
 857                                   struct ktermios *old)
 858 {
 859         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 860         unsigned int lcr, flow = 0;
 861         int baud;
 862
 863         /* Mask termios capabilities we don't support */
 864         termios->c_cflag &= ~CMSPAR;
 865
 866         /* Word size */
 867         switch (termios->c_cflag & CSIZE) {
 868         case CS5:
 869                 lcr = SC16IS7XX_LCR_WORD_LEN_5;
 870                 break;
 871         case CS6:
 872                 lcr = SC16IS7XX_LCR_WORD_LEN_6;
 873                 break;
 874         case CS7:
 875                 lcr = SC16IS7XX_LCR_WORD_LEN_7;
 876                 break;
 877         case CS8:
 878                 lcr = SC16IS7XX_LCR_WORD_LEN_8;
 879                 break;
 880         default:
 881                 lcr = SC16IS7XX_LCR_WORD_LEN_8;
 882                 termios->c_cflag &= ~CSIZE;
 883                 termios->c_cflag |= CS8;
 884                 break;
 885         }
 886
 887         /* Parity */
 888         if (termios->c_cflag & PARENB) {
 889                 lcr |= SC16IS7XX_LCR_PARITY_BIT;
 890                 if (!(termios->c_cflag & PARODD))
 891                         lcr |= SC16IS7XX_LCR_EVENPARITY_BIT;
 892         }
 893
 894         /* Stop bits */
 895         if (termios->c_cflag & CSTOPB)
 896                 lcr |= SC16IS7XX_LCR_STOPLEN_BIT; /* 2 stops */
 897
 898         /* Set read status mask */
 899         port->read_status_mask = SC16IS7XX_LSR_OE_BIT;
 900         if (termios->c_iflag & INPCK)
 901                 port->read_status_mask |= SC16IS7XX_LSR_PE_BIT |
 902                                           SC16IS7XX_LSR_FE_BIT;
 903         if (termios->c_iflag & (BRKINT | PARMRK))
 904                 port->read_status_mask |= SC16IS7XX_LSR_BI_BIT;
 905
 906         /* Set status ignore mask */
 907         port->ignore_status_mask = 0;
 908         if (termios->c_iflag & IGNBRK)
 909                 port->ignore_status_mask |= SC16IS7XX_LSR_BI_BIT;
 910         if (!(termios->c_cflag & CREAD))
 911                 port->ignore_status_mask |= SC16IS7XX_LSR_BRK_ERROR_MASK;
 912
 913         /* As above, claim the mutex while accessing the EFR. */
 914         mutex_lock(&s->efr_lock);
 915
 916         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG,
 917                              SC16IS7XX_LCR_CONF_MODE_B);
 918
 919         /* Configure flow control */
 920         regcache_cache_bypass(s->regmap, true);
 921         sc16is7xx_port_write(port, SC16IS7XX_XON1_REG, termios->c_cc[VSTART]);
 922         sc16is7xx_port_write(port, SC16IS7XX_XOFF1_REG, termios->c_cc[VSTOP]);
 923         if (termios->c_cflag & CRTSCTS)
 924                 flow |= SC16IS7XX_EFR_AUTOCTS_BIT |
 925                         SC16IS7XX_EFR_AUTORTS_BIT;
 926         if (termios->c_iflag & IXON)
 927                 flow |= SC16IS7XX_EFR_SWFLOW3_BIT;
 928         if (termios->c_iflag & IXOFF)
 929                 flow |= SC16IS7XX_EFR_SWFLOW1_BIT;
 930
 931         sc16is7xx_port_write(port, SC16IS7XX_EFR_REG, flow);
 932         regcache_cache_bypass(s->regmap, false);
 933
 934         /* Update LCR register */
 935         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, lcr);
 936
 937         mutex_unlock(&s->efr_lock);
 938
 939         /* Get baud rate generator configuration */
 940         baud = uart_get_baud_rate(port, termios, old,
 941                                   port->uartclk / 16 / 4 / 0xffff,
 942                                   port->uartclk / 16);
 943
 944         /* Setup baudrate generator */
 945         baud = sc16is7xx_set_baud(port, baud);
 946
 947         /* Update timeout according to new baud rate */
 948         uart_update_timeout(port, termios->c_cflag, baud);
 949 }
 950
 951 static int sc16is7xx_config_rs485(struct uart_port *port,
 952                                   struct serial_rs485 *rs485)
 953 {
 954         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 955         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
 956
 957         if (rs485->flags & SER_RS485_ENABLED) {
 958                 bool rts_during_rx, rts_during_tx;
 959
 960                 rts_during_rx = rs485->flags & SER_RS485_RTS_AFTER_SEND;
 961                 rts_during_tx = rs485->flags & SER_RS485_RTS_ON_SEND;
 962
 963                 if (rts_during_rx == rts_during_tx)
 964                         dev_err(port->dev,
 965                                 "unsupported RTS signalling on_send:%d after_send:%d - exactly one of RS485 RTS flags should be set\n",
 966                                 rts_during_tx, rts_during_rx);
 967
 968                 /*
 969                  * RTS signal is handled by HW, it's timing can't be influenced.
 970                  * However, it's sometimes useful to delay TX even without RTS
 971                  * control therefore we try to handle .delay_rts_before_send.
 972                  */
 973                 if (rs485->delay_rts_after_send)
 974                         return -EINVAL;
 975         }
 976
 977         port->rs485 = *rs485;
 978         one->config.flags |= SC16IS7XX_RECONF_RS485;
 979         queue_kthread_work(&s->kworker, &one->reg_work);
 980
 981         return 0;
 982 }
 983
 984 static int sc16is7xx_startup(struct uart_port *port)
 985 {
 986         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
 987         unsigned int val;
 988
 989         sc16is7xx_power(port, 1);
 990
 991         /* Reset FIFOs*/
 992         val = SC16IS7XX_FCR_RXRESET_BIT | SC16IS7XX_FCR_TXRESET_BIT;
 993         sc16is7xx_port_write(port, SC16IS7XX_FCR_REG, val);
 994         udelay(5);
 995         sc16is7xx_port_write(port, SC16IS7XX_FCR_REG,
 996                              SC16IS7XX_FCR_FIFO_BIT);
 997
 998         /* Enable EFR */
 999         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG,
1000                              SC16IS7XX_LCR_CONF_MODE_B);
1001
1002         regcache_cache_bypass(s->regmap, true);
1003
1004         /* Enable write access to enhanced features and internal clock div */
1005         sc16is7xx_port_write(port, SC16IS7XX_EFR_REG,
1006                              SC16IS7XX_EFR_ENABLE_BIT);
1007
1008         /* Enable TCR/TLR */
1009         sc16is7xx_port_update(port, SC16IS7XX_MCR_REG,
1010                               SC16IS7XX_MCR_TCRTLR_BIT,
1011                               SC16IS7XX_MCR_TCRTLR_BIT);
1012
1013         /* Configure flow control levels */
1014         /* Flow control halt level 48, resume level 24 */
1015         sc16is7xx_port_write(port, SC16IS7XX_TCR_REG,
1016                              SC16IS7XX_TCR_RX_RESUME(24) |
1017                              SC16IS7XX_TCR_RX_HALT(48));
1018
1019         regcache_cache_bypass(s->regmap, false);
1020
1021         /* Now, initialize the UART */
1022         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, SC16IS7XX_LCR_WORD_LEN_8);
1023
1024         /* Enable the Rx and Tx FIFO */
1025         sc16is7xx_port_update(port, SC16IS7XX_EFCR_REG,
1026                               SC16IS7XX_EFCR_RXDISABLE_BIT |
1027                               SC16IS7XX_EFCR_TXDISABLE_BIT,
1028                               0);
1029
1030         /* Enable RX, TX, CTS change interrupts */
1031         val = SC16IS7XX_IER_RDI_BIT | SC16IS7XX_IER_THRI_BIT |
1032               SC16IS7XX_IER_CTSI_BIT;
1033         sc16is7xx_port_write(port, SC16IS7XX_IER_REG, val);
1034
1035         return 0;
1036 }
1037
1038 static void sc16is7xx_shutdown(struct uart_port *port)
1039 {
1040         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
1041
1042         /* Disable all interrupts */
1043         sc16is7xx_port_write(port, SC16IS7XX_IER_REG, 0);
1044         /* Disable TX/RX */
1045         sc16is7xx_port_update(port, SC16IS7XX_EFCR_REG,
1046                               SC16IS7XX_EFCR_RXDISABLE_BIT |
1047                               SC16IS7XX_EFCR_TXDISABLE_BIT,
1048                               SC16IS7XX_EFCR_RXDISABLE_BIT |
1049                               SC16IS7XX_EFCR_TXDISABLE_BIT);
1050
1051         sc16is7xx_power(port, 0);
1052
1053         flush_kthread_worker(&s->kworker);
1054 }
1055
1056 static const char *sc16is7xx_type(struct uart_port *port)
1057 {
1058         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
1059
1060         return (port->type == PORT_SC16IS7XX) ? s->devtype->name : NULL;
1061 }
1062
1063 static int sc16is7xx_request_port(struct uart_port *port)
1064 {
1065         /* Do nothing */
1066         return 0;
1067 }
1068
1069 static void sc16is7xx_config_port(struct uart_port *port, int flags)
1070 {
1071         if (flags & UART_CONFIG_TYPE)
1072                 port->type = PORT_SC16IS7XX;
1073 }
1074
1075 static int sc16is7xx_verify_port(struct uart_port *port,
1076                                  struct serial_struct *s)
1077 {
1078         if ((s->type != PORT_UNKNOWN) && (s->type != PORT_SC16IS7XX))
1079                 return -EINVAL;
1080         if (s->irq != port->irq)
1081                 return -EINVAL;
1082
1083         return 0;
1084 }
1085
1086 static void sc16is7xx_pm(struct uart_port *port, unsigned int state,
1087                          unsigned int oldstate)
1088 {
1089         sc16is7xx_power(port, (state == UART_PM_STATE_ON) ? 1 : 0);
1090 }
1091
1092 static void sc16is7xx_null_void(struct uart_port *port)
1093 {
1094         /* Do nothing */
1095 }
1096
1097 static const struct uart_ops sc16is7xx_ops = {
1098         .tx_empty       = sc16is7xx_tx_empty,
1099         .set_mctrl      = sc16is7xx_set_mctrl,
1100         .get_mctrl      = sc16is7xx_get_mctrl,
1101         .stop_tx        = sc16is7xx_stop_tx,
1102         .start_tx       = sc16is7xx_start_tx,
1103         .stop_rx        = sc16is7xx_stop_rx,
1104         .break_ctl      = sc16is7xx_break_ctl,
1105         .startup        = sc16is7xx_startup,
1106         .shutdown       = sc16is7xx_shutdown,
1107         .set_termios    = sc16is7xx_set_termios,
1108         .type           = sc16is7xx_type,
1109         .request_port   = sc16is7xx_request_port,
1110         .release_port   = sc16is7xx_null_void,
1111         .config_port    = sc16is7xx_config_port,
1112         .verify_port    = sc16is7xx_verify_port,
1113         .pm             = sc16is7xx_pm,
1114 };
1115
1116 #ifdef CONFIG_GPIOLIB
1117 static int sc16is7xx_gpio_get(struct gpio_chip *chip, unsigned offset)
1118 {
1119         unsigned int val;
1120         struct sc16is7xx_port *s = container_of(chip, struct sc16is7xx_port,
1121                                                 gpio);
1122         struct uart_port *port = &s->p[0].port;
1123
1124         val = sc16is7xx_port_read(port, SC16IS7XX_IOSTATE_REG);
1125
1126         return !!(val & BIT(offset));
1127 }
1128
1129 static void sc16is7xx_gpio_set(struct gpio_chip *chip, unsigned offset, int val)
1130 {
1131         struct sc16is7xx_port *s = container_of(chip, struct sc16is7xx_port,
1132                                                 gpio);
1133         struct uart_port *port = &s->p[0].port;
1134
1135         sc16is7xx_port_update(port, SC16IS7XX_IOSTATE_REG, BIT(offset),
1136                               val ? BIT(offset) : 0);
1137 }
1138
1139 static int sc16is7xx_gpio_direction_input(struct gpio_chip *chip,
1140                                           unsigned offset)
1141 {
1142         struct sc16is7xx_port *s = container_of(chip, struct sc16is7xx_port,
1143                                                 gpio);
1144         struct uart_port *port = &s->p[0].port;
1145
1146         sc16is7xx_port_update(port, SC16IS7XX_IODIR_REG, BIT(offset), 0);
1147
1148         return 0;
1149 }
1150
1151 static int sc16is7xx_gpio_direction_output(struct gpio_chip *chip,
1152                                            unsigned offset, int val)
1153 {
1154         struct sc16is7xx_port *s = container_of(chip, struct sc16is7xx_port,
1155                                                 gpio);
1156         struct uart_port *port = &s->p[0].port;
1157
1158         sc16is7xx_port_update(port, SC16IS7XX_IOSTATE_REG, BIT(offset),
1159                               val ? BIT(offset) : 0);
1160         sc16is7xx_port_update(port, SC16IS7XX_IODIR_REG, BIT(offset),
1161                               BIT(offset));
1162
1163         return 0;
1164 }
1165 #endif
1166
1167 static int sc16is7xx_probe(struct device *dev,
1168                            const struct sc16is7xx_devtype *devtype,
1169                            struct regmap *regmap, int irq, unsigned long flags)
1170 {
1171         struct sched_param sched_param = { .sched_priority = MAX_RT_PRIO / 2 };
1172         unsigned long freq, *pfreq = dev_get_platdata(dev);
1173         int i, ret;
1174         struct sc16is7xx_port *s;
1175
1176         if (IS_ERR(regmap))
1177                 return PTR_ERR(regmap);
1178
1179         /* Alloc port structure */
1180         s = devm_kzalloc(dev, sizeof(*s) +
1181                          sizeof(struct sc16is7xx_one) * devtype->nr_uart,
1182                          GFP_KERNEL);
1183         if (!s) {
1184                 dev_err(dev, "Error allocating port structure\n");
1185                 return -ENOMEM;
1186         }
1187
1188         s->clk = devm_clk_get(dev, NULL);
1189         if (IS_ERR(s->clk)) {
1190                 if (pfreq)
1191                         freq = *pfreq;
1192                 else
1193                         return PTR_ERR(s->clk);
1194         } else {
1195                 clk_prepare_enable(s->clk);
1196                 freq = clk_get_rate(s->clk);
1197         }
1198
1199         s->regmap = regmap;
1200         s->devtype = devtype;
1201         dev_set_drvdata(dev, s);
1202         mutex_init(&s->efr_lock);
1203
1204         init_kthread_worker(&s->kworker);
1205         init_kthread_work(&s->irq_work, sc16is7xx_ist);
1206         s->kworker_task = kthread_run(kthread_worker_fn, &s->kworker,
1207                                       "sc16is7xx");
1208         if (IS_ERR(s->kworker_task)) {
1209                 ret = PTR_ERR(s->kworker_task);
1210                 goto out_clk;
1211         }
1212         sched_setscheduler(s->kworker_task, SCHED_FIFO, &sched_param);
1213
1214 #ifdef CONFIG_GPIOLIB
1215         if (devtype->nr_gpio) {
1216                 /* Setup GPIO cotroller */
1217                 s->gpio.owner            = THIS_MODULE;
1218                 s->gpio.dev              = dev;
1219                 s->gpio.label            = dev_name(dev);
1220                 s->gpio.direction_input  = sc16is7xx_gpio_direction_input;
1221                 s->gpio.get              = sc16is7xx_gpio_get;
1222                 s->gpio.direction_output = sc16is7xx_gpio_direction_output;
1223                 s->gpio.set              = sc16is7xx_gpio_set;
1224                 s->gpio.base             = -1;
1225                 s->gpio.ngpio            = devtype->nr_gpio;
1226                 s->gpio.can_sleep        = 1;
1227                 ret = gpiochip_add(&s->gpio);
1228                 if (ret)
1229                         goto out_thread;
1230         }
1231 #endif
1232
1233         for (i = 0; i < devtype->nr_uart; ++i) {
1234                 s->p[i].line            = i;
1235                 /* Initialize port data */
1236                 s->p[i].port.dev        = dev;
1237                 s->p[i].port.irq        = irq;
1238                 s->p[i].port.type       = PORT_SC16IS7XX;
1239                 s->p[i].port.fifosize   = SC16IS7XX_FIFO_SIZE;
1240                 s->p[i].port.flags      = UPF_FIXED_TYPE | UPF_LOW_LATENCY;
1241                 s->p[i].port.iotype     = UPIO_PORT;
1242                 s->p[i].port.uartclk    = freq;
1243                 s->p[i].port.rs485_config = sc16is7xx_config_rs485;
1244                 s->p[i].port.ops        = &sc16is7xx_ops;
1245                 s->p[i].port.line       = sc16is7xx_alloc_line();
1246                 if (s->p[i].port.line >= SC16IS7XX_MAX_DEVS) {
1247                         ret = -ENOMEM;
1248                         goto out_ports;
1249                 }
1250
1251                 /* Disable all interrupts */
1252                 sc16is7xx_port_write(&s->p[i].port, SC16IS7XX_IER_REG, 0);
1253                 /* Disable TX/RX */
1254                 sc16is7xx_port_write(&s->p[i].port, SC16IS7XX_EFCR_REG,
1255                                      SC16IS7XX_EFCR_RXDISABLE_BIT |
1256                                      SC16IS7XX_EFCR_TXDISABLE_BIT);
1257                 /* Initialize kthread work structs */
1258                 init_kthread_work(&s->p[i].tx_work, sc16is7xx_tx_proc);
1259                 init_kthread_work(&s->p[i].reg_work, sc16is7xx_reg_proc);
1260                 /* Register port */
1261                 uart_add_one_port(&sc16is7xx_uart, &s->p[i].port);
1262                 /* Go to suspend mode */
1263                 sc16is7xx_power(&s->p[i].port, 0);
1264         }
1265
1266         /* Setup interrupt */
1267         ret = devm_request_irq(dev, irq, sc16is7xx_irq,
1268                                flags, dev_name(dev), s);
1269         if (!ret)
1270                 return 0;
1271
1272 out_ports:
1273         for (i--; i >= 0; i--) {
1274                 uart_remove_one_port(&sc16is7xx_uart, &s->p[i].port);
1275                 clear_bit(s->p[i].port.line, &sc16is7xx_lines);
1276         }
1277
1278 #ifdef CONFIG_GPIOLIB
1279         if (devtype->nr_gpio)
1280                 gpiochip_remove(&s->gpio);
1281
1282 out_thread:
1283 #endif
1284         kthread_stop(s->kworker_task);
1285
1286 out_clk:
1287         if (!IS_ERR(s->clk))
1288                 clk_disable_unprepare(s->clk);
1289
1290         return ret;
1291 }
1292
1293 static int sc16is7xx_remove(struct device *dev)
1294 {
1295         struct sc16is7xx_port *s = dev_get_drvdata(dev);
1296         int i;
1297
1298 #ifdef CONFIG_GPIOLIB
1299         if (s->devtype->nr_gpio)
1300                 gpiochip_remove(&s->gpio);
1301 #endif
1302
1303         for (i = 0; i < s->devtype->nr_uart; i++) {
1304                 uart_remove_one_port(&sc16is7xx_uart, &s->p[i].port);
1305                 clear_bit(s->p[i].port.line, &sc16is7xx_lines);
1306                 sc16is7xx_power(&s->p[i].port, 0);
1307         }
1308
1309         flush_kthread_worker(&s->kworker);
1310         kthread_stop(s->kworker_task);
1311
1312         if (!IS_ERR(s->clk))
1313                 clk_disable_unprepare(s->clk);
1314
1315         return 0;
1316 }
1317
1318 static const struct of_device_id __maybe_unused sc16is7xx_dt_ids[] = {
1319         { .compatible = "nxp,sc16is740",        .data = &sc16is74x_devtype, },
1320         { .compatible = "nxp,sc16is741",        .data = &sc16is74x_devtype, },
1321         { .compatible = "nxp,sc16is750",        .data = &sc16is750_devtype, },
1322         { .compatible = "nxp,sc16is752",        .data = &sc16is752_devtype, },
1323         { .compatible = "nxp,sc16is760",        .data = &sc16is760_devtype, },
1324         { .compatible = "nxp,sc16is762",        .data = &sc16is762_devtype, },
1325         { }
1326 };
1327 MODULE_DEVICE_TABLE(of, sc16is7xx_dt_ids);
1328
1329 static struct regmap_config regcfg = {
1330         .reg_bits = 7,
1331         .pad_bits = 1,
1332         .val_bits = 8,
1333         .cache_type = REGCACHE_RBTREE,
1334         .volatile_reg = sc16is7xx_regmap_volatile,
1335         .precious_reg = sc16is7xx_regmap_precious,
1336 };
1337
1338 #ifdef CONFIG_SERIAL_SC16IS7XX_SPI
1339 static int sc16is7xx_spi_probe(struct spi_device *spi)
1340 {
1341         const struct sc16is7xx_devtype *devtype;
1342         unsigned long flags = 0;
1343         struct regmap *regmap;
1344         int ret;
1345
1346         /* Setup SPI bus */
1347         spi->bits_per_word      = 8;
1348         /* only supports mode 0 on SC16IS762 */
1349         spi->mode               = spi->mode ? : SPI_MODE_0;
1350         spi->max_speed_hz       = spi->max_speed_hz ? : 15000000;
1351         ret = spi_setup(spi);
1352         if (ret)
1353                 return ret;
1354
1355         if (spi->dev.of_node) {
1356                 const struct of_device_id *of_id =
1357                         of_match_device(sc16is7xx_dt_ids, &spi->dev);
1358
1359                 if (!of_id)
1360                         return -ENODEV;
1361
1362                 devtype = (struct sc16is7xx_devtype *)of_id->data;
1363         } else {
1364                 const struct spi_device_id *id_entry = spi_get_device_id(spi);
1365
1366                 devtype = (struct sc16is7xx_devtype *)id_entry->driver_data;
1367                 flags = IRQF_TRIGGER_FALLING;
1368         }
1369
1370         regcfg.max_register = (0xf << SC16IS7XX_REG_SHIFT) |
1371                               (devtype->nr_uart - 1);
1372         regmap = devm_regmap_init_spi(spi, &regcfg);
1373
1374         return sc16is7xx_probe(&spi->dev, devtype, regmap, spi->irq, flags);
1375 }
1376
1377 static int sc16is7xx_spi_remove(struct spi_device *spi)
1378 {
1379         return sc16is7xx_remove(&spi->dev);
1380 }
1381
1382 static const struct spi_device_id sc16is7xx_spi_id_table[] = {
1383         { "sc16is74x",  (kernel_ulong_t)&sc16is74x_devtype, },
1384         { "sc16is740",  (kernel_ulong_t)&sc16is74x_devtype, },
1385         { "sc16is741",  (kernel_ulong_t)&sc16is74x_devtype, },
1386         { "sc16is750",  (kernel_ulong_t)&sc16is750_devtype, },
1387         { "sc16is752",  (kernel_ulong_t)&sc16is752_devtype, },
1388         { "sc16is760",  (kernel_ulong_t)&sc16is760_devtype, },
1389         { "sc16is762",  (kernel_ulong_t)&sc16is762_devtype, },
1390         { }
1391 };
1392
1393 MODULE_DEVICE_TABLE(spi, sc16is7xx_spi_id_table);
1394
1395 static struct spi_driver sc16is7xx_spi_uart_driver = {
1396         .driver = {
1397                 .name           = SC16IS7XX_NAME,
1398                 .of_match_table = of_match_ptr(sc16is7xx_dt_ids),
1399         },
1400         .probe          = sc16is7xx_spi_probe,
1401         .remove         = sc16is7xx_spi_remove,
1402         .id_table       = sc16is7xx_spi_id_table,
1403 };
1404
1405 MODULE_ALIAS("spi:sc16is7xx");
1406 #endif
1407
1408 #ifdef CONFIG_SERIAL_SC16IS7XX_I2C
1409 static int sc16is7xx_i2c_probe(struct i2c_client *i2c,
1410                                const struct i2c_device_id *id)
1411 {
1412         const struct sc16is7xx_devtype *devtype;
1413         unsigned long flags = 0;
1414         struct regmap *regmap;
1415
1416         if (i2c->dev.of_node) {
1417                 const struct of_device_id *of_id =
1418                                 of_match_device(sc16is7xx_dt_ids, &i2c->dev);
1419
1420                 if (!of_id)
1421                         return -ENODEV;
1422
1423                 devtype = (struct sc16is7xx_devtype *)of_id->data;
1424         } else {
1425                 devtype = (struct sc16is7xx_devtype *)id->driver_data;
1426                 flags = IRQF_TRIGGER_FALLING;
1427         }
1428
1429         regcfg.max_register = (0xf << SC16IS7XX_REG_SHIFT) |
1430                               (devtype->nr_uart - 1);
1431         regmap = devm_regmap_init_i2c(i2c, &regcfg);
1432
1433         return sc16is7xx_probe(&i2c->dev, devtype, regmap, i2c->irq, flags);
1434 }
1435
1436 static int sc16is7xx_i2c_remove(struct i2c_client *client)
1437 {
1438         return sc16is7xx_remove(&client->dev);
1439 }
1440
1441 static const struct i2c_device_id sc16is7xx_i2c_id_table[] = {
1442         { "sc16is74x",  (kernel_ulong_t)&sc16is74x_devtype, },
1443         { "sc16is740",  (kernel_ulong_t)&sc16is74x_devtype, },
1444         { "sc16is741",  (kernel_ulong_t)&sc16is74x_devtype, },
1445         { "sc16is750",  (kernel_ulong_t)&sc16is750_devtype, },
1446         { "sc16is752",  (kernel_ulong_t)&sc16is752_devtype, },
1447         { "sc16is760",  (kernel_ulong_t)&sc16is760_devtype, },
1448         { "sc16is762",  (kernel_ulong_t)&sc16is762_devtype, },
1449         { }
1450 };
1451 MODULE_DEVICE_TABLE(i2c, sc16is7xx_i2c_id_table);
1452
1453 static struct i2c_driver sc16is7xx_i2c_uart_driver = {
1454         .driver = {
1455                 .name           = SC16IS7XX_NAME,
1456                 .of_match_table = of_match_ptr(sc16is7xx_dt_ids),
1457         },
1458         .probe          = sc16is7xx_i2c_probe,
1459         .remove         = sc16is7xx_i2c_remove,
1460         .id_table       = sc16is7xx_i2c_id_table,
1461 };
1462
1463 #endif
1464
1465 static int __init sc16is7xx_init(void)
1466 {
1467         int ret;
1468
1469         ret = uart_register_driver(&sc16is7xx_uart);
1470         if (ret) {
1471                 pr_err("Registering UART driver failed\n");
1472                 return ret;
1473         }
1474
1475 #ifdef CONFIG_SERIAL_SC16IS7XX_I2C
1476         ret = i2c_add_driver(&sc16is7xx_i2c_uart_driver);
1477         if (ret < 0) {
1478                 pr_err("failed to init sc16is7xx i2c --> %d\n", ret);
1479                 goto err_i2c;
1480         }
1481 #endif
1482
1483 #ifdef CONFIG_SERIAL_SC16IS7XX_SPI
1484         ret = spi_register_driver(&sc16is7xx_spi_uart_driver);
1485         if (ret < 0) {
1486                 pr_err("failed to init sc16is7xx spi --> %d\n", ret);
1487                 goto err_spi;
1488         }
1489 #endif
1490         return ret;
1491
1492 #ifdef CONFIG_SERIAL_SC16IS7XX_SPI
1493 err_spi:
1494 #ifdef CONFIG_SERIAL_SC16IS7XX_I2C
1495         i2c_del_driver(&sc16is7xx_i2c_uart_driver);
1496 #endif
1497 #endif
1498 err_i2c:
1499         uart_unregister_driver(&sc16is7xx_uart);
1500         return ret;
1501 }
1502 module_init(sc16is7xx_init);
1503
1504 static void __exit sc16is7xx_exit(void)
1505 {
1506 #ifdef CONFIG_SERIAL_SC16IS7XX_I2C
1507         i2c_del_driver(&sc16is7xx_i2c_uart_driver);
1508 #endif
1509
1510 #ifdef CONFIG_SERIAL_SC16IS7XX_SPI
1511         spi_unregister_driver(&sc16is7xx_spi_uart_driver);
1512 #endif
1513         uart_unregister_driver(&sc16is7xx_uart);
1514 }
1515 module_exit(sc16is7xx_exit);
1516
1517 MODULE_LICENSE("GPL");
1518 MODULE_AUTHOR("Jon Ringle <jringle@gridpoint.com>");
1519 MODULE_DESCRIPTION("SC16IS7XX serial driver");