2 * SuperH on-chip serial module support. (SCI with no FIFO / with FIFO)
4 * Copyright (C) 2002 - 2011 Paul Mundt
5 * Modified to support SH7720 SCIF. Markus Brunner, Mark Jonas (Jul 2007).
7 * based off of the old drivers/char/sh-sci.c by:
9 * Copyright (C) 1999, 2000 Niibe Yutaka
10 * Copyright (C) 2000 Sugioka Toshinobu
11 * Modified to support multiple serial ports. Stuart Menefy (May 2000).
12 * Modified to support SecureEdge. David McCullough (2002)
13 * Modified to support SH7300 SCIF. Takashi Kusuda (Jun 2003).
14 * Removed SH7300 support (Jul 2007).
16 * This file is subject to the terms and conditions of the GNU General Public
17 * License. See the file "COPYING" in the main directory of this archive
20 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
26 #include <linux/clk.h>
27 #include <linux/console.h>
28 #include <linux/ctype.h>
29 #include <linux/cpufreq.h>
30 #include <linux/delay.h>
31 #include <linux/dmaengine.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/err.h>
34 #include <linux/errno.h>
35 #include <linux/init.h>
36 #include <linux/interrupt.h>
37 #include <linux/ioport.h>
38 #include <linux/major.h>
39 #include <linux/module.h>
42 #include <linux/platform_device.h>
43 #include <linux/pm_runtime.h>
44 #include <linux/scatterlist.h>
45 #include <linux/serial.h>
46 #include <linux/serial_sci.h>
47 #include <linux/sh_dma.h>
48 #include <linux/slab.h>
49 #include <linux/string.h>
50 #include <linux/sysrq.h>
51 #include <linux/timer.h>
52 #include <linux/tty.h>
53 #include <linux/tty_flip.h>
56 #include <asm/sh_bios.h>
61 /* Offsets into the sci_port->irqs array */
69 SCIx_MUX_IRQ = SCIx_NR_IRQS, /* special case */
72 #define SCIx_IRQ_IS_MUXED(port) \
73 ((port)->irqs[SCIx_ERI_IRQ] == \
74 (port)->irqs[SCIx_RXI_IRQ]) || \
75 ((port)->irqs[SCIx_ERI_IRQ] && \
76 ((port)->irqs[SCIx_RXI_IRQ] < 0))
79 struct uart_port port;
81 /* Platform configuration */
82 struct plat_sci_port *cfg;
83 unsigned int overrun_reg;
84 unsigned int overrun_mask;
85 unsigned int error_mask;
86 unsigned int error_clear;
87 unsigned int sampling_rate;
88 resource_size_t reg_size;
91 struct timer_list break_timer;
99 int irqs[SCIx_NR_IRQS];
100 char *irqstr[SCIx_NR_IRQS];
102 struct dma_chan *chan_tx;
103 struct dma_chan *chan_rx;
105 #ifdef CONFIG_SERIAL_SH_SCI_DMA
106 dma_cookie_t cookie_tx;
107 dma_cookie_t cookie_rx[2];
108 dma_cookie_t active_rx;
109 dma_addr_t tx_dma_addr;
110 unsigned int tx_dma_len;
111 struct scatterlist sg_rx[2];
114 struct work_struct work_tx;
115 struct timer_list rx_timer;
116 unsigned int rx_timeout;
120 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
122 static struct sci_port sci_ports[SCI_NPORTS];
123 static struct uart_driver sci_uart_driver;
125 static inline struct sci_port *
126 to_sci_port(struct uart_port *uart)
128 return container_of(uart, struct sci_port, port);
131 struct plat_sci_reg {
135 /* Helper for invalidating specific entries of an inherited map. */
136 #define sci_reg_invalid { .offset = 0, .size = 0 }
138 static const struct plat_sci_reg sci_regmap[SCIx_NR_REGTYPES][SCIx_NR_REGS] = {
139 [SCIx_PROBE_REGTYPE] = {
140 [0 ... SCIx_NR_REGS - 1] = sci_reg_invalid,
144 * Common SCI definitions, dependent on the port's regshift
147 [SCIx_SCI_REGTYPE] = {
148 [SCSMR] = { 0x00, 8 },
149 [SCBRR] = { 0x01, 8 },
150 [SCSCR] = { 0x02, 8 },
151 [SCxTDR] = { 0x03, 8 },
152 [SCxSR] = { 0x04, 8 },
153 [SCxRDR] = { 0x05, 8 },
154 [SCFCR] = sci_reg_invalid,
155 [SCFDR] = sci_reg_invalid,
156 [SCTFDR] = sci_reg_invalid,
157 [SCRFDR] = sci_reg_invalid,
158 [SCSPTR] = sci_reg_invalid,
159 [SCLSR] = sci_reg_invalid,
160 [HSSRR] = sci_reg_invalid,
161 [SCPCR] = sci_reg_invalid,
162 [SCPDR] = sci_reg_invalid,
166 * Common definitions for legacy IrDA ports.
168 [SCIx_IRDA_REGTYPE] = {
169 [SCSMR] = { 0x00, 8 },
170 [SCBRR] = { 0x02, 8 },
171 [SCSCR] = { 0x04, 8 },
172 [SCxTDR] = { 0x06, 8 },
173 [SCxSR] = { 0x08, 16 },
174 [SCxRDR] = { 0x0a, 8 },
175 [SCFCR] = { 0x0c, 8 },
176 [SCFDR] = { 0x0e, 16 },
177 [SCTFDR] = sci_reg_invalid,
178 [SCRFDR] = sci_reg_invalid,
179 [SCSPTR] = sci_reg_invalid,
180 [SCLSR] = sci_reg_invalid,
181 [HSSRR] = sci_reg_invalid,
182 [SCPCR] = sci_reg_invalid,
183 [SCPDR] = sci_reg_invalid,
187 * Common SCIFA definitions.
189 [SCIx_SCIFA_REGTYPE] = {
190 [SCSMR] = { 0x00, 16 },
191 [SCBRR] = { 0x04, 8 },
192 [SCSCR] = { 0x08, 16 },
193 [SCxTDR] = { 0x20, 8 },
194 [SCxSR] = { 0x14, 16 },
195 [SCxRDR] = { 0x24, 8 },
196 [SCFCR] = { 0x18, 16 },
197 [SCFDR] = { 0x1c, 16 },
198 [SCTFDR] = sci_reg_invalid,
199 [SCRFDR] = sci_reg_invalid,
200 [SCSPTR] = sci_reg_invalid,
201 [SCLSR] = sci_reg_invalid,
202 [HSSRR] = sci_reg_invalid,
203 [SCPCR] = { 0x30, 16 },
204 [SCPDR] = { 0x34, 16 },
208 * Common SCIFB definitions.
210 [SCIx_SCIFB_REGTYPE] = {
211 [SCSMR] = { 0x00, 16 },
212 [SCBRR] = { 0x04, 8 },
213 [SCSCR] = { 0x08, 16 },
214 [SCxTDR] = { 0x40, 8 },
215 [SCxSR] = { 0x14, 16 },
216 [SCxRDR] = { 0x60, 8 },
217 [SCFCR] = { 0x18, 16 },
218 [SCFDR] = sci_reg_invalid,
219 [SCTFDR] = { 0x38, 16 },
220 [SCRFDR] = { 0x3c, 16 },
221 [SCSPTR] = sci_reg_invalid,
222 [SCLSR] = sci_reg_invalid,
223 [HSSRR] = sci_reg_invalid,
224 [SCPCR] = { 0x30, 16 },
225 [SCPDR] = { 0x34, 16 },
229 * Common SH-2(A) SCIF definitions for ports with FIFO data
232 [SCIx_SH2_SCIF_FIFODATA_REGTYPE] = {
233 [SCSMR] = { 0x00, 16 },
234 [SCBRR] = { 0x04, 8 },
235 [SCSCR] = { 0x08, 16 },
236 [SCxTDR] = { 0x0c, 8 },
237 [SCxSR] = { 0x10, 16 },
238 [SCxRDR] = { 0x14, 8 },
239 [SCFCR] = { 0x18, 16 },
240 [SCFDR] = { 0x1c, 16 },
241 [SCTFDR] = sci_reg_invalid,
242 [SCRFDR] = sci_reg_invalid,
243 [SCSPTR] = { 0x20, 16 },
244 [SCLSR] = { 0x24, 16 },
245 [HSSRR] = sci_reg_invalid,
246 [SCPCR] = sci_reg_invalid,
247 [SCPDR] = sci_reg_invalid,
251 * Common SH-3 SCIF definitions.
253 [SCIx_SH3_SCIF_REGTYPE] = {
254 [SCSMR] = { 0x00, 8 },
255 [SCBRR] = { 0x02, 8 },
256 [SCSCR] = { 0x04, 8 },
257 [SCxTDR] = { 0x06, 8 },
258 [SCxSR] = { 0x08, 16 },
259 [SCxRDR] = { 0x0a, 8 },
260 [SCFCR] = { 0x0c, 8 },
261 [SCFDR] = { 0x0e, 16 },
262 [SCTFDR] = sci_reg_invalid,
263 [SCRFDR] = sci_reg_invalid,
264 [SCSPTR] = sci_reg_invalid,
265 [SCLSR] = sci_reg_invalid,
266 [HSSRR] = sci_reg_invalid,
267 [SCPCR] = sci_reg_invalid,
268 [SCPDR] = sci_reg_invalid,
272 * Common SH-4(A) SCIF(B) definitions.
274 [SCIx_SH4_SCIF_REGTYPE] = {
275 [SCSMR] = { 0x00, 16 },
276 [SCBRR] = { 0x04, 8 },
277 [SCSCR] = { 0x08, 16 },
278 [SCxTDR] = { 0x0c, 8 },
279 [SCxSR] = { 0x10, 16 },
280 [SCxRDR] = { 0x14, 8 },
281 [SCFCR] = { 0x18, 16 },
282 [SCFDR] = { 0x1c, 16 },
283 [SCTFDR] = sci_reg_invalid,
284 [SCRFDR] = sci_reg_invalid,
285 [SCSPTR] = { 0x20, 16 },
286 [SCLSR] = { 0x24, 16 },
287 [HSSRR] = sci_reg_invalid,
288 [SCPCR] = sci_reg_invalid,
289 [SCPDR] = sci_reg_invalid,
293 * Common HSCIF definitions.
295 [SCIx_HSCIF_REGTYPE] = {
296 [SCSMR] = { 0x00, 16 },
297 [SCBRR] = { 0x04, 8 },
298 [SCSCR] = { 0x08, 16 },
299 [SCxTDR] = { 0x0c, 8 },
300 [SCxSR] = { 0x10, 16 },
301 [SCxRDR] = { 0x14, 8 },
302 [SCFCR] = { 0x18, 16 },
303 [SCFDR] = { 0x1c, 16 },
304 [SCTFDR] = sci_reg_invalid,
305 [SCRFDR] = sci_reg_invalid,
306 [SCSPTR] = { 0x20, 16 },
307 [SCLSR] = { 0x24, 16 },
308 [HSSRR] = { 0x40, 16 },
309 [SCPCR] = sci_reg_invalid,
310 [SCPDR] = sci_reg_invalid,
314 * Common SH-4(A) SCIF(B) definitions for ports without an SCSPTR
317 [SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE] = {
318 [SCSMR] = { 0x00, 16 },
319 [SCBRR] = { 0x04, 8 },
320 [SCSCR] = { 0x08, 16 },
321 [SCxTDR] = { 0x0c, 8 },
322 [SCxSR] = { 0x10, 16 },
323 [SCxRDR] = { 0x14, 8 },
324 [SCFCR] = { 0x18, 16 },
325 [SCFDR] = { 0x1c, 16 },
326 [SCTFDR] = sci_reg_invalid,
327 [SCRFDR] = sci_reg_invalid,
328 [SCSPTR] = sci_reg_invalid,
329 [SCLSR] = { 0x24, 16 },
330 [HSSRR] = sci_reg_invalid,
331 [SCPCR] = sci_reg_invalid,
332 [SCPDR] = sci_reg_invalid,
336 * Common SH-4(A) SCIF(B) definitions for ports with FIFO data
339 [SCIx_SH4_SCIF_FIFODATA_REGTYPE] = {
340 [SCSMR] = { 0x00, 16 },
341 [SCBRR] = { 0x04, 8 },
342 [SCSCR] = { 0x08, 16 },
343 [SCxTDR] = { 0x0c, 8 },
344 [SCxSR] = { 0x10, 16 },
345 [SCxRDR] = { 0x14, 8 },
346 [SCFCR] = { 0x18, 16 },
347 [SCFDR] = { 0x1c, 16 },
348 [SCTFDR] = { 0x1c, 16 }, /* aliased to SCFDR */
349 [SCRFDR] = { 0x20, 16 },
350 [SCSPTR] = { 0x24, 16 },
351 [SCLSR] = { 0x28, 16 },
352 [HSSRR] = sci_reg_invalid,
353 [SCPCR] = sci_reg_invalid,
354 [SCPDR] = sci_reg_invalid,
358 * SH7705-style SCIF(B) ports, lacking both SCSPTR and SCLSR
361 [SCIx_SH7705_SCIF_REGTYPE] = {
362 [SCSMR] = { 0x00, 16 },
363 [SCBRR] = { 0x04, 8 },
364 [SCSCR] = { 0x08, 16 },
365 [SCxTDR] = { 0x20, 8 },
366 [SCxSR] = { 0x14, 16 },
367 [SCxRDR] = { 0x24, 8 },
368 [SCFCR] = { 0x18, 16 },
369 [SCFDR] = { 0x1c, 16 },
370 [SCTFDR] = sci_reg_invalid,
371 [SCRFDR] = sci_reg_invalid,
372 [SCSPTR] = sci_reg_invalid,
373 [SCLSR] = sci_reg_invalid,
374 [HSSRR] = sci_reg_invalid,
375 [SCPCR] = sci_reg_invalid,
376 [SCPDR] = sci_reg_invalid,
380 #define sci_getreg(up, offset) (sci_regmap[to_sci_port(up)->cfg->regtype] + offset)
383 * The "offset" here is rather misleading, in that it refers to an enum
384 * value relative to the port mapping rather than the fixed offset
385 * itself, which needs to be manually retrieved from the platform's
386 * register map for the given port.
388 static unsigned int sci_serial_in(struct uart_port *p, int offset)
390 const struct plat_sci_reg *reg = sci_getreg(p, offset);
393 return ioread8(p->membase + (reg->offset << p->regshift));
394 else if (reg->size == 16)
395 return ioread16(p->membase + (reg->offset << p->regshift));
397 WARN(1, "Invalid register access\n");
402 static void sci_serial_out(struct uart_port *p, int offset, int value)
404 const struct plat_sci_reg *reg = sci_getreg(p, offset);
407 iowrite8(value, p->membase + (reg->offset << p->regshift));
408 else if (reg->size == 16)
409 iowrite16(value, p->membase + (reg->offset << p->regshift));
411 WARN(1, "Invalid register access\n");
414 static int sci_probe_regmap(struct plat_sci_port *cfg)
418 cfg->regtype = SCIx_SCI_REGTYPE;
421 cfg->regtype = SCIx_IRDA_REGTYPE;
424 cfg->regtype = SCIx_SCIFA_REGTYPE;
427 cfg->regtype = SCIx_SCIFB_REGTYPE;
431 * The SH-4 is a bit of a misnomer here, although that's
432 * where this particular port layout originated. This
433 * configuration (or some slight variation thereof)
434 * remains the dominant model for all SCIFs.
436 cfg->regtype = SCIx_SH4_SCIF_REGTYPE;
439 cfg->regtype = SCIx_HSCIF_REGTYPE;
442 pr_err("Can't probe register map for given port\n");
449 static void sci_port_enable(struct sci_port *sci_port)
451 if (!sci_port->port.dev)
454 pm_runtime_get_sync(sci_port->port.dev);
456 clk_prepare_enable(sci_port->iclk);
457 sci_port->port.uartclk = clk_get_rate(sci_port->iclk);
458 clk_prepare_enable(sci_port->fclk);
461 static void sci_port_disable(struct sci_port *sci_port)
463 if (!sci_port->port.dev)
466 /* Cancel the break timer to ensure that the timer handler will not try
467 * to access the hardware with clocks and power disabled. Reset the
468 * break flag to make the break debouncing state machine ready for the
471 del_timer_sync(&sci_port->break_timer);
472 sci_port->break_flag = 0;
474 clk_disable_unprepare(sci_port->fclk);
475 clk_disable_unprepare(sci_port->iclk);
477 pm_runtime_put_sync(sci_port->port.dev);
480 static inline unsigned long port_rx_irq_mask(struct uart_port *port)
483 * Not all ports (such as SCIFA) will support REIE. Rather than
484 * special-casing the port type, we check the port initialization
485 * IRQ enable mask to see whether the IRQ is desired at all. If
486 * it's unset, it's logically inferred that there's no point in
489 return SCSCR_RIE | (to_sci_port(port)->cfg->scscr & SCSCR_REIE);
492 static void sci_start_tx(struct uart_port *port)
494 struct sci_port *s = to_sci_port(port);
497 #ifdef CONFIG_SERIAL_SH_SCI_DMA
498 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
499 u16 new, scr = serial_port_in(port, SCSCR);
501 new = scr | SCSCR_TDRQE;
503 new = scr & ~SCSCR_TDRQE;
505 serial_port_out(port, SCSCR, new);
508 if (s->chan_tx && !uart_circ_empty(&s->port.state->xmit) &&
509 dma_submit_error(s->cookie_tx)) {
511 schedule_work(&s->work_tx);
515 if (!s->chan_tx || port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
516 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
517 ctrl = serial_port_in(port, SCSCR);
518 serial_port_out(port, SCSCR, ctrl | SCSCR_TIE);
522 static void sci_stop_tx(struct uart_port *port)
526 /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
527 ctrl = serial_port_in(port, SCSCR);
529 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
530 ctrl &= ~SCSCR_TDRQE;
534 serial_port_out(port, SCSCR, ctrl);
537 static void sci_start_rx(struct uart_port *port)
541 ctrl = serial_port_in(port, SCSCR) | port_rx_irq_mask(port);
543 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
544 ctrl &= ~SCSCR_RDRQE;
546 serial_port_out(port, SCSCR, ctrl);
549 static void sci_stop_rx(struct uart_port *port)
553 ctrl = serial_port_in(port, SCSCR);
555 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
556 ctrl &= ~SCSCR_RDRQE;
558 ctrl &= ~port_rx_irq_mask(port);
560 serial_port_out(port, SCSCR, ctrl);
563 static void sci_clear_SCxSR(struct uart_port *port, unsigned int mask)
565 if (port->type == PORT_SCI) {
566 /* Just store the mask */
567 serial_port_out(port, SCxSR, mask);
568 } else if (to_sci_port(port)->overrun_mask == SCIFA_ORER) {
569 /* SCIFA/SCIFB and SCIF on SH7705/SH7720/SH7721 */
570 /* Only clear the status bits we want to clear */
571 serial_port_out(port, SCxSR,
572 serial_port_in(port, SCxSR) & mask);
574 /* Store the mask, clear parity/framing errors */
575 serial_port_out(port, SCxSR, mask & ~(SCIF_FERC | SCIF_PERC));
579 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
581 #ifdef CONFIG_CONSOLE_POLL
582 static int sci_poll_get_char(struct uart_port *port)
584 unsigned short status;
588 status = serial_port_in(port, SCxSR);
589 if (status & SCxSR_ERRORS(port)) {
590 sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
596 if (!(status & SCxSR_RDxF(port)))
599 c = serial_port_in(port, SCxRDR);
602 serial_port_in(port, SCxSR);
603 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
609 static void sci_poll_put_char(struct uart_port *port, unsigned char c)
611 unsigned short status;
614 status = serial_port_in(port, SCxSR);
615 } while (!(status & SCxSR_TDxE(port)));
617 serial_port_out(port, SCxTDR, c);
618 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port) & ~SCxSR_TEND(port));
620 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE */
622 static void sci_init_pins(struct uart_port *port, unsigned int cflag)
624 struct sci_port *s = to_sci_port(port);
625 const struct plat_sci_reg *reg = sci_regmap[s->cfg->regtype] + SCSPTR;
628 * Use port-specific handler if provided.
630 if (s->cfg->ops && s->cfg->ops->init_pins) {
631 s->cfg->ops->init_pins(port, cflag);
636 * For the generic path SCSPTR is necessary. Bail out if that's
642 if ((s->cfg->capabilities & SCIx_HAVE_RTSCTS) &&
643 ((!(cflag & CRTSCTS)))) {
644 unsigned short status;
646 status = serial_port_in(port, SCSPTR);
647 status &= ~SCSPTR_CTSIO;
648 status |= SCSPTR_RTSIO;
649 serial_port_out(port, SCSPTR, status); /* Set RTS = 1 */
653 static int sci_txfill(struct uart_port *port)
655 const struct plat_sci_reg *reg;
657 reg = sci_getreg(port, SCTFDR);
659 return serial_port_in(port, SCTFDR) & ((port->fifosize << 1) - 1);
661 reg = sci_getreg(port, SCFDR);
663 return serial_port_in(port, SCFDR) >> 8;
665 return !(serial_port_in(port, SCxSR) & SCI_TDRE);
668 static int sci_txroom(struct uart_port *port)
670 return port->fifosize - sci_txfill(port);
673 static int sci_rxfill(struct uart_port *port)
675 const struct plat_sci_reg *reg;
677 reg = sci_getreg(port, SCRFDR);
679 return serial_port_in(port, SCRFDR) & ((port->fifosize << 1) - 1);
681 reg = sci_getreg(port, SCFDR);
683 return serial_port_in(port, SCFDR) & ((port->fifosize << 1) - 1);
685 return (serial_port_in(port, SCxSR) & SCxSR_RDxF(port)) != 0;
689 * SCI helper for checking the state of the muxed port/RXD pins.
691 static inline int sci_rxd_in(struct uart_port *port)
693 struct sci_port *s = to_sci_port(port);
695 if (s->cfg->port_reg <= 0)
698 /* Cast for ARM damage */
699 return !!__raw_readb((void __iomem *)(uintptr_t)s->cfg->port_reg);
702 /* ********************************************************************** *
703 * the interrupt related routines *
704 * ********************************************************************** */
706 static void sci_transmit_chars(struct uart_port *port)
708 struct circ_buf *xmit = &port->state->xmit;
709 unsigned int stopped = uart_tx_stopped(port);
710 unsigned short status;
714 status = serial_port_in(port, SCxSR);
715 if (!(status & SCxSR_TDxE(port))) {
716 ctrl = serial_port_in(port, SCSCR);
717 if (uart_circ_empty(xmit))
721 serial_port_out(port, SCSCR, ctrl);
725 count = sci_txroom(port);
733 } else if (!uart_circ_empty(xmit) && !stopped) {
734 c = xmit->buf[xmit->tail];
735 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
740 serial_port_out(port, SCxTDR, c);
743 } while (--count > 0);
745 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
747 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
748 uart_write_wakeup(port);
749 if (uart_circ_empty(xmit)) {
752 ctrl = serial_port_in(port, SCSCR);
754 if (port->type != PORT_SCI) {
755 serial_port_in(port, SCxSR); /* Dummy read */
756 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
760 serial_port_out(port, SCSCR, ctrl);
764 /* On SH3, SCIF may read end-of-break as a space->mark char */
765 #define STEPFN(c) ({int __c = (c); (((__c-1)|(__c)) == -1); })
767 static void sci_receive_chars(struct uart_port *port)
769 struct sci_port *sci_port = to_sci_port(port);
770 struct tty_port *tport = &port->state->port;
771 int i, count, copied = 0;
772 unsigned short status;
775 status = serial_port_in(port, SCxSR);
776 if (!(status & SCxSR_RDxF(port)))
780 /* Don't copy more bytes than there is room for in the buffer */
781 count = tty_buffer_request_room(tport, sci_rxfill(port));
783 /* If for any reason we can't copy more data, we're done! */
787 if (port->type == PORT_SCI) {
788 char c = serial_port_in(port, SCxRDR);
789 if (uart_handle_sysrq_char(port, c) ||
790 sci_port->break_flag)
793 tty_insert_flip_char(tport, c, TTY_NORMAL);
795 for (i = 0; i < count; i++) {
796 char c = serial_port_in(port, SCxRDR);
798 status = serial_port_in(port, SCxSR);
799 #if defined(CONFIG_CPU_SH3)
800 /* Skip "chars" during break */
801 if (sci_port->break_flag) {
803 (status & SCxSR_FER(port))) {
808 /* Nonzero => end-of-break */
809 dev_dbg(port->dev, "debounce<%02x>\n", c);
810 sci_port->break_flag = 0;
817 #endif /* CONFIG_CPU_SH3 */
818 if (uart_handle_sysrq_char(port, c)) {
823 /* Store data and status */
824 if (status & SCxSR_FER(port)) {
826 port->icount.frame++;
827 dev_notice(port->dev, "frame error\n");
828 } else if (status & SCxSR_PER(port)) {
830 port->icount.parity++;
831 dev_notice(port->dev, "parity error\n");
835 tty_insert_flip_char(tport, c, flag);
839 serial_port_in(port, SCxSR); /* dummy read */
840 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
843 port->icount.rx += count;
847 /* Tell the rest of the system the news. New characters! */
848 tty_flip_buffer_push(tport);
850 /* TTY buffers full; read from RX reg to prevent lockup */
851 serial_port_in(port, SCxRDR);
852 serial_port_in(port, SCxSR); /* dummy read */
853 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
857 #define SCI_BREAK_JIFFIES (HZ/20)
860 * The sci generates interrupts during the break,
861 * 1 per millisecond or so during the break period, for 9600 baud.
862 * So dont bother disabling interrupts.
863 * But dont want more than 1 break event.
864 * Use a kernel timer to periodically poll the rx line until
865 * the break is finished.
867 static inline void sci_schedule_break_timer(struct sci_port *port)
869 mod_timer(&port->break_timer, jiffies + SCI_BREAK_JIFFIES);
872 /* Ensure that two consecutive samples find the break over. */
873 static void sci_break_timer(unsigned long data)
875 struct sci_port *port = (struct sci_port *)data;
877 if (sci_rxd_in(&port->port) == 0) {
878 port->break_flag = 1;
879 sci_schedule_break_timer(port);
880 } else if (port->break_flag == 1) {
882 port->break_flag = 2;
883 sci_schedule_break_timer(port);
885 port->break_flag = 0;
888 static int sci_handle_errors(struct uart_port *port)
891 unsigned short status = serial_port_in(port, SCxSR);
892 struct tty_port *tport = &port->state->port;
893 struct sci_port *s = to_sci_port(port);
895 /* Handle overruns */
896 if (status & s->overrun_mask) {
897 port->icount.overrun++;
900 if (tty_insert_flip_char(tport, 0, TTY_OVERRUN))
903 dev_notice(port->dev, "overrun error\n");
906 if (status & SCxSR_FER(port)) {
907 if (sci_rxd_in(port) == 0) {
908 /* Notify of BREAK */
909 struct sci_port *sci_port = to_sci_port(port);
911 if (!sci_port->break_flag) {
914 sci_port->break_flag = 1;
915 sci_schedule_break_timer(sci_port);
917 /* Do sysrq handling. */
918 if (uart_handle_break(port))
921 dev_dbg(port->dev, "BREAK detected\n");
923 if (tty_insert_flip_char(tport, 0, TTY_BREAK))
929 port->icount.frame++;
931 if (tty_insert_flip_char(tport, 0, TTY_FRAME))
934 dev_notice(port->dev, "frame error\n");
938 if (status & SCxSR_PER(port)) {
940 port->icount.parity++;
942 if (tty_insert_flip_char(tport, 0, TTY_PARITY))
945 dev_notice(port->dev, "parity error\n");
949 tty_flip_buffer_push(tport);
954 static int sci_handle_fifo_overrun(struct uart_port *port)
956 struct tty_port *tport = &port->state->port;
957 struct sci_port *s = to_sci_port(port);
958 const struct plat_sci_reg *reg;
962 reg = sci_getreg(port, s->overrun_reg);
966 status = serial_port_in(port, s->overrun_reg);
967 if (status & s->overrun_mask) {
968 status &= ~s->overrun_mask;
969 serial_port_out(port, s->overrun_reg, status);
971 port->icount.overrun++;
973 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
974 tty_flip_buffer_push(tport);
976 dev_dbg(port->dev, "overrun error\n");
983 static int sci_handle_breaks(struct uart_port *port)
986 unsigned short status = serial_port_in(port, SCxSR);
987 struct tty_port *tport = &port->state->port;
988 struct sci_port *s = to_sci_port(port);
990 if (uart_handle_break(port))
993 if (!s->break_flag && status & SCxSR_BRK(port)) {
994 #if defined(CONFIG_CPU_SH3)
1001 /* Notify of BREAK */
1002 if (tty_insert_flip_char(tport, 0, TTY_BREAK))
1005 dev_dbg(port->dev, "BREAK detected\n");
1009 tty_flip_buffer_push(tport);
1011 copied += sci_handle_fifo_overrun(port);
1016 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1017 static void sci_dma_tx_complete(void *arg)
1019 struct sci_port *s = arg;
1020 struct uart_port *port = &s->port;
1021 struct circ_buf *xmit = &port->state->xmit;
1022 unsigned long flags;
1024 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1026 spin_lock_irqsave(&port->lock, flags);
1028 xmit->tail += s->tx_dma_len;
1029 xmit->tail &= UART_XMIT_SIZE - 1;
1031 port->icount.tx += s->tx_dma_len;
1033 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1034 uart_write_wakeup(port);
1036 if (!uart_circ_empty(xmit)) {
1038 schedule_work(&s->work_tx);
1040 s->cookie_tx = -EINVAL;
1041 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1042 u16 ctrl = serial_port_in(port, SCSCR);
1043 serial_port_out(port, SCSCR, ctrl & ~SCSCR_TIE);
1047 spin_unlock_irqrestore(&port->lock, flags);
1050 /* Locking: called with port lock held */
1051 static int sci_dma_rx_push(struct sci_port *s, void *buf, size_t count)
1053 struct uart_port *port = &s->port;
1054 struct tty_port *tport = &port->state->port;
1057 copied = tty_insert_flip_string(tport, buf, count);
1058 if (copied < count) {
1059 dev_warn(port->dev, "Rx overrun: dropping %zu bytes\n",
1061 port->icount.buf_overrun++;
1064 port->icount.rx += copied;
1069 static int sci_dma_rx_find_active(struct sci_port *s)
1073 for (i = 0; i < ARRAY_SIZE(s->cookie_rx); i++)
1074 if (s->active_rx == s->cookie_rx[i])
1077 dev_err(s->port.dev, "%s: Rx cookie %d not found!\n", __func__,
1082 static void sci_rx_dma_release(struct sci_port *s, bool enable_pio)
1084 struct dma_chan *chan = s->chan_rx;
1085 struct uart_port *port = &s->port;
1086 unsigned long flags;
1088 spin_lock_irqsave(&port->lock, flags);
1090 s->cookie_rx[0] = s->cookie_rx[1] = -EINVAL;
1091 spin_unlock_irqrestore(&port->lock, flags);
1092 dmaengine_terminate_all(chan);
1093 dma_free_coherent(chan->device->dev, s->buf_len_rx * 2, s->rx_buf[0],
1094 sg_dma_address(&s->sg_rx[0]));
1095 dma_release_channel(chan);
1100 static void sci_dma_rx_complete(void *arg)
1102 struct sci_port *s = arg;
1103 struct dma_chan *chan = s->chan_rx;
1104 struct uart_port *port = &s->port;
1105 struct dma_async_tx_descriptor *desc;
1106 unsigned long flags;
1107 int active, count = 0;
1109 dev_dbg(port->dev, "%s(%d) active cookie %d\n", __func__, port->line,
1112 spin_lock_irqsave(&port->lock, flags);
1114 active = sci_dma_rx_find_active(s);
1116 count = sci_dma_rx_push(s, s->rx_buf[active], s->buf_len_rx);
1118 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1121 tty_flip_buffer_push(&port->state->port);
1123 desc = dmaengine_prep_slave_sg(s->chan_rx, &s->sg_rx[active], 1,
1125 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1129 desc->callback = sci_dma_rx_complete;
1130 desc->callback_param = s;
1131 s->cookie_rx[active] = dmaengine_submit(desc);
1132 if (dma_submit_error(s->cookie_rx[active]))
1135 s->active_rx = s->cookie_rx[!active];
1137 dma_async_issue_pending(chan);
1139 dev_dbg(port->dev, "%s: cookie %d #%d, new active cookie %d\n",
1140 __func__, s->cookie_rx[active], active, s->active_rx);
1141 spin_unlock_irqrestore(&port->lock, flags);
1145 spin_unlock_irqrestore(&port->lock, flags);
1146 dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1147 sci_rx_dma_release(s, true);
1150 static void sci_tx_dma_release(struct sci_port *s, bool enable_pio)
1152 struct dma_chan *chan = s->chan_tx;
1153 struct uart_port *port = &s->port;
1154 unsigned long flags;
1156 spin_lock_irqsave(&port->lock, flags);
1158 s->cookie_tx = -EINVAL;
1159 spin_unlock_irqrestore(&port->lock, flags);
1160 dmaengine_terminate_all(chan);
1161 dma_unmap_single(chan->device->dev, s->tx_dma_addr, UART_XMIT_SIZE,
1163 dma_release_channel(chan);
1168 static void sci_submit_rx(struct sci_port *s)
1170 struct dma_chan *chan = s->chan_rx;
1173 for (i = 0; i < 2; i++) {
1174 struct scatterlist *sg = &s->sg_rx[i];
1175 struct dma_async_tx_descriptor *desc;
1177 desc = dmaengine_prep_slave_sg(chan,
1178 sg, 1, DMA_DEV_TO_MEM,
1179 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1183 desc->callback = sci_dma_rx_complete;
1184 desc->callback_param = s;
1185 s->cookie_rx[i] = dmaengine_submit(desc);
1186 if (dma_submit_error(s->cookie_rx[i]))
1189 dev_dbg(s->port.dev, "%s(): cookie %d to #%d\n", __func__,
1190 s->cookie_rx[i], i);
1193 s->active_rx = s->cookie_rx[0];
1195 dma_async_issue_pending(chan);
1200 dmaengine_terminate_all(chan);
1201 for (i = 0; i < 2; i++)
1202 s->cookie_rx[i] = -EINVAL;
1203 s->active_rx = -EINVAL;
1204 dev_warn(s->port.dev, "Failed to re-start Rx DMA, using PIO\n");
1205 sci_rx_dma_release(s, true);
1208 static void work_fn_tx(struct work_struct *work)
1210 struct sci_port *s = container_of(work, struct sci_port, work_tx);
1211 struct dma_async_tx_descriptor *desc;
1212 struct dma_chan *chan = s->chan_tx;
1213 struct uart_port *port = &s->port;
1214 struct circ_buf *xmit = &port->state->xmit;
1219 * Port xmit buffer is already mapped, and it is one page... Just adjust
1220 * offsets and lengths. Since it is a circular buffer, we have to
1221 * transmit till the end, and then the rest. Take the port lock to get a
1222 * consistent xmit buffer state.
1224 spin_lock_irq(&port->lock);
1225 buf = s->tx_dma_addr + (xmit->tail & (UART_XMIT_SIZE - 1));
1226 s->tx_dma_len = min_t(unsigned int,
1227 CIRC_CNT(xmit->head, xmit->tail, UART_XMIT_SIZE),
1228 CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE));
1229 spin_unlock_irq(&port->lock);
1231 desc = dmaengine_prep_slave_single(chan, buf, s->tx_dma_len,
1233 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1235 dev_warn(port->dev, "Failed preparing Tx DMA descriptor\n");
1237 sci_tx_dma_release(s, true);
1241 dma_sync_single_for_device(chan->device->dev, buf, s->tx_dma_len,
1244 spin_lock_irq(&port->lock);
1245 desc->callback = sci_dma_tx_complete;
1246 desc->callback_param = s;
1247 spin_unlock_irq(&port->lock);
1248 s->cookie_tx = dmaengine_submit(desc);
1249 if (dma_submit_error(s->cookie_tx)) {
1250 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1252 sci_tx_dma_release(s, true);
1256 dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n",
1257 __func__, xmit->buf, xmit->tail, xmit->head, s->cookie_tx);
1259 dma_async_issue_pending(chan);
1262 static void rx_timer_fn(unsigned long arg)
1264 struct sci_port *s = (struct sci_port *)arg;
1265 struct dma_chan *chan = s->chan_rx;
1266 struct uart_port *port = &s->port;
1267 struct dma_tx_state state;
1268 enum dma_status status;
1269 unsigned long flags;
1274 spin_lock_irqsave(&port->lock, flags);
1276 dev_dbg(port->dev, "DMA Rx timed out\n");
1278 active = sci_dma_rx_find_active(s);
1280 spin_unlock_irqrestore(&port->lock, flags);
1284 status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1285 if (status == DMA_COMPLETE) {
1286 dev_dbg(port->dev, "Cookie %d #%d has already completed\n",
1287 s->active_rx, active);
1288 spin_unlock_irqrestore(&port->lock, flags);
1290 /* Let packet complete handler take care of the packet */
1294 dmaengine_pause(chan);
1297 * sometimes DMA transfer doesn't stop even if it is stopped and
1298 * data keeps on coming until transaction is complete so check
1299 * for DMA_COMPLETE again
1300 * Let packet complete handler take care of the packet
1302 status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1303 if (status == DMA_COMPLETE) {
1304 spin_unlock_irqrestore(&port->lock, flags);
1305 dev_dbg(port->dev, "Transaction complete after DMA engine was stopped");
1309 /* Handle incomplete DMA receive */
1310 dmaengine_terminate_all(s->chan_rx);
1311 read = sg_dma_len(&s->sg_rx[active]) - state.residue;
1312 dev_dbg(port->dev, "Read %u bytes with cookie %d\n", read,
1316 count = sci_dma_rx_push(s, s->rx_buf[active], read);
1318 tty_flip_buffer_push(&port->state->port);
1321 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1324 /* Direct new serial port interrupts back to CPU */
1325 scr = serial_port_in(port, SCSCR);
1326 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1327 scr &= ~SCSCR_RDRQE;
1328 enable_irq(s->irqs[SCIx_RXI_IRQ]);
1330 serial_port_out(port, SCSCR, scr | SCSCR_RIE);
1332 spin_unlock_irqrestore(&port->lock, flags);
1335 static struct dma_chan *sci_request_dma_chan(struct uart_port *port,
1336 enum dma_transfer_direction dir,
1339 dma_cap_mask_t mask;
1340 struct dma_chan *chan;
1341 struct dma_slave_config cfg;
1345 dma_cap_set(DMA_SLAVE, mask);
1347 chan = dma_request_slave_channel_compat(mask, shdma_chan_filter,
1348 (void *)(unsigned long)id, port->dev,
1349 dir == DMA_MEM_TO_DEV ? "tx" : "rx");
1352 "dma_request_slave_channel_compat failed\n");
1356 memset(&cfg, 0, sizeof(cfg));
1357 cfg.direction = dir;
1358 if (dir == DMA_MEM_TO_DEV) {
1359 cfg.dst_addr = port->mapbase +
1360 (sci_getreg(port, SCxTDR)->offset << port->regshift);
1361 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1363 cfg.src_addr = port->mapbase +
1364 (sci_getreg(port, SCxRDR)->offset << port->regshift);
1365 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1368 ret = dmaengine_slave_config(chan, &cfg);
1370 dev_warn(port->dev, "dmaengine_slave_config failed %d\n", ret);
1371 dma_release_channel(chan);
1378 static void sci_request_dma(struct uart_port *port)
1380 struct sci_port *s = to_sci_port(port);
1381 struct dma_chan *chan;
1383 dev_dbg(port->dev, "%s: port %d\n", __func__, port->line);
1385 if (!port->dev->of_node &&
1386 (s->cfg->dma_slave_tx <= 0 || s->cfg->dma_slave_rx <= 0))
1389 s->cookie_tx = -EINVAL;
1390 chan = sci_request_dma_chan(port, DMA_MEM_TO_DEV, s->cfg->dma_slave_tx);
1391 dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1394 /* UART circular tx buffer is an aligned page. */
1395 s->tx_dma_addr = dma_map_single(chan->device->dev,
1396 port->state->xmit.buf,
1399 if (dma_mapping_error(chan->device->dev, s->tx_dma_addr)) {
1400 dev_warn(port->dev, "Failed mapping Tx DMA descriptor\n");
1401 dma_release_channel(chan);
1404 dev_dbg(port->dev, "%s: mapped %lu@%p to %pad\n",
1405 __func__, UART_XMIT_SIZE,
1406 port->state->xmit.buf, &s->tx_dma_addr);
1409 INIT_WORK(&s->work_tx, work_fn_tx);
1412 chan = sci_request_dma_chan(port, DMA_DEV_TO_MEM, s->cfg->dma_slave_rx);
1413 dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1421 s->buf_len_rx = 2 * max_t(size_t, 16, port->fifosize);
1422 buf = dma_alloc_coherent(chan->device->dev, s->buf_len_rx * 2,
1426 "Failed to allocate Rx dma buffer, using PIO\n");
1427 dma_release_channel(chan);
1432 for (i = 0; i < 2; i++) {
1433 struct scatterlist *sg = &s->sg_rx[i];
1435 sg_init_table(sg, 1);
1437 sg_dma_address(sg) = dma;
1438 sg_dma_len(sg) = s->buf_len_rx;
1440 buf += s->buf_len_rx;
1441 dma += s->buf_len_rx;
1444 setup_timer(&s->rx_timer, rx_timer_fn, (unsigned long)s);
1446 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1451 static void sci_free_dma(struct uart_port *port)
1453 struct sci_port *s = to_sci_port(port);
1456 sci_tx_dma_release(s, false);
1458 sci_rx_dma_release(s, false);
1461 static void sci_flush_buffer(struct uart_port *port)
1464 * In uart_flush_buffer(), the xmit circular buffer has just been
1465 * cleared, so we have to reset tx_dma_len accordingly.
1467 to_sci_port(port)->tx_dma_len = 0;
1469 #else /* !CONFIG_SERIAL_SH_SCI_DMA */
1470 static inline void sci_request_dma(struct uart_port *port)
1474 static inline void sci_free_dma(struct uart_port *port)
1478 #define sci_flush_buffer NULL
1479 #endif /* !CONFIG_SERIAL_SH_SCI_DMA */
1481 static irqreturn_t sci_rx_interrupt(int irq, void *ptr)
1483 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1484 struct uart_port *port = ptr;
1485 struct sci_port *s = to_sci_port(port);
1488 u16 scr = serial_port_in(port, SCSCR);
1489 u16 ssr = serial_port_in(port, SCxSR);
1491 /* Disable future Rx interrupts */
1492 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1493 disable_irq_nosync(irq);
1499 serial_port_out(port, SCSCR, scr);
1500 /* Clear current interrupt */
1501 serial_port_out(port, SCxSR,
1502 ssr & ~(SCIF_DR | SCxSR_RDxF(port)));
1503 dev_dbg(port->dev, "Rx IRQ %lu: setup t-out in %u jiffies\n",
1504 jiffies, s->rx_timeout);
1505 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1511 /* I think sci_receive_chars has to be called irrespective
1512 * of whether the I_IXOFF is set, otherwise, how is the interrupt
1515 sci_receive_chars(ptr);
1520 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
1522 struct uart_port *port = ptr;
1523 unsigned long flags;
1525 spin_lock_irqsave(&port->lock, flags);
1526 sci_transmit_chars(port);
1527 spin_unlock_irqrestore(&port->lock, flags);
1532 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
1534 struct uart_port *port = ptr;
1535 struct sci_port *s = to_sci_port(port);
1538 if (port->type == PORT_SCI) {
1539 if (sci_handle_errors(port)) {
1540 /* discard character in rx buffer */
1541 serial_port_in(port, SCxSR);
1542 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
1545 sci_handle_fifo_overrun(port);
1547 sci_receive_chars(ptr);
1550 sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
1552 /* Kick the transmission */
1554 sci_tx_interrupt(irq, ptr);
1559 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
1561 struct uart_port *port = ptr;
1564 sci_handle_breaks(port);
1565 sci_clear_SCxSR(port, SCxSR_BREAK_CLEAR(port));
1570 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
1572 unsigned short ssr_status, scr_status, err_enabled, orer_status = 0;
1573 struct uart_port *port = ptr;
1574 struct sci_port *s = to_sci_port(port);
1575 irqreturn_t ret = IRQ_NONE;
1577 ssr_status = serial_port_in(port, SCxSR);
1578 scr_status = serial_port_in(port, SCSCR);
1579 if (s->overrun_reg == SCxSR)
1580 orer_status = ssr_status;
1582 if (sci_getreg(port, s->overrun_reg)->size)
1583 orer_status = serial_port_in(port, s->overrun_reg);
1586 err_enabled = scr_status & port_rx_irq_mask(port);
1589 if ((ssr_status & SCxSR_TDxE(port)) && (scr_status & SCSCR_TIE) &&
1591 ret = sci_tx_interrupt(irq, ptr);
1594 * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
1597 if (((ssr_status & SCxSR_RDxF(port)) || s->chan_rx) &&
1598 (scr_status & SCSCR_RIE))
1599 ret = sci_rx_interrupt(irq, ptr);
1601 /* Error Interrupt */
1602 if ((ssr_status & SCxSR_ERRORS(port)) && err_enabled)
1603 ret = sci_er_interrupt(irq, ptr);
1605 /* Break Interrupt */
1606 if ((ssr_status & SCxSR_BRK(port)) && err_enabled)
1607 ret = sci_br_interrupt(irq, ptr);
1609 /* Overrun Interrupt */
1610 if (orer_status & s->overrun_mask) {
1611 sci_handle_fifo_overrun(port);
1618 static const struct sci_irq_desc {
1620 irq_handler_t handler;
1621 } sci_irq_desc[] = {
1623 * Split out handlers, the default case.
1627 .handler = sci_er_interrupt,
1632 .handler = sci_rx_interrupt,
1637 .handler = sci_tx_interrupt,
1642 .handler = sci_br_interrupt,
1646 * Special muxed handler.
1650 .handler = sci_mpxed_interrupt,
1654 static int sci_request_irq(struct sci_port *port)
1656 struct uart_port *up = &port->port;
1659 for (i = j = 0; i < SCIx_NR_IRQS; i++, j++) {
1660 const struct sci_irq_desc *desc;
1663 if (SCIx_IRQ_IS_MUXED(port)) {
1667 irq = port->irqs[i];
1670 * Certain port types won't support all of the
1671 * available interrupt sources.
1673 if (unlikely(irq < 0))
1677 desc = sci_irq_desc + i;
1678 port->irqstr[j] = kasprintf(GFP_KERNEL, "%s:%s",
1679 dev_name(up->dev), desc->desc);
1680 if (!port->irqstr[j])
1683 ret = request_irq(irq, desc->handler, up->irqflags,
1684 port->irqstr[j], port);
1685 if (unlikely(ret)) {
1686 dev_err(up->dev, "Can't allocate %s IRQ\n", desc->desc);
1695 free_irq(port->irqs[i], port);
1699 kfree(port->irqstr[j]);
1704 static void sci_free_irq(struct sci_port *port)
1709 * Intentionally in reverse order so we iterate over the muxed
1712 for (i = 0; i < SCIx_NR_IRQS; i++) {
1713 int irq = port->irqs[i];
1716 * Certain port types won't support all of the available
1717 * interrupt sources.
1719 if (unlikely(irq < 0))
1722 free_irq(port->irqs[i], port);
1723 kfree(port->irqstr[i]);
1725 if (SCIx_IRQ_IS_MUXED(port)) {
1726 /* If there's only one IRQ, we're done. */
1732 static unsigned int sci_tx_empty(struct uart_port *port)
1734 unsigned short status = serial_port_in(port, SCxSR);
1735 unsigned short in_tx_fifo = sci_txfill(port);
1737 return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
1741 * Modem control is a bit of a mixed bag for SCI(F) ports. Generally
1742 * CTS/RTS is supported in hardware by at least one port and controlled
1743 * via SCSPTR (SCxPCR for SCIFA/B parts), or external pins (presently
1744 * handled via the ->init_pins() op, which is a bit of a one-way street,
1745 * lacking any ability to defer pin control -- this will later be
1746 * converted over to the GPIO framework).
1748 * Other modes (such as loopback) are supported generically on certain
1749 * port types, but not others. For these it's sufficient to test for the
1750 * existence of the support register and simply ignore the port type.
1752 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
1754 if (mctrl & TIOCM_LOOP) {
1755 const struct plat_sci_reg *reg;
1758 * Standard loopback mode for SCFCR ports.
1760 reg = sci_getreg(port, SCFCR);
1762 serial_port_out(port, SCFCR,
1763 serial_port_in(port, SCFCR) |
1768 static unsigned int sci_get_mctrl(struct uart_port *port)
1771 * CTS/RTS is handled in hardware when supported, while nothing
1772 * else is wired up. Keep it simple and simply assert DSR/CAR.
1774 return TIOCM_DSR | TIOCM_CAR;
1777 static void sci_break_ctl(struct uart_port *port, int break_state)
1779 struct sci_port *s = to_sci_port(port);
1780 const struct plat_sci_reg *reg = sci_regmap[s->cfg->regtype] + SCSPTR;
1781 unsigned short scscr, scsptr;
1783 /* check wheter the port has SCSPTR */
1786 * Not supported by hardware. Most parts couple break and rx
1787 * interrupts together, with break detection always enabled.
1792 scsptr = serial_port_in(port, SCSPTR);
1793 scscr = serial_port_in(port, SCSCR);
1795 if (break_state == -1) {
1796 scsptr = (scsptr | SCSPTR_SPB2IO) & ~SCSPTR_SPB2DT;
1799 scsptr = (scsptr | SCSPTR_SPB2DT) & ~SCSPTR_SPB2IO;
1803 serial_port_out(port, SCSPTR, scsptr);
1804 serial_port_out(port, SCSCR, scscr);
1807 static int sci_startup(struct uart_port *port)
1809 struct sci_port *s = to_sci_port(port);
1810 unsigned long flags;
1813 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1815 sci_request_dma(port);
1817 ret = sci_request_irq(s);
1818 if (unlikely(ret < 0)) {
1823 spin_lock_irqsave(&port->lock, flags);
1826 spin_unlock_irqrestore(&port->lock, flags);
1831 static void sci_shutdown(struct uart_port *port)
1833 struct sci_port *s = to_sci_port(port);
1834 unsigned long flags;
1836 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1838 spin_lock_irqsave(&port->lock, flags);
1841 spin_unlock_irqrestore(&port->lock, flags);
1843 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1845 dev_dbg(port->dev, "%s(%d) deleting rx_timer\n", __func__,
1847 del_timer_sync(&s->rx_timer);
1855 static unsigned int sci_scbrr_calc(struct sci_port *s, unsigned int bps,
1858 if (s->sampling_rate)
1859 return DIV_ROUND_CLOSEST(freq, s->sampling_rate * bps) - 1;
1861 /* Warn, but use a safe default */
1864 return ((freq + 16 * bps) / (32 * bps) - 1);
1867 /* calculate frame length from SMR */
1868 static int sci_baud_calc_frame_len(unsigned int smr_val)
1872 if (smr_val & SCSMR_CHR)
1874 if (smr_val & SCSMR_PE)
1876 if (smr_val & SCSMR_STOP)
1883 /* calculate sample rate, BRR, and clock select for HSCIF */
1884 static void sci_baud_calc_hscif(unsigned int bps, unsigned long freq,
1885 int *brr, unsigned int *srr,
1886 unsigned int *cks, int frame_len)
1888 int sr, c, br, err, recv_margin;
1889 int min_err = 1000; /* 100% */
1890 int recv_max_margin = 0;
1892 /* Find the combination of sample rate and clock select with the
1893 smallest deviation from the desired baud rate. */
1894 for (sr = 8; sr <= 32; sr++) {
1895 for (c = 0; c <= 3; c++) {
1896 /* integerized formulas from HSCIF documentation */
1897 br = DIV_ROUND_CLOSEST(freq, (sr *
1898 (1 << (2 * c + 1)) * bps)) - 1;
1899 br = clamp(br, 0, 255);
1900 err = DIV_ROUND_CLOSEST(freq, ((br + 1) * bps * sr *
1901 (1 << (2 * c + 1)) / 1000)) -
1904 * M: Receive margin (%)
1905 * N: Ratio of bit rate to clock (N = sampling rate)
1906 * D: Clock duty (D = 0 to 1.0)
1907 * L: Frame length (L = 9 to 12)
1908 * F: Absolute value of clock frequency deviation
1910 * M = |(0.5 - 1 / 2 * N) - ((L - 0.5) * F) -
1911 * (|D - 0.5| / N * (1 + F))|
1912 * NOTE: Usually, treat D for 0.5, F is 0 by this
1915 recv_margin = abs((500 -
1916 DIV_ROUND_CLOSEST(1000, sr << 1)) / 10);
1917 if (abs(min_err) > abs(err)) {
1919 recv_max_margin = recv_margin;
1920 } else if ((min_err == err) &&
1921 (recv_margin > recv_max_margin))
1922 recv_max_margin = recv_margin;
1932 if (min_err == 1000) {
1941 static void sci_reset(struct uart_port *port)
1943 const struct plat_sci_reg *reg;
1944 unsigned int status;
1947 status = serial_port_in(port, SCxSR);
1948 } while (!(status & SCxSR_TEND(port)));
1950 serial_port_out(port, SCSCR, 0x00); /* TE=0, RE=0, CKE1=0 */
1952 reg = sci_getreg(port, SCFCR);
1954 serial_port_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
1957 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
1958 struct ktermios *old)
1960 struct sci_port *s = to_sci_port(port);
1961 const struct plat_sci_reg *reg;
1962 unsigned int baud, smr_val = 0, max_baud, cks = 0;
1964 unsigned int srr = 15;
1966 if ((termios->c_cflag & CSIZE) == CS7)
1967 smr_val |= SCSMR_CHR;
1968 if (termios->c_cflag & PARENB)
1969 smr_val |= SCSMR_PE;
1970 if (termios->c_cflag & PARODD)
1971 smr_val |= SCSMR_PE | SCSMR_ODD;
1972 if (termios->c_cflag & CSTOPB)
1973 smr_val |= SCSMR_STOP;
1976 * earlyprintk comes here early on with port->uartclk set to zero.
1977 * the clock framework is not up and running at this point so here
1978 * we assume that 115200 is the maximum baud rate. please note that
1979 * the baud rate is not programmed during earlyprintk - it is assumed
1980 * that the previous boot loader has enabled required clocks and
1981 * setup the baud rate generator hardware for us already.
1983 max_baud = port->uartclk ? port->uartclk / 16 : 115200;
1985 baud = uart_get_baud_rate(port, termios, old, 0, max_baud);
1986 if (likely(baud && port->uartclk)) {
1987 if (s->cfg->type == PORT_HSCIF) {
1988 int frame_len = sci_baud_calc_frame_len(smr_val);
1989 sci_baud_calc_hscif(baud, port->uartclk, &t, &srr,
1992 t = sci_scbrr_calc(s, baud, port->uartclk);
1993 for (cks = 0; t >= 256 && cks <= 3; cks++)
2002 smr_val |= serial_port_in(port, SCSMR) & SCSMR_CKS;
2004 uart_update_timeout(port, termios->c_cflag, baud);
2006 dev_dbg(port->dev, "%s: SMR %x, cks %x, t %x, SCSCR %x\n",
2007 __func__, smr_val, cks, t, s->cfg->scscr);
2010 serial_port_out(port, SCSMR, (smr_val & ~SCSMR_CKS) | cks);
2011 serial_port_out(port, SCBRR, t);
2012 reg = sci_getreg(port, HSSRR);
2014 serial_port_out(port, HSSRR, srr | HSCIF_SRE);
2015 udelay((1000000+(baud-1)) / baud); /* Wait one bit interval */
2017 serial_port_out(port, SCSMR, smr_val);
2019 sci_init_pins(port, termios->c_cflag);
2021 reg = sci_getreg(port, SCFCR);
2023 unsigned short ctrl = serial_port_in(port, SCFCR);
2025 if (s->cfg->capabilities & SCIx_HAVE_RTSCTS) {
2026 if (termios->c_cflag & CRTSCTS)
2033 * As we've done a sci_reset() above, ensure we don't
2034 * interfere with the FIFOs while toggling MCE. As the
2035 * reset values could still be set, simply mask them out.
2037 ctrl &= ~(SCFCR_RFRST | SCFCR_TFRST);
2039 serial_port_out(port, SCFCR, ctrl);
2042 serial_port_out(port, SCSCR, s->cfg->scscr);
2044 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2046 * Calculate delay for 2 DMA buffers (4 FIFO).
2047 * See serial_core.c::uart_update_timeout().
2048 * With 10 bits (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above
2049 * function calculates 1 jiffie for the data plus 5 jiffies for the
2050 * "slop(e)." Then below we calculate 5 jiffies (20ms) for 2 DMA
2051 * buffers (4 FIFO sizes), but when performing a faster transfer, the
2052 * value obtained by this formula is too small. Therefore, if the value
2053 * is smaller than 20ms, use 20ms as the timeout value for DMA.
2058 /* byte size and parity */
2059 switch (termios->c_cflag & CSIZE) {
2074 if (termios->c_cflag & CSTOPB)
2076 if (termios->c_cflag & PARENB)
2078 s->rx_timeout = DIV_ROUND_UP((s->buf_len_rx * 2 * bits * HZ) /
2080 dev_dbg(port->dev, "DMA Rx t-out %ums, tty t-out %u jiffies\n",
2081 s->rx_timeout * 1000 / HZ, port->timeout);
2082 if (s->rx_timeout < msecs_to_jiffies(20))
2083 s->rx_timeout = msecs_to_jiffies(20);
2087 if ((termios->c_cflag & CREAD) != 0)
2090 sci_port_disable(s);
2093 static void sci_pm(struct uart_port *port, unsigned int state,
2094 unsigned int oldstate)
2096 struct sci_port *sci_port = to_sci_port(port);
2099 case UART_PM_STATE_OFF:
2100 sci_port_disable(sci_port);
2103 sci_port_enable(sci_port);
2108 static const char *sci_type(struct uart_port *port)
2110 switch (port->type) {
2128 static int sci_remap_port(struct uart_port *port)
2130 struct sci_port *sport = to_sci_port(port);
2133 * Nothing to do if there's already an established membase.
2138 if (port->flags & UPF_IOREMAP) {
2139 port->membase = ioremap_nocache(port->mapbase, sport->reg_size);
2140 if (unlikely(!port->membase)) {
2141 dev_err(port->dev, "can't remap port#%d\n", port->line);
2146 * For the simple (and majority of) cases where we don't
2147 * need to do any remapping, just cast the cookie
2150 port->membase = (void __iomem *)(uintptr_t)port->mapbase;
2156 static void sci_release_port(struct uart_port *port)
2158 struct sci_port *sport = to_sci_port(port);
2160 if (port->flags & UPF_IOREMAP) {
2161 iounmap(port->membase);
2162 port->membase = NULL;
2165 release_mem_region(port->mapbase, sport->reg_size);
2168 static int sci_request_port(struct uart_port *port)
2170 struct resource *res;
2171 struct sci_port *sport = to_sci_port(port);
2174 res = request_mem_region(port->mapbase, sport->reg_size,
2175 dev_name(port->dev));
2176 if (unlikely(res == NULL)) {
2177 dev_err(port->dev, "request_mem_region failed.");
2181 ret = sci_remap_port(port);
2182 if (unlikely(ret != 0)) {
2183 release_resource(res);
2190 static void sci_config_port(struct uart_port *port, int flags)
2192 if (flags & UART_CONFIG_TYPE) {
2193 struct sci_port *sport = to_sci_port(port);
2195 port->type = sport->cfg->type;
2196 sci_request_port(port);
2200 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
2202 if (ser->baud_base < 2400)
2203 /* No paper tape reader for Mitch.. */
2209 static struct uart_ops sci_uart_ops = {
2210 .tx_empty = sci_tx_empty,
2211 .set_mctrl = sci_set_mctrl,
2212 .get_mctrl = sci_get_mctrl,
2213 .start_tx = sci_start_tx,
2214 .stop_tx = sci_stop_tx,
2215 .stop_rx = sci_stop_rx,
2216 .break_ctl = sci_break_ctl,
2217 .startup = sci_startup,
2218 .shutdown = sci_shutdown,
2219 .flush_buffer = sci_flush_buffer,
2220 .set_termios = sci_set_termios,
2223 .release_port = sci_release_port,
2224 .request_port = sci_request_port,
2225 .config_port = sci_config_port,
2226 .verify_port = sci_verify_port,
2227 #ifdef CONFIG_CONSOLE_POLL
2228 .poll_get_char = sci_poll_get_char,
2229 .poll_put_char = sci_poll_put_char,
2233 static int sci_init_single(struct platform_device *dev,
2234 struct sci_port *sci_port, unsigned int index,
2235 struct plat_sci_port *p, bool early)
2237 struct uart_port *port = &sci_port->port;
2238 const struct resource *res;
2244 port->ops = &sci_uart_ops;
2245 port->iotype = UPIO_MEM;
2248 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
2252 port->mapbase = res->start;
2253 sci_port->reg_size = resource_size(res);
2255 for (i = 0; i < ARRAY_SIZE(sci_port->irqs); ++i)
2256 sci_port->irqs[i] = platform_get_irq(dev, i);
2258 /* The SCI generates several interrupts. They can be muxed together or
2259 * connected to different interrupt lines. In the muxed case only one
2260 * interrupt resource is specified. In the non-muxed case three or four
2261 * interrupt resources are specified, as the BRI interrupt is optional.
2263 if (sci_port->irqs[0] < 0)
2266 if (sci_port->irqs[1] < 0) {
2267 sci_port->irqs[1] = sci_port->irqs[0];
2268 sci_port->irqs[2] = sci_port->irqs[0];
2269 sci_port->irqs[3] = sci_port->irqs[0];
2272 if (p->regtype == SCIx_PROBE_REGTYPE) {
2273 ret = sci_probe_regmap(p);
2280 port->fifosize = 256;
2281 sci_port->overrun_reg = SCxSR;
2282 sci_port->overrun_mask = SCIFA_ORER;
2283 sci_port->sampling_rate = 16;
2286 port->fifosize = 128;
2287 sci_port->overrun_reg = SCLSR;
2288 sci_port->overrun_mask = SCLSR_ORER;
2289 sci_port->sampling_rate = 0;
2292 port->fifosize = 64;
2293 sci_port->overrun_reg = SCxSR;
2294 sci_port->overrun_mask = SCIFA_ORER;
2295 sci_port->sampling_rate = 16;
2298 port->fifosize = 16;
2299 if (p->regtype == SCIx_SH7705_SCIF_REGTYPE) {
2300 sci_port->overrun_reg = SCxSR;
2301 sci_port->overrun_mask = SCIFA_ORER;
2302 sci_port->sampling_rate = 16;
2304 sci_port->overrun_reg = SCLSR;
2305 sci_port->overrun_mask = SCLSR_ORER;
2306 sci_port->sampling_rate = 32;
2311 sci_port->overrun_reg = SCxSR;
2312 sci_port->overrun_mask = SCI_ORER;
2313 sci_port->sampling_rate = 32;
2317 /* SCIFA on sh7723 and sh7724 need a custom sampling rate that doesn't
2318 * match the SoC datasheet, this should be investigated. Let platform
2319 * data override the sampling rate for now.
2321 if (p->sampling_rate)
2322 sci_port->sampling_rate = p->sampling_rate;
2325 sci_port->iclk = clk_get(&dev->dev, "sci_ick");
2326 if (IS_ERR(sci_port->iclk)) {
2327 sci_port->iclk = clk_get(&dev->dev, "peripheral_clk");
2328 if (IS_ERR(sci_port->iclk)) {
2329 dev_err(&dev->dev, "can't get iclk\n");
2330 return PTR_ERR(sci_port->iclk);
2335 * The function clock is optional, ignore it if we can't
2338 sci_port->fclk = clk_get(&dev->dev, "sci_fck");
2339 if (IS_ERR(sci_port->fclk))
2340 sci_port->fclk = NULL;
2342 port->dev = &dev->dev;
2344 pm_runtime_enable(&dev->dev);
2347 sci_port->break_timer.data = (unsigned long)sci_port;
2348 sci_port->break_timer.function = sci_break_timer;
2349 init_timer(&sci_port->break_timer);
2352 * Establish some sensible defaults for the error detection.
2354 if (p->type == PORT_SCI) {
2355 sci_port->error_mask = SCI_DEFAULT_ERROR_MASK;
2356 sci_port->error_clear = SCI_ERROR_CLEAR;
2358 sci_port->error_mask = SCIF_DEFAULT_ERROR_MASK;
2359 sci_port->error_clear = SCIF_ERROR_CLEAR;
2363 * Make the error mask inclusive of overrun detection, if
2366 if (sci_port->overrun_reg == SCxSR) {
2367 sci_port->error_mask |= sci_port->overrun_mask;
2368 sci_port->error_clear &= ~sci_port->overrun_mask;
2371 port->type = p->type;
2372 port->flags = UPF_FIXED_PORT | p->flags;
2373 port->regshift = p->regshift;
2376 * The UART port needs an IRQ value, so we peg this to the RX IRQ
2377 * for the multi-IRQ ports, which is where we are primarily
2378 * concerned with the shutdown path synchronization.
2380 * For the muxed case there's nothing more to do.
2382 port->irq = sci_port->irqs[SCIx_RXI_IRQ];
2385 port->serial_in = sci_serial_in;
2386 port->serial_out = sci_serial_out;
2388 if (p->dma_slave_tx > 0 && p->dma_slave_rx > 0)
2389 dev_dbg(port->dev, "DMA tx %d, rx %d\n",
2390 p->dma_slave_tx, p->dma_slave_rx);
2395 static void sci_cleanup_single(struct sci_port *port)
2397 clk_put(port->iclk);
2398 clk_put(port->fclk);
2400 pm_runtime_disable(port->port.dev);
2403 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
2404 static void serial_console_putchar(struct uart_port *port, int ch)
2406 sci_poll_put_char(port, ch);
2410 * Print a string to the serial port trying not to disturb
2411 * any possible real use of the port...
2413 static void serial_console_write(struct console *co, const char *s,
2416 struct sci_port *sci_port = &sci_ports[co->index];
2417 struct uart_port *port = &sci_port->port;
2418 unsigned short bits, ctrl;
2419 unsigned long flags;
2422 local_irq_save(flags);
2425 else if (oops_in_progress)
2426 locked = spin_trylock(&port->lock);
2428 spin_lock(&port->lock);
2430 /* first save the SCSCR then disable the interrupts */
2431 ctrl = serial_port_in(port, SCSCR);
2432 serial_port_out(port, SCSCR, sci_port->cfg->scscr);
2434 uart_console_write(port, s, count, serial_console_putchar);
2436 /* wait until fifo is empty and last bit has been transmitted */
2437 bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
2438 while ((serial_port_in(port, SCxSR) & bits) != bits)
2441 /* restore the SCSCR */
2442 serial_port_out(port, SCSCR, ctrl);
2445 spin_unlock(&port->lock);
2446 local_irq_restore(flags);
2449 static int serial_console_setup(struct console *co, char *options)
2451 struct sci_port *sci_port;
2452 struct uart_port *port;
2460 * Refuse to handle any bogus ports.
2462 if (co->index < 0 || co->index >= SCI_NPORTS)
2465 sci_port = &sci_ports[co->index];
2466 port = &sci_port->port;
2469 * Refuse to handle uninitialized ports.
2474 ret = sci_remap_port(port);
2475 if (unlikely(ret != 0))
2479 uart_parse_options(options, &baud, &parity, &bits, &flow);
2481 return uart_set_options(port, co, baud, parity, bits, flow);
2484 static struct console serial_console = {
2486 .device = uart_console_device,
2487 .write = serial_console_write,
2488 .setup = serial_console_setup,
2489 .flags = CON_PRINTBUFFER,
2491 .data = &sci_uart_driver,
2494 static struct console early_serial_console = {
2495 .name = "early_ttySC",
2496 .write = serial_console_write,
2497 .flags = CON_PRINTBUFFER,
2501 static char early_serial_buf[32];
2503 static int sci_probe_earlyprintk(struct platform_device *pdev)
2505 struct plat_sci_port *cfg = dev_get_platdata(&pdev->dev);
2507 if (early_serial_console.data)
2510 early_serial_console.index = pdev->id;
2512 sci_init_single(pdev, &sci_ports[pdev->id], pdev->id, cfg, true);
2514 serial_console_setup(&early_serial_console, early_serial_buf);
2516 if (!strstr(early_serial_buf, "keep"))
2517 early_serial_console.flags |= CON_BOOT;
2519 register_console(&early_serial_console);
2523 #define SCI_CONSOLE (&serial_console)
2526 static inline int sci_probe_earlyprintk(struct platform_device *pdev)
2531 #define SCI_CONSOLE NULL
2533 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
2535 static const char banner[] __initconst = "SuperH (H)SCI(F) driver initialized";
2537 static struct uart_driver sci_uart_driver = {
2538 .owner = THIS_MODULE,
2539 .driver_name = "sci",
2540 .dev_name = "ttySC",
2542 .minor = SCI_MINOR_START,
2544 .cons = SCI_CONSOLE,
2547 static int sci_remove(struct platform_device *dev)
2549 struct sci_port *port = platform_get_drvdata(dev);
2551 uart_remove_one_port(&sci_uart_driver, &port->port);
2553 sci_cleanup_single(port);
2558 struct sci_port_info {
2560 unsigned int regtype;
2563 static const struct of_device_id of_sci_match[] = {
2565 .compatible = "renesas,scif",
2566 .data = &(const struct sci_port_info) {
2568 .regtype = SCIx_SH4_SCIF_REGTYPE,
2571 .compatible = "renesas,scifa",
2572 .data = &(const struct sci_port_info) {
2574 .regtype = SCIx_SCIFA_REGTYPE,
2577 .compatible = "renesas,scifb",
2578 .data = &(const struct sci_port_info) {
2580 .regtype = SCIx_SCIFB_REGTYPE,
2583 .compatible = "renesas,hscif",
2584 .data = &(const struct sci_port_info) {
2586 .regtype = SCIx_HSCIF_REGTYPE,
2589 .compatible = "renesas,sci",
2590 .data = &(const struct sci_port_info) {
2592 .regtype = SCIx_SCI_REGTYPE,
2598 MODULE_DEVICE_TABLE(of, of_sci_match);
2600 static struct plat_sci_port *
2601 sci_parse_dt(struct platform_device *pdev, unsigned int *dev_id)
2603 struct device_node *np = pdev->dev.of_node;
2604 const struct of_device_id *match;
2605 const struct sci_port_info *info;
2606 struct plat_sci_port *p;
2609 if (!IS_ENABLED(CONFIG_OF) || !np)
2612 match = of_match_node(of_sci_match, pdev->dev.of_node);
2618 p = devm_kzalloc(&pdev->dev, sizeof(struct plat_sci_port), GFP_KERNEL);
2622 /* Get the line number for the aliases node. */
2623 id = of_alias_get_id(np, "serial");
2625 dev_err(&pdev->dev, "failed to get alias id (%d)\n", id);
2631 p->flags = UPF_IOREMAP | UPF_BOOT_AUTOCONF;
2632 p->type = info->type;
2633 p->regtype = info->regtype;
2634 p->scscr = SCSCR_RE | SCSCR_TE;
2639 static int sci_probe_single(struct platform_device *dev,
2641 struct plat_sci_port *p,
2642 struct sci_port *sciport)
2647 if (unlikely(index >= SCI_NPORTS)) {
2648 dev_notice(&dev->dev, "Attempting to register port %d when only %d are available\n",
2649 index+1, SCI_NPORTS);
2650 dev_notice(&dev->dev, "Consider bumping CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
2654 ret = sci_init_single(dev, sciport, index, p, false);
2658 ret = uart_add_one_port(&sci_uart_driver, &sciport->port);
2660 sci_cleanup_single(sciport);
2667 static int sci_probe(struct platform_device *dev)
2669 struct plat_sci_port *p;
2670 struct sci_port *sp;
2671 unsigned int dev_id;
2675 * If we've come here via earlyprintk initialization, head off to
2676 * the special early probe. We don't have sufficient device state
2677 * to make it beyond this yet.
2679 if (is_early_platform_device(dev))
2680 return sci_probe_earlyprintk(dev);
2682 if (dev->dev.of_node) {
2683 p = sci_parse_dt(dev, &dev_id);
2687 p = dev->dev.platform_data;
2689 dev_err(&dev->dev, "no platform data supplied\n");
2696 sp = &sci_ports[dev_id];
2697 platform_set_drvdata(dev, sp);
2699 ret = sci_probe_single(dev, dev_id, p, sp);
2703 #ifdef CONFIG_SH_STANDARD_BIOS
2704 sh_bios_gdb_detach();
2710 static __maybe_unused int sci_suspend(struct device *dev)
2712 struct sci_port *sport = dev_get_drvdata(dev);
2715 uart_suspend_port(&sci_uart_driver, &sport->port);
2720 static __maybe_unused int sci_resume(struct device *dev)
2722 struct sci_port *sport = dev_get_drvdata(dev);
2725 uart_resume_port(&sci_uart_driver, &sport->port);
2730 static SIMPLE_DEV_PM_OPS(sci_dev_pm_ops, sci_suspend, sci_resume);
2732 static struct platform_driver sci_driver = {
2734 .remove = sci_remove,
2737 .pm = &sci_dev_pm_ops,
2738 .of_match_table = of_match_ptr(of_sci_match),
2742 static int __init sci_init(void)
2746 pr_info("%s\n", banner);
2748 ret = uart_register_driver(&sci_uart_driver);
2749 if (likely(ret == 0)) {
2750 ret = platform_driver_register(&sci_driver);
2752 uart_unregister_driver(&sci_uart_driver);
2758 static void __exit sci_exit(void)
2760 platform_driver_unregister(&sci_driver);
2761 uart_unregister_driver(&sci_uart_driver);
2764 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
2765 early_platform_init_buffer("earlyprintk", &sci_driver,
2766 early_serial_buf, ARRAY_SIZE(early_serial_buf));
2768 module_init(sci_init);
2769 module_exit(sci_exit);
2771 MODULE_LICENSE("GPL");
2772 MODULE_ALIAS("platform:sh-sci");
2773 MODULE_AUTHOR("Paul Mundt");
2774 MODULE_DESCRIPTION("SuperH (H)SCI(F) serial driver");