GNU Linux-libre 4.14.266-gnu1
[releases.git] / drivers / tty / serial / sh-sci.c
1 /*
2  * SuperH on-chip serial module support.  (SCI with no FIFO / with FIFO)
3  *
4  *  Copyright (C) 2002 - 2011  Paul Mundt
5  *  Copyright (C) 2015 Glider bvba
6  *  Modified to support SH7720 SCIF. Markus Brunner, Mark Jonas (Jul 2007).
7  *
8  * based off of the old drivers/char/sh-sci.c by:
9  *
10  *   Copyright (C) 1999, 2000  Niibe Yutaka
11  *   Copyright (C) 2000  Sugioka Toshinobu
12  *   Modified to support multiple serial ports. Stuart Menefy (May 2000).
13  *   Modified to support SecureEdge. David McCullough (2002)
14  *   Modified to support SH7300 SCIF. Takashi Kusuda (Jun 2003).
15  *   Removed SH7300 support (Jul 2007).
16  *
17  * This file is subject to the terms and conditions of the GNU General Public
18  * License.  See the file "COPYING" in the main directory of this archive
19  * for more details.
20  */
21 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
22 #define SUPPORT_SYSRQ
23 #endif
24
25 #undef DEBUG
26
27 #include <linux/clk.h>
28 #include <linux/console.h>
29 #include <linux/ctype.h>
30 #include <linux/cpufreq.h>
31 #include <linux/delay.h>
32 #include <linux/dmaengine.h>
33 #include <linux/dma-mapping.h>
34 #include <linux/err.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/interrupt.h>
38 #include <linux/ioport.h>
39 #include <linux/major.h>
40 #include <linux/module.h>
41 #include <linux/mm.h>
42 #include <linux/of.h>
43 #include <linux/platform_device.h>
44 #include <linux/pm_runtime.h>
45 #include <linux/scatterlist.h>
46 #include <linux/serial.h>
47 #include <linux/serial_sci.h>
48 #include <linux/sh_dma.h>
49 #include <linux/slab.h>
50 #include <linux/string.h>
51 #include <linux/sysrq.h>
52 #include <linux/timer.h>
53 #include <linux/tty.h>
54 #include <linux/tty_flip.h>
55
56 #ifdef CONFIG_SUPERH
57 #include <asm/sh_bios.h>
58 #endif
59
60 #include "serial_mctrl_gpio.h"
61 #include "sh-sci.h"
62
63 /* Offsets into the sci_port->irqs array */
64 enum {
65         SCIx_ERI_IRQ,
66         SCIx_RXI_IRQ,
67         SCIx_TXI_IRQ,
68         SCIx_BRI_IRQ,
69         SCIx_NR_IRQS,
70
71         SCIx_MUX_IRQ = SCIx_NR_IRQS,    /* special case */
72 };
73
74 #define SCIx_IRQ_IS_MUXED(port)                 \
75         ((port)->irqs[SCIx_ERI_IRQ] ==  \
76          (port)->irqs[SCIx_RXI_IRQ]) || \
77         ((port)->irqs[SCIx_ERI_IRQ] &&  \
78          ((port)->irqs[SCIx_RXI_IRQ] < 0))
79
80 enum SCI_CLKS {
81         SCI_FCK,                /* Functional Clock */
82         SCI_SCK,                /* Optional External Clock */
83         SCI_BRG_INT,            /* Optional BRG Internal Clock Source */
84         SCI_SCIF_CLK,           /* Optional BRG External Clock Source */
85         SCI_NUM_CLKS
86 };
87
88 /* Bit x set means sampling rate x + 1 is supported */
89 #define SCI_SR(x)               BIT((x) - 1)
90 #define SCI_SR_RANGE(x, y)      GENMASK((y) - 1, (x) - 1)
91
92 #define SCI_SR_SCIFAB           SCI_SR(5) | SCI_SR(7) | SCI_SR(11) | \
93                                 SCI_SR(13) | SCI_SR(16) | SCI_SR(17) | \
94                                 SCI_SR(19) | SCI_SR(27)
95
96 #define min_sr(_port)           ffs((_port)->sampling_rate_mask)
97 #define max_sr(_port)           fls((_port)->sampling_rate_mask)
98
99 /* Iterate over all supported sampling rates, from high to low */
100 #define for_each_sr(_sr, _port)                                         \
101         for ((_sr) = max_sr(_port); (_sr) >= min_sr(_port); (_sr)--)    \
102                 if ((_port)->sampling_rate_mask & SCI_SR((_sr)))
103
104 struct plat_sci_reg {
105         u8 offset, size;
106 };
107
108 struct sci_port_params {
109         const struct plat_sci_reg regs[SCIx_NR_REGS];
110         unsigned int fifosize;
111         unsigned int overrun_reg;
112         unsigned int overrun_mask;
113         unsigned int sampling_rate_mask;
114         unsigned int error_mask;
115         unsigned int error_clear;
116 };
117
118 struct sci_port {
119         struct uart_port        port;
120
121         /* Platform configuration */
122         const struct sci_port_params *params;
123         const struct plat_sci_port *cfg;
124         unsigned int            sampling_rate_mask;
125         resource_size_t         reg_size;
126         struct mctrl_gpios      *gpios;
127
128         /* Clocks */
129         struct clk              *clks[SCI_NUM_CLKS];
130         unsigned long           clk_rates[SCI_NUM_CLKS];
131
132         int                     irqs[SCIx_NR_IRQS];
133         char                    *irqstr[SCIx_NR_IRQS];
134
135         struct dma_chan                 *chan_tx;
136         struct dma_chan                 *chan_rx;
137
138 #ifdef CONFIG_SERIAL_SH_SCI_DMA
139         dma_cookie_t                    cookie_tx;
140         dma_cookie_t                    cookie_rx[2];
141         dma_cookie_t                    active_rx;
142         dma_addr_t                      tx_dma_addr;
143         unsigned int                    tx_dma_len;
144         struct scatterlist              sg_rx[2];
145         void                            *rx_buf[2];
146         size_t                          buf_len_rx;
147         struct work_struct              work_tx;
148         struct timer_list               rx_timer;
149         unsigned int                    rx_timeout;
150 #endif
151         unsigned int                    rx_frame;
152         int                             rx_trigger;
153         struct timer_list               rx_fifo_timer;
154         int                             rx_fifo_timeout;
155
156         bool has_rtscts;
157         bool autorts;
158 };
159
160 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
161
162 static struct sci_port sci_ports[SCI_NPORTS];
163 static struct uart_driver sci_uart_driver;
164
165 static inline struct sci_port *
166 to_sci_port(struct uart_port *uart)
167 {
168         return container_of(uart, struct sci_port, port);
169 }
170
171 static const struct sci_port_params sci_port_params[SCIx_NR_REGTYPES] = {
172         /*
173          * Common SCI definitions, dependent on the port's regshift
174          * value.
175          */
176         [SCIx_SCI_REGTYPE] = {
177                 .regs = {
178                         [SCSMR]         = { 0x00,  8 },
179                         [SCBRR]         = { 0x01,  8 },
180                         [SCSCR]         = { 0x02,  8 },
181                         [SCxTDR]        = { 0x03,  8 },
182                         [SCxSR]         = { 0x04,  8 },
183                         [SCxRDR]        = { 0x05,  8 },
184                 },
185                 .fifosize = 1,
186                 .overrun_reg = SCxSR,
187                 .overrun_mask = SCI_ORER,
188                 .sampling_rate_mask = SCI_SR(32),
189                 .error_mask = SCI_DEFAULT_ERROR_MASK | SCI_ORER,
190                 .error_clear = SCI_ERROR_CLEAR & ~SCI_ORER,
191         },
192
193         /*
194          * Common definitions for legacy IrDA ports.
195          */
196         [SCIx_IRDA_REGTYPE] = {
197                 .regs = {
198                         [SCSMR]         = { 0x00,  8 },
199                         [SCBRR]         = { 0x02,  8 },
200                         [SCSCR]         = { 0x04,  8 },
201                         [SCxTDR]        = { 0x06,  8 },
202                         [SCxSR]         = { 0x08, 16 },
203                         [SCxRDR]        = { 0x0a,  8 },
204                         [SCFCR]         = { 0x0c,  8 },
205                         [SCFDR]         = { 0x0e, 16 },
206                 },
207                 .fifosize = 1,
208                 .overrun_reg = SCxSR,
209                 .overrun_mask = SCI_ORER,
210                 .sampling_rate_mask = SCI_SR(32),
211                 .error_mask = SCI_DEFAULT_ERROR_MASK | SCI_ORER,
212                 .error_clear = SCI_ERROR_CLEAR & ~SCI_ORER,
213         },
214
215         /*
216          * Common SCIFA definitions.
217          */
218         [SCIx_SCIFA_REGTYPE] = {
219                 .regs = {
220                         [SCSMR]         = { 0x00, 16 },
221                         [SCBRR]         = { 0x04,  8 },
222                         [SCSCR]         = { 0x08, 16 },
223                         [SCxTDR]        = { 0x20,  8 },
224                         [SCxSR]         = { 0x14, 16 },
225                         [SCxRDR]        = { 0x24,  8 },
226                         [SCFCR]         = { 0x18, 16 },
227                         [SCFDR]         = { 0x1c, 16 },
228                         [SCPCR]         = { 0x30, 16 },
229                         [SCPDR]         = { 0x34, 16 },
230                 },
231                 .fifosize = 64,
232                 .overrun_reg = SCxSR,
233                 .overrun_mask = SCIFA_ORER,
234                 .sampling_rate_mask = SCI_SR_SCIFAB,
235                 .error_mask = SCIF_DEFAULT_ERROR_MASK | SCIFA_ORER,
236                 .error_clear = SCIF_ERROR_CLEAR & ~SCIFA_ORER,
237         },
238
239         /*
240          * Common SCIFB definitions.
241          */
242         [SCIx_SCIFB_REGTYPE] = {
243                 .regs = {
244                         [SCSMR]         = { 0x00, 16 },
245                         [SCBRR]         = { 0x04,  8 },
246                         [SCSCR]         = { 0x08, 16 },
247                         [SCxTDR]        = { 0x40,  8 },
248                         [SCxSR]         = { 0x14, 16 },
249                         [SCxRDR]        = { 0x60,  8 },
250                         [SCFCR]         = { 0x18, 16 },
251                         [SCTFDR]        = { 0x38, 16 },
252                         [SCRFDR]        = { 0x3c, 16 },
253                         [SCPCR]         = { 0x30, 16 },
254                         [SCPDR]         = { 0x34, 16 },
255                 },
256                 .fifosize = 256,
257                 .overrun_reg = SCxSR,
258                 .overrun_mask = SCIFA_ORER,
259                 .sampling_rate_mask = SCI_SR_SCIFAB,
260                 .error_mask = SCIF_DEFAULT_ERROR_MASK | SCIFA_ORER,
261                 .error_clear = SCIF_ERROR_CLEAR & ~SCIFA_ORER,
262         },
263
264         /*
265          * Common SH-2(A) SCIF definitions for ports with FIFO data
266          * count registers.
267          */
268         [SCIx_SH2_SCIF_FIFODATA_REGTYPE] = {
269                 .regs = {
270                         [SCSMR]         = { 0x00, 16 },
271                         [SCBRR]         = { 0x04,  8 },
272                         [SCSCR]         = { 0x08, 16 },
273                         [SCxTDR]        = { 0x0c,  8 },
274                         [SCxSR]         = { 0x10, 16 },
275                         [SCxRDR]        = { 0x14,  8 },
276                         [SCFCR]         = { 0x18, 16 },
277                         [SCFDR]         = { 0x1c, 16 },
278                         [SCSPTR]        = { 0x20, 16 },
279                         [SCLSR]         = { 0x24, 16 },
280                 },
281                 .fifosize = 16,
282                 .overrun_reg = SCLSR,
283                 .overrun_mask = SCLSR_ORER,
284                 .sampling_rate_mask = SCI_SR(32),
285                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
286                 .error_clear = SCIF_ERROR_CLEAR,
287         },
288
289         /*
290          * Common SH-3 SCIF definitions.
291          */
292         [SCIx_SH3_SCIF_REGTYPE] = {
293                 .regs = {
294                         [SCSMR]         = { 0x00,  8 },
295                         [SCBRR]         = { 0x02,  8 },
296                         [SCSCR]         = { 0x04,  8 },
297                         [SCxTDR]        = { 0x06,  8 },
298                         [SCxSR]         = { 0x08, 16 },
299                         [SCxRDR]        = { 0x0a,  8 },
300                         [SCFCR]         = { 0x0c,  8 },
301                         [SCFDR]         = { 0x0e, 16 },
302                 },
303                 .fifosize = 16,
304                 .overrun_reg = SCLSR,
305                 .overrun_mask = SCLSR_ORER,
306                 .sampling_rate_mask = SCI_SR(32),
307                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
308                 .error_clear = SCIF_ERROR_CLEAR,
309         },
310
311         /*
312          * Common SH-4(A) SCIF(B) definitions.
313          */
314         [SCIx_SH4_SCIF_REGTYPE] = {
315                 .regs = {
316                         [SCSMR]         = { 0x00, 16 },
317                         [SCBRR]         = { 0x04,  8 },
318                         [SCSCR]         = { 0x08, 16 },
319                         [SCxTDR]        = { 0x0c,  8 },
320                         [SCxSR]         = { 0x10, 16 },
321                         [SCxRDR]        = { 0x14,  8 },
322                         [SCFCR]         = { 0x18, 16 },
323                         [SCFDR]         = { 0x1c, 16 },
324                         [SCSPTR]        = { 0x20, 16 },
325                         [SCLSR]         = { 0x24, 16 },
326                 },
327                 .fifosize = 16,
328                 .overrun_reg = SCLSR,
329                 .overrun_mask = SCLSR_ORER,
330                 .sampling_rate_mask = SCI_SR(32),
331                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
332                 .error_clear = SCIF_ERROR_CLEAR,
333         },
334
335         /*
336          * Common SCIF definitions for ports with a Baud Rate Generator for
337          * External Clock (BRG).
338          */
339         [SCIx_SH4_SCIF_BRG_REGTYPE] = {
340                 .regs = {
341                         [SCSMR]         = { 0x00, 16 },
342                         [SCBRR]         = { 0x04,  8 },
343                         [SCSCR]         = { 0x08, 16 },
344                         [SCxTDR]        = { 0x0c,  8 },
345                         [SCxSR]         = { 0x10, 16 },
346                         [SCxRDR]        = { 0x14,  8 },
347                         [SCFCR]         = { 0x18, 16 },
348                         [SCFDR]         = { 0x1c, 16 },
349                         [SCSPTR]        = { 0x20, 16 },
350                         [SCLSR]         = { 0x24, 16 },
351                         [SCDL]          = { 0x30, 16 },
352                         [SCCKS]         = { 0x34, 16 },
353                 },
354                 .fifosize = 16,
355                 .overrun_reg = SCLSR,
356                 .overrun_mask = SCLSR_ORER,
357                 .sampling_rate_mask = SCI_SR(32),
358                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
359                 .error_clear = SCIF_ERROR_CLEAR,
360         },
361
362         /*
363          * Common HSCIF definitions.
364          */
365         [SCIx_HSCIF_REGTYPE] = {
366                 .regs = {
367                         [SCSMR]         = { 0x00, 16 },
368                         [SCBRR]         = { 0x04,  8 },
369                         [SCSCR]         = { 0x08, 16 },
370                         [SCxTDR]        = { 0x0c,  8 },
371                         [SCxSR]         = { 0x10, 16 },
372                         [SCxRDR]        = { 0x14,  8 },
373                         [SCFCR]         = { 0x18, 16 },
374                         [SCFDR]         = { 0x1c, 16 },
375                         [SCSPTR]        = { 0x20, 16 },
376                         [SCLSR]         = { 0x24, 16 },
377                         [HSSRR]         = { 0x40, 16 },
378                         [SCDL]          = { 0x30, 16 },
379                         [SCCKS]         = { 0x34, 16 },
380                         [HSRTRGR]       = { 0x54, 16 },
381                         [HSTTRGR]       = { 0x58, 16 },
382                 },
383                 .fifosize = 128,
384                 .overrun_reg = SCLSR,
385                 .overrun_mask = SCLSR_ORER,
386                 .sampling_rate_mask = SCI_SR_RANGE(8, 32),
387                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
388                 .error_clear = SCIF_ERROR_CLEAR,
389         },
390
391         /*
392          * Common SH-4(A) SCIF(B) definitions for ports without an SCSPTR
393          * register.
394          */
395         [SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE] = {
396                 .regs = {
397                         [SCSMR]         = { 0x00, 16 },
398                         [SCBRR]         = { 0x04,  8 },
399                         [SCSCR]         = { 0x08, 16 },
400                         [SCxTDR]        = { 0x0c,  8 },
401                         [SCxSR]         = { 0x10, 16 },
402                         [SCxRDR]        = { 0x14,  8 },
403                         [SCFCR]         = { 0x18, 16 },
404                         [SCFDR]         = { 0x1c, 16 },
405                         [SCLSR]         = { 0x24, 16 },
406                 },
407                 .fifosize = 16,
408                 .overrun_reg = SCLSR,
409                 .overrun_mask = SCLSR_ORER,
410                 .sampling_rate_mask = SCI_SR(32),
411                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
412                 .error_clear = SCIF_ERROR_CLEAR,
413         },
414
415         /*
416          * Common SH-4(A) SCIF(B) definitions for ports with FIFO data
417          * count registers.
418          */
419         [SCIx_SH4_SCIF_FIFODATA_REGTYPE] = {
420                 .regs = {
421                         [SCSMR]         = { 0x00, 16 },
422                         [SCBRR]         = { 0x04,  8 },
423                         [SCSCR]         = { 0x08, 16 },
424                         [SCxTDR]        = { 0x0c,  8 },
425                         [SCxSR]         = { 0x10, 16 },
426                         [SCxRDR]        = { 0x14,  8 },
427                         [SCFCR]         = { 0x18, 16 },
428                         [SCFDR]         = { 0x1c, 16 },
429                         [SCTFDR]        = { 0x1c, 16 }, /* aliased to SCFDR */
430                         [SCRFDR]        = { 0x20, 16 },
431                         [SCSPTR]        = { 0x24, 16 },
432                         [SCLSR]         = { 0x28, 16 },
433                 },
434                 .fifosize = 16,
435                 .overrun_reg = SCLSR,
436                 .overrun_mask = SCLSR_ORER,
437                 .sampling_rate_mask = SCI_SR(32),
438                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
439                 .error_clear = SCIF_ERROR_CLEAR,
440         },
441
442         /*
443          * SH7705-style SCIF(B) ports, lacking both SCSPTR and SCLSR
444          * registers.
445          */
446         [SCIx_SH7705_SCIF_REGTYPE] = {
447                 .regs = {
448                         [SCSMR]         = { 0x00, 16 },
449                         [SCBRR]         = { 0x04,  8 },
450                         [SCSCR]         = { 0x08, 16 },
451                         [SCxTDR]        = { 0x20,  8 },
452                         [SCxSR]         = { 0x14, 16 },
453                         [SCxRDR]        = { 0x24,  8 },
454                         [SCFCR]         = { 0x18, 16 },
455                         [SCFDR]         = { 0x1c, 16 },
456                 },
457                 .fifosize = 64,
458                 .overrun_reg = SCxSR,
459                 .overrun_mask = SCIFA_ORER,
460                 .sampling_rate_mask = SCI_SR(16),
461                 .error_mask = SCIF_DEFAULT_ERROR_MASK | SCIFA_ORER,
462                 .error_clear = SCIF_ERROR_CLEAR & ~SCIFA_ORER,
463         },
464 };
465
466 #define sci_getreg(up, offset)          (&to_sci_port(up)->params->regs[offset])
467
468 /*
469  * The "offset" here is rather misleading, in that it refers to an enum
470  * value relative to the port mapping rather than the fixed offset
471  * itself, which needs to be manually retrieved from the platform's
472  * register map for the given port.
473  */
474 static unsigned int sci_serial_in(struct uart_port *p, int offset)
475 {
476         const struct plat_sci_reg *reg = sci_getreg(p, offset);
477
478         if (reg->size == 8)
479                 return ioread8(p->membase + (reg->offset << p->regshift));
480         else if (reg->size == 16)
481                 return ioread16(p->membase + (reg->offset << p->regshift));
482         else
483                 WARN(1, "Invalid register access\n");
484
485         return 0;
486 }
487
488 static void sci_serial_out(struct uart_port *p, int offset, int value)
489 {
490         const struct plat_sci_reg *reg = sci_getreg(p, offset);
491
492         if (reg->size == 8)
493                 iowrite8(value, p->membase + (reg->offset << p->regshift));
494         else if (reg->size == 16)
495                 iowrite16(value, p->membase + (reg->offset << p->regshift));
496         else
497                 WARN(1, "Invalid register access\n");
498 }
499
500 static void sci_port_enable(struct sci_port *sci_port)
501 {
502         unsigned int i;
503
504         if (!sci_port->port.dev)
505                 return;
506
507         pm_runtime_get_sync(sci_port->port.dev);
508
509         for (i = 0; i < SCI_NUM_CLKS; i++) {
510                 clk_prepare_enable(sci_port->clks[i]);
511                 sci_port->clk_rates[i] = clk_get_rate(sci_port->clks[i]);
512         }
513         sci_port->port.uartclk = sci_port->clk_rates[SCI_FCK];
514 }
515
516 static void sci_port_disable(struct sci_port *sci_port)
517 {
518         unsigned int i;
519
520         if (!sci_port->port.dev)
521                 return;
522
523         for (i = SCI_NUM_CLKS; i-- > 0; )
524                 clk_disable_unprepare(sci_port->clks[i]);
525
526         pm_runtime_put_sync(sci_port->port.dev);
527 }
528
529 static inline unsigned long port_rx_irq_mask(struct uart_port *port)
530 {
531         /*
532          * Not all ports (such as SCIFA) will support REIE. Rather than
533          * special-casing the port type, we check the port initialization
534          * IRQ enable mask to see whether the IRQ is desired at all. If
535          * it's unset, it's logically inferred that there's no point in
536          * testing for it.
537          */
538         return SCSCR_RIE | (to_sci_port(port)->cfg->scscr & SCSCR_REIE);
539 }
540
541 static void sci_start_tx(struct uart_port *port)
542 {
543         struct sci_port *s = to_sci_port(port);
544         unsigned short ctrl;
545
546 #ifdef CONFIG_SERIAL_SH_SCI_DMA
547         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
548                 u16 new, scr = serial_port_in(port, SCSCR);
549                 if (s->chan_tx)
550                         new = scr | SCSCR_TDRQE;
551                 else
552                         new = scr & ~SCSCR_TDRQE;
553                 if (new != scr)
554                         serial_port_out(port, SCSCR, new);
555         }
556
557         if (s->chan_tx && !uart_circ_empty(&s->port.state->xmit) &&
558             dma_submit_error(s->cookie_tx)) {
559                 s->cookie_tx = 0;
560                 schedule_work(&s->work_tx);
561         }
562 #endif
563
564         if (!s->chan_tx || port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
565                 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
566                 ctrl = serial_port_in(port, SCSCR);
567                 serial_port_out(port, SCSCR, ctrl | SCSCR_TIE);
568         }
569 }
570
571 static void sci_stop_tx(struct uart_port *port)
572 {
573         unsigned short ctrl;
574
575         /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
576         ctrl = serial_port_in(port, SCSCR);
577
578         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
579                 ctrl &= ~SCSCR_TDRQE;
580
581         ctrl &= ~SCSCR_TIE;
582
583         serial_port_out(port, SCSCR, ctrl);
584
585 #ifdef CONFIG_SERIAL_SH_SCI_DMA
586         if (to_sci_port(port)->chan_tx &&
587             !dma_submit_error(to_sci_port(port)->cookie_tx)) {
588                 dmaengine_terminate_async(to_sci_port(port)->chan_tx);
589                 to_sci_port(port)->cookie_tx = -EINVAL;
590         }
591 #endif
592 }
593
594 static void sci_start_rx(struct uart_port *port)
595 {
596         unsigned short ctrl;
597
598         ctrl = serial_port_in(port, SCSCR) | port_rx_irq_mask(port);
599
600         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
601                 ctrl &= ~SCSCR_RDRQE;
602
603         serial_port_out(port, SCSCR, ctrl);
604 }
605
606 static void sci_stop_rx(struct uart_port *port)
607 {
608         unsigned short ctrl;
609
610         ctrl = serial_port_in(port, SCSCR);
611
612         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
613                 ctrl &= ~SCSCR_RDRQE;
614
615         ctrl &= ~port_rx_irq_mask(port);
616
617         serial_port_out(port, SCSCR, ctrl);
618 }
619
620 static void sci_clear_SCxSR(struct uart_port *port, unsigned int mask)
621 {
622         if (port->type == PORT_SCI) {
623                 /* Just store the mask */
624                 serial_port_out(port, SCxSR, mask);
625         } else if (to_sci_port(port)->params->overrun_mask == SCIFA_ORER) {
626                 /* SCIFA/SCIFB and SCIF on SH7705/SH7720/SH7721 */
627                 /* Only clear the status bits we want to clear */
628                 serial_port_out(port, SCxSR,
629                                 serial_port_in(port, SCxSR) & mask);
630         } else {
631                 /* Store the mask, clear parity/framing errors */
632                 serial_port_out(port, SCxSR, mask & ~(SCIF_FERC | SCIF_PERC));
633         }
634 }
635
636 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || \
637     defined(CONFIG_SERIAL_SH_SCI_EARLYCON)
638
639 #ifdef CONFIG_CONSOLE_POLL
640 static int sci_poll_get_char(struct uart_port *port)
641 {
642         unsigned short status;
643         int c;
644
645         do {
646                 status = serial_port_in(port, SCxSR);
647                 if (status & SCxSR_ERRORS(port)) {
648                         sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
649                         continue;
650                 }
651                 break;
652         } while (1);
653
654         if (!(status & SCxSR_RDxF(port)))
655                 return NO_POLL_CHAR;
656
657         c = serial_port_in(port, SCxRDR);
658
659         /* Dummy read */
660         serial_port_in(port, SCxSR);
661         sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
662
663         return c;
664 }
665 #endif
666
667 static void sci_poll_put_char(struct uart_port *port, unsigned char c)
668 {
669         unsigned short status;
670
671         do {
672                 status = serial_port_in(port, SCxSR);
673         } while (!(status & SCxSR_TDxE(port)));
674
675         serial_port_out(port, SCxTDR, c);
676         sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port) & ~SCxSR_TEND(port));
677 }
678 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE ||
679           CONFIG_SERIAL_SH_SCI_EARLYCON */
680
681 static void sci_init_pins(struct uart_port *port, unsigned int cflag)
682 {
683         struct sci_port *s = to_sci_port(port);
684
685         /*
686          * Use port-specific handler if provided.
687          */
688         if (s->cfg->ops && s->cfg->ops->init_pins) {
689                 s->cfg->ops->init_pins(port, cflag);
690                 return;
691         }
692
693         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
694                 u16 data = serial_port_in(port, SCPDR);
695                 u16 ctrl = serial_port_in(port, SCPCR);
696
697                 /* Enable RXD and TXD pin functions */
698                 ctrl &= ~(SCPCR_RXDC | SCPCR_TXDC);
699                 if (to_sci_port(port)->has_rtscts) {
700                         /* RTS# is output, active low, unless autorts */
701                         if (!(port->mctrl & TIOCM_RTS)) {
702                                 ctrl |= SCPCR_RTSC;
703                                 data |= SCPDR_RTSD;
704                         } else if (!s->autorts) {
705                                 ctrl |= SCPCR_RTSC;
706                                 data &= ~SCPDR_RTSD;
707                         } else {
708                                 /* Enable RTS# pin function */
709                                 ctrl &= ~SCPCR_RTSC;
710                         }
711                         /* Enable CTS# pin function */
712                         ctrl &= ~SCPCR_CTSC;
713                 }
714                 serial_port_out(port, SCPDR, data);
715                 serial_port_out(port, SCPCR, ctrl);
716         } else if (sci_getreg(port, SCSPTR)->size) {
717                 u16 status = serial_port_in(port, SCSPTR);
718
719                 /* RTS# is always output; and active low, unless autorts */
720                 status |= SCSPTR_RTSIO;
721                 if (!(port->mctrl & TIOCM_RTS))
722                         status |= SCSPTR_RTSDT;
723                 else if (!s->autorts)
724                         status &= ~SCSPTR_RTSDT;
725                 /* CTS# and SCK are inputs */
726                 status &= ~(SCSPTR_CTSIO | SCSPTR_SCKIO);
727                 serial_port_out(port, SCSPTR, status);
728         }
729 }
730
731 static int sci_txfill(struct uart_port *port)
732 {
733         struct sci_port *s = to_sci_port(port);
734         unsigned int fifo_mask = (s->params->fifosize << 1) - 1;
735         const struct plat_sci_reg *reg;
736
737         reg = sci_getreg(port, SCTFDR);
738         if (reg->size)
739                 return serial_port_in(port, SCTFDR) & fifo_mask;
740
741         reg = sci_getreg(port, SCFDR);
742         if (reg->size)
743                 return serial_port_in(port, SCFDR) >> 8;
744
745         return !(serial_port_in(port, SCxSR) & SCI_TDRE);
746 }
747
748 static int sci_txroom(struct uart_port *port)
749 {
750         return port->fifosize - sci_txfill(port);
751 }
752
753 static int sci_rxfill(struct uart_port *port)
754 {
755         struct sci_port *s = to_sci_port(port);
756         unsigned int fifo_mask = (s->params->fifosize << 1) - 1;
757         const struct plat_sci_reg *reg;
758
759         reg = sci_getreg(port, SCRFDR);
760         if (reg->size)
761                 return serial_port_in(port, SCRFDR) & fifo_mask;
762
763         reg = sci_getreg(port, SCFDR);
764         if (reg->size)
765                 return serial_port_in(port, SCFDR) & fifo_mask;
766
767         return (serial_port_in(port, SCxSR) & SCxSR_RDxF(port)) != 0;
768 }
769
770 /* ********************************************************************** *
771  *                   the interrupt related routines                       *
772  * ********************************************************************** */
773
774 static void sci_transmit_chars(struct uart_port *port)
775 {
776         struct circ_buf *xmit = &port->state->xmit;
777         unsigned int stopped = uart_tx_stopped(port);
778         unsigned short status;
779         unsigned short ctrl;
780         int count;
781
782         status = serial_port_in(port, SCxSR);
783         if (!(status & SCxSR_TDxE(port))) {
784                 ctrl = serial_port_in(port, SCSCR);
785                 if (uart_circ_empty(xmit))
786                         ctrl &= ~SCSCR_TIE;
787                 else
788                         ctrl |= SCSCR_TIE;
789                 serial_port_out(port, SCSCR, ctrl);
790                 return;
791         }
792
793         count = sci_txroom(port);
794
795         do {
796                 unsigned char c;
797
798                 if (port->x_char) {
799                         c = port->x_char;
800                         port->x_char = 0;
801                 } else if (!uart_circ_empty(xmit) && !stopped) {
802                         c = xmit->buf[xmit->tail];
803                         xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
804                 } else {
805                         break;
806                 }
807
808                 serial_port_out(port, SCxTDR, c);
809
810                 port->icount.tx++;
811         } while (--count > 0);
812
813         sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
814
815         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
816                 uart_write_wakeup(port);
817         if (uart_circ_empty(xmit))
818                 sci_stop_tx(port);
819
820 }
821
822 /* On SH3, SCIF may read end-of-break as a space->mark char */
823 #define STEPFN(c)  ({int __c = (c); (((__c-1)|(__c)) == -1); })
824
825 static void sci_receive_chars(struct uart_port *port)
826 {
827         struct tty_port *tport = &port->state->port;
828         int i, count, copied = 0;
829         unsigned short status;
830         unsigned char flag;
831
832         status = serial_port_in(port, SCxSR);
833         if (!(status & SCxSR_RDxF(port)))
834                 return;
835
836         while (1) {
837                 /* Don't copy more bytes than there is room for in the buffer */
838                 count = tty_buffer_request_room(tport, sci_rxfill(port));
839
840                 /* If for any reason we can't copy more data, we're done! */
841                 if (count == 0)
842                         break;
843
844                 if (port->type == PORT_SCI) {
845                         char c = serial_port_in(port, SCxRDR);
846                         if (uart_handle_sysrq_char(port, c))
847                                 count = 0;
848                         else
849                                 tty_insert_flip_char(tport, c, TTY_NORMAL);
850                 } else {
851                         for (i = 0; i < count; i++) {
852                                 char c;
853
854                                 if (port->type == PORT_SCIF ||
855                                     port->type == PORT_HSCIF) {
856                                         status = serial_port_in(port, SCxSR);
857                                         c = serial_port_in(port, SCxRDR);
858                                 } else {
859                                         c = serial_port_in(port, SCxRDR);
860                                         status = serial_port_in(port, SCxSR);
861                                 }
862                                 if (uart_handle_sysrq_char(port, c)) {
863                                         count--; i--;
864                                         continue;
865                                 }
866
867                                 /* Store data and status */
868                                 if (status & SCxSR_FER(port)) {
869                                         flag = TTY_FRAME;
870                                         port->icount.frame++;
871                                         dev_notice(port->dev, "frame error\n");
872                                 } else if (status & SCxSR_PER(port)) {
873                                         flag = TTY_PARITY;
874                                         port->icount.parity++;
875                                         dev_notice(port->dev, "parity error\n");
876                                 } else
877                                         flag = TTY_NORMAL;
878
879                                 tty_insert_flip_char(tport, c, flag);
880                         }
881                 }
882
883                 serial_port_in(port, SCxSR); /* dummy read */
884                 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
885
886                 copied += count;
887                 port->icount.rx += count;
888         }
889
890         if (copied) {
891                 /* Tell the rest of the system the news. New characters! */
892                 tty_flip_buffer_push(tport);
893         } else {
894                 /* TTY buffers full; read from RX reg to prevent lockup */
895                 serial_port_in(port, SCxRDR);
896                 serial_port_in(port, SCxSR); /* dummy read */
897                 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
898         }
899 }
900
901 static int sci_handle_errors(struct uart_port *port)
902 {
903         int copied = 0;
904         unsigned short status = serial_port_in(port, SCxSR);
905         struct tty_port *tport = &port->state->port;
906         struct sci_port *s = to_sci_port(port);
907
908         /* Handle overruns */
909         if (status & s->params->overrun_mask) {
910                 port->icount.overrun++;
911
912                 /* overrun error */
913                 if (tty_insert_flip_char(tport, 0, TTY_OVERRUN))
914                         copied++;
915
916                 dev_notice(port->dev, "overrun error\n");
917         }
918
919         if (status & SCxSR_FER(port)) {
920                 /* frame error */
921                 port->icount.frame++;
922
923                 if (tty_insert_flip_char(tport, 0, TTY_FRAME))
924                         copied++;
925
926                 dev_notice(port->dev, "frame error\n");
927         }
928
929         if (status & SCxSR_PER(port)) {
930                 /* parity error */
931                 port->icount.parity++;
932
933                 if (tty_insert_flip_char(tport, 0, TTY_PARITY))
934                         copied++;
935
936                 dev_notice(port->dev, "parity error\n");
937         }
938
939         if (copied)
940                 tty_flip_buffer_push(tport);
941
942         return copied;
943 }
944
945 static int sci_handle_fifo_overrun(struct uart_port *port)
946 {
947         struct tty_port *tport = &port->state->port;
948         struct sci_port *s = to_sci_port(port);
949         const struct plat_sci_reg *reg;
950         int copied = 0;
951         u16 status;
952
953         reg = sci_getreg(port, s->params->overrun_reg);
954         if (!reg->size)
955                 return 0;
956
957         status = serial_port_in(port, s->params->overrun_reg);
958         if (status & s->params->overrun_mask) {
959                 status &= ~s->params->overrun_mask;
960                 serial_port_out(port, s->params->overrun_reg, status);
961
962                 port->icount.overrun++;
963
964                 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
965                 tty_flip_buffer_push(tport);
966
967                 dev_dbg(port->dev, "overrun error\n");
968                 copied++;
969         }
970
971         return copied;
972 }
973
974 static int sci_handle_breaks(struct uart_port *port)
975 {
976         int copied = 0;
977         unsigned short status = serial_port_in(port, SCxSR);
978         struct tty_port *tport = &port->state->port;
979
980         if (uart_handle_break(port))
981                 return 0;
982
983         if (status & SCxSR_BRK(port)) {
984                 port->icount.brk++;
985
986                 /* Notify of BREAK */
987                 if (tty_insert_flip_char(tport, 0, TTY_BREAK))
988                         copied++;
989
990                 dev_dbg(port->dev, "BREAK detected\n");
991         }
992
993         if (copied)
994                 tty_flip_buffer_push(tport);
995
996         copied += sci_handle_fifo_overrun(port);
997
998         return copied;
999 }
1000
1001 static int scif_set_rtrg(struct uart_port *port, int rx_trig)
1002 {
1003         unsigned int bits;
1004
1005         if (rx_trig >= port->fifosize)
1006                 rx_trig = port->fifosize - 1;
1007         if (rx_trig < 1)
1008                 rx_trig = 1;
1009
1010         /* HSCIF can be set to an arbitrary level. */
1011         if (sci_getreg(port, HSRTRGR)->size) {
1012                 serial_port_out(port, HSRTRGR, rx_trig);
1013                 return rx_trig;
1014         }
1015
1016         switch (port->type) {
1017         case PORT_SCIF:
1018                 if (rx_trig < 4) {
1019                         bits = 0;
1020                         rx_trig = 1;
1021                 } else if (rx_trig < 8) {
1022                         bits = SCFCR_RTRG0;
1023                         rx_trig = 4;
1024                 } else if (rx_trig < 14) {
1025                         bits = SCFCR_RTRG1;
1026                         rx_trig = 8;
1027                 } else {
1028                         bits = SCFCR_RTRG0 | SCFCR_RTRG1;
1029                         rx_trig = 14;
1030                 }
1031                 break;
1032         case PORT_SCIFA:
1033         case PORT_SCIFB:
1034                 if (rx_trig < 16) {
1035                         bits = 0;
1036                         rx_trig = 1;
1037                 } else if (rx_trig < 32) {
1038                         bits = SCFCR_RTRG0;
1039                         rx_trig = 16;
1040                 } else if (rx_trig < 48) {
1041                         bits = SCFCR_RTRG1;
1042                         rx_trig = 32;
1043                 } else {
1044                         bits = SCFCR_RTRG0 | SCFCR_RTRG1;
1045                         rx_trig = 48;
1046                 }
1047                 break;
1048         default:
1049                 WARN(1, "unknown FIFO configuration");
1050                 return 1;
1051         }
1052
1053         serial_port_out(port, SCFCR,
1054                 (serial_port_in(port, SCFCR) &
1055                 ~(SCFCR_RTRG1 | SCFCR_RTRG0)) | bits);
1056
1057         return rx_trig;
1058 }
1059
1060 static int scif_rtrg_enabled(struct uart_port *port)
1061 {
1062         if (sci_getreg(port, HSRTRGR)->size)
1063                 return serial_port_in(port, HSRTRGR) != 0;
1064         else
1065                 return (serial_port_in(port, SCFCR) &
1066                         (SCFCR_RTRG0 | SCFCR_RTRG1)) != 0;
1067 }
1068
1069 static void rx_fifo_timer_fn(unsigned long arg)
1070 {
1071         struct sci_port *s = (struct sci_port *)arg;
1072         struct uart_port *port = &s->port;
1073
1074         dev_dbg(port->dev, "Rx timed out\n");
1075         scif_set_rtrg(port, 1);
1076 }
1077
1078 static ssize_t rx_trigger_show(struct device *dev,
1079                                struct device_attribute *attr,
1080                                char *buf)
1081 {
1082         struct uart_port *port = dev_get_drvdata(dev);
1083         struct sci_port *sci = to_sci_port(port);
1084
1085         return sprintf(buf, "%d\n", sci->rx_trigger);
1086 }
1087
1088 static ssize_t rx_trigger_store(struct device *dev,
1089                                 struct device_attribute *attr,
1090                                 const char *buf,
1091                                 size_t count)
1092 {
1093         struct uart_port *port = dev_get_drvdata(dev);
1094         struct sci_port *sci = to_sci_port(port);
1095         int ret;
1096         long r;
1097
1098         ret = kstrtol(buf, 0, &r);
1099         if (ret)
1100                 return ret;
1101
1102         sci->rx_trigger = scif_set_rtrg(port, r);
1103         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1104                 scif_set_rtrg(port, 1);
1105
1106         return count;
1107 }
1108
1109 static DEVICE_ATTR(rx_fifo_trigger, 0644, rx_trigger_show, rx_trigger_store);
1110
1111 static ssize_t rx_fifo_timeout_show(struct device *dev,
1112                                struct device_attribute *attr,
1113                                char *buf)
1114 {
1115         struct uart_port *port = dev_get_drvdata(dev);
1116         struct sci_port *sci = to_sci_port(port);
1117
1118         return sprintf(buf, "%d\n", sci->rx_fifo_timeout);
1119 }
1120
1121 static ssize_t rx_fifo_timeout_store(struct device *dev,
1122                                 struct device_attribute *attr,
1123                                 const char *buf,
1124                                 size_t count)
1125 {
1126         struct uart_port *port = dev_get_drvdata(dev);
1127         struct sci_port *sci = to_sci_port(port);
1128         int ret;
1129         long r;
1130
1131         ret = kstrtol(buf, 0, &r);
1132         if (ret)
1133                 return ret;
1134         sci->rx_fifo_timeout = r;
1135         scif_set_rtrg(port, 1);
1136         if (r > 0)
1137                 setup_timer(&sci->rx_fifo_timer, rx_fifo_timer_fn,
1138                             (unsigned long)sci);
1139         return count;
1140 }
1141
1142 static DEVICE_ATTR(rx_fifo_timeout, 0644, rx_fifo_timeout_show, rx_fifo_timeout_store);
1143
1144
1145 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1146 static void sci_dma_tx_complete(void *arg)
1147 {
1148         struct sci_port *s = arg;
1149         struct uart_port *port = &s->port;
1150         struct circ_buf *xmit = &port->state->xmit;
1151         unsigned long flags;
1152
1153         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1154
1155         spin_lock_irqsave(&port->lock, flags);
1156
1157         xmit->tail += s->tx_dma_len;
1158         xmit->tail &= UART_XMIT_SIZE - 1;
1159
1160         port->icount.tx += s->tx_dma_len;
1161
1162         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1163                 uart_write_wakeup(port);
1164
1165         if (!uart_circ_empty(xmit)) {
1166                 s->cookie_tx = 0;
1167                 schedule_work(&s->work_tx);
1168         } else {
1169                 s->cookie_tx = -EINVAL;
1170                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1171                         u16 ctrl = serial_port_in(port, SCSCR);
1172                         serial_port_out(port, SCSCR, ctrl & ~SCSCR_TIE);
1173                 }
1174         }
1175
1176         spin_unlock_irqrestore(&port->lock, flags);
1177 }
1178
1179 /* Locking: called with port lock held */
1180 static int sci_dma_rx_push(struct sci_port *s, void *buf, size_t count)
1181 {
1182         struct uart_port *port = &s->port;
1183         struct tty_port *tport = &port->state->port;
1184         int copied;
1185
1186         copied = tty_insert_flip_string(tport, buf, count);
1187         if (copied < count)
1188                 port->icount.buf_overrun++;
1189
1190         port->icount.rx += copied;
1191
1192         return copied;
1193 }
1194
1195 static int sci_dma_rx_find_active(struct sci_port *s)
1196 {
1197         unsigned int i;
1198
1199         for (i = 0; i < ARRAY_SIZE(s->cookie_rx); i++)
1200                 if (s->active_rx == s->cookie_rx[i])
1201                         return i;
1202
1203         return -1;
1204 }
1205
1206 static void sci_rx_dma_release(struct sci_port *s, bool enable_pio)
1207 {
1208         struct dma_chan *chan = s->chan_rx;
1209         struct uart_port *port = &s->port;
1210         unsigned long flags;
1211
1212         spin_lock_irqsave(&port->lock, flags);
1213         s->chan_rx = NULL;
1214         s->cookie_rx[0] = s->cookie_rx[1] = -EINVAL;
1215         spin_unlock_irqrestore(&port->lock, flags);
1216         dmaengine_terminate_all(chan);
1217         dma_free_coherent(chan->device->dev, s->buf_len_rx * 2, s->rx_buf[0],
1218                           sg_dma_address(&s->sg_rx[0]));
1219         dma_release_channel(chan);
1220         if (enable_pio)
1221                 sci_start_rx(port);
1222 }
1223
1224 static void sci_dma_rx_complete(void *arg)
1225 {
1226         struct sci_port *s = arg;
1227         struct dma_chan *chan = s->chan_rx;
1228         struct uart_port *port = &s->port;
1229         struct dma_async_tx_descriptor *desc;
1230         unsigned long flags;
1231         int active, count = 0;
1232
1233         dev_dbg(port->dev, "%s(%d) active cookie %d\n", __func__, port->line,
1234                 s->active_rx);
1235
1236         spin_lock_irqsave(&port->lock, flags);
1237
1238         active = sci_dma_rx_find_active(s);
1239         if (active >= 0)
1240                 count = sci_dma_rx_push(s, s->rx_buf[active], s->buf_len_rx);
1241
1242         mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1243
1244         if (count)
1245                 tty_flip_buffer_push(&port->state->port);
1246
1247         desc = dmaengine_prep_slave_sg(s->chan_rx, &s->sg_rx[active], 1,
1248                                        DMA_DEV_TO_MEM,
1249                                        DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1250         if (!desc)
1251                 goto fail;
1252
1253         desc->callback = sci_dma_rx_complete;
1254         desc->callback_param = s;
1255         s->cookie_rx[active] = dmaengine_submit(desc);
1256         if (dma_submit_error(s->cookie_rx[active]))
1257                 goto fail;
1258
1259         s->active_rx = s->cookie_rx[!active];
1260
1261         dma_async_issue_pending(chan);
1262
1263         spin_unlock_irqrestore(&port->lock, flags);
1264         dev_dbg(port->dev, "%s: cookie %d #%d, new active cookie %d\n",
1265                 __func__, s->cookie_rx[active], active, s->active_rx);
1266         return;
1267
1268 fail:
1269         spin_unlock_irqrestore(&port->lock, flags);
1270         dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1271         sci_rx_dma_release(s, true);
1272 }
1273
1274 static void sci_tx_dma_release(struct sci_port *s, bool enable_pio)
1275 {
1276         struct dma_chan *chan = s->chan_tx;
1277         struct uart_port *port = &s->port;
1278         unsigned long flags;
1279
1280         spin_lock_irqsave(&port->lock, flags);
1281         s->chan_tx = NULL;
1282         s->cookie_tx = -EINVAL;
1283         spin_unlock_irqrestore(&port->lock, flags);
1284         dmaengine_terminate_all(chan);
1285         dma_unmap_single(chan->device->dev, s->tx_dma_addr, UART_XMIT_SIZE,
1286                          DMA_TO_DEVICE);
1287         dma_release_channel(chan);
1288         if (enable_pio)
1289                 sci_start_tx(port);
1290 }
1291
1292 static void sci_submit_rx(struct sci_port *s)
1293 {
1294         struct dma_chan *chan = s->chan_rx;
1295         int i;
1296
1297         for (i = 0; i < 2; i++) {
1298                 struct scatterlist *sg = &s->sg_rx[i];
1299                 struct dma_async_tx_descriptor *desc;
1300
1301                 desc = dmaengine_prep_slave_sg(chan,
1302                         sg, 1, DMA_DEV_TO_MEM,
1303                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1304                 if (!desc)
1305                         goto fail;
1306
1307                 desc->callback = sci_dma_rx_complete;
1308                 desc->callback_param = s;
1309                 s->cookie_rx[i] = dmaengine_submit(desc);
1310                 if (dma_submit_error(s->cookie_rx[i]))
1311                         goto fail;
1312
1313         }
1314
1315         s->active_rx = s->cookie_rx[0];
1316
1317         dma_async_issue_pending(chan);
1318         return;
1319
1320 fail:
1321         if (i)
1322                 dmaengine_terminate_all(chan);
1323         for (i = 0; i < 2; i++)
1324                 s->cookie_rx[i] = -EINVAL;
1325         s->active_rx = -EINVAL;
1326         sci_rx_dma_release(s, true);
1327 }
1328
1329 static void work_fn_tx(struct work_struct *work)
1330 {
1331         struct sci_port *s = container_of(work, struct sci_port, work_tx);
1332         struct dma_async_tx_descriptor *desc;
1333         struct dma_chan *chan = s->chan_tx;
1334         struct uart_port *port = &s->port;
1335         struct circ_buf *xmit = &port->state->xmit;
1336         dma_addr_t buf;
1337         int head, tail;
1338
1339         /*
1340          * DMA is idle now.
1341          * Port xmit buffer is already mapped, and it is one page... Just adjust
1342          * offsets and lengths. Since it is a circular buffer, we have to
1343          * transmit till the end, and then the rest. Take the port lock to get a
1344          * consistent xmit buffer state.
1345          */
1346         spin_lock_irq(&port->lock);
1347         head = xmit->head;
1348         tail = xmit->tail;
1349         buf = s->tx_dma_addr + (tail & (UART_XMIT_SIZE - 1));
1350         s->tx_dma_len = min_t(unsigned int,
1351                 CIRC_CNT(head, tail, UART_XMIT_SIZE),
1352                 CIRC_CNT_TO_END(head, tail, UART_XMIT_SIZE));
1353         if (!s->tx_dma_len) {
1354                 /* Transmit buffer has been flushed */
1355                 spin_unlock_irq(&port->lock);
1356                 return;
1357         }
1358
1359         desc = dmaengine_prep_slave_single(chan, buf, s->tx_dma_len,
1360                                            DMA_MEM_TO_DEV,
1361                                            DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1362         if (!desc) {
1363                 spin_unlock_irq(&port->lock);
1364                 dev_warn(port->dev, "Failed preparing Tx DMA descriptor\n");
1365                 /* switch to PIO */
1366                 sci_tx_dma_release(s, true);
1367                 return;
1368         }
1369
1370         dma_sync_single_for_device(chan->device->dev, buf, s->tx_dma_len,
1371                                    DMA_TO_DEVICE);
1372
1373         desc->callback = sci_dma_tx_complete;
1374         desc->callback_param = s;
1375         s->cookie_tx = dmaengine_submit(desc);
1376         if (dma_submit_error(s->cookie_tx)) {
1377                 spin_unlock_irq(&port->lock);
1378                 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1379                 /* switch to PIO */
1380                 sci_tx_dma_release(s, true);
1381                 return;
1382         }
1383
1384         spin_unlock_irq(&port->lock);
1385         dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n",
1386                 __func__, xmit->buf, tail, head, s->cookie_tx);
1387
1388         dma_async_issue_pending(chan);
1389 }
1390
1391 static void rx_timer_fn(unsigned long arg)
1392 {
1393         struct sci_port *s = (struct sci_port *)arg;
1394         struct dma_chan *chan = s->chan_rx;
1395         struct uart_port *port = &s->port;
1396         struct dma_tx_state state;
1397         enum dma_status status;
1398         unsigned long flags;
1399         unsigned int read;
1400         int active, count;
1401         u16 scr;
1402
1403         dev_dbg(port->dev, "DMA Rx timed out\n");
1404
1405         spin_lock_irqsave(&port->lock, flags);
1406
1407         active = sci_dma_rx_find_active(s);
1408         if (active < 0) {
1409                 spin_unlock_irqrestore(&port->lock, flags);
1410                 return;
1411         }
1412
1413         status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1414         if (status == DMA_COMPLETE) {
1415                 spin_unlock_irqrestore(&port->lock, flags);
1416                 dev_dbg(port->dev, "Cookie %d #%d has already completed\n",
1417                         s->active_rx, active);
1418
1419                 /* Let packet complete handler take care of the packet */
1420                 return;
1421         }
1422
1423         dmaengine_pause(chan);
1424
1425         /*
1426          * sometimes DMA transfer doesn't stop even if it is stopped and
1427          * data keeps on coming until transaction is complete so check
1428          * for DMA_COMPLETE again
1429          * Let packet complete handler take care of the packet
1430          */
1431         status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1432         if (status == DMA_COMPLETE) {
1433                 spin_unlock_irqrestore(&port->lock, flags);
1434                 dev_dbg(port->dev, "Transaction complete after DMA engine was stopped");
1435                 return;
1436         }
1437
1438         /* Handle incomplete DMA receive */
1439         dmaengine_terminate_all(s->chan_rx);
1440         read = sg_dma_len(&s->sg_rx[active]) - state.residue;
1441
1442         if (read) {
1443                 count = sci_dma_rx_push(s, s->rx_buf[active], read);
1444                 if (count)
1445                         tty_flip_buffer_push(&port->state->port);
1446         }
1447
1448         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1449                 sci_submit_rx(s);
1450
1451         /* Direct new serial port interrupts back to CPU */
1452         scr = serial_port_in(port, SCSCR);
1453         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1454                 scr &= ~SCSCR_RDRQE;
1455                 enable_irq(s->irqs[SCIx_RXI_IRQ]);
1456         }
1457         serial_port_out(port, SCSCR, scr | SCSCR_RIE);
1458
1459         spin_unlock_irqrestore(&port->lock, flags);
1460 }
1461
1462 static struct dma_chan *sci_request_dma_chan(struct uart_port *port,
1463                                              enum dma_transfer_direction dir)
1464 {
1465         struct dma_chan *chan;
1466         struct dma_slave_config cfg;
1467         int ret;
1468
1469         chan = dma_request_slave_channel(port->dev,
1470                                          dir == DMA_MEM_TO_DEV ? "tx" : "rx");
1471         if (!chan) {
1472                 dev_warn(port->dev, "dma_request_slave_channel failed\n");
1473                 return NULL;
1474         }
1475
1476         memset(&cfg, 0, sizeof(cfg));
1477         cfg.direction = dir;
1478         if (dir == DMA_MEM_TO_DEV) {
1479                 cfg.dst_addr = port->mapbase +
1480                         (sci_getreg(port, SCxTDR)->offset << port->regshift);
1481                 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1482         } else {
1483                 cfg.src_addr = port->mapbase +
1484                         (sci_getreg(port, SCxRDR)->offset << port->regshift);
1485                 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1486         }
1487
1488         ret = dmaengine_slave_config(chan, &cfg);
1489         if (ret) {
1490                 dev_warn(port->dev, "dmaengine_slave_config failed %d\n", ret);
1491                 dma_release_channel(chan);
1492                 return NULL;
1493         }
1494
1495         return chan;
1496 }
1497
1498 static void sci_request_dma(struct uart_port *port)
1499 {
1500         struct sci_port *s = to_sci_port(port);
1501         struct dma_chan *chan;
1502
1503         dev_dbg(port->dev, "%s: port %d\n", __func__, port->line);
1504
1505         /*
1506          * DMA on console may interfere with Kernel log messages which use
1507          * plain putchar(). So, simply don't use it with a console.
1508          */
1509         if (uart_console(port))
1510                 return;
1511
1512         if (!port->dev->of_node)
1513                 return;
1514
1515         s->cookie_tx = -EINVAL;
1516
1517         /*
1518          * Don't request a dma channel if no channel was specified
1519          * in the device tree.
1520          */
1521         if (!of_find_property(port->dev->of_node, "dmas", NULL))
1522                 return;
1523
1524         chan = sci_request_dma_chan(port, DMA_MEM_TO_DEV);
1525         dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1526         if (chan) {
1527                 s->chan_tx = chan;
1528                 /* UART circular tx buffer is an aligned page. */
1529                 s->tx_dma_addr = dma_map_single(chan->device->dev,
1530                                                 port->state->xmit.buf,
1531                                                 UART_XMIT_SIZE,
1532                                                 DMA_TO_DEVICE);
1533                 if (dma_mapping_error(chan->device->dev, s->tx_dma_addr)) {
1534                         dev_warn(port->dev, "Failed mapping Tx DMA descriptor\n");
1535                         dma_release_channel(chan);
1536                         s->chan_tx = NULL;
1537                 } else {
1538                         dev_dbg(port->dev, "%s: mapped %lu@%p to %pad\n",
1539                                 __func__, UART_XMIT_SIZE,
1540                                 port->state->xmit.buf, &s->tx_dma_addr);
1541                 }
1542
1543                 INIT_WORK(&s->work_tx, work_fn_tx);
1544         }
1545
1546         chan = sci_request_dma_chan(port, DMA_DEV_TO_MEM);
1547         dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1548         if (chan) {
1549                 unsigned int i;
1550                 dma_addr_t dma;
1551                 void *buf;
1552
1553                 s->chan_rx = chan;
1554
1555                 s->buf_len_rx = 2 * max_t(size_t, 16, port->fifosize);
1556                 buf = dma_alloc_coherent(chan->device->dev, s->buf_len_rx * 2,
1557                                          &dma, GFP_KERNEL);
1558                 if (!buf) {
1559                         dev_warn(port->dev,
1560                                  "Failed to allocate Rx dma buffer, using PIO\n");
1561                         dma_release_channel(chan);
1562                         s->chan_rx = NULL;
1563                         return;
1564                 }
1565
1566                 for (i = 0; i < 2; i++) {
1567                         struct scatterlist *sg = &s->sg_rx[i];
1568
1569                         sg_init_table(sg, 1);
1570                         s->rx_buf[i] = buf;
1571                         sg_dma_address(sg) = dma;
1572                         sg_dma_len(sg) = s->buf_len_rx;
1573
1574                         buf += s->buf_len_rx;
1575                         dma += s->buf_len_rx;
1576                 }
1577
1578                 setup_timer(&s->rx_timer, rx_timer_fn, (unsigned long)s);
1579
1580                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1581                         sci_submit_rx(s);
1582         }
1583 }
1584
1585 static void sci_free_dma(struct uart_port *port)
1586 {
1587         struct sci_port *s = to_sci_port(port);
1588
1589         if (s->chan_tx)
1590                 sci_tx_dma_release(s, false);
1591         if (s->chan_rx)
1592                 sci_rx_dma_release(s, false);
1593 }
1594
1595 static void sci_flush_buffer(struct uart_port *port)
1596 {
1597         struct sci_port *s = to_sci_port(port);
1598
1599         /*
1600          * In uart_flush_buffer(), the xmit circular buffer has just been
1601          * cleared, so we have to reset tx_dma_len accordingly, and stop any
1602          * pending transfers
1603          */
1604         s->tx_dma_len = 0;
1605         if (s->chan_tx) {
1606                 dmaengine_terminate_async(s->chan_tx);
1607                 s->cookie_tx = -EINVAL;
1608         }
1609 }
1610 #else /* !CONFIG_SERIAL_SH_SCI_DMA */
1611 static inline void sci_request_dma(struct uart_port *port)
1612 {
1613 }
1614
1615 static inline void sci_free_dma(struct uart_port *port)
1616 {
1617 }
1618
1619 #define sci_flush_buffer        NULL
1620 #endif /* !CONFIG_SERIAL_SH_SCI_DMA */
1621
1622 static irqreturn_t sci_rx_interrupt(int irq, void *ptr)
1623 {
1624         struct uart_port *port = ptr;
1625         struct sci_port *s = to_sci_port(port);
1626
1627 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1628         if (s->chan_rx) {
1629                 u16 scr = serial_port_in(port, SCSCR);
1630                 u16 ssr = serial_port_in(port, SCxSR);
1631
1632                 /* Disable future Rx interrupts */
1633                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1634                         disable_irq_nosync(irq);
1635                         scr |= SCSCR_RDRQE;
1636                 } else {
1637                         scr &= ~SCSCR_RIE;
1638                         sci_submit_rx(s);
1639                 }
1640                 serial_port_out(port, SCSCR, scr);
1641                 /* Clear current interrupt */
1642                 serial_port_out(port, SCxSR,
1643                                 ssr & ~(SCIF_DR | SCxSR_RDxF(port)));
1644                 dev_dbg(port->dev, "Rx IRQ %lu: setup t-out in %u jiffies\n",
1645                         jiffies, s->rx_timeout);
1646                 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1647
1648                 return IRQ_HANDLED;
1649         }
1650 #endif
1651
1652         if (s->rx_trigger > 1 && s->rx_fifo_timeout > 0) {
1653                 if (!scif_rtrg_enabled(port))
1654                         scif_set_rtrg(port, s->rx_trigger);
1655
1656                 mod_timer(&s->rx_fifo_timer, jiffies + DIV_ROUND_UP(
1657                           s->rx_frame * s->rx_fifo_timeout, 1000));
1658         }
1659
1660         /* I think sci_receive_chars has to be called irrespective
1661          * of whether the I_IXOFF is set, otherwise, how is the interrupt
1662          * to be disabled?
1663          */
1664         sci_receive_chars(ptr);
1665
1666         return IRQ_HANDLED;
1667 }
1668
1669 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
1670 {
1671         struct uart_port *port = ptr;
1672         unsigned long flags;
1673
1674         spin_lock_irqsave(&port->lock, flags);
1675         sci_transmit_chars(port);
1676         spin_unlock_irqrestore(&port->lock, flags);
1677
1678         return IRQ_HANDLED;
1679 }
1680
1681 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
1682 {
1683         struct uart_port *port = ptr;
1684         struct sci_port *s = to_sci_port(port);
1685
1686         /* Handle errors */
1687         if (port->type == PORT_SCI) {
1688                 if (sci_handle_errors(port)) {
1689                         /* discard character in rx buffer */
1690                         serial_port_in(port, SCxSR);
1691                         sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
1692                 }
1693         } else {
1694                 sci_handle_fifo_overrun(port);
1695                 if (!s->chan_rx)
1696                         sci_receive_chars(ptr);
1697         }
1698
1699         sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
1700
1701         /* Kick the transmission */
1702         if (!s->chan_tx)
1703                 sci_tx_interrupt(irq, ptr);
1704
1705         return IRQ_HANDLED;
1706 }
1707
1708 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
1709 {
1710         struct uart_port *port = ptr;
1711
1712         /* Handle BREAKs */
1713         sci_handle_breaks(port);
1714         sci_clear_SCxSR(port, SCxSR_BREAK_CLEAR(port));
1715
1716         return IRQ_HANDLED;
1717 }
1718
1719 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
1720 {
1721         unsigned short ssr_status, scr_status, err_enabled, orer_status = 0;
1722         struct uart_port *port = ptr;
1723         struct sci_port *s = to_sci_port(port);
1724         irqreturn_t ret = IRQ_NONE;
1725
1726         ssr_status = serial_port_in(port, SCxSR);
1727         scr_status = serial_port_in(port, SCSCR);
1728         if (s->params->overrun_reg == SCxSR)
1729                 orer_status = ssr_status;
1730         else if (sci_getreg(port, s->params->overrun_reg)->size)
1731                 orer_status = serial_port_in(port, s->params->overrun_reg);
1732
1733         err_enabled = scr_status & port_rx_irq_mask(port);
1734
1735         /* Tx Interrupt */
1736         if ((ssr_status & SCxSR_TDxE(port)) && (scr_status & SCSCR_TIE) &&
1737             !s->chan_tx)
1738                 ret = sci_tx_interrupt(irq, ptr);
1739
1740         /*
1741          * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
1742          * DR flags
1743          */
1744         if (((ssr_status & SCxSR_RDxF(port)) || s->chan_rx) &&
1745             (scr_status & SCSCR_RIE))
1746                 ret = sci_rx_interrupt(irq, ptr);
1747
1748         /* Error Interrupt */
1749         if ((ssr_status & SCxSR_ERRORS(port)) && err_enabled)
1750                 ret = sci_er_interrupt(irq, ptr);
1751
1752         /* Break Interrupt */
1753         if ((ssr_status & SCxSR_BRK(port)) && err_enabled)
1754                 ret = sci_br_interrupt(irq, ptr);
1755
1756         /* Overrun Interrupt */
1757         if (orer_status & s->params->overrun_mask) {
1758                 sci_handle_fifo_overrun(port);
1759                 ret = IRQ_HANDLED;
1760         }
1761
1762         return ret;
1763 }
1764
1765 static const struct sci_irq_desc {
1766         const char      *desc;
1767         irq_handler_t   handler;
1768 } sci_irq_desc[] = {
1769         /*
1770          * Split out handlers, the default case.
1771          */
1772         [SCIx_ERI_IRQ] = {
1773                 .desc = "rx err",
1774                 .handler = sci_er_interrupt,
1775         },
1776
1777         [SCIx_RXI_IRQ] = {
1778                 .desc = "rx full",
1779                 .handler = sci_rx_interrupt,
1780         },
1781
1782         [SCIx_TXI_IRQ] = {
1783                 .desc = "tx empty",
1784                 .handler = sci_tx_interrupt,
1785         },
1786
1787         [SCIx_BRI_IRQ] = {
1788                 .desc = "break",
1789                 .handler = sci_br_interrupt,
1790         },
1791
1792         /*
1793          * Special muxed handler.
1794          */
1795         [SCIx_MUX_IRQ] = {
1796                 .desc = "mux",
1797                 .handler = sci_mpxed_interrupt,
1798         },
1799 };
1800
1801 static int sci_request_irq(struct sci_port *port)
1802 {
1803         struct uart_port *up = &port->port;
1804         int i, j, ret = 0;
1805
1806         for (i = j = 0; i < SCIx_NR_IRQS; i++, j++) {
1807                 const struct sci_irq_desc *desc;
1808                 int irq;
1809
1810                 if (SCIx_IRQ_IS_MUXED(port)) {
1811                         i = SCIx_MUX_IRQ;
1812                         irq = up->irq;
1813                 } else {
1814                         irq = port->irqs[i];
1815
1816                         /*
1817                          * Certain port types won't support all of the
1818                          * available interrupt sources.
1819                          */
1820                         if (unlikely(irq < 0))
1821                                 continue;
1822                 }
1823
1824                 desc = sci_irq_desc + i;
1825                 port->irqstr[j] = kasprintf(GFP_KERNEL, "%s:%s",
1826                                             dev_name(up->dev), desc->desc);
1827                 if (!port->irqstr[j]) {
1828                         ret = -ENOMEM;
1829                         goto out_nomem;
1830                 }
1831
1832                 ret = request_irq(irq, desc->handler, up->irqflags,
1833                                   port->irqstr[j], port);
1834                 if (unlikely(ret)) {
1835                         dev_err(up->dev, "Can't allocate %s IRQ\n", desc->desc);
1836                         goto out_noirq;
1837                 }
1838         }
1839
1840         return 0;
1841
1842 out_noirq:
1843         while (--i >= 0)
1844                 free_irq(port->irqs[i], port);
1845
1846 out_nomem:
1847         while (--j >= 0)
1848                 kfree(port->irqstr[j]);
1849
1850         return ret;
1851 }
1852
1853 static void sci_free_irq(struct sci_port *port)
1854 {
1855         int i;
1856
1857         /*
1858          * Intentionally in reverse order so we iterate over the muxed
1859          * IRQ first.
1860          */
1861         for (i = 0; i < SCIx_NR_IRQS; i++) {
1862                 int irq = port->irqs[i];
1863
1864                 /*
1865                  * Certain port types won't support all of the available
1866                  * interrupt sources.
1867                  */
1868                 if (unlikely(irq < 0))
1869                         continue;
1870
1871                 free_irq(port->irqs[i], port);
1872                 kfree(port->irqstr[i]);
1873
1874                 if (SCIx_IRQ_IS_MUXED(port)) {
1875                         /* If there's only one IRQ, we're done. */
1876                         return;
1877                 }
1878         }
1879 }
1880
1881 static unsigned int sci_tx_empty(struct uart_port *port)
1882 {
1883         unsigned short status = serial_port_in(port, SCxSR);
1884         unsigned short in_tx_fifo = sci_txfill(port);
1885
1886         return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
1887 }
1888
1889 static void sci_set_rts(struct uart_port *port, bool state)
1890 {
1891         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1892                 u16 data = serial_port_in(port, SCPDR);
1893
1894                 /* Active low */
1895                 if (state)
1896                         data &= ~SCPDR_RTSD;
1897                 else
1898                         data |= SCPDR_RTSD;
1899                 serial_port_out(port, SCPDR, data);
1900
1901                 /* RTS# is output */
1902                 serial_port_out(port, SCPCR,
1903                                 serial_port_in(port, SCPCR) | SCPCR_RTSC);
1904         } else if (sci_getreg(port, SCSPTR)->size) {
1905                 u16 ctrl = serial_port_in(port, SCSPTR);
1906
1907                 /* Active low */
1908                 if (state)
1909                         ctrl &= ~SCSPTR_RTSDT;
1910                 else
1911                         ctrl |= SCSPTR_RTSDT;
1912                 serial_port_out(port, SCSPTR, ctrl);
1913         }
1914 }
1915
1916 static bool sci_get_cts(struct uart_port *port)
1917 {
1918         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1919                 /* Active low */
1920                 return !(serial_port_in(port, SCPDR) & SCPDR_CTSD);
1921         } else if (sci_getreg(port, SCSPTR)->size) {
1922                 /* Active low */
1923                 return !(serial_port_in(port, SCSPTR) & SCSPTR_CTSDT);
1924         }
1925
1926         return true;
1927 }
1928
1929 /*
1930  * Modem control is a bit of a mixed bag for SCI(F) ports. Generally
1931  * CTS/RTS is supported in hardware by at least one port and controlled
1932  * via SCSPTR (SCxPCR for SCIFA/B parts), or external pins (presently
1933  * handled via the ->init_pins() op, which is a bit of a one-way street,
1934  * lacking any ability to defer pin control -- this will later be
1935  * converted over to the GPIO framework).
1936  *
1937  * Other modes (such as loopback) are supported generically on certain
1938  * port types, but not others. For these it's sufficient to test for the
1939  * existence of the support register and simply ignore the port type.
1940  */
1941 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
1942 {
1943         struct sci_port *s = to_sci_port(port);
1944
1945         if (mctrl & TIOCM_LOOP) {
1946                 const struct plat_sci_reg *reg;
1947
1948                 /*
1949                  * Standard loopback mode for SCFCR ports.
1950                  */
1951                 reg = sci_getreg(port, SCFCR);
1952                 if (reg->size)
1953                         serial_port_out(port, SCFCR,
1954                                         serial_port_in(port, SCFCR) |
1955                                         SCFCR_LOOP);
1956         }
1957
1958         mctrl_gpio_set(s->gpios, mctrl);
1959
1960         if (!s->has_rtscts)
1961                 return;
1962
1963         if (!(mctrl & TIOCM_RTS)) {
1964                 /* Disable Auto RTS */
1965                 serial_port_out(port, SCFCR,
1966                                 serial_port_in(port, SCFCR) & ~SCFCR_MCE);
1967
1968                 /* Clear RTS */
1969                 sci_set_rts(port, 0);
1970         } else if (s->autorts) {
1971                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1972                         /* Enable RTS# pin function */
1973                         serial_port_out(port, SCPCR,
1974                                 serial_port_in(port, SCPCR) & ~SCPCR_RTSC);
1975                 }
1976
1977                 /* Enable Auto RTS */
1978                 serial_port_out(port, SCFCR,
1979                                 serial_port_in(port, SCFCR) | SCFCR_MCE);
1980         } else {
1981                 /* Set RTS */
1982                 sci_set_rts(port, 1);
1983         }
1984 }
1985
1986 static unsigned int sci_get_mctrl(struct uart_port *port)
1987 {
1988         struct sci_port *s = to_sci_port(port);
1989         struct mctrl_gpios *gpios = s->gpios;
1990         unsigned int mctrl = 0;
1991
1992         mctrl_gpio_get(gpios, &mctrl);
1993
1994         /*
1995          * CTS/RTS is handled in hardware when supported, while nothing
1996          * else is wired up.
1997          */
1998         if (s->autorts) {
1999                 if (sci_get_cts(port))
2000                         mctrl |= TIOCM_CTS;
2001         } else if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_CTS))) {
2002                 mctrl |= TIOCM_CTS;
2003         }
2004         if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_DSR)))
2005                 mctrl |= TIOCM_DSR;
2006         if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_DCD)))
2007                 mctrl |= TIOCM_CAR;
2008
2009         return mctrl;
2010 }
2011
2012 static void sci_enable_ms(struct uart_port *port)
2013 {
2014         mctrl_gpio_enable_ms(to_sci_port(port)->gpios);
2015 }
2016
2017 static void sci_break_ctl(struct uart_port *port, int break_state)
2018 {
2019         unsigned short scscr, scsptr;
2020
2021         /* check wheter the port has SCSPTR */
2022         if (!sci_getreg(port, SCSPTR)->size) {
2023                 /*
2024                  * Not supported by hardware. Most parts couple break and rx
2025                  * interrupts together, with break detection always enabled.
2026                  */
2027                 return;
2028         }
2029
2030         scsptr = serial_port_in(port, SCSPTR);
2031         scscr = serial_port_in(port, SCSCR);
2032
2033         if (break_state == -1) {
2034                 scsptr = (scsptr | SCSPTR_SPB2IO) & ~SCSPTR_SPB2DT;
2035                 scscr &= ~SCSCR_TE;
2036         } else {
2037                 scsptr = (scsptr | SCSPTR_SPB2DT) & ~SCSPTR_SPB2IO;
2038                 scscr |= SCSCR_TE;
2039         }
2040
2041         serial_port_out(port, SCSPTR, scsptr);
2042         serial_port_out(port, SCSCR, scscr);
2043 }
2044
2045 static int sci_startup(struct uart_port *port)
2046 {
2047         struct sci_port *s = to_sci_port(port);
2048         int ret;
2049
2050         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
2051
2052         sci_request_dma(port);
2053
2054         ret = sci_request_irq(s);
2055         if (unlikely(ret < 0)) {
2056                 sci_free_dma(port);
2057                 return ret;
2058         }
2059
2060         return 0;
2061 }
2062
2063 static void sci_shutdown(struct uart_port *port)
2064 {
2065         struct sci_port *s = to_sci_port(port);
2066         unsigned long flags;
2067         u16 scr;
2068
2069         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
2070
2071         s->autorts = false;
2072         mctrl_gpio_disable_ms(to_sci_port(port)->gpios);
2073
2074         spin_lock_irqsave(&port->lock, flags);
2075         sci_stop_rx(port);
2076         sci_stop_tx(port);
2077         /* Stop RX and TX, disable related interrupts, keep clock source */
2078         scr = serial_port_in(port, SCSCR);
2079         serial_port_out(port, SCSCR, scr & (SCSCR_CKE1 | SCSCR_CKE0));
2080         spin_unlock_irqrestore(&port->lock, flags);
2081
2082 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2083         if (s->chan_rx) {
2084                 dev_dbg(port->dev, "%s(%d) deleting rx_timer\n", __func__,
2085                         port->line);
2086                 del_timer_sync(&s->rx_timer);
2087         }
2088 #endif
2089
2090         if (s->rx_trigger > 1 && s->rx_fifo_timeout > 0)
2091                 del_timer_sync(&s->rx_fifo_timer);
2092         sci_free_irq(s);
2093         sci_free_dma(port);
2094 }
2095
2096 static int sci_sck_calc(struct sci_port *s, unsigned int bps,
2097                         unsigned int *srr)
2098 {
2099         unsigned long freq = s->clk_rates[SCI_SCK];
2100         int err, min_err = INT_MAX;
2101         unsigned int sr;
2102
2103         if (s->port.type != PORT_HSCIF)
2104                 freq *= 2;
2105
2106         for_each_sr(sr, s) {
2107                 err = DIV_ROUND_CLOSEST(freq, sr) - bps;
2108                 if (abs(err) >= abs(min_err))
2109                         continue;
2110
2111                 min_err = err;
2112                 *srr = sr - 1;
2113
2114                 if (!err)
2115                         break;
2116         }
2117
2118         dev_dbg(s->port.dev, "SCK: %u%+d bps using SR %u\n", bps, min_err,
2119                 *srr + 1);
2120         return min_err;
2121 }
2122
2123 static int sci_brg_calc(struct sci_port *s, unsigned int bps,
2124                         unsigned long freq, unsigned int *dlr,
2125                         unsigned int *srr)
2126 {
2127         int err, min_err = INT_MAX;
2128         unsigned int sr, dl;
2129
2130         if (s->port.type != PORT_HSCIF)
2131                 freq *= 2;
2132
2133         for_each_sr(sr, s) {
2134                 dl = DIV_ROUND_CLOSEST(freq, sr * bps);
2135                 dl = clamp(dl, 1U, 65535U);
2136
2137                 err = DIV_ROUND_CLOSEST(freq, sr * dl) - bps;
2138                 if (abs(err) >= abs(min_err))
2139                         continue;
2140
2141                 min_err = err;
2142                 *dlr = dl;
2143                 *srr = sr - 1;
2144
2145                 if (!err)
2146                         break;
2147         }
2148
2149         dev_dbg(s->port.dev, "BRG: %u%+d bps using DL %u SR %u\n", bps,
2150                 min_err, *dlr, *srr + 1);
2151         return min_err;
2152 }
2153
2154 /* calculate sample rate, BRR, and clock select */
2155 static int sci_scbrr_calc(struct sci_port *s, unsigned int bps,
2156                           unsigned int *brr, unsigned int *srr,
2157                           unsigned int *cks)
2158 {
2159         unsigned long freq = s->clk_rates[SCI_FCK];
2160         unsigned int sr, br, prediv, scrate, c;
2161         int err, min_err = INT_MAX;
2162
2163         if (s->port.type != PORT_HSCIF)
2164                 freq *= 2;
2165
2166         /*
2167          * Find the combination of sample rate and clock select with the
2168          * smallest deviation from the desired baud rate.
2169          * Prefer high sample rates to maximise the receive margin.
2170          *
2171          * M: Receive margin (%)
2172          * N: Ratio of bit rate to clock (N = sampling rate)
2173          * D: Clock duty (D = 0 to 1.0)
2174          * L: Frame length (L = 9 to 12)
2175          * F: Absolute value of clock frequency deviation
2176          *
2177          *  M = |(0.5 - 1 / 2 * N) - ((L - 0.5) * F) -
2178          *      (|D - 0.5| / N * (1 + F))|
2179          *  NOTE: Usually, treat D for 0.5, F is 0 by this calculation.
2180          */
2181         for_each_sr(sr, s) {
2182                 for (c = 0; c <= 3; c++) {
2183                         /* integerized formulas from HSCIF documentation */
2184                         prediv = sr * (1 << (2 * c + 1));
2185
2186                         /*
2187                          * We need to calculate:
2188                          *
2189                          *     br = freq / (prediv * bps) clamped to [1..256]
2190                          *     err = freq / (br * prediv) - bps
2191                          *
2192                          * Watch out for overflow when calculating the desired
2193                          * sampling clock rate!
2194                          */
2195                         if (bps > UINT_MAX / prediv)
2196                                 break;
2197
2198                         scrate = prediv * bps;
2199                         br = DIV_ROUND_CLOSEST(freq, scrate);
2200                         br = clamp(br, 1U, 256U);
2201
2202                         err = DIV_ROUND_CLOSEST(freq, br * prediv) - bps;
2203                         if (abs(err) >= abs(min_err))
2204                                 continue;
2205
2206                         min_err = err;
2207                         *brr = br - 1;
2208                         *srr = sr - 1;
2209                         *cks = c;
2210
2211                         if (!err)
2212                                 goto found;
2213                 }
2214         }
2215
2216 found:
2217         dev_dbg(s->port.dev, "BRR: %u%+d bps using N %u SR %u cks %u\n", bps,
2218                 min_err, *brr, *srr + 1, *cks);
2219         return min_err;
2220 }
2221
2222 static void sci_reset(struct uart_port *port)
2223 {
2224         const struct plat_sci_reg *reg;
2225         unsigned int status;
2226         struct sci_port *s = to_sci_port(port);
2227
2228         serial_port_out(port, SCSCR, 0x00);     /* TE=0, RE=0, CKE1=0 */
2229
2230         reg = sci_getreg(port, SCFCR);
2231         if (reg->size)
2232                 serial_port_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
2233
2234         sci_clear_SCxSR(port,
2235                         SCxSR_RDxF_CLEAR(port) & SCxSR_ERROR_CLEAR(port) &
2236                         SCxSR_BREAK_CLEAR(port));
2237         if (sci_getreg(port, SCLSR)->size) {
2238                 status = serial_port_in(port, SCLSR);
2239                 status &= ~(SCLSR_TO | SCLSR_ORER);
2240                 serial_port_out(port, SCLSR, status);
2241         }
2242
2243         if (s->rx_trigger > 1) {
2244                 if (s->rx_fifo_timeout) {
2245                         scif_set_rtrg(port, 1);
2246                         setup_timer(&s->rx_fifo_timer, rx_fifo_timer_fn,
2247                                     (unsigned long)s);
2248                 } else {
2249                         if (port->type == PORT_SCIFA ||
2250                             port->type == PORT_SCIFB)
2251                                 scif_set_rtrg(port, 1);
2252                         else
2253                                 scif_set_rtrg(port, s->rx_trigger);
2254                 }
2255         }
2256 }
2257
2258 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
2259                             struct ktermios *old)
2260 {
2261         unsigned int baud, smr_val = SCSMR_ASYNC, scr_val = 0, i, bits;
2262         unsigned int brr = 255, cks = 0, srr = 15, dl = 0, sccks = 0;
2263         unsigned int brr1 = 255, cks1 = 0, srr1 = 15, dl1 = 0;
2264         struct sci_port *s = to_sci_port(port);
2265         const struct plat_sci_reg *reg;
2266         int min_err = INT_MAX, err;
2267         unsigned long max_freq = 0;
2268         int best_clk = -1;
2269
2270         if ((termios->c_cflag & CSIZE) == CS7)
2271                 smr_val |= SCSMR_CHR;
2272         if (termios->c_cflag & PARENB)
2273                 smr_val |= SCSMR_PE;
2274         if (termios->c_cflag & PARODD)
2275                 smr_val |= SCSMR_PE | SCSMR_ODD;
2276         if (termios->c_cflag & CSTOPB)
2277                 smr_val |= SCSMR_STOP;
2278
2279         /*
2280          * earlyprintk comes here early on with port->uartclk set to zero.
2281          * the clock framework is not up and running at this point so here
2282          * we assume that 115200 is the maximum baud rate. please note that
2283          * the baud rate is not programmed during earlyprintk - it is assumed
2284          * that the previous boot loader has enabled required clocks and
2285          * setup the baud rate generator hardware for us already.
2286          */
2287         if (!port->uartclk) {
2288                 baud = uart_get_baud_rate(port, termios, old, 0, 115200);
2289                 goto done;
2290         }
2291
2292         for (i = 0; i < SCI_NUM_CLKS; i++)
2293                 max_freq = max(max_freq, s->clk_rates[i]);
2294
2295         baud = uart_get_baud_rate(port, termios, old, 0, max_freq / min_sr(s));
2296         if (!baud)
2297                 goto done;
2298
2299         /*
2300          * There can be multiple sources for the sampling clock.  Find the one
2301          * that gives us the smallest deviation from the desired baud rate.
2302          */
2303
2304         /* Optional Undivided External Clock */
2305         if (s->clk_rates[SCI_SCK] && port->type != PORT_SCIFA &&
2306             port->type != PORT_SCIFB) {
2307                 err = sci_sck_calc(s, baud, &srr1);
2308                 if (abs(err) < abs(min_err)) {
2309                         best_clk = SCI_SCK;
2310                         scr_val = SCSCR_CKE1;
2311                         sccks = SCCKS_CKS;
2312                         min_err = err;
2313                         srr = srr1;
2314                         if (!err)
2315                                 goto done;
2316                 }
2317         }
2318
2319         /* Optional BRG Frequency Divided External Clock */
2320         if (s->clk_rates[SCI_SCIF_CLK] && sci_getreg(port, SCDL)->size) {
2321                 err = sci_brg_calc(s, baud, s->clk_rates[SCI_SCIF_CLK], &dl1,
2322                                    &srr1);
2323                 if (abs(err) < abs(min_err)) {
2324                         best_clk = SCI_SCIF_CLK;
2325                         scr_val = SCSCR_CKE1;
2326                         sccks = 0;
2327                         min_err = err;
2328                         dl = dl1;
2329                         srr = srr1;
2330                         if (!err)
2331                                 goto done;
2332                 }
2333         }
2334
2335         /* Optional BRG Frequency Divided Internal Clock */
2336         if (s->clk_rates[SCI_BRG_INT] && sci_getreg(port, SCDL)->size) {
2337                 err = sci_brg_calc(s, baud, s->clk_rates[SCI_BRG_INT], &dl1,
2338                                    &srr1);
2339                 if (abs(err) < abs(min_err)) {
2340                         best_clk = SCI_BRG_INT;
2341                         scr_val = SCSCR_CKE1;
2342                         sccks = SCCKS_XIN;
2343                         min_err = err;
2344                         dl = dl1;
2345                         srr = srr1;
2346                         if (!min_err)
2347                                 goto done;
2348                 }
2349         }
2350
2351         /* Divided Functional Clock using standard Bit Rate Register */
2352         err = sci_scbrr_calc(s, baud, &brr1, &srr1, &cks1);
2353         if (abs(err) < abs(min_err)) {
2354                 best_clk = SCI_FCK;
2355                 scr_val = 0;
2356                 min_err = err;
2357                 brr = brr1;
2358                 srr = srr1;
2359                 cks = cks1;
2360         }
2361
2362 done:
2363         if (best_clk >= 0)
2364                 dev_dbg(port->dev, "Using clk %pC for %u%+d bps\n",
2365                         s->clks[best_clk], baud, min_err);
2366
2367         sci_port_enable(s);
2368
2369         /*
2370          * Program the optional External Baud Rate Generator (BRG) first.
2371          * It controls the mux to select (H)SCK or frequency divided clock.
2372          */
2373         if (best_clk >= 0 && sci_getreg(port, SCCKS)->size) {
2374                 serial_port_out(port, SCDL, dl);
2375                 serial_port_out(port, SCCKS, sccks);
2376         }
2377
2378         sci_reset(port);
2379
2380         uart_update_timeout(port, termios->c_cflag, baud);
2381
2382         if (best_clk >= 0) {
2383                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
2384                         switch (srr + 1) {
2385                         case 5:  smr_val |= SCSMR_SRC_5;  break;
2386                         case 7:  smr_val |= SCSMR_SRC_7;  break;
2387                         case 11: smr_val |= SCSMR_SRC_11; break;
2388                         case 13: smr_val |= SCSMR_SRC_13; break;
2389                         case 16: smr_val |= SCSMR_SRC_16; break;
2390                         case 17: smr_val |= SCSMR_SRC_17; break;
2391                         case 19: smr_val |= SCSMR_SRC_19; break;
2392                         case 27: smr_val |= SCSMR_SRC_27; break;
2393                         }
2394                 smr_val |= cks;
2395                 dev_dbg(port->dev,
2396                          "SCR 0x%x SMR 0x%x BRR %u CKS 0x%x DL %u SRR %u\n",
2397                          scr_val, smr_val, brr, sccks, dl, srr);
2398                 serial_port_out(port, SCSCR, scr_val);
2399                 serial_port_out(port, SCSMR, smr_val);
2400                 serial_port_out(port, SCBRR, brr);
2401                 if (sci_getreg(port, HSSRR)->size)
2402                         serial_port_out(port, HSSRR, srr | HSCIF_SRE);
2403
2404                 /* Wait one bit interval */
2405                 udelay((1000000 + (baud - 1)) / baud);
2406         } else {
2407                 /* Don't touch the bit rate configuration */
2408                 scr_val = s->cfg->scscr & (SCSCR_CKE1 | SCSCR_CKE0);
2409                 smr_val |= serial_port_in(port, SCSMR) &
2410                            (SCSMR_CKEDG | SCSMR_SRC_MASK | SCSMR_CKS);
2411                 dev_dbg(port->dev, "SCR 0x%x SMR 0x%x\n", scr_val, smr_val);
2412                 serial_port_out(port, SCSCR, scr_val);
2413                 serial_port_out(port, SCSMR, smr_val);
2414         }
2415
2416         sci_init_pins(port, termios->c_cflag);
2417
2418         port->status &= ~UPSTAT_AUTOCTS;
2419         s->autorts = false;
2420         reg = sci_getreg(port, SCFCR);
2421         if (reg->size) {
2422                 unsigned short ctrl = serial_port_in(port, SCFCR);
2423
2424                 if ((port->flags & UPF_HARD_FLOW) &&
2425                     (termios->c_cflag & CRTSCTS)) {
2426                         /* There is no CTS interrupt to restart the hardware */
2427                         port->status |= UPSTAT_AUTOCTS;
2428                         /* MCE is enabled when RTS is raised */
2429                         s->autorts = true;
2430                 }
2431
2432                 /*
2433                  * As we've done a sci_reset() above, ensure we don't
2434                  * interfere with the FIFOs while toggling MCE. As the
2435                  * reset values could still be set, simply mask them out.
2436                  */
2437                 ctrl &= ~(SCFCR_RFRST | SCFCR_TFRST);
2438
2439                 serial_port_out(port, SCFCR, ctrl);
2440         }
2441         if (port->flags & UPF_HARD_FLOW) {
2442                 /* Refresh (Auto) RTS */
2443                 sci_set_mctrl(port, port->mctrl);
2444         }
2445
2446         scr_val |= SCSCR_RE | SCSCR_TE |
2447                    (s->cfg->scscr & ~(SCSCR_CKE1 | SCSCR_CKE0));
2448         dev_dbg(port->dev, "SCSCR 0x%x\n", scr_val);
2449         serial_port_out(port, SCSCR, scr_val);
2450         if ((srr + 1 == 5) &&
2451             (port->type == PORT_SCIFA || port->type == PORT_SCIFB)) {
2452                 /*
2453                  * In asynchronous mode, when the sampling rate is 1/5, first
2454                  * received data may become invalid on some SCIFA and SCIFB.
2455                  * To avoid this problem wait more than 1 serial data time (1
2456                  * bit time x serial data number) after setting SCSCR.RE = 1.
2457                  */
2458                 udelay(DIV_ROUND_UP(10 * 1000000, baud));
2459         }
2460
2461         /*
2462          * Calculate delay for 2 DMA buffers (4 FIFO).
2463          * See serial_core.c::uart_update_timeout().
2464          * With 10 bits (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above
2465          * function calculates 1 jiffie for the data plus 5 jiffies for the
2466          * "slop(e)." Then below we calculate 5 jiffies (20ms) for 2 DMA
2467          * buffers (4 FIFO sizes), but when performing a faster transfer, the
2468          * value obtained by this formula is too small. Therefore, if the value
2469          * is smaller than 20ms, use 20ms as the timeout value for DMA.
2470          */
2471         /* byte size and parity */
2472         switch (termios->c_cflag & CSIZE) {
2473         case CS5:
2474                 bits = 7;
2475                 break;
2476         case CS6:
2477                 bits = 8;
2478                 break;
2479         case CS7:
2480                 bits = 9;
2481                 break;
2482         default:
2483                 bits = 10;
2484                 break;
2485         }
2486
2487         if (termios->c_cflag & CSTOPB)
2488                 bits++;
2489         if (termios->c_cflag & PARENB)
2490                 bits++;
2491
2492         s->rx_frame = (100 * bits * HZ) / (baud / 10);
2493 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2494         s->rx_timeout = DIV_ROUND_UP(s->buf_len_rx * 2 * s->rx_frame, 1000);
2495         dev_dbg(port->dev, "DMA Rx t-out %ums, tty t-out %u jiffies\n",
2496                 s->rx_timeout * 1000 / HZ, port->timeout);
2497         if (s->rx_timeout < msecs_to_jiffies(20))
2498                 s->rx_timeout = msecs_to_jiffies(20);
2499 #endif
2500
2501         if ((termios->c_cflag & CREAD) != 0)
2502                 sci_start_rx(port);
2503
2504         sci_port_disable(s);
2505
2506         if (UART_ENABLE_MS(port, termios->c_cflag))
2507                 sci_enable_ms(port);
2508 }
2509
2510 static void sci_pm(struct uart_port *port, unsigned int state,
2511                    unsigned int oldstate)
2512 {
2513         struct sci_port *sci_port = to_sci_port(port);
2514
2515         switch (state) {
2516         case UART_PM_STATE_OFF:
2517                 sci_port_disable(sci_port);
2518                 break;
2519         default:
2520                 sci_port_enable(sci_port);
2521                 break;
2522         }
2523 }
2524
2525 static const char *sci_type(struct uart_port *port)
2526 {
2527         switch (port->type) {
2528         case PORT_IRDA:
2529                 return "irda";
2530         case PORT_SCI:
2531                 return "sci";
2532         case PORT_SCIF:
2533                 return "scif";
2534         case PORT_SCIFA:
2535                 return "scifa";
2536         case PORT_SCIFB:
2537                 return "scifb";
2538         case PORT_HSCIF:
2539                 return "hscif";
2540         }
2541
2542         return NULL;
2543 }
2544
2545 static int sci_remap_port(struct uart_port *port)
2546 {
2547         struct sci_port *sport = to_sci_port(port);
2548
2549         /*
2550          * Nothing to do if there's already an established membase.
2551          */
2552         if (port->membase)
2553                 return 0;
2554
2555         if (port->dev->of_node || (port->flags & UPF_IOREMAP)) {
2556                 port->membase = ioremap_nocache(port->mapbase, sport->reg_size);
2557                 if (unlikely(!port->membase)) {
2558                         dev_err(port->dev, "can't remap port#%d\n", port->line);
2559                         return -ENXIO;
2560                 }
2561         } else {
2562                 /*
2563                  * For the simple (and majority of) cases where we don't
2564                  * need to do any remapping, just cast the cookie
2565                  * directly.
2566                  */
2567                 port->membase = (void __iomem *)(uintptr_t)port->mapbase;
2568         }
2569
2570         return 0;
2571 }
2572
2573 static void sci_release_port(struct uart_port *port)
2574 {
2575         struct sci_port *sport = to_sci_port(port);
2576
2577         if (port->dev->of_node || (port->flags & UPF_IOREMAP)) {
2578                 iounmap(port->membase);
2579                 port->membase = NULL;
2580         }
2581
2582         release_mem_region(port->mapbase, sport->reg_size);
2583 }
2584
2585 static int sci_request_port(struct uart_port *port)
2586 {
2587         struct resource *res;
2588         struct sci_port *sport = to_sci_port(port);
2589         int ret;
2590
2591         res = request_mem_region(port->mapbase, sport->reg_size,
2592                                  dev_name(port->dev));
2593         if (unlikely(res == NULL)) {
2594                 dev_err(port->dev, "request_mem_region failed.");
2595                 return -EBUSY;
2596         }
2597
2598         ret = sci_remap_port(port);
2599         if (unlikely(ret != 0)) {
2600                 release_resource(res);
2601                 return ret;
2602         }
2603
2604         return 0;
2605 }
2606
2607 static void sci_config_port(struct uart_port *port, int flags)
2608 {
2609         if (flags & UART_CONFIG_TYPE) {
2610                 struct sci_port *sport = to_sci_port(port);
2611
2612                 port->type = sport->cfg->type;
2613                 sci_request_port(port);
2614         }
2615 }
2616
2617 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
2618 {
2619         if (ser->baud_base < 2400)
2620                 /* No paper tape reader for Mitch.. */
2621                 return -EINVAL;
2622
2623         return 0;
2624 }
2625
2626 static const struct uart_ops sci_uart_ops = {
2627         .tx_empty       = sci_tx_empty,
2628         .set_mctrl      = sci_set_mctrl,
2629         .get_mctrl      = sci_get_mctrl,
2630         .start_tx       = sci_start_tx,
2631         .stop_tx        = sci_stop_tx,
2632         .stop_rx        = sci_stop_rx,
2633         .enable_ms      = sci_enable_ms,
2634         .break_ctl      = sci_break_ctl,
2635         .startup        = sci_startup,
2636         .shutdown       = sci_shutdown,
2637         .flush_buffer   = sci_flush_buffer,
2638         .set_termios    = sci_set_termios,
2639         .pm             = sci_pm,
2640         .type           = sci_type,
2641         .release_port   = sci_release_port,
2642         .request_port   = sci_request_port,
2643         .config_port    = sci_config_port,
2644         .verify_port    = sci_verify_port,
2645 #ifdef CONFIG_CONSOLE_POLL
2646         .poll_get_char  = sci_poll_get_char,
2647         .poll_put_char  = sci_poll_put_char,
2648 #endif
2649 };
2650
2651 static int sci_init_clocks(struct sci_port *sci_port, struct device *dev)
2652 {
2653         const char *clk_names[] = {
2654                 [SCI_FCK] = "fck",
2655                 [SCI_SCK] = "sck",
2656                 [SCI_BRG_INT] = "brg_int",
2657                 [SCI_SCIF_CLK] = "scif_clk",
2658         };
2659         struct clk *clk;
2660         unsigned int i;
2661
2662         if (sci_port->cfg->type == PORT_HSCIF)
2663                 clk_names[SCI_SCK] = "hsck";
2664
2665         for (i = 0; i < SCI_NUM_CLKS; i++) {
2666                 clk = devm_clk_get(dev, clk_names[i]);
2667                 if (PTR_ERR(clk) == -EPROBE_DEFER)
2668                         return -EPROBE_DEFER;
2669
2670                 if (IS_ERR(clk) && i == SCI_FCK) {
2671                         /*
2672                          * "fck" used to be called "sci_ick", and we need to
2673                          * maintain DT backward compatibility.
2674                          */
2675                         clk = devm_clk_get(dev, "sci_ick");
2676                         if (PTR_ERR(clk) == -EPROBE_DEFER)
2677                                 return -EPROBE_DEFER;
2678
2679                         if (!IS_ERR(clk))
2680                                 goto found;
2681
2682                         /*
2683                          * Not all SH platforms declare a clock lookup entry
2684                          * for SCI devices, in which case we need to get the
2685                          * global "peripheral_clk" clock.
2686                          */
2687                         clk = devm_clk_get(dev, "peripheral_clk");
2688                         if (!IS_ERR(clk))
2689                                 goto found;
2690
2691                         dev_err(dev, "failed to get %s (%ld)\n", clk_names[i],
2692                                 PTR_ERR(clk));
2693                         return PTR_ERR(clk);
2694                 }
2695
2696 found:
2697                 if (IS_ERR(clk))
2698                         dev_dbg(dev, "failed to get %s (%ld)\n", clk_names[i],
2699                                 PTR_ERR(clk));
2700                 else
2701                         dev_dbg(dev, "clk %s is %pC rate %lu\n", clk_names[i],
2702                                 clk, clk_get_rate(clk));
2703                 sci_port->clks[i] = IS_ERR(clk) ? NULL : clk;
2704         }
2705         return 0;
2706 }
2707
2708 static const struct sci_port_params *
2709 sci_probe_regmap(const struct plat_sci_port *cfg)
2710 {
2711         unsigned int regtype;
2712
2713         if (cfg->regtype != SCIx_PROBE_REGTYPE)
2714                 return &sci_port_params[cfg->regtype];
2715
2716         switch (cfg->type) {
2717         case PORT_SCI:
2718                 regtype = SCIx_SCI_REGTYPE;
2719                 break;
2720         case PORT_IRDA:
2721                 regtype = SCIx_IRDA_REGTYPE;
2722                 break;
2723         case PORT_SCIFA:
2724                 regtype = SCIx_SCIFA_REGTYPE;
2725                 break;
2726         case PORT_SCIFB:
2727                 regtype = SCIx_SCIFB_REGTYPE;
2728                 break;
2729         case PORT_SCIF:
2730                 /*
2731                  * The SH-4 is a bit of a misnomer here, although that's
2732                  * where this particular port layout originated. This
2733                  * configuration (or some slight variation thereof)
2734                  * remains the dominant model for all SCIFs.
2735                  */
2736                 regtype = SCIx_SH4_SCIF_REGTYPE;
2737                 break;
2738         case PORT_HSCIF:
2739                 regtype = SCIx_HSCIF_REGTYPE;
2740                 break;
2741         default:
2742                 pr_err("Can't probe register map for given port\n");
2743                 return NULL;
2744         }
2745
2746         return &sci_port_params[regtype];
2747 }
2748
2749 static int sci_init_single(struct platform_device *dev,
2750                            struct sci_port *sci_port, unsigned int index,
2751                            const struct plat_sci_port *p, bool early)
2752 {
2753         struct uart_port *port = &sci_port->port;
2754         const struct resource *res;
2755         unsigned int i;
2756         int ret;
2757
2758         sci_port->cfg   = p;
2759
2760         port->ops       = &sci_uart_ops;
2761         port->iotype    = UPIO_MEM;
2762         port->line      = index;
2763
2764         res = platform_get_resource(dev, IORESOURCE_MEM, 0);
2765         if (res == NULL)
2766                 return -ENOMEM;
2767
2768         port->mapbase = res->start;
2769         sci_port->reg_size = resource_size(res);
2770
2771         for (i = 0; i < ARRAY_SIZE(sci_port->irqs); ++i)
2772                 sci_port->irqs[i] = platform_get_irq(dev, i);
2773
2774         /* The SCI generates several interrupts. They can be muxed together or
2775          * connected to different interrupt lines. In the muxed case only one
2776          * interrupt resource is specified. In the non-muxed case three or four
2777          * interrupt resources are specified, as the BRI interrupt is optional.
2778          */
2779         if (sci_port->irqs[0] < 0)
2780                 return -ENXIO;
2781
2782         if (sci_port->irqs[1] < 0) {
2783                 sci_port->irqs[1] = sci_port->irqs[0];
2784                 sci_port->irqs[2] = sci_port->irqs[0];
2785                 sci_port->irqs[3] = sci_port->irqs[0];
2786         }
2787
2788         sci_port->params = sci_probe_regmap(p);
2789         if (unlikely(sci_port->params == NULL))
2790                 return -EINVAL;
2791
2792         switch (p->type) {
2793         case PORT_SCIFB:
2794                 sci_port->rx_trigger = 48;
2795                 break;
2796         case PORT_HSCIF:
2797                 sci_port->rx_trigger = 64;
2798                 break;
2799         case PORT_SCIFA:
2800                 sci_port->rx_trigger = 32;
2801                 break;
2802         case PORT_SCIF:
2803                 if (p->regtype == SCIx_SH7705_SCIF_REGTYPE)
2804                         /* RX triggering not implemented for this IP */
2805                         sci_port->rx_trigger = 1;
2806                 else
2807                         sci_port->rx_trigger = 8;
2808                 break;
2809         default:
2810                 sci_port->rx_trigger = 1;
2811                 break;
2812         }
2813
2814         sci_port->rx_fifo_timeout = 0;
2815
2816         /* SCIFA on sh7723 and sh7724 need a custom sampling rate that doesn't
2817          * match the SoC datasheet, this should be investigated. Let platform
2818          * data override the sampling rate for now.
2819          */
2820         sci_port->sampling_rate_mask = p->sampling_rate
2821                                      ? SCI_SR(p->sampling_rate)
2822                                      : sci_port->params->sampling_rate_mask;
2823
2824         if (!early) {
2825                 ret = sci_init_clocks(sci_port, &dev->dev);
2826                 if (ret < 0)
2827                         return ret;
2828
2829                 port->dev = &dev->dev;
2830
2831                 pm_runtime_enable(&dev->dev);
2832         }
2833
2834         port->type              = p->type;
2835         port->flags             = UPF_FIXED_PORT | UPF_BOOT_AUTOCONF | p->flags;
2836         port->fifosize          = sci_port->params->fifosize;
2837
2838         if (port->type == PORT_SCI) {
2839                 if (sci_port->reg_size >= 0x20)
2840                         port->regshift = 2;
2841                 else
2842                         port->regshift = 1;
2843         }
2844
2845         /*
2846          * The UART port needs an IRQ value, so we peg this to the RX IRQ
2847          * for the multi-IRQ ports, which is where we are primarily
2848          * concerned with the shutdown path synchronization.
2849          *
2850          * For the muxed case there's nothing more to do.
2851          */
2852         port->irq               = sci_port->irqs[SCIx_RXI_IRQ];
2853         port->irqflags          = 0;
2854
2855         port->serial_in         = sci_serial_in;
2856         port->serial_out        = sci_serial_out;
2857
2858         return 0;
2859 }
2860
2861 static void sci_cleanup_single(struct sci_port *port)
2862 {
2863         pm_runtime_disable(port->port.dev);
2864 }
2865
2866 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || \
2867     defined(CONFIG_SERIAL_SH_SCI_EARLYCON)
2868 static void serial_console_putchar(struct uart_port *port, int ch)
2869 {
2870         sci_poll_put_char(port, ch);
2871 }
2872
2873 /*
2874  *      Print a string to the serial port trying not to disturb
2875  *      any possible real use of the port...
2876  */
2877 static void serial_console_write(struct console *co, const char *s,
2878                                  unsigned count)
2879 {
2880         struct sci_port *sci_port = &sci_ports[co->index];
2881         struct uart_port *port = &sci_port->port;
2882         unsigned short bits, ctrl, ctrl_temp;
2883         unsigned long flags;
2884         int locked = 1;
2885
2886 #if defined(SUPPORT_SYSRQ)
2887         if (port->sysrq)
2888                 locked = 0;
2889         else
2890 #endif
2891         if (oops_in_progress)
2892                 locked = spin_trylock_irqsave(&port->lock, flags);
2893         else
2894                 spin_lock_irqsave(&port->lock, flags);
2895
2896         /* first save SCSCR then disable interrupts, keep clock source */
2897         ctrl = serial_port_in(port, SCSCR);
2898         ctrl_temp = SCSCR_RE | SCSCR_TE |
2899                     (sci_port->cfg->scscr & ~(SCSCR_CKE1 | SCSCR_CKE0)) |
2900                     (ctrl & (SCSCR_CKE1 | SCSCR_CKE0));
2901         serial_port_out(port, SCSCR, ctrl_temp);
2902
2903         uart_console_write(port, s, count, serial_console_putchar);
2904
2905         /* wait until fifo is empty and last bit has been transmitted */
2906         bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
2907         while ((serial_port_in(port, SCxSR) & bits) != bits)
2908                 cpu_relax();
2909
2910         /* restore the SCSCR */
2911         serial_port_out(port, SCSCR, ctrl);
2912
2913         if (locked)
2914                 spin_unlock_irqrestore(&port->lock, flags);
2915 }
2916
2917 static int serial_console_setup(struct console *co, char *options)
2918 {
2919         struct sci_port *sci_port;
2920         struct uart_port *port;
2921         int baud = 115200;
2922         int bits = 8;
2923         int parity = 'n';
2924         int flow = 'n';
2925         int ret;
2926
2927         /*
2928          * Refuse to handle any bogus ports.
2929          */
2930         if (co->index < 0 || co->index >= SCI_NPORTS)
2931                 return -ENODEV;
2932
2933         sci_port = &sci_ports[co->index];
2934         port = &sci_port->port;
2935
2936         /*
2937          * Refuse to handle uninitialized ports.
2938          */
2939         if (!port->ops)
2940                 return -ENODEV;
2941
2942         ret = sci_remap_port(port);
2943         if (unlikely(ret != 0))
2944                 return ret;
2945
2946         if (options)
2947                 uart_parse_options(options, &baud, &parity, &bits, &flow);
2948
2949         return uart_set_options(port, co, baud, parity, bits, flow);
2950 }
2951
2952 static struct console serial_console = {
2953         .name           = "ttySC",
2954         .device         = uart_console_device,
2955         .write          = serial_console_write,
2956         .setup          = serial_console_setup,
2957         .flags          = CON_PRINTBUFFER,
2958         .index          = -1,
2959         .data           = &sci_uart_driver,
2960 };
2961
2962 static struct console early_serial_console = {
2963         .name           = "early_ttySC",
2964         .write          = serial_console_write,
2965         .flags          = CON_PRINTBUFFER,
2966         .index          = -1,
2967 };
2968
2969 static char early_serial_buf[32];
2970
2971 static int sci_probe_earlyprintk(struct platform_device *pdev)
2972 {
2973         const struct plat_sci_port *cfg = dev_get_platdata(&pdev->dev);
2974
2975         if (early_serial_console.data)
2976                 return -EEXIST;
2977
2978         early_serial_console.index = pdev->id;
2979
2980         sci_init_single(pdev, &sci_ports[pdev->id], pdev->id, cfg, true);
2981
2982         serial_console_setup(&early_serial_console, early_serial_buf);
2983
2984         if (!strstr(early_serial_buf, "keep"))
2985                 early_serial_console.flags |= CON_BOOT;
2986
2987         register_console(&early_serial_console);
2988         return 0;
2989 }
2990
2991 #define SCI_CONSOLE     (&serial_console)
2992
2993 #else
2994 static inline int sci_probe_earlyprintk(struct platform_device *pdev)
2995 {
2996         return -EINVAL;
2997 }
2998
2999 #define SCI_CONSOLE     NULL
3000
3001 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE || CONFIG_SERIAL_SH_SCI_EARLYCON */
3002
3003 static const char banner[] __initconst = "SuperH (H)SCI(F) driver initialized";
3004
3005 static DEFINE_MUTEX(sci_uart_registration_lock);
3006 static struct uart_driver sci_uart_driver = {
3007         .owner          = THIS_MODULE,
3008         .driver_name    = "sci",
3009         .dev_name       = "ttySC",
3010         .major          = SCI_MAJOR,
3011         .minor          = SCI_MINOR_START,
3012         .nr             = SCI_NPORTS,
3013         .cons           = SCI_CONSOLE,
3014 };
3015
3016 static int sci_remove(struct platform_device *dev)
3017 {
3018         struct sci_port *port = platform_get_drvdata(dev);
3019
3020         uart_remove_one_port(&sci_uart_driver, &port->port);
3021
3022         sci_cleanup_single(port);
3023
3024         if (port->port.fifosize > 1) {
3025                 sysfs_remove_file(&dev->dev.kobj,
3026                                   &dev_attr_rx_fifo_trigger.attr);
3027         }
3028         if (port->port.type == PORT_SCIFA || port->port.type == PORT_SCIFB) {
3029                 sysfs_remove_file(&dev->dev.kobj,
3030                                   &dev_attr_rx_fifo_timeout.attr);
3031         }
3032
3033         return 0;
3034 }
3035
3036
3037 #define SCI_OF_DATA(type, regtype)      (void *)((type) << 16 | (regtype))
3038 #define SCI_OF_TYPE(data)               ((unsigned long)(data) >> 16)
3039 #define SCI_OF_REGTYPE(data)            ((unsigned long)(data) & 0xffff)
3040
3041 static const struct of_device_id of_sci_match[] = {
3042         /* SoC-specific types */
3043         {
3044                 .compatible = "renesas,scif-r7s72100",
3045                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH2_SCIF_FIFODATA_REGTYPE),
3046         },
3047         /* Family-specific types */
3048         {
3049                 .compatible = "renesas,rcar-gen1-scif",
3050                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3051         }, {
3052                 .compatible = "renesas,rcar-gen2-scif",
3053                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3054         }, {
3055                 .compatible = "renesas,rcar-gen3-scif",
3056                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3057         },
3058         /* Generic types */
3059         {
3060                 .compatible = "renesas,scif",
3061                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_REGTYPE),
3062         }, {
3063                 .compatible = "renesas,scifa",
3064                 .data = SCI_OF_DATA(PORT_SCIFA, SCIx_SCIFA_REGTYPE),
3065         }, {
3066                 .compatible = "renesas,scifb",
3067                 .data = SCI_OF_DATA(PORT_SCIFB, SCIx_SCIFB_REGTYPE),
3068         }, {
3069                 .compatible = "renesas,hscif",
3070                 .data = SCI_OF_DATA(PORT_HSCIF, SCIx_HSCIF_REGTYPE),
3071         }, {
3072                 .compatible = "renesas,sci",
3073                 .data = SCI_OF_DATA(PORT_SCI, SCIx_SCI_REGTYPE),
3074         }, {
3075                 /* Terminator */
3076         },
3077 };
3078 MODULE_DEVICE_TABLE(of, of_sci_match);
3079
3080 static struct plat_sci_port *sci_parse_dt(struct platform_device *pdev,
3081                                           unsigned int *dev_id)
3082 {
3083         struct device_node *np = pdev->dev.of_node;
3084         const struct of_device_id *match;
3085         struct plat_sci_port *p;
3086         struct sci_port *sp;
3087         int id;
3088
3089         if (!IS_ENABLED(CONFIG_OF) || !np)
3090                 return NULL;
3091
3092         match = of_match_node(of_sci_match, np);
3093         if (!match)
3094                 return NULL;
3095
3096         p = devm_kzalloc(&pdev->dev, sizeof(struct plat_sci_port), GFP_KERNEL);
3097         if (!p)
3098                 return NULL;
3099
3100         /* Get the line number from the aliases node. */
3101         id = of_alias_get_id(np, "serial");
3102         if (id < 0) {
3103                 dev_err(&pdev->dev, "failed to get alias id (%d)\n", id);
3104                 return NULL;
3105         }
3106         if (id >= ARRAY_SIZE(sci_ports)) {
3107                 dev_err(&pdev->dev, "serial%d out of range\n", id);
3108                 return NULL;
3109         }
3110
3111         sp = &sci_ports[id];
3112         *dev_id = id;
3113
3114         p->type = SCI_OF_TYPE(match->data);
3115         p->regtype = SCI_OF_REGTYPE(match->data);
3116
3117         sp->has_rtscts = of_property_read_bool(np, "uart-has-rtscts");
3118
3119         return p;
3120 }
3121
3122 static int sci_probe_single(struct platform_device *dev,
3123                                       unsigned int index,
3124                                       struct plat_sci_port *p,
3125                                       struct sci_port *sciport)
3126 {
3127         int ret;
3128
3129         /* Sanity check */
3130         if (unlikely(index >= SCI_NPORTS)) {
3131                 dev_notice(&dev->dev, "Attempting to register port %d when only %d are available\n",
3132                            index+1, SCI_NPORTS);
3133                 dev_notice(&dev->dev, "Consider bumping CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
3134                 return -EINVAL;
3135         }
3136
3137         mutex_lock(&sci_uart_registration_lock);
3138         if (!sci_uart_driver.state) {
3139                 ret = uart_register_driver(&sci_uart_driver);
3140                 if (ret) {
3141                         mutex_unlock(&sci_uart_registration_lock);
3142                         return ret;
3143                 }
3144         }
3145         mutex_unlock(&sci_uart_registration_lock);
3146
3147         ret = sci_init_single(dev, sciport, index, p, false);
3148         if (ret)
3149                 return ret;
3150
3151         sciport->gpios = mctrl_gpio_init(&sciport->port, 0);
3152         if (IS_ERR(sciport->gpios) && PTR_ERR(sciport->gpios) != -ENOSYS)
3153                 return PTR_ERR(sciport->gpios);
3154
3155         if (sciport->has_rtscts) {
3156                 if (!IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(sciport->gpios,
3157                                                         UART_GPIO_CTS)) ||
3158                     !IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(sciport->gpios,
3159                                                         UART_GPIO_RTS))) {
3160                         dev_err(&dev->dev, "Conflicting RTS/CTS config\n");
3161                         return -EINVAL;
3162                 }
3163                 sciport->port.flags |= UPF_HARD_FLOW;
3164         }
3165
3166         ret = uart_add_one_port(&sci_uart_driver, &sciport->port);
3167         if (ret) {
3168                 sci_cleanup_single(sciport);
3169                 return ret;
3170         }
3171
3172         return 0;
3173 }
3174
3175 static int sci_probe(struct platform_device *dev)
3176 {
3177         struct plat_sci_port *p;
3178         struct sci_port *sp;
3179         unsigned int dev_id;
3180         int ret;
3181
3182         /*
3183          * If we've come here via earlyprintk initialization, head off to
3184          * the special early probe. We don't have sufficient device state
3185          * to make it beyond this yet.
3186          */
3187         if (is_early_platform_device(dev))
3188                 return sci_probe_earlyprintk(dev);
3189
3190         if (dev->dev.of_node) {
3191                 p = sci_parse_dt(dev, &dev_id);
3192                 if (p == NULL)
3193                         return -EINVAL;
3194         } else {
3195                 p = dev->dev.platform_data;
3196                 if (p == NULL) {
3197                         dev_err(&dev->dev, "no platform data supplied\n");
3198                         return -EINVAL;
3199                 }
3200
3201                 dev_id = dev->id;
3202         }
3203
3204         sp = &sci_ports[dev_id];
3205         platform_set_drvdata(dev, sp);
3206
3207         ret = sci_probe_single(dev, dev_id, p, sp);
3208         if (ret)
3209                 return ret;
3210
3211         if (sp->port.fifosize > 1) {
3212                 ret = sysfs_create_file(&dev->dev.kobj,
3213                                 &dev_attr_rx_fifo_trigger.attr);
3214                 if (ret)
3215                         return ret;
3216         }
3217         if (sp->port.type == PORT_SCIFA || sp->port.type ==  PORT_SCIFB) {
3218                 ret = sysfs_create_file(&dev->dev.kobj,
3219                                 &dev_attr_rx_fifo_timeout.attr);
3220                 if (ret) {
3221                         if (sp->port.fifosize > 1) {
3222                                 sysfs_remove_file(&dev->dev.kobj,
3223                                         &dev_attr_rx_fifo_trigger.attr);
3224                         }
3225                         return ret;
3226                 }
3227         }
3228
3229 #ifdef CONFIG_SH_STANDARD_BIOS
3230         sh_bios_gdb_detach();
3231 #endif
3232
3233         return 0;
3234 }
3235
3236 static __maybe_unused int sci_suspend(struct device *dev)
3237 {
3238         struct sci_port *sport = dev_get_drvdata(dev);
3239
3240         if (sport)
3241                 uart_suspend_port(&sci_uart_driver, &sport->port);
3242
3243         return 0;
3244 }
3245
3246 static __maybe_unused int sci_resume(struct device *dev)
3247 {
3248         struct sci_port *sport = dev_get_drvdata(dev);
3249
3250         if (sport)
3251                 uart_resume_port(&sci_uart_driver, &sport->port);
3252
3253         return 0;
3254 }
3255
3256 static SIMPLE_DEV_PM_OPS(sci_dev_pm_ops, sci_suspend, sci_resume);
3257
3258 static struct platform_driver sci_driver = {
3259         .probe          = sci_probe,
3260         .remove         = sci_remove,
3261         .driver         = {
3262                 .name   = "sh-sci",
3263                 .pm     = &sci_dev_pm_ops,
3264                 .of_match_table = of_match_ptr(of_sci_match),
3265         },
3266 };
3267
3268 static int __init sci_init(void)
3269 {
3270         pr_info("%s\n", banner);
3271
3272         return platform_driver_register(&sci_driver);
3273 }
3274
3275 static void __exit sci_exit(void)
3276 {
3277         platform_driver_unregister(&sci_driver);
3278
3279         if (sci_uart_driver.state)
3280                 uart_unregister_driver(&sci_uart_driver);
3281 }
3282
3283 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
3284 early_platform_init_buffer("earlyprintk", &sci_driver,
3285                            early_serial_buf, ARRAY_SIZE(early_serial_buf));
3286 #endif
3287 #ifdef CONFIG_SERIAL_SH_SCI_EARLYCON
3288 static struct __init plat_sci_port port_cfg;
3289
3290 static int __init early_console_setup(struct earlycon_device *device,
3291                                       int type)
3292 {
3293         if (!device->port.membase)
3294                 return -ENODEV;
3295
3296         device->port.serial_in = sci_serial_in;
3297         device->port.serial_out = sci_serial_out;
3298         device->port.type = type;
3299         memcpy(&sci_ports[0].port, &device->port, sizeof(struct uart_port));
3300         port_cfg.type = type;
3301         sci_ports[0].cfg = &port_cfg;
3302         sci_ports[0].params = sci_probe_regmap(&port_cfg);
3303         port_cfg.scscr = sci_serial_in(&sci_ports[0].port, SCSCR);
3304         sci_serial_out(&sci_ports[0].port, SCSCR,
3305                        SCSCR_RE | SCSCR_TE | port_cfg.scscr);
3306
3307         device->con->write = serial_console_write;
3308         return 0;
3309 }
3310 static int __init sci_early_console_setup(struct earlycon_device *device,
3311                                           const char *opt)
3312 {
3313         return early_console_setup(device, PORT_SCI);
3314 }
3315 static int __init scif_early_console_setup(struct earlycon_device *device,
3316                                           const char *opt)
3317 {
3318         return early_console_setup(device, PORT_SCIF);
3319 }
3320 static int __init scifa_early_console_setup(struct earlycon_device *device,
3321                                           const char *opt)
3322 {
3323         return early_console_setup(device, PORT_SCIFA);
3324 }
3325 static int __init scifb_early_console_setup(struct earlycon_device *device,
3326                                           const char *opt)
3327 {
3328         return early_console_setup(device, PORT_SCIFB);
3329 }
3330 static int __init hscif_early_console_setup(struct earlycon_device *device,
3331                                           const char *opt)
3332 {
3333         return early_console_setup(device, PORT_HSCIF);
3334 }
3335
3336 OF_EARLYCON_DECLARE(sci, "renesas,sci", sci_early_console_setup);
3337 OF_EARLYCON_DECLARE(scif, "renesas,scif", scif_early_console_setup);
3338 OF_EARLYCON_DECLARE(scifa, "renesas,scifa", scifa_early_console_setup);
3339 OF_EARLYCON_DECLARE(scifb, "renesas,scifb", scifb_early_console_setup);
3340 OF_EARLYCON_DECLARE(hscif, "renesas,hscif", hscif_early_console_setup);
3341 #endif /* CONFIG_SERIAL_SH_SCI_EARLYCON */
3342
3343 module_init(sci_init);
3344 module_exit(sci_exit);
3345
3346 MODULE_LICENSE("GPL");
3347 MODULE_ALIAS("platform:sh-sci");
3348 MODULE_AUTHOR("Paul Mundt");
3349 MODULE_DESCRIPTION("SuperH (H)SCI(F) serial driver");