GNU Linux-libre 4.9.309-gnu1
[releases.git] / 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/driver.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 << 4) /* CTS */
200 #define SC16IS7XX_MSR_DSR_BIT           (1 << 5) /* DSR (IO4)
201                                                   * - only on 75x/76x
202                                                   */
203 #define SC16IS7XX_MSR_RI_BIT            (1 << 6) /* RI (IO7)
204                                                   * - only on 75x/76x
205                                                   */
206 #define SC16IS7XX_MSR_CD_BIT            (1 << 7) /* 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_MODEM_BIT   (1 << 1) /* Enable GPIO[7:4] as modem pins */
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         /*
394          * Don't send zero-length data, at least on SPI it confuses the chip
395          * delivering wrong TXLVL data.
396          */
397         if (unlikely(!to_send))
398                 return;
399
400         regcache_cache_bypass(s->regmap, true);
401         regmap_raw_write(s->regmap, addr, s->buf, to_send);
402         regcache_cache_bypass(s->regmap, false);
403 }
404
405 static void sc16is7xx_port_update(struct uart_port *port, u8 reg,
406                                   u8 mask, u8 val)
407 {
408         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
409         const u8 line = sc16is7xx_line(port);
410
411         regmap_update_bits(s->regmap, (reg << SC16IS7XX_REG_SHIFT) | line,
412                            mask, val);
413 }
414
415 static int sc16is7xx_alloc_line(void)
416 {
417         int i;
418
419         BUILD_BUG_ON(SC16IS7XX_MAX_DEVS > BITS_PER_LONG);
420
421         for (i = 0; i < SC16IS7XX_MAX_DEVS; i++)
422                 if (!test_and_set_bit(i, &sc16is7xx_lines))
423                         break;
424
425         return i;
426 }
427
428 static void sc16is7xx_power(struct uart_port *port, int on)
429 {
430         sc16is7xx_port_update(port, SC16IS7XX_IER_REG,
431                               SC16IS7XX_IER_SLEEP_BIT,
432                               on ? 0 : SC16IS7XX_IER_SLEEP_BIT);
433 }
434
435 static const struct sc16is7xx_devtype sc16is74x_devtype = {
436         .name           = "SC16IS74X",
437         .nr_gpio        = 0,
438         .nr_uart        = 1,
439 };
440
441 static const struct sc16is7xx_devtype sc16is750_devtype = {
442         .name           = "SC16IS750",
443         .nr_gpio        = 8,
444         .nr_uart        = 1,
445 };
446
447 static const struct sc16is7xx_devtype sc16is752_devtype = {
448         .name           = "SC16IS752",
449         .nr_gpio        = 8,
450         .nr_uart        = 2,
451 };
452
453 static const struct sc16is7xx_devtype sc16is760_devtype = {
454         .name           = "SC16IS760",
455         .nr_gpio        = 8,
456         .nr_uart        = 1,
457 };
458
459 static const struct sc16is7xx_devtype sc16is762_devtype = {
460         .name           = "SC16IS762",
461         .nr_gpio        = 8,
462         .nr_uart        = 2,
463 };
464
465 static bool sc16is7xx_regmap_volatile(struct device *dev, unsigned int reg)
466 {
467         switch (reg >> SC16IS7XX_REG_SHIFT) {
468         case SC16IS7XX_RHR_REG:
469         case SC16IS7XX_IIR_REG:
470         case SC16IS7XX_LSR_REG:
471         case SC16IS7XX_MSR_REG:
472         case SC16IS7XX_TXLVL_REG:
473         case SC16IS7XX_RXLVL_REG:
474         case SC16IS7XX_IOSTATE_REG:
475                 return true;
476         default:
477                 break;
478         }
479
480         return false;
481 }
482
483 static bool sc16is7xx_regmap_precious(struct device *dev, unsigned int reg)
484 {
485         switch (reg >> SC16IS7XX_REG_SHIFT) {
486         case SC16IS7XX_RHR_REG:
487                 return true;
488         default:
489                 break;
490         }
491
492         return false;
493 }
494
495 static int sc16is7xx_set_baud(struct uart_port *port, int baud)
496 {
497         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
498         u8 lcr;
499         u8 prescaler = 0;
500         unsigned long clk = port->uartclk, div = clk / 16 / baud;
501
502         if (div > 0xffff) {
503                 prescaler = SC16IS7XX_MCR_CLKSEL_BIT;
504                 div /= 4;
505         }
506
507         /* In an amazing feat of design, the Enhanced Features Register shares
508          * the address of the Interrupt Identification Register, and is
509          * switched in by writing a magic value (0xbf) to the Line Control
510          * Register. Any interrupt firing during this time will see the EFR
511          * where it expects the IIR to be, leading to "Unexpected interrupt"
512          * messages.
513          *
514          * Prevent this possibility by claiming a mutex while accessing the
515          * EFR, and claiming the same mutex from within the interrupt handler.
516          * This is similar to disabling the interrupt, but that doesn't work
517          * because the bulk of the interrupt processing is run as a workqueue
518          * job in thread context.
519          */
520         mutex_lock(&s->efr_lock);
521
522         lcr = sc16is7xx_port_read(port, SC16IS7XX_LCR_REG);
523
524         /* Open the LCR divisors for configuration */
525         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG,
526                              SC16IS7XX_LCR_CONF_MODE_B);
527
528         /* Enable enhanced features */
529         regcache_cache_bypass(s->regmap, true);
530         sc16is7xx_port_write(port, SC16IS7XX_EFR_REG,
531                              SC16IS7XX_EFR_ENABLE_BIT);
532         regcache_cache_bypass(s->regmap, false);
533
534         /* Put LCR back to the normal mode */
535         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, lcr);
536
537         mutex_unlock(&s->efr_lock);
538
539         sc16is7xx_port_update(port, SC16IS7XX_MCR_REG,
540                               SC16IS7XX_MCR_CLKSEL_BIT,
541                               prescaler);
542
543         /* Open the LCR divisors for configuration */
544         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG,
545                              SC16IS7XX_LCR_CONF_MODE_A);
546
547         /* Write the new divisor */
548         regcache_cache_bypass(s->regmap, true);
549         sc16is7xx_port_write(port, SC16IS7XX_DLH_REG, div / 256);
550         sc16is7xx_port_write(port, SC16IS7XX_DLL_REG, div % 256);
551         regcache_cache_bypass(s->regmap, false);
552
553         /* Put LCR back to the normal mode */
554         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, lcr);
555
556         return DIV_ROUND_CLOSEST(clk / 16, div);
557 }
558
559 static void sc16is7xx_handle_rx(struct uart_port *port, unsigned int rxlen,
560                                 unsigned int iir)
561 {
562         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
563         unsigned int lsr = 0, ch, flag, bytes_read, i;
564         bool read_lsr = (iir == SC16IS7XX_IIR_RLSE_SRC) ? true : false;
565
566         if (unlikely(rxlen >= sizeof(s->buf))) {
567                 dev_warn_ratelimited(port->dev,
568                                      "ttySC%i: Possible RX FIFO overrun: %d\n",
569                                      port->line, rxlen);
570                 port->icount.buf_overrun++;
571                 /* Ensure sanity of RX level */
572                 rxlen = sizeof(s->buf);
573         }
574
575         while (rxlen) {
576                 /* Only read lsr if there are possible errors in FIFO */
577                 if (read_lsr) {
578                         lsr = sc16is7xx_port_read(port, SC16IS7XX_LSR_REG);
579                         if (!(lsr & SC16IS7XX_LSR_FIFOE_BIT))
580                                 read_lsr = false; /* No errors left in FIFO */
581                 } else
582                         lsr = 0;
583
584                 if (read_lsr) {
585                         s->buf[0] = sc16is7xx_port_read(port, SC16IS7XX_RHR_REG);
586                         bytes_read = 1;
587                 } else {
588                         sc16is7xx_fifo_read(port, rxlen);
589                         bytes_read = rxlen;
590                 }
591
592                 lsr &= SC16IS7XX_LSR_BRK_ERROR_MASK;
593
594                 port->icount.rx++;
595                 flag = TTY_NORMAL;
596
597                 if (unlikely(lsr)) {
598                         if (lsr & SC16IS7XX_LSR_BI_BIT) {
599                                 port->icount.brk++;
600                                 if (uart_handle_break(port))
601                                         continue;
602                         } else if (lsr & SC16IS7XX_LSR_PE_BIT)
603                                 port->icount.parity++;
604                         else if (lsr & SC16IS7XX_LSR_FE_BIT)
605                                 port->icount.frame++;
606                         else if (lsr & SC16IS7XX_LSR_OE_BIT)
607                                 port->icount.overrun++;
608
609                         lsr &= port->read_status_mask;
610                         if (lsr & SC16IS7XX_LSR_BI_BIT)
611                                 flag = TTY_BREAK;
612                         else if (lsr & SC16IS7XX_LSR_PE_BIT)
613                                 flag = TTY_PARITY;
614                         else if (lsr & SC16IS7XX_LSR_FE_BIT)
615                                 flag = TTY_FRAME;
616                         else if (lsr & SC16IS7XX_LSR_OE_BIT)
617                                 flag = TTY_OVERRUN;
618                 }
619
620                 for (i = 0; i < bytes_read; ++i) {
621                         ch = s->buf[i];
622                         if (uart_handle_sysrq_char(port, ch))
623                                 continue;
624
625                         if (lsr & port->ignore_status_mask)
626                                 continue;
627
628                         uart_insert_char(port, lsr, SC16IS7XX_LSR_OE_BIT, ch,
629                                          flag);
630                 }
631                 rxlen -= bytes_read;
632         }
633
634         tty_flip_buffer_push(&port->state->port);
635 }
636
637 static void sc16is7xx_handle_tx(struct uart_port *port)
638 {
639         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
640         struct circ_buf *xmit = &port->state->xmit;
641         unsigned int txlen, to_send, i;
642
643         if (unlikely(port->x_char)) {
644                 sc16is7xx_port_write(port, SC16IS7XX_THR_REG, port->x_char);
645                 port->icount.tx++;
646                 port->x_char = 0;
647                 return;
648         }
649
650         if (uart_circ_empty(xmit) || uart_tx_stopped(port))
651                 return;
652
653         /* Get length of data pending in circular buffer */
654         to_send = uart_circ_chars_pending(xmit);
655         if (likely(to_send)) {
656                 /* Limit to size of TX FIFO */
657                 txlen = sc16is7xx_port_read(port, SC16IS7XX_TXLVL_REG);
658                 if (txlen > SC16IS7XX_FIFO_SIZE) {
659                         dev_err_ratelimited(port->dev,
660                                 "chip reports %d free bytes in TX fifo, but it only has %d",
661                                 txlen, SC16IS7XX_FIFO_SIZE);
662                         txlen = 0;
663                 }
664                 to_send = (to_send > txlen) ? txlen : to_send;
665
666                 /* Add data to send */
667                 port->icount.tx += to_send;
668
669                 /* Convert to linear buffer */
670                 for (i = 0; i < to_send; ++i) {
671                         s->buf[i] = xmit->buf[xmit->tail];
672                         xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
673                 }
674
675                 sc16is7xx_fifo_write(port, to_send);
676         }
677
678         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
679                 uart_write_wakeup(port);
680 }
681
682 static bool sc16is7xx_port_irq(struct sc16is7xx_port *s, int portno)
683 {
684         struct uart_port *port = &s->p[portno].port;
685
686         do {
687                 unsigned int iir, rxlen;
688
689                 iir = sc16is7xx_port_read(port, SC16IS7XX_IIR_REG);
690                 if (iir & SC16IS7XX_IIR_NO_INT_BIT)
691                         return false;
692
693                 iir &= SC16IS7XX_IIR_ID_MASK;
694
695                 switch (iir) {
696                 case SC16IS7XX_IIR_RDI_SRC:
697                 case SC16IS7XX_IIR_RLSE_SRC:
698                 case SC16IS7XX_IIR_RTOI_SRC:
699                 case SC16IS7XX_IIR_XOFFI_SRC:
700                         rxlen = sc16is7xx_port_read(port, SC16IS7XX_RXLVL_REG);
701                         if (rxlen)
702                                 sc16is7xx_handle_rx(port, rxlen, iir);
703                         break;
704                 case SC16IS7XX_IIR_THRI_SRC:
705                         sc16is7xx_handle_tx(port);
706                         break;
707                 default:
708                         dev_err_ratelimited(port->dev,
709                                             "ttySC%i: Unexpected interrupt: %x",
710                                             port->line, iir);
711                         break;
712                 }
713         } while (0);
714         return true;
715 }
716
717 static void sc16is7xx_ist(struct kthread_work *ws)
718 {
719         struct sc16is7xx_port *s = to_sc16is7xx_port(ws, irq_work);
720
721         mutex_lock(&s->efr_lock);
722
723         while (1) {
724                 bool keep_polling = false;
725                 int i;
726
727                 for (i = 0; i < s->devtype->nr_uart; ++i)
728                         keep_polling |= sc16is7xx_port_irq(s, i);
729                 if (!keep_polling)
730                         break;
731         }
732
733         mutex_unlock(&s->efr_lock);
734 }
735
736 static irqreturn_t sc16is7xx_irq(int irq, void *dev_id)
737 {
738         struct sc16is7xx_port *s = (struct sc16is7xx_port *)dev_id;
739
740         kthread_queue_work(&s->kworker, &s->irq_work);
741
742         return IRQ_HANDLED;
743 }
744
745 static void sc16is7xx_tx_proc(struct kthread_work *ws)
746 {
747         struct uart_port *port = &(to_sc16is7xx_one(ws, tx_work)->port);
748
749         if ((port->rs485.flags & SER_RS485_ENABLED) &&
750             (port->rs485.delay_rts_before_send > 0))
751                 msleep(port->rs485.delay_rts_before_send);
752
753         sc16is7xx_handle_tx(port);
754 }
755
756 static void sc16is7xx_reconf_rs485(struct uart_port *port)
757 {
758         const u32 mask = SC16IS7XX_EFCR_AUTO_RS485_BIT |
759                          SC16IS7XX_EFCR_RTS_INVERT_BIT;
760         u32 efcr = 0;
761         struct serial_rs485 *rs485 = &port->rs485;
762         unsigned long irqflags;
763
764         spin_lock_irqsave(&port->lock, irqflags);
765         if (rs485->flags & SER_RS485_ENABLED) {
766                 efcr |= SC16IS7XX_EFCR_AUTO_RS485_BIT;
767
768                 if (rs485->flags & SER_RS485_RTS_AFTER_SEND)
769                         efcr |= SC16IS7XX_EFCR_RTS_INVERT_BIT;
770         }
771         spin_unlock_irqrestore(&port->lock, irqflags);
772
773         sc16is7xx_port_update(port, SC16IS7XX_EFCR_REG, mask, efcr);
774 }
775
776 static void sc16is7xx_reg_proc(struct kthread_work *ws)
777 {
778         struct sc16is7xx_one *one = to_sc16is7xx_one(ws, reg_work);
779         struct sc16is7xx_one_config config;
780         unsigned long irqflags;
781
782         spin_lock_irqsave(&one->port.lock, irqflags);
783         config = one->config;
784         memset(&one->config, 0, sizeof(one->config));
785         spin_unlock_irqrestore(&one->port.lock, irqflags);
786
787         if (config.flags & SC16IS7XX_RECONF_MD) {
788                 sc16is7xx_port_update(&one->port, SC16IS7XX_MCR_REG,
789                                       SC16IS7XX_MCR_LOOP_BIT,
790                                       (one->port.mctrl & TIOCM_LOOP) ?
791                                       SC16IS7XX_MCR_LOOP_BIT : 0);
792                 sc16is7xx_port_update(&one->port, SC16IS7XX_MCR_REG,
793                                       SC16IS7XX_MCR_RTS_BIT,
794                                       (one->port.mctrl & TIOCM_RTS) ?
795                                       SC16IS7XX_MCR_RTS_BIT : 0);
796                 sc16is7xx_port_update(&one->port, SC16IS7XX_MCR_REG,
797                                       SC16IS7XX_MCR_DTR_BIT,
798                                       (one->port.mctrl & TIOCM_DTR) ?
799                                       SC16IS7XX_MCR_DTR_BIT : 0);
800         }
801         if (config.flags & SC16IS7XX_RECONF_IER)
802                 sc16is7xx_port_update(&one->port, SC16IS7XX_IER_REG,
803                                       config.ier_clear, 0);
804
805         if (config.flags & SC16IS7XX_RECONF_RS485)
806                 sc16is7xx_reconf_rs485(&one->port);
807 }
808
809 static void sc16is7xx_ier_clear(struct uart_port *port, u8 bit)
810 {
811         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
812         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
813
814         one->config.flags |= SC16IS7XX_RECONF_IER;
815         one->config.ier_clear |= bit;
816         kthread_queue_work(&s->kworker, &one->reg_work);
817 }
818
819 static void sc16is7xx_stop_tx(struct uart_port *port)
820 {
821         sc16is7xx_ier_clear(port, SC16IS7XX_IER_THRI_BIT);
822 }
823
824 static void sc16is7xx_stop_rx(struct uart_port *port)
825 {
826         sc16is7xx_ier_clear(port, SC16IS7XX_IER_RDI_BIT);
827 }
828
829 static void sc16is7xx_start_tx(struct uart_port *port)
830 {
831         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
832         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
833
834         kthread_queue_work(&s->kworker, &one->tx_work);
835 }
836
837 static unsigned int sc16is7xx_tx_empty(struct uart_port *port)
838 {
839         unsigned int lsr;
840
841         lsr = sc16is7xx_port_read(port, SC16IS7XX_LSR_REG);
842
843         return (lsr & SC16IS7XX_LSR_TEMT_BIT) ? TIOCSER_TEMT : 0;
844 }
845
846 static unsigned int sc16is7xx_get_mctrl(struct uart_port *port)
847 {
848         /* DCD and DSR are not wired and CTS/RTS is handled automatically
849          * so just indicate DSR and CAR asserted
850          */
851         return TIOCM_DSR | TIOCM_CAR;
852 }
853
854 static void sc16is7xx_set_mctrl(struct uart_port *port, unsigned int mctrl)
855 {
856         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
857         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
858
859         one->config.flags |= SC16IS7XX_RECONF_MD;
860         kthread_queue_work(&s->kworker, &one->reg_work);
861 }
862
863 static void sc16is7xx_break_ctl(struct uart_port *port, int break_state)
864 {
865         sc16is7xx_port_update(port, SC16IS7XX_LCR_REG,
866                               SC16IS7XX_LCR_TXBREAK_BIT,
867                               break_state ? SC16IS7XX_LCR_TXBREAK_BIT : 0);
868 }
869
870 static void sc16is7xx_set_termios(struct uart_port *port,
871                                   struct ktermios *termios,
872                                   struct ktermios *old)
873 {
874         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
875         unsigned int lcr, flow = 0;
876         int baud;
877
878         /* Mask termios capabilities we don't support */
879         termios->c_cflag &= ~CMSPAR;
880
881         /* Word size */
882         switch (termios->c_cflag & CSIZE) {
883         case CS5:
884                 lcr = SC16IS7XX_LCR_WORD_LEN_5;
885                 break;
886         case CS6:
887                 lcr = SC16IS7XX_LCR_WORD_LEN_6;
888                 break;
889         case CS7:
890                 lcr = SC16IS7XX_LCR_WORD_LEN_7;
891                 break;
892         case CS8:
893                 lcr = SC16IS7XX_LCR_WORD_LEN_8;
894                 break;
895         default:
896                 lcr = SC16IS7XX_LCR_WORD_LEN_8;
897                 termios->c_cflag &= ~CSIZE;
898                 termios->c_cflag |= CS8;
899                 break;
900         }
901
902         /* Parity */
903         if (termios->c_cflag & PARENB) {
904                 lcr |= SC16IS7XX_LCR_PARITY_BIT;
905                 if (!(termios->c_cflag & PARODD))
906                         lcr |= SC16IS7XX_LCR_EVENPARITY_BIT;
907         }
908
909         /* Stop bits */
910         if (termios->c_cflag & CSTOPB)
911                 lcr |= SC16IS7XX_LCR_STOPLEN_BIT; /* 2 stops */
912
913         /* Set read status mask */
914         port->read_status_mask = SC16IS7XX_LSR_OE_BIT;
915         if (termios->c_iflag & INPCK)
916                 port->read_status_mask |= SC16IS7XX_LSR_PE_BIT |
917                                           SC16IS7XX_LSR_FE_BIT;
918         if (termios->c_iflag & (BRKINT | PARMRK))
919                 port->read_status_mask |= SC16IS7XX_LSR_BI_BIT;
920
921         /* Set status ignore mask */
922         port->ignore_status_mask = 0;
923         if (termios->c_iflag & IGNBRK)
924                 port->ignore_status_mask |= SC16IS7XX_LSR_BI_BIT;
925         if (!(termios->c_cflag & CREAD))
926                 port->ignore_status_mask |= SC16IS7XX_LSR_BRK_ERROR_MASK;
927
928         /* As above, claim the mutex while accessing the EFR. */
929         mutex_lock(&s->efr_lock);
930
931         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG,
932                              SC16IS7XX_LCR_CONF_MODE_B);
933
934         /* Configure flow control */
935         regcache_cache_bypass(s->regmap, true);
936         sc16is7xx_port_write(port, SC16IS7XX_XON1_REG, termios->c_cc[VSTART]);
937         sc16is7xx_port_write(port, SC16IS7XX_XOFF1_REG, termios->c_cc[VSTOP]);
938         if (termios->c_cflag & CRTSCTS)
939                 flow |= SC16IS7XX_EFR_AUTOCTS_BIT |
940                         SC16IS7XX_EFR_AUTORTS_BIT;
941         if (termios->c_iflag & IXON)
942                 flow |= SC16IS7XX_EFR_SWFLOW3_BIT;
943         if (termios->c_iflag & IXOFF)
944                 flow |= SC16IS7XX_EFR_SWFLOW1_BIT;
945
946         sc16is7xx_port_write(port, SC16IS7XX_EFR_REG, flow);
947         regcache_cache_bypass(s->regmap, false);
948
949         /* Update LCR register */
950         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, lcr);
951
952         mutex_unlock(&s->efr_lock);
953
954         /* Get baud rate generator configuration */
955         baud = uart_get_baud_rate(port, termios, old,
956                                   port->uartclk / 16 / 4 / 0xffff,
957                                   port->uartclk / 16);
958
959         /* Setup baudrate generator */
960         baud = sc16is7xx_set_baud(port, baud);
961
962         /* Update timeout according to new baud rate */
963         uart_update_timeout(port, termios->c_cflag, baud);
964 }
965
966 static int sc16is7xx_config_rs485(struct uart_port *port,
967                                   struct serial_rs485 *rs485)
968 {
969         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
970         struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
971
972         if (rs485->flags & SER_RS485_ENABLED) {
973                 bool rts_during_rx, rts_during_tx;
974
975                 rts_during_rx = rs485->flags & SER_RS485_RTS_AFTER_SEND;
976                 rts_during_tx = rs485->flags & SER_RS485_RTS_ON_SEND;
977
978                 if (rts_during_rx == rts_during_tx)
979                         dev_err(port->dev,
980                                 "unsupported RTS signalling on_send:%d after_send:%d - exactly one of RS485 RTS flags should be set\n",
981                                 rts_during_tx, rts_during_rx);
982
983                 /*
984                  * RTS signal is handled by HW, it's timing can't be influenced.
985                  * However, it's sometimes useful to delay TX even without RTS
986                  * control therefore we try to handle .delay_rts_before_send.
987                  */
988                 if (rs485->delay_rts_after_send)
989                         return -EINVAL;
990         }
991
992         port->rs485 = *rs485;
993         one->config.flags |= SC16IS7XX_RECONF_RS485;
994         kthread_queue_work(&s->kworker, &one->reg_work);
995
996         return 0;
997 }
998
999 static int sc16is7xx_startup(struct uart_port *port)
1000 {
1001         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
1002         unsigned int val;
1003
1004         sc16is7xx_power(port, 1);
1005
1006         /* Reset FIFOs*/
1007         val = SC16IS7XX_FCR_RXRESET_BIT | SC16IS7XX_FCR_TXRESET_BIT;
1008         sc16is7xx_port_write(port, SC16IS7XX_FCR_REG, val);
1009         udelay(5);
1010         sc16is7xx_port_write(port, SC16IS7XX_FCR_REG,
1011                              SC16IS7XX_FCR_FIFO_BIT);
1012
1013         /* Enable EFR */
1014         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG,
1015                              SC16IS7XX_LCR_CONF_MODE_B);
1016
1017         regcache_cache_bypass(s->regmap, true);
1018
1019         /* Enable write access to enhanced features and internal clock div */
1020         sc16is7xx_port_write(port, SC16IS7XX_EFR_REG,
1021                              SC16IS7XX_EFR_ENABLE_BIT);
1022
1023         /* Enable TCR/TLR */
1024         sc16is7xx_port_update(port, SC16IS7XX_MCR_REG,
1025                               SC16IS7XX_MCR_TCRTLR_BIT,
1026                               SC16IS7XX_MCR_TCRTLR_BIT);
1027
1028         /* Configure flow control levels */
1029         /* Flow control halt level 48, resume level 24 */
1030         sc16is7xx_port_write(port, SC16IS7XX_TCR_REG,
1031                              SC16IS7XX_TCR_RX_RESUME(24) |
1032                              SC16IS7XX_TCR_RX_HALT(48));
1033
1034         regcache_cache_bypass(s->regmap, false);
1035
1036         /* Now, initialize the UART */
1037         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, SC16IS7XX_LCR_WORD_LEN_8);
1038
1039         /* Enable the Rx and Tx FIFO */
1040         sc16is7xx_port_update(port, SC16IS7XX_EFCR_REG,
1041                               SC16IS7XX_EFCR_RXDISABLE_BIT |
1042                               SC16IS7XX_EFCR_TXDISABLE_BIT,
1043                               0);
1044
1045         /* Enable RX, TX interrupts */
1046         val = SC16IS7XX_IER_RDI_BIT | SC16IS7XX_IER_THRI_BIT;
1047         sc16is7xx_port_write(port, SC16IS7XX_IER_REG, val);
1048
1049         return 0;
1050 }
1051
1052 static void sc16is7xx_shutdown(struct uart_port *port)
1053 {
1054         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
1055
1056         /* Disable all interrupts */
1057         sc16is7xx_port_write(port, SC16IS7XX_IER_REG, 0);
1058         /* Disable TX/RX */
1059         sc16is7xx_port_update(port, SC16IS7XX_EFCR_REG,
1060                               SC16IS7XX_EFCR_RXDISABLE_BIT |
1061                               SC16IS7XX_EFCR_TXDISABLE_BIT,
1062                               SC16IS7XX_EFCR_RXDISABLE_BIT |
1063                               SC16IS7XX_EFCR_TXDISABLE_BIT);
1064
1065         sc16is7xx_power(port, 0);
1066
1067         kthread_flush_worker(&s->kworker);
1068 }
1069
1070 static const char *sc16is7xx_type(struct uart_port *port)
1071 {
1072         struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
1073
1074         return (port->type == PORT_SC16IS7XX) ? s->devtype->name : NULL;
1075 }
1076
1077 static int sc16is7xx_request_port(struct uart_port *port)
1078 {
1079         /* Do nothing */
1080         return 0;
1081 }
1082
1083 static void sc16is7xx_config_port(struct uart_port *port, int flags)
1084 {
1085         if (flags & UART_CONFIG_TYPE)
1086                 port->type = PORT_SC16IS7XX;
1087 }
1088
1089 static int sc16is7xx_verify_port(struct uart_port *port,
1090                                  struct serial_struct *s)
1091 {
1092         if ((s->type != PORT_UNKNOWN) && (s->type != PORT_SC16IS7XX))
1093                 return -EINVAL;
1094         if (s->irq != port->irq)
1095                 return -EINVAL;
1096
1097         return 0;
1098 }
1099
1100 static void sc16is7xx_pm(struct uart_port *port, unsigned int state,
1101                          unsigned int oldstate)
1102 {
1103         sc16is7xx_power(port, (state == UART_PM_STATE_ON) ? 1 : 0);
1104 }
1105
1106 static void sc16is7xx_null_void(struct uart_port *port)
1107 {
1108         /* Do nothing */
1109 }
1110
1111 static const struct uart_ops sc16is7xx_ops = {
1112         .tx_empty       = sc16is7xx_tx_empty,
1113         .set_mctrl      = sc16is7xx_set_mctrl,
1114         .get_mctrl      = sc16is7xx_get_mctrl,
1115         .stop_tx        = sc16is7xx_stop_tx,
1116         .start_tx       = sc16is7xx_start_tx,
1117         .stop_rx        = sc16is7xx_stop_rx,
1118         .break_ctl      = sc16is7xx_break_ctl,
1119         .startup        = sc16is7xx_startup,
1120         .shutdown       = sc16is7xx_shutdown,
1121         .set_termios    = sc16is7xx_set_termios,
1122         .type           = sc16is7xx_type,
1123         .request_port   = sc16is7xx_request_port,
1124         .release_port   = sc16is7xx_null_void,
1125         .config_port    = sc16is7xx_config_port,
1126         .verify_port    = sc16is7xx_verify_port,
1127         .pm             = sc16is7xx_pm,
1128 };
1129
1130 #ifdef CONFIG_GPIOLIB
1131 static int sc16is7xx_gpio_get(struct gpio_chip *chip, unsigned offset)
1132 {
1133         unsigned int val;
1134         struct sc16is7xx_port *s = gpiochip_get_data(chip);
1135         struct uart_port *port = &s->p[0].port;
1136
1137         val = sc16is7xx_port_read(port, SC16IS7XX_IOSTATE_REG);
1138
1139         return !!(val & BIT(offset));
1140 }
1141
1142 static void sc16is7xx_gpio_set(struct gpio_chip *chip, unsigned offset, int val)
1143 {
1144         struct sc16is7xx_port *s = gpiochip_get_data(chip);
1145         struct uart_port *port = &s->p[0].port;
1146
1147         sc16is7xx_port_update(port, SC16IS7XX_IOSTATE_REG, BIT(offset),
1148                               val ? BIT(offset) : 0);
1149 }
1150
1151 static int sc16is7xx_gpio_direction_input(struct gpio_chip *chip,
1152                                           unsigned offset)
1153 {
1154         struct sc16is7xx_port *s = gpiochip_get_data(chip);
1155         struct uart_port *port = &s->p[0].port;
1156
1157         sc16is7xx_port_update(port, SC16IS7XX_IODIR_REG, BIT(offset), 0);
1158
1159         return 0;
1160 }
1161
1162 static int sc16is7xx_gpio_direction_output(struct gpio_chip *chip,
1163                                            unsigned offset, int val)
1164 {
1165         struct sc16is7xx_port *s = gpiochip_get_data(chip);
1166         struct uart_port *port = &s->p[0].port;
1167         u8 state = sc16is7xx_port_read(port, SC16IS7XX_IOSTATE_REG);
1168
1169         if (val)
1170                 state |= BIT(offset);
1171         else
1172                 state &= ~BIT(offset);
1173         sc16is7xx_port_write(port, SC16IS7XX_IOSTATE_REG, state);
1174         sc16is7xx_port_update(port, SC16IS7XX_IODIR_REG, BIT(offset),
1175                               BIT(offset));
1176
1177         return 0;
1178 }
1179 #endif
1180
1181 static int sc16is7xx_probe(struct device *dev,
1182                            const struct sc16is7xx_devtype *devtype,
1183                            struct regmap *regmap, int irq, unsigned long flags)
1184 {
1185         struct sched_param sched_param = { .sched_priority = MAX_RT_PRIO / 2 };
1186         unsigned long freq, *pfreq = dev_get_platdata(dev);
1187         int i, ret;
1188         struct sc16is7xx_port *s;
1189
1190         if (IS_ERR(regmap))
1191                 return PTR_ERR(regmap);
1192
1193         /* Alloc port structure */
1194         s = devm_kzalloc(dev, sizeof(*s) +
1195                          sizeof(struct sc16is7xx_one) * devtype->nr_uart,
1196                          GFP_KERNEL);
1197         if (!s) {
1198                 dev_err(dev, "Error allocating port structure\n");
1199                 return -ENOMEM;
1200         }
1201
1202         s->clk = devm_clk_get(dev, NULL);
1203         if (IS_ERR(s->clk)) {
1204                 if (pfreq)
1205                         freq = *pfreq;
1206                 else
1207                         return PTR_ERR(s->clk);
1208         } else {
1209                 clk_prepare_enable(s->clk);
1210                 freq = clk_get_rate(s->clk);
1211         }
1212
1213         s->regmap = regmap;
1214         s->devtype = devtype;
1215         dev_set_drvdata(dev, s);
1216         mutex_init(&s->efr_lock);
1217
1218         kthread_init_worker(&s->kworker);
1219         kthread_init_work(&s->irq_work, sc16is7xx_ist);
1220         s->kworker_task = kthread_run(kthread_worker_fn, &s->kworker,
1221                                       "sc16is7xx");
1222         if (IS_ERR(s->kworker_task)) {
1223                 ret = PTR_ERR(s->kworker_task);
1224                 goto out_clk;
1225         }
1226         sched_setscheduler(s->kworker_task, SCHED_FIFO, &sched_param);
1227
1228 #ifdef CONFIG_GPIOLIB
1229         if (devtype->nr_gpio) {
1230                 /* Setup GPIO cotroller */
1231                 s->gpio.owner            = THIS_MODULE;
1232                 s->gpio.parent           = dev;
1233                 s->gpio.label            = dev_name(dev);
1234                 s->gpio.direction_input  = sc16is7xx_gpio_direction_input;
1235                 s->gpio.get              = sc16is7xx_gpio_get;
1236                 s->gpio.direction_output = sc16is7xx_gpio_direction_output;
1237                 s->gpio.set              = sc16is7xx_gpio_set;
1238                 s->gpio.base             = -1;
1239                 s->gpio.ngpio            = devtype->nr_gpio;
1240                 s->gpio.can_sleep        = 1;
1241                 ret = gpiochip_add_data(&s->gpio, s);
1242                 if (ret)
1243                         goto out_thread;
1244         }
1245 #endif
1246
1247         /* reset device, purging any pending irq / data */
1248         regmap_write(s->regmap, SC16IS7XX_IOCONTROL_REG << SC16IS7XX_REG_SHIFT,
1249                         SC16IS7XX_IOCONTROL_SRESET_BIT);
1250
1251         for (i = 0; i < devtype->nr_uart; ++i) {
1252                 s->p[i].line            = i;
1253                 /* Initialize port data */
1254                 s->p[i].port.dev        = dev;
1255                 s->p[i].port.irq        = irq;
1256                 s->p[i].port.type       = PORT_SC16IS7XX;
1257                 s->p[i].port.fifosize   = SC16IS7XX_FIFO_SIZE;
1258                 s->p[i].port.flags      = UPF_FIXED_TYPE | UPF_LOW_LATENCY;
1259                 s->p[i].port.iotype     = UPIO_PORT;
1260                 s->p[i].port.uartclk    = freq;
1261                 s->p[i].port.rs485_config = sc16is7xx_config_rs485;
1262                 s->p[i].port.ops        = &sc16is7xx_ops;
1263                 s->p[i].port.line       = sc16is7xx_alloc_line();
1264                 if (s->p[i].port.line >= SC16IS7XX_MAX_DEVS) {
1265                         ret = -ENOMEM;
1266                         goto out_ports;
1267                 }
1268
1269                 /* Disable all interrupts */
1270                 sc16is7xx_port_write(&s->p[i].port, SC16IS7XX_IER_REG, 0);
1271                 /* Disable TX/RX */
1272                 sc16is7xx_port_write(&s->p[i].port, SC16IS7XX_EFCR_REG,
1273                                      SC16IS7XX_EFCR_RXDISABLE_BIT |
1274                                      SC16IS7XX_EFCR_TXDISABLE_BIT);
1275                 /* Initialize kthread work structs */
1276                 kthread_init_work(&s->p[i].tx_work, sc16is7xx_tx_proc);
1277                 kthread_init_work(&s->p[i].reg_work, sc16is7xx_reg_proc);
1278                 /* Register port */
1279                 uart_add_one_port(&sc16is7xx_uart, &s->p[i].port);
1280
1281                 /* Enable EFR */
1282                 sc16is7xx_port_write(&s->p[i].port, SC16IS7XX_LCR_REG,
1283                                      SC16IS7XX_LCR_CONF_MODE_B);
1284
1285                 regcache_cache_bypass(s->regmap, true);
1286
1287                 /* Enable write access to enhanced features */
1288                 sc16is7xx_port_write(&s->p[i].port, SC16IS7XX_EFR_REG,
1289                                      SC16IS7XX_EFR_ENABLE_BIT);
1290
1291                 regcache_cache_bypass(s->regmap, false);
1292
1293                 /* Restore access to general registers */
1294                 sc16is7xx_port_write(&s->p[i].port, SC16IS7XX_LCR_REG, 0x00);
1295
1296                 /* Go to suspend mode */
1297                 sc16is7xx_power(&s->p[i].port, 0);
1298         }
1299
1300         /* Setup interrupt */
1301         ret = devm_request_irq(dev, irq, sc16is7xx_irq,
1302                                flags, dev_name(dev), s);
1303         if (!ret)
1304                 return 0;
1305
1306 out_ports:
1307         for (i--; i >= 0; i--) {
1308                 uart_remove_one_port(&sc16is7xx_uart, &s->p[i].port);
1309                 clear_bit(s->p[i].port.line, &sc16is7xx_lines);
1310         }
1311
1312 #ifdef CONFIG_GPIOLIB
1313         if (devtype->nr_gpio)
1314                 gpiochip_remove(&s->gpio);
1315
1316 out_thread:
1317 #endif
1318         kthread_stop(s->kworker_task);
1319
1320 out_clk:
1321         if (!IS_ERR(s->clk))
1322                 clk_disable_unprepare(s->clk);
1323
1324         return ret;
1325 }
1326
1327 static int sc16is7xx_remove(struct device *dev)
1328 {
1329         struct sc16is7xx_port *s = dev_get_drvdata(dev);
1330         int i;
1331
1332 #ifdef CONFIG_GPIOLIB
1333         if (s->devtype->nr_gpio)
1334                 gpiochip_remove(&s->gpio);
1335 #endif
1336
1337         for (i = 0; i < s->devtype->nr_uart; i++) {
1338                 uart_remove_one_port(&sc16is7xx_uart, &s->p[i].port);
1339                 clear_bit(s->p[i].port.line, &sc16is7xx_lines);
1340                 sc16is7xx_power(&s->p[i].port, 0);
1341         }
1342
1343         kthread_flush_worker(&s->kworker);
1344         kthread_stop(s->kworker_task);
1345
1346         if (!IS_ERR(s->clk))
1347                 clk_disable_unprepare(s->clk);
1348
1349         return 0;
1350 }
1351
1352 static const struct of_device_id __maybe_unused sc16is7xx_dt_ids[] = {
1353         { .compatible = "nxp,sc16is740",        .data = &sc16is74x_devtype, },
1354         { .compatible = "nxp,sc16is741",        .data = &sc16is74x_devtype, },
1355         { .compatible = "nxp,sc16is750",        .data = &sc16is750_devtype, },
1356         { .compatible = "nxp,sc16is752",        .data = &sc16is752_devtype, },
1357         { .compatible = "nxp,sc16is760",        .data = &sc16is760_devtype, },
1358         { .compatible = "nxp,sc16is762",        .data = &sc16is762_devtype, },
1359         { }
1360 };
1361 MODULE_DEVICE_TABLE(of, sc16is7xx_dt_ids);
1362
1363 static struct regmap_config regcfg = {
1364         .reg_bits = 7,
1365         .pad_bits = 1,
1366         .val_bits = 8,
1367         .cache_type = REGCACHE_RBTREE,
1368         .volatile_reg = sc16is7xx_regmap_volatile,
1369         .precious_reg = sc16is7xx_regmap_precious,
1370 };
1371
1372 #ifdef CONFIG_SERIAL_SC16IS7XX_SPI
1373 static int sc16is7xx_spi_probe(struct spi_device *spi)
1374 {
1375         const struct sc16is7xx_devtype *devtype;
1376         unsigned long flags = 0;
1377         struct regmap *regmap;
1378         int ret;
1379
1380         /* Setup SPI bus */
1381         spi->bits_per_word      = 8;
1382         /* only supports mode 0 on SC16IS762 */
1383         spi->mode               = spi->mode ? : SPI_MODE_0;
1384         spi->max_speed_hz       = spi->max_speed_hz ? : 15000000;
1385         ret = spi_setup(spi);
1386         if (ret)
1387                 return ret;
1388
1389         if (spi->dev.of_node) {
1390                 const struct of_device_id *of_id =
1391                         of_match_device(sc16is7xx_dt_ids, &spi->dev);
1392
1393                 if (!of_id)
1394                         return -ENODEV;
1395
1396                 devtype = (struct sc16is7xx_devtype *)of_id->data;
1397         } else {
1398                 const struct spi_device_id *id_entry = spi_get_device_id(spi);
1399
1400                 devtype = (struct sc16is7xx_devtype *)id_entry->driver_data;
1401                 flags = IRQF_TRIGGER_FALLING;
1402         }
1403
1404         regcfg.max_register = (0xf << SC16IS7XX_REG_SHIFT) |
1405                               (devtype->nr_uart - 1);
1406         regmap = devm_regmap_init_spi(spi, &regcfg);
1407
1408         return sc16is7xx_probe(&spi->dev, devtype, regmap, spi->irq, flags);
1409 }
1410
1411 static int sc16is7xx_spi_remove(struct spi_device *spi)
1412 {
1413         return sc16is7xx_remove(&spi->dev);
1414 }
1415
1416 static const struct spi_device_id sc16is7xx_spi_id_table[] = {
1417         { "sc16is74x",  (kernel_ulong_t)&sc16is74x_devtype, },
1418         { "sc16is740",  (kernel_ulong_t)&sc16is74x_devtype, },
1419         { "sc16is741",  (kernel_ulong_t)&sc16is74x_devtype, },
1420         { "sc16is750",  (kernel_ulong_t)&sc16is750_devtype, },
1421         { "sc16is752",  (kernel_ulong_t)&sc16is752_devtype, },
1422         { "sc16is760",  (kernel_ulong_t)&sc16is760_devtype, },
1423         { "sc16is762",  (kernel_ulong_t)&sc16is762_devtype, },
1424         { }
1425 };
1426
1427 MODULE_DEVICE_TABLE(spi, sc16is7xx_spi_id_table);
1428
1429 static struct spi_driver sc16is7xx_spi_uart_driver = {
1430         .driver = {
1431                 .name           = SC16IS7XX_NAME,
1432                 .of_match_table = of_match_ptr(sc16is7xx_dt_ids),
1433         },
1434         .probe          = sc16is7xx_spi_probe,
1435         .remove         = sc16is7xx_spi_remove,
1436         .id_table       = sc16is7xx_spi_id_table,
1437 };
1438
1439 MODULE_ALIAS("spi:sc16is7xx");
1440 #endif
1441
1442 #ifdef CONFIG_SERIAL_SC16IS7XX_I2C
1443 static int sc16is7xx_i2c_probe(struct i2c_client *i2c,
1444                                const struct i2c_device_id *id)
1445 {
1446         const struct sc16is7xx_devtype *devtype;
1447         unsigned long flags = 0;
1448         struct regmap *regmap;
1449
1450         if (i2c->dev.of_node) {
1451                 const struct of_device_id *of_id =
1452                                 of_match_device(sc16is7xx_dt_ids, &i2c->dev);
1453
1454                 if (!of_id)
1455                         return -ENODEV;
1456
1457                 devtype = (struct sc16is7xx_devtype *)of_id->data;
1458         } else {
1459                 devtype = (struct sc16is7xx_devtype *)id->driver_data;
1460                 flags = IRQF_TRIGGER_FALLING;
1461         }
1462
1463         regcfg.max_register = (0xf << SC16IS7XX_REG_SHIFT) |
1464                               (devtype->nr_uart - 1);
1465         regmap = devm_regmap_init_i2c(i2c, &regcfg);
1466
1467         return sc16is7xx_probe(&i2c->dev, devtype, regmap, i2c->irq, flags);
1468 }
1469
1470 static int sc16is7xx_i2c_remove(struct i2c_client *client)
1471 {
1472         return sc16is7xx_remove(&client->dev);
1473 }
1474
1475 static const struct i2c_device_id sc16is7xx_i2c_id_table[] = {
1476         { "sc16is74x",  (kernel_ulong_t)&sc16is74x_devtype, },
1477         { "sc16is740",  (kernel_ulong_t)&sc16is74x_devtype, },
1478         { "sc16is741",  (kernel_ulong_t)&sc16is74x_devtype, },
1479         { "sc16is750",  (kernel_ulong_t)&sc16is750_devtype, },
1480         { "sc16is752",  (kernel_ulong_t)&sc16is752_devtype, },
1481         { "sc16is760",  (kernel_ulong_t)&sc16is760_devtype, },
1482         { "sc16is762",  (kernel_ulong_t)&sc16is762_devtype, },
1483         { }
1484 };
1485 MODULE_DEVICE_TABLE(i2c, sc16is7xx_i2c_id_table);
1486
1487 static struct i2c_driver sc16is7xx_i2c_uart_driver = {
1488         .driver = {
1489                 .name           = SC16IS7XX_NAME,
1490                 .of_match_table = of_match_ptr(sc16is7xx_dt_ids),
1491         },
1492         .probe          = sc16is7xx_i2c_probe,
1493         .remove         = sc16is7xx_i2c_remove,
1494         .id_table       = sc16is7xx_i2c_id_table,
1495 };
1496
1497 #endif
1498
1499 static int __init sc16is7xx_init(void)
1500 {
1501         int ret;
1502
1503         ret = uart_register_driver(&sc16is7xx_uart);
1504         if (ret) {
1505                 pr_err("Registering UART driver failed\n");
1506                 return ret;
1507         }
1508
1509 #ifdef CONFIG_SERIAL_SC16IS7XX_I2C
1510         ret = i2c_add_driver(&sc16is7xx_i2c_uart_driver);
1511         if (ret < 0) {
1512                 pr_err("failed to init sc16is7xx i2c --> %d\n", ret);
1513                 goto err_i2c;
1514         }
1515 #endif
1516
1517 #ifdef CONFIG_SERIAL_SC16IS7XX_SPI
1518         ret = spi_register_driver(&sc16is7xx_spi_uart_driver);
1519         if (ret < 0) {
1520                 pr_err("failed to init sc16is7xx spi --> %d\n", ret);
1521                 goto err_spi;
1522         }
1523 #endif
1524         return ret;
1525
1526 #ifdef CONFIG_SERIAL_SC16IS7XX_SPI
1527 err_spi:
1528 #ifdef CONFIG_SERIAL_SC16IS7XX_I2C
1529         i2c_del_driver(&sc16is7xx_i2c_uart_driver);
1530 #endif
1531 #endif
1532 err_i2c:
1533         uart_unregister_driver(&sc16is7xx_uart);
1534         return ret;
1535 }
1536 module_init(sc16is7xx_init);
1537
1538 static void __exit sc16is7xx_exit(void)
1539 {
1540 #ifdef CONFIG_SERIAL_SC16IS7XX_I2C
1541         i2c_del_driver(&sc16is7xx_i2c_uart_driver);
1542 #endif
1543
1544 #ifdef CONFIG_SERIAL_SC16IS7XX_SPI
1545         spi_unregister_driver(&sc16is7xx_spi_uart_driver);
1546 #endif
1547         uart_unregister_driver(&sc16is7xx_uart);
1548 }
1549 module_exit(sc16is7xx_exit);
1550
1551 MODULE_LICENSE("GPL");
1552 MODULE_AUTHOR("Jon Ringle <jringle@gridpoint.com>");
1553 MODULE_DESCRIPTION("SC16IS7XX serial driver");