xref: /rk3399_rockchip-uboot/drivers/serial/serial_sti_asc.c (revision a821c4af79e4f5ce9b629b20473863397bbe9b10)
1214a17e6SPatrice Chotard /*
2214a17e6SPatrice Chotard  * Support for Serial I/O using STMicroelectronics' on-chip ASC.
3214a17e6SPatrice Chotard  *
4214a17e6SPatrice Chotard  *  Copyright (c) 2017
5214a17e6SPatrice Chotard  *  Patrice Chotard <patrice.chotard@st.com>
6214a17e6SPatrice Chotard  *
7214a17e6SPatrice Chotard  * SPDX-License-Identifier:	GPL-2.0
8214a17e6SPatrice Chotard  */
9214a17e6SPatrice Chotard 
10214a17e6SPatrice Chotard #include <common.h>
11214a17e6SPatrice Chotard #include <dm.h>
12214a17e6SPatrice Chotard #include <serial.h>
13214a17e6SPatrice Chotard #include <asm/io.h>
14214a17e6SPatrice Chotard 
15214a17e6SPatrice Chotard DECLARE_GLOBAL_DATA_PTR;
16214a17e6SPatrice Chotard 
17214a17e6SPatrice Chotard #define BAUDMODE	0x00001000
18214a17e6SPatrice Chotard #define RXENABLE	0x00000100
19214a17e6SPatrice Chotard #define RUN		0x00000080
20214a17e6SPatrice Chotard #define MODE		0x00000001
21214a17e6SPatrice Chotard #define MODE_8BIT	0x0001
22214a17e6SPatrice Chotard #define STOP_1BIT	0x0008
23214a17e6SPatrice Chotard #define PARITYODD	0x0020
24214a17e6SPatrice Chotard 
25214a17e6SPatrice Chotard #define STA_TF		BIT(9)
26214a17e6SPatrice Chotard #define STA_RBF		BIT(0)
27214a17e6SPatrice Chotard 
28214a17e6SPatrice Chotard struct sti_asc_uart {
29214a17e6SPatrice Chotard 	u32 baudrate;
30214a17e6SPatrice Chotard 	u32 txbuf;
31214a17e6SPatrice Chotard 	u32 rxbuf;
32214a17e6SPatrice Chotard 	u32 control;
33214a17e6SPatrice Chotard 	u32 inten;
34214a17e6SPatrice Chotard 	u32 status;
35214a17e6SPatrice Chotard 	u32 guardtime;
36214a17e6SPatrice Chotard 	u32 timeout;
37214a17e6SPatrice Chotard 	u32 txreset;
38214a17e6SPatrice Chotard 	u32 rxreset;
39214a17e6SPatrice Chotard };
40214a17e6SPatrice Chotard 
41214a17e6SPatrice Chotard struct sti_asc_serial {
42214a17e6SPatrice Chotard 	/* address of registers in physical memory */
43214a17e6SPatrice Chotard 	struct sti_asc_uart *regs;
44214a17e6SPatrice Chotard };
45214a17e6SPatrice Chotard 
46214a17e6SPatrice Chotard /* Values for the BAUDRATE Register */
47214a17e6SPatrice Chotard #define PCLK			(200ul * 1000000ul)
48214a17e6SPatrice Chotard #define BAUDRATE_VAL_M0(bps)	(PCLK / (16 * (bps)))
49214a17e6SPatrice Chotard #define BAUDRATE_VAL_M1(bps)	((bps * (1 << 14)) + (1<<13)) / (PCLK/(1 << 6))
50214a17e6SPatrice Chotard 
51214a17e6SPatrice Chotard /*
52214a17e6SPatrice Chotard  * MODE 0
53214a17e6SPatrice Chotard  *                       ICCLK
54214a17e6SPatrice Chotard  * ASCBaudRate =   ----------------
55214a17e6SPatrice Chotard  *                   baudrate * 16
56214a17e6SPatrice Chotard  *
57214a17e6SPatrice Chotard  * MODE 1
58214a17e6SPatrice Chotard  *                   baudrate * 16 * 2^16
59214a17e6SPatrice Chotard  * ASCBaudRate =   ------------------------
60214a17e6SPatrice Chotard  *                          ICCLK
61214a17e6SPatrice Chotard  *
62214a17e6SPatrice Chotard  * NOTE:
63214a17e6SPatrice Chotard  * Mode 1 should be used for baudrates of 19200, and above, as it
64214a17e6SPatrice Chotard  * has a lower deviation error than Mode 0 for higher frequencies.
65214a17e6SPatrice Chotard  * Mode 0 should be used for all baudrates below 19200.
66214a17e6SPatrice Chotard  */
67214a17e6SPatrice Chotard 
sti_asc_pending(struct udevice * dev,bool input)68214a17e6SPatrice Chotard static int sti_asc_pending(struct udevice *dev, bool input)
69214a17e6SPatrice Chotard {
70214a17e6SPatrice Chotard 	struct sti_asc_serial *priv = dev_get_priv(dev);
71214a17e6SPatrice Chotard 	struct sti_asc_uart *const uart = priv->regs;
72214a17e6SPatrice Chotard 	unsigned long status;
73214a17e6SPatrice Chotard 
74214a17e6SPatrice Chotard 	status = readl(&uart->status);
75214a17e6SPatrice Chotard 	if (input)
76214a17e6SPatrice Chotard 		return status & STA_RBF;
77214a17e6SPatrice Chotard 	else
78214a17e6SPatrice Chotard 		return status & STA_TF;
79214a17e6SPatrice Chotard }
80214a17e6SPatrice Chotard 
_sti_asc_serial_setbrg(struct sti_asc_uart * uart,int baudrate)81214a17e6SPatrice Chotard static int _sti_asc_serial_setbrg(struct sti_asc_uart *uart, int baudrate)
82214a17e6SPatrice Chotard {
83214a17e6SPatrice Chotard 	unsigned long val;
84214a17e6SPatrice Chotard 	int t, mode = 1;
85214a17e6SPatrice Chotard 
86214a17e6SPatrice Chotard 	switch (baudrate) {
87214a17e6SPatrice Chotard 	case 9600:
88214a17e6SPatrice Chotard 		t = BAUDRATE_VAL_M0(9600);
89214a17e6SPatrice Chotard 		mode = 0;
90214a17e6SPatrice Chotard 		break;
91214a17e6SPatrice Chotard 	case 19200:
92214a17e6SPatrice Chotard 		t = BAUDRATE_VAL_M1(19200);
93214a17e6SPatrice Chotard 		break;
94214a17e6SPatrice Chotard 	case 38400:
95214a17e6SPatrice Chotard 		t = BAUDRATE_VAL_M1(38400);
96214a17e6SPatrice Chotard 		break;
97214a17e6SPatrice Chotard 	case 57600:
98214a17e6SPatrice Chotard 		t = BAUDRATE_VAL_M1(57600);
99214a17e6SPatrice Chotard 		break;
100214a17e6SPatrice Chotard 	default:
101214a17e6SPatrice Chotard 		debug("ASC: unsupported baud rate: %d, using 115200 instead.\n",
102214a17e6SPatrice Chotard 		      baudrate);
103214a17e6SPatrice Chotard 	case 115200:
104214a17e6SPatrice Chotard 		t = BAUDRATE_VAL_M1(115200);
105214a17e6SPatrice Chotard 		break;
106214a17e6SPatrice Chotard 	}
107214a17e6SPatrice Chotard 
108214a17e6SPatrice Chotard 	/* disable the baudrate generator */
109214a17e6SPatrice Chotard 	val = readl(&uart->control);
110214a17e6SPatrice Chotard 	writel(val & ~RUN, &uart->control);
111214a17e6SPatrice Chotard 
112214a17e6SPatrice Chotard 	/* set baud generator reload value */
113214a17e6SPatrice Chotard 	writel(t, &uart->baudrate);
114214a17e6SPatrice Chotard 	/* reset the RX & TX buffers */
115214a17e6SPatrice Chotard 	writel(1, &uart->txreset);
116214a17e6SPatrice Chotard 	writel(1, &uart->rxreset);
117214a17e6SPatrice Chotard 
118214a17e6SPatrice Chotard 	/* set baud generator mode */
119214a17e6SPatrice Chotard 	if (mode)
120214a17e6SPatrice Chotard 		val |= BAUDMODE;
121214a17e6SPatrice Chotard 
122214a17e6SPatrice Chotard 	/* finally, write value and enable ASC */
123214a17e6SPatrice Chotard 	writel(val, &uart->control);
124214a17e6SPatrice Chotard 
125214a17e6SPatrice Chotard 	return 0;
126214a17e6SPatrice Chotard }
127214a17e6SPatrice Chotard 
128214a17e6SPatrice Chotard /* called to adjust baud-rate */
sti_asc_serial_setbrg(struct udevice * dev,int baudrate)129214a17e6SPatrice Chotard static int sti_asc_serial_setbrg(struct udevice *dev, int baudrate)
130214a17e6SPatrice Chotard {
131214a17e6SPatrice Chotard 	struct sti_asc_serial *priv = dev_get_priv(dev);
132214a17e6SPatrice Chotard 	struct sti_asc_uart *const uart = priv->regs;
133214a17e6SPatrice Chotard 
134214a17e6SPatrice Chotard 	return _sti_asc_serial_setbrg(uart, baudrate);
135214a17e6SPatrice Chotard }
136214a17e6SPatrice Chotard 
137214a17e6SPatrice Chotard /* blocking function, that returns next char */
sti_asc_serial_getc(struct udevice * dev)138214a17e6SPatrice Chotard static int sti_asc_serial_getc(struct udevice *dev)
139214a17e6SPatrice Chotard {
140214a17e6SPatrice Chotard 	struct sti_asc_serial *priv = dev_get_priv(dev);
141214a17e6SPatrice Chotard 	struct sti_asc_uart *const uart = priv->regs;
142214a17e6SPatrice Chotard 
143214a17e6SPatrice Chotard 	/* polling wait: for a char to be read */
144214a17e6SPatrice Chotard 	if (!sti_asc_pending(dev, true))
145214a17e6SPatrice Chotard 		return -EAGAIN;
146214a17e6SPatrice Chotard 
147214a17e6SPatrice Chotard 	return readl(&uart->rxbuf);
148214a17e6SPatrice Chotard }
149214a17e6SPatrice Chotard 
150214a17e6SPatrice Chotard /* write write out a single char */
sti_asc_serial_putc(struct udevice * dev,const char c)151214a17e6SPatrice Chotard static int sti_asc_serial_putc(struct udevice *dev, const char c)
152214a17e6SPatrice Chotard {
153214a17e6SPatrice Chotard 	struct sti_asc_serial *priv = dev_get_priv(dev);
154214a17e6SPatrice Chotard 	struct sti_asc_uart *const uart = priv->regs;
155214a17e6SPatrice Chotard 
156214a17e6SPatrice Chotard 	/* wait till safe to write next char */
157214a17e6SPatrice Chotard 	if (sti_asc_pending(dev, false))
158214a17e6SPatrice Chotard 		return -EAGAIN;
159214a17e6SPatrice Chotard 
160214a17e6SPatrice Chotard 	/* finally, write next char */
161214a17e6SPatrice Chotard 	writel(c, &uart->txbuf);
162214a17e6SPatrice Chotard 
163214a17e6SPatrice Chotard 	return 0;
164214a17e6SPatrice Chotard }
165214a17e6SPatrice Chotard 
166214a17e6SPatrice Chotard /* initialize the ASC */
sti_asc_serial_probe(struct udevice * dev)167214a17e6SPatrice Chotard static int sti_asc_serial_probe(struct udevice *dev)
168214a17e6SPatrice Chotard {
169214a17e6SPatrice Chotard 	struct sti_asc_serial *priv = dev_get_priv(dev);
170214a17e6SPatrice Chotard 	unsigned long val;
171214a17e6SPatrice Chotard 	fdt_addr_t base;
172214a17e6SPatrice Chotard 
173*a821c4afSSimon Glass 	base = devfdt_get_addr(dev);
174214a17e6SPatrice Chotard 	if (base == FDT_ADDR_T_NONE)
175214a17e6SPatrice Chotard 		return -EINVAL;
176214a17e6SPatrice Chotard 
177214a17e6SPatrice Chotard 	priv->regs = (struct sti_asc_uart *)base;
178214a17e6SPatrice Chotard 	sti_asc_serial_setbrg(dev, gd->baudrate);
179214a17e6SPatrice Chotard 
180214a17e6SPatrice Chotard 	/*
181214a17e6SPatrice Chotard 	 * build up the value to be written to CONTROL
182214a17e6SPatrice Chotard 	 * set character length, bit stop number, odd parity
183214a17e6SPatrice Chotard 	 */
184214a17e6SPatrice Chotard 	val = RXENABLE | RUN | MODE_8BIT | STOP_1BIT | PARITYODD;
185214a17e6SPatrice Chotard 	writel(val, &priv->regs->control);
186214a17e6SPatrice Chotard 
187214a17e6SPatrice Chotard 	return 0;
188214a17e6SPatrice Chotard }
189214a17e6SPatrice Chotard 
190214a17e6SPatrice Chotard static const struct dm_serial_ops sti_asc_serial_ops = {
191214a17e6SPatrice Chotard 	.putc = sti_asc_serial_putc,
192214a17e6SPatrice Chotard 	.pending = sti_asc_pending,
193214a17e6SPatrice Chotard 	.getc = sti_asc_serial_getc,
194214a17e6SPatrice Chotard 	.setbrg = sti_asc_serial_setbrg,
195214a17e6SPatrice Chotard };
196214a17e6SPatrice Chotard 
197214a17e6SPatrice Chotard static const struct udevice_id sti_serial_of_match[] = {
198214a17e6SPatrice Chotard 	{ .compatible = "st,asc" },
199214a17e6SPatrice Chotard 	{ }
200214a17e6SPatrice Chotard };
201214a17e6SPatrice Chotard 
202214a17e6SPatrice Chotard U_BOOT_DRIVER(serial_sti_asc) = {
203214a17e6SPatrice Chotard 	.name = "serial_sti_asc",
204214a17e6SPatrice Chotard 	.id = UCLASS_SERIAL,
205214a17e6SPatrice Chotard 	.of_match = sti_serial_of_match,
206214a17e6SPatrice Chotard 	.ops = &sti_asc_serial_ops,
207214a17e6SPatrice Chotard 	.probe = sti_asc_serial_probe,
208214a17e6SPatrice Chotard 	.priv_auto_alloc_size = sizeof(struct sti_asc_serial),
209214a17e6SPatrice Chotard 	.flags = DM_FLAG_PRE_RELOC,
210214a17e6SPatrice Chotard };
211214a17e6SPatrice Chotard 
212