2 * SuperH on-chip serial module support. (SCI with no FIFO / with FIFO)
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).
8 * based off of the old drivers/char/sh-sci.c by:
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).
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
21 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
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>
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>
57 #include <asm/sh_bios.h>
60 #include "serial_mctrl_gpio.h"
63 /* Offsets into the sci_port->irqs array */
71 SCIx_MUX_IRQ = SCIx_NR_IRQS, /* special case */
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))
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 */
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)
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)
96 #define min_sr(_port) ffs((_port)->sampling_rate_mask)
97 #define max_sr(_port) fls((_port)->sampling_rate_mask)
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)))
104 struct plat_sci_reg {
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;
119 struct uart_port port;
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;
129 struct clk *clks[SCI_NUM_CLKS];
130 unsigned long clk_rates[SCI_NUM_CLKS];
132 int irqs[SCIx_NR_IRQS];
133 char *irqstr[SCIx_NR_IRQS];
135 struct dma_chan *chan_tx;
136 struct dma_chan *chan_rx;
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];
147 struct work_struct work_tx;
148 struct timer_list rx_timer;
149 unsigned int rx_timeout;
151 unsigned int rx_frame;
153 struct timer_list rx_fifo_timer;
160 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
162 static struct sci_port sci_ports[SCI_NPORTS];
163 static struct uart_driver sci_uart_driver;
165 static inline struct sci_port *
166 to_sci_port(struct uart_port *uart)
168 return container_of(uart, struct sci_port, port);
171 static const struct sci_port_params sci_port_params[SCIx_NR_REGTYPES] = {
173 * Common SCI definitions, dependent on the port's regshift
176 [SCIx_SCI_REGTYPE] = {
178 [SCSMR] = { 0x00, 8 },
179 [SCBRR] = { 0x01, 8 },
180 [SCSCR] = { 0x02, 8 },
181 [SCxTDR] = { 0x03, 8 },
182 [SCxSR] = { 0x04, 8 },
183 [SCxRDR] = { 0x05, 8 },
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,
194 * Common definitions for legacy IrDA ports.
196 [SCIx_IRDA_REGTYPE] = {
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 },
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,
216 * Common SCIFA definitions.
218 [SCIx_SCIFA_REGTYPE] = {
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 },
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,
240 * Common SCIFB definitions.
242 [SCIx_SCIFB_REGTYPE] = {
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 },
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,
265 * Common SH-2(A) SCIF definitions for ports with FIFO data
268 [SCIx_SH2_SCIF_FIFODATA_REGTYPE] = {
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 },
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,
290 * Common SH-3 SCIF definitions.
292 [SCIx_SH3_SCIF_REGTYPE] = {
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 },
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,
312 * Common SH-4(A) SCIF(B) definitions.
314 [SCIx_SH4_SCIF_REGTYPE] = {
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 },
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,
336 * Common SCIF definitions for ports with a Baud Rate Generator for
337 * External Clock (BRG).
339 [SCIx_SH4_SCIF_BRG_REGTYPE] = {
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 },
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,
363 * Common HSCIF definitions.
365 [SCIx_HSCIF_REGTYPE] = {
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 },
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,
392 * Common SH-4(A) SCIF(B) definitions for ports without an SCSPTR
395 [SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE] = {
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 },
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,
416 * Common SH-4(A) SCIF(B) definitions for ports with FIFO data
419 [SCIx_SH4_SCIF_FIFODATA_REGTYPE] = {
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 },
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,
443 * SH7705-style SCIF(B) ports, lacking both SCSPTR and SCLSR
446 [SCIx_SH7705_SCIF_REGTYPE] = {
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 },
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,
466 #define sci_getreg(up, offset) (&to_sci_port(up)->params->regs[offset])
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.
474 static unsigned int sci_serial_in(struct uart_port *p, int offset)
476 const struct plat_sci_reg *reg = sci_getreg(p, offset);
479 return ioread8(p->membase + (reg->offset << p->regshift));
480 else if (reg->size == 16)
481 return ioread16(p->membase + (reg->offset << p->regshift));
483 WARN(1, "Invalid register access\n");
488 static void sci_serial_out(struct uart_port *p, int offset, int value)
490 const struct plat_sci_reg *reg = sci_getreg(p, offset);
493 iowrite8(value, p->membase + (reg->offset << p->regshift));
494 else if (reg->size == 16)
495 iowrite16(value, p->membase + (reg->offset << p->regshift));
497 WARN(1, "Invalid register access\n");
500 static void sci_port_enable(struct sci_port *sci_port)
504 if (!sci_port->port.dev)
507 pm_runtime_get_sync(sci_port->port.dev);
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]);
513 sci_port->port.uartclk = sci_port->clk_rates[SCI_FCK];
516 static void sci_port_disable(struct sci_port *sci_port)
520 if (!sci_port->port.dev)
523 for (i = SCI_NUM_CLKS; i-- > 0; )
524 clk_disable_unprepare(sci_port->clks[i]);
526 pm_runtime_put_sync(sci_port->port.dev);
529 static inline unsigned long port_rx_irq_mask(struct uart_port *port)
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
538 return SCSCR_RIE | (to_sci_port(port)->cfg->scscr & SCSCR_REIE);
541 static void sci_start_tx(struct uart_port *port)
543 struct sci_port *s = to_sci_port(port);
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);
550 new = scr | SCSCR_TDRQE;
552 new = scr & ~SCSCR_TDRQE;
554 serial_port_out(port, SCSCR, new);
557 if (s->chan_tx && !uart_circ_empty(&s->port.state->xmit) &&
558 dma_submit_error(s->cookie_tx)) {
560 schedule_work(&s->work_tx);
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);
571 static void sci_stop_tx(struct uart_port *port)
575 /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
576 ctrl = serial_port_in(port, SCSCR);
578 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
579 ctrl &= ~SCSCR_TDRQE;
583 serial_port_out(port, SCSCR, ctrl);
586 static void sci_start_rx(struct uart_port *port)
590 ctrl = serial_port_in(port, SCSCR) | port_rx_irq_mask(port);
592 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
593 ctrl &= ~SCSCR_RDRQE;
595 serial_port_out(port, SCSCR, ctrl);
598 static void sci_stop_rx(struct uart_port *port)
602 ctrl = serial_port_in(port, SCSCR);
604 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
605 ctrl &= ~SCSCR_RDRQE;
607 ctrl &= ~port_rx_irq_mask(port);
609 serial_port_out(port, SCSCR, ctrl);
612 static void sci_clear_SCxSR(struct uart_port *port, unsigned int mask)
614 if (port->type == PORT_SCI) {
615 /* Just store the mask */
616 serial_port_out(port, SCxSR, mask);
617 } else if (to_sci_port(port)->params->overrun_mask == SCIFA_ORER) {
618 /* SCIFA/SCIFB and SCIF on SH7705/SH7720/SH7721 */
619 /* Only clear the status bits we want to clear */
620 serial_port_out(port, SCxSR,
621 serial_port_in(port, SCxSR) & mask);
623 /* Store the mask, clear parity/framing errors */
624 serial_port_out(port, SCxSR, mask & ~(SCIF_FERC | SCIF_PERC));
628 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || \
629 defined(CONFIG_SERIAL_SH_SCI_EARLYCON)
631 #ifdef CONFIG_CONSOLE_POLL
632 static int sci_poll_get_char(struct uart_port *port)
634 unsigned short status;
638 status = serial_port_in(port, SCxSR);
639 if (status & SCxSR_ERRORS(port)) {
640 sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
646 if (!(status & SCxSR_RDxF(port)))
649 c = serial_port_in(port, SCxRDR);
652 serial_port_in(port, SCxSR);
653 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
659 static void sci_poll_put_char(struct uart_port *port, unsigned char c)
661 unsigned short status;
664 status = serial_port_in(port, SCxSR);
665 } while (!(status & SCxSR_TDxE(port)));
667 serial_port_out(port, SCxTDR, c);
668 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port) & ~SCxSR_TEND(port));
670 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE ||
671 CONFIG_SERIAL_SH_SCI_EARLYCON */
673 static void sci_init_pins(struct uart_port *port, unsigned int cflag)
675 struct sci_port *s = to_sci_port(port);
678 * Use port-specific handler if provided.
680 if (s->cfg->ops && s->cfg->ops->init_pins) {
681 s->cfg->ops->init_pins(port, cflag);
685 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
686 u16 data = serial_port_in(port, SCPDR);
687 u16 ctrl = serial_port_in(port, SCPCR);
689 /* Enable RXD and TXD pin functions */
690 ctrl &= ~(SCPCR_RXDC | SCPCR_TXDC);
691 if (to_sci_port(port)->has_rtscts) {
692 /* RTS# is output, active low, unless autorts */
693 if (!(port->mctrl & TIOCM_RTS)) {
696 } else if (!s->autorts) {
700 /* Enable RTS# pin function */
703 /* Enable CTS# pin function */
706 serial_port_out(port, SCPDR, data);
707 serial_port_out(port, SCPCR, ctrl);
708 } else if (sci_getreg(port, SCSPTR)->size) {
709 u16 status = serial_port_in(port, SCSPTR);
711 /* RTS# is always output; and active low, unless autorts */
712 status |= SCSPTR_RTSIO;
713 if (!(port->mctrl & TIOCM_RTS))
714 status |= SCSPTR_RTSDT;
715 else if (!s->autorts)
716 status &= ~SCSPTR_RTSDT;
717 /* CTS# and SCK are inputs */
718 status &= ~(SCSPTR_CTSIO | SCSPTR_SCKIO);
719 serial_port_out(port, SCSPTR, status);
723 static int sci_txfill(struct uart_port *port)
725 struct sci_port *s = to_sci_port(port);
726 unsigned int fifo_mask = (s->params->fifosize << 1) - 1;
727 const struct plat_sci_reg *reg;
729 reg = sci_getreg(port, SCTFDR);
731 return serial_port_in(port, SCTFDR) & fifo_mask;
733 reg = sci_getreg(port, SCFDR);
735 return serial_port_in(port, SCFDR) >> 8;
737 return !(serial_port_in(port, SCxSR) & SCI_TDRE);
740 static int sci_txroom(struct uart_port *port)
742 return port->fifosize - sci_txfill(port);
745 static int sci_rxfill(struct uart_port *port)
747 struct sci_port *s = to_sci_port(port);
748 unsigned int fifo_mask = (s->params->fifosize << 1) - 1;
749 const struct plat_sci_reg *reg;
751 reg = sci_getreg(port, SCRFDR);
753 return serial_port_in(port, SCRFDR) & fifo_mask;
755 reg = sci_getreg(port, SCFDR);
757 return serial_port_in(port, SCFDR) & fifo_mask;
759 return (serial_port_in(port, SCxSR) & SCxSR_RDxF(port)) != 0;
762 /* ********************************************************************** *
763 * the interrupt related routines *
764 * ********************************************************************** */
766 static void sci_transmit_chars(struct uart_port *port)
768 struct circ_buf *xmit = &port->state->xmit;
769 unsigned int stopped = uart_tx_stopped(port);
770 unsigned short status;
774 status = serial_port_in(port, SCxSR);
775 if (!(status & SCxSR_TDxE(port))) {
776 ctrl = serial_port_in(port, SCSCR);
777 if (uart_circ_empty(xmit))
781 serial_port_out(port, SCSCR, ctrl);
785 count = sci_txroom(port);
793 } else if (!uart_circ_empty(xmit) && !stopped) {
794 c = xmit->buf[xmit->tail];
795 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
800 serial_port_out(port, SCxTDR, c);
803 } while (--count > 0);
805 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
807 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
808 uart_write_wakeup(port);
809 if (uart_circ_empty(xmit)) {
812 ctrl = serial_port_in(port, SCSCR);
814 if (port->type != PORT_SCI) {
815 serial_port_in(port, SCxSR); /* Dummy read */
816 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
820 serial_port_out(port, SCSCR, ctrl);
824 /* On SH3, SCIF may read end-of-break as a space->mark char */
825 #define STEPFN(c) ({int __c = (c); (((__c-1)|(__c)) == -1); })
827 static void sci_receive_chars(struct uart_port *port)
829 struct tty_port *tport = &port->state->port;
830 int i, count, copied = 0;
831 unsigned short status;
834 status = serial_port_in(port, SCxSR);
835 if (!(status & SCxSR_RDxF(port)))
839 /* Don't copy more bytes than there is room for in the buffer */
840 count = tty_buffer_request_room(tport, sci_rxfill(port));
842 /* If for any reason we can't copy more data, we're done! */
846 if (port->type == PORT_SCI) {
847 char c = serial_port_in(port, SCxRDR);
848 if (uart_handle_sysrq_char(port, c))
851 tty_insert_flip_char(tport, c, TTY_NORMAL);
853 for (i = 0; i < count; i++) {
854 char c = serial_port_in(port, SCxRDR);
856 status = serial_port_in(port, SCxSR);
857 if (uart_handle_sysrq_char(port, c)) {
862 /* Store data and status */
863 if (status & SCxSR_FER(port)) {
865 port->icount.frame++;
866 dev_notice(port->dev, "frame error\n");
867 } else if (status & SCxSR_PER(port)) {
869 port->icount.parity++;
870 dev_notice(port->dev, "parity error\n");
874 tty_insert_flip_char(tport, c, flag);
878 serial_port_in(port, SCxSR); /* dummy read */
879 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
882 port->icount.rx += count;
886 /* Tell the rest of the system the news. New characters! */
887 tty_flip_buffer_push(tport);
889 serial_port_in(port, SCxSR); /* dummy read */
890 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
894 static int sci_handle_errors(struct uart_port *port)
897 unsigned short status = serial_port_in(port, SCxSR);
898 struct tty_port *tport = &port->state->port;
899 struct sci_port *s = to_sci_port(port);
901 /* Handle overruns */
902 if (status & s->params->overrun_mask) {
903 port->icount.overrun++;
906 if (tty_insert_flip_char(tport, 0, TTY_OVERRUN))
909 dev_notice(port->dev, "overrun error\n");
912 if (status & SCxSR_FER(port)) {
914 port->icount.frame++;
916 if (tty_insert_flip_char(tport, 0, TTY_FRAME))
919 dev_notice(port->dev, "frame error\n");
922 if (status & SCxSR_PER(port)) {
924 port->icount.parity++;
926 if (tty_insert_flip_char(tport, 0, TTY_PARITY))
929 dev_notice(port->dev, "parity error\n");
933 tty_flip_buffer_push(tport);
938 static int sci_handle_fifo_overrun(struct uart_port *port)
940 struct tty_port *tport = &port->state->port;
941 struct sci_port *s = to_sci_port(port);
942 const struct plat_sci_reg *reg;
946 reg = sci_getreg(port, s->params->overrun_reg);
950 status = serial_port_in(port, s->params->overrun_reg);
951 if (status & s->params->overrun_mask) {
952 status &= ~s->params->overrun_mask;
953 serial_port_out(port, s->params->overrun_reg, status);
955 port->icount.overrun++;
957 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
958 tty_flip_buffer_push(tport);
960 dev_dbg(port->dev, "overrun error\n");
967 static int sci_handle_breaks(struct uart_port *port)
970 unsigned short status = serial_port_in(port, SCxSR);
971 struct tty_port *tport = &port->state->port;
973 if (uart_handle_break(port))
976 if (status & SCxSR_BRK(port)) {
979 /* Notify of BREAK */
980 if (tty_insert_flip_char(tport, 0, TTY_BREAK))
983 dev_dbg(port->dev, "BREAK detected\n");
987 tty_flip_buffer_push(tport);
989 copied += sci_handle_fifo_overrun(port);
994 static int scif_set_rtrg(struct uart_port *port, int rx_trig)
1000 if (rx_trig >= port->fifosize)
1001 rx_trig = port->fifosize;
1003 /* HSCIF can be set to an arbitrary level. */
1004 if (sci_getreg(port, HSRTRGR)->size) {
1005 serial_port_out(port, HSRTRGR, rx_trig);
1009 switch (port->type) {
1014 } else if (rx_trig < 8) {
1017 } else if (rx_trig < 14) {
1021 bits = SCFCR_RTRG0 | SCFCR_RTRG1;
1030 } else if (rx_trig < 32) {
1033 } else if (rx_trig < 48) {
1037 bits = SCFCR_RTRG0 | SCFCR_RTRG1;
1042 WARN(1, "unknown FIFO configuration");
1046 serial_port_out(port, SCFCR,
1047 (serial_port_in(port, SCFCR) &
1048 ~(SCFCR_RTRG1 | SCFCR_RTRG0)) | bits);
1053 static int scif_rtrg_enabled(struct uart_port *port)
1055 if (sci_getreg(port, HSRTRGR)->size)
1056 return serial_port_in(port, HSRTRGR) != 0;
1058 return (serial_port_in(port, SCFCR) &
1059 (SCFCR_RTRG0 | SCFCR_RTRG1)) != 0;
1062 static void rx_fifo_timer_fn(unsigned long arg)
1064 struct sci_port *s = (struct sci_port *)arg;
1065 struct uart_port *port = &s->port;
1067 dev_dbg(port->dev, "Rx timed out\n");
1068 scif_set_rtrg(port, 1);
1071 static ssize_t rx_trigger_show(struct device *dev,
1072 struct device_attribute *attr,
1075 struct uart_port *port = dev_get_drvdata(dev);
1076 struct sci_port *sci = to_sci_port(port);
1078 return sprintf(buf, "%d\n", sci->rx_trigger);
1081 static ssize_t rx_trigger_store(struct device *dev,
1082 struct device_attribute *attr,
1086 struct uart_port *port = dev_get_drvdata(dev);
1087 struct sci_port *sci = to_sci_port(port);
1091 ret = kstrtol(buf, 0, &r);
1095 sci->rx_trigger = scif_set_rtrg(port, r);
1096 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1097 scif_set_rtrg(port, 1);
1102 static DEVICE_ATTR(rx_fifo_trigger, 0644, rx_trigger_show, rx_trigger_store);
1104 static ssize_t rx_fifo_timeout_show(struct device *dev,
1105 struct device_attribute *attr,
1108 struct uart_port *port = dev_get_drvdata(dev);
1109 struct sci_port *sci = to_sci_port(port);
1111 return sprintf(buf, "%d\n", sci->rx_fifo_timeout);
1114 static ssize_t rx_fifo_timeout_store(struct device *dev,
1115 struct device_attribute *attr,
1119 struct uart_port *port = dev_get_drvdata(dev);
1120 struct sci_port *sci = to_sci_port(port);
1124 ret = kstrtol(buf, 0, &r);
1127 sci->rx_fifo_timeout = r;
1128 scif_set_rtrg(port, 1);
1130 setup_timer(&sci->rx_fifo_timer, rx_fifo_timer_fn,
1131 (unsigned long)sci);
1135 static DEVICE_ATTR(rx_fifo_timeout, 0644, rx_fifo_timeout_show, rx_fifo_timeout_store);
1138 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1139 static void sci_dma_tx_complete(void *arg)
1141 struct sci_port *s = arg;
1142 struct uart_port *port = &s->port;
1143 struct circ_buf *xmit = &port->state->xmit;
1144 unsigned long flags;
1146 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1148 spin_lock_irqsave(&port->lock, flags);
1150 xmit->tail += s->tx_dma_len;
1151 xmit->tail &= UART_XMIT_SIZE - 1;
1153 port->icount.tx += s->tx_dma_len;
1155 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1156 uart_write_wakeup(port);
1158 if (!uart_circ_empty(xmit)) {
1160 schedule_work(&s->work_tx);
1162 s->cookie_tx = -EINVAL;
1163 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1164 u16 ctrl = serial_port_in(port, SCSCR);
1165 serial_port_out(port, SCSCR, ctrl & ~SCSCR_TIE);
1169 spin_unlock_irqrestore(&port->lock, flags);
1172 /* Locking: called with port lock held */
1173 static int sci_dma_rx_push(struct sci_port *s, void *buf, size_t count)
1175 struct uart_port *port = &s->port;
1176 struct tty_port *tport = &port->state->port;
1179 copied = tty_insert_flip_string(tport, buf, count);
1181 port->icount.buf_overrun++;
1183 port->icount.rx += copied;
1188 static int sci_dma_rx_find_active(struct sci_port *s)
1192 for (i = 0; i < ARRAY_SIZE(s->cookie_rx); i++)
1193 if (s->active_rx == s->cookie_rx[i])
1199 static void sci_rx_dma_release(struct sci_port *s, bool enable_pio)
1201 struct dma_chan *chan = s->chan_rx;
1202 struct uart_port *port = &s->port;
1203 unsigned long flags;
1205 spin_lock_irqsave(&port->lock, flags);
1207 s->cookie_rx[0] = s->cookie_rx[1] = -EINVAL;
1208 spin_unlock_irqrestore(&port->lock, flags);
1209 dmaengine_terminate_all(chan);
1210 dma_free_coherent(chan->device->dev, s->buf_len_rx * 2, s->rx_buf[0],
1211 sg_dma_address(&s->sg_rx[0]));
1212 dma_release_channel(chan);
1217 static void sci_dma_rx_complete(void *arg)
1219 struct sci_port *s = arg;
1220 struct dma_chan *chan = s->chan_rx;
1221 struct uart_port *port = &s->port;
1222 struct dma_async_tx_descriptor *desc;
1223 unsigned long flags;
1224 int active, count = 0;
1226 dev_dbg(port->dev, "%s(%d) active cookie %d\n", __func__, port->line,
1229 spin_lock_irqsave(&port->lock, flags);
1231 active = sci_dma_rx_find_active(s);
1233 count = sci_dma_rx_push(s, s->rx_buf[active], s->buf_len_rx);
1235 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1238 tty_flip_buffer_push(&port->state->port);
1240 desc = dmaengine_prep_slave_sg(s->chan_rx, &s->sg_rx[active], 1,
1242 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1246 desc->callback = sci_dma_rx_complete;
1247 desc->callback_param = s;
1248 s->cookie_rx[active] = dmaengine_submit(desc);
1249 if (dma_submit_error(s->cookie_rx[active]))
1252 s->active_rx = s->cookie_rx[!active];
1254 dma_async_issue_pending(chan);
1256 spin_unlock_irqrestore(&port->lock, flags);
1257 dev_dbg(port->dev, "%s: cookie %d #%d, new active cookie %d\n",
1258 __func__, s->cookie_rx[active], active, s->active_rx);
1262 spin_unlock_irqrestore(&port->lock, flags);
1263 dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1264 sci_rx_dma_release(s, true);
1267 static void sci_tx_dma_release(struct sci_port *s, bool enable_pio)
1269 struct dma_chan *chan = s->chan_tx;
1270 struct uart_port *port = &s->port;
1271 unsigned long flags;
1273 spin_lock_irqsave(&port->lock, flags);
1275 s->cookie_tx = -EINVAL;
1276 spin_unlock_irqrestore(&port->lock, flags);
1277 dmaengine_terminate_all(chan);
1278 dma_unmap_single(chan->device->dev, s->tx_dma_addr, UART_XMIT_SIZE,
1280 dma_release_channel(chan);
1285 static void sci_submit_rx(struct sci_port *s)
1287 struct dma_chan *chan = s->chan_rx;
1290 for (i = 0; i < 2; i++) {
1291 struct scatterlist *sg = &s->sg_rx[i];
1292 struct dma_async_tx_descriptor *desc;
1294 desc = dmaengine_prep_slave_sg(chan,
1295 sg, 1, DMA_DEV_TO_MEM,
1296 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1300 desc->callback = sci_dma_rx_complete;
1301 desc->callback_param = s;
1302 s->cookie_rx[i] = dmaengine_submit(desc);
1303 if (dma_submit_error(s->cookie_rx[i]))
1308 s->active_rx = s->cookie_rx[0];
1310 dma_async_issue_pending(chan);
1315 dmaengine_terminate_all(chan);
1316 for (i = 0; i < 2; i++)
1317 s->cookie_rx[i] = -EINVAL;
1318 s->active_rx = -EINVAL;
1319 sci_rx_dma_release(s, true);
1322 static void work_fn_tx(struct work_struct *work)
1324 struct sci_port *s = container_of(work, struct sci_port, work_tx);
1325 struct dma_async_tx_descriptor *desc;
1326 struct dma_chan *chan = s->chan_tx;
1327 struct uart_port *port = &s->port;
1328 struct circ_buf *xmit = &port->state->xmit;
1333 * Port xmit buffer is already mapped, and it is one page... Just adjust
1334 * offsets and lengths. Since it is a circular buffer, we have to
1335 * transmit till the end, and then the rest. Take the port lock to get a
1336 * consistent xmit buffer state.
1338 spin_lock_irq(&port->lock);
1339 buf = s->tx_dma_addr + (xmit->tail & (UART_XMIT_SIZE - 1));
1340 s->tx_dma_len = min_t(unsigned int,
1341 CIRC_CNT(xmit->head, xmit->tail, UART_XMIT_SIZE),
1342 CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE));
1343 spin_unlock_irq(&port->lock);
1345 desc = dmaengine_prep_slave_single(chan, buf, s->tx_dma_len,
1347 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1349 dev_warn(port->dev, "Failed preparing Tx DMA descriptor\n");
1351 sci_tx_dma_release(s, true);
1355 dma_sync_single_for_device(chan->device->dev, buf, s->tx_dma_len,
1358 spin_lock_irq(&port->lock);
1359 desc->callback = sci_dma_tx_complete;
1360 desc->callback_param = s;
1361 spin_unlock_irq(&port->lock);
1362 s->cookie_tx = dmaengine_submit(desc);
1363 if (dma_submit_error(s->cookie_tx)) {
1364 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1366 sci_tx_dma_release(s, true);
1370 dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n",
1371 __func__, xmit->buf, xmit->tail, xmit->head, s->cookie_tx);
1373 dma_async_issue_pending(chan);
1376 static void rx_timer_fn(unsigned long arg)
1378 struct sci_port *s = (struct sci_port *)arg;
1379 struct dma_chan *chan = s->chan_rx;
1380 struct uart_port *port = &s->port;
1381 struct dma_tx_state state;
1382 enum dma_status status;
1383 unsigned long flags;
1388 dev_dbg(port->dev, "DMA Rx timed out\n");
1390 spin_lock_irqsave(&port->lock, flags);
1392 active = sci_dma_rx_find_active(s);
1394 spin_unlock_irqrestore(&port->lock, flags);
1398 status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1399 if (status == DMA_COMPLETE) {
1400 spin_unlock_irqrestore(&port->lock, flags);
1401 dev_dbg(port->dev, "Cookie %d #%d has already completed\n",
1402 s->active_rx, active);
1404 /* Let packet complete handler take care of the packet */
1408 dmaengine_pause(chan);
1411 * sometimes DMA transfer doesn't stop even if it is stopped and
1412 * data keeps on coming until transaction is complete so check
1413 * for DMA_COMPLETE again
1414 * Let packet complete handler take care of the packet
1416 status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1417 if (status == DMA_COMPLETE) {
1418 spin_unlock_irqrestore(&port->lock, flags);
1419 dev_dbg(port->dev, "Transaction complete after DMA engine was stopped");
1423 /* Handle incomplete DMA receive */
1424 dmaengine_terminate_all(s->chan_rx);
1425 read = sg_dma_len(&s->sg_rx[active]) - state.residue;
1428 count = sci_dma_rx_push(s, s->rx_buf[active], read);
1430 tty_flip_buffer_push(&port->state->port);
1433 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1436 /* Direct new serial port interrupts back to CPU */
1437 scr = serial_port_in(port, SCSCR);
1438 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1439 scr &= ~SCSCR_RDRQE;
1440 enable_irq(s->irqs[SCIx_RXI_IRQ]);
1442 serial_port_out(port, SCSCR, scr | SCSCR_RIE);
1444 spin_unlock_irqrestore(&port->lock, flags);
1447 static struct dma_chan *sci_request_dma_chan(struct uart_port *port,
1448 enum dma_transfer_direction dir)
1450 struct dma_chan *chan;
1451 struct dma_slave_config cfg;
1454 chan = dma_request_slave_channel(port->dev,
1455 dir == DMA_MEM_TO_DEV ? "tx" : "rx");
1457 dev_warn(port->dev, "dma_request_slave_channel failed\n");
1461 memset(&cfg, 0, sizeof(cfg));
1462 cfg.direction = dir;
1463 if (dir == DMA_MEM_TO_DEV) {
1464 cfg.dst_addr = port->mapbase +
1465 (sci_getreg(port, SCxTDR)->offset << port->regshift);
1466 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1468 cfg.src_addr = port->mapbase +
1469 (sci_getreg(port, SCxRDR)->offset << port->regshift);
1470 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1473 ret = dmaengine_slave_config(chan, &cfg);
1475 dev_warn(port->dev, "dmaengine_slave_config failed %d\n", ret);
1476 dma_release_channel(chan);
1483 static void sci_request_dma(struct uart_port *port)
1485 struct sci_port *s = to_sci_port(port);
1486 struct dma_chan *chan;
1488 dev_dbg(port->dev, "%s: port %d\n", __func__, port->line);
1490 if (!port->dev->of_node)
1493 s->cookie_tx = -EINVAL;
1494 chan = sci_request_dma_chan(port, DMA_MEM_TO_DEV);
1495 dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1498 /* UART circular tx buffer is an aligned page. */
1499 s->tx_dma_addr = dma_map_single(chan->device->dev,
1500 port->state->xmit.buf,
1503 if (dma_mapping_error(chan->device->dev, s->tx_dma_addr)) {
1504 dev_warn(port->dev, "Failed mapping Tx DMA descriptor\n");
1505 dma_release_channel(chan);
1508 dev_dbg(port->dev, "%s: mapped %lu@%p to %pad\n",
1509 __func__, UART_XMIT_SIZE,
1510 port->state->xmit.buf, &s->tx_dma_addr);
1513 INIT_WORK(&s->work_tx, work_fn_tx);
1516 chan = sci_request_dma_chan(port, DMA_DEV_TO_MEM);
1517 dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1525 s->buf_len_rx = 2 * max_t(size_t, 16, port->fifosize);
1526 buf = dma_alloc_coherent(chan->device->dev, s->buf_len_rx * 2,
1530 "Failed to allocate Rx dma buffer, using PIO\n");
1531 dma_release_channel(chan);
1536 for (i = 0; i < 2; i++) {
1537 struct scatterlist *sg = &s->sg_rx[i];
1539 sg_init_table(sg, 1);
1541 sg_dma_address(sg) = dma;
1542 sg_dma_len(sg) = s->buf_len_rx;
1544 buf += s->buf_len_rx;
1545 dma += s->buf_len_rx;
1548 setup_timer(&s->rx_timer, rx_timer_fn, (unsigned long)s);
1550 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1555 static void sci_free_dma(struct uart_port *port)
1557 struct sci_port *s = to_sci_port(port);
1560 sci_tx_dma_release(s, false);
1562 sci_rx_dma_release(s, false);
1565 static void sci_flush_buffer(struct uart_port *port)
1568 * In uart_flush_buffer(), the xmit circular buffer has just been
1569 * cleared, so we have to reset tx_dma_len accordingly.
1571 to_sci_port(port)->tx_dma_len = 0;
1573 #else /* !CONFIG_SERIAL_SH_SCI_DMA */
1574 static inline void sci_request_dma(struct uart_port *port)
1578 static inline void sci_free_dma(struct uart_port *port)
1582 #define sci_flush_buffer NULL
1583 #endif /* !CONFIG_SERIAL_SH_SCI_DMA */
1585 static irqreturn_t sci_rx_interrupt(int irq, void *ptr)
1587 struct uart_port *port = ptr;
1588 struct sci_port *s = to_sci_port(port);
1590 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1592 u16 scr = serial_port_in(port, SCSCR);
1593 u16 ssr = serial_port_in(port, SCxSR);
1595 /* Disable future Rx interrupts */
1596 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1597 disable_irq_nosync(irq);
1603 serial_port_out(port, SCSCR, scr);
1604 /* Clear current interrupt */
1605 serial_port_out(port, SCxSR,
1606 ssr & ~(SCIF_DR | SCxSR_RDxF(port)));
1607 dev_dbg(port->dev, "Rx IRQ %lu: setup t-out in %u jiffies\n",
1608 jiffies, s->rx_timeout);
1609 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1615 if (s->rx_trigger > 1 && s->rx_fifo_timeout > 0) {
1616 if (!scif_rtrg_enabled(port))
1617 scif_set_rtrg(port, s->rx_trigger);
1619 mod_timer(&s->rx_fifo_timer, jiffies + DIV_ROUND_UP(
1620 s->rx_frame * s->rx_fifo_timeout, 1000));
1623 /* I think sci_receive_chars has to be called irrespective
1624 * of whether the I_IXOFF is set, otherwise, how is the interrupt
1627 sci_receive_chars(ptr);
1632 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
1634 struct uart_port *port = ptr;
1635 unsigned long flags;
1637 spin_lock_irqsave(&port->lock, flags);
1638 sci_transmit_chars(port);
1639 spin_unlock_irqrestore(&port->lock, flags);
1644 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
1646 struct uart_port *port = ptr;
1647 struct sci_port *s = to_sci_port(port);
1650 if (port->type == PORT_SCI) {
1651 if (sci_handle_errors(port)) {
1652 /* discard character in rx buffer */
1653 serial_port_in(port, SCxSR);
1654 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
1657 sci_handle_fifo_overrun(port);
1659 sci_receive_chars(ptr);
1662 sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
1664 /* Kick the transmission */
1666 sci_tx_interrupt(irq, ptr);
1671 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
1673 struct uart_port *port = ptr;
1676 sci_handle_breaks(port);
1677 sci_clear_SCxSR(port, SCxSR_BREAK_CLEAR(port));
1682 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
1684 unsigned short ssr_status, scr_status, err_enabled, orer_status = 0;
1685 struct uart_port *port = ptr;
1686 struct sci_port *s = to_sci_port(port);
1687 irqreturn_t ret = IRQ_NONE;
1689 ssr_status = serial_port_in(port, SCxSR);
1690 scr_status = serial_port_in(port, SCSCR);
1691 if (s->params->overrun_reg == SCxSR)
1692 orer_status = ssr_status;
1693 else if (sci_getreg(port, s->params->overrun_reg)->size)
1694 orer_status = serial_port_in(port, s->params->overrun_reg);
1696 err_enabled = scr_status & port_rx_irq_mask(port);
1699 if ((ssr_status & SCxSR_TDxE(port)) && (scr_status & SCSCR_TIE) &&
1701 ret = sci_tx_interrupt(irq, ptr);
1704 * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
1707 if (((ssr_status & SCxSR_RDxF(port)) || s->chan_rx) &&
1708 (scr_status & SCSCR_RIE))
1709 ret = sci_rx_interrupt(irq, ptr);
1711 /* Error Interrupt */
1712 if ((ssr_status & SCxSR_ERRORS(port)) && err_enabled)
1713 ret = sci_er_interrupt(irq, ptr);
1715 /* Break Interrupt */
1716 if ((ssr_status & SCxSR_BRK(port)) && err_enabled)
1717 ret = sci_br_interrupt(irq, ptr);
1719 /* Overrun Interrupt */
1720 if (orer_status & s->params->overrun_mask) {
1721 sci_handle_fifo_overrun(port);
1728 static const struct sci_irq_desc {
1730 irq_handler_t handler;
1731 } sci_irq_desc[] = {
1733 * Split out handlers, the default case.
1737 .handler = sci_er_interrupt,
1742 .handler = sci_rx_interrupt,
1747 .handler = sci_tx_interrupt,
1752 .handler = sci_br_interrupt,
1756 * Special muxed handler.
1760 .handler = sci_mpxed_interrupt,
1764 static int sci_request_irq(struct sci_port *port)
1766 struct uart_port *up = &port->port;
1769 for (i = j = 0; i < SCIx_NR_IRQS; i++, j++) {
1770 const struct sci_irq_desc *desc;
1773 if (SCIx_IRQ_IS_MUXED(port)) {
1777 irq = port->irqs[i];
1780 * Certain port types won't support all of the
1781 * available interrupt sources.
1783 if (unlikely(irq < 0))
1787 desc = sci_irq_desc + i;
1788 port->irqstr[j] = kasprintf(GFP_KERNEL, "%s:%s",
1789 dev_name(up->dev), desc->desc);
1790 if (!port->irqstr[j]) {
1795 ret = request_irq(irq, desc->handler, up->irqflags,
1796 port->irqstr[j], port);
1797 if (unlikely(ret)) {
1798 dev_err(up->dev, "Can't allocate %s IRQ\n", desc->desc);
1807 free_irq(port->irqs[i], port);
1811 kfree(port->irqstr[j]);
1816 static void sci_free_irq(struct sci_port *port)
1821 * Intentionally in reverse order so we iterate over the muxed
1824 for (i = 0; i < SCIx_NR_IRQS; i++) {
1825 int irq = port->irqs[i];
1828 * Certain port types won't support all of the available
1829 * interrupt sources.
1831 if (unlikely(irq < 0))
1834 free_irq(port->irqs[i], port);
1835 kfree(port->irqstr[i]);
1837 if (SCIx_IRQ_IS_MUXED(port)) {
1838 /* If there's only one IRQ, we're done. */
1844 static unsigned int sci_tx_empty(struct uart_port *port)
1846 unsigned short status = serial_port_in(port, SCxSR);
1847 unsigned short in_tx_fifo = sci_txfill(port);
1849 return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
1852 static void sci_set_rts(struct uart_port *port, bool state)
1854 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1855 u16 data = serial_port_in(port, SCPDR);
1859 data &= ~SCPDR_RTSD;
1862 serial_port_out(port, SCPDR, data);
1864 /* RTS# is output */
1865 serial_port_out(port, SCPCR,
1866 serial_port_in(port, SCPCR) | SCPCR_RTSC);
1867 } else if (sci_getreg(port, SCSPTR)->size) {
1868 u16 ctrl = serial_port_in(port, SCSPTR);
1872 ctrl &= ~SCSPTR_RTSDT;
1874 ctrl |= SCSPTR_RTSDT;
1875 serial_port_out(port, SCSPTR, ctrl);
1879 static bool sci_get_cts(struct uart_port *port)
1881 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1883 return !(serial_port_in(port, SCPDR) & SCPDR_CTSD);
1884 } else if (sci_getreg(port, SCSPTR)->size) {
1886 return !(serial_port_in(port, SCSPTR) & SCSPTR_CTSDT);
1893 * Modem control is a bit of a mixed bag for SCI(F) ports. Generally
1894 * CTS/RTS is supported in hardware by at least one port and controlled
1895 * via SCSPTR (SCxPCR for SCIFA/B parts), or external pins (presently
1896 * handled via the ->init_pins() op, which is a bit of a one-way street,
1897 * lacking any ability to defer pin control -- this will later be
1898 * converted over to the GPIO framework).
1900 * Other modes (such as loopback) are supported generically on certain
1901 * port types, but not others. For these it's sufficient to test for the
1902 * existence of the support register and simply ignore the port type.
1904 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
1906 struct sci_port *s = to_sci_port(port);
1908 if (mctrl & TIOCM_LOOP) {
1909 const struct plat_sci_reg *reg;
1912 * Standard loopback mode for SCFCR ports.
1914 reg = sci_getreg(port, SCFCR);
1916 serial_port_out(port, SCFCR,
1917 serial_port_in(port, SCFCR) |
1921 mctrl_gpio_set(s->gpios, mctrl);
1926 if (!(mctrl & TIOCM_RTS)) {
1927 /* Disable Auto RTS */
1928 serial_port_out(port, SCFCR,
1929 serial_port_in(port, SCFCR) & ~SCFCR_MCE);
1932 sci_set_rts(port, 0);
1933 } else if (s->autorts) {
1934 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1935 /* Enable RTS# pin function */
1936 serial_port_out(port, SCPCR,
1937 serial_port_in(port, SCPCR) & ~SCPCR_RTSC);
1940 /* Enable Auto RTS */
1941 serial_port_out(port, SCFCR,
1942 serial_port_in(port, SCFCR) | SCFCR_MCE);
1945 sci_set_rts(port, 1);
1949 static unsigned int sci_get_mctrl(struct uart_port *port)
1951 struct sci_port *s = to_sci_port(port);
1952 struct mctrl_gpios *gpios = s->gpios;
1953 unsigned int mctrl = 0;
1955 mctrl_gpio_get(gpios, &mctrl);
1958 * CTS/RTS is handled in hardware when supported, while nothing
1962 if (sci_get_cts(port))
1964 } else if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_CTS))) {
1967 if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_DSR)))
1969 if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_DCD)))
1975 static void sci_enable_ms(struct uart_port *port)
1977 mctrl_gpio_enable_ms(to_sci_port(port)->gpios);
1980 static void sci_break_ctl(struct uart_port *port, int break_state)
1982 unsigned short scscr, scsptr;
1984 /* check wheter the port has SCSPTR */
1985 if (!sci_getreg(port, SCSPTR)->size) {
1987 * Not supported by hardware. Most parts couple break and rx
1988 * interrupts together, with break detection always enabled.
1993 scsptr = serial_port_in(port, SCSPTR);
1994 scscr = serial_port_in(port, SCSCR);
1996 if (break_state == -1) {
1997 scsptr = (scsptr | SCSPTR_SPB2IO) & ~SCSPTR_SPB2DT;
2000 scsptr = (scsptr | SCSPTR_SPB2DT) & ~SCSPTR_SPB2IO;
2004 serial_port_out(port, SCSPTR, scsptr);
2005 serial_port_out(port, SCSCR, scscr);
2008 static int sci_startup(struct uart_port *port)
2010 struct sci_port *s = to_sci_port(port);
2013 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
2015 sci_request_dma(port);
2017 ret = sci_request_irq(s);
2018 if (unlikely(ret < 0)) {
2026 static void sci_shutdown(struct uart_port *port)
2028 struct sci_port *s = to_sci_port(port);
2029 unsigned long flags;
2032 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
2035 mctrl_gpio_disable_ms(to_sci_port(port)->gpios);
2037 spin_lock_irqsave(&port->lock, flags);
2040 /* Stop RX and TX, disable related interrupts, keep clock source */
2041 scr = serial_port_in(port, SCSCR);
2042 serial_port_out(port, SCSCR, scr & (SCSCR_CKE1 | SCSCR_CKE0));
2043 spin_unlock_irqrestore(&port->lock, flags);
2045 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2047 dev_dbg(port->dev, "%s(%d) deleting rx_timer\n", __func__,
2049 del_timer_sync(&s->rx_timer);
2057 static int sci_sck_calc(struct sci_port *s, unsigned int bps,
2060 unsigned long freq = s->clk_rates[SCI_SCK];
2061 int err, min_err = INT_MAX;
2064 if (s->port.type != PORT_HSCIF)
2067 for_each_sr(sr, s) {
2068 err = DIV_ROUND_CLOSEST(freq, sr) - bps;
2069 if (abs(err) >= abs(min_err))
2079 dev_dbg(s->port.dev, "SCK: %u%+d bps using SR %u\n", bps, min_err,
2084 static int sci_brg_calc(struct sci_port *s, unsigned int bps,
2085 unsigned long freq, unsigned int *dlr,
2088 int err, min_err = INT_MAX;
2089 unsigned int sr, dl;
2091 if (s->port.type != PORT_HSCIF)
2094 for_each_sr(sr, s) {
2095 dl = DIV_ROUND_CLOSEST(freq, sr * bps);
2096 dl = clamp(dl, 1U, 65535U);
2098 err = DIV_ROUND_CLOSEST(freq, sr * dl) - bps;
2099 if (abs(err) >= abs(min_err))
2110 dev_dbg(s->port.dev, "BRG: %u%+d bps using DL %u SR %u\n", bps,
2111 min_err, *dlr, *srr + 1);
2115 /* calculate sample rate, BRR, and clock select */
2116 static int sci_scbrr_calc(struct sci_port *s, unsigned int bps,
2117 unsigned int *brr, unsigned int *srr,
2120 unsigned long freq = s->clk_rates[SCI_FCK];
2121 unsigned int sr, br, prediv, scrate, c;
2122 int err, min_err = INT_MAX;
2124 if (s->port.type != PORT_HSCIF)
2128 * Find the combination of sample rate and clock select with the
2129 * smallest deviation from the desired baud rate.
2130 * Prefer high sample rates to maximise the receive margin.
2132 * M: Receive margin (%)
2133 * N: Ratio of bit rate to clock (N = sampling rate)
2134 * D: Clock duty (D = 0 to 1.0)
2135 * L: Frame length (L = 9 to 12)
2136 * F: Absolute value of clock frequency deviation
2138 * M = |(0.5 - 1 / 2 * N) - ((L - 0.5) * F) -
2139 * (|D - 0.5| / N * (1 + F))|
2140 * NOTE: Usually, treat D for 0.5, F is 0 by this calculation.
2142 for_each_sr(sr, s) {
2143 for (c = 0; c <= 3; c++) {
2144 /* integerized formulas from HSCIF documentation */
2145 prediv = sr * (1 << (2 * c + 1));
2148 * We need to calculate:
2150 * br = freq / (prediv * bps) clamped to [1..256]
2151 * err = freq / (br * prediv) - bps
2153 * Watch out for overflow when calculating the desired
2154 * sampling clock rate!
2156 if (bps > UINT_MAX / prediv)
2159 scrate = prediv * bps;
2160 br = DIV_ROUND_CLOSEST(freq, scrate);
2161 br = clamp(br, 1U, 256U);
2163 err = DIV_ROUND_CLOSEST(freq, br * prediv) - bps;
2164 if (abs(err) >= abs(min_err))
2178 dev_dbg(s->port.dev, "BRR: %u%+d bps using N %u SR %u cks %u\n", bps,
2179 min_err, *brr, *srr + 1, *cks);
2183 static void sci_reset(struct uart_port *port)
2185 const struct plat_sci_reg *reg;
2186 unsigned int status;
2187 struct sci_port *s = to_sci_port(port);
2189 serial_port_out(port, SCSCR, 0x00); /* TE=0, RE=0, CKE1=0 */
2191 reg = sci_getreg(port, SCFCR);
2193 serial_port_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
2195 sci_clear_SCxSR(port,
2196 SCxSR_RDxF_CLEAR(port) & SCxSR_ERROR_CLEAR(port) &
2197 SCxSR_BREAK_CLEAR(port));
2198 if (sci_getreg(port, SCLSR)->size) {
2199 status = serial_port_in(port, SCLSR);
2200 status &= ~(SCLSR_TO | SCLSR_ORER);
2201 serial_port_out(port, SCLSR, status);
2204 if (s->rx_trigger > 1) {
2205 if (s->rx_fifo_timeout) {
2206 scif_set_rtrg(port, 1);
2207 setup_timer(&s->rx_fifo_timer, rx_fifo_timer_fn,
2210 if (port->type == PORT_SCIFA ||
2211 port->type == PORT_SCIFB)
2212 scif_set_rtrg(port, 1);
2214 scif_set_rtrg(port, s->rx_trigger);
2219 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
2220 struct ktermios *old)
2222 unsigned int baud, smr_val = SCSMR_ASYNC, scr_val = 0, i, bits;
2223 unsigned int brr = 255, cks = 0, srr = 15, dl = 0, sccks = 0;
2224 unsigned int brr1 = 255, cks1 = 0, srr1 = 15, dl1 = 0;
2225 struct sci_port *s = to_sci_port(port);
2226 const struct plat_sci_reg *reg;
2227 int min_err = INT_MAX, err;
2228 unsigned long max_freq = 0;
2231 if ((termios->c_cflag & CSIZE) == CS7)
2232 smr_val |= SCSMR_CHR;
2233 if (termios->c_cflag & PARENB)
2234 smr_val |= SCSMR_PE;
2235 if (termios->c_cflag & PARODD)
2236 smr_val |= SCSMR_PE | SCSMR_ODD;
2237 if (termios->c_cflag & CSTOPB)
2238 smr_val |= SCSMR_STOP;
2241 * earlyprintk comes here early on with port->uartclk set to zero.
2242 * the clock framework is not up and running at this point so here
2243 * we assume that 115200 is the maximum baud rate. please note that
2244 * the baud rate is not programmed during earlyprintk - it is assumed
2245 * that the previous boot loader has enabled required clocks and
2246 * setup the baud rate generator hardware for us already.
2248 if (!port->uartclk) {
2249 baud = uart_get_baud_rate(port, termios, old, 0, 115200);
2253 for (i = 0; i < SCI_NUM_CLKS; i++)
2254 max_freq = max(max_freq, s->clk_rates[i]);
2256 baud = uart_get_baud_rate(port, termios, old, 0, max_freq / min_sr(s));
2261 * There can be multiple sources for the sampling clock. Find the one
2262 * that gives us the smallest deviation from the desired baud rate.
2265 /* Optional Undivided External Clock */
2266 if (s->clk_rates[SCI_SCK] && port->type != PORT_SCIFA &&
2267 port->type != PORT_SCIFB) {
2268 err = sci_sck_calc(s, baud, &srr1);
2269 if (abs(err) < abs(min_err)) {
2271 scr_val = SCSCR_CKE1;
2280 /* Optional BRG Frequency Divided External Clock */
2281 if (s->clk_rates[SCI_SCIF_CLK] && sci_getreg(port, SCDL)->size) {
2282 err = sci_brg_calc(s, baud, s->clk_rates[SCI_SCIF_CLK], &dl1,
2284 if (abs(err) < abs(min_err)) {
2285 best_clk = SCI_SCIF_CLK;
2286 scr_val = SCSCR_CKE1;
2296 /* Optional BRG Frequency Divided Internal Clock */
2297 if (s->clk_rates[SCI_BRG_INT] && sci_getreg(port, SCDL)->size) {
2298 err = sci_brg_calc(s, baud, s->clk_rates[SCI_BRG_INT], &dl1,
2300 if (abs(err) < abs(min_err)) {
2301 best_clk = SCI_BRG_INT;
2302 scr_val = SCSCR_CKE1;
2312 /* Divided Functional Clock using standard Bit Rate Register */
2313 err = sci_scbrr_calc(s, baud, &brr1, &srr1, &cks1);
2314 if (abs(err) < abs(min_err)) {
2325 dev_dbg(port->dev, "Using clk %pC for %u%+d bps\n",
2326 s->clks[best_clk], baud, min_err);
2331 * Program the optional External Baud Rate Generator (BRG) first.
2332 * It controls the mux to select (H)SCK or frequency divided clock.
2334 if (best_clk >= 0 && sci_getreg(port, SCCKS)->size) {
2335 serial_port_out(port, SCDL, dl);
2336 serial_port_out(port, SCCKS, sccks);
2341 uart_update_timeout(port, termios->c_cflag, baud);
2343 if (best_clk >= 0) {
2344 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
2346 case 5: smr_val |= SCSMR_SRC_5; break;
2347 case 7: smr_val |= SCSMR_SRC_7; break;
2348 case 11: smr_val |= SCSMR_SRC_11; break;
2349 case 13: smr_val |= SCSMR_SRC_13; break;
2350 case 16: smr_val |= SCSMR_SRC_16; break;
2351 case 17: smr_val |= SCSMR_SRC_17; break;
2352 case 19: smr_val |= SCSMR_SRC_19; break;
2353 case 27: smr_val |= SCSMR_SRC_27; break;
2357 "SCR 0x%x SMR 0x%x BRR %u CKS 0x%x DL %u SRR %u\n",
2358 scr_val, smr_val, brr, sccks, dl, srr);
2359 serial_port_out(port, SCSCR, scr_val);
2360 serial_port_out(port, SCSMR, smr_val);
2361 serial_port_out(port, SCBRR, brr);
2362 if (sci_getreg(port, HSSRR)->size)
2363 serial_port_out(port, HSSRR, srr | HSCIF_SRE);
2365 /* Wait one bit interval */
2366 udelay((1000000 + (baud - 1)) / baud);
2368 /* Don't touch the bit rate configuration */
2369 scr_val = s->cfg->scscr & (SCSCR_CKE1 | SCSCR_CKE0);
2370 smr_val |= serial_port_in(port, SCSMR) &
2371 (SCSMR_CKEDG | SCSMR_SRC_MASK | SCSMR_CKS);
2372 dev_dbg(port->dev, "SCR 0x%x SMR 0x%x\n", scr_val, smr_val);
2373 serial_port_out(port, SCSCR, scr_val);
2374 serial_port_out(port, SCSMR, smr_val);
2377 sci_init_pins(port, termios->c_cflag);
2379 port->status &= ~UPSTAT_AUTOCTS;
2381 reg = sci_getreg(port, SCFCR);
2383 unsigned short ctrl = serial_port_in(port, SCFCR);
2385 if ((port->flags & UPF_HARD_FLOW) &&
2386 (termios->c_cflag & CRTSCTS)) {
2387 /* There is no CTS interrupt to restart the hardware */
2388 port->status |= UPSTAT_AUTOCTS;
2389 /* MCE is enabled when RTS is raised */
2394 * As we've done a sci_reset() above, ensure we don't
2395 * interfere with the FIFOs while toggling MCE. As the
2396 * reset values could still be set, simply mask them out.
2398 ctrl &= ~(SCFCR_RFRST | SCFCR_TFRST);
2400 serial_port_out(port, SCFCR, ctrl);
2402 if (port->flags & UPF_HARD_FLOW) {
2403 /* Refresh (Auto) RTS */
2404 sci_set_mctrl(port, port->mctrl);
2407 scr_val |= SCSCR_RE | SCSCR_TE |
2408 (s->cfg->scscr & ~(SCSCR_CKE1 | SCSCR_CKE0));
2409 dev_dbg(port->dev, "SCSCR 0x%x\n", scr_val);
2410 serial_port_out(port, SCSCR, scr_val);
2411 if ((srr + 1 == 5) &&
2412 (port->type == PORT_SCIFA || port->type == PORT_SCIFB)) {
2414 * In asynchronous mode, when the sampling rate is 1/5, first
2415 * received data may become invalid on some SCIFA and SCIFB.
2416 * To avoid this problem wait more than 1 serial data time (1
2417 * bit time x serial data number) after setting SCSCR.RE = 1.
2419 udelay(DIV_ROUND_UP(10 * 1000000, baud));
2423 * Calculate delay for 2 DMA buffers (4 FIFO).
2424 * See serial_core.c::uart_update_timeout().
2425 * With 10 bits (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above
2426 * function calculates 1 jiffie for the data plus 5 jiffies for the
2427 * "slop(e)." Then below we calculate 5 jiffies (20ms) for 2 DMA
2428 * buffers (4 FIFO sizes), but when performing a faster transfer, the
2429 * value obtained by this formula is too small. Therefore, if the value
2430 * is smaller than 20ms, use 20ms as the timeout value for DMA.
2432 /* byte size and parity */
2433 switch (termios->c_cflag & CSIZE) {
2448 if (termios->c_cflag & CSTOPB)
2450 if (termios->c_cflag & PARENB)
2453 s->rx_frame = (100 * bits * HZ) / (baud / 10);
2454 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2455 s->rx_timeout = DIV_ROUND_UP(s->buf_len_rx * 2 * s->rx_frame, 1000);
2456 dev_dbg(port->dev, "DMA Rx t-out %ums, tty t-out %u jiffies\n",
2457 s->rx_timeout * 1000 / HZ, port->timeout);
2458 if (s->rx_timeout < msecs_to_jiffies(20))
2459 s->rx_timeout = msecs_to_jiffies(20);
2462 if ((termios->c_cflag & CREAD) != 0)
2465 sci_port_disable(s);
2467 if (UART_ENABLE_MS(port, termios->c_cflag))
2468 sci_enable_ms(port);
2471 static void sci_pm(struct uart_port *port, unsigned int state,
2472 unsigned int oldstate)
2474 struct sci_port *sci_port = to_sci_port(port);
2477 case UART_PM_STATE_OFF:
2478 sci_port_disable(sci_port);
2481 sci_port_enable(sci_port);
2486 static const char *sci_type(struct uart_port *port)
2488 switch (port->type) {
2506 static int sci_remap_port(struct uart_port *port)
2508 struct sci_port *sport = to_sci_port(port);
2511 * Nothing to do if there's already an established membase.
2516 if (port->dev->of_node || (port->flags & UPF_IOREMAP)) {
2517 port->membase = ioremap_nocache(port->mapbase, sport->reg_size);
2518 if (unlikely(!port->membase)) {
2519 dev_err(port->dev, "can't remap port#%d\n", port->line);
2524 * For the simple (and majority of) cases where we don't
2525 * need to do any remapping, just cast the cookie
2528 port->membase = (void __iomem *)(uintptr_t)port->mapbase;
2534 static void sci_release_port(struct uart_port *port)
2536 struct sci_port *sport = to_sci_port(port);
2538 if (port->dev->of_node || (port->flags & UPF_IOREMAP)) {
2539 iounmap(port->membase);
2540 port->membase = NULL;
2543 release_mem_region(port->mapbase, sport->reg_size);
2546 static int sci_request_port(struct uart_port *port)
2548 struct resource *res;
2549 struct sci_port *sport = to_sci_port(port);
2552 res = request_mem_region(port->mapbase, sport->reg_size,
2553 dev_name(port->dev));
2554 if (unlikely(res == NULL)) {
2555 dev_err(port->dev, "request_mem_region failed.");
2559 ret = sci_remap_port(port);
2560 if (unlikely(ret != 0)) {
2561 release_resource(res);
2568 static void sci_config_port(struct uart_port *port, int flags)
2570 if (flags & UART_CONFIG_TYPE) {
2571 struct sci_port *sport = to_sci_port(port);
2573 port->type = sport->cfg->type;
2574 sci_request_port(port);
2578 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
2580 if (ser->baud_base < 2400)
2581 /* No paper tape reader for Mitch.. */
2587 static const struct uart_ops sci_uart_ops = {
2588 .tx_empty = sci_tx_empty,
2589 .set_mctrl = sci_set_mctrl,
2590 .get_mctrl = sci_get_mctrl,
2591 .start_tx = sci_start_tx,
2592 .stop_tx = sci_stop_tx,
2593 .stop_rx = sci_stop_rx,
2594 .enable_ms = sci_enable_ms,
2595 .break_ctl = sci_break_ctl,
2596 .startup = sci_startup,
2597 .shutdown = sci_shutdown,
2598 .flush_buffer = sci_flush_buffer,
2599 .set_termios = sci_set_termios,
2602 .release_port = sci_release_port,
2603 .request_port = sci_request_port,
2604 .config_port = sci_config_port,
2605 .verify_port = sci_verify_port,
2606 #ifdef CONFIG_CONSOLE_POLL
2607 .poll_get_char = sci_poll_get_char,
2608 .poll_put_char = sci_poll_put_char,
2612 static int sci_init_clocks(struct sci_port *sci_port, struct device *dev)
2614 const char *clk_names[] = {
2617 [SCI_BRG_INT] = "brg_int",
2618 [SCI_SCIF_CLK] = "scif_clk",
2623 if (sci_port->cfg->type == PORT_HSCIF)
2624 clk_names[SCI_SCK] = "hsck";
2626 for (i = 0; i < SCI_NUM_CLKS; i++) {
2627 clk = devm_clk_get(dev, clk_names[i]);
2628 if (PTR_ERR(clk) == -EPROBE_DEFER)
2629 return -EPROBE_DEFER;
2631 if (IS_ERR(clk) && i == SCI_FCK) {
2633 * "fck" used to be called "sci_ick", and we need to
2634 * maintain DT backward compatibility.
2636 clk = devm_clk_get(dev, "sci_ick");
2637 if (PTR_ERR(clk) == -EPROBE_DEFER)
2638 return -EPROBE_DEFER;
2644 * Not all SH platforms declare a clock lookup entry
2645 * for SCI devices, in which case we need to get the
2646 * global "peripheral_clk" clock.
2648 clk = devm_clk_get(dev, "peripheral_clk");
2652 dev_err(dev, "failed to get %s (%ld)\n", clk_names[i],
2654 return PTR_ERR(clk);
2659 dev_dbg(dev, "failed to get %s (%ld)\n", clk_names[i],
2662 dev_dbg(dev, "clk %s is %pC rate %pCr\n", clk_names[i],
2664 sci_port->clks[i] = IS_ERR(clk) ? NULL : clk;
2669 static const struct sci_port_params *
2670 sci_probe_regmap(const struct plat_sci_port *cfg)
2672 unsigned int regtype;
2674 if (cfg->regtype != SCIx_PROBE_REGTYPE)
2675 return &sci_port_params[cfg->regtype];
2677 switch (cfg->type) {
2679 regtype = SCIx_SCI_REGTYPE;
2682 regtype = SCIx_IRDA_REGTYPE;
2685 regtype = SCIx_SCIFA_REGTYPE;
2688 regtype = SCIx_SCIFB_REGTYPE;
2692 * The SH-4 is a bit of a misnomer here, although that's
2693 * where this particular port layout originated. This
2694 * configuration (or some slight variation thereof)
2695 * remains the dominant model for all SCIFs.
2697 regtype = SCIx_SH4_SCIF_REGTYPE;
2700 regtype = SCIx_HSCIF_REGTYPE;
2703 pr_err("Can't probe register map for given port\n");
2707 return &sci_port_params[regtype];
2710 static int sci_init_single(struct platform_device *dev,
2711 struct sci_port *sci_port, unsigned int index,
2712 const struct plat_sci_port *p, bool early)
2714 struct uart_port *port = &sci_port->port;
2715 const struct resource *res;
2721 port->ops = &sci_uart_ops;
2722 port->iotype = UPIO_MEM;
2725 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
2729 port->mapbase = res->start;
2730 sci_port->reg_size = resource_size(res);
2732 for (i = 0; i < ARRAY_SIZE(sci_port->irqs); ++i)
2733 sci_port->irqs[i] = platform_get_irq(dev, i);
2735 /* The SCI generates several interrupts. They can be muxed together or
2736 * connected to different interrupt lines. In the muxed case only one
2737 * interrupt resource is specified. In the non-muxed case three or four
2738 * interrupt resources are specified, as the BRI interrupt is optional.
2740 if (sci_port->irqs[0] < 0)
2743 if (sci_port->irqs[1] < 0) {
2744 sci_port->irqs[1] = sci_port->irqs[0];
2745 sci_port->irqs[2] = sci_port->irqs[0];
2746 sci_port->irqs[3] = sci_port->irqs[0];
2749 sci_port->params = sci_probe_regmap(p);
2750 if (unlikely(sci_port->params == NULL))
2755 sci_port->rx_trigger = 48;
2758 sci_port->rx_trigger = 64;
2761 sci_port->rx_trigger = 32;
2764 if (p->regtype == SCIx_SH7705_SCIF_REGTYPE)
2765 /* RX triggering not implemented for this IP */
2766 sci_port->rx_trigger = 1;
2768 sci_port->rx_trigger = 8;
2771 sci_port->rx_trigger = 1;
2775 sci_port->rx_fifo_timeout = 0;
2777 /* SCIFA on sh7723 and sh7724 need a custom sampling rate that doesn't
2778 * match the SoC datasheet, this should be investigated. Let platform
2779 * data override the sampling rate for now.
2781 sci_port->sampling_rate_mask = p->sampling_rate
2782 ? SCI_SR(p->sampling_rate)
2783 : sci_port->params->sampling_rate_mask;
2786 ret = sci_init_clocks(sci_port, &dev->dev);
2790 port->dev = &dev->dev;
2792 pm_runtime_enable(&dev->dev);
2795 port->type = p->type;
2796 port->flags = UPF_FIXED_PORT | UPF_BOOT_AUTOCONF | p->flags;
2797 port->fifosize = sci_port->params->fifosize;
2799 if (port->type == PORT_SCI) {
2800 if (sci_port->reg_size >= 0x20)
2807 * The UART port needs an IRQ value, so we peg this to the RX IRQ
2808 * for the multi-IRQ ports, which is where we are primarily
2809 * concerned with the shutdown path synchronization.
2811 * For the muxed case there's nothing more to do.
2813 port->irq = sci_port->irqs[SCIx_RXI_IRQ];
2816 port->serial_in = sci_serial_in;
2817 port->serial_out = sci_serial_out;
2822 static void sci_cleanup_single(struct sci_port *port)
2824 pm_runtime_disable(port->port.dev);
2827 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || \
2828 defined(CONFIG_SERIAL_SH_SCI_EARLYCON)
2829 static void serial_console_putchar(struct uart_port *port, int ch)
2831 sci_poll_put_char(port, ch);
2835 * Print a string to the serial port trying not to disturb
2836 * any possible real use of the port...
2838 static void serial_console_write(struct console *co, const char *s,
2841 struct sci_port *sci_port = &sci_ports[co->index];
2842 struct uart_port *port = &sci_port->port;
2843 unsigned short bits, ctrl, ctrl_temp;
2844 unsigned long flags;
2847 local_irq_save(flags);
2848 #if defined(SUPPORT_SYSRQ)
2853 if (oops_in_progress)
2854 locked = spin_trylock(&port->lock);
2856 spin_lock(&port->lock);
2858 /* first save SCSCR then disable interrupts, keep clock source */
2859 ctrl = serial_port_in(port, SCSCR);
2860 ctrl_temp = SCSCR_RE | SCSCR_TE |
2861 (sci_port->cfg->scscr & ~(SCSCR_CKE1 | SCSCR_CKE0)) |
2862 (ctrl & (SCSCR_CKE1 | SCSCR_CKE0));
2863 serial_port_out(port, SCSCR, ctrl_temp);
2865 uart_console_write(port, s, count, serial_console_putchar);
2867 /* wait until fifo is empty and last bit has been transmitted */
2868 bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
2869 while ((serial_port_in(port, SCxSR) & bits) != bits)
2872 /* restore the SCSCR */
2873 serial_port_out(port, SCSCR, ctrl);
2876 spin_unlock(&port->lock);
2877 local_irq_restore(flags);
2880 static int serial_console_setup(struct console *co, char *options)
2882 struct sci_port *sci_port;
2883 struct uart_port *port;
2891 * Refuse to handle any bogus ports.
2893 if (co->index < 0 || co->index >= SCI_NPORTS)
2896 sci_port = &sci_ports[co->index];
2897 port = &sci_port->port;
2900 * Refuse to handle uninitialized ports.
2905 ret = sci_remap_port(port);
2906 if (unlikely(ret != 0))
2910 uart_parse_options(options, &baud, &parity, &bits, &flow);
2912 return uart_set_options(port, co, baud, parity, bits, flow);
2915 static struct console serial_console = {
2917 .device = uart_console_device,
2918 .write = serial_console_write,
2919 .setup = serial_console_setup,
2920 .flags = CON_PRINTBUFFER,
2922 .data = &sci_uart_driver,
2925 static struct console early_serial_console = {
2926 .name = "early_ttySC",
2927 .write = serial_console_write,
2928 .flags = CON_PRINTBUFFER,
2932 static char early_serial_buf[32];
2934 static int sci_probe_earlyprintk(struct platform_device *pdev)
2936 const struct plat_sci_port *cfg = dev_get_platdata(&pdev->dev);
2938 if (early_serial_console.data)
2941 early_serial_console.index = pdev->id;
2943 sci_init_single(pdev, &sci_ports[pdev->id], pdev->id, cfg, true);
2945 serial_console_setup(&early_serial_console, early_serial_buf);
2947 if (!strstr(early_serial_buf, "keep"))
2948 early_serial_console.flags |= CON_BOOT;
2950 register_console(&early_serial_console);
2954 #define SCI_CONSOLE (&serial_console)
2957 static inline int sci_probe_earlyprintk(struct platform_device *pdev)
2962 #define SCI_CONSOLE NULL
2964 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE || CONFIG_SERIAL_SH_SCI_EARLYCON */
2966 static const char banner[] __initconst = "SuperH (H)SCI(F) driver initialized";
2968 static DEFINE_MUTEX(sci_uart_registration_lock);
2969 static struct uart_driver sci_uart_driver = {
2970 .owner = THIS_MODULE,
2971 .driver_name = "sci",
2972 .dev_name = "ttySC",
2974 .minor = SCI_MINOR_START,
2976 .cons = SCI_CONSOLE,
2979 static int sci_remove(struct platform_device *dev)
2981 struct sci_port *port = platform_get_drvdata(dev);
2983 uart_remove_one_port(&sci_uart_driver, &port->port);
2985 sci_cleanup_single(port);
2987 if (port->port.fifosize > 1) {
2988 sysfs_remove_file(&dev->dev.kobj,
2989 &dev_attr_rx_fifo_trigger.attr);
2991 if (port->port.type == PORT_SCIFA || port->port.type == PORT_SCIFB) {
2992 sysfs_remove_file(&dev->dev.kobj,
2993 &dev_attr_rx_fifo_timeout.attr);
3000 #define SCI_OF_DATA(type, regtype) (void *)((type) << 16 | (regtype))
3001 #define SCI_OF_TYPE(data) ((unsigned long)(data) >> 16)
3002 #define SCI_OF_REGTYPE(data) ((unsigned long)(data) & 0xffff)
3004 static const struct of_device_id of_sci_match[] = {
3005 /* SoC-specific types */
3007 .compatible = "renesas,scif-r7s72100",
3008 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH2_SCIF_FIFODATA_REGTYPE),
3010 /* Family-specific types */
3012 .compatible = "renesas,rcar-gen1-scif",
3013 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3015 .compatible = "renesas,rcar-gen2-scif",
3016 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3018 .compatible = "renesas,rcar-gen3-scif",
3019 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3023 .compatible = "renesas,scif",
3024 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_REGTYPE),
3026 .compatible = "renesas,scifa",
3027 .data = SCI_OF_DATA(PORT_SCIFA, SCIx_SCIFA_REGTYPE),
3029 .compatible = "renesas,scifb",
3030 .data = SCI_OF_DATA(PORT_SCIFB, SCIx_SCIFB_REGTYPE),
3032 .compatible = "renesas,hscif",
3033 .data = SCI_OF_DATA(PORT_HSCIF, SCIx_HSCIF_REGTYPE),
3035 .compatible = "renesas,sci",
3036 .data = SCI_OF_DATA(PORT_SCI, SCIx_SCI_REGTYPE),
3041 MODULE_DEVICE_TABLE(of, of_sci_match);
3043 static struct plat_sci_port *sci_parse_dt(struct platform_device *pdev,
3044 unsigned int *dev_id)
3046 struct device_node *np = pdev->dev.of_node;
3047 const struct of_device_id *match;
3048 struct plat_sci_port *p;
3049 struct sci_port *sp;
3052 if (!IS_ENABLED(CONFIG_OF) || !np)
3055 match = of_match_node(of_sci_match, np);
3059 p = devm_kzalloc(&pdev->dev, sizeof(struct plat_sci_port), GFP_KERNEL);
3063 /* Get the line number from the aliases node. */
3064 id = of_alias_get_id(np, "serial");
3066 dev_err(&pdev->dev, "failed to get alias id (%d)\n", id);
3070 sp = &sci_ports[id];
3073 p->type = SCI_OF_TYPE(match->data);
3074 p->regtype = SCI_OF_REGTYPE(match->data);
3076 if (of_find_property(np, "uart-has-rtscts", NULL))
3077 sp->has_rtscts = true;
3082 static int sci_probe_single(struct platform_device *dev,
3084 struct plat_sci_port *p,
3085 struct sci_port *sciport)
3090 if (unlikely(index >= SCI_NPORTS)) {
3091 dev_notice(&dev->dev, "Attempting to register port %d when only %d are available\n",
3092 index+1, SCI_NPORTS);
3093 dev_notice(&dev->dev, "Consider bumping CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
3097 mutex_lock(&sci_uart_registration_lock);
3098 if (!sci_uart_driver.state) {
3099 ret = uart_register_driver(&sci_uart_driver);
3101 mutex_unlock(&sci_uart_registration_lock);
3105 mutex_unlock(&sci_uart_registration_lock);
3107 ret = sci_init_single(dev, sciport, index, p, false);
3111 sciport->gpios = mctrl_gpio_init(&sciport->port, 0);
3112 if (IS_ERR(sciport->gpios) && PTR_ERR(sciport->gpios) != -ENOSYS)
3113 return PTR_ERR(sciport->gpios);
3115 if (sciport->has_rtscts) {
3116 if (!IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(sciport->gpios,
3118 !IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(sciport->gpios,
3120 dev_err(&dev->dev, "Conflicting RTS/CTS config\n");
3123 sciport->port.flags |= UPF_HARD_FLOW;
3126 ret = uart_add_one_port(&sci_uart_driver, &sciport->port);
3128 sci_cleanup_single(sciport);
3135 static int sci_probe(struct platform_device *dev)
3137 struct plat_sci_port *p;
3138 struct sci_port *sp;
3139 unsigned int dev_id;
3143 * If we've come here via earlyprintk initialization, head off to
3144 * the special early probe. We don't have sufficient device state
3145 * to make it beyond this yet.
3147 if (is_early_platform_device(dev))
3148 return sci_probe_earlyprintk(dev);
3150 if (dev->dev.of_node) {
3151 p = sci_parse_dt(dev, &dev_id);
3155 p = dev->dev.platform_data;
3157 dev_err(&dev->dev, "no platform data supplied\n");
3164 sp = &sci_ports[dev_id];
3165 platform_set_drvdata(dev, sp);
3167 ret = sci_probe_single(dev, dev_id, p, sp);
3171 if (sp->port.fifosize > 1) {
3172 ret = sysfs_create_file(&dev->dev.kobj,
3173 &dev_attr_rx_fifo_trigger.attr);
3177 if (sp->port.type == PORT_SCIFA || sp->port.type == PORT_SCIFB) {
3178 ret = sysfs_create_file(&dev->dev.kobj,
3179 &dev_attr_rx_fifo_timeout.attr);
3181 if (sp->port.fifosize > 1) {
3182 sysfs_remove_file(&dev->dev.kobj,
3183 &dev_attr_rx_fifo_trigger.attr);
3189 #ifdef CONFIG_SH_STANDARD_BIOS
3190 sh_bios_gdb_detach();
3196 static __maybe_unused int sci_suspend(struct device *dev)
3198 struct sci_port *sport = dev_get_drvdata(dev);
3201 uart_suspend_port(&sci_uart_driver, &sport->port);
3206 static __maybe_unused int sci_resume(struct device *dev)
3208 struct sci_port *sport = dev_get_drvdata(dev);
3211 uart_resume_port(&sci_uart_driver, &sport->port);
3216 static SIMPLE_DEV_PM_OPS(sci_dev_pm_ops, sci_suspend, sci_resume);
3218 static struct platform_driver sci_driver = {
3220 .remove = sci_remove,
3223 .pm = &sci_dev_pm_ops,
3224 .of_match_table = of_match_ptr(of_sci_match),
3228 static int __init sci_init(void)
3230 pr_info("%s\n", banner);
3232 return platform_driver_register(&sci_driver);
3235 static void __exit sci_exit(void)
3237 platform_driver_unregister(&sci_driver);
3239 if (sci_uart_driver.state)
3240 uart_unregister_driver(&sci_uart_driver);
3243 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
3244 early_platform_init_buffer("earlyprintk", &sci_driver,
3245 early_serial_buf, ARRAY_SIZE(early_serial_buf));
3247 #ifdef CONFIG_SERIAL_SH_SCI_EARLYCON
3248 static struct __init plat_sci_port port_cfg;
3250 static int __init early_console_setup(struct earlycon_device *device,
3253 if (!device->port.membase)
3256 device->port.serial_in = sci_serial_in;
3257 device->port.serial_out = sci_serial_out;
3258 device->port.type = type;
3259 memcpy(&sci_ports[0].port, &device->port, sizeof(struct uart_port));
3260 port_cfg.type = type;
3261 sci_ports[0].cfg = &port_cfg;
3262 sci_ports[0].params = sci_probe_regmap(&port_cfg);
3263 port_cfg.scscr = sci_serial_in(&sci_ports[0].port, SCSCR);
3264 sci_serial_out(&sci_ports[0].port, SCSCR,
3265 SCSCR_RE | SCSCR_TE | port_cfg.scscr);
3267 device->con->write = serial_console_write;
3270 static int __init sci_early_console_setup(struct earlycon_device *device,
3273 return early_console_setup(device, PORT_SCI);
3275 static int __init scif_early_console_setup(struct earlycon_device *device,
3278 return early_console_setup(device, PORT_SCIF);
3280 static int __init scifa_early_console_setup(struct earlycon_device *device,
3283 return early_console_setup(device, PORT_SCIFA);
3285 static int __init scifb_early_console_setup(struct earlycon_device *device,
3288 return early_console_setup(device, PORT_SCIFB);
3290 static int __init hscif_early_console_setup(struct earlycon_device *device,
3293 return early_console_setup(device, PORT_HSCIF);
3296 OF_EARLYCON_DECLARE(sci, "renesas,sci", sci_early_console_setup);
3297 OF_EARLYCON_DECLARE(scif, "renesas,scif", scif_early_console_setup);
3298 OF_EARLYCON_DECLARE(scifa, "renesas,scifa", scifa_early_console_setup);
3299 OF_EARLYCON_DECLARE(scifb, "renesas,scifb", scifb_early_console_setup);
3300 OF_EARLYCON_DECLARE(hscif, "renesas,hscif", hscif_early_console_setup);
3301 #endif /* CONFIG_SERIAL_SH_SCI_EARLYCON */
3303 module_init(sci_init);
3304 module_exit(sci_exit);
3306 MODULE_LICENSE("GPL");
3307 MODULE_ALIAS("platform:sh-sci");
3308 MODULE_AUTHOR("Paul Mundt");
3309 MODULE_DESCRIPTION("SuperH (H)SCI(F) serial driver");