1 // SPDX-License-Identifier: GPL-2.0
3 * SuperH on-chip serial module support. (SCI with no FIFO / with FIFO)
5 * Copyright (C) 2002 - 2011 Paul Mundt
6 * Copyright (C) 2015 Glider bvba
7 * Modified to support SH7720 SCIF. Markus Brunner, Mark Jonas (Jul 2007).
9 * based off of the old drivers/char/sh-sci.c by:
11 * Copyright (C) 1999, 2000 Niibe Yutaka
12 * Copyright (C) 2000 Sugioka Toshinobu
13 * Modified to support multiple serial ports. Stuart Menefy (May 2000).
14 * Modified to support SecureEdge. David McCullough (2002)
15 * Modified to support SH7300 SCIF. Takashi Kusuda (Jun 2003).
16 * Removed SH7300 support (Jul 2007).
18 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
24 #include <linux/clk.h>
25 #include <linux/console.h>
26 #include <linux/ctype.h>
27 #include <linux/cpufreq.h>
28 #include <linux/delay.h>
29 #include <linux/dmaengine.h>
30 #include <linux/dma-mapping.h>
31 #include <linux/err.h>
32 #include <linux/errno.h>
33 #include <linux/init.h>
34 #include <linux/interrupt.h>
35 #include <linux/ioport.h>
36 #include <linux/ktime.h>
37 #include <linux/major.h>
38 #include <linux/module.h>
41 #include <linux/of_device.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>
59 #include "serial_mctrl_gpio.h"
62 /* Offsets into the sci_port->irqs array */
72 SCIx_MUX_IRQ
= SCIx_NR_IRQS
, /* special case */
75 #define SCIx_IRQ_IS_MUXED(port) \
76 ((port)->irqs[SCIx_ERI_IRQ] == \
77 (port)->irqs[SCIx_RXI_IRQ]) || \
78 ((port)->irqs[SCIx_ERI_IRQ] && \
79 ((port)->irqs[SCIx_RXI_IRQ] < 0))
82 SCI_FCK
, /* Functional Clock */
83 SCI_SCK
, /* Optional External Clock */
84 SCI_BRG_INT
, /* Optional BRG Internal Clock Source */
85 SCI_SCIF_CLK
, /* Optional BRG External Clock Source */
89 /* Bit x set means sampling rate x + 1 is supported */
90 #define SCI_SR(x) BIT((x) - 1)
91 #define SCI_SR_RANGE(x, y) GENMASK((y) - 1, (x) - 1)
93 #define SCI_SR_SCIFAB SCI_SR(5) | SCI_SR(7) | SCI_SR(11) | \
94 SCI_SR(13) | SCI_SR(16) | SCI_SR(17) | \
95 SCI_SR(19) | SCI_SR(27)
97 #define min_sr(_port) ffs((_port)->sampling_rate_mask)
98 #define max_sr(_port) fls((_port)->sampling_rate_mask)
100 /* Iterate over all supported sampling rates, from high to low */
101 #define for_each_sr(_sr, _port) \
102 for ((_sr) = max_sr(_port); (_sr) >= min_sr(_port); (_sr)--) \
103 if ((_port)->sampling_rate_mask & SCI_SR((_sr)))
105 struct plat_sci_reg
{
109 struct sci_port_params
{
110 const struct plat_sci_reg regs
[SCIx_NR_REGS
];
111 unsigned int fifosize
;
112 unsigned int overrun_reg
;
113 unsigned int overrun_mask
;
114 unsigned int sampling_rate_mask
;
115 unsigned int error_mask
;
116 unsigned int error_clear
;
120 struct uart_port port
;
122 /* Platform configuration */
123 const struct sci_port_params
*params
;
124 const struct plat_sci_port
*cfg
;
125 unsigned int sampling_rate_mask
;
126 resource_size_t reg_size
;
127 struct mctrl_gpios
*gpios
;
130 struct clk
*clks
[SCI_NUM_CLKS
];
131 unsigned long clk_rates
[SCI_NUM_CLKS
];
133 int irqs
[SCIx_NR_IRQS
];
134 char *irqstr
[SCIx_NR_IRQS
];
136 struct dma_chan
*chan_tx
;
137 struct dma_chan
*chan_rx
;
139 #ifdef CONFIG_SERIAL_SH_SCI_DMA
140 struct dma_chan
*chan_tx_saved
;
141 struct dma_chan
*chan_rx_saved
;
142 dma_cookie_t cookie_tx
;
143 dma_cookie_t cookie_rx
[2];
144 dma_cookie_t active_rx
;
145 dma_addr_t tx_dma_addr
;
146 unsigned int tx_dma_len
;
147 struct scatterlist sg_rx
[2];
150 struct work_struct work_tx
;
151 struct hrtimer rx_timer
;
152 unsigned int rx_timeout
; /* microseconds */
154 unsigned int rx_frame
;
156 struct timer_list rx_fifo_timer
;
164 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
166 static struct sci_port sci_ports
[SCI_NPORTS
];
167 static unsigned long sci_ports_in_use
;
168 static struct uart_driver sci_uart_driver
;
170 static inline struct sci_port
*
171 to_sci_port(struct uart_port
*uart
)
173 return container_of(uart
, struct sci_port
, port
);
176 static const struct sci_port_params sci_port_params
[SCIx_NR_REGTYPES
] = {
178 * Common SCI definitions, dependent on the port's regshift
181 [SCIx_SCI_REGTYPE
] = {
183 [SCSMR
] = { 0x00, 8 },
184 [SCBRR
] = { 0x01, 8 },
185 [SCSCR
] = { 0x02, 8 },
186 [SCxTDR
] = { 0x03, 8 },
187 [SCxSR
] = { 0x04, 8 },
188 [SCxRDR
] = { 0x05, 8 },
191 .overrun_reg
= SCxSR
,
192 .overrun_mask
= SCI_ORER
,
193 .sampling_rate_mask
= SCI_SR(32),
194 .error_mask
= SCI_DEFAULT_ERROR_MASK
| SCI_ORER
,
195 .error_clear
= SCI_ERROR_CLEAR
& ~SCI_ORER
,
199 * Common definitions for legacy IrDA ports.
201 [SCIx_IRDA_REGTYPE
] = {
203 [SCSMR
] = { 0x00, 8 },
204 [SCBRR
] = { 0x02, 8 },
205 [SCSCR
] = { 0x04, 8 },
206 [SCxTDR
] = { 0x06, 8 },
207 [SCxSR
] = { 0x08, 16 },
208 [SCxRDR
] = { 0x0a, 8 },
209 [SCFCR
] = { 0x0c, 8 },
210 [SCFDR
] = { 0x0e, 16 },
213 .overrun_reg
= SCxSR
,
214 .overrun_mask
= SCI_ORER
,
215 .sampling_rate_mask
= SCI_SR(32),
216 .error_mask
= SCI_DEFAULT_ERROR_MASK
| SCI_ORER
,
217 .error_clear
= SCI_ERROR_CLEAR
& ~SCI_ORER
,
221 * Common SCIFA definitions.
223 [SCIx_SCIFA_REGTYPE
] = {
225 [SCSMR
] = { 0x00, 16 },
226 [SCBRR
] = { 0x04, 8 },
227 [SCSCR
] = { 0x08, 16 },
228 [SCxTDR
] = { 0x20, 8 },
229 [SCxSR
] = { 0x14, 16 },
230 [SCxRDR
] = { 0x24, 8 },
231 [SCFCR
] = { 0x18, 16 },
232 [SCFDR
] = { 0x1c, 16 },
233 [SCPCR
] = { 0x30, 16 },
234 [SCPDR
] = { 0x34, 16 },
237 .overrun_reg
= SCxSR
,
238 .overrun_mask
= SCIFA_ORER
,
239 .sampling_rate_mask
= SCI_SR_SCIFAB
,
240 .error_mask
= SCIF_DEFAULT_ERROR_MASK
| SCIFA_ORER
,
241 .error_clear
= SCIF_ERROR_CLEAR
& ~SCIFA_ORER
,
245 * Common SCIFB definitions.
247 [SCIx_SCIFB_REGTYPE
] = {
249 [SCSMR
] = { 0x00, 16 },
250 [SCBRR
] = { 0x04, 8 },
251 [SCSCR
] = { 0x08, 16 },
252 [SCxTDR
] = { 0x40, 8 },
253 [SCxSR
] = { 0x14, 16 },
254 [SCxRDR
] = { 0x60, 8 },
255 [SCFCR
] = { 0x18, 16 },
256 [SCTFDR
] = { 0x38, 16 },
257 [SCRFDR
] = { 0x3c, 16 },
258 [SCPCR
] = { 0x30, 16 },
259 [SCPDR
] = { 0x34, 16 },
262 .overrun_reg
= SCxSR
,
263 .overrun_mask
= SCIFA_ORER
,
264 .sampling_rate_mask
= SCI_SR_SCIFAB
,
265 .error_mask
= SCIF_DEFAULT_ERROR_MASK
| SCIFA_ORER
,
266 .error_clear
= SCIF_ERROR_CLEAR
& ~SCIFA_ORER
,
270 * Common SH-2(A) SCIF definitions for ports with FIFO data
273 [SCIx_SH2_SCIF_FIFODATA_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 [SCSPTR
] = { 0x20, 16 },
284 [SCLSR
] = { 0x24, 16 },
287 .overrun_reg
= SCLSR
,
288 .overrun_mask
= SCLSR_ORER
,
289 .sampling_rate_mask
= SCI_SR(32),
290 .error_mask
= SCIF_DEFAULT_ERROR_MASK
,
291 .error_clear
= SCIF_ERROR_CLEAR
,
295 * The "SCIFA" that is in RZ/T and RZ/A2.
296 * It looks like a normal SCIF with FIFO data, but with a
297 * compressed address space. Also, the break out of interrupts
298 * are different: ERI/BRI, RXI, TXI, TEI, DRI.
300 [SCIx_RZ_SCIFA_REGTYPE
] = {
302 [SCSMR
] = { 0x00, 16 },
303 [SCBRR
] = { 0x02, 8 },
304 [SCSCR
] = { 0x04, 16 },
305 [SCxTDR
] = { 0x06, 8 },
306 [SCxSR
] = { 0x08, 16 },
307 [SCxRDR
] = { 0x0A, 8 },
308 [SCFCR
] = { 0x0C, 16 },
309 [SCFDR
] = { 0x0E, 16 },
310 [SCSPTR
] = { 0x10, 16 },
311 [SCLSR
] = { 0x12, 16 },
314 .overrun_reg
= SCLSR
,
315 .overrun_mask
= SCLSR_ORER
,
316 .sampling_rate_mask
= SCI_SR(32),
317 .error_mask
= SCIF_DEFAULT_ERROR_MASK
,
318 .error_clear
= SCIF_ERROR_CLEAR
,
322 * Common SH-3 SCIF definitions.
324 [SCIx_SH3_SCIF_REGTYPE
] = {
326 [SCSMR
] = { 0x00, 8 },
327 [SCBRR
] = { 0x02, 8 },
328 [SCSCR
] = { 0x04, 8 },
329 [SCxTDR
] = { 0x06, 8 },
330 [SCxSR
] = { 0x08, 16 },
331 [SCxRDR
] = { 0x0a, 8 },
332 [SCFCR
] = { 0x0c, 8 },
333 [SCFDR
] = { 0x0e, 16 },
336 .overrun_reg
= SCLSR
,
337 .overrun_mask
= SCLSR_ORER
,
338 .sampling_rate_mask
= SCI_SR(32),
339 .error_mask
= SCIF_DEFAULT_ERROR_MASK
,
340 .error_clear
= SCIF_ERROR_CLEAR
,
344 * Common SH-4(A) SCIF(B) definitions.
346 [SCIx_SH4_SCIF_REGTYPE
] = {
348 [SCSMR
] = { 0x00, 16 },
349 [SCBRR
] = { 0x04, 8 },
350 [SCSCR
] = { 0x08, 16 },
351 [SCxTDR
] = { 0x0c, 8 },
352 [SCxSR
] = { 0x10, 16 },
353 [SCxRDR
] = { 0x14, 8 },
354 [SCFCR
] = { 0x18, 16 },
355 [SCFDR
] = { 0x1c, 16 },
356 [SCSPTR
] = { 0x20, 16 },
357 [SCLSR
] = { 0x24, 16 },
360 .overrun_reg
= SCLSR
,
361 .overrun_mask
= SCLSR_ORER
,
362 .sampling_rate_mask
= SCI_SR(32),
363 .error_mask
= SCIF_DEFAULT_ERROR_MASK
,
364 .error_clear
= SCIF_ERROR_CLEAR
,
368 * Common SCIF definitions for ports with a Baud Rate Generator for
369 * External Clock (BRG).
371 [SCIx_SH4_SCIF_BRG_REGTYPE
] = {
373 [SCSMR
] = { 0x00, 16 },
374 [SCBRR
] = { 0x04, 8 },
375 [SCSCR
] = { 0x08, 16 },
376 [SCxTDR
] = { 0x0c, 8 },
377 [SCxSR
] = { 0x10, 16 },
378 [SCxRDR
] = { 0x14, 8 },
379 [SCFCR
] = { 0x18, 16 },
380 [SCFDR
] = { 0x1c, 16 },
381 [SCSPTR
] = { 0x20, 16 },
382 [SCLSR
] = { 0x24, 16 },
383 [SCDL
] = { 0x30, 16 },
384 [SCCKS
] = { 0x34, 16 },
387 .overrun_reg
= SCLSR
,
388 .overrun_mask
= SCLSR_ORER
,
389 .sampling_rate_mask
= SCI_SR(32),
390 .error_mask
= SCIF_DEFAULT_ERROR_MASK
,
391 .error_clear
= SCIF_ERROR_CLEAR
,
395 * Common HSCIF definitions.
397 [SCIx_HSCIF_REGTYPE
] = {
399 [SCSMR
] = { 0x00, 16 },
400 [SCBRR
] = { 0x04, 8 },
401 [SCSCR
] = { 0x08, 16 },
402 [SCxTDR
] = { 0x0c, 8 },
403 [SCxSR
] = { 0x10, 16 },
404 [SCxRDR
] = { 0x14, 8 },
405 [SCFCR
] = { 0x18, 16 },
406 [SCFDR
] = { 0x1c, 16 },
407 [SCSPTR
] = { 0x20, 16 },
408 [SCLSR
] = { 0x24, 16 },
409 [HSSRR
] = { 0x40, 16 },
410 [SCDL
] = { 0x30, 16 },
411 [SCCKS
] = { 0x34, 16 },
412 [HSRTRGR
] = { 0x54, 16 },
413 [HSTTRGR
] = { 0x58, 16 },
416 .overrun_reg
= SCLSR
,
417 .overrun_mask
= SCLSR_ORER
,
418 .sampling_rate_mask
= SCI_SR_RANGE(8, 32),
419 .error_mask
= SCIF_DEFAULT_ERROR_MASK
,
420 .error_clear
= SCIF_ERROR_CLEAR
,
424 * Common SH-4(A) SCIF(B) definitions for ports without an SCSPTR
427 [SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE
] = {
429 [SCSMR
] = { 0x00, 16 },
430 [SCBRR
] = { 0x04, 8 },
431 [SCSCR
] = { 0x08, 16 },
432 [SCxTDR
] = { 0x0c, 8 },
433 [SCxSR
] = { 0x10, 16 },
434 [SCxRDR
] = { 0x14, 8 },
435 [SCFCR
] = { 0x18, 16 },
436 [SCFDR
] = { 0x1c, 16 },
437 [SCLSR
] = { 0x24, 16 },
440 .overrun_reg
= SCLSR
,
441 .overrun_mask
= SCLSR_ORER
,
442 .sampling_rate_mask
= SCI_SR(32),
443 .error_mask
= SCIF_DEFAULT_ERROR_MASK
,
444 .error_clear
= SCIF_ERROR_CLEAR
,
448 * Common SH-4(A) SCIF(B) definitions for ports with FIFO data
451 [SCIx_SH4_SCIF_FIFODATA_REGTYPE
] = {
453 [SCSMR
] = { 0x00, 16 },
454 [SCBRR
] = { 0x04, 8 },
455 [SCSCR
] = { 0x08, 16 },
456 [SCxTDR
] = { 0x0c, 8 },
457 [SCxSR
] = { 0x10, 16 },
458 [SCxRDR
] = { 0x14, 8 },
459 [SCFCR
] = { 0x18, 16 },
460 [SCFDR
] = { 0x1c, 16 },
461 [SCTFDR
] = { 0x1c, 16 }, /* aliased to SCFDR */
462 [SCRFDR
] = { 0x20, 16 },
463 [SCSPTR
] = { 0x24, 16 },
464 [SCLSR
] = { 0x28, 16 },
467 .overrun_reg
= SCLSR
,
468 .overrun_mask
= SCLSR_ORER
,
469 .sampling_rate_mask
= SCI_SR(32),
470 .error_mask
= SCIF_DEFAULT_ERROR_MASK
,
471 .error_clear
= SCIF_ERROR_CLEAR
,
475 * SH7705-style SCIF(B) ports, lacking both SCSPTR and SCLSR
478 [SCIx_SH7705_SCIF_REGTYPE
] = {
480 [SCSMR
] = { 0x00, 16 },
481 [SCBRR
] = { 0x04, 8 },
482 [SCSCR
] = { 0x08, 16 },
483 [SCxTDR
] = { 0x20, 8 },
484 [SCxSR
] = { 0x14, 16 },
485 [SCxRDR
] = { 0x24, 8 },
486 [SCFCR
] = { 0x18, 16 },
487 [SCFDR
] = { 0x1c, 16 },
490 .overrun_reg
= SCxSR
,
491 .overrun_mask
= SCIFA_ORER
,
492 .sampling_rate_mask
= SCI_SR(16),
493 .error_mask
= SCIF_DEFAULT_ERROR_MASK
| SCIFA_ORER
,
494 .error_clear
= SCIF_ERROR_CLEAR
& ~SCIFA_ORER
,
498 #define sci_getreg(up, offset) (&to_sci_port(up)->params->regs[offset])
501 * The "offset" here is rather misleading, in that it refers to an enum
502 * value relative to the port mapping rather than the fixed offset
503 * itself, which needs to be manually retrieved from the platform's
504 * register map for the given port.
506 static unsigned int sci_serial_in(struct uart_port
*p
, int offset
)
508 const struct plat_sci_reg
*reg
= sci_getreg(p
, offset
);
511 return ioread8(p
->membase
+ (reg
->offset
<< p
->regshift
));
512 else if (reg
->size
== 16)
513 return ioread16(p
->membase
+ (reg
->offset
<< p
->regshift
));
515 WARN(1, "Invalid register access\n");
520 static void sci_serial_out(struct uart_port
*p
, int offset
, int value
)
522 const struct plat_sci_reg
*reg
= sci_getreg(p
, offset
);
525 iowrite8(value
, p
->membase
+ (reg
->offset
<< p
->regshift
));
526 else if (reg
->size
== 16)
527 iowrite16(value
, p
->membase
+ (reg
->offset
<< p
->regshift
));
529 WARN(1, "Invalid register access\n");
532 static void sci_port_enable(struct sci_port
*sci_port
)
536 if (!sci_port
->port
.dev
)
539 pm_runtime_get_sync(sci_port
->port
.dev
);
541 for (i
= 0; i
< SCI_NUM_CLKS
; i
++) {
542 clk_prepare_enable(sci_port
->clks
[i
]);
543 sci_port
->clk_rates
[i
] = clk_get_rate(sci_port
->clks
[i
]);
545 sci_port
->port
.uartclk
= sci_port
->clk_rates
[SCI_FCK
];
548 static void sci_port_disable(struct sci_port
*sci_port
)
552 if (!sci_port
->port
.dev
)
555 for (i
= SCI_NUM_CLKS
; i
-- > 0; )
556 clk_disable_unprepare(sci_port
->clks
[i
]);
558 pm_runtime_put_sync(sci_port
->port
.dev
);
561 static inline unsigned long port_rx_irq_mask(struct uart_port
*port
)
564 * Not all ports (such as SCIFA) will support REIE. Rather than
565 * special-casing the port type, we check the port initialization
566 * IRQ enable mask to see whether the IRQ is desired at all. If
567 * it's unset, it's logically inferred that there's no point in
570 return SCSCR_RIE
| (to_sci_port(port
)->cfg
->scscr
& SCSCR_REIE
);
573 static void sci_start_tx(struct uart_port
*port
)
575 struct sci_port
*s
= to_sci_port(port
);
578 #ifdef CONFIG_SERIAL_SH_SCI_DMA
579 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
580 u16
new, scr
= serial_port_in(port
, SCSCR
);
582 new = scr
| SCSCR_TDRQE
;
584 new = scr
& ~SCSCR_TDRQE
;
586 serial_port_out(port
, SCSCR
, new);
589 if (s
->chan_tx
&& !uart_circ_empty(&s
->port
.state
->xmit
) &&
590 dma_submit_error(s
->cookie_tx
)) {
592 schedule_work(&s
->work_tx
);
596 if (!s
->chan_tx
|| port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
597 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
598 ctrl
= serial_port_in(port
, SCSCR
);
599 serial_port_out(port
, SCSCR
, ctrl
| SCSCR_TIE
);
603 static void sci_stop_tx(struct uart_port
*port
)
607 /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
608 ctrl
= serial_port_in(port
, SCSCR
);
610 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
)
611 ctrl
&= ~SCSCR_TDRQE
;
615 serial_port_out(port
, SCSCR
, ctrl
);
618 static void sci_start_rx(struct uart_port
*port
)
622 ctrl
= serial_port_in(port
, SCSCR
) | port_rx_irq_mask(port
);
624 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
)
625 ctrl
&= ~SCSCR_RDRQE
;
627 serial_port_out(port
, SCSCR
, ctrl
);
630 static void sci_stop_rx(struct uart_port
*port
)
634 ctrl
= serial_port_in(port
, SCSCR
);
636 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
)
637 ctrl
&= ~SCSCR_RDRQE
;
639 ctrl
&= ~port_rx_irq_mask(port
);
641 serial_port_out(port
, SCSCR
, ctrl
);
644 static void sci_clear_SCxSR(struct uart_port
*port
, unsigned int mask
)
646 if (port
->type
== PORT_SCI
) {
647 /* Just store the mask */
648 serial_port_out(port
, SCxSR
, mask
);
649 } else if (to_sci_port(port
)->params
->overrun_mask
== SCIFA_ORER
) {
650 /* SCIFA/SCIFB and SCIF on SH7705/SH7720/SH7721 */
651 /* Only clear the status bits we want to clear */
652 serial_port_out(port
, SCxSR
,
653 serial_port_in(port
, SCxSR
) & mask
);
655 /* Store the mask, clear parity/framing errors */
656 serial_port_out(port
, SCxSR
, mask
& ~(SCIF_FERC
| SCIF_PERC
));
660 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || \
661 defined(CONFIG_SERIAL_SH_SCI_EARLYCON)
663 #ifdef CONFIG_CONSOLE_POLL
664 static int sci_poll_get_char(struct uart_port
*port
)
666 unsigned short status
;
670 status
= serial_port_in(port
, SCxSR
);
671 if (status
& SCxSR_ERRORS(port
)) {
672 sci_clear_SCxSR(port
, SCxSR_ERROR_CLEAR(port
));
678 if (!(status
& SCxSR_RDxF(port
)))
681 c
= serial_port_in(port
, SCxRDR
);
684 serial_port_in(port
, SCxSR
);
685 sci_clear_SCxSR(port
, SCxSR_RDxF_CLEAR(port
));
691 static void sci_poll_put_char(struct uart_port
*port
, unsigned char c
)
693 unsigned short status
;
696 status
= serial_port_in(port
, SCxSR
);
697 } while (!(status
& SCxSR_TDxE(port
)));
699 serial_port_out(port
, SCxTDR
, c
);
700 sci_clear_SCxSR(port
, SCxSR_TDxE_CLEAR(port
) & ~SCxSR_TEND(port
));
702 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE ||
703 CONFIG_SERIAL_SH_SCI_EARLYCON */
705 static void sci_init_pins(struct uart_port
*port
, unsigned int cflag
)
707 struct sci_port
*s
= to_sci_port(port
);
710 * Use port-specific handler if provided.
712 if (s
->cfg
->ops
&& s
->cfg
->ops
->init_pins
) {
713 s
->cfg
->ops
->init_pins(port
, cflag
);
717 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
718 u16 data
= serial_port_in(port
, SCPDR
);
719 u16 ctrl
= serial_port_in(port
, SCPCR
);
721 /* Enable RXD and TXD pin functions */
722 ctrl
&= ~(SCPCR_RXDC
| SCPCR_TXDC
);
723 if (to_sci_port(port
)->has_rtscts
) {
724 /* RTS# is output, active low, unless autorts */
725 if (!(port
->mctrl
& TIOCM_RTS
)) {
728 } else if (!s
->autorts
) {
732 /* Enable RTS# pin function */
735 /* Enable CTS# pin function */
738 serial_port_out(port
, SCPDR
, data
);
739 serial_port_out(port
, SCPCR
, ctrl
);
740 } else if (sci_getreg(port
, SCSPTR
)->size
) {
741 u16 status
= serial_port_in(port
, SCSPTR
);
743 /* RTS# is always output; and active low, unless autorts */
744 status
|= SCSPTR_RTSIO
;
745 if (!(port
->mctrl
& TIOCM_RTS
))
746 status
|= SCSPTR_RTSDT
;
747 else if (!s
->autorts
)
748 status
&= ~SCSPTR_RTSDT
;
749 /* CTS# and SCK are inputs */
750 status
&= ~(SCSPTR_CTSIO
| SCSPTR_SCKIO
);
751 serial_port_out(port
, SCSPTR
, status
);
755 static int sci_txfill(struct uart_port
*port
)
757 struct sci_port
*s
= to_sci_port(port
);
758 unsigned int fifo_mask
= (s
->params
->fifosize
<< 1) - 1;
759 const struct plat_sci_reg
*reg
;
761 reg
= sci_getreg(port
, SCTFDR
);
763 return serial_port_in(port
, SCTFDR
) & fifo_mask
;
765 reg
= sci_getreg(port
, SCFDR
);
767 return serial_port_in(port
, SCFDR
) >> 8;
769 return !(serial_port_in(port
, SCxSR
) & SCI_TDRE
);
772 static int sci_txroom(struct uart_port
*port
)
774 return port
->fifosize
- sci_txfill(port
);
777 static int sci_rxfill(struct uart_port
*port
)
779 struct sci_port
*s
= to_sci_port(port
);
780 unsigned int fifo_mask
= (s
->params
->fifosize
<< 1) - 1;
781 const struct plat_sci_reg
*reg
;
783 reg
= sci_getreg(port
, SCRFDR
);
785 return serial_port_in(port
, SCRFDR
) & fifo_mask
;
787 reg
= sci_getreg(port
, SCFDR
);
789 return serial_port_in(port
, SCFDR
) & fifo_mask
;
791 return (serial_port_in(port
, SCxSR
) & SCxSR_RDxF(port
)) != 0;
794 /* ********************************************************************** *
795 * the interrupt related routines *
796 * ********************************************************************** */
798 static void sci_transmit_chars(struct uart_port
*port
)
800 struct circ_buf
*xmit
= &port
->state
->xmit
;
801 unsigned int stopped
= uart_tx_stopped(port
);
802 unsigned short status
;
806 status
= serial_port_in(port
, SCxSR
);
807 if (!(status
& SCxSR_TDxE(port
))) {
808 ctrl
= serial_port_in(port
, SCSCR
);
809 if (uart_circ_empty(xmit
))
813 serial_port_out(port
, SCSCR
, ctrl
);
817 count
= sci_txroom(port
);
825 } else if (!uart_circ_empty(xmit
) && !stopped
) {
826 c
= xmit
->buf
[xmit
->tail
];
827 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
- 1);
832 serial_port_out(port
, SCxTDR
, c
);
835 } while (--count
> 0);
837 sci_clear_SCxSR(port
, SCxSR_TDxE_CLEAR(port
));
839 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
840 uart_write_wakeup(port
);
841 if (uart_circ_empty(xmit
))
846 /* On SH3, SCIF may read end-of-break as a space->mark char */
847 #define STEPFN(c) ({int __c = (c); (((__c-1)|(__c)) == -1); })
849 static void sci_receive_chars(struct uart_port
*port
)
851 struct tty_port
*tport
= &port
->state
->port
;
852 int i
, count
, copied
= 0;
853 unsigned short status
;
856 status
= serial_port_in(port
, SCxSR
);
857 if (!(status
& SCxSR_RDxF(port
)))
861 /* Don't copy more bytes than there is room for in the buffer */
862 count
= tty_buffer_request_room(tport
, sci_rxfill(port
));
864 /* If for any reason we can't copy more data, we're done! */
868 if (port
->type
== PORT_SCI
) {
869 char c
= serial_port_in(port
, SCxRDR
);
870 if (uart_handle_sysrq_char(port
, c
))
873 tty_insert_flip_char(tport
, c
, TTY_NORMAL
);
875 for (i
= 0; i
< count
; i
++) {
878 if (port
->type
== PORT_SCIF
||
879 port
->type
== PORT_HSCIF
) {
880 status
= serial_port_in(port
, SCxSR
);
881 c
= serial_port_in(port
, SCxRDR
);
883 c
= serial_port_in(port
, SCxRDR
);
884 status
= serial_port_in(port
, SCxSR
);
886 if (uart_handle_sysrq_char(port
, c
)) {
891 /* Store data and status */
892 if (status
& SCxSR_FER(port
)) {
894 port
->icount
.frame
++;
895 dev_notice(port
->dev
, "frame error\n");
896 } else if (status
& SCxSR_PER(port
)) {
898 port
->icount
.parity
++;
899 dev_notice(port
->dev
, "parity error\n");
903 tty_insert_flip_char(tport
, c
, flag
);
907 serial_port_in(port
, SCxSR
); /* dummy read */
908 sci_clear_SCxSR(port
, SCxSR_RDxF_CLEAR(port
));
911 port
->icount
.rx
+= count
;
915 /* Tell the rest of the system the news. New characters! */
916 tty_flip_buffer_push(tport
);
918 /* TTY buffers full; read from RX reg to prevent lockup */
919 serial_port_in(port
, SCxRDR
);
920 serial_port_in(port
, SCxSR
); /* dummy read */
921 sci_clear_SCxSR(port
, SCxSR_RDxF_CLEAR(port
));
925 static int sci_handle_errors(struct uart_port
*port
)
928 unsigned short status
= serial_port_in(port
, SCxSR
);
929 struct tty_port
*tport
= &port
->state
->port
;
930 struct sci_port
*s
= to_sci_port(port
);
932 /* Handle overruns */
933 if (status
& s
->params
->overrun_mask
) {
934 port
->icount
.overrun
++;
937 if (tty_insert_flip_char(tport
, 0, TTY_OVERRUN
))
940 dev_notice(port
->dev
, "overrun error\n");
943 if (status
& SCxSR_FER(port
)) {
945 port
->icount
.frame
++;
947 if (tty_insert_flip_char(tport
, 0, TTY_FRAME
))
950 dev_notice(port
->dev
, "frame error\n");
953 if (status
& SCxSR_PER(port
)) {
955 port
->icount
.parity
++;
957 if (tty_insert_flip_char(tport
, 0, TTY_PARITY
))
960 dev_notice(port
->dev
, "parity error\n");
964 tty_flip_buffer_push(tport
);
969 static int sci_handle_fifo_overrun(struct uart_port
*port
)
971 struct tty_port
*tport
= &port
->state
->port
;
972 struct sci_port
*s
= to_sci_port(port
);
973 const struct plat_sci_reg
*reg
;
977 reg
= sci_getreg(port
, s
->params
->overrun_reg
);
981 status
= serial_port_in(port
, s
->params
->overrun_reg
);
982 if (status
& s
->params
->overrun_mask
) {
983 status
&= ~s
->params
->overrun_mask
;
984 serial_port_out(port
, s
->params
->overrun_reg
, status
);
986 port
->icount
.overrun
++;
988 tty_insert_flip_char(tport
, 0, TTY_OVERRUN
);
989 tty_flip_buffer_push(tport
);
991 dev_dbg(port
->dev
, "overrun error\n");
998 static int sci_handle_breaks(struct uart_port
*port
)
1001 unsigned short status
= serial_port_in(port
, SCxSR
);
1002 struct tty_port
*tport
= &port
->state
->port
;
1004 if (uart_handle_break(port
))
1007 if (status
& SCxSR_BRK(port
)) {
1010 /* Notify of BREAK */
1011 if (tty_insert_flip_char(tport
, 0, TTY_BREAK
))
1014 dev_dbg(port
->dev
, "BREAK detected\n");
1018 tty_flip_buffer_push(tport
);
1020 copied
+= sci_handle_fifo_overrun(port
);
1025 static int scif_set_rtrg(struct uart_port
*port
, int rx_trig
)
1031 if (rx_trig
>= port
->fifosize
)
1032 rx_trig
= port
->fifosize
;
1034 /* HSCIF can be set to an arbitrary level. */
1035 if (sci_getreg(port
, HSRTRGR
)->size
) {
1036 serial_port_out(port
, HSRTRGR
, rx_trig
);
1040 switch (port
->type
) {
1045 } else if (rx_trig
< 8) {
1048 } else if (rx_trig
< 14) {
1052 bits
= SCFCR_RTRG0
| SCFCR_RTRG1
;
1061 } else if (rx_trig
< 32) {
1064 } else if (rx_trig
< 48) {
1068 bits
= SCFCR_RTRG0
| SCFCR_RTRG1
;
1073 WARN(1, "unknown FIFO configuration");
1077 serial_port_out(port
, SCFCR
,
1078 (serial_port_in(port
, SCFCR
) &
1079 ~(SCFCR_RTRG1
| SCFCR_RTRG0
)) | bits
);
1084 static int scif_rtrg_enabled(struct uart_port
*port
)
1086 if (sci_getreg(port
, HSRTRGR
)->size
)
1087 return serial_port_in(port
, HSRTRGR
) != 0;
1089 return (serial_port_in(port
, SCFCR
) &
1090 (SCFCR_RTRG0
| SCFCR_RTRG1
)) != 0;
1093 static void rx_fifo_timer_fn(struct timer_list
*t
)
1095 struct sci_port
*s
= from_timer(s
, t
, rx_fifo_timer
);
1096 struct uart_port
*port
= &s
->port
;
1098 dev_dbg(port
->dev
, "Rx timed out\n");
1099 scif_set_rtrg(port
, 1);
1102 static ssize_t
rx_trigger_show(struct device
*dev
,
1103 struct device_attribute
*attr
,
1106 struct uart_port
*port
= dev_get_drvdata(dev
);
1107 struct sci_port
*sci
= to_sci_port(port
);
1109 return sprintf(buf
, "%d\n", sci
->rx_trigger
);
1112 static ssize_t
rx_trigger_store(struct device
*dev
,
1113 struct device_attribute
*attr
,
1117 struct uart_port
*port
= dev_get_drvdata(dev
);
1118 struct sci_port
*sci
= to_sci_port(port
);
1122 ret
= kstrtol(buf
, 0, &r
);
1126 sci
->rx_trigger
= scif_set_rtrg(port
, r
);
1127 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
)
1128 scif_set_rtrg(port
, 1);
1133 static DEVICE_ATTR(rx_fifo_trigger
, 0644, rx_trigger_show
, rx_trigger_store
);
1135 static ssize_t
rx_fifo_timeout_show(struct device
*dev
,
1136 struct device_attribute
*attr
,
1139 struct uart_port
*port
= dev_get_drvdata(dev
);
1140 struct sci_port
*sci
= to_sci_port(port
);
1143 if (port
->type
== PORT_HSCIF
)
1144 v
= sci
->hscif_tot
>> HSSCR_TOT_SHIFT
;
1146 v
= sci
->rx_fifo_timeout
;
1148 return sprintf(buf
, "%d\n", v
);
1151 static ssize_t
rx_fifo_timeout_store(struct device
*dev
,
1152 struct device_attribute
*attr
,
1156 struct uart_port
*port
= dev_get_drvdata(dev
);
1157 struct sci_port
*sci
= to_sci_port(port
);
1161 ret
= kstrtol(buf
, 0, &r
);
1165 if (port
->type
== PORT_HSCIF
) {
1168 sci
->hscif_tot
= r
<< HSSCR_TOT_SHIFT
;
1170 sci
->rx_fifo_timeout
= r
;
1171 scif_set_rtrg(port
, 1);
1173 timer_setup(&sci
->rx_fifo_timer
, rx_fifo_timer_fn
, 0);
1179 static DEVICE_ATTR_RW(rx_fifo_timeout
);
1182 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1183 static void sci_dma_tx_complete(void *arg
)
1185 struct sci_port
*s
= arg
;
1186 struct uart_port
*port
= &s
->port
;
1187 struct circ_buf
*xmit
= &port
->state
->xmit
;
1188 unsigned long flags
;
1190 dev_dbg(port
->dev
, "%s(%d)\n", __func__
, port
->line
);
1192 spin_lock_irqsave(&port
->lock
, flags
);
1194 xmit
->tail
+= s
->tx_dma_len
;
1195 xmit
->tail
&= UART_XMIT_SIZE
- 1;
1197 port
->icount
.tx
+= s
->tx_dma_len
;
1199 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
1200 uart_write_wakeup(port
);
1202 if (!uart_circ_empty(xmit
)) {
1204 schedule_work(&s
->work_tx
);
1206 s
->cookie_tx
= -EINVAL
;
1207 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
1208 u16 ctrl
= serial_port_in(port
, SCSCR
);
1209 serial_port_out(port
, SCSCR
, ctrl
& ~SCSCR_TIE
);
1213 spin_unlock_irqrestore(&port
->lock
, flags
);
1216 /* Locking: called with port lock held */
1217 static int sci_dma_rx_push(struct sci_port
*s
, void *buf
, size_t count
)
1219 struct uart_port
*port
= &s
->port
;
1220 struct tty_port
*tport
= &port
->state
->port
;
1223 copied
= tty_insert_flip_string(tport
, buf
, count
);
1225 port
->icount
.buf_overrun
++;
1227 port
->icount
.rx
+= copied
;
1232 static int sci_dma_rx_find_active(struct sci_port
*s
)
1236 for (i
= 0; i
< ARRAY_SIZE(s
->cookie_rx
); i
++)
1237 if (s
->active_rx
== s
->cookie_rx
[i
])
1243 static void sci_rx_dma_release(struct sci_port
*s
)
1245 struct dma_chan
*chan
= s
->chan_rx_saved
;
1247 s
->chan_rx_saved
= s
->chan_rx
= NULL
;
1248 s
->cookie_rx
[0] = s
->cookie_rx
[1] = -EINVAL
;
1249 dmaengine_terminate_sync(chan
);
1250 dma_free_coherent(chan
->device
->dev
, s
->buf_len_rx
* 2, s
->rx_buf
[0],
1251 sg_dma_address(&s
->sg_rx
[0]));
1252 dma_release_channel(chan
);
1255 static void start_hrtimer_us(struct hrtimer
*hrt
, unsigned long usec
)
1257 long sec
= usec
/ 1000000;
1258 long nsec
= (usec
% 1000000) * 1000;
1259 ktime_t t
= ktime_set(sec
, nsec
);
1261 hrtimer_start(hrt
, t
, HRTIMER_MODE_REL
);
1264 static void sci_dma_rx_complete(void *arg
)
1266 struct sci_port
*s
= arg
;
1267 struct dma_chan
*chan
= s
->chan_rx
;
1268 struct uart_port
*port
= &s
->port
;
1269 struct dma_async_tx_descriptor
*desc
;
1270 unsigned long flags
;
1271 int active
, count
= 0;
1273 dev_dbg(port
->dev
, "%s(%d) active cookie %d\n", __func__
, port
->line
,
1276 spin_lock_irqsave(&port
->lock
, flags
);
1278 active
= sci_dma_rx_find_active(s
);
1280 count
= sci_dma_rx_push(s
, s
->rx_buf
[active
], s
->buf_len_rx
);
1282 start_hrtimer_us(&s
->rx_timer
, s
->rx_timeout
);
1285 tty_flip_buffer_push(&port
->state
->port
);
1287 desc
= dmaengine_prep_slave_sg(s
->chan_rx
, &s
->sg_rx
[active
], 1,
1289 DMA_PREP_INTERRUPT
| DMA_CTRL_ACK
);
1293 desc
->callback
= sci_dma_rx_complete
;
1294 desc
->callback_param
= s
;
1295 s
->cookie_rx
[active
] = dmaengine_submit(desc
);
1296 if (dma_submit_error(s
->cookie_rx
[active
]))
1299 s
->active_rx
= s
->cookie_rx
[!active
];
1301 dma_async_issue_pending(chan
);
1303 spin_unlock_irqrestore(&port
->lock
, flags
);
1304 dev_dbg(port
->dev
, "%s: cookie %d #%d, new active cookie %d\n",
1305 __func__
, s
->cookie_rx
[active
], active
, s
->active_rx
);
1309 spin_unlock_irqrestore(&port
->lock
, flags
);
1310 dev_warn(port
->dev
, "Failed submitting Rx DMA descriptor\n");
1312 spin_lock_irqsave(&port
->lock
, flags
);
1315 spin_unlock_irqrestore(&port
->lock
, flags
);
1318 static void sci_tx_dma_release(struct sci_port
*s
)
1320 struct dma_chan
*chan
= s
->chan_tx_saved
;
1322 cancel_work_sync(&s
->work_tx
);
1323 s
->chan_tx_saved
= s
->chan_tx
= NULL
;
1324 s
->cookie_tx
= -EINVAL
;
1325 dmaengine_terminate_sync(chan
);
1326 dma_unmap_single(chan
->device
->dev
, s
->tx_dma_addr
, UART_XMIT_SIZE
,
1328 dma_release_channel(chan
);
1331 static int sci_submit_rx(struct sci_port
*s
, bool port_lock_held
)
1333 struct dma_chan
*chan
= s
->chan_rx
;
1334 struct uart_port
*port
= &s
->port
;
1335 unsigned long flags
;
1338 for (i
= 0; i
< 2; i
++) {
1339 struct scatterlist
*sg
= &s
->sg_rx
[i
];
1340 struct dma_async_tx_descriptor
*desc
;
1342 desc
= dmaengine_prep_slave_sg(chan
,
1343 sg
, 1, DMA_DEV_TO_MEM
,
1344 DMA_PREP_INTERRUPT
| DMA_CTRL_ACK
);
1348 desc
->callback
= sci_dma_rx_complete
;
1349 desc
->callback_param
= s
;
1350 s
->cookie_rx
[i
] = dmaengine_submit(desc
);
1351 if (dma_submit_error(s
->cookie_rx
[i
]))
1356 s
->active_rx
= s
->cookie_rx
[0];
1358 dma_async_issue_pending(chan
);
1363 if (!port_lock_held
)
1364 spin_lock_irqsave(&port
->lock
, flags
);
1366 dmaengine_terminate_async(chan
);
1367 for (i
= 0; i
< 2; i
++)
1368 s
->cookie_rx
[i
] = -EINVAL
;
1372 if (!port_lock_held
)
1373 spin_unlock_irqrestore(&port
->lock
, flags
);
1377 static void work_fn_tx(struct work_struct
*work
)
1379 struct sci_port
*s
= container_of(work
, struct sci_port
, work_tx
);
1380 struct dma_async_tx_descriptor
*desc
;
1381 struct dma_chan
*chan
= s
->chan_tx
;
1382 struct uart_port
*port
= &s
->port
;
1383 struct circ_buf
*xmit
= &port
->state
->xmit
;
1384 unsigned long flags
;
1390 * Port xmit buffer is already mapped, and it is one page... Just adjust
1391 * offsets and lengths. Since it is a circular buffer, we have to
1392 * transmit till the end, and then the rest. Take the port lock to get a
1393 * consistent xmit buffer state.
1395 spin_lock_irq(&port
->lock
);
1398 buf
= s
->tx_dma_addr
+ (tail
& (UART_XMIT_SIZE
- 1));
1399 s
->tx_dma_len
= min_t(unsigned int,
1400 CIRC_CNT(head
, tail
, UART_XMIT_SIZE
),
1401 CIRC_CNT_TO_END(head
, tail
, UART_XMIT_SIZE
));
1402 if (!s
->tx_dma_len
) {
1403 /* Transmit buffer has been flushed */
1404 spin_unlock_irq(&port
->lock
);
1408 desc
= dmaengine_prep_slave_single(chan
, buf
, s
->tx_dma_len
,
1410 DMA_PREP_INTERRUPT
| DMA_CTRL_ACK
);
1412 spin_unlock_irq(&port
->lock
);
1413 dev_warn(port
->dev
, "Failed preparing Tx DMA descriptor\n");
1417 dma_sync_single_for_device(chan
->device
->dev
, buf
, s
->tx_dma_len
,
1420 desc
->callback
= sci_dma_tx_complete
;
1421 desc
->callback_param
= s
;
1422 s
->cookie_tx
= dmaengine_submit(desc
);
1423 if (dma_submit_error(s
->cookie_tx
)) {
1424 spin_unlock_irq(&port
->lock
);
1425 dev_warn(port
->dev
, "Failed submitting Tx DMA descriptor\n");
1429 spin_unlock_irq(&port
->lock
);
1430 dev_dbg(port
->dev
, "%s: %p: %d...%d, cookie %d\n",
1431 __func__
, xmit
->buf
, tail
, head
, s
->cookie_tx
);
1433 dma_async_issue_pending(chan
);
1437 spin_lock_irqsave(&port
->lock
, flags
);
1440 spin_unlock_irqrestore(&port
->lock
, flags
);
1444 static enum hrtimer_restart
rx_timer_fn(struct hrtimer
*t
)
1446 struct sci_port
*s
= container_of(t
, struct sci_port
, rx_timer
);
1447 struct dma_chan
*chan
= s
->chan_rx
;
1448 struct uart_port
*port
= &s
->port
;
1449 struct dma_tx_state state
;
1450 enum dma_status status
;
1451 unsigned long flags
;
1456 dev_dbg(port
->dev
, "DMA Rx timed out\n");
1458 spin_lock_irqsave(&port
->lock
, flags
);
1460 active
= sci_dma_rx_find_active(s
);
1462 spin_unlock_irqrestore(&port
->lock
, flags
);
1463 return HRTIMER_NORESTART
;
1466 status
= dmaengine_tx_status(s
->chan_rx
, s
->active_rx
, &state
);
1467 if (status
== DMA_COMPLETE
) {
1468 spin_unlock_irqrestore(&port
->lock
, flags
);
1469 dev_dbg(port
->dev
, "Cookie %d #%d has already completed\n",
1470 s
->active_rx
, active
);
1472 /* Let packet complete handler take care of the packet */
1473 return HRTIMER_NORESTART
;
1476 dmaengine_pause(chan
);
1479 * sometimes DMA transfer doesn't stop even if it is stopped and
1480 * data keeps on coming until transaction is complete so check
1481 * for DMA_COMPLETE again
1482 * Let packet complete handler take care of the packet
1484 status
= dmaengine_tx_status(s
->chan_rx
, s
->active_rx
, &state
);
1485 if (status
== DMA_COMPLETE
) {
1486 spin_unlock_irqrestore(&port
->lock
, flags
);
1487 dev_dbg(port
->dev
, "Transaction complete after DMA engine was stopped");
1488 return HRTIMER_NORESTART
;
1491 /* Handle incomplete DMA receive */
1492 dmaengine_terminate_async(s
->chan_rx
);
1493 read
= sg_dma_len(&s
->sg_rx
[active
]) - state
.residue
;
1496 count
= sci_dma_rx_push(s
, s
->rx_buf
[active
], read
);
1498 tty_flip_buffer_push(&port
->state
->port
);
1501 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
)
1502 sci_submit_rx(s
, true);
1504 /* Direct new serial port interrupts back to CPU */
1505 scr
= serial_port_in(port
, SCSCR
);
1506 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
1507 scr
&= ~SCSCR_RDRQE
;
1508 enable_irq(s
->irqs
[SCIx_RXI_IRQ
]);
1510 serial_port_out(port
, SCSCR
, scr
| SCSCR_RIE
);
1512 spin_unlock_irqrestore(&port
->lock
, flags
);
1514 return HRTIMER_NORESTART
;
1517 static struct dma_chan
*sci_request_dma_chan(struct uart_port
*port
,
1518 enum dma_transfer_direction dir
)
1520 struct dma_chan
*chan
;
1521 struct dma_slave_config cfg
;
1524 chan
= dma_request_slave_channel(port
->dev
,
1525 dir
== DMA_MEM_TO_DEV
? "tx" : "rx");
1527 dev_warn(port
->dev
, "dma_request_slave_channel failed\n");
1531 memset(&cfg
, 0, sizeof(cfg
));
1532 cfg
.direction
= dir
;
1533 if (dir
== DMA_MEM_TO_DEV
) {
1534 cfg
.dst_addr
= port
->mapbase
+
1535 (sci_getreg(port
, SCxTDR
)->offset
<< port
->regshift
);
1536 cfg
.dst_addr_width
= DMA_SLAVE_BUSWIDTH_1_BYTE
;
1538 cfg
.src_addr
= port
->mapbase
+
1539 (sci_getreg(port
, SCxRDR
)->offset
<< port
->regshift
);
1540 cfg
.src_addr_width
= DMA_SLAVE_BUSWIDTH_1_BYTE
;
1543 ret
= dmaengine_slave_config(chan
, &cfg
);
1545 dev_warn(port
->dev
, "dmaengine_slave_config failed %d\n", ret
);
1546 dma_release_channel(chan
);
1553 static void sci_request_dma(struct uart_port
*port
)
1555 struct sci_port
*s
= to_sci_port(port
);
1556 struct dma_chan
*chan
;
1558 dev_dbg(port
->dev
, "%s: port %d\n", __func__
, port
->line
);
1561 * DMA on console may interfere with Kernel log messages which use
1562 * plain putchar(). So, simply don't use it with a console.
1564 if (uart_console(port
))
1567 if (!port
->dev
->of_node
)
1570 s
->cookie_tx
= -EINVAL
;
1573 * Don't request a dma channel if no channel was specified
1574 * in the device tree.
1576 if (!of_find_property(port
->dev
->of_node
, "dmas", NULL
))
1579 chan
= sci_request_dma_chan(port
, DMA_MEM_TO_DEV
);
1580 dev_dbg(port
->dev
, "%s: TX: got channel %p\n", __func__
, chan
);
1582 /* UART circular tx buffer is an aligned page. */
1583 s
->tx_dma_addr
= dma_map_single(chan
->device
->dev
,
1584 port
->state
->xmit
.buf
,
1587 if (dma_mapping_error(chan
->device
->dev
, s
->tx_dma_addr
)) {
1588 dev_warn(port
->dev
, "Failed mapping Tx DMA descriptor\n");
1589 dma_release_channel(chan
);
1591 dev_dbg(port
->dev
, "%s: mapped %lu@%p to %pad\n",
1592 __func__
, UART_XMIT_SIZE
,
1593 port
->state
->xmit
.buf
, &s
->tx_dma_addr
);
1595 INIT_WORK(&s
->work_tx
, work_fn_tx
);
1596 s
->chan_tx_saved
= s
->chan_tx
= chan
;
1600 chan
= sci_request_dma_chan(port
, DMA_DEV_TO_MEM
);
1601 dev_dbg(port
->dev
, "%s: RX: got channel %p\n", __func__
, chan
);
1607 s
->buf_len_rx
= 2 * max_t(size_t, 16, port
->fifosize
);
1608 buf
= dma_alloc_coherent(chan
->device
->dev
, s
->buf_len_rx
* 2,
1612 "Failed to allocate Rx dma buffer, using PIO\n");
1613 dma_release_channel(chan
);
1617 for (i
= 0; i
< 2; i
++) {
1618 struct scatterlist
*sg
= &s
->sg_rx
[i
];
1620 sg_init_table(sg
, 1);
1622 sg_dma_address(sg
) = dma
;
1623 sg_dma_len(sg
) = s
->buf_len_rx
;
1625 buf
+= s
->buf_len_rx
;
1626 dma
+= s
->buf_len_rx
;
1629 hrtimer_init(&s
->rx_timer
, CLOCK_MONOTONIC
, HRTIMER_MODE_REL
);
1630 s
->rx_timer
.function
= rx_timer_fn
;
1632 s
->chan_rx_saved
= s
->chan_rx
= chan
;
1634 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
)
1635 sci_submit_rx(s
, false);
1639 static void sci_free_dma(struct uart_port
*port
)
1641 struct sci_port
*s
= to_sci_port(port
);
1643 if (s
->chan_tx_saved
)
1644 sci_tx_dma_release(s
);
1645 if (s
->chan_rx_saved
)
1646 sci_rx_dma_release(s
);
1649 static void sci_flush_buffer(struct uart_port
*port
)
1651 struct sci_port
*s
= to_sci_port(port
);
1654 * In uart_flush_buffer(), the xmit circular buffer has just been
1655 * cleared, so we have to reset tx_dma_len accordingly, and stop any
1660 dmaengine_terminate_async(s
->chan_tx
);
1661 s
->cookie_tx
= -EINVAL
;
1664 #else /* !CONFIG_SERIAL_SH_SCI_DMA */
1665 static inline void sci_request_dma(struct uart_port
*port
)
1669 static inline void sci_free_dma(struct uart_port
*port
)
1673 #define sci_flush_buffer NULL
1674 #endif /* !CONFIG_SERIAL_SH_SCI_DMA */
1676 static irqreturn_t
sci_rx_interrupt(int irq
, void *ptr
)
1678 struct uart_port
*port
= ptr
;
1679 struct sci_port
*s
= to_sci_port(port
);
1681 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1683 u16 scr
= serial_port_in(port
, SCSCR
);
1684 u16 ssr
= serial_port_in(port
, SCxSR
);
1686 /* Disable future Rx interrupts */
1687 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
1688 disable_irq_nosync(irq
);
1691 if (sci_submit_rx(s
, false) < 0)
1696 serial_port_out(port
, SCSCR
, scr
);
1697 /* Clear current interrupt */
1698 serial_port_out(port
, SCxSR
,
1699 ssr
& ~(SCIF_DR
| SCxSR_RDxF(port
)));
1700 dev_dbg(port
->dev
, "Rx IRQ %lu: setup t-out in %u us\n",
1701 jiffies
, s
->rx_timeout
);
1702 start_hrtimer_us(&s
->rx_timer
, s
->rx_timeout
);
1710 if (s
->rx_trigger
> 1 && s
->rx_fifo_timeout
> 0) {
1711 if (!scif_rtrg_enabled(port
))
1712 scif_set_rtrg(port
, s
->rx_trigger
);
1714 mod_timer(&s
->rx_fifo_timer
, jiffies
+ DIV_ROUND_UP(
1715 s
->rx_frame
* HZ
* s
->rx_fifo_timeout
, 1000000));
1718 /* I think sci_receive_chars has to be called irrespective
1719 * of whether the I_IXOFF is set, otherwise, how is the interrupt
1722 sci_receive_chars(ptr
);
1727 static irqreturn_t
sci_tx_interrupt(int irq
, void *ptr
)
1729 struct uart_port
*port
= ptr
;
1730 unsigned long flags
;
1732 spin_lock_irqsave(&port
->lock
, flags
);
1733 sci_transmit_chars(port
);
1734 spin_unlock_irqrestore(&port
->lock
, flags
);
1739 static irqreturn_t
sci_br_interrupt(int irq
, void *ptr
)
1741 struct uart_port
*port
= ptr
;
1744 sci_handle_breaks(port
);
1745 sci_clear_SCxSR(port
, SCxSR_BREAK_CLEAR(port
));
1750 static irqreturn_t
sci_er_interrupt(int irq
, void *ptr
)
1752 struct uart_port
*port
= ptr
;
1753 struct sci_port
*s
= to_sci_port(port
);
1755 if (s
->irqs
[SCIx_ERI_IRQ
] == s
->irqs
[SCIx_BRI_IRQ
]) {
1756 /* Break and Error interrupts are muxed */
1757 unsigned short ssr_status
= serial_port_in(port
, SCxSR
);
1759 /* Break Interrupt */
1760 if (ssr_status
& SCxSR_BRK(port
))
1761 sci_br_interrupt(irq
, ptr
);
1764 if (!(ssr_status
& SCxSR_ERRORS(port
)))
1769 if (port
->type
== PORT_SCI
) {
1770 if (sci_handle_errors(port
)) {
1771 /* discard character in rx buffer */
1772 serial_port_in(port
, SCxSR
);
1773 sci_clear_SCxSR(port
, SCxSR_RDxF_CLEAR(port
));
1776 sci_handle_fifo_overrun(port
);
1778 sci_receive_chars(ptr
);
1781 sci_clear_SCxSR(port
, SCxSR_ERROR_CLEAR(port
));
1783 /* Kick the transmission */
1785 sci_tx_interrupt(irq
, ptr
);
1790 static irqreturn_t
sci_mpxed_interrupt(int irq
, void *ptr
)
1792 unsigned short ssr_status
, scr_status
, err_enabled
, orer_status
= 0;
1793 struct uart_port
*port
= ptr
;
1794 struct sci_port
*s
= to_sci_port(port
);
1795 irqreturn_t ret
= IRQ_NONE
;
1797 ssr_status
= serial_port_in(port
, SCxSR
);
1798 scr_status
= serial_port_in(port
, SCSCR
);
1799 if (s
->params
->overrun_reg
== SCxSR
)
1800 orer_status
= ssr_status
;
1801 else if (sci_getreg(port
, s
->params
->overrun_reg
)->size
)
1802 orer_status
= serial_port_in(port
, s
->params
->overrun_reg
);
1804 err_enabled
= scr_status
& port_rx_irq_mask(port
);
1807 if ((ssr_status
& SCxSR_TDxE(port
)) && (scr_status
& SCSCR_TIE
) &&
1809 ret
= sci_tx_interrupt(irq
, ptr
);
1812 * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
1815 if (((ssr_status
& SCxSR_RDxF(port
)) || s
->chan_rx
) &&
1816 (scr_status
& SCSCR_RIE
))
1817 ret
= sci_rx_interrupt(irq
, ptr
);
1819 /* Error Interrupt */
1820 if ((ssr_status
& SCxSR_ERRORS(port
)) && err_enabled
)
1821 ret
= sci_er_interrupt(irq
, ptr
);
1823 /* Break Interrupt */
1824 if ((ssr_status
& SCxSR_BRK(port
)) && err_enabled
)
1825 ret
= sci_br_interrupt(irq
, ptr
);
1827 /* Overrun Interrupt */
1828 if (orer_status
& s
->params
->overrun_mask
) {
1829 sci_handle_fifo_overrun(port
);
1836 static const struct sci_irq_desc
{
1838 irq_handler_t handler
;
1839 } sci_irq_desc
[] = {
1841 * Split out handlers, the default case.
1845 .handler
= sci_er_interrupt
,
1850 .handler
= sci_rx_interrupt
,
1855 .handler
= sci_tx_interrupt
,
1860 .handler
= sci_br_interrupt
,
1865 .handler
= sci_rx_interrupt
,
1870 .handler
= sci_tx_interrupt
,
1874 * Special muxed handler.
1878 .handler
= sci_mpxed_interrupt
,
1882 static int sci_request_irq(struct sci_port
*port
)
1884 struct uart_port
*up
= &port
->port
;
1885 int i
, j
, w
, ret
= 0;
1887 for (i
= j
= 0; i
< SCIx_NR_IRQS
; i
++, j
++) {
1888 const struct sci_irq_desc
*desc
;
1891 /* Check if already registered (muxed) */
1892 for (w
= 0; w
< i
; w
++)
1893 if (port
->irqs
[w
] == port
->irqs
[i
])
1898 if (SCIx_IRQ_IS_MUXED(port
)) {
1902 irq
= port
->irqs
[i
];
1905 * Certain port types won't support all of the
1906 * available interrupt sources.
1908 if (unlikely(irq
< 0))
1912 desc
= sci_irq_desc
+ i
;
1913 port
->irqstr
[j
] = kasprintf(GFP_KERNEL
, "%s:%s",
1914 dev_name(up
->dev
), desc
->desc
);
1915 if (!port
->irqstr
[j
]) {
1920 ret
= request_irq(irq
, desc
->handler
, up
->irqflags
,
1921 port
->irqstr
[j
], port
);
1922 if (unlikely(ret
)) {
1923 dev_err(up
->dev
, "Can't allocate %s IRQ\n", desc
->desc
);
1932 free_irq(port
->irqs
[i
], port
);
1936 kfree(port
->irqstr
[j
]);
1941 static void sci_free_irq(struct sci_port
*port
)
1946 * Intentionally in reverse order so we iterate over the muxed
1949 for (i
= 0; i
< SCIx_NR_IRQS
; i
++) {
1950 int irq
= port
->irqs
[i
];
1953 * Certain port types won't support all of the available
1954 * interrupt sources.
1956 if (unlikely(irq
< 0))
1959 /* Check if already freed (irq was muxed) */
1960 for (j
= 0; j
< i
; j
++)
1961 if (port
->irqs
[j
] == irq
)
1966 free_irq(port
->irqs
[i
], port
);
1967 kfree(port
->irqstr
[i
]);
1969 if (SCIx_IRQ_IS_MUXED(port
)) {
1970 /* If there's only one IRQ, we're done. */
1976 static unsigned int sci_tx_empty(struct uart_port
*port
)
1978 unsigned short status
= serial_port_in(port
, SCxSR
);
1979 unsigned short in_tx_fifo
= sci_txfill(port
);
1981 return (status
& SCxSR_TEND(port
)) && !in_tx_fifo
? TIOCSER_TEMT
: 0;
1984 static void sci_set_rts(struct uart_port
*port
, bool state
)
1986 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
1987 u16 data
= serial_port_in(port
, SCPDR
);
1991 data
&= ~SCPDR_RTSD
;
1994 serial_port_out(port
, SCPDR
, data
);
1996 /* RTS# is output */
1997 serial_port_out(port
, SCPCR
,
1998 serial_port_in(port
, SCPCR
) | SCPCR_RTSC
);
1999 } else if (sci_getreg(port
, SCSPTR
)->size
) {
2000 u16 ctrl
= serial_port_in(port
, SCSPTR
);
2004 ctrl
&= ~SCSPTR_RTSDT
;
2006 ctrl
|= SCSPTR_RTSDT
;
2007 serial_port_out(port
, SCSPTR
, ctrl
);
2011 static bool sci_get_cts(struct uart_port
*port
)
2013 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
2015 return !(serial_port_in(port
, SCPDR
) & SCPDR_CTSD
);
2016 } else if (sci_getreg(port
, SCSPTR
)->size
) {
2018 return !(serial_port_in(port
, SCSPTR
) & SCSPTR_CTSDT
);
2025 * Modem control is a bit of a mixed bag for SCI(F) ports. Generally
2026 * CTS/RTS is supported in hardware by at least one port and controlled
2027 * via SCSPTR (SCxPCR for SCIFA/B parts), or external pins (presently
2028 * handled via the ->init_pins() op, which is a bit of a one-way street,
2029 * lacking any ability to defer pin control -- this will later be
2030 * converted over to the GPIO framework).
2032 * Other modes (such as loopback) are supported generically on certain
2033 * port types, but not others. For these it's sufficient to test for the
2034 * existence of the support register and simply ignore the port type.
2036 static void sci_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
2038 struct sci_port
*s
= to_sci_port(port
);
2040 if (mctrl
& TIOCM_LOOP
) {
2041 const struct plat_sci_reg
*reg
;
2044 * Standard loopback mode for SCFCR ports.
2046 reg
= sci_getreg(port
, SCFCR
);
2048 serial_port_out(port
, SCFCR
,
2049 serial_port_in(port
, SCFCR
) |
2053 mctrl_gpio_set(s
->gpios
, mctrl
);
2058 if (!(mctrl
& TIOCM_RTS
)) {
2059 /* Disable Auto RTS */
2060 serial_port_out(port
, SCFCR
,
2061 serial_port_in(port
, SCFCR
) & ~SCFCR_MCE
);
2064 sci_set_rts(port
, 0);
2065 } else if (s
->autorts
) {
2066 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
) {
2067 /* Enable RTS# pin function */
2068 serial_port_out(port
, SCPCR
,
2069 serial_port_in(port
, SCPCR
) & ~SCPCR_RTSC
);
2072 /* Enable Auto RTS */
2073 serial_port_out(port
, SCFCR
,
2074 serial_port_in(port
, SCFCR
) | SCFCR_MCE
);
2077 sci_set_rts(port
, 1);
2081 static unsigned int sci_get_mctrl(struct uart_port
*port
)
2083 struct sci_port
*s
= to_sci_port(port
);
2084 struct mctrl_gpios
*gpios
= s
->gpios
;
2085 unsigned int mctrl
= 0;
2087 mctrl_gpio_get(gpios
, &mctrl
);
2090 * CTS/RTS is handled in hardware when supported, while nothing
2094 if (sci_get_cts(port
))
2096 } else if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios
, UART_GPIO_CTS
))) {
2099 if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios
, UART_GPIO_DSR
)))
2101 if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios
, UART_GPIO_DCD
)))
2107 static void sci_enable_ms(struct uart_port
*port
)
2109 mctrl_gpio_enable_ms(to_sci_port(port
)->gpios
);
2112 static void sci_break_ctl(struct uart_port
*port
, int break_state
)
2114 unsigned short scscr
, scsptr
;
2115 unsigned long flags
;
2117 /* check wheter the port has SCSPTR */
2118 if (!sci_getreg(port
, SCSPTR
)->size
) {
2120 * Not supported by hardware. Most parts couple break and rx
2121 * interrupts together, with break detection always enabled.
2126 spin_lock_irqsave(&port
->lock
, flags
);
2127 scsptr
= serial_port_in(port
, SCSPTR
);
2128 scscr
= serial_port_in(port
, SCSCR
);
2130 if (break_state
== -1) {
2131 scsptr
= (scsptr
| SCSPTR_SPB2IO
) & ~SCSPTR_SPB2DT
;
2134 scsptr
= (scsptr
| SCSPTR_SPB2DT
) & ~SCSPTR_SPB2IO
;
2138 serial_port_out(port
, SCSPTR
, scsptr
);
2139 serial_port_out(port
, SCSCR
, scscr
);
2140 spin_unlock_irqrestore(&port
->lock
, flags
);
2143 static int sci_startup(struct uart_port
*port
)
2145 struct sci_port
*s
= to_sci_port(port
);
2148 dev_dbg(port
->dev
, "%s(%d)\n", __func__
, port
->line
);
2150 sci_request_dma(port
);
2152 ret
= sci_request_irq(s
);
2153 if (unlikely(ret
< 0)) {
2161 static void sci_shutdown(struct uart_port
*port
)
2163 struct sci_port
*s
= to_sci_port(port
);
2164 unsigned long flags
;
2167 dev_dbg(port
->dev
, "%s(%d)\n", __func__
, port
->line
);
2170 mctrl_gpio_disable_ms(to_sci_port(port
)->gpios
);
2172 spin_lock_irqsave(&port
->lock
, flags
);
2176 * Stop RX and TX, disable related interrupts, keep clock source
2177 * and HSCIF TOT bits
2179 scr
= serial_port_in(port
, SCSCR
);
2180 serial_port_out(port
, SCSCR
, scr
&
2181 (SCSCR_CKE1
| SCSCR_CKE0
| s
->hscif_tot
));
2182 spin_unlock_irqrestore(&port
->lock
, flags
);
2184 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2185 if (s
->chan_rx_saved
) {
2186 dev_dbg(port
->dev
, "%s(%d) deleting rx_timer\n", __func__
,
2188 hrtimer_cancel(&s
->rx_timer
);
2192 if (s
->rx_trigger
> 1 && s
->rx_fifo_timeout
> 0)
2193 del_timer_sync(&s
->rx_fifo_timer
);
2198 static int sci_sck_calc(struct sci_port
*s
, unsigned int bps
,
2201 unsigned long freq
= s
->clk_rates
[SCI_SCK
];
2202 int err
, min_err
= INT_MAX
;
2205 if (s
->port
.type
!= PORT_HSCIF
)
2208 for_each_sr(sr
, s
) {
2209 err
= DIV_ROUND_CLOSEST(freq
, sr
) - bps
;
2210 if (abs(err
) >= abs(min_err
))
2220 dev_dbg(s
->port
.dev
, "SCK: %u%+d bps using SR %u\n", bps
, min_err
,
2225 static int sci_brg_calc(struct sci_port
*s
, unsigned int bps
,
2226 unsigned long freq
, unsigned int *dlr
,
2229 int err
, min_err
= INT_MAX
;
2230 unsigned int sr
, dl
;
2232 if (s
->port
.type
!= PORT_HSCIF
)
2235 for_each_sr(sr
, s
) {
2236 dl
= DIV_ROUND_CLOSEST(freq
, sr
* bps
);
2237 dl
= clamp(dl
, 1U, 65535U);
2239 err
= DIV_ROUND_CLOSEST(freq
, sr
* dl
) - bps
;
2240 if (abs(err
) >= abs(min_err
))
2251 dev_dbg(s
->port
.dev
, "BRG: %u%+d bps using DL %u SR %u\n", bps
,
2252 min_err
, *dlr
, *srr
+ 1);
2256 /* calculate sample rate, BRR, and clock select */
2257 static int sci_scbrr_calc(struct sci_port
*s
, unsigned int bps
,
2258 unsigned int *brr
, unsigned int *srr
,
2261 unsigned long freq
= s
->clk_rates
[SCI_FCK
];
2262 unsigned int sr
, br
, prediv
, scrate
, c
;
2263 int err
, min_err
= INT_MAX
;
2265 if (s
->port
.type
!= PORT_HSCIF
)
2269 * Find the combination of sample rate and clock select with the
2270 * smallest deviation from the desired baud rate.
2271 * Prefer high sample rates to maximise the receive margin.
2273 * M: Receive margin (%)
2274 * N: Ratio of bit rate to clock (N = sampling rate)
2275 * D: Clock duty (D = 0 to 1.0)
2276 * L: Frame length (L = 9 to 12)
2277 * F: Absolute value of clock frequency deviation
2279 * M = |(0.5 - 1 / 2 * N) - ((L - 0.5) * F) -
2280 * (|D - 0.5| / N * (1 + F))|
2281 * NOTE: Usually, treat D for 0.5, F is 0 by this calculation.
2283 for_each_sr(sr
, s
) {
2284 for (c
= 0; c
<= 3; c
++) {
2285 /* integerized formulas from HSCIF documentation */
2286 prediv
= sr
* (1 << (2 * c
+ 1));
2289 * We need to calculate:
2291 * br = freq / (prediv * bps) clamped to [1..256]
2292 * err = freq / (br * prediv) - bps
2294 * Watch out for overflow when calculating the desired
2295 * sampling clock rate!
2297 if (bps
> UINT_MAX
/ prediv
)
2300 scrate
= prediv
* bps
;
2301 br
= DIV_ROUND_CLOSEST(freq
, scrate
);
2302 br
= clamp(br
, 1U, 256U);
2304 err
= DIV_ROUND_CLOSEST(freq
, br
* prediv
) - bps
;
2305 if (abs(err
) >= abs(min_err
))
2319 dev_dbg(s
->port
.dev
, "BRR: %u%+d bps using N %u SR %u cks %u\n", bps
,
2320 min_err
, *brr
, *srr
+ 1, *cks
);
2324 static void sci_reset(struct uart_port
*port
)
2326 const struct plat_sci_reg
*reg
;
2327 unsigned int status
;
2328 struct sci_port
*s
= to_sci_port(port
);
2330 serial_port_out(port
, SCSCR
, s
->hscif_tot
); /* TE=0, RE=0, CKE1=0 */
2332 reg
= sci_getreg(port
, SCFCR
);
2334 serial_port_out(port
, SCFCR
, SCFCR_RFRST
| SCFCR_TFRST
);
2336 sci_clear_SCxSR(port
,
2337 SCxSR_RDxF_CLEAR(port
) & SCxSR_ERROR_CLEAR(port
) &
2338 SCxSR_BREAK_CLEAR(port
));
2339 if (sci_getreg(port
, SCLSR
)->size
) {
2340 status
= serial_port_in(port
, SCLSR
);
2341 status
&= ~(SCLSR_TO
| SCLSR_ORER
);
2342 serial_port_out(port
, SCLSR
, status
);
2345 if (s
->rx_trigger
> 1) {
2346 if (s
->rx_fifo_timeout
) {
2347 scif_set_rtrg(port
, 1);
2348 timer_setup(&s
->rx_fifo_timer
, rx_fifo_timer_fn
, 0);
2350 if (port
->type
== PORT_SCIFA
||
2351 port
->type
== PORT_SCIFB
)
2352 scif_set_rtrg(port
, 1);
2354 scif_set_rtrg(port
, s
->rx_trigger
);
2359 static void sci_set_termios(struct uart_port
*port
, struct ktermios
*termios
,
2360 struct ktermios
*old
)
2362 unsigned int baud
, smr_val
= SCSMR_ASYNC
, scr_val
= 0, i
, bits
;
2363 unsigned int brr
= 255, cks
= 0, srr
= 15, dl
= 0, sccks
= 0;
2364 unsigned int brr1
= 255, cks1
= 0, srr1
= 15, dl1
= 0;
2365 struct sci_port
*s
= to_sci_port(port
);
2366 const struct plat_sci_reg
*reg
;
2367 int min_err
= INT_MAX
, err
;
2368 unsigned long max_freq
= 0;
2370 unsigned long flags
;
2372 if ((termios
->c_cflag
& CSIZE
) == CS7
)
2373 smr_val
|= SCSMR_CHR
;
2374 if (termios
->c_cflag
& PARENB
)
2375 smr_val
|= SCSMR_PE
;
2376 if (termios
->c_cflag
& PARODD
)
2377 smr_val
|= SCSMR_PE
| SCSMR_ODD
;
2378 if (termios
->c_cflag
& CSTOPB
)
2379 smr_val
|= SCSMR_STOP
;
2382 * earlyprintk comes here early on with port->uartclk set to zero.
2383 * the clock framework is not up and running at this point so here
2384 * we assume that 115200 is the maximum baud rate. please note that
2385 * the baud rate is not programmed during earlyprintk - it is assumed
2386 * that the previous boot loader has enabled required clocks and
2387 * setup the baud rate generator hardware for us already.
2389 if (!port
->uartclk
) {
2390 baud
= uart_get_baud_rate(port
, termios
, old
, 0, 115200);
2394 for (i
= 0; i
< SCI_NUM_CLKS
; i
++)
2395 max_freq
= max(max_freq
, s
->clk_rates
[i
]);
2397 baud
= uart_get_baud_rate(port
, termios
, old
, 0, max_freq
/ min_sr(s
));
2402 * There can be multiple sources for the sampling clock. Find the one
2403 * that gives us the smallest deviation from the desired baud rate.
2406 /* Optional Undivided External Clock */
2407 if (s
->clk_rates
[SCI_SCK
] && port
->type
!= PORT_SCIFA
&&
2408 port
->type
!= PORT_SCIFB
) {
2409 err
= sci_sck_calc(s
, baud
, &srr1
);
2410 if (abs(err
) < abs(min_err
)) {
2412 scr_val
= SCSCR_CKE1
;
2421 /* Optional BRG Frequency Divided External Clock */
2422 if (s
->clk_rates
[SCI_SCIF_CLK
] && sci_getreg(port
, SCDL
)->size
) {
2423 err
= sci_brg_calc(s
, baud
, s
->clk_rates
[SCI_SCIF_CLK
], &dl1
,
2425 if (abs(err
) < abs(min_err
)) {
2426 best_clk
= SCI_SCIF_CLK
;
2427 scr_val
= SCSCR_CKE1
;
2437 /* Optional BRG Frequency Divided Internal Clock */
2438 if (s
->clk_rates
[SCI_BRG_INT
] && sci_getreg(port
, SCDL
)->size
) {
2439 err
= sci_brg_calc(s
, baud
, s
->clk_rates
[SCI_BRG_INT
], &dl1
,
2441 if (abs(err
) < abs(min_err
)) {
2442 best_clk
= SCI_BRG_INT
;
2443 scr_val
= SCSCR_CKE1
;
2453 /* Divided Functional Clock using standard Bit Rate Register */
2454 err
= sci_scbrr_calc(s
, baud
, &brr1
, &srr1
, &cks1
);
2455 if (abs(err
) < abs(min_err
)) {
2466 dev_dbg(port
->dev
, "Using clk %pC for %u%+d bps\n",
2467 s
->clks
[best_clk
], baud
, min_err
);
2472 * Program the optional External Baud Rate Generator (BRG) first.
2473 * It controls the mux to select (H)SCK or frequency divided clock.
2475 if (best_clk
>= 0 && sci_getreg(port
, SCCKS
)->size
) {
2476 serial_port_out(port
, SCDL
, dl
);
2477 serial_port_out(port
, SCCKS
, sccks
);
2480 spin_lock_irqsave(&port
->lock
, flags
);
2484 uart_update_timeout(port
, termios
->c_cflag
, baud
);
2486 /* byte size and parity */
2487 switch (termios
->c_cflag
& CSIZE
) {
2502 if (termios
->c_cflag
& CSTOPB
)
2504 if (termios
->c_cflag
& PARENB
)
2507 if (best_clk
>= 0) {
2508 if (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
)
2510 case 5: smr_val
|= SCSMR_SRC_5
; break;
2511 case 7: smr_val
|= SCSMR_SRC_7
; break;
2512 case 11: smr_val
|= SCSMR_SRC_11
; break;
2513 case 13: smr_val
|= SCSMR_SRC_13
; break;
2514 case 16: smr_val
|= SCSMR_SRC_16
; break;
2515 case 17: smr_val
|= SCSMR_SRC_17
; break;
2516 case 19: smr_val
|= SCSMR_SRC_19
; break;
2517 case 27: smr_val
|= SCSMR_SRC_27
; break;
2520 serial_port_out(port
, SCSCR
, scr_val
| s
->hscif_tot
);
2521 serial_port_out(port
, SCSMR
, smr_val
);
2522 serial_port_out(port
, SCBRR
, brr
);
2523 if (sci_getreg(port
, HSSRR
)->size
) {
2524 unsigned int hssrr
= srr
| HSCIF_SRE
;
2525 /* Calculate deviation from intended rate at the
2526 * center of the last stop bit in sampling clocks.
2528 int last_stop
= bits
* 2 - 1;
2529 int deviation
= DIV_ROUND_CLOSEST(min_err
* last_stop
*
2533 if (abs(deviation
) >= 2) {
2534 /* At least two sampling clocks off at the
2535 * last stop bit; we can increase the error
2536 * margin by shifting the sampling point.
2538 int shift
= clamp(deviation
/ 2, -8, 7);
2540 hssrr
|= (shift
<< HSCIF_SRHP_SHIFT
) &
2542 hssrr
|= HSCIF_SRDE
;
2544 serial_port_out(port
, HSSRR
, hssrr
);
2547 /* Wait one bit interval */
2548 udelay((1000000 + (baud
- 1)) / baud
);
2550 /* Don't touch the bit rate configuration */
2551 scr_val
= s
->cfg
->scscr
& (SCSCR_CKE1
| SCSCR_CKE0
);
2552 smr_val
|= serial_port_in(port
, SCSMR
) &
2553 (SCSMR_CKEDG
| SCSMR_SRC_MASK
| SCSMR_CKS
);
2554 serial_port_out(port
, SCSCR
, scr_val
| s
->hscif_tot
);
2555 serial_port_out(port
, SCSMR
, smr_val
);
2558 sci_init_pins(port
, termios
->c_cflag
);
2560 port
->status
&= ~UPSTAT_AUTOCTS
;
2562 reg
= sci_getreg(port
, SCFCR
);
2564 unsigned short ctrl
= serial_port_in(port
, SCFCR
);
2566 if ((port
->flags
& UPF_HARD_FLOW
) &&
2567 (termios
->c_cflag
& CRTSCTS
)) {
2568 /* There is no CTS interrupt to restart the hardware */
2569 port
->status
|= UPSTAT_AUTOCTS
;
2570 /* MCE is enabled when RTS is raised */
2575 * As we've done a sci_reset() above, ensure we don't
2576 * interfere with the FIFOs while toggling MCE. As the
2577 * reset values could still be set, simply mask them out.
2579 ctrl
&= ~(SCFCR_RFRST
| SCFCR_TFRST
);
2581 serial_port_out(port
, SCFCR
, ctrl
);
2583 if (port
->flags
& UPF_HARD_FLOW
) {
2584 /* Refresh (Auto) RTS */
2585 sci_set_mctrl(port
, port
->mctrl
);
2588 scr_val
|= SCSCR_RE
| SCSCR_TE
|
2589 (s
->cfg
->scscr
& ~(SCSCR_CKE1
| SCSCR_CKE0
));
2590 serial_port_out(port
, SCSCR
, scr_val
| s
->hscif_tot
);
2591 if ((srr
+ 1 == 5) &&
2592 (port
->type
== PORT_SCIFA
|| port
->type
== PORT_SCIFB
)) {
2594 * In asynchronous mode, when the sampling rate is 1/5, first
2595 * received data may become invalid on some SCIFA and SCIFB.
2596 * To avoid this problem wait more than 1 serial data time (1
2597 * bit time x serial data number) after setting SCSCR.RE = 1.
2599 udelay(DIV_ROUND_UP(10 * 1000000, baud
));
2603 * Calculate delay for 2 DMA buffers (4 FIFO).
2604 * See serial_core.c::uart_update_timeout().
2605 * With 10 bits (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above
2606 * function calculates 1 jiffie for the data plus 5 jiffies for the
2607 * "slop(e)." Then below we calculate 5 jiffies (20ms) for 2 DMA
2608 * buffers (4 FIFO sizes), but when performing a faster transfer, the
2609 * value obtained by this formula is too small. Therefore, if the value
2610 * is smaller than 20ms, use 20ms as the timeout value for DMA.
2612 s
->rx_frame
= (10000 * bits
) / (baud
/ 100);
2613 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2614 s
->rx_timeout
= s
->buf_len_rx
* 2 * s
->rx_frame
;
2615 if (s
->rx_timeout
< 20)
2619 if ((termios
->c_cflag
& CREAD
) != 0)
2622 spin_unlock_irqrestore(&port
->lock
, flags
);
2624 sci_port_disable(s
);
2626 if (UART_ENABLE_MS(port
, termios
->c_cflag
))
2627 sci_enable_ms(port
);
2630 static void sci_pm(struct uart_port
*port
, unsigned int state
,
2631 unsigned int oldstate
)
2633 struct sci_port
*sci_port
= to_sci_port(port
);
2636 case UART_PM_STATE_OFF
:
2637 sci_port_disable(sci_port
);
2640 sci_port_enable(sci_port
);
2645 static const char *sci_type(struct uart_port
*port
)
2647 switch (port
->type
) {
2665 static int sci_remap_port(struct uart_port
*port
)
2667 struct sci_port
*sport
= to_sci_port(port
);
2670 * Nothing to do if there's already an established membase.
2675 if (port
->dev
->of_node
|| (port
->flags
& UPF_IOREMAP
)) {
2676 port
->membase
= ioremap_nocache(port
->mapbase
, sport
->reg_size
);
2677 if (unlikely(!port
->membase
)) {
2678 dev_err(port
->dev
, "can't remap port#%d\n", port
->line
);
2683 * For the simple (and majority of) cases where we don't
2684 * need to do any remapping, just cast the cookie
2687 port
->membase
= (void __iomem
*)(uintptr_t)port
->mapbase
;
2693 static void sci_release_port(struct uart_port
*port
)
2695 struct sci_port
*sport
= to_sci_port(port
);
2697 if (port
->dev
->of_node
|| (port
->flags
& UPF_IOREMAP
)) {
2698 iounmap(port
->membase
);
2699 port
->membase
= NULL
;
2702 release_mem_region(port
->mapbase
, sport
->reg_size
);
2705 static int sci_request_port(struct uart_port
*port
)
2707 struct resource
*res
;
2708 struct sci_port
*sport
= to_sci_port(port
);
2711 res
= request_mem_region(port
->mapbase
, sport
->reg_size
,
2712 dev_name(port
->dev
));
2713 if (unlikely(res
== NULL
)) {
2714 dev_err(port
->dev
, "request_mem_region failed.");
2718 ret
= sci_remap_port(port
);
2719 if (unlikely(ret
!= 0)) {
2720 release_resource(res
);
2727 static void sci_config_port(struct uart_port
*port
, int flags
)
2729 if (flags
& UART_CONFIG_TYPE
) {
2730 struct sci_port
*sport
= to_sci_port(port
);
2732 port
->type
= sport
->cfg
->type
;
2733 sci_request_port(port
);
2737 static int sci_verify_port(struct uart_port
*port
, struct serial_struct
*ser
)
2739 if (ser
->baud_base
< 2400)
2740 /* No paper tape reader for Mitch.. */
2746 static const struct uart_ops sci_uart_ops
= {
2747 .tx_empty
= sci_tx_empty
,
2748 .set_mctrl
= sci_set_mctrl
,
2749 .get_mctrl
= sci_get_mctrl
,
2750 .start_tx
= sci_start_tx
,
2751 .stop_tx
= sci_stop_tx
,
2752 .stop_rx
= sci_stop_rx
,
2753 .enable_ms
= sci_enable_ms
,
2754 .break_ctl
= sci_break_ctl
,
2755 .startup
= sci_startup
,
2756 .shutdown
= sci_shutdown
,
2757 .flush_buffer
= sci_flush_buffer
,
2758 .set_termios
= sci_set_termios
,
2761 .release_port
= sci_release_port
,
2762 .request_port
= sci_request_port
,
2763 .config_port
= sci_config_port
,
2764 .verify_port
= sci_verify_port
,
2765 #ifdef CONFIG_CONSOLE_POLL
2766 .poll_get_char
= sci_poll_get_char
,
2767 .poll_put_char
= sci_poll_put_char
,
2771 static int sci_init_clocks(struct sci_port
*sci_port
, struct device
*dev
)
2773 const char *clk_names
[] = {
2776 [SCI_BRG_INT
] = "brg_int",
2777 [SCI_SCIF_CLK
] = "scif_clk",
2782 if (sci_port
->cfg
->type
== PORT_HSCIF
)
2783 clk_names
[SCI_SCK
] = "hsck";
2785 for (i
= 0; i
< SCI_NUM_CLKS
; i
++) {
2786 clk
= devm_clk_get(dev
, clk_names
[i
]);
2787 if (PTR_ERR(clk
) == -EPROBE_DEFER
)
2788 return -EPROBE_DEFER
;
2790 if (IS_ERR(clk
) && i
== SCI_FCK
) {
2792 * "fck" used to be called "sci_ick", and we need to
2793 * maintain DT backward compatibility.
2795 clk
= devm_clk_get(dev
, "sci_ick");
2796 if (PTR_ERR(clk
) == -EPROBE_DEFER
)
2797 return -EPROBE_DEFER
;
2803 * Not all SH platforms declare a clock lookup entry
2804 * for SCI devices, in which case we need to get the
2805 * global "peripheral_clk" clock.
2807 clk
= devm_clk_get(dev
, "peripheral_clk");
2811 dev_err(dev
, "failed to get %s (%ld)\n", clk_names
[i
],
2813 return PTR_ERR(clk
);
2818 dev_dbg(dev
, "failed to get %s (%ld)\n", clk_names
[i
],
2821 dev_dbg(dev
, "clk %s is %pC rate %lu\n", clk_names
[i
],
2822 clk
, clk_get_rate(clk
));
2823 sci_port
->clks
[i
] = IS_ERR(clk
) ? NULL
: clk
;
2828 static const struct sci_port_params
*
2829 sci_probe_regmap(const struct plat_sci_port
*cfg
)
2831 unsigned int regtype
;
2833 if (cfg
->regtype
!= SCIx_PROBE_REGTYPE
)
2834 return &sci_port_params
[cfg
->regtype
];
2836 switch (cfg
->type
) {
2838 regtype
= SCIx_SCI_REGTYPE
;
2841 regtype
= SCIx_IRDA_REGTYPE
;
2844 regtype
= SCIx_SCIFA_REGTYPE
;
2847 regtype
= SCIx_SCIFB_REGTYPE
;
2851 * The SH-4 is a bit of a misnomer here, although that's
2852 * where this particular port layout originated. This
2853 * configuration (or some slight variation thereof)
2854 * remains the dominant model for all SCIFs.
2856 regtype
= SCIx_SH4_SCIF_REGTYPE
;
2859 regtype
= SCIx_HSCIF_REGTYPE
;
2862 pr_err("Can't probe register map for given port\n");
2866 return &sci_port_params
[regtype
];
2869 static int sci_init_single(struct platform_device
*dev
,
2870 struct sci_port
*sci_port
, unsigned int index
,
2871 const struct plat_sci_port
*p
, bool early
)
2873 struct uart_port
*port
= &sci_port
->port
;
2874 const struct resource
*res
;
2880 port
->ops
= &sci_uart_ops
;
2881 port
->iotype
= UPIO_MEM
;
2884 res
= platform_get_resource(dev
, IORESOURCE_MEM
, 0);
2888 port
->mapbase
= res
->start
;
2889 sci_port
->reg_size
= resource_size(res
);
2891 for (i
= 0; i
< ARRAY_SIZE(sci_port
->irqs
); ++i
)
2892 sci_port
->irqs
[i
] = platform_get_irq(dev
, i
);
2894 /* The SCI generates several interrupts. They can be muxed together or
2895 * connected to different interrupt lines. In the muxed case only one
2896 * interrupt resource is specified as there is only one interrupt ID.
2897 * In the non-muxed case, up to 6 interrupt signals might be generated
2898 * from the SCI, however those signals might have their own individual
2899 * interrupt ID numbers, or muxed together with another interrupt.
2901 if (sci_port
->irqs
[0] < 0)
2904 if (sci_port
->irqs
[1] < 0)
2905 for (i
= 1; i
< ARRAY_SIZE(sci_port
->irqs
); i
++)
2906 sci_port
->irqs
[i
] = sci_port
->irqs
[0];
2908 sci_port
->params
= sci_probe_regmap(p
);
2909 if (unlikely(sci_port
->params
== NULL
))
2914 sci_port
->rx_trigger
= 48;
2917 sci_port
->rx_trigger
= 64;
2920 sci_port
->rx_trigger
= 32;
2923 if (p
->regtype
== SCIx_SH7705_SCIF_REGTYPE
)
2924 /* RX triggering not implemented for this IP */
2925 sci_port
->rx_trigger
= 1;
2927 sci_port
->rx_trigger
= 8;
2930 sci_port
->rx_trigger
= 1;
2934 sci_port
->rx_fifo_timeout
= 0;
2935 sci_port
->hscif_tot
= 0;
2937 /* SCIFA on sh7723 and sh7724 need a custom sampling rate that doesn't
2938 * match the SoC datasheet, this should be investigated. Let platform
2939 * data override the sampling rate for now.
2941 sci_port
->sampling_rate_mask
= p
->sampling_rate
2942 ? SCI_SR(p
->sampling_rate
)
2943 : sci_port
->params
->sampling_rate_mask
;
2946 ret
= sci_init_clocks(sci_port
, &dev
->dev
);
2950 port
->dev
= &dev
->dev
;
2952 pm_runtime_enable(&dev
->dev
);
2955 port
->type
= p
->type
;
2956 port
->flags
= UPF_FIXED_PORT
| UPF_BOOT_AUTOCONF
| p
->flags
;
2957 port
->fifosize
= sci_port
->params
->fifosize
;
2959 if (port
->type
== PORT_SCI
) {
2960 if (sci_port
->reg_size
>= 0x20)
2967 * The UART port needs an IRQ value, so we peg this to the RX IRQ
2968 * for the multi-IRQ ports, which is where we are primarily
2969 * concerned with the shutdown path synchronization.
2971 * For the muxed case there's nothing more to do.
2973 port
->irq
= sci_port
->irqs
[SCIx_RXI_IRQ
];
2976 port
->serial_in
= sci_serial_in
;
2977 port
->serial_out
= sci_serial_out
;
2982 static void sci_cleanup_single(struct sci_port
*port
)
2984 pm_runtime_disable(port
->port
.dev
);
2987 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || \
2988 defined(CONFIG_SERIAL_SH_SCI_EARLYCON)
2989 static void serial_console_putchar(struct uart_port
*port
, int ch
)
2991 sci_poll_put_char(port
, ch
);
2995 * Print a string to the serial port trying not to disturb
2996 * any possible real use of the port...
2998 static void serial_console_write(struct console
*co
, const char *s
,
3001 struct sci_port
*sci_port
= &sci_ports
[co
->index
];
3002 struct uart_port
*port
= &sci_port
->port
;
3003 unsigned short bits
, ctrl
, ctrl_temp
;
3004 unsigned long flags
;
3007 #if defined(SUPPORT_SYSRQ)
3012 if (oops_in_progress
)
3013 locked
= spin_trylock_irqsave(&port
->lock
, flags
);
3015 spin_lock_irqsave(&port
->lock
, flags
);
3017 /* first save SCSCR then disable interrupts, keep clock source */
3018 ctrl
= serial_port_in(port
, SCSCR
);
3019 ctrl_temp
= SCSCR_RE
| SCSCR_TE
|
3020 (sci_port
->cfg
->scscr
& ~(SCSCR_CKE1
| SCSCR_CKE0
)) |
3021 (ctrl
& (SCSCR_CKE1
| SCSCR_CKE0
));
3022 serial_port_out(port
, SCSCR
, ctrl_temp
| sci_port
->hscif_tot
);
3024 uart_console_write(port
, s
, count
, serial_console_putchar
);
3026 /* wait until fifo is empty and last bit has been transmitted */
3027 bits
= SCxSR_TDxE(port
) | SCxSR_TEND(port
);
3028 while ((serial_port_in(port
, SCxSR
) & bits
) != bits
)
3031 /* restore the SCSCR */
3032 serial_port_out(port
, SCSCR
, ctrl
);
3035 spin_unlock_irqrestore(&port
->lock
, flags
);
3038 static int serial_console_setup(struct console
*co
, char *options
)
3040 struct sci_port
*sci_port
;
3041 struct uart_port
*port
;
3049 * Refuse to handle any bogus ports.
3051 if (co
->index
< 0 || co
->index
>= SCI_NPORTS
)
3054 sci_port
= &sci_ports
[co
->index
];
3055 port
= &sci_port
->port
;
3058 * Refuse to handle uninitialized ports.
3063 ret
= sci_remap_port(port
);
3064 if (unlikely(ret
!= 0))
3068 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
3070 return uart_set_options(port
, co
, baud
, parity
, bits
, flow
);
3073 static struct console serial_console
= {
3075 .device
= uart_console_device
,
3076 .write
= serial_console_write
,
3077 .setup
= serial_console_setup
,
3078 .flags
= CON_PRINTBUFFER
,
3080 .data
= &sci_uart_driver
,
3083 static struct console early_serial_console
= {
3084 .name
= "early_ttySC",
3085 .write
= serial_console_write
,
3086 .flags
= CON_PRINTBUFFER
,
3090 static char early_serial_buf
[32];
3092 static int sci_probe_earlyprintk(struct platform_device
*pdev
)
3094 const struct plat_sci_port
*cfg
= dev_get_platdata(&pdev
->dev
);
3096 if (early_serial_console
.data
)
3099 early_serial_console
.index
= pdev
->id
;
3101 sci_init_single(pdev
, &sci_ports
[pdev
->id
], pdev
->id
, cfg
, true);
3103 serial_console_setup(&early_serial_console
, early_serial_buf
);
3105 if (!strstr(early_serial_buf
, "keep"))
3106 early_serial_console
.flags
|= CON_BOOT
;
3108 register_console(&early_serial_console
);
3112 #define SCI_CONSOLE (&serial_console)
3115 static inline int sci_probe_earlyprintk(struct platform_device
*pdev
)
3120 #define SCI_CONSOLE NULL
3122 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE || CONFIG_SERIAL_SH_SCI_EARLYCON */
3124 static const char banner
[] __initconst
= "SuperH (H)SCI(F) driver initialized";
3126 static DEFINE_MUTEX(sci_uart_registration_lock
);
3127 static struct uart_driver sci_uart_driver
= {
3128 .owner
= THIS_MODULE
,
3129 .driver_name
= "sci",
3130 .dev_name
= "ttySC",
3132 .minor
= SCI_MINOR_START
,
3134 .cons
= SCI_CONSOLE
,
3137 static int sci_remove(struct platform_device
*dev
)
3139 struct sci_port
*port
= platform_get_drvdata(dev
);
3140 unsigned int type
= port
->port
.type
; /* uart_remove_... clears it */
3142 sci_ports_in_use
&= ~BIT(port
->port
.line
);
3143 uart_remove_one_port(&sci_uart_driver
, &port
->port
);
3145 sci_cleanup_single(port
);
3147 if (port
->port
.fifosize
> 1) {
3148 sysfs_remove_file(&dev
->dev
.kobj
,
3149 &dev_attr_rx_fifo_trigger
.attr
);
3151 if (type
== PORT_SCIFA
|| type
== PORT_SCIFB
|| type
== PORT_HSCIF
) {
3152 sysfs_remove_file(&dev
->dev
.kobj
,
3153 &dev_attr_rx_fifo_timeout
.attr
);
3160 #define SCI_OF_DATA(type, regtype) (void *)((type) << 16 | (regtype))
3161 #define SCI_OF_TYPE(data) ((unsigned long)(data) >> 16)
3162 #define SCI_OF_REGTYPE(data) ((unsigned long)(data) & 0xffff)
3164 static const struct of_device_id of_sci_match
[] = {
3165 /* SoC-specific types */
3167 .compatible
= "renesas,scif-r7s72100",
3168 .data
= SCI_OF_DATA(PORT_SCIF
, SCIx_SH2_SCIF_FIFODATA_REGTYPE
),
3171 .compatible
= "renesas,scif-r7s9210",
3172 .data
= SCI_OF_DATA(PORT_SCIF
, SCIx_RZ_SCIFA_REGTYPE
),
3174 /* Family-specific types */
3176 .compatible
= "renesas,rcar-gen1-scif",
3177 .data
= SCI_OF_DATA(PORT_SCIF
, SCIx_SH4_SCIF_BRG_REGTYPE
),
3179 .compatible
= "renesas,rcar-gen2-scif",
3180 .data
= SCI_OF_DATA(PORT_SCIF
, SCIx_SH4_SCIF_BRG_REGTYPE
),
3182 .compatible
= "renesas,rcar-gen3-scif",
3183 .data
= SCI_OF_DATA(PORT_SCIF
, SCIx_SH4_SCIF_BRG_REGTYPE
),
3187 .compatible
= "renesas,scif",
3188 .data
= SCI_OF_DATA(PORT_SCIF
, SCIx_SH4_SCIF_REGTYPE
),
3190 .compatible
= "renesas,scifa",
3191 .data
= SCI_OF_DATA(PORT_SCIFA
, SCIx_SCIFA_REGTYPE
),
3193 .compatible
= "renesas,scifb",
3194 .data
= SCI_OF_DATA(PORT_SCIFB
, SCIx_SCIFB_REGTYPE
),
3196 .compatible
= "renesas,hscif",
3197 .data
= SCI_OF_DATA(PORT_HSCIF
, SCIx_HSCIF_REGTYPE
),
3199 .compatible
= "renesas,sci",
3200 .data
= SCI_OF_DATA(PORT_SCI
, SCIx_SCI_REGTYPE
),
3205 MODULE_DEVICE_TABLE(of
, of_sci_match
);
3207 static struct plat_sci_port
*sci_parse_dt(struct platform_device
*pdev
,
3208 unsigned int *dev_id
)
3210 struct device_node
*np
= pdev
->dev
.of_node
;
3211 struct plat_sci_port
*p
;
3212 struct sci_port
*sp
;
3216 if (!IS_ENABLED(CONFIG_OF
) || !np
)
3219 data
= of_device_get_match_data(&pdev
->dev
);
3221 p
= devm_kzalloc(&pdev
->dev
, sizeof(struct plat_sci_port
), GFP_KERNEL
);
3225 /* Get the line number from the aliases node. */
3226 id
= of_alias_get_id(np
, "serial");
3227 if (id
< 0 && ~sci_ports_in_use
)
3228 id
= ffz(sci_ports_in_use
);
3230 dev_err(&pdev
->dev
, "failed to get alias id (%d)\n", id
);
3233 if (id
>= ARRAY_SIZE(sci_ports
)) {
3234 dev_err(&pdev
->dev
, "serial%d out of range\n", id
);
3238 sp
= &sci_ports
[id
];
3241 p
->type
= SCI_OF_TYPE(data
);
3242 p
->regtype
= SCI_OF_REGTYPE(data
);
3244 sp
->has_rtscts
= of_property_read_bool(np
, "uart-has-rtscts");
3249 static int sci_probe_single(struct platform_device
*dev
,
3251 struct plat_sci_port
*p
,
3252 struct sci_port
*sciport
)
3257 if (unlikely(index
>= SCI_NPORTS
)) {
3258 dev_notice(&dev
->dev
, "Attempting to register port %d when only %d are available\n",
3259 index
+1, SCI_NPORTS
);
3260 dev_notice(&dev
->dev
, "Consider bumping CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
3263 BUILD_BUG_ON(SCI_NPORTS
> sizeof(sci_ports_in_use
) * 8);
3264 if (sci_ports_in_use
& BIT(index
))
3267 mutex_lock(&sci_uart_registration_lock
);
3268 if (!sci_uart_driver
.state
) {
3269 ret
= uart_register_driver(&sci_uart_driver
);
3271 mutex_unlock(&sci_uart_registration_lock
);
3275 mutex_unlock(&sci_uart_registration_lock
);
3277 ret
= sci_init_single(dev
, sciport
, index
, p
, false);
3281 sciport
->gpios
= mctrl_gpio_init(&sciport
->port
, 0);
3282 if (IS_ERR(sciport
->gpios
) && PTR_ERR(sciport
->gpios
) != -ENOSYS
)
3283 return PTR_ERR(sciport
->gpios
);
3285 if (sciport
->has_rtscts
) {
3286 if (!IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(sciport
->gpios
,
3288 !IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(sciport
->gpios
,
3290 dev_err(&dev
->dev
, "Conflicting RTS/CTS config\n");
3293 sciport
->port
.flags
|= UPF_HARD_FLOW
;
3296 ret
= uart_add_one_port(&sci_uart_driver
, &sciport
->port
);
3298 sci_cleanup_single(sciport
);
3305 static int sci_probe(struct platform_device
*dev
)
3307 struct plat_sci_port
*p
;
3308 struct sci_port
*sp
;
3309 unsigned int dev_id
;
3313 * If we've come here via earlyprintk initialization, head off to
3314 * the special early probe. We don't have sufficient device state
3315 * to make it beyond this yet.
3317 if (is_early_platform_device(dev
))
3318 return sci_probe_earlyprintk(dev
);
3320 if (dev
->dev
.of_node
) {
3321 p
= sci_parse_dt(dev
, &dev_id
);
3325 p
= dev
->dev
.platform_data
;
3327 dev_err(&dev
->dev
, "no platform data supplied\n");
3334 sp
= &sci_ports
[dev_id
];
3335 platform_set_drvdata(dev
, sp
);
3337 ret
= sci_probe_single(dev
, dev_id
, p
, sp
);
3341 if (sp
->port
.fifosize
> 1) {
3342 ret
= sysfs_create_file(&dev
->dev
.kobj
,
3343 &dev_attr_rx_fifo_trigger
.attr
);
3347 if (sp
->port
.type
== PORT_SCIFA
|| sp
->port
.type
== PORT_SCIFB
||
3348 sp
->port
.type
== PORT_HSCIF
) {
3349 ret
= sysfs_create_file(&dev
->dev
.kobj
,
3350 &dev_attr_rx_fifo_timeout
.attr
);
3352 if (sp
->port
.fifosize
> 1) {
3353 sysfs_remove_file(&dev
->dev
.kobj
,
3354 &dev_attr_rx_fifo_trigger
.attr
);
3360 #ifdef CONFIG_SH_STANDARD_BIOS
3361 sh_bios_gdb_detach();
3364 sci_ports_in_use
|= BIT(dev_id
);
3368 static __maybe_unused
int sci_suspend(struct device
*dev
)
3370 struct sci_port
*sport
= dev_get_drvdata(dev
);
3373 uart_suspend_port(&sci_uart_driver
, &sport
->port
);
3378 static __maybe_unused
int sci_resume(struct device
*dev
)
3380 struct sci_port
*sport
= dev_get_drvdata(dev
);
3383 uart_resume_port(&sci_uart_driver
, &sport
->port
);
3388 static SIMPLE_DEV_PM_OPS(sci_dev_pm_ops
, sci_suspend
, sci_resume
);
3390 static struct platform_driver sci_driver
= {
3392 .remove
= sci_remove
,
3395 .pm
= &sci_dev_pm_ops
,
3396 .of_match_table
= of_match_ptr(of_sci_match
),
3400 static int __init
sci_init(void)
3402 pr_info("%s\n", banner
);
3404 return platform_driver_register(&sci_driver
);
3407 static void __exit
sci_exit(void)
3409 platform_driver_unregister(&sci_driver
);
3411 if (sci_uart_driver
.state
)
3412 uart_unregister_driver(&sci_uart_driver
);
3415 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
3416 early_platform_init_buffer("earlyprintk", &sci_driver
,
3417 early_serial_buf
, ARRAY_SIZE(early_serial_buf
));
3419 #ifdef CONFIG_SERIAL_SH_SCI_EARLYCON
3420 static struct plat_sci_port port_cfg __initdata
;
3422 static int __init
early_console_setup(struct earlycon_device
*device
,
3425 if (!device
->port
.membase
)
3428 device
->port
.serial_in
= sci_serial_in
;
3429 device
->port
.serial_out
= sci_serial_out
;
3430 device
->port
.type
= type
;
3431 memcpy(&sci_ports
[0].port
, &device
->port
, sizeof(struct uart_port
));
3432 port_cfg
.type
= type
;
3433 sci_ports
[0].cfg
= &port_cfg
;
3434 sci_ports
[0].params
= sci_probe_regmap(&port_cfg
);
3435 port_cfg
.scscr
= sci_serial_in(&sci_ports
[0].port
, SCSCR
);
3436 sci_serial_out(&sci_ports
[0].port
, SCSCR
,
3437 SCSCR_RE
| SCSCR_TE
| port_cfg
.scscr
);
3439 device
->con
->write
= serial_console_write
;
3442 static int __init
sci_early_console_setup(struct earlycon_device
*device
,
3445 return early_console_setup(device
, PORT_SCI
);
3447 static int __init
scif_early_console_setup(struct earlycon_device
*device
,
3450 return early_console_setup(device
, PORT_SCIF
);
3452 static int __init
scifa_early_console_setup(struct earlycon_device
*device
,
3455 return early_console_setup(device
, PORT_SCIFA
);
3457 static int __init
scifb_early_console_setup(struct earlycon_device
*device
,
3460 return early_console_setup(device
, PORT_SCIFB
);
3462 static int __init
hscif_early_console_setup(struct earlycon_device
*device
,
3465 return early_console_setup(device
, PORT_HSCIF
);
3468 OF_EARLYCON_DECLARE(sci
, "renesas,sci", sci_early_console_setup
);
3469 OF_EARLYCON_DECLARE(scif
, "renesas,scif", scif_early_console_setup
);
3470 OF_EARLYCON_DECLARE(scifa
, "renesas,scifa", scifa_early_console_setup
);
3471 OF_EARLYCON_DECLARE(scifb
, "renesas,scifb", scifb_early_console_setup
);
3472 OF_EARLYCON_DECLARE(hscif
, "renesas,hscif", hscif_early_console_setup
);
3473 #endif /* CONFIG_SERIAL_SH_SCI_EARLYCON */
3475 module_init(sci_init
);
3476 module_exit(sci_exit
);
3478 MODULE_LICENSE("GPL");
3479 MODULE_ALIAS("platform:sh-sci");
3480 MODULE_AUTHOR("Paul Mundt");
3481 MODULE_DESCRIPTION("SuperH (H)SCI(F) serial driver");