1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * SuperH SCIF device driver.
3*4882a593Smuzhiyun * Copyright (C) 2013 Renesas Electronics Corporation
4*4882a593Smuzhiyun * Copyright (C) 2007,2008,2010, 2014 Nobuhiro Iwamatsu
5*4882a593Smuzhiyun * Copyright (C) 2002 - 2008 Paul Mundt
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * SPDX-License-Identifier: GPL-2.0+
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <common.h>
11*4882a593Smuzhiyun #include <errno.h>
12*4882a593Smuzhiyun #include <clk.h>
13*4882a593Smuzhiyun #include <dm.h>
14*4882a593Smuzhiyun #include <asm/io.h>
15*4882a593Smuzhiyun #include <asm/processor.h>
16*4882a593Smuzhiyun #include <serial.h>
17*4882a593Smuzhiyun #include <linux/compiler.h>
18*4882a593Smuzhiyun #include <dm/platform_data/serial_sh.h>
19*4882a593Smuzhiyun #include "serial_sh.h"
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun DECLARE_GLOBAL_DATA_PTR;
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun #if defined(CONFIG_CPU_SH7760) || \
24*4882a593Smuzhiyun defined(CONFIG_CPU_SH7780) || \
25*4882a593Smuzhiyun defined(CONFIG_CPU_SH7785) || \
26*4882a593Smuzhiyun defined(CONFIG_CPU_SH7786)
scif_rxfill(struct uart_port * port)27*4882a593Smuzhiyun static int scif_rxfill(struct uart_port *port)
28*4882a593Smuzhiyun {
29*4882a593Smuzhiyun return sci_in(port, SCRFDR) & 0xff;
30*4882a593Smuzhiyun }
31*4882a593Smuzhiyun #elif defined(CONFIG_CPU_SH7763)
scif_rxfill(struct uart_port * port)32*4882a593Smuzhiyun static int scif_rxfill(struct uart_port *port)
33*4882a593Smuzhiyun {
34*4882a593Smuzhiyun if ((port->mapbase == 0xffe00000) ||
35*4882a593Smuzhiyun (port->mapbase == 0xffe08000)) {
36*4882a593Smuzhiyun /* SCIF0/1*/
37*4882a593Smuzhiyun return sci_in(port, SCRFDR) & 0xff;
38*4882a593Smuzhiyun } else {
39*4882a593Smuzhiyun /* SCIF2 */
40*4882a593Smuzhiyun return sci_in(port, SCFDR) & SCIF2_RFDC_MASK;
41*4882a593Smuzhiyun }
42*4882a593Smuzhiyun }
43*4882a593Smuzhiyun #elif defined(CONFIG_ARCH_SH7372)
scif_rxfill(struct uart_port * port)44*4882a593Smuzhiyun static int scif_rxfill(struct uart_port *port)
45*4882a593Smuzhiyun {
46*4882a593Smuzhiyun if (port->type == PORT_SCIFA)
47*4882a593Smuzhiyun return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
48*4882a593Smuzhiyun else
49*4882a593Smuzhiyun return sci_in(port, SCRFDR);
50*4882a593Smuzhiyun }
51*4882a593Smuzhiyun #else
scif_rxfill(struct uart_port * port)52*4882a593Smuzhiyun static int scif_rxfill(struct uart_port *port)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
55*4882a593Smuzhiyun }
56*4882a593Smuzhiyun #endif
57*4882a593Smuzhiyun
sh_serial_init_generic(struct uart_port * port)58*4882a593Smuzhiyun static void sh_serial_init_generic(struct uart_port *port)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun sci_out(port, SCSCR , SCSCR_INIT(port));
61*4882a593Smuzhiyun sci_out(port, SCSCR , SCSCR_INIT(port));
62*4882a593Smuzhiyun sci_out(port, SCSMR, 0);
63*4882a593Smuzhiyun sci_out(port, SCSMR, 0);
64*4882a593Smuzhiyun sci_out(port, SCFCR, SCFCR_RFRST|SCFCR_TFRST);
65*4882a593Smuzhiyun sci_in(port, SCFCR);
66*4882a593Smuzhiyun sci_out(port, SCFCR, 0);
67*4882a593Smuzhiyun }
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun static void
sh_serial_setbrg_generic(struct uart_port * port,int clk,int baudrate)70*4882a593Smuzhiyun sh_serial_setbrg_generic(struct uart_port *port, int clk, int baudrate)
71*4882a593Smuzhiyun {
72*4882a593Smuzhiyun if (port->clk_mode == EXT_CLK) {
73*4882a593Smuzhiyun unsigned short dl = DL_VALUE(baudrate, clk);
74*4882a593Smuzhiyun sci_out(port, DL, dl);
75*4882a593Smuzhiyun /* Need wait: Clock * 1/dl * 1/16 */
76*4882a593Smuzhiyun udelay((1000000 * dl * 16 / clk) * 1000 + 1);
77*4882a593Smuzhiyun } else {
78*4882a593Smuzhiyun sci_out(port, SCBRR, SCBRR_VALUE(baudrate, clk));
79*4882a593Smuzhiyun }
80*4882a593Smuzhiyun }
81*4882a593Smuzhiyun
handle_error(struct uart_port * port)82*4882a593Smuzhiyun static void handle_error(struct uart_port *port)
83*4882a593Smuzhiyun {
84*4882a593Smuzhiyun sci_in(port, SCxSR);
85*4882a593Smuzhiyun sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
86*4882a593Smuzhiyun sci_in(port, SCLSR);
87*4882a593Smuzhiyun sci_out(port, SCLSR, 0x00);
88*4882a593Smuzhiyun }
89*4882a593Smuzhiyun
serial_raw_putc(struct uart_port * port,const char c)90*4882a593Smuzhiyun static int serial_raw_putc(struct uart_port *port, const char c)
91*4882a593Smuzhiyun {
92*4882a593Smuzhiyun /* Tx fifo is empty */
93*4882a593Smuzhiyun if (!(sci_in(port, SCxSR) & SCxSR_TEND(port)))
94*4882a593Smuzhiyun return -EAGAIN;
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun sci_out(port, SCxTDR, c);
97*4882a593Smuzhiyun sci_out(port, SCxSR, sci_in(port, SCxSR) & ~SCxSR_TEND(port));
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun return 0;
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun
serial_rx_fifo_level(struct uart_port * port)102*4882a593Smuzhiyun static int serial_rx_fifo_level(struct uart_port *port)
103*4882a593Smuzhiyun {
104*4882a593Smuzhiyun return scif_rxfill(port);
105*4882a593Smuzhiyun }
106*4882a593Smuzhiyun
sh_serial_tstc_generic(struct uart_port * port)107*4882a593Smuzhiyun static int sh_serial_tstc_generic(struct uart_port *port)
108*4882a593Smuzhiyun {
109*4882a593Smuzhiyun if (sci_in(port, SCxSR) & SCIF_ERRORS) {
110*4882a593Smuzhiyun handle_error(port);
111*4882a593Smuzhiyun return 0;
112*4882a593Smuzhiyun }
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun return serial_rx_fifo_level(port) ? 1 : 0;
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun
serial_getc_check(struct uart_port * port)117*4882a593Smuzhiyun static int serial_getc_check(struct uart_port *port)
118*4882a593Smuzhiyun {
119*4882a593Smuzhiyun unsigned short status;
120*4882a593Smuzhiyun
121*4882a593Smuzhiyun status = sci_in(port, SCxSR);
122*4882a593Smuzhiyun
123*4882a593Smuzhiyun if (status & SCIF_ERRORS)
124*4882a593Smuzhiyun handle_error(port);
125*4882a593Smuzhiyun if (sci_in(port, SCLSR) & SCxSR_ORER(port))
126*4882a593Smuzhiyun handle_error(port);
127*4882a593Smuzhiyun return status & (SCIF_DR | SCxSR_RDxF(port));
128*4882a593Smuzhiyun }
129*4882a593Smuzhiyun
sh_serial_getc_generic(struct uart_port * port)130*4882a593Smuzhiyun static int sh_serial_getc_generic(struct uart_port *port)
131*4882a593Smuzhiyun {
132*4882a593Smuzhiyun unsigned short status;
133*4882a593Smuzhiyun char ch;
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun if (!serial_getc_check(port))
136*4882a593Smuzhiyun return -EAGAIN;
137*4882a593Smuzhiyun
138*4882a593Smuzhiyun ch = sci_in(port, SCxRDR);
139*4882a593Smuzhiyun status = sci_in(port, SCxSR);
140*4882a593Smuzhiyun
141*4882a593Smuzhiyun sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
142*4882a593Smuzhiyun
143*4882a593Smuzhiyun if (status & SCIF_ERRORS)
144*4882a593Smuzhiyun handle_error(port);
145*4882a593Smuzhiyun
146*4882a593Smuzhiyun if (sci_in(port, SCLSR) & SCxSR_ORER(port))
147*4882a593Smuzhiyun handle_error(port);
148*4882a593Smuzhiyun
149*4882a593Smuzhiyun return ch;
150*4882a593Smuzhiyun }
151*4882a593Smuzhiyun
152*4882a593Smuzhiyun #ifdef CONFIG_DM_SERIAL
153*4882a593Smuzhiyun
sh_serial_pending(struct udevice * dev,bool input)154*4882a593Smuzhiyun static int sh_serial_pending(struct udevice *dev, bool input)
155*4882a593Smuzhiyun {
156*4882a593Smuzhiyun struct uart_port *priv = dev_get_priv(dev);
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun return sh_serial_tstc_generic(priv);
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun
sh_serial_putc(struct udevice * dev,const char ch)161*4882a593Smuzhiyun static int sh_serial_putc(struct udevice *dev, const char ch)
162*4882a593Smuzhiyun {
163*4882a593Smuzhiyun struct uart_port *priv = dev_get_priv(dev);
164*4882a593Smuzhiyun
165*4882a593Smuzhiyun return serial_raw_putc(priv, ch);
166*4882a593Smuzhiyun }
167*4882a593Smuzhiyun
sh_serial_getc(struct udevice * dev)168*4882a593Smuzhiyun static int sh_serial_getc(struct udevice *dev)
169*4882a593Smuzhiyun {
170*4882a593Smuzhiyun struct uart_port *priv = dev_get_priv(dev);
171*4882a593Smuzhiyun
172*4882a593Smuzhiyun return sh_serial_getc_generic(priv);
173*4882a593Smuzhiyun }
174*4882a593Smuzhiyun
sh_serial_setbrg(struct udevice * dev,int baudrate)175*4882a593Smuzhiyun static int sh_serial_setbrg(struct udevice *dev, int baudrate)
176*4882a593Smuzhiyun {
177*4882a593Smuzhiyun struct sh_serial_platdata *plat = dev_get_platdata(dev);
178*4882a593Smuzhiyun struct uart_port *priv = dev_get_priv(dev);
179*4882a593Smuzhiyun
180*4882a593Smuzhiyun sh_serial_setbrg_generic(priv, plat->clk, baudrate);
181*4882a593Smuzhiyun
182*4882a593Smuzhiyun return 0;
183*4882a593Smuzhiyun }
184*4882a593Smuzhiyun
sh_serial_probe(struct udevice * dev)185*4882a593Smuzhiyun static int sh_serial_probe(struct udevice *dev)
186*4882a593Smuzhiyun {
187*4882a593Smuzhiyun struct sh_serial_platdata *plat = dev_get_platdata(dev);
188*4882a593Smuzhiyun struct uart_port *priv = dev_get_priv(dev);
189*4882a593Smuzhiyun
190*4882a593Smuzhiyun priv->membase = (unsigned char *)plat->base;
191*4882a593Smuzhiyun priv->mapbase = plat->base;
192*4882a593Smuzhiyun priv->type = plat->type;
193*4882a593Smuzhiyun priv->clk_mode = plat->clk_mode;
194*4882a593Smuzhiyun
195*4882a593Smuzhiyun sh_serial_init_generic(priv);
196*4882a593Smuzhiyun
197*4882a593Smuzhiyun return 0;
198*4882a593Smuzhiyun }
199*4882a593Smuzhiyun
200*4882a593Smuzhiyun static const struct dm_serial_ops sh_serial_ops = {
201*4882a593Smuzhiyun .putc = sh_serial_putc,
202*4882a593Smuzhiyun .pending = sh_serial_pending,
203*4882a593Smuzhiyun .getc = sh_serial_getc,
204*4882a593Smuzhiyun .setbrg = sh_serial_setbrg,
205*4882a593Smuzhiyun };
206*4882a593Smuzhiyun
207*4882a593Smuzhiyun #ifdef CONFIG_OF_CONTROL
208*4882a593Smuzhiyun static const struct udevice_id sh_serial_id[] ={
209*4882a593Smuzhiyun {.compatible = "renesas,sci", .data = PORT_SCI},
210*4882a593Smuzhiyun {.compatible = "renesas,scif", .data = PORT_SCIF},
211*4882a593Smuzhiyun {.compatible = "renesas,scifa", .data = PORT_SCIFA},
212*4882a593Smuzhiyun {}
213*4882a593Smuzhiyun };
214*4882a593Smuzhiyun
sh_serial_ofdata_to_platdata(struct udevice * dev)215*4882a593Smuzhiyun static int sh_serial_ofdata_to_platdata(struct udevice *dev)
216*4882a593Smuzhiyun {
217*4882a593Smuzhiyun struct sh_serial_platdata *plat = dev_get_platdata(dev);
218*4882a593Smuzhiyun struct clk sh_serial_clk;
219*4882a593Smuzhiyun fdt_addr_t addr;
220*4882a593Smuzhiyun int ret;
221*4882a593Smuzhiyun
222*4882a593Smuzhiyun addr = fdtdec_get_addr(gd->fdt_blob, dev_of_offset(dev), "reg");
223*4882a593Smuzhiyun if (addr == FDT_ADDR_T_NONE)
224*4882a593Smuzhiyun return -EINVAL;
225*4882a593Smuzhiyun
226*4882a593Smuzhiyun plat->base = addr;
227*4882a593Smuzhiyun
228*4882a593Smuzhiyun ret = clk_get_by_name(dev, "fck", &sh_serial_clk);
229*4882a593Smuzhiyun if (!ret)
230*4882a593Smuzhiyun plat->clk = clk_get_rate(&sh_serial_clk);
231*4882a593Smuzhiyun else
232*4882a593Smuzhiyun plat->clk = fdtdec_get_int(gd->fdt_blob, dev_of_offset(dev),
233*4882a593Smuzhiyun "clock", 1);
234*4882a593Smuzhiyun
235*4882a593Smuzhiyun plat->type = dev_get_driver_data(dev);
236*4882a593Smuzhiyun return 0;
237*4882a593Smuzhiyun }
238*4882a593Smuzhiyun #endif
239*4882a593Smuzhiyun
240*4882a593Smuzhiyun U_BOOT_DRIVER(serial_sh) = {
241*4882a593Smuzhiyun .name = "serial_sh",
242*4882a593Smuzhiyun .id = UCLASS_SERIAL,
243*4882a593Smuzhiyun .of_match = of_match_ptr(sh_serial_id),
244*4882a593Smuzhiyun .ofdata_to_platdata = of_match_ptr(sh_serial_ofdata_to_platdata),
245*4882a593Smuzhiyun .platdata_auto_alloc_size = sizeof(struct sh_serial_platdata),
246*4882a593Smuzhiyun .probe = sh_serial_probe,
247*4882a593Smuzhiyun .ops = &sh_serial_ops,
248*4882a593Smuzhiyun .flags = DM_FLAG_PRE_RELOC,
249*4882a593Smuzhiyun .priv_auto_alloc_size = sizeof(struct uart_port),
250*4882a593Smuzhiyun };
251*4882a593Smuzhiyun
252*4882a593Smuzhiyun #else /* CONFIG_DM_SERIAL */
253*4882a593Smuzhiyun
254*4882a593Smuzhiyun #if defined(CONFIG_CONS_SCIF0)
255*4882a593Smuzhiyun # define SCIF_BASE SCIF0_BASE
256*4882a593Smuzhiyun #elif defined(CONFIG_CONS_SCIF1)
257*4882a593Smuzhiyun # define SCIF_BASE SCIF1_BASE
258*4882a593Smuzhiyun #elif defined(CONFIG_CONS_SCIF2)
259*4882a593Smuzhiyun # define SCIF_BASE SCIF2_BASE
260*4882a593Smuzhiyun #elif defined(CONFIG_CONS_SCIF3)
261*4882a593Smuzhiyun # define SCIF_BASE SCIF3_BASE
262*4882a593Smuzhiyun #elif defined(CONFIG_CONS_SCIF4)
263*4882a593Smuzhiyun # define SCIF_BASE SCIF4_BASE
264*4882a593Smuzhiyun #elif defined(CONFIG_CONS_SCIF5)
265*4882a593Smuzhiyun # define SCIF_BASE SCIF5_BASE
266*4882a593Smuzhiyun #elif defined(CONFIG_CONS_SCIF6)
267*4882a593Smuzhiyun # define SCIF_BASE SCIF6_BASE
268*4882a593Smuzhiyun #elif defined(CONFIG_CONS_SCIF7)
269*4882a593Smuzhiyun # define SCIF_BASE SCIF7_BASE
270*4882a593Smuzhiyun #else
271*4882a593Smuzhiyun # error "Default SCIF doesn't set....."
272*4882a593Smuzhiyun #endif
273*4882a593Smuzhiyun
274*4882a593Smuzhiyun #if defined(CONFIG_SCIF_A)
275*4882a593Smuzhiyun #define SCIF_BASE_PORT PORT_SCIFA
276*4882a593Smuzhiyun #elif defined(CONFIG_SCI)
277*4882a593Smuzhiyun #define SCIF_BASE_PORT PORT_SCI
278*4882a593Smuzhiyun #else
279*4882a593Smuzhiyun #define SCIF_BASE_PORT PORT_SCIF
280*4882a593Smuzhiyun #endif
281*4882a593Smuzhiyun
282*4882a593Smuzhiyun static struct uart_port sh_sci = {
283*4882a593Smuzhiyun .membase = (unsigned char *)SCIF_BASE,
284*4882a593Smuzhiyun .mapbase = SCIF_BASE,
285*4882a593Smuzhiyun .type = SCIF_BASE_PORT,
286*4882a593Smuzhiyun #ifdef CONFIG_SCIF_USE_EXT_CLK
287*4882a593Smuzhiyun .clk_mode = EXT_CLK,
288*4882a593Smuzhiyun #endif
289*4882a593Smuzhiyun };
290*4882a593Smuzhiyun
sh_serial_setbrg(void)291*4882a593Smuzhiyun static void sh_serial_setbrg(void)
292*4882a593Smuzhiyun {
293*4882a593Smuzhiyun DECLARE_GLOBAL_DATA_PTR;
294*4882a593Smuzhiyun struct uart_port *port = &sh_sci;
295*4882a593Smuzhiyun
296*4882a593Smuzhiyun sh_serial_setbrg_generic(port, CONFIG_SH_SCIF_CLK_FREQ, gd->baudrate);
297*4882a593Smuzhiyun }
298*4882a593Smuzhiyun
sh_serial_init(void)299*4882a593Smuzhiyun static int sh_serial_init(void)
300*4882a593Smuzhiyun {
301*4882a593Smuzhiyun struct uart_port *port = &sh_sci;
302*4882a593Smuzhiyun
303*4882a593Smuzhiyun sh_serial_init_generic(port);
304*4882a593Smuzhiyun serial_setbrg();
305*4882a593Smuzhiyun
306*4882a593Smuzhiyun return 0;
307*4882a593Smuzhiyun }
308*4882a593Smuzhiyun
sh_serial_putc(const char c)309*4882a593Smuzhiyun static void sh_serial_putc(const char c)
310*4882a593Smuzhiyun {
311*4882a593Smuzhiyun struct uart_port *port = &sh_sci;
312*4882a593Smuzhiyun
313*4882a593Smuzhiyun if (c == '\n') {
314*4882a593Smuzhiyun while (1) {
315*4882a593Smuzhiyun if (serial_raw_putc(port, '\r') != -EAGAIN)
316*4882a593Smuzhiyun break;
317*4882a593Smuzhiyun }
318*4882a593Smuzhiyun }
319*4882a593Smuzhiyun while (1) {
320*4882a593Smuzhiyun if (serial_raw_putc(port, c) != -EAGAIN)
321*4882a593Smuzhiyun break;
322*4882a593Smuzhiyun }
323*4882a593Smuzhiyun }
324*4882a593Smuzhiyun
sh_serial_tstc(void)325*4882a593Smuzhiyun static int sh_serial_tstc(void)
326*4882a593Smuzhiyun {
327*4882a593Smuzhiyun struct uart_port *port = &sh_sci;
328*4882a593Smuzhiyun
329*4882a593Smuzhiyun return sh_serial_tstc_generic(port);
330*4882a593Smuzhiyun }
331*4882a593Smuzhiyun
sh_serial_getc(void)332*4882a593Smuzhiyun static int sh_serial_getc(void)
333*4882a593Smuzhiyun {
334*4882a593Smuzhiyun struct uart_port *port = &sh_sci;
335*4882a593Smuzhiyun int ch;
336*4882a593Smuzhiyun
337*4882a593Smuzhiyun while (1) {
338*4882a593Smuzhiyun ch = sh_serial_getc_generic(port);
339*4882a593Smuzhiyun if (ch != -EAGAIN)
340*4882a593Smuzhiyun break;
341*4882a593Smuzhiyun }
342*4882a593Smuzhiyun
343*4882a593Smuzhiyun return ch;
344*4882a593Smuzhiyun }
345*4882a593Smuzhiyun
346*4882a593Smuzhiyun static struct serial_device sh_serial_drv = {
347*4882a593Smuzhiyun .name = "sh_serial",
348*4882a593Smuzhiyun .start = sh_serial_init,
349*4882a593Smuzhiyun .stop = NULL,
350*4882a593Smuzhiyun .setbrg = sh_serial_setbrg,
351*4882a593Smuzhiyun .putc = sh_serial_putc,
352*4882a593Smuzhiyun .puts = default_serial_puts,
353*4882a593Smuzhiyun .getc = sh_serial_getc,
354*4882a593Smuzhiyun .tstc = sh_serial_tstc,
355*4882a593Smuzhiyun };
356*4882a593Smuzhiyun
sh_serial_initialize(void)357*4882a593Smuzhiyun void sh_serial_initialize(void)
358*4882a593Smuzhiyun {
359*4882a593Smuzhiyun serial_register(&sh_serial_drv);
360*4882a593Smuzhiyun }
361*4882a593Smuzhiyun
default_serial_console(void)362*4882a593Smuzhiyun __weak struct serial_device *default_serial_console(void)
363*4882a593Smuzhiyun {
364*4882a593Smuzhiyun return &sh_serial_drv;
365*4882a593Smuzhiyun }
366*4882a593Smuzhiyun #endif /* CONFIG_DM_SERIAL */
367