xref: /OK3568_Linux_fs/u-boot/drivers/serial/serial_ar933x.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (C) 2015-2016 Wills Wang <wills.wang@live.com>
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * SPDX-License-Identifier: GPL-2.0+
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <common.h>
8*4882a593Smuzhiyun #include <dm.h>
9*4882a593Smuzhiyun #include <div64.h>
10*4882a593Smuzhiyun #include <errno.h>
11*4882a593Smuzhiyun #include <serial.h>
12*4882a593Smuzhiyun #include <asm/io.h>
13*4882a593Smuzhiyun #include <asm/addrspace.h>
14*4882a593Smuzhiyun #include <asm/types.h>
15*4882a593Smuzhiyun #include <dm/pinctrl.h>
16*4882a593Smuzhiyun #include <mach/ar71xx_regs.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #define AR933X_UART_DATA_REG            0x00
19*4882a593Smuzhiyun #define AR933X_UART_CS_REG              0x04
20*4882a593Smuzhiyun #define AR933X_UART_CLK_REG             0x08
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #define AR933X_UART_DATA_TX_RX_MASK     0xff
23*4882a593Smuzhiyun #define AR933X_UART_DATA_RX_CSR         BIT(8)
24*4882a593Smuzhiyun #define AR933X_UART_DATA_TX_CSR         BIT(9)
25*4882a593Smuzhiyun #define AR933X_UART_CS_IF_MODE_S        2
26*4882a593Smuzhiyun #define AR933X_UART_CS_IF_MODE_M        0x3
27*4882a593Smuzhiyun #define AR933X_UART_CS_IF_MODE_DTE      1
28*4882a593Smuzhiyun #define AR933X_UART_CS_IF_MODE_DCE      2
29*4882a593Smuzhiyun #define AR933X_UART_CS_TX_RDY_ORIDE     BIT(7)
30*4882a593Smuzhiyun #define AR933X_UART_CS_RX_RDY_ORIDE     BIT(8)
31*4882a593Smuzhiyun #define AR933X_UART_CLK_STEP_M          0xffff
32*4882a593Smuzhiyun #define AR933X_UART_CLK_SCALE_M         0xfff
33*4882a593Smuzhiyun #define AR933X_UART_CLK_SCALE_S         16
34*4882a593Smuzhiyun #define AR933X_UART_CLK_STEP_S          0
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun struct ar933x_serial_priv {
37*4882a593Smuzhiyun 	void __iomem *regs;
38*4882a593Smuzhiyun };
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun /*
41*4882a593Smuzhiyun  * Baudrate algorithm come from Linux/drivers/tty/serial/ar933x_uart.c
42*4882a593Smuzhiyun  * baudrate = (clk / (scale + 1)) * (step * (1 / 2^17))
43*4882a593Smuzhiyun  */
ar933x_serial_get_baud(u32 clk,u32 scale,u32 step)44*4882a593Smuzhiyun static u32 ar933x_serial_get_baud(u32 clk, u32 scale, u32 step)
45*4882a593Smuzhiyun {
46*4882a593Smuzhiyun 	u64 t;
47*4882a593Smuzhiyun 	u32 div;
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	div = (2 << 16) * (scale + 1);
50*4882a593Smuzhiyun 	t = clk;
51*4882a593Smuzhiyun 	t *= step;
52*4882a593Smuzhiyun 	t += (div / 2);
53*4882a593Smuzhiyun 	do_div(t, div);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	return t;
56*4882a593Smuzhiyun }
57*4882a593Smuzhiyun 
ar933x_serial_get_scale_step(u32 clk,u32 baud,u32 * scale,u32 * step)58*4882a593Smuzhiyun static void ar933x_serial_get_scale_step(u32 clk, u32 baud,
59*4882a593Smuzhiyun 					 u32 *scale, u32 *step)
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun 	u32 tscale, baudrate;
62*4882a593Smuzhiyun 	long min_diff;
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	*scale = 0;
65*4882a593Smuzhiyun 	*step = 0;
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun 	min_diff = baud;
68*4882a593Smuzhiyun 	for (tscale = 0; tscale < AR933X_UART_CLK_SCALE_M; tscale++) {
69*4882a593Smuzhiyun 		u64 tstep;
70*4882a593Smuzhiyun 		int diff;
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun 		tstep = baud * (tscale + 1);
73*4882a593Smuzhiyun 		tstep *= (2 << 16);
74*4882a593Smuzhiyun 		do_div(tstep, clk);
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 		if (tstep > AR933X_UART_CLK_STEP_M)
77*4882a593Smuzhiyun 			break;
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun 		baudrate = ar933x_serial_get_baud(clk, tscale, tstep);
80*4882a593Smuzhiyun 		diff = abs(baudrate - baud);
81*4882a593Smuzhiyun 		if (diff < min_diff) {
82*4882a593Smuzhiyun 			min_diff = diff;
83*4882a593Smuzhiyun 			*scale = tscale;
84*4882a593Smuzhiyun 			*step = tstep;
85*4882a593Smuzhiyun 		}
86*4882a593Smuzhiyun 	}
87*4882a593Smuzhiyun }
88*4882a593Smuzhiyun 
ar933x_serial_setbrg(struct udevice * dev,int baudrate)89*4882a593Smuzhiyun static int ar933x_serial_setbrg(struct udevice *dev, int baudrate)
90*4882a593Smuzhiyun {
91*4882a593Smuzhiyun 	struct ar933x_serial_priv *priv = dev_get_priv(dev);
92*4882a593Smuzhiyun 	u32 val, scale, step;
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	val = get_serial_clock();
95*4882a593Smuzhiyun 	ar933x_serial_get_scale_step(val, baudrate, &scale, &step);
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun 	val  = (scale & AR933X_UART_CLK_SCALE_M)
98*4882a593Smuzhiyun 			<< AR933X_UART_CLK_SCALE_S;
99*4882a593Smuzhiyun 	val |= (step & AR933X_UART_CLK_STEP_M)
100*4882a593Smuzhiyun 			<< AR933X_UART_CLK_STEP_S;
101*4882a593Smuzhiyun 	writel(val, priv->regs + AR933X_UART_CLK_REG);
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun 	return 0;
104*4882a593Smuzhiyun }
105*4882a593Smuzhiyun 
ar933x_serial_putc(struct udevice * dev,const char c)106*4882a593Smuzhiyun static int ar933x_serial_putc(struct udevice *dev, const char c)
107*4882a593Smuzhiyun {
108*4882a593Smuzhiyun 	struct ar933x_serial_priv *priv = dev_get_priv(dev);
109*4882a593Smuzhiyun 	u32 data;
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun 	data = readl(priv->regs + AR933X_UART_DATA_REG);
112*4882a593Smuzhiyun 	if (!(data & AR933X_UART_DATA_TX_CSR))
113*4882a593Smuzhiyun 		return -EAGAIN;
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	data  = (u32)c | AR933X_UART_DATA_TX_CSR;
116*4882a593Smuzhiyun 	writel(data, priv->regs + AR933X_UART_DATA_REG);
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun 	return 0;
119*4882a593Smuzhiyun }
120*4882a593Smuzhiyun 
ar933x_serial_getc(struct udevice * dev)121*4882a593Smuzhiyun static int ar933x_serial_getc(struct udevice *dev)
122*4882a593Smuzhiyun {
123*4882a593Smuzhiyun 	struct ar933x_serial_priv *priv = dev_get_priv(dev);
124*4882a593Smuzhiyun 	u32 data;
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun 	data = readl(priv->regs + AR933X_UART_DATA_REG);
127*4882a593Smuzhiyun 	if (!(data & AR933X_UART_DATA_RX_CSR))
128*4882a593Smuzhiyun 		return -EAGAIN;
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	writel(AR933X_UART_DATA_RX_CSR, priv->regs + AR933X_UART_DATA_REG);
131*4882a593Smuzhiyun 	return data & AR933X_UART_DATA_TX_RX_MASK;
132*4882a593Smuzhiyun }
133*4882a593Smuzhiyun 
ar933x_serial_pending(struct udevice * dev,bool input)134*4882a593Smuzhiyun static int ar933x_serial_pending(struct udevice *dev, bool input)
135*4882a593Smuzhiyun {
136*4882a593Smuzhiyun 	struct ar933x_serial_priv *priv = dev_get_priv(dev);
137*4882a593Smuzhiyun 	u32 data;
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun 	data = readl(priv->regs + AR933X_UART_DATA_REG);
140*4882a593Smuzhiyun 	if (input)
141*4882a593Smuzhiyun 		return (data & AR933X_UART_DATA_RX_CSR) ? 1 : 0;
142*4882a593Smuzhiyun 	else
143*4882a593Smuzhiyun 		return (data & AR933X_UART_DATA_TX_CSR) ? 0 : 1;
144*4882a593Smuzhiyun }
145*4882a593Smuzhiyun 
ar933x_serial_probe(struct udevice * dev)146*4882a593Smuzhiyun static int ar933x_serial_probe(struct udevice *dev)
147*4882a593Smuzhiyun {
148*4882a593Smuzhiyun 	struct ar933x_serial_priv *priv = dev_get_priv(dev);
149*4882a593Smuzhiyun 	fdt_addr_t addr;
150*4882a593Smuzhiyun 	u32 val;
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	addr = devfdt_get_addr(dev);
153*4882a593Smuzhiyun 	if (addr == FDT_ADDR_T_NONE)
154*4882a593Smuzhiyun 		return -EINVAL;
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun 	priv->regs = map_physmem(addr, AR933X_UART_SIZE,
157*4882a593Smuzhiyun 				 MAP_NOCACHE);
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun 	/*
160*4882a593Smuzhiyun 	 * UART controller configuration:
161*4882a593Smuzhiyun 	 * - no DMA
162*4882a593Smuzhiyun 	 * - no interrupt
163*4882a593Smuzhiyun 	 * - DCE mode
164*4882a593Smuzhiyun 	 * - no flow control
165*4882a593Smuzhiyun 	 * - set RX ready oride
166*4882a593Smuzhiyun 	 * - set TX ready oride
167*4882a593Smuzhiyun 	 */
168*4882a593Smuzhiyun 	val = (AR933X_UART_CS_IF_MODE_DCE << AR933X_UART_CS_IF_MODE_S) |
169*4882a593Smuzhiyun 	      AR933X_UART_CS_TX_RDY_ORIDE | AR933X_UART_CS_RX_RDY_ORIDE;
170*4882a593Smuzhiyun 	writel(val, priv->regs + AR933X_UART_CS_REG);
171*4882a593Smuzhiyun 	return 0;
172*4882a593Smuzhiyun }
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun static const struct dm_serial_ops ar933x_serial_ops = {
175*4882a593Smuzhiyun 	.putc = ar933x_serial_putc,
176*4882a593Smuzhiyun 	.pending = ar933x_serial_pending,
177*4882a593Smuzhiyun 	.getc = ar933x_serial_getc,
178*4882a593Smuzhiyun 	.setbrg = ar933x_serial_setbrg,
179*4882a593Smuzhiyun };
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun static const struct udevice_id ar933x_serial_ids[] = {
182*4882a593Smuzhiyun 	{ .compatible = "qca,ar9330-uart" },
183*4882a593Smuzhiyun 	{ }
184*4882a593Smuzhiyun };
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun U_BOOT_DRIVER(serial_ar933x) = {
187*4882a593Smuzhiyun 	.name   = "serial_ar933x",
188*4882a593Smuzhiyun 	.id = UCLASS_SERIAL,
189*4882a593Smuzhiyun 	.of_match = ar933x_serial_ids,
190*4882a593Smuzhiyun 	.priv_auto_alloc_size = sizeof(struct ar933x_serial_priv),
191*4882a593Smuzhiyun 	.probe = ar933x_serial_probe,
192*4882a593Smuzhiyun 	.ops    = &ar933x_serial_ops,
193*4882a593Smuzhiyun 	.flags = DM_FLAG_PRE_RELOC,
194*4882a593Smuzhiyun };
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun #ifdef CONFIG_DEBUG_UART_AR933X
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun #include <debug_uart.h>
199*4882a593Smuzhiyun 
_debug_uart_init(void)200*4882a593Smuzhiyun static inline void _debug_uart_init(void)
201*4882a593Smuzhiyun {
202*4882a593Smuzhiyun 	void __iomem *regs = (void *)CONFIG_DEBUG_UART_BASE;
203*4882a593Smuzhiyun 	u32 val, scale, step;
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun 	/*
206*4882a593Smuzhiyun 	 * UART controller configuration:
207*4882a593Smuzhiyun 	 * - no DMA
208*4882a593Smuzhiyun 	 * - no interrupt
209*4882a593Smuzhiyun 	 * - DCE mode
210*4882a593Smuzhiyun 	 * - no flow control
211*4882a593Smuzhiyun 	 * - set RX ready oride
212*4882a593Smuzhiyun 	 * - set TX ready oride
213*4882a593Smuzhiyun 	 */
214*4882a593Smuzhiyun 	val = (AR933X_UART_CS_IF_MODE_DCE << AR933X_UART_CS_IF_MODE_S) |
215*4882a593Smuzhiyun 	      AR933X_UART_CS_TX_RDY_ORIDE | AR933X_UART_CS_RX_RDY_ORIDE;
216*4882a593Smuzhiyun 	writel(val, regs + AR933X_UART_CS_REG);
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun 	ar933x_serial_get_scale_step(CONFIG_DEBUG_UART_CLOCK,
219*4882a593Smuzhiyun 				     CONFIG_BAUDRATE, &scale, &step);
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun 	val  = (scale & AR933X_UART_CLK_SCALE_M)
222*4882a593Smuzhiyun 			<< AR933X_UART_CLK_SCALE_S;
223*4882a593Smuzhiyun 	val |= (step & AR933X_UART_CLK_STEP_M)
224*4882a593Smuzhiyun 			<< AR933X_UART_CLK_STEP_S;
225*4882a593Smuzhiyun 	writel(val, regs + AR933X_UART_CLK_REG);
226*4882a593Smuzhiyun }
227*4882a593Smuzhiyun 
_debug_uart_putc(int c)228*4882a593Smuzhiyun static inline void _debug_uart_putc(int c)
229*4882a593Smuzhiyun {
230*4882a593Smuzhiyun 	void __iomem *regs = (void *)CONFIG_DEBUG_UART_BASE;
231*4882a593Smuzhiyun 	u32 data;
232*4882a593Smuzhiyun 
233*4882a593Smuzhiyun 	do {
234*4882a593Smuzhiyun 		data = readl(regs + AR933X_UART_DATA_REG);
235*4882a593Smuzhiyun 	} while (!(data & AR933X_UART_DATA_TX_CSR));
236*4882a593Smuzhiyun 
237*4882a593Smuzhiyun 	data  = (u32)c | AR933X_UART_DATA_TX_CSR;
238*4882a593Smuzhiyun 	writel(data, regs + AR933X_UART_DATA_REG);
239*4882a593Smuzhiyun }
240*4882a593Smuzhiyun 
241*4882a593Smuzhiyun DEBUG_UART_FUNCS
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun #endif
244