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>
41 #include <linux/notifier.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>
62 /* Offsets into the sci_port->irqs array */
70 SCIx_MUX_IRQ = SCIx_NR_IRQS, /* special case */
73 #define SCIx_IRQ_IS_MUXED(port) \
74 ((port)->irqs[SCIx_ERI_IRQ] == \
75 (port)->irqs[SCIx_RXI_IRQ]) || \
76 ((port)->irqs[SCIx_ERI_IRQ] && \
77 ((port)->irqs[SCIx_RXI_IRQ] < 0))
80 struct uart_port port;
82 /* Platform configuration */
83 struct plat_sci_port *cfg;
84 unsigned int overrun_reg;
85 unsigned int overrun_mask;
86 unsigned int error_mask;
87 unsigned int error_clear;
88 unsigned int sampling_rate;
89 resource_size_t reg_size;
92 struct timer_list break_timer;
100 int irqs[SCIx_NR_IRQS];
101 char *irqstr[SCIx_NR_IRQS];
103 struct dma_chan *chan_tx;
104 struct dma_chan *chan_rx;
106 #ifdef CONFIG_SERIAL_SH_SCI_DMA
107 dma_cookie_t cookie_tx;
108 dma_cookie_t cookie_rx[2];
109 dma_cookie_t active_rx;
110 dma_addr_t tx_dma_addr;
111 unsigned int tx_dma_len;
112 struct scatterlist sg_rx[2];
115 struct sh_dmae_slave param_tx;
116 struct sh_dmae_slave param_rx;
117 struct work_struct work_tx;
118 struct work_struct work_rx;
119 struct timer_list rx_timer;
120 unsigned int rx_timeout;
123 struct notifier_block freq_transition;
126 /* Function prototypes */
127 static void sci_start_tx(struct uart_port *port);
128 static void sci_stop_tx(struct uart_port *port);
129 static void sci_start_rx(struct uart_port *port);
131 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
133 static struct sci_port sci_ports[SCI_NPORTS];
134 static struct uart_driver sci_uart_driver;
136 static inline struct sci_port *
137 to_sci_port(struct uart_port *uart)
139 return container_of(uart, struct sci_port, port);
142 struct plat_sci_reg {
146 /* Helper for invalidating specific entries of an inherited map. */
147 #define sci_reg_invalid { .offset = 0, .size = 0 }
149 static const struct plat_sci_reg sci_regmap[SCIx_NR_REGTYPES][SCIx_NR_REGS] = {
150 [SCIx_PROBE_REGTYPE] = {
151 [0 ... SCIx_NR_REGS - 1] = sci_reg_invalid,
155 * Common SCI definitions, dependent on the port's regshift
158 [SCIx_SCI_REGTYPE] = {
159 [SCSMR] = { 0x00, 8 },
160 [SCBRR] = { 0x01, 8 },
161 [SCSCR] = { 0x02, 8 },
162 [SCxTDR] = { 0x03, 8 },
163 [SCxSR] = { 0x04, 8 },
164 [SCxRDR] = { 0x05, 8 },
165 [SCFCR] = sci_reg_invalid,
166 [SCFDR] = sci_reg_invalid,
167 [SCTFDR] = sci_reg_invalid,
168 [SCRFDR] = sci_reg_invalid,
169 [SCSPTR] = sci_reg_invalid,
170 [SCLSR] = sci_reg_invalid,
171 [HSSRR] = sci_reg_invalid,
172 [SCPCR] = sci_reg_invalid,
173 [SCPDR] = sci_reg_invalid,
177 * Common definitions for legacy IrDA ports, dependent on
180 [SCIx_IRDA_REGTYPE] = {
181 [SCSMR] = { 0x00, 8 },
182 [SCBRR] = { 0x01, 8 },
183 [SCSCR] = { 0x02, 8 },
184 [SCxTDR] = { 0x03, 8 },
185 [SCxSR] = { 0x04, 8 },
186 [SCxRDR] = { 0x05, 8 },
187 [SCFCR] = { 0x06, 8 },
188 [SCFDR] = { 0x07, 16 },
189 [SCTFDR] = sci_reg_invalid,
190 [SCRFDR] = sci_reg_invalid,
191 [SCSPTR] = sci_reg_invalid,
192 [SCLSR] = sci_reg_invalid,
193 [HSSRR] = sci_reg_invalid,
194 [SCPCR] = sci_reg_invalid,
195 [SCPDR] = sci_reg_invalid,
199 * Common SCIFA definitions.
201 [SCIx_SCIFA_REGTYPE] = {
202 [SCSMR] = { 0x00, 16 },
203 [SCBRR] = { 0x04, 8 },
204 [SCSCR] = { 0x08, 16 },
205 [SCxTDR] = { 0x20, 8 },
206 [SCxSR] = { 0x14, 16 },
207 [SCxRDR] = { 0x24, 8 },
208 [SCFCR] = { 0x18, 16 },
209 [SCFDR] = { 0x1c, 16 },
210 [SCTFDR] = sci_reg_invalid,
211 [SCRFDR] = sci_reg_invalid,
212 [SCSPTR] = sci_reg_invalid,
213 [SCLSR] = sci_reg_invalid,
214 [HSSRR] = sci_reg_invalid,
215 [SCPCR] = { 0x30, 16 },
216 [SCPDR] = { 0x34, 16 },
220 * Common SCIFB definitions.
222 [SCIx_SCIFB_REGTYPE] = {
223 [SCSMR] = { 0x00, 16 },
224 [SCBRR] = { 0x04, 8 },
225 [SCSCR] = { 0x08, 16 },
226 [SCxTDR] = { 0x40, 8 },
227 [SCxSR] = { 0x14, 16 },
228 [SCxRDR] = { 0x60, 8 },
229 [SCFCR] = { 0x18, 16 },
230 [SCFDR] = sci_reg_invalid,
231 [SCTFDR] = { 0x38, 16 },
232 [SCRFDR] = { 0x3c, 16 },
233 [SCSPTR] = sci_reg_invalid,
234 [SCLSR] = sci_reg_invalid,
235 [HSSRR] = sci_reg_invalid,
236 [SCPCR] = { 0x30, 16 },
237 [SCPDR] = { 0x34, 16 },
241 * Common SH-2(A) SCIF definitions for ports with FIFO data
244 [SCIx_SH2_SCIF_FIFODATA_REGTYPE] = {
245 [SCSMR] = { 0x00, 16 },
246 [SCBRR] = { 0x04, 8 },
247 [SCSCR] = { 0x08, 16 },
248 [SCxTDR] = { 0x0c, 8 },
249 [SCxSR] = { 0x10, 16 },
250 [SCxRDR] = { 0x14, 8 },
251 [SCFCR] = { 0x18, 16 },
252 [SCFDR] = { 0x1c, 16 },
253 [SCTFDR] = sci_reg_invalid,
254 [SCRFDR] = sci_reg_invalid,
255 [SCSPTR] = { 0x20, 16 },
256 [SCLSR] = { 0x24, 16 },
257 [HSSRR] = sci_reg_invalid,
258 [SCPCR] = sci_reg_invalid,
259 [SCPDR] = sci_reg_invalid,
263 * Common SH-3 SCIF definitions.
265 [SCIx_SH3_SCIF_REGTYPE] = {
266 [SCSMR] = { 0x00, 8 },
267 [SCBRR] = { 0x02, 8 },
268 [SCSCR] = { 0x04, 8 },
269 [SCxTDR] = { 0x06, 8 },
270 [SCxSR] = { 0x08, 16 },
271 [SCxRDR] = { 0x0a, 8 },
272 [SCFCR] = { 0x0c, 8 },
273 [SCFDR] = { 0x0e, 16 },
274 [SCTFDR] = sci_reg_invalid,
275 [SCRFDR] = sci_reg_invalid,
276 [SCSPTR] = sci_reg_invalid,
277 [SCLSR] = sci_reg_invalid,
278 [HSSRR] = sci_reg_invalid,
279 [SCPCR] = sci_reg_invalid,
280 [SCPDR] = sci_reg_invalid,
284 * Common SH-4(A) SCIF(B) definitions.
286 [SCIx_SH4_SCIF_REGTYPE] = {
287 [SCSMR] = { 0x00, 16 },
288 [SCBRR] = { 0x04, 8 },
289 [SCSCR] = { 0x08, 16 },
290 [SCxTDR] = { 0x0c, 8 },
291 [SCxSR] = { 0x10, 16 },
292 [SCxRDR] = { 0x14, 8 },
293 [SCFCR] = { 0x18, 16 },
294 [SCFDR] = { 0x1c, 16 },
295 [SCTFDR] = sci_reg_invalid,
296 [SCRFDR] = sci_reg_invalid,
297 [SCSPTR] = { 0x20, 16 },
298 [SCLSR] = { 0x24, 16 },
299 [HSSRR] = sci_reg_invalid,
300 [SCPCR] = sci_reg_invalid,
301 [SCPDR] = sci_reg_invalid,
305 * Common HSCIF definitions.
307 [SCIx_HSCIF_REGTYPE] = {
308 [SCSMR] = { 0x00, 16 },
309 [SCBRR] = { 0x04, 8 },
310 [SCSCR] = { 0x08, 16 },
311 [SCxTDR] = { 0x0c, 8 },
312 [SCxSR] = { 0x10, 16 },
313 [SCxRDR] = { 0x14, 8 },
314 [SCFCR] = { 0x18, 16 },
315 [SCFDR] = { 0x1c, 16 },
316 [SCTFDR] = sci_reg_invalid,
317 [SCRFDR] = sci_reg_invalid,
318 [SCSPTR] = { 0x20, 16 },
319 [SCLSR] = { 0x24, 16 },
320 [HSSRR] = { 0x40, 16 },
321 [SCPCR] = sci_reg_invalid,
322 [SCPDR] = sci_reg_invalid,
326 * Common SH-4(A) SCIF(B) definitions for ports without an SCSPTR
329 [SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE] = {
330 [SCSMR] = { 0x00, 16 },
331 [SCBRR] = { 0x04, 8 },
332 [SCSCR] = { 0x08, 16 },
333 [SCxTDR] = { 0x0c, 8 },
334 [SCxSR] = { 0x10, 16 },
335 [SCxRDR] = { 0x14, 8 },
336 [SCFCR] = { 0x18, 16 },
337 [SCFDR] = { 0x1c, 16 },
338 [SCTFDR] = sci_reg_invalid,
339 [SCRFDR] = sci_reg_invalid,
340 [SCSPTR] = sci_reg_invalid,
341 [SCLSR] = { 0x24, 16 },
342 [HSSRR] = sci_reg_invalid,
343 [SCPCR] = sci_reg_invalid,
344 [SCPDR] = sci_reg_invalid,
348 * Common SH-4(A) SCIF(B) definitions for ports with FIFO data
351 [SCIx_SH4_SCIF_FIFODATA_REGTYPE] = {
352 [SCSMR] = { 0x00, 16 },
353 [SCBRR] = { 0x04, 8 },
354 [SCSCR] = { 0x08, 16 },
355 [SCxTDR] = { 0x0c, 8 },
356 [SCxSR] = { 0x10, 16 },
357 [SCxRDR] = { 0x14, 8 },
358 [SCFCR] = { 0x18, 16 },
359 [SCFDR] = { 0x1c, 16 },
360 [SCTFDR] = { 0x1c, 16 }, /* aliased to SCFDR */
361 [SCRFDR] = { 0x20, 16 },
362 [SCSPTR] = { 0x24, 16 },
363 [SCLSR] = { 0x28, 16 },
364 [HSSRR] = sci_reg_invalid,
365 [SCPCR] = sci_reg_invalid,
366 [SCPDR] = sci_reg_invalid,
370 * SH7705-style SCIF(B) ports, lacking both SCSPTR and SCLSR
373 [SCIx_SH7705_SCIF_REGTYPE] = {
374 [SCSMR] = { 0x00, 16 },
375 [SCBRR] = { 0x04, 8 },
376 [SCSCR] = { 0x08, 16 },
377 [SCxTDR] = { 0x20, 8 },
378 [SCxSR] = { 0x14, 16 },
379 [SCxRDR] = { 0x24, 8 },
380 [SCFCR] = { 0x18, 16 },
381 [SCFDR] = { 0x1c, 16 },
382 [SCTFDR] = sci_reg_invalid,
383 [SCRFDR] = sci_reg_invalid,
384 [SCSPTR] = sci_reg_invalid,
385 [SCLSR] = sci_reg_invalid,
386 [HSSRR] = sci_reg_invalid,
387 [SCPCR] = sci_reg_invalid,
388 [SCPDR] = sci_reg_invalid,
392 #define sci_getreg(up, offset) (sci_regmap[to_sci_port(up)->cfg->regtype] + offset)
395 * The "offset" here is rather misleading, in that it refers to an enum
396 * value relative to the port mapping rather than the fixed offset
397 * itself, which needs to be manually retrieved from the platform's
398 * register map for the given port.
400 static unsigned int sci_serial_in(struct uart_port *p, int offset)
402 const struct plat_sci_reg *reg = sci_getreg(p, offset);
405 return ioread8(p->membase + (reg->offset << p->regshift));
406 else if (reg->size == 16)
407 return ioread16(p->membase + (reg->offset << p->regshift));
409 WARN(1, "Invalid register access\n");
414 static void sci_serial_out(struct uart_port *p, int offset, int value)
416 const struct plat_sci_reg *reg = sci_getreg(p, offset);
419 iowrite8(value, p->membase + (reg->offset << p->regshift));
420 else if (reg->size == 16)
421 iowrite16(value, p->membase + (reg->offset << p->regshift));
423 WARN(1, "Invalid register access\n");
426 static int sci_probe_regmap(struct plat_sci_port *cfg)
430 cfg->regtype = SCIx_SCI_REGTYPE;
433 cfg->regtype = SCIx_IRDA_REGTYPE;
436 cfg->regtype = SCIx_SCIFA_REGTYPE;
439 cfg->regtype = SCIx_SCIFB_REGTYPE;
443 * The SH-4 is a bit of a misnomer here, although that's
444 * where this particular port layout originated. This
445 * configuration (or some slight variation thereof)
446 * remains the dominant model for all SCIFs.
448 cfg->regtype = SCIx_SH4_SCIF_REGTYPE;
451 cfg->regtype = SCIx_HSCIF_REGTYPE;
454 pr_err("Can't probe register map for given port\n");
461 static void sci_port_enable(struct sci_port *sci_port)
463 if (!sci_port->port.dev)
466 pm_runtime_get_sync(sci_port->port.dev);
468 clk_prepare_enable(sci_port->iclk);
469 sci_port->port.uartclk = clk_get_rate(sci_port->iclk);
470 clk_prepare_enable(sci_port->fclk);
473 static void sci_port_disable(struct sci_port *sci_port)
475 if (!sci_port->port.dev)
478 /* Cancel the break timer to ensure that the timer handler will not try
479 * to access the hardware with clocks and power disabled. Reset the
480 * break flag to make the break debouncing state machine ready for the
483 del_timer_sync(&sci_port->break_timer);
484 sci_port->break_flag = 0;
486 clk_disable_unprepare(sci_port->fclk);
487 clk_disable_unprepare(sci_port->iclk);
489 pm_runtime_put_sync(sci_port->port.dev);
492 static void sci_clear_SCxSR(struct uart_port *port, unsigned int mask)
494 if (port->type == PORT_SCI) {
495 /* Just store the mask */
496 serial_port_out(port, SCxSR, mask);
497 } else if (to_sci_port(port)->overrun_mask == SCIFA_ORER) {
498 /* SCIFA/SCIFB and SCIF on SH7705/SH7720/SH7721 */
499 /* Only clear the status bits we want to clear */
500 serial_port_out(port, SCxSR,
501 serial_port_in(port, SCxSR) & mask);
503 /* Store the mask, clear parity/framing errors */
504 serial_port_out(port, SCxSR, mask & ~(SCIF_FERC | SCIF_PERC));
508 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
510 #ifdef CONFIG_CONSOLE_POLL
511 static int sci_poll_get_char(struct uart_port *port)
513 unsigned short status;
517 status = serial_port_in(port, SCxSR);
518 if (status & SCxSR_ERRORS(port)) {
519 sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
525 if (!(status & SCxSR_RDxF(port)))
528 c = serial_port_in(port, SCxRDR);
531 serial_port_in(port, SCxSR);
532 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
538 static void sci_poll_put_char(struct uart_port *port, unsigned char c)
540 unsigned short status;
543 status = serial_port_in(port, SCxSR);
544 } while (!(status & SCxSR_TDxE(port)));
546 serial_port_out(port, SCxTDR, c);
547 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port) & ~SCxSR_TEND(port));
549 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE */
551 static void sci_init_pins(struct uart_port *port, unsigned int cflag)
553 struct sci_port *s = to_sci_port(port);
554 const struct plat_sci_reg *reg = sci_regmap[s->cfg->regtype] + SCSPTR;
557 * Use port-specific handler if provided.
559 if (s->cfg->ops && s->cfg->ops->init_pins) {
560 s->cfg->ops->init_pins(port, cflag);
565 * For the generic path SCSPTR is necessary. Bail out if that's
571 if ((s->cfg->capabilities & SCIx_HAVE_RTSCTS) &&
572 ((!(cflag & CRTSCTS)))) {
573 unsigned short status;
575 status = serial_port_in(port, SCSPTR);
576 status &= ~SCSPTR_CTSIO;
577 status |= SCSPTR_RTSIO;
578 serial_port_out(port, SCSPTR, status); /* Set RTS = 1 */
582 static int sci_txfill(struct uart_port *port)
584 const struct plat_sci_reg *reg;
586 reg = sci_getreg(port, SCTFDR);
588 return serial_port_in(port, SCTFDR) & ((port->fifosize << 1) - 1);
590 reg = sci_getreg(port, SCFDR);
592 return serial_port_in(port, SCFDR) >> 8;
594 return !(serial_port_in(port, SCxSR) & SCI_TDRE);
597 static int sci_txroom(struct uart_port *port)
599 return port->fifosize - sci_txfill(port);
602 static int sci_rxfill(struct uart_port *port)
604 const struct plat_sci_reg *reg;
606 reg = sci_getreg(port, SCRFDR);
608 return serial_port_in(port, SCRFDR) & ((port->fifosize << 1) - 1);
610 reg = sci_getreg(port, SCFDR);
612 return serial_port_in(port, SCFDR) & ((port->fifosize << 1) - 1);
614 return (serial_port_in(port, SCxSR) & SCxSR_RDxF(port)) != 0;
618 * SCI helper for checking the state of the muxed port/RXD pins.
620 static inline int sci_rxd_in(struct uart_port *port)
622 struct sci_port *s = to_sci_port(port);
624 if (s->cfg->port_reg <= 0)
627 /* Cast for ARM damage */
628 return !!__raw_readb((void __iomem *)(uintptr_t)s->cfg->port_reg);
631 /* ********************************************************************** *
632 * the interrupt related routines *
633 * ********************************************************************** */
635 static void sci_transmit_chars(struct uart_port *port)
637 struct circ_buf *xmit = &port->state->xmit;
638 unsigned int stopped = uart_tx_stopped(port);
639 unsigned short status;
643 status = serial_port_in(port, SCxSR);
644 if (!(status & SCxSR_TDxE(port))) {
645 ctrl = serial_port_in(port, SCSCR);
646 if (uart_circ_empty(xmit))
650 serial_port_out(port, SCSCR, ctrl);
654 count = sci_txroom(port);
662 } else if (!uart_circ_empty(xmit) && !stopped) {
663 c = xmit->buf[xmit->tail];
664 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
669 serial_port_out(port, SCxTDR, c);
672 } while (--count > 0);
674 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
676 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
677 uart_write_wakeup(port);
678 if (uart_circ_empty(xmit)) {
681 ctrl = serial_port_in(port, SCSCR);
683 if (port->type != PORT_SCI) {
684 serial_port_in(port, SCxSR); /* Dummy read */
685 sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
689 serial_port_out(port, SCSCR, ctrl);
693 /* On SH3, SCIF may read end-of-break as a space->mark char */
694 #define STEPFN(c) ({int __c = (c); (((__c-1)|(__c)) == -1); })
696 static void sci_receive_chars(struct uart_port *port)
698 struct sci_port *sci_port = to_sci_port(port);
699 struct tty_port *tport = &port->state->port;
700 int i, count, copied = 0;
701 unsigned short status;
704 status = serial_port_in(port, SCxSR);
705 if (!(status & SCxSR_RDxF(port)))
709 /* Don't copy more bytes than there is room for in the buffer */
710 count = tty_buffer_request_room(tport, sci_rxfill(port));
712 /* If for any reason we can't copy more data, we're done! */
716 if (port->type == PORT_SCI) {
717 char c = serial_port_in(port, SCxRDR);
718 if (uart_handle_sysrq_char(port, c) ||
719 sci_port->break_flag)
722 tty_insert_flip_char(tport, c, TTY_NORMAL);
724 for (i = 0; i < count; i++) {
725 char c = serial_port_in(port, SCxRDR);
727 status = serial_port_in(port, SCxSR);
728 #if defined(CONFIG_CPU_SH3)
729 /* Skip "chars" during break */
730 if (sci_port->break_flag) {
732 (status & SCxSR_FER(port))) {
737 /* Nonzero => end-of-break */
738 dev_dbg(port->dev, "debounce<%02x>\n", c);
739 sci_port->break_flag = 0;
746 #endif /* CONFIG_CPU_SH3 */
747 if (uart_handle_sysrq_char(port, c)) {
752 /* Store data and status */
753 if (status & SCxSR_FER(port)) {
755 port->icount.frame++;
756 dev_notice(port->dev, "frame error\n");
757 } else if (status & SCxSR_PER(port)) {
759 port->icount.parity++;
760 dev_notice(port->dev, "parity error\n");
764 tty_insert_flip_char(tport, c, flag);
768 serial_port_in(port, SCxSR); /* dummy read */
769 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
772 port->icount.rx += count;
776 /* Tell the rest of the system the news. New characters! */
777 tty_flip_buffer_push(tport);
779 serial_port_in(port, SCxSR); /* dummy read */
780 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
784 #define SCI_BREAK_JIFFIES (HZ/20)
787 * The sci generates interrupts during the break,
788 * 1 per millisecond or so during the break period, for 9600 baud.
789 * So dont bother disabling interrupts.
790 * But dont want more than 1 break event.
791 * Use a kernel timer to periodically poll the rx line until
792 * the break is finished.
794 static inline void sci_schedule_break_timer(struct sci_port *port)
796 mod_timer(&port->break_timer, jiffies + SCI_BREAK_JIFFIES);
799 /* Ensure that two consecutive samples find the break over. */
800 static void sci_break_timer(unsigned long data)
802 struct sci_port *port = (struct sci_port *)data;
804 if (sci_rxd_in(&port->port) == 0) {
805 port->break_flag = 1;
806 sci_schedule_break_timer(port);
807 } else if (port->break_flag == 1) {
809 port->break_flag = 2;
810 sci_schedule_break_timer(port);
812 port->break_flag = 0;
815 static int sci_handle_errors(struct uart_port *port)
818 unsigned short status = serial_port_in(port, SCxSR);
819 struct tty_port *tport = &port->state->port;
820 struct sci_port *s = to_sci_port(port);
822 /* Handle overruns */
823 if (status & s->overrun_mask) {
824 port->icount.overrun++;
827 if (tty_insert_flip_char(tport, 0, TTY_OVERRUN))
830 dev_notice(port->dev, "overrun error\n");
833 if (status & SCxSR_FER(port)) {
834 if (sci_rxd_in(port) == 0) {
835 /* Notify of BREAK */
836 struct sci_port *sci_port = to_sci_port(port);
838 if (!sci_port->break_flag) {
841 sci_port->break_flag = 1;
842 sci_schedule_break_timer(sci_port);
844 /* Do sysrq handling. */
845 if (uart_handle_break(port))
848 dev_dbg(port->dev, "BREAK detected\n");
850 if (tty_insert_flip_char(tport, 0, TTY_BREAK))
856 port->icount.frame++;
858 if (tty_insert_flip_char(tport, 0, TTY_FRAME))
861 dev_notice(port->dev, "frame error\n");
865 if (status & SCxSR_PER(port)) {
867 port->icount.parity++;
869 if (tty_insert_flip_char(tport, 0, TTY_PARITY))
872 dev_notice(port->dev, "parity error\n");
876 tty_flip_buffer_push(tport);
881 static int sci_handle_fifo_overrun(struct uart_port *port)
883 struct tty_port *tport = &port->state->port;
884 struct sci_port *s = to_sci_port(port);
885 const struct plat_sci_reg *reg;
889 reg = sci_getreg(port, s->overrun_reg);
893 status = serial_port_in(port, s->overrun_reg);
894 if (status & s->overrun_mask) {
895 status &= ~s->overrun_mask;
896 serial_port_out(port, s->overrun_reg, status);
898 port->icount.overrun++;
900 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
901 tty_flip_buffer_push(tport);
903 dev_dbg(port->dev, "overrun error\n");
910 static int sci_handle_breaks(struct uart_port *port)
913 unsigned short status = serial_port_in(port, SCxSR);
914 struct tty_port *tport = &port->state->port;
915 struct sci_port *s = to_sci_port(port);
917 if (uart_handle_break(port))
920 if (!s->break_flag && status & SCxSR_BRK(port)) {
921 #if defined(CONFIG_CPU_SH3)
928 /* Notify of BREAK */
929 if (tty_insert_flip_char(tport, 0, TTY_BREAK))
932 dev_dbg(port->dev, "BREAK detected\n");
936 tty_flip_buffer_push(tport);
938 copied += sci_handle_fifo_overrun(port);
943 static irqreturn_t sci_rx_interrupt(int irq, void *ptr)
945 #ifdef CONFIG_SERIAL_SH_SCI_DMA
946 struct uart_port *port = ptr;
947 struct sci_port *s = to_sci_port(port);
950 u16 scr = serial_port_in(port, SCSCR);
951 u16 ssr = serial_port_in(port, SCxSR);
953 /* Disable future Rx interrupts */
954 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
955 disable_irq_nosync(irq);
960 serial_port_out(port, SCSCR, scr);
961 /* Clear current interrupt */
962 serial_port_out(port, SCxSR,
963 ssr & ~(SCIF_DR | SCxSR_RDxF(port)));
964 dev_dbg(port->dev, "Rx IRQ %lu: setup t-out in %u jiffies\n",
965 jiffies, s->rx_timeout);
966 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
972 /* I think sci_receive_chars has to be called irrespective
973 * of whether the I_IXOFF is set, otherwise, how is the interrupt
976 sci_receive_chars(ptr);
981 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
983 struct uart_port *port = ptr;
986 spin_lock_irqsave(&port->lock, flags);
987 sci_transmit_chars(port);
988 spin_unlock_irqrestore(&port->lock, flags);
993 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
995 struct uart_port *port = ptr;
996 struct sci_port *s = to_sci_port(port);
999 if (port->type == PORT_SCI) {
1000 if (sci_handle_errors(port)) {
1001 /* discard character in rx buffer */
1002 serial_port_in(port, SCxSR);
1003 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
1006 sci_handle_fifo_overrun(port);
1008 sci_receive_chars(ptr);
1011 sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
1013 /* Kick the transmission */
1015 sci_tx_interrupt(irq, ptr);
1020 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
1022 struct uart_port *port = ptr;
1025 sci_handle_breaks(port);
1026 sci_clear_SCxSR(port, SCxSR_BREAK_CLEAR(port));
1031 static inline unsigned long port_rx_irq_mask(struct uart_port *port)
1034 * Not all ports (such as SCIFA) will support REIE. Rather than
1035 * special-casing the port type, we check the port initialization
1036 * IRQ enable mask to see whether the IRQ is desired at all. If
1037 * it's unset, it's logically inferred that there's no point in
1040 return SCSCR_RIE | (to_sci_port(port)->cfg->scscr & SCSCR_REIE);
1043 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
1045 unsigned short ssr_status, scr_status, err_enabled, orer_status = 0;
1046 struct uart_port *port = ptr;
1047 struct sci_port *s = to_sci_port(port);
1048 irqreturn_t ret = IRQ_NONE;
1050 ssr_status = serial_port_in(port, SCxSR);
1051 scr_status = serial_port_in(port, SCSCR);
1052 if (s->overrun_reg == SCxSR)
1053 orer_status = ssr_status;
1055 if (sci_getreg(port, s->overrun_reg)->size)
1056 orer_status = serial_port_in(port, s->overrun_reg);
1059 err_enabled = scr_status & port_rx_irq_mask(port);
1062 if ((ssr_status & SCxSR_TDxE(port)) && (scr_status & SCSCR_TIE) &&
1064 ret = sci_tx_interrupt(irq, ptr);
1067 * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
1070 if (((ssr_status & SCxSR_RDxF(port)) || s->chan_rx) &&
1071 (scr_status & SCSCR_RIE))
1072 ret = sci_rx_interrupt(irq, ptr);
1074 /* Error Interrupt */
1075 if ((ssr_status & SCxSR_ERRORS(port)) && err_enabled)
1076 ret = sci_er_interrupt(irq, ptr);
1078 /* Break Interrupt */
1079 if ((ssr_status & SCxSR_BRK(port)) && err_enabled)
1080 ret = sci_br_interrupt(irq, ptr);
1082 /* Overrun Interrupt */
1083 if (orer_status & s->overrun_mask) {
1084 sci_handle_fifo_overrun(port);
1092 * Here we define a transition notifier so that we can update all of our
1093 * ports' baud rate when the peripheral clock changes.
1095 static int sci_notifier(struct notifier_block *self,
1096 unsigned long phase, void *p)
1098 struct sci_port *sci_port;
1099 unsigned long flags;
1101 sci_port = container_of(self, struct sci_port, freq_transition);
1103 if (phase == CPUFREQ_POSTCHANGE) {
1104 struct uart_port *port = &sci_port->port;
1106 spin_lock_irqsave(&port->lock, flags);
1107 port->uartclk = clk_get_rate(sci_port->iclk);
1108 spin_unlock_irqrestore(&port->lock, flags);
1114 static const struct sci_irq_desc {
1116 irq_handler_t handler;
1117 } sci_irq_desc[] = {
1119 * Split out handlers, the default case.
1123 .handler = sci_er_interrupt,
1128 .handler = sci_rx_interrupt,
1133 .handler = sci_tx_interrupt,
1138 .handler = sci_br_interrupt,
1142 * Special muxed handler.
1146 .handler = sci_mpxed_interrupt,
1150 static int sci_request_irq(struct sci_port *port)
1152 struct uart_port *up = &port->port;
1155 for (i = j = 0; i < SCIx_NR_IRQS; i++, j++) {
1156 const struct sci_irq_desc *desc;
1159 if (SCIx_IRQ_IS_MUXED(port)) {
1163 irq = port->irqs[i];
1166 * Certain port types won't support all of the
1167 * available interrupt sources.
1169 if (unlikely(irq < 0))
1173 desc = sci_irq_desc + i;
1174 port->irqstr[j] = kasprintf(GFP_KERNEL, "%s:%s",
1175 dev_name(up->dev), desc->desc);
1176 if (!port->irqstr[j])
1179 ret = request_irq(irq, desc->handler, up->irqflags,
1180 port->irqstr[j], port);
1181 if (unlikely(ret)) {
1182 dev_err(up->dev, "Can't allocate %s IRQ\n", desc->desc);
1191 free_irq(port->irqs[i], port);
1195 kfree(port->irqstr[j]);
1200 static void sci_free_irq(struct sci_port *port)
1205 * Intentionally in reverse order so we iterate over the muxed
1208 for (i = 0; i < SCIx_NR_IRQS; i++) {
1209 int irq = port->irqs[i];
1212 * Certain port types won't support all of the available
1213 * interrupt sources.
1215 if (unlikely(irq < 0))
1218 free_irq(port->irqs[i], port);
1219 kfree(port->irqstr[i]);
1221 if (SCIx_IRQ_IS_MUXED(port)) {
1222 /* If there's only one IRQ, we're done. */
1228 static unsigned int sci_tx_empty(struct uart_port *port)
1230 unsigned short status = serial_port_in(port, SCxSR);
1231 unsigned short in_tx_fifo = sci_txfill(port);
1233 return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
1237 * Modem control is a bit of a mixed bag for SCI(F) ports. Generally
1238 * CTS/RTS is supported in hardware by at least one port and controlled
1239 * via SCSPTR (SCxPCR for SCIFA/B parts), or external pins (presently
1240 * handled via the ->init_pins() op, which is a bit of a one-way street,
1241 * lacking any ability to defer pin control -- this will later be
1242 * converted over to the GPIO framework).
1244 * Other modes (such as loopback) are supported generically on certain
1245 * port types, but not others. For these it's sufficient to test for the
1246 * existence of the support register and simply ignore the port type.
1248 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
1250 if (mctrl & TIOCM_LOOP) {
1251 const struct plat_sci_reg *reg;
1254 * Standard loopback mode for SCFCR ports.
1256 reg = sci_getreg(port, SCFCR);
1258 serial_port_out(port, SCFCR,
1259 serial_port_in(port, SCFCR) |
1264 static unsigned int sci_get_mctrl(struct uart_port *port)
1267 * CTS/RTS is handled in hardware when supported, while nothing
1268 * else is wired up. Keep it simple and simply assert DSR/CAR.
1270 return TIOCM_DSR | TIOCM_CAR;
1273 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1274 static void sci_dma_tx_complete(void *arg)
1276 struct sci_port *s = arg;
1277 struct uart_port *port = &s->port;
1278 struct circ_buf *xmit = &port->state->xmit;
1279 unsigned long flags;
1281 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1283 spin_lock_irqsave(&port->lock, flags);
1285 xmit->tail += s->tx_dma_len;
1286 xmit->tail &= UART_XMIT_SIZE - 1;
1288 port->icount.tx += s->tx_dma_len;
1290 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1291 uart_write_wakeup(port);
1293 if (!uart_circ_empty(xmit)) {
1295 schedule_work(&s->work_tx);
1297 s->cookie_tx = -EINVAL;
1298 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1299 u16 ctrl = serial_port_in(port, SCSCR);
1300 serial_port_out(port, SCSCR, ctrl & ~SCSCR_TIE);
1304 spin_unlock_irqrestore(&port->lock, flags);
1307 /* Locking: called with port lock held */
1308 static int sci_dma_rx_push(struct sci_port *s, void *buf, size_t count)
1310 struct uart_port *port = &s->port;
1311 struct tty_port *tport = &port->state->port;
1314 copied = tty_insert_flip_string(tport, buf, count);
1315 if (copied < count) {
1316 dev_warn(port->dev, "Rx overrun: dropping %zu bytes\n",
1318 port->icount.buf_overrun++;
1321 port->icount.rx += copied;
1326 static int sci_dma_rx_find_active(struct sci_port *s)
1330 for (i = 0; i < ARRAY_SIZE(s->cookie_rx); i++)
1331 if (s->active_rx == s->cookie_rx[i])
1334 dev_err(s->port.dev, "%s: Rx cookie %d not found!\n", __func__,
1339 static void sci_dma_rx_complete(void *arg)
1341 struct sci_port *s = arg;
1342 struct uart_port *port = &s->port;
1343 unsigned long flags;
1344 int active, count = 0;
1346 dev_dbg(port->dev, "%s(%d) active cookie %d\n", __func__, port->line,
1349 spin_lock_irqsave(&port->lock, flags);
1351 active = sci_dma_rx_find_active(s);
1353 count = sci_dma_rx_push(s, s->rx_buf[active], s->buf_len_rx);
1355 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1357 spin_unlock_irqrestore(&port->lock, flags);
1360 tty_flip_buffer_push(&port->state->port);
1362 schedule_work(&s->work_rx);
1365 static void sci_rx_dma_release(struct sci_port *s, bool enable_pio)
1367 struct dma_chan *chan = s->chan_rx;
1368 struct uart_port *port = &s->port;
1369 unsigned long flags;
1371 spin_lock_irqsave(&port->lock, flags);
1373 s->cookie_rx[0] = s->cookie_rx[1] = -EINVAL;
1374 spin_unlock_irqrestore(&port->lock, flags);
1375 dmaengine_terminate_all(chan);
1376 dma_free_coherent(chan->device->dev, s->buf_len_rx * 2, s->rx_buf[0],
1377 sg_dma_address(&s->sg_rx[0]));
1378 dma_release_channel(chan);
1383 static void sci_tx_dma_release(struct sci_port *s, bool enable_pio)
1385 struct dma_chan *chan = s->chan_tx;
1386 struct uart_port *port = &s->port;
1387 unsigned long flags;
1389 spin_lock_irqsave(&port->lock, flags);
1391 s->cookie_tx = -EINVAL;
1392 spin_unlock_irqrestore(&port->lock, flags);
1393 dmaengine_terminate_all(chan);
1394 dma_unmap_single(chan->device->dev, s->tx_dma_addr, UART_XMIT_SIZE,
1396 dma_release_channel(chan);
1401 static void sci_submit_rx(struct sci_port *s)
1403 struct dma_chan *chan = s->chan_rx;
1406 for (i = 0; i < 2; i++) {
1407 struct scatterlist *sg = &s->sg_rx[i];
1408 struct dma_async_tx_descriptor *desc;
1410 desc = dmaengine_prep_slave_sg(chan,
1411 sg, 1, DMA_DEV_TO_MEM,
1412 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1416 desc->callback = sci_dma_rx_complete;
1417 desc->callback_param = s;
1418 s->cookie_rx[i] = dmaengine_submit(desc);
1419 if (dma_submit_error(s->cookie_rx[i]))
1422 dev_dbg(s->port.dev, "%s(): cookie %d to #%d\n", __func__,
1423 s->cookie_rx[i], i);
1426 s->active_rx = s->cookie_rx[0];
1428 dma_async_issue_pending(chan);
1433 dmaengine_terminate_all(chan);
1434 for (i = 0; i < 2; i++)
1435 s->cookie_rx[i] = -EINVAL;
1436 s->active_rx = -EINVAL;
1437 dev_warn(s->port.dev, "Failed to re-start Rx DMA, using PIO\n");
1438 sci_rx_dma_release(s, true);
1441 static void work_fn_rx(struct work_struct *work)
1443 struct sci_port *s = container_of(work, struct sci_port, work_rx);
1444 struct uart_port *port = &s->port;
1445 struct dma_async_tx_descriptor *desc;
1446 struct dma_tx_state state;
1447 enum dma_status status;
1448 unsigned long flags;
1451 spin_lock_irqsave(&port->lock, flags);
1452 new = sci_dma_rx_find_active(s);
1454 spin_unlock_irqrestore(&port->lock, flags);
1458 status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1459 if (status != DMA_COMPLETE) {
1460 /* Handle incomplete DMA receive */
1461 struct dma_chan *chan = s->chan_rx;
1465 dmaengine_terminate_all(chan);
1466 read = sg_dma_len(&s->sg_rx[new]) - state.residue;
1467 dev_dbg(port->dev, "Read %u bytes with cookie %d\n", read,
1471 count = sci_dma_rx_push(s, s->rx_buf[new], read);
1473 tty_flip_buffer_push(&port->state->port);
1476 spin_unlock_irqrestore(&port->lock, flags);
1482 desc = dmaengine_prep_slave_sg(s->chan_rx, &s->sg_rx[new], 1,
1484 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1488 desc->callback = sci_dma_rx_complete;
1489 desc->callback_param = s;
1490 s->cookie_rx[new] = dmaengine_submit(desc);
1491 if (dma_submit_error(s->cookie_rx[new]))
1494 s->active_rx = s->cookie_rx[!new];
1496 dev_dbg(port->dev, "%s: cookie %d #%d, new active cookie %d\n",
1497 __func__, s->cookie_rx[new], new, s->active_rx);
1498 spin_unlock_irqrestore(&port->lock, flags);
1502 spin_unlock_irqrestore(&port->lock, flags);
1503 dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1504 sci_rx_dma_release(s, true);
1507 static void work_fn_tx(struct work_struct *work)
1509 struct sci_port *s = container_of(work, struct sci_port, work_tx);
1510 struct dma_async_tx_descriptor *desc;
1511 struct dma_chan *chan = s->chan_tx;
1512 struct uart_port *port = &s->port;
1513 struct circ_buf *xmit = &port->state->xmit;
1518 * Port xmit buffer is already mapped, and it is one page... Just adjust
1519 * offsets and lengths. Since it is a circular buffer, we have to
1520 * transmit till the end, and then the rest. Take the port lock to get a
1521 * consistent xmit buffer state.
1523 spin_lock_irq(&port->lock);
1524 buf = s->tx_dma_addr + (xmit->tail & (UART_XMIT_SIZE - 1));
1525 s->tx_dma_len = min_t(unsigned int,
1526 CIRC_CNT(xmit->head, xmit->tail, UART_XMIT_SIZE),
1527 CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE));
1528 spin_unlock_irq(&port->lock);
1530 desc = dmaengine_prep_slave_single(chan, buf, s->tx_dma_len,
1532 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1534 dev_warn(port->dev, "Failed preparing Tx DMA descriptor\n");
1536 sci_tx_dma_release(s, true);
1540 dma_sync_single_for_device(chan->device->dev, buf, s->tx_dma_len,
1543 spin_lock_irq(&port->lock);
1544 desc->callback = sci_dma_tx_complete;
1545 desc->callback_param = s;
1546 spin_unlock_irq(&port->lock);
1547 s->cookie_tx = dmaengine_submit(desc);
1548 if (dma_submit_error(s->cookie_tx)) {
1549 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1551 sci_tx_dma_release(s, true);
1555 dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n",
1556 __func__, xmit->buf, xmit->tail, xmit->head, s->cookie_tx);
1558 dma_async_issue_pending(chan);
1562 static void sci_start_tx(struct uart_port *port)
1564 struct sci_port *s = to_sci_port(port);
1565 unsigned short ctrl;
1567 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1568 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1569 u16 new, scr = serial_port_in(port, SCSCR);
1571 new = scr | SCSCR_TDRQE;
1573 new = scr & ~SCSCR_TDRQE;
1575 serial_port_out(port, SCSCR, new);
1578 if (s->chan_tx && !uart_circ_empty(&s->port.state->xmit) &&
1579 dma_submit_error(s->cookie_tx)) {
1581 schedule_work(&s->work_tx);
1585 if (!s->chan_tx || port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1586 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
1587 ctrl = serial_port_in(port, SCSCR);
1588 serial_port_out(port, SCSCR, ctrl | SCSCR_TIE);
1592 static void sci_stop_tx(struct uart_port *port)
1594 unsigned short ctrl;
1596 /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
1597 ctrl = serial_port_in(port, SCSCR);
1599 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1600 ctrl &= ~SCSCR_TDRQE;
1604 serial_port_out(port, SCSCR, ctrl);
1607 static void sci_start_rx(struct uart_port *port)
1609 unsigned short ctrl;
1611 ctrl = serial_port_in(port, SCSCR) | port_rx_irq_mask(port);
1613 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1614 ctrl &= ~SCSCR_RDRQE;
1616 serial_port_out(port, SCSCR, ctrl);
1619 static void sci_stop_rx(struct uart_port *port)
1621 unsigned short ctrl;
1623 ctrl = serial_port_in(port, SCSCR);
1625 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1626 ctrl &= ~SCSCR_RDRQE;
1628 ctrl &= ~port_rx_irq_mask(port);
1630 serial_port_out(port, SCSCR, ctrl);
1633 static void sci_break_ctl(struct uart_port *port, int break_state)
1635 struct sci_port *s = to_sci_port(port);
1636 const struct plat_sci_reg *reg = sci_regmap[s->cfg->regtype] + SCSPTR;
1637 unsigned short scscr, scsptr;
1639 /* check wheter the port has SCSPTR */
1642 * Not supported by hardware. Most parts couple break and rx
1643 * interrupts together, with break detection always enabled.
1648 scsptr = serial_port_in(port, SCSPTR);
1649 scscr = serial_port_in(port, SCSCR);
1651 if (break_state == -1) {
1652 scsptr = (scsptr | SCSPTR_SPB2IO) & ~SCSPTR_SPB2DT;
1655 scsptr = (scsptr | SCSPTR_SPB2DT) & ~SCSPTR_SPB2IO;
1659 serial_port_out(port, SCSPTR, scsptr);
1660 serial_port_out(port, SCSCR, scscr);
1663 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1664 static bool filter(struct dma_chan *chan, void *slave)
1666 struct sh_dmae_slave *param = slave;
1668 dev_dbg(chan->device->dev, "%s: slave ID %d\n",
1669 __func__, param->shdma_slave.slave_id);
1671 chan->private = ¶m->shdma_slave;
1675 static void rx_timer_fn(unsigned long arg)
1677 struct sci_port *s = (struct sci_port *)arg;
1678 struct uart_port *port = &s->port;
1679 u16 scr = serial_port_in(port, SCSCR);
1681 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1682 scr &= ~SCSCR_RDRQE;
1683 enable_irq(s->irqs[SCIx_RXI_IRQ]);
1685 serial_port_out(port, SCSCR, scr | SCSCR_RIE);
1686 dev_dbg(port->dev, "DMA Rx timed out\n");
1687 schedule_work(&s->work_rx);
1690 static void sci_request_dma(struct uart_port *port)
1692 struct sci_port *s = to_sci_port(port);
1693 struct sh_dmae_slave *param;
1694 struct dma_chan *chan;
1695 dma_cap_mask_t mask;
1697 dev_dbg(port->dev, "%s: port %d\n", __func__, port->line);
1699 if (s->cfg->dma_slave_tx <= 0 || s->cfg->dma_slave_rx <= 0)
1703 dma_cap_set(DMA_SLAVE, mask);
1705 param = &s->param_tx;
1707 /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_TX */
1708 param->shdma_slave.slave_id = s->cfg->dma_slave_tx;
1710 s->cookie_tx = -EINVAL;
1711 chan = dma_request_channel(mask, filter, param);
1712 dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1715 /* UART circular tx buffer is an aligned page. */
1716 s->tx_dma_addr = dma_map_single(chan->device->dev,
1717 port->state->xmit.buf,
1720 if (dma_mapping_error(chan->device->dev, s->tx_dma_addr)) {
1721 dev_warn(port->dev, "Failed mapping Tx DMA descriptor\n");
1722 dma_release_channel(chan);
1725 dev_dbg(port->dev, "%s: mapped %lu@%p to %pad\n",
1726 __func__, UART_XMIT_SIZE,
1727 port->state->xmit.buf, &s->tx_dma_addr);
1730 INIT_WORK(&s->work_tx, work_fn_tx);
1733 param = &s->param_rx;
1735 /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_RX */
1736 param->shdma_slave.slave_id = s->cfg->dma_slave_rx;
1738 chan = dma_request_channel(mask, filter, param);
1739 dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1747 s->buf_len_rx = 2 * max_t(size_t, 16, port->fifosize);
1748 buf = dma_alloc_coherent(chan->device->dev, s->buf_len_rx * 2,
1752 "Failed to allocate Rx dma buffer, using PIO\n");
1753 dma_release_channel(chan);
1759 for (i = 0; i < 2; i++) {
1760 struct scatterlist *sg = &s->sg_rx[i];
1762 sg_init_table(sg, 1);
1764 sg_dma_address(sg) = dma;
1765 sg->length = s->buf_len_rx;
1767 buf += s->buf_len_rx;
1768 dma += s->buf_len_rx;
1771 INIT_WORK(&s->work_rx, work_fn_rx);
1772 setup_timer(&s->rx_timer, rx_timer_fn, (unsigned long)s);
1778 static void sci_free_dma(struct uart_port *port)
1780 struct sci_port *s = to_sci_port(port);
1783 sci_tx_dma_release(s, false);
1785 sci_rx_dma_release(s, false);
1788 static inline void sci_request_dma(struct uart_port *port)
1792 static inline void sci_free_dma(struct uart_port *port)
1797 static int sci_startup(struct uart_port *port)
1799 struct sci_port *s = to_sci_port(port);
1800 unsigned long flags;
1803 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1805 ret = sci_request_irq(s);
1806 if (unlikely(ret < 0))
1809 sci_request_dma(port);
1811 spin_lock_irqsave(&port->lock, flags);
1814 spin_unlock_irqrestore(&port->lock, flags);
1819 static void sci_shutdown(struct uart_port *port)
1821 struct sci_port *s = to_sci_port(port);
1822 unsigned long flags;
1824 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1826 spin_lock_irqsave(&port->lock, flags);
1829 spin_unlock_irqrestore(&port->lock, flags);
1835 static unsigned int sci_scbrr_calc(struct sci_port *s, unsigned int bps,
1838 if (s->sampling_rate)
1839 return DIV_ROUND_CLOSEST(freq, s->sampling_rate * bps) - 1;
1841 /* Warn, but use a safe default */
1844 return ((freq + 16 * bps) / (32 * bps) - 1);
1847 /* calculate frame length from SMR */
1848 static int sci_baud_calc_frame_len(unsigned int smr_val)
1852 if (smr_val & SCSMR_CHR)
1854 if (smr_val & SCSMR_PE)
1856 if (smr_val & SCSMR_STOP)
1863 /* calculate sample rate, BRR, and clock select for HSCIF */
1864 static void sci_baud_calc_hscif(unsigned int bps, unsigned long freq,
1865 int *brr, unsigned int *srr,
1866 unsigned int *cks, int frame_len)
1868 int sr, c, br, err, recv_margin;
1869 int min_err = 1000; /* 100% */
1870 int recv_max_margin = 0;
1872 /* Find the combination of sample rate and clock select with the
1873 smallest deviation from the desired baud rate. */
1874 for (sr = 8; sr <= 32; sr++) {
1875 for (c = 0; c <= 3; c++) {
1876 /* integerized formulas from HSCIF documentation */
1877 br = DIV_ROUND_CLOSEST(freq, (sr *
1878 (1 << (2 * c + 1)) * bps)) - 1;
1879 br = clamp(br, 0, 255);
1880 err = DIV_ROUND_CLOSEST(freq, ((br + 1) * bps * sr *
1881 (1 << (2 * c + 1)) / 1000)) -
1884 * M: Receive margin (%)
1885 * N: Ratio of bit rate to clock (N = sampling rate)
1886 * D: Clock duty (D = 0 to 1.0)
1887 * L: Frame length (L = 9 to 12)
1888 * F: Absolute value of clock frequency deviation
1890 * M = |(0.5 - 1 / 2 * N) - ((L - 0.5) * F) -
1891 * (|D - 0.5| / N * (1 + F))|
1892 * NOTE: Usually, treat D for 0.5, F is 0 by this
1895 recv_margin = abs((500 -
1896 DIV_ROUND_CLOSEST(1000, sr << 1)) / 10);
1897 if (abs(min_err) > abs(err)) {
1899 recv_max_margin = recv_margin;
1900 } else if ((min_err == err) &&
1901 (recv_margin > recv_max_margin))
1902 recv_max_margin = recv_margin;
1912 if (min_err == 1000) {
1921 static void sci_reset(struct uart_port *port)
1923 const struct plat_sci_reg *reg;
1924 unsigned int status;
1927 status = serial_port_in(port, SCxSR);
1928 } while (!(status & SCxSR_TEND(port)));
1930 serial_port_out(port, SCSCR, 0x00); /* TE=0, RE=0, CKE1=0 */
1932 reg = sci_getreg(port, SCFCR);
1934 serial_port_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
1937 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
1938 struct ktermios *old)
1940 struct sci_port *s = to_sci_port(port);
1941 const struct plat_sci_reg *reg;
1942 unsigned int baud, smr_val = 0, max_baud, cks = 0;
1944 unsigned int srr = 15;
1946 if ((termios->c_cflag & CSIZE) == CS7)
1947 smr_val |= SCSMR_CHR;
1948 if (termios->c_cflag & PARENB)
1949 smr_val |= SCSMR_PE;
1950 if (termios->c_cflag & PARODD)
1951 smr_val |= SCSMR_PE | SCSMR_ODD;
1952 if (termios->c_cflag & CSTOPB)
1953 smr_val |= SCSMR_STOP;
1956 * earlyprintk comes here early on with port->uartclk set to zero.
1957 * the clock framework is not up and running at this point so here
1958 * we assume that 115200 is the maximum baud rate. please note that
1959 * the baud rate is not programmed during earlyprintk - it is assumed
1960 * that the previous boot loader has enabled required clocks and
1961 * setup the baud rate generator hardware for us already.
1963 max_baud = port->uartclk ? port->uartclk / 16 : 115200;
1965 baud = uart_get_baud_rate(port, termios, old, 0, max_baud);
1966 if (likely(baud && port->uartclk)) {
1967 if (s->cfg->type == PORT_HSCIF) {
1968 int frame_len = sci_baud_calc_frame_len(smr_val);
1969 sci_baud_calc_hscif(baud, port->uartclk, &t, &srr,
1972 t = sci_scbrr_calc(s, baud, port->uartclk);
1973 for (cks = 0; t >= 256 && cks <= 3; cks++)
1982 smr_val |= serial_port_in(port, SCSMR) & SCSMR_CKS;
1984 uart_update_timeout(port, termios->c_cflag, baud);
1986 dev_dbg(port->dev, "%s: SMR %x, cks %x, t %x, SCSCR %x\n",
1987 __func__, smr_val, cks, t, s->cfg->scscr);
1990 serial_port_out(port, SCSMR, (smr_val & ~SCSMR_CKS) | cks);
1991 serial_port_out(port, SCBRR, t);
1992 reg = sci_getreg(port, HSSRR);
1994 serial_port_out(port, HSSRR, srr | HSCIF_SRE);
1995 udelay((1000000+(baud-1)) / baud); /* Wait one bit interval */
1997 serial_port_out(port, SCSMR, smr_val);
1999 sci_init_pins(port, termios->c_cflag);
2001 reg = sci_getreg(port, SCFCR);
2003 unsigned short ctrl = serial_port_in(port, SCFCR);
2005 if (s->cfg->capabilities & SCIx_HAVE_RTSCTS) {
2006 if (termios->c_cflag & CRTSCTS)
2013 * As we've done a sci_reset() above, ensure we don't
2014 * interfere with the FIFOs while toggling MCE. As the
2015 * reset values could still be set, simply mask them out.
2017 ctrl &= ~(SCFCR_RFRST | SCFCR_TFRST);
2019 serial_port_out(port, SCFCR, ctrl);
2022 serial_port_out(port, SCSCR, s->cfg->scscr);
2024 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2026 * Calculate delay for 2 DMA buffers (4 FIFO).
2027 * See serial_core.c::uart_update_timeout().
2028 * With 10 bits (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above
2029 * function calculates 1 jiffie for the data plus 5 jiffies for the
2030 * "slop(e)." Then below we calculate 5 jiffies (20ms) for 2 DMA
2031 * buffers (4 FIFO sizes), but when performing a faster transfer, the
2032 * value obtained by this formula is too small. Therefore, if the value
2033 * is smaller than 20ms, use 20ms as the timeout value for DMA.
2038 /* byte size and parity */
2039 switch (termios->c_cflag & CSIZE) {
2054 if (termios->c_cflag & CSTOPB)
2056 if (termios->c_cflag & PARENB)
2058 s->rx_timeout = DIV_ROUND_UP((s->buf_len_rx * 2 * bits * HZ) /
2060 dev_dbg(port->dev, "DMA Rx t-out %ums, tty t-out %u jiffies\n",
2061 s->rx_timeout * 1000 / HZ, port->timeout);
2062 if (s->rx_timeout < msecs_to_jiffies(20))
2063 s->rx_timeout = msecs_to_jiffies(20);
2067 if ((termios->c_cflag & CREAD) != 0)
2070 sci_port_disable(s);
2073 static void sci_pm(struct uart_port *port, unsigned int state,
2074 unsigned int oldstate)
2076 struct sci_port *sci_port = to_sci_port(port);
2079 case UART_PM_STATE_OFF:
2080 sci_port_disable(sci_port);
2083 sci_port_enable(sci_port);
2088 static const char *sci_type(struct uart_port *port)
2090 switch (port->type) {
2108 static int sci_remap_port(struct uart_port *port)
2110 struct sci_port *sport = to_sci_port(port);
2113 * Nothing to do if there's already an established membase.
2118 if (port->flags & UPF_IOREMAP) {
2119 port->membase = ioremap_nocache(port->mapbase, sport->reg_size);
2120 if (unlikely(!port->membase)) {
2121 dev_err(port->dev, "can't remap port#%d\n", port->line);
2126 * For the simple (and majority of) cases where we don't
2127 * need to do any remapping, just cast the cookie
2130 port->membase = (void __iomem *)(uintptr_t)port->mapbase;
2136 static void sci_release_port(struct uart_port *port)
2138 struct sci_port *sport = to_sci_port(port);
2140 if (port->flags & UPF_IOREMAP) {
2141 iounmap(port->membase);
2142 port->membase = NULL;
2145 release_mem_region(port->mapbase, sport->reg_size);
2148 static int sci_request_port(struct uart_port *port)
2150 struct resource *res;
2151 struct sci_port *sport = to_sci_port(port);
2154 res = request_mem_region(port->mapbase, sport->reg_size,
2155 dev_name(port->dev));
2156 if (unlikely(res == NULL)) {
2157 dev_err(port->dev, "request_mem_region failed.");
2161 ret = sci_remap_port(port);
2162 if (unlikely(ret != 0)) {
2163 release_resource(res);
2170 static void sci_config_port(struct uart_port *port, int flags)
2172 if (flags & UART_CONFIG_TYPE) {
2173 struct sci_port *sport = to_sci_port(port);
2175 port->type = sport->cfg->type;
2176 sci_request_port(port);
2180 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
2182 if (ser->baud_base < 2400)
2183 /* No paper tape reader for Mitch.. */
2189 static struct uart_ops sci_uart_ops = {
2190 .tx_empty = sci_tx_empty,
2191 .set_mctrl = sci_set_mctrl,
2192 .get_mctrl = sci_get_mctrl,
2193 .start_tx = sci_start_tx,
2194 .stop_tx = sci_stop_tx,
2195 .stop_rx = sci_stop_rx,
2196 .break_ctl = sci_break_ctl,
2197 .startup = sci_startup,
2198 .shutdown = sci_shutdown,
2199 .set_termios = sci_set_termios,
2202 .release_port = sci_release_port,
2203 .request_port = sci_request_port,
2204 .config_port = sci_config_port,
2205 .verify_port = sci_verify_port,
2206 #ifdef CONFIG_CONSOLE_POLL
2207 .poll_get_char = sci_poll_get_char,
2208 .poll_put_char = sci_poll_put_char,
2212 static int sci_init_single(struct platform_device *dev,
2213 struct sci_port *sci_port, unsigned int index,
2214 struct plat_sci_port *p, bool early)
2216 struct uart_port *port = &sci_port->port;
2217 const struct resource *res;
2223 port->ops = &sci_uart_ops;
2224 port->iotype = UPIO_MEM;
2227 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
2231 port->mapbase = res->start;
2232 sci_port->reg_size = resource_size(res);
2234 for (i = 0; i < ARRAY_SIZE(sci_port->irqs); ++i)
2235 sci_port->irqs[i] = platform_get_irq(dev, i);
2237 /* The SCI generates several interrupts. They can be muxed together or
2238 * connected to different interrupt lines. In the muxed case only one
2239 * interrupt resource is specified. In the non-muxed case three or four
2240 * interrupt resources are specified, as the BRI interrupt is optional.
2242 if (sci_port->irqs[0] < 0)
2245 if (sci_port->irqs[1] < 0) {
2246 sci_port->irqs[1] = sci_port->irqs[0];
2247 sci_port->irqs[2] = sci_port->irqs[0];
2248 sci_port->irqs[3] = sci_port->irqs[0];
2251 if (p->regtype == SCIx_PROBE_REGTYPE) {
2252 ret = sci_probe_regmap(p);
2259 port->fifosize = 256;
2260 sci_port->overrun_reg = SCxSR;
2261 sci_port->overrun_mask = SCIFA_ORER;
2262 sci_port->sampling_rate = 16;
2265 port->fifosize = 128;
2266 sci_port->overrun_reg = SCLSR;
2267 sci_port->overrun_mask = SCLSR_ORER;
2268 sci_port->sampling_rate = 0;
2271 port->fifosize = 64;
2272 sci_port->overrun_reg = SCxSR;
2273 sci_port->overrun_mask = SCIFA_ORER;
2274 sci_port->sampling_rate = 16;
2277 port->fifosize = 16;
2278 if (p->regtype == SCIx_SH7705_SCIF_REGTYPE) {
2279 sci_port->overrun_reg = SCxSR;
2280 sci_port->overrun_mask = SCIFA_ORER;
2281 sci_port->sampling_rate = 16;
2283 sci_port->overrun_reg = SCLSR;
2284 sci_port->overrun_mask = SCLSR_ORER;
2285 sci_port->sampling_rate = 32;
2290 sci_port->overrun_reg = SCxSR;
2291 sci_port->overrun_mask = SCI_ORER;
2292 sci_port->sampling_rate = 32;
2296 /* SCIFA on sh7723 and sh7724 need a custom sampling rate that doesn't
2297 * match the SoC datasheet, this should be investigated. Let platform
2298 * data override the sampling rate for now.
2300 if (p->sampling_rate)
2301 sci_port->sampling_rate = p->sampling_rate;
2304 sci_port->iclk = clk_get(&dev->dev, "sci_ick");
2305 if (IS_ERR(sci_port->iclk)) {
2306 sci_port->iclk = clk_get(&dev->dev, "peripheral_clk");
2307 if (IS_ERR(sci_port->iclk)) {
2308 dev_err(&dev->dev, "can't get iclk\n");
2309 return PTR_ERR(sci_port->iclk);
2314 * The function clock is optional, ignore it if we can't
2317 sci_port->fclk = clk_get(&dev->dev, "sci_fck");
2318 if (IS_ERR(sci_port->fclk))
2319 sci_port->fclk = NULL;
2321 port->dev = &dev->dev;
2323 pm_runtime_enable(&dev->dev);
2326 sci_port->break_timer.data = (unsigned long)sci_port;
2327 sci_port->break_timer.function = sci_break_timer;
2328 init_timer(&sci_port->break_timer);
2331 * Establish some sensible defaults for the error detection.
2333 if (p->type == PORT_SCI) {
2334 sci_port->error_mask = SCI_DEFAULT_ERROR_MASK;
2335 sci_port->error_clear = SCI_ERROR_CLEAR;
2337 sci_port->error_mask = SCIF_DEFAULT_ERROR_MASK;
2338 sci_port->error_clear = SCIF_ERROR_CLEAR;
2342 * Make the error mask inclusive of overrun detection, if
2345 if (sci_port->overrun_reg == SCxSR) {
2346 sci_port->error_mask |= sci_port->overrun_mask;
2347 sci_port->error_clear &= ~sci_port->overrun_mask;
2350 port->type = p->type;
2351 port->flags = UPF_FIXED_PORT | p->flags;
2352 port->regshift = p->regshift;
2355 * The UART port needs an IRQ value, so we peg this to the RX IRQ
2356 * for the multi-IRQ ports, which is where we are primarily
2357 * concerned with the shutdown path synchronization.
2359 * For the muxed case there's nothing more to do.
2361 port->irq = sci_port->irqs[SCIx_RXI_IRQ];
2364 port->serial_in = sci_serial_in;
2365 port->serial_out = sci_serial_out;
2367 if (p->dma_slave_tx > 0 && p->dma_slave_rx > 0)
2368 dev_dbg(port->dev, "DMA tx %d, rx %d\n",
2369 p->dma_slave_tx, p->dma_slave_rx);
2374 static void sci_cleanup_single(struct sci_port *port)
2376 clk_put(port->iclk);
2377 clk_put(port->fclk);
2379 pm_runtime_disable(port->port.dev);
2382 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
2383 static void serial_console_putchar(struct uart_port *port, int ch)
2385 sci_poll_put_char(port, ch);
2389 * Print a string to the serial port trying not to disturb
2390 * any possible real use of the port...
2392 static void serial_console_write(struct console *co, const char *s,
2395 struct sci_port *sci_port = &sci_ports[co->index];
2396 struct uart_port *port = &sci_port->port;
2397 unsigned short bits, ctrl;
2398 unsigned long flags;
2401 local_irq_save(flags);
2404 else if (oops_in_progress)
2405 locked = spin_trylock(&port->lock);
2407 spin_lock(&port->lock);
2409 /* first save the SCSCR then disable the interrupts */
2410 ctrl = serial_port_in(port, SCSCR);
2411 serial_port_out(port, SCSCR, sci_port->cfg->scscr);
2413 uart_console_write(port, s, count, serial_console_putchar);
2415 /* wait until fifo is empty and last bit has been transmitted */
2416 bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
2417 while ((serial_port_in(port, SCxSR) & bits) != bits)
2420 /* restore the SCSCR */
2421 serial_port_out(port, SCSCR, ctrl);
2424 spin_unlock(&port->lock);
2425 local_irq_restore(flags);
2428 static int serial_console_setup(struct console *co, char *options)
2430 struct sci_port *sci_port;
2431 struct uart_port *port;
2439 * Refuse to handle any bogus ports.
2441 if (co->index < 0 || co->index >= SCI_NPORTS)
2444 sci_port = &sci_ports[co->index];
2445 port = &sci_port->port;
2448 * Refuse to handle uninitialized ports.
2453 ret = sci_remap_port(port);
2454 if (unlikely(ret != 0))
2458 uart_parse_options(options, &baud, &parity, &bits, &flow);
2460 return uart_set_options(port, co, baud, parity, bits, flow);
2463 static struct console serial_console = {
2465 .device = uart_console_device,
2466 .write = serial_console_write,
2467 .setup = serial_console_setup,
2468 .flags = CON_PRINTBUFFER,
2470 .data = &sci_uart_driver,
2473 static struct console early_serial_console = {
2474 .name = "early_ttySC",
2475 .write = serial_console_write,
2476 .flags = CON_PRINTBUFFER,
2480 static char early_serial_buf[32];
2482 static int sci_probe_earlyprintk(struct platform_device *pdev)
2484 struct plat_sci_port *cfg = dev_get_platdata(&pdev->dev);
2486 if (early_serial_console.data)
2489 early_serial_console.index = pdev->id;
2491 sci_init_single(pdev, &sci_ports[pdev->id], pdev->id, cfg, true);
2493 serial_console_setup(&early_serial_console, early_serial_buf);
2495 if (!strstr(early_serial_buf, "keep"))
2496 early_serial_console.flags |= CON_BOOT;
2498 register_console(&early_serial_console);
2502 #define SCI_CONSOLE (&serial_console)
2505 static inline int sci_probe_earlyprintk(struct platform_device *pdev)
2510 #define SCI_CONSOLE NULL
2512 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
2514 static const char banner[] __initconst = "SuperH (H)SCI(F) driver initialized";
2516 static struct uart_driver sci_uart_driver = {
2517 .owner = THIS_MODULE,
2518 .driver_name = "sci",
2519 .dev_name = "ttySC",
2521 .minor = SCI_MINOR_START,
2523 .cons = SCI_CONSOLE,
2526 static int sci_remove(struct platform_device *dev)
2528 struct sci_port *port = platform_get_drvdata(dev);
2530 cpufreq_unregister_notifier(&port->freq_transition,
2531 CPUFREQ_TRANSITION_NOTIFIER);
2533 uart_remove_one_port(&sci_uart_driver, &port->port);
2535 sci_cleanup_single(port);
2540 struct sci_port_info {
2542 unsigned int regtype;
2545 static const struct of_device_id of_sci_match[] = {
2547 .compatible = "renesas,scif",
2548 .data = &(const struct sci_port_info) {
2550 .regtype = SCIx_SH4_SCIF_REGTYPE,
2553 .compatible = "renesas,scifa",
2554 .data = &(const struct sci_port_info) {
2556 .regtype = SCIx_SCIFA_REGTYPE,
2559 .compatible = "renesas,scifb",
2560 .data = &(const struct sci_port_info) {
2562 .regtype = SCIx_SCIFB_REGTYPE,
2565 .compatible = "renesas,hscif",
2566 .data = &(const struct sci_port_info) {
2568 .regtype = SCIx_HSCIF_REGTYPE,
2571 .compatible = "renesas,sci",
2572 .data = &(const struct sci_port_info) {
2574 .regtype = SCIx_SCI_REGTYPE,
2580 MODULE_DEVICE_TABLE(of, of_sci_match);
2582 static struct plat_sci_port *
2583 sci_parse_dt(struct platform_device *pdev, unsigned int *dev_id)
2585 struct device_node *np = pdev->dev.of_node;
2586 const struct of_device_id *match;
2587 const struct sci_port_info *info;
2588 struct plat_sci_port *p;
2591 if (!IS_ENABLED(CONFIG_OF) || !np)
2594 match = of_match_node(of_sci_match, pdev->dev.of_node);
2600 p = devm_kzalloc(&pdev->dev, sizeof(struct plat_sci_port), GFP_KERNEL);
2604 /* Get the line number for the aliases node. */
2605 id = of_alias_get_id(np, "serial");
2607 dev_err(&pdev->dev, "failed to get alias id (%d)\n", id);
2613 p->flags = UPF_IOREMAP | UPF_BOOT_AUTOCONF;
2614 p->type = info->type;
2615 p->regtype = info->regtype;
2616 p->scscr = SCSCR_RE | SCSCR_TE;
2621 static int sci_probe_single(struct platform_device *dev,
2623 struct plat_sci_port *p,
2624 struct sci_port *sciport)
2629 if (unlikely(index >= SCI_NPORTS)) {
2630 dev_notice(&dev->dev, "Attempting to register port %d when only %d are available\n",
2631 index+1, SCI_NPORTS);
2632 dev_notice(&dev->dev, "Consider bumping CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
2636 ret = sci_init_single(dev, sciport, index, p, false);
2640 ret = uart_add_one_port(&sci_uart_driver, &sciport->port);
2642 sci_cleanup_single(sciport);
2649 static int sci_probe(struct platform_device *dev)
2651 struct plat_sci_port *p;
2652 struct sci_port *sp;
2653 unsigned int dev_id;
2657 * If we've come here via earlyprintk initialization, head off to
2658 * the special early probe. We don't have sufficient device state
2659 * to make it beyond this yet.
2661 if (is_early_platform_device(dev))
2662 return sci_probe_earlyprintk(dev);
2664 if (dev->dev.of_node) {
2665 p = sci_parse_dt(dev, &dev_id);
2669 p = dev->dev.platform_data;
2671 dev_err(&dev->dev, "no platform data supplied\n");
2678 sp = &sci_ports[dev_id];
2679 platform_set_drvdata(dev, sp);
2681 ret = sci_probe_single(dev, dev_id, p, sp);
2685 sp->freq_transition.notifier_call = sci_notifier;
2687 ret = cpufreq_register_notifier(&sp->freq_transition,
2688 CPUFREQ_TRANSITION_NOTIFIER);
2689 if (unlikely(ret < 0)) {
2690 uart_remove_one_port(&sci_uart_driver, &sp->port);
2691 sci_cleanup_single(sp);
2695 #ifdef CONFIG_SH_STANDARD_BIOS
2696 sh_bios_gdb_detach();
2702 static __maybe_unused int sci_suspend(struct device *dev)
2704 struct sci_port *sport = dev_get_drvdata(dev);
2707 uart_suspend_port(&sci_uart_driver, &sport->port);
2712 static __maybe_unused int sci_resume(struct device *dev)
2714 struct sci_port *sport = dev_get_drvdata(dev);
2717 uart_resume_port(&sci_uart_driver, &sport->port);
2722 static SIMPLE_DEV_PM_OPS(sci_dev_pm_ops, sci_suspend, sci_resume);
2724 static struct platform_driver sci_driver = {
2726 .remove = sci_remove,
2729 .pm = &sci_dev_pm_ops,
2730 .of_match_table = of_match_ptr(of_sci_match),
2734 static int __init sci_init(void)
2738 pr_info("%s\n", banner);
2740 ret = uart_register_driver(&sci_uart_driver);
2741 if (likely(ret == 0)) {
2742 ret = platform_driver_register(&sci_driver);
2744 uart_unregister_driver(&sci_uart_driver);
2750 static void __exit sci_exit(void)
2752 platform_driver_unregister(&sci_driver);
2753 uart_unregister_driver(&sci_uart_driver);
2756 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
2757 early_platform_init_buffer("earlyprintk", &sci_driver,
2758 early_serial_buf, ARRAY_SIZE(early_serial_buf));
2760 module_init(sci_init);
2761 module_exit(sci_exit);
2763 MODULE_LICENSE("GPL");
2764 MODULE_ALIAS("platform:sh-sci");
2765 MODULE_AUTHOR("Paul Mundt");
2766 MODULE_DESCRIPTION("SuperH (H)SCI(F) serial driver");