xref: /OK3568_Linux_fs/u-boot/drivers/serial/atmel_usart.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (C) 2004-2006 Atmel Corporation
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Modified to support C structur SoC access by
5*4882a593Smuzhiyun  * Andreas Bießmann <biessmann@corscience.de>
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun #include <common.h>
10*4882a593Smuzhiyun #include <clk.h>
11*4882a593Smuzhiyun #include <dm.h>
12*4882a593Smuzhiyun #include <errno.h>
13*4882a593Smuzhiyun #include <watchdog.h>
14*4882a593Smuzhiyun #include <serial.h>
15*4882a593Smuzhiyun #include <debug_uart.h>
16*4882a593Smuzhiyun #include <linux/compiler.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #include <asm/io.h>
19*4882a593Smuzhiyun #ifdef CONFIG_DM_SERIAL
20*4882a593Smuzhiyun #include <asm/arch/atmel_serial.h>
21*4882a593Smuzhiyun #endif
22*4882a593Smuzhiyun #include <asm/arch/clk.h>
23*4882a593Smuzhiyun #include <asm/arch/hardware.h>
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #include "atmel_usart.h"
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun DECLARE_GLOBAL_DATA_PTR;
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun #ifndef CONFIG_DM_SERIAL
atmel_serial_setbrg_internal(atmel_usart3_t * usart,int id,int baudrate)30*4882a593Smuzhiyun static void atmel_serial_setbrg_internal(atmel_usart3_t *usart, int id,
31*4882a593Smuzhiyun 					 int baudrate)
32*4882a593Smuzhiyun {
33*4882a593Smuzhiyun 	unsigned long divisor;
34*4882a593Smuzhiyun 	unsigned long usart_hz;
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun 	/*
37*4882a593Smuzhiyun 	 *              Master Clock
38*4882a593Smuzhiyun 	 * Baud Rate = --------------
39*4882a593Smuzhiyun 	 *                16 * CD
40*4882a593Smuzhiyun 	 */
41*4882a593Smuzhiyun 	usart_hz = get_usart_clk_rate(id);
42*4882a593Smuzhiyun 	divisor = (usart_hz / 16 + baudrate / 2) / baudrate;
43*4882a593Smuzhiyun 	writel(USART3_BF(CD, divisor), &usart->brgr);
44*4882a593Smuzhiyun }
45*4882a593Smuzhiyun 
atmel_serial_init_internal(atmel_usart3_t * usart)46*4882a593Smuzhiyun static void atmel_serial_init_internal(atmel_usart3_t *usart)
47*4882a593Smuzhiyun {
48*4882a593Smuzhiyun 	/*
49*4882a593Smuzhiyun 	 * Just in case: drain transmitter register
50*4882a593Smuzhiyun 	 * 1000us is enough for baudrate >= 9600
51*4882a593Smuzhiyun 	 */
52*4882a593Smuzhiyun 	if (!(readl(&usart->csr) & USART3_BIT(TXEMPTY)))
53*4882a593Smuzhiyun 		__udelay(1000);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	writel(USART3_BIT(RSTRX) | USART3_BIT(RSTTX), &usart->cr);
56*4882a593Smuzhiyun }
57*4882a593Smuzhiyun 
atmel_serial_activate(atmel_usart3_t * usart)58*4882a593Smuzhiyun static void atmel_serial_activate(atmel_usart3_t *usart)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	writel((USART3_BF(USART_MODE, USART3_USART_MODE_NORMAL)
61*4882a593Smuzhiyun 			   | USART3_BF(USCLKS, USART3_USCLKS_MCK)
62*4882a593Smuzhiyun 			   | USART3_BF(CHRL, USART3_CHRL_8)
63*4882a593Smuzhiyun 			   | USART3_BF(PAR, USART3_PAR_NONE)
64*4882a593Smuzhiyun 			   | USART3_BF(NBSTOP, USART3_NBSTOP_1)),
65*4882a593Smuzhiyun 			   &usart->mr);
66*4882a593Smuzhiyun 	writel(USART3_BIT(RXEN) | USART3_BIT(TXEN), &usart->cr);
67*4882a593Smuzhiyun 	/* 100us is enough for the new settings to be settled */
68*4882a593Smuzhiyun 	__udelay(100);
69*4882a593Smuzhiyun }
70*4882a593Smuzhiyun 
atmel_serial_setbrg(void)71*4882a593Smuzhiyun static void atmel_serial_setbrg(void)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun 	atmel_serial_setbrg_internal((atmel_usart3_t *)CONFIG_USART_BASE,
74*4882a593Smuzhiyun 				     CONFIG_USART_ID, gd->baudrate);
75*4882a593Smuzhiyun }
76*4882a593Smuzhiyun 
atmel_serial_init(void)77*4882a593Smuzhiyun static int atmel_serial_init(void)
78*4882a593Smuzhiyun {
79*4882a593Smuzhiyun 	atmel_usart3_t *usart = (atmel_usart3_t *)CONFIG_USART_BASE;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	atmel_serial_init_internal(usart);
82*4882a593Smuzhiyun 	serial_setbrg();
83*4882a593Smuzhiyun 	atmel_serial_activate(usart);
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun 	return 0;
86*4882a593Smuzhiyun }
87*4882a593Smuzhiyun 
atmel_serial_putc(char c)88*4882a593Smuzhiyun static void atmel_serial_putc(char c)
89*4882a593Smuzhiyun {
90*4882a593Smuzhiyun 	atmel_usart3_t *usart = (atmel_usart3_t *)CONFIG_USART_BASE;
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	if (c == '\n')
93*4882a593Smuzhiyun 		serial_putc('\r');
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun 	while (!(readl(&usart->csr) & USART3_BIT(TXRDY)));
96*4882a593Smuzhiyun 	writel(c, &usart->thr);
97*4882a593Smuzhiyun }
98*4882a593Smuzhiyun 
atmel_serial_getc(void)99*4882a593Smuzhiyun static int atmel_serial_getc(void)
100*4882a593Smuzhiyun {
101*4882a593Smuzhiyun 	atmel_usart3_t *usart = (atmel_usart3_t *)CONFIG_USART_BASE;
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun 	while (!(readl(&usart->csr) & USART3_BIT(RXRDY)))
104*4882a593Smuzhiyun 		 WATCHDOG_RESET();
105*4882a593Smuzhiyun 	return readl(&usart->rhr);
106*4882a593Smuzhiyun }
107*4882a593Smuzhiyun 
atmel_serial_tstc(void)108*4882a593Smuzhiyun static int atmel_serial_tstc(void)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun 	atmel_usart3_t *usart = (atmel_usart3_t *)CONFIG_USART_BASE;
111*4882a593Smuzhiyun 	return (readl(&usart->csr) & USART3_BIT(RXRDY)) != 0;
112*4882a593Smuzhiyun }
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun static struct serial_device atmel_serial_drv = {
115*4882a593Smuzhiyun 	.name	= "atmel_serial",
116*4882a593Smuzhiyun 	.start	= atmel_serial_init,
117*4882a593Smuzhiyun 	.stop	= NULL,
118*4882a593Smuzhiyun 	.setbrg	= atmel_serial_setbrg,
119*4882a593Smuzhiyun 	.putc	= atmel_serial_putc,
120*4882a593Smuzhiyun 	.puts	= default_serial_puts,
121*4882a593Smuzhiyun 	.getc	= atmel_serial_getc,
122*4882a593Smuzhiyun 	.tstc	= atmel_serial_tstc,
123*4882a593Smuzhiyun };
124*4882a593Smuzhiyun 
atmel_serial_initialize(void)125*4882a593Smuzhiyun void atmel_serial_initialize(void)
126*4882a593Smuzhiyun {
127*4882a593Smuzhiyun 	serial_register(&atmel_serial_drv);
128*4882a593Smuzhiyun }
129*4882a593Smuzhiyun 
default_serial_console(void)130*4882a593Smuzhiyun __weak struct serial_device *default_serial_console(void)
131*4882a593Smuzhiyun {
132*4882a593Smuzhiyun 	return &atmel_serial_drv;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun #endif
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun #ifdef CONFIG_DM_SERIAL
137*4882a593Smuzhiyun enum serial_clk_type {
138*4882a593Smuzhiyun 	CLK_TYPE_NORMAL = 0,
139*4882a593Smuzhiyun 	CLK_TYPE_DBGU,
140*4882a593Smuzhiyun };
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun struct atmel_serial_priv {
143*4882a593Smuzhiyun 	atmel_usart3_t *usart;
144*4882a593Smuzhiyun 	ulong usart_clk_rate;
145*4882a593Smuzhiyun };
146*4882a593Smuzhiyun 
_atmel_serial_set_brg(atmel_usart3_t * usart,ulong usart_clk_rate,int baudrate)147*4882a593Smuzhiyun static void _atmel_serial_set_brg(atmel_usart3_t *usart,
148*4882a593Smuzhiyun 				  ulong usart_clk_rate, int baudrate)
149*4882a593Smuzhiyun {
150*4882a593Smuzhiyun 	unsigned long divisor;
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	divisor = (usart_clk_rate / 16 + baudrate / 2) / baudrate;
153*4882a593Smuzhiyun 	writel(USART3_BF(CD, divisor), &usart->brgr);
154*4882a593Smuzhiyun }
155*4882a593Smuzhiyun 
_atmel_serial_init(atmel_usart3_t * usart,ulong usart_clk_rate,int baudrate)156*4882a593Smuzhiyun void _atmel_serial_init(atmel_usart3_t *usart,
157*4882a593Smuzhiyun 			ulong usart_clk_rate, int baudrate)
158*4882a593Smuzhiyun {
159*4882a593Smuzhiyun 	writel(USART3_BIT(RXDIS) | USART3_BIT(TXDIS), &usart->cr);
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun 	writel((USART3_BF(USART_MODE, USART3_USART_MODE_NORMAL) |
162*4882a593Smuzhiyun 		USART3_BF(USCLKS, USART3_USCLKS_MCK) |
163*4882a593Smuzhiyun 		USART3_BF(CHRL, USART3_CHRL_8) |
164*4882a593Smuzhiyun 		USART3_BF(PAR, USART3_PAR_NONE) |
165*4882a593Smuzhiyun 		USART3_BF(NBSTOP, USART3_NBSTOP_1)), &usart->mr);
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun 	_atmel_serial_set_brg(usart, usart_clk_rate, baudrate);
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun 	writel(USART3_BIT(RSTRX) | USART3_BIT(RSTTX), &usart->cr);
170*4882a593Smuzhiyun 	writel(USART3_BIT(RXEN) | USART3_BIT(TXEN), &usart->cr);
171*4882a593Smuzhiyun }
172*4882a593Smuzhiyun 
atmel_serial_setbrg(struct udevice * dev,int baudrate)173*4882a593Smuzhiyun int atmel_serial_setbrg(struct udevice *dev, int baudrate)
174*4882a593Smuzhiyun {
175*4882a593Smuzhiyun 	struct atmel_serial_priv *priv = dev_get_priv(dev);
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun 	_atmel_serial_set_brg(priv->usart, priv->usart_clk_rate, baudrate);
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 	return 0;
180*4882a593Smuzhiyun }
181*4882a593Smuzhiyun 
atmel_serial_getc(struct udevice * dev)182*4882a593Smuzhiyun static int atmel_serial_getc(struct udevice *dev)
183*4882a593Smuzhiyun {
184*4882a593Smuzhiyun 	struct atmel_serial_priv *priv = dev_get_priv(dev);
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun 	if (!(readl(&priv->usart->csr) & USART3_BIT(RXRDY)))
187*4882a593Smuzhiyun 		return -EAGAIN;
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun 	return readl(&priv->usart->rhr);
190*4882a593Smuzhiyun }
191*4882a593Smuzhiyun 
atmel_serial_putc(struct udevice * dev,const char ch)192*4882a593Smuzhiyun static int atmel_serial_putc(struct udevice *dev, const char ch)
193*4882a593Smuzhiyun {
194*4882a593Smuzhiyun 	struct atmel_serial_priv *priv = dev_get_priv(dev);
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun 	if (!(readl(&priv->usart->csr) & USART3_BIT(TXRDY)))
197*4882a593Smuzhiyun 		return -EAGAIN;
198*4882a593Smuzhiyun 
199*4882a593Smuzhiyun 	writel(ch, &priv->usart->thr);
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun 	return 0;
202*4882a593Smuzhiyun }
203*4882a593Smuzhiyun 
atmel_serial_pending(struct udevice * dev,bool input)204*4882a593Smuzhiyun static int atmel_serial_pending(struct udevice *dev, bool input)
205*4882a593Smuzhiyun {
206*4882a593Smuzhiyun 	struct atmel_serial_priv *priv = dev_get_priv(dev);
207*4882a593Smuzhiyun 	uint32_t csr = readl(&priv->usart->csr);
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun 	if (input)
210*4882a593Smuzhiyun 		return csr & USART3_BIT(RXRDY) ? 1 : 0;
211*4882a593Smuzhiyun 	else
212*4882a593Smuzhiyun 		return csr & USART3_BIT(TXEMPTY) ? 0 : 1;
213*4882a593Smuzhiyun }
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun static const struct dm_serial_ops atmel_serial_ops = {
216*4882a593Smuzhiyun 	.putc = atmel_serial_putc,
217*4882a593Smuzhiyun 	.pending = atmel_serial_pending,
218*4882a593Smuzhiyun 	.getc = atmel_serial_getc,
219*4882a593Smuzhiyun 	.setbrg = atmel_serial_setbrg,
220*4882a593Smuzhiyun };
221*4882a593Smuzhiyun 
atmel_serial_enable_clk(struct udevice * dev)222*4882a593Smuzhiyun static int atmel_serial_enable_clk(struct udevice *dev)
223*4882a593Smuzhiyun {
224*4882a593Smuzhiyun 	struct atmel_serial_priv *priv = dev_get_priv(dev);
225*4882a593Smuzhiyun 	struct clk clk;
226*4882a593Smuzhiyun 	ulong clk_rate;
227*4882a593Smuzhiyun 	int ret;
228*4882a593Smuzhiyun 
229*4882a593Smuzhiyun 	ret = clk_get_by_index(dev, 0, &clk);
230*4882a593Smuzhiyun 	if (ret)
231*4882a593Smuzhiyun 		return -EINVAL;
232*4882a593Smuzhiyun 
233*4882a593Smuzhiyun 	if (dev_get_driver_data(dev) == CLK_TYPE_NORMAL) {
234*4882a593Smuzhiyun 		ret = clk_enable(&clk);
235*4882a593Smuzhiyun 		if (ret)
236*4882a593Smuzhiyun 			return ret;
237*4882a593Smuzhiyun 	}
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 	clk_rate = clk_get_rate(&clk);
240*4882a593Smuzhiyun 	if (!clk_rate)
241*4882a593Smuzhiyun 		return -EINVAL;
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun 	priv->usart_clk_rate = clk_rate;
244*4882a593Smuzhiyun 
245*4882a593Smuzhiyun 	clk_free(&clk);
246*4882a593Smuzhiyun 
247*4882a593Smuzhiyun 	return 0;
248*4882a593Smuzhiyun }
249*4882a593Smuzhiyun 
atmel_serial_probe(struct udevice * dev)250*4882a593Smuzhiyun static int atmel_serial_probe(struct udevice *dev)
251*4882a593Smuzhiyun {
252*4882a593Smuzhiyun 	struct atmel_serial_platdata *plat = dev->platdata;
253*4882a593Smuzhiyun 	struct atmel_serial_priv *priv = dev_get_priv(dev);
254*4882a593Smuzhiyun 	int ret;
255*4882a593Smuzhiyun #if CONFIG_IS_ENABLED(OF_CONTROL)
256*4882a593Smuzhiyun 	fdt_addr_t addr_base;
257*4882a593Smuzhiyun 
258*4882a593Smuzhiyun 	addr_base = devfdt_get_addr(dev);
259*4882a593Smuzhiyun 	if (addr_base == FDT_ADDR_T_NONE)
260*4882a593Smuzhiyun 		return -ENODEV;
261*4882a593Smuzhiyun 
262*4882a593Smuzhiyun 	plat->base_addr = (uint32_t)addr_base;
263*4882a593Smuzhiyun #endif
264*4882a593Smuzhiyun 	priv->usart = (atmel_usart3_t *)plat->base_addr;
265*4882a593Smuzhiyun 
266*4882a593Smuzhiyun 	ret = atmel_serial_enable_clk(dev);
267*4882a593Smuzhiyun 	if (ret)
268*4882a593Smuzhiyun 		return ret;
269*4882a593Smuzhiyun 
270*4882a593Smuzhiyun 	_atmel_serial_init(priv->usart, priv->usart_clk_rate, gd->baudrate);
271*4882a593Smuzhiyun 
272*4882a593Smuzhiyun 	return 0;
273*4882a593Smuzhiyun }
274*4882a593Smuzhiyun 
275*4882a593Smuzhiyun #if CONFIG_IS_ENABLED(OF_CONTROL)
276*4882a593Smuzhiyun static const struct udevice_id atmel_serial_ids[] = {
277*4882a593Smuzhiyun 	{
278*4882a593Smuzhiyun 		.compatible = "atmel,at91sam9260-dbgu",
279*4882a593Smuzhiyun 		.data = CLK_TYPE_DBGU,
280*4882a593Smuzhiyun 	},
281*4882a593Smuzhiyun 	{
282*4882a593Smuzhiyun 		.compatible = "atmel,at91sam9260-usart",
283*4882a593Smuzhiyun 		.data = CLK_TYPE_NORMAL,
284*4882a593Smuzhiyun 	},
285*4882a593Smuzhiyun 	{ }
286*4882a593Smuzhiyun };
287*4882a593Smuzhiyun #endif
288*4882a593Smuzhiyun 
289*4882a593Smuzhiyun U_BOOT_DRIVER(serial_atmel) = {
290*4882a593Smuzhiyun 	.name	= "serial_atmel",
291*4882a593Smuzhiyun 	.id	= UCLASS_SERIAL,
292*4882a593Smuzhiyun #if CONFIG_IS_ENABLED(OF_CONTROL)
293*4882a593Smuzhiyun 	.of_match = atmel_serial_ids,
294*4882a593Smuzhiyun 	.platdata_auto_alloc_size = sizeof(struct atmel_serial_platdata),
295*4882a593Smuzhiyun #endif
296*4882a593Smuzhiyun 	.probe = atmel_serial_probe,
297*4882a593Smuzhiyun 	.ops	= &atmel_serial_ops,
298*4882a593Smuzhiyun 	.flags = DM_FLAG_PRE_RELOC,
299*4882a593Smuzhiyun 	.priv_auto_alloc_size	= sizeof(struct atmel_serial_priv),
300*4882a593Smuzhiyun };
301*4882a593Smuzhiyun #endif
302*4882a593Smuzhiyun 
303*4882a593Smuzhiyun #ifdef CONFIG_DEBUG_UART_ATMEL
_debug_uart_init(void)304*4882a593Smuzhiyun static inline void _debug_uart_init(void)
305*4882a593Smuzhiyun {
306*4882a593Smuzhiyun 	atmel_usart3_t *usart = (atmel_usart3_t *)CONFIG_DEBUG_UART_BASE;
307*4882a593Smuzhiyun 
308*4882a593Smuzhiyun 	_atmel_serial_init(usart, CONFIG_DEBUG_UART_CLOCK, CONFIG_BAUDRATE);
309*4882a593Smuzhiyun }
310*4882a593Smuzhiyun 
_debug_uart_putc(int ch)311*4882a593Smuzhiyun static inline void _debug_uart_putc(int ch)
312*4882a593Smuzhiyun {
313*4882a593Smuzhiyun 	atmel_usart3_t *usart = (atmel_usart3_t *)CONFIG_DEBUG_UART_BASE;
314*4882a593Smuzhiyun 
315*4882a593Smuzhiyun 	while (!(readl(&usart->csr) & USART3_BIT(TXRDY)))
316*4882a593Smuzhiyun 		;
317*4882a593Smuzhiyun 
318*4882a593Smuzhiyun 	writel(ch, &usart->thr);
319*4882a593Smuzhiyun }
320*4882a593Smuzhiyun 
321*4882a593Smuzhiyun DEBUG_UART_FUNCS
322*4882a593Smuzhiyun #endif
323