xref: /OK3568_Linux_fs/kernel/drivers/tty/serial/uartlite.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * uartlite.c: Serial driver for Xilinx uartlite serial controller
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2006 Peter Korsgaard <jacmet@sunsite.dk>
6*4882a593Smuzhiyun  * Copyright (C) 2007 Secret Lab Technologies Ltd.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/platform_device.h>
10*4882a593Smuzhiyun #include <linux/module.h>
11*4882a593Smuzhiyun #include <linux/console.h>
12*4882a593Smuzhiyun #include <linux/serial.h>
13*4882a593Smuzhiyun #include <linux/serial_core.h>
14*4882a593Smuzhiyun #include <linux/tty.h>
15*4882a593Smuzhiyun #include <linux/tty_flip.h>
16*4882a593Smuzhiyun #include <linux/delay.h>
17*4882a593Smuzhiyun #include <linux/interrupt.h>
18*4882a593Smuzhiyun #include <linux/init.h>
19*4882a593Smuzhiyun #include <linux/io.h>
20*4882a593Smuzhiyun #include <linux/of.h>
21*4882a593Smuzhiyun #include <linux/of_address.h>
22*4882a593Smuzhiyun #include <linux/of_device.h>
23*4882a593Smuzhiyun #include <linux/of_platform.h>
24*4882a593Smuzhiyun #include <linux/clk.h>
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun #define ULITE_NAME		"ttyUL"
27*4882a593Smuzhiyun #define ULITE_MAJOR		204
28*4882a593Smuzhiyun #define ULITE_MINOR		187
29*4882a593Smuzhiyun #define ULITE_NR_UARTS		CONFIG_SERIAL_UARTLITE_NR_UARTS
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun /* ---------------------------------------------------------------------
32*4882a593Smuzhiyun  * Register definitions
33*4882a593Smuzhiyun  *
34*4882a593Smuzhiyun  * For register details see datasheet:
35*4882a593Smuzhiyun  * https://www.xilinx.com/support/documentation/ip_documentation/opb_uartlite.pdf
36*4882a593Smuzhiyun  */
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #define ULITE_RX		0x00
39*4882a593Smuzhiyun #define ULITE_TX		0x04
40*4882a593Smuzhiyun #define ULITE_STATUS		0x08
41*4882a593Smuzhiyun #define ULITE_CONTROL		0x0c
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun #define ULITE_REGION		16
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun #define ULITE_STATUS_RXVALID	0x01
46*4882a593Smuzhiyun #define ULITE_STATUS_RXFULL	0x02
47*4882a593Smuzhiyun #define ULITE_STATUS_TXEMPTY	0x04
48*4882a593Smuzhiyun #define ULITE_STATUS_TXFULL	0x08
49*4882a593Smuzhiyun #define ULITE_STATUS_IE		0x10
50*4882a593Smuzhiyun #define ULITE_STATUS_OVERRUN	0x20
51*4882a593Smuzhiyun #define ULITE_STATUS_FRAME	0x40
52*4882a593Smuzhiyun #define ULITE_STATUS_PARITY	0x80
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun #define ULITE_CONTROL_RST_TX	0x01
55*4882a593Smuzhiyun #define ULITE_CONTROL_RST_RX	0x02
56*4882a593Smuzhiyun #define ULITE_CONTROL_IE	0x10
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun /* Static pointer to console port */
59*4882a593Smuzhiyun #ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
60*4882a593Smuzhiyun static struct uart_port *console_port;
61*4882a593Smuzhiyun #endif
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun struct uartlite_data {
64*4882a593Smuzhiyun 	const struct uartlite_reg_ops *reg_ops;
65*4882a593Smuzhiyun 	struct clk *clk;
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun struct uartlite_reg_ops {
69*4882a593Smuzhiyun 	u32 (*in)(void __iomem *addr);
70*4882a593Smuzhiyun 	void (*out)(u32 val, void __iomem *addr);
71*4882a593Smuzhiyun };
72*4882a593Smuzhiyun 
uartlite_inbe32(void __iomem * addr)73*4882a593Smuzhiyun static u32 uartlite_inbe32(void __iomem *addr)
74*4882a593Smuzhiyun {
75*4882a593Smuzhiyun 	return ioread32be(addr);
76*4882a593Smuzhiyun }
77*4882a593Smuzhiyun 
uartlite_outbe32(u32 val,void __iomem * addr)78*4882a593Smuzhiyun static void uartlite_outbe32(u32 val, void __iomem *addr)
79*4882a593Smuzhiyun {
80*4882a593Smuzhiyun 	iowrite32be(val, addr);
81*4882a593Smuzhiyun }
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun static const struct uartlite_reg_ops uartlite_be = {
84*4882a593Smuzhiyun 	.in = uartlite_inbe32,
85*4882a593Smuzhiyun 	.out = uartlite_outbe32,
86*4882a593Smuzhiyun };
87*4882a593Smuzhiyun 
uartlite_inle32(void __iomem * addr)88*4882a593Smuzhiyun static u32 uartlite_inle32(void __iomem *addr)
89*4882a593Smuzhiyun {
90*4882a593Smuzhiyun 	return ioread32(addr);
91*4882a593Smuzhiyun }
92*4882a593Smuzhiyun 
uartlite_outle32(u32 val,void __iomem * addr)93*4882a593Smuzhiyun static void uartlite_outle32(u32 val, void __iomem *addr)
94*4882a593Smuzhiyun {
95*4882a593Smuzhiyun 	iowrite32(val, addr);
96*4882a593Smuzhiyun }
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun static const struct uartlite_reg_ops uartlite_le = {
99*4882a593Smuzhiyun 	.in = uartlite_inle32,
100*4882a593Smuzhiyun 	.out = uartlite_outle32,
101*4882a593Smuzhiyun };
102*4882a593Smuzhiyun 
uart_in32(u32 offset,struct uart_port * port)103*4882a593Smuzhiyun static inline u32 uart_in32(u32 offset, struct uart_port *port)
104*4882a593Smuzhiyun {
105*4882a593Smuzhiyun 	struct uartlite_data *pdata = port->private_data;
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	return pdata->reg_ops->in(port->membase + offset);
108*4882a593Smuzhiyun }
109*4882a593Smuzhiyun 
uart_out32(u32 val,u32 offset,struct uart_port * port)110*4882a593Smuzhiyun static inline void uart_out32(u32 val, u32 offset, struct uart_port *port)
111*4882a593Smuzhiyun {
112*4882a593Smuzhiyun 	struct uartlite_data *pdata = port->private_data;
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun 	pdata->reg_ops->out(val, port->membase + offset);
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun static struct uart_port ulite_ports[ULITE_NR_UARTS];
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun /* ---------------------------------------------------------------------
120*4882a593Smuzhiyun  * Core UART driver operations
121*4882a593Smuzhiyun  */
122*4882a593Smuzhiyun 
ulite_receive(struct uart_port * port,int stat)123*4882a593Smuzhiyun static int ulite_receive(struct uart_port *port, int stat)
124*4882a593Smuzhiyun {
125*4882a593Smuzhiyun 	struct tty_port *tport = &port->state->port;
126*4882a593Smuzhiyun 	unsigned char ch = 0;
127*4882a593Smuzhiyun 	char flag = TTY_NORMAL;
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 	if ((stat & (ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
130*4882a593Smuzhiyun 		     | ULITE_STATUS_FRAME)) == 0)
131*4882a593Smuzhiyun 		return 0;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	/* stats */
134*4882a593Smuzhiyun 	if (stat & ULITE_STATUS_RXVALID) {
135*4882a593Smuzhiyun 		port->icount.rx++;
136*4882a593Smuzhiyun 		ch = uart_in32(ULITE_RX, port);
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 		if (stat & ULITE_STATUS_PARITY)
139*4882a593Smuzhiyun 			port->icount.parity++;
140*4882a593Smuzhiyun 	}
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	if (stat & ULITE_STATUS_OVERRUN)
143*4882a593Smuzhiyun 		port->icount.overrun++;
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 	if (stat & ULITE_STATUS_FRAME)
146*4882a593Smuzhiyun 		port->icount.frame++;
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 	/* drop byte with parity error if IGNPAR specificed */
150*4882a593Smuzhiyun 	if (stat & port->ignore_status_mask & ULITE_STATUS_PARITY)
151*4882a593Smuzhiyun 		stat &= ~ULITE_STATUS_RXVALID;
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun 	stat &= port->read_status_mask;
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 	if (stat & ULITE_STATUS_PARITY)
156*4882a593Smuzhiyun 		flag = TTY_PARITY;
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun 	stat &= ~port->ignore_status_mask;
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun 	if (stat & ULITE_STATUS_RXVALID)
162*4882a593Smuzhiyun 		tty_insert_flip_char(tport, ch, flag);
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 	if (stat & ULITE_STATUS_FRAME)
165*4882a593Smuzhiyun 		tty_insert_flip_char(tport, 0, TTY_FRAME);
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun 	if (stat & ULITE_STATUS_OVERRUN)
168*4882a593Smuzhiyun 		tty_insert_flip_char(tport, 0, TTY_OVERRUN);
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 	return 1;
171*4882a593Smuzhiyun }
172*4882a593Smuzhiyun 
ulite_transmit(struct uart_port * port,int stat)173*4882a593Smuzhiyun static int ulite_transmit(struct uart_port *port, int stat)
174*4882a593Smuzhiyun {
175*4882a593Smuzhiyun 	struct circ_buf *xmit  = &port->state->xmit;
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun 	if (stat & ULITE_STATUS_TXFULL)
178*4882a593Smuzhiyun 		return 0;
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun 	if (port->x_char) {
181*4882a593Smuzhiyun 		uart_out32(port->x_char, ULITE_TX, port);
182*4882a593Smuzhiyun 		port->x_char = 0;
183*4882a593Smuzhiyun 		port->icount.tx++;
184*4882a593Smuzhiyun 		return 1;
185*4882a593Smuzhiyun 	}
186*4882a593Smuzhiyun 
187*4882a593Smuzhiyun 	if (uart_circ_empty(xmit) || uart_tx_stopped(port))
188*4882a593Smuzhiyun 		return 0;
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun 	uart_out32(xmit->buf[xmit->tail], ULITE_TX, port);
191*4882a593Smuzhiyun 	xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE-1);
192*4882a593Smuzhiyun 	port->icount.tx++;
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun 	/* wake up */
195*4882a593Smuzhiyun 	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
196*4882a593Smuzhiyun 		uart_write_wakeup(port);
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun 	return 1;
199*4882a593Smuzhiyun }
200*4882a593Smuzhiyun 
ulite_isr(int irq,void * dev_id)201*4882a593Smuzhiyun static irqreturn_t ulite_isr(int irq, void *dev_id)
202*4882a593Smuzhiyun {
203*4882a593Smuzhiyun 	struct uart_port *port = dev_id;
204*4882a593Smuzhiyun 	int stat, busy, n = 0;
205*4882a593Smuzhiyun 	unsigned long flags;
206*4882a593Smuzhiyun 
207*4882a593Smuzhiyun 	do {
208*4882a593Smuzhiyun 		spin_lock_irqsave(&port->lock, flags);
209*4882a593Smuzhiyun 		stat = uart_in32(ULITE_STATUS, port);
210*4882a593Smuzhiyun 		busy  = ulite_receive(port, stat);
211*4882a593Smuzhiyun 		busy |= ulite_transmit(port, stat);
212*4882a593Smuzhiyun 		spin_unlock_irqrestore(&port->lock, flags);
213*4882a593Smuzhiyun 		n++;
214*4882a593Smuzhiyun 	} while (busy);
215*4882a593Smuzhiyun 
216*4882a593Smuzhiyun 	/* work done? */
217*4882a593Smuzhiyun 	if (n > 1) {
218*4882a593Smuzhiyun 		tty_flip_buffer_push(&port->state->port);
219*4882a593Smuzhiyun 		return IRQ_HANDLED;
220*4882a593Smuzhiyun 	} else {
221*4882a593Smuzhiyun 		return IRQ_NONE;
222*4882a593Smuzhiyun 	}
223*4882a593Smuzhiyun }
224*4882a593Smuzhiyun 
ulite_tx_empty(struct uart_port * port)225*4882a593Smuzhiyun static unsigned int ulite_tx_empty(struct uart_port *port)
226*4882a593Smuzhiyun {
227*4882a593Smuzhiyun 	unsigned long flags;
228*4882a593Smuzhiyun 	unsigned int ret;
229*4882a593Smuzhiyun 
230*4882a593Smuzhiyun 	spin_lock_irqsave(&port->lock, flags);
231*4882a593Smuzhiyun 	ret = uart_in32(ULITE_STATUS, port);
232*4882a593Smuzhiyun 	spin_unlock_irqrestore(&port->lock, flags);
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun 	return ret & ULITE_STATUS_TXEMPTY ? TIOCSER_TEMT : 0;
235*4882a593Smuzhiyun }
236*4882a593Smuzhiyun 
ulite_get_mctrl(struct uart_port * port)237*4882a593Smuzhiyun static unsigned int ulite_get_mctrl(struct uart_port *port)
238*4882a593Smuzhiyun {
239*4882a593Smuzhiyun 	return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
240*4882a593Smuzhiyun }
241*4882a593Smuzhiyun 
ulite_set_mctrl(struct uart_port * port,unsigned int mctrl)242*4882a593Smuzhiyun static void ulite_set_mctrl(struct uart_port *port, unsigned int mctrl)
243*4882a593Smuzhiyun {
244*4882a593Smuzhiyun 	/* N/A */
245*4882a593Smuzhiyun }
246*4882a593Smuzhiyun 
ulite_stop_tx(struct uart_port * port)247*4882a593Smuzhiyun static void ulite_stop_tx(struct uart_port *port)
248*4882a593Smuzhiyun {
249*4882a593Smuzhiyun 	/* N/A */
250*4882a593Smuzhiyun }
251*4882a593Smuzhiyun 
ulite_start_tx(struct uart_port * port)252*4882a593Smuzhiyun static void ulite_start_tx(struct uart_port *port)
253*4882a593Smuzhiyun {
254*4882a593Smuzhiyun 	ulite_transmit(port, uart_in32(ULITE_STATUS, port));
255*4882a593Smuzhiyun }
256*4882a593Smuzhiyun 
ulite_stop_rx(struct uart_port * port)257*4882a593Smuzhiyun static void ulite_stop_rx(struct uart_port *port)
258*4882a593Smuzhiyun {
259*4882a593Smuzhiyun 	/* don't forward any more data (like !CREAD) */
260*4882a593Smuzhiyun 	port->ignore_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
261*4882a593Smuzhiyun 		| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
262*4882a593Smuzhiyun }
263*4882a593Smuzhiyun 
ulite_break_ctl(struct uart_port * port,int ctl)264*4882a593Smuzhiyun static void ulite_break_ctl(struct uart_port *port, int ctl)
265*4882a593Smuzhiyun {
266*4882a593Smuzhiyun 	/* N/A */
267*4882a593Smuzhiyun }
268*4882a593Smuzhiyun 
ulite_startup(struct uart_port * port)269*4882a593Smuzhiyun static int ulite_startup(struct uart_port *port)
270*4882a593Smuzhiyun {
271*4882a593Smuzhiyun 	struct uartlite_data *pdata = port->private_data;
272*4882a593Smuzhiyun 	int ret;
273*4882a593Smuzhiyun 
274*4882a593Smuzhiyun 	ret = clk_enable(pdata->clk);
275*4882a593Smuzhiyun 	if (ret) {
276*4882a593Smuzhiyun 		dev_err(port->dev, "Failed to enable clock\n");
277*4882a593Smuzhiyun 		return ret;
278*4882a593Smuzhiyun 	}
279*4882a593Smuzhiyun 
280*4882a593Smuzhiyun 	ret = request_irq(port->irq, ulite_isr, IRQF_SHARED | IRQF_TRIGGER_RISING,
281*4882a593Smuzhiyun 			  "uartlite", port);
282*4882a593Smuzhiyun 	if (ret)
283*4882a593Smuzhiyun 		return ret;
284*4882a593Smuzhiyun 
285*4882a593Smuzhiyun 	uart_out32(ULITE_CONTROL_RST_RX | ULITE_CONTROL_RST_TX,
286*4882a593Smuzhiyun 		ULITE_CONTROL, port);
287*4882a593Smuzhiyun 	uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
288*4882a593Smuzhiyun 
289*4882a593Smuzhiyun 	return 0;
290*4882a593Smuzhiyun }
291*4882a593Smuzhiyun 
ulite_shutdown(struct uart_port * port)292*4882a593Smuzhiyun static void ulite_shutdown(struct uart_port *port)
293*4882a593Smuzhiyun {
294*4882a593Smuzhiyun 	struct uartlite_data *pdata = port->private_data;
295*4882a593Smuzhiyun 
296*4882a593Smuzhiyun 	uart_out32(0, ULITE_CONTROL, port);
297*4882a593Smuzhiyun 	uart_in32(ULITE_CONTROL, port); /* dummy */
298*4882a593Smuzhiyun 	free_irq(port->irq, port);
299*4882a593Smuzhiyun 	clk_disable(pdata->clk);
300*4882a593Smuzhiyun }
301*4882a593Smuzhiyun 
ulite_set_termios(struct uart_port * port,struct ktermios * termios,struct ktermios * old)302*4882a593Smuzhiyun static void ulite_set_termios(struct uart_port *port, struct ktermios *termios,
303*4882a593Smuzhiyun 			      struct ktermios *old)
304*4882a593Smuzhiyun {
305*4882a593Smuzhiyun 	unsigned long flags;
306*4882a593Smuzhiyun 	unsigned int baud;
307*4882a593Smuzhiyun 
308*4882a593Smuzhiyun 	spin_lock_irqsave(&port->lock, flags);
309*4882a593Smuzhiyun 
310*4882a593Smuzhiyun 	port->read_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
311*4882a593Smuzhiyun 		| ULITE_STATUS_TXFULL;
312*4882a593Smuzhiyun 
313*4882a593Smuzhiyun 	if (termios->c_iflag & INPCK)
314*4882a593Smuzhiyun 		port->read_status_mask |=
315*4882a593Smuzhiyun 			ULITE_STATUS_PARITY | ULITE_STATUS_FRAME;
316*4882a593Smuzhiyun 
317*4882a593Smuzhiyun 	port->ignore_status_mask = 0;
318*4882a593Smuzhiyun 	if (termios->c_iflag & IGNPAR)
319*4882a593Smuzhiyun 		port->ignore_status_mask |= ULITE_STATUS_PARITY
320*4882a593Smuzhiyun 			| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
321*4882a593Smuzhiyun 
322*4882a593Smuzhiyun 	/* ignore all characters if CREAD is not set */
323*4882a593Smuzhiyun 	if ((termios->c_cflag & CREAD) == 0)
324*4882a593Smuzhiyun 		port->ignore_status_mask |=
325*4882a593Smuzhiyun 			ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
326*4882a593Smuzhiyun 			| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
327*4882a593Smuzhiyun 
328*4882a593Smuzhiyun 	/* update timeout */
329*4882a593Smuzhiyun 	baud = uart_get_baud_rate(port, termios, old, 0, 460800);
330*4882a593Smuzhiyun 	uart_update_timeout(port, termios->c_cflag, baud);
331*4882a593Smuzhiyun 
332*4882a593Smuzhiyun 	spin_unlock_irqrestore(&port->lock, flags);
333*4882a593Smuzhiyun }
334*4882a593Smuzhiyun 
ulite_type(struct uart_port * port)335*4882a593Smuzhiyun static const char *ulite_type(struct uart_port *port)
336*4882a593Smuzhiyun {
337*4882a593Smuzhiyun 	return port->type == PORT_UARTLITE ? "uartlite" : NULL;
338*4882a593Smuzhiyun }
339*4882a593Smuzhiyun 
ulite_release_port(struct uart_port * port)340*4882a593Smuzhiyun static void ulite_release_port(struct uart_port *port)
341*4882a593Smuzhiyun {
342*4882a593Smuzhiyun 	release_mem_region(port->mapbase, ULITE_REGION);
343*4882a593Smuzhiyun 	iounmap(port->membase);
344*4882a593Smuzhiyun 	port->membase = NULL;
345*4882a593Smuzhiyun }
346*4882a593Smuzhiyun 
ulite_request_port(struct uart_port * port)347*4882a593Smuzhiyun static int ulite_request_port(struct uart_port *port)
348*4882a593Smuzhiyun {
349*4882a593Smuzhiyun 	struct uartlite_data *pdata = port->private_data;
350*4882a593Smuzhiyun 	int ret;
351*4882a593Smuzhiyun 
352*4882a593Smuzhiyun 	pr_debug("ulite console: port=%p; port->mapbase=%llx\n",
353*4882a593Smuzhiyun 		 port, (unsigned long long) port->mapbase);
354*4882a593Smuzhiyun 
355*4882a593Smuzhiyun 	if (!request_mem_region(port->mapbase, ULITE_REGION, "uartlite")) {
356*4882a593Smuzhiyun 		dev_err(port->dev, "Memory region busy\n");
357*4882a593Smuzhiyun 		return -EBUSY;
358*4882a593Smuzhiyun 	}
359*4882a593Smuzhiyun 
360*4882a593Smuzhiyun 	port->membase = ioremap(port->mapbase, ULITE_REGION);
361*4882a593Smuzhiyun 	if (!port->membase) {
362*4882a593Smuzhiyun 		dev_err(port->dev, "Unable to map registers\n");
363*4882a593Smuzhiyun 		release_mem_region(port->mapbase, ULITE_REGION);
364*4882a593Smuzhiyun 		return -EBUSY;
365*4882a593Smuzhiyun 	}
366*4882a593Smuzhiyun 
367*4882a593Smuzhiyun 	pdata->reg_ops = &uartlite_be;
368*4882a593Smuzhiyun 	ret = uart_in32(ULITE_CONTROL, port);
369*4882a593Smuzhiyun 	uart_out32(ULITE_CONTROL_RST_TX, ULITE_CONTROL, port);
370*4882a593Smuzhiyun 	ret = uart_in32(ULITE_STATUS, port);
371*4882a593Smuzhiyun 	/* Endianess detection */
372*4882a593Smuzhiyun 	if ((ret & ULITE_STATUS_TXEMPTY) != ULITE_STATUS_TXEMPTY)
373*4882a593Smuzhiyun 		pdata->reg_ops = &uartlite_le;
374*4882a593Smuzhiyun 
375*4882a593Smuzhiyun 	return 0;
376*4882a593Smuzhiyun }
377*4882a593Smuzhiyun 
ulite_config_port(struct uart_port * port,int flags)378*4882a593Smuzhiyun static void ulite_config_port(struct uart_port *port, int flags)
379*4882a593Smuzhiyun {
380*4882a593Smuzhiyun 	if (!ulite_request_port(port))
381*4882a593Smuzhiyun 		port->type = PORT_UARTLITE;
382*4882a593Smuzhiyun }
383*4882a593Smuzhiyun 
ulite_verify_port(struct uart_port * port,struct serial_struct * ser)384*4882a593Smuzhiyun static int ulite_verify_port(struct uart_port *port, struct serial_struct *ser)
385*4882a593Smuzhiyun {
386*4882a593Smuzhiyun 	/* we don't want the core code to modify any port params */
387*4882a593Smuzhiyun 	return -EINVAL;
388*4882a593Smuzhiyun }
389*4882a593Smuzhiyun 
ulite_pm(struct uart_port * port,unsigned int state,unsigned int oldstate)390*4882a593Smuzhiyun static void ulite_pm(struct uart_port *port, unsigned int state,
391*4882a593Smuzhiyun 		     unsigned int oldstate)
392*4882a593Smuzhiyun {
393*4882a593Smuzhiyun 	struct uartlite_data *pdata = port->private_data;
394*4882a593Smuzhiyun 
395*4882a593Smuzhiyun 	if (!state)
396*4882a593Smuzhiyun 		clk_enable(pdata->clk);
397*4882a593Smuzhiyun 	else
398*4882a593Smuzhiyun 		clk_disable(pdata->clk);
399*4882a593Smuzhiyun }
400*4882a593Smuzhiyun 
401*4882a593Smuzhiyun #ifdef CONFIG_CONSOLE_POLL
ulite_get_poll_char(struct uart_port * port)402*4882a593Smuzhiyun static int ulite_get_poll_char(struct uart_port *port)
403*4882a593Smuzhiyun {
404*4882a593Smuzhiyun 	if (!(uart_in32(ULITE_STATUS, port) & ULITE_STATUS_RXVALID))
405*4882a593Smuzhiyun 		return NO_POLL_CHAR;
406*4882a593Smuzhiyun 
407*4882a593Smuzhiyun 	return uart_in32(ULITE_RX, port);
408*4882a593Smuzhiyun }
409*4882a593Smuzhiyun 
ulite_put_poll_char(struct uart_port * port,unsigned char ch)410*4882a593Smuzhiyun static void ulite_put_poll_char(struct uart_port *port, unsigned char ch)
411*4882a593Smuzhiyun {
412*4882a593Smuzhiyun 	while (uart_in32(ULITE_STATUS, port) & ULITE_STATUS_TXFULL)
413*4882a593Smuzhiyun 		cpu_relax();
414*4882a593Smuzhiyun 
415*4882a593Smuzhiyun 	/* write char to device */
416*4882a593Smuzhiyun 	uart_out32(ch, ULITE_TX, port);
417*4882a593Smuzhiyun }
418*4882a593Smuzhiyun #endif
419*4882a593Smuzhiyun 
420*4882a593Smuzhiyun static const struct uart_ops ulite_ops = {
421*4882a593Smuzhiyun 	.tx_empty	= ulite_tx_empty,
422*4882a593Smuzhiyun 	.set_mctrl	= ulite_set_mctrl,
423*4882a593Smuzhiyun 	.get_mctrl	= ulite_get_mctrl,
424*4882a593Smuzhiyun 	.stop_tx	= ulite_stop_tx,
425*4882a593Smuzhiyun 	.start_tx	= ulite_start_tx,
426*4882a593Smuzhiyun 	.stop_rx	= ulite_stop_rx,
427*4882a593Smuzhiyun 	.break_ctl	= ulite_break_ctl,
428*4882a593Smuzhiyun 	.startup	= ulite_startup,
429*4882a593Smuzhiyun 	.shutdown	= ulite_shutdown,
430*4882a593Smuzhiyun 	.set_termios	= ulite_set_termios,
431*4882a593Smuzhiyun 	.type		= ulite_type,
432*4882a593Smuzhiyun 	.release_port	= ulite_release_port,
433*4882a593Smuzhiyun 	.request_port	= ulite_request_port,
434*4882a593Smuzhiyun 	.config_port	= ulite_config_port,
435*4882a593Smuzhiyun 	.verify_port	= ulite_verify_port,
436*4882a593Smuzhiyun 	.pm		= ulite_pm,
437*4882a593Smuzhiyun #ifdef CONFIG_CONSOLE_POLL
438*4882a593Smuzhiyun 	.poll_get_char	= ulite_get_poll_char,
439*4882a593Smuzhiyun 	.poll_put_char	= ulite_put_poll_char,
440*4882a593Smuzhiyun #endif
441*4882a593Smuzhiyun };
442*4882a593Smuzhiyun 
443*4882a593Smuzhiyun /* ---------------------------------------------------------------------
444*4882a593Smuzhiyun  * Console driver operations
445*4882a593Smuzhiyun  */
446*4882a593Smuzhiyun 
447*4882a593Smuzhiyun #ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
ulite_console_wait_tx(struct uart_port * port)448*4882a593Smuzhiyun static void ulite_console_wait_tx(struct uart_port *port)
449*4882a593Smuzhiyun {
450*4882a593Smuzhiyun 	u8 val;
451*4882a593Smuzhiyun 	unsigned long timeout;
452*4882a593Smuzhiyun 
453*4882a593Smuzhiyun 	/*
454*4882a593Smuzhiyun 	 * Spin waiting for TX fifo to have space available.
455*4882a593Smuzhiyun 	 * When using the Microblaze Debug Module this can take up to 1s
456*4882a593Smuzhiyun 	 */
457*4882a593Smuzhiyun 	timeout = jiffies + msecs_to_jiffies(1000);
458*4882a593Smuzhiyun 	while (1) {
459*4882a593Smuzhiyun 		val = uart_in32(ULITE_STATUS, port);
460*4882a593Smuzhiyun 		if ((val & ULITE_STATUS_TXFULL) == 0)
461*4882a593Smuzhiyun 			break;
462*4882a593Smuzhiyun 		if (time_after(jiffies, timeout)) {
463*4882a593Smuzhiyun 			dev_warn(port->dev,
464*4882a593Smuzhiyun 				 "timeout waiting for TX buffer empty\n");
465*4882a593Smuzhiyun 			break;
466*4882a593Smuzhiyun 		}
467*4882a593Smuzhiyun 		cpu_relax();
468*4882a593Smuzhiyun 	}
469*4882a593Smuzhiyun }
470*4882a593Smuzhiyun 
ulite_console_putchar(struct uart_port * port,int ch)471*4882a593Smuzhiyun static void ulite_console_putchar(struct uart_port *port, int ch)
472*4882a593Smuzhiyun {
473*4882a593Smuzhiyun 	ulite_console_wait_tx(port);
474*4882a593Smuzhiyun 	uart_out32(ch, ULITE_TX, port);
475*4882a593Smuzhiyun }
476*4882a593Smuzhiyun 
ulite_console_write(struct console * co,const char * s,unsigned int count)477*4882a593Smuzhiyun static void ulite_console_write(struct console *co, const char *s,
478*4882a593Smuzhiyun 				unsigned int count)
479*4882a593Smuzhiyun {
480*4882a593Smuzhiyun 	struct uart_port *port = console_port;
481*4882a593Smuzhiyun 	unsigned long flags;
482*4882a593Smuzhiyun 	unsigned int ier;
483*4882a593Smuzhiyun 	int locked = 1;
484*4882a593Smuzhiyun 
485*4882a593Smuzhiyun 	if (oops_in_progress) {
486*4882a593Smuzhiyun 		locked = spin_trylock_irqsave(&port->lock, flags);
487*4882a593Smuzhiyun 	} else
488*4882a593Smuzhiyun 		spin_lock_irqsave(&port->lock, flags);
489*4882a593Smuzhiyun 
490*4882a593Smuzhiyun 	/* save and disable interrupt */
491*4882a593Smuzhiyun 	ier = uart_in32(ULITE_STATUS, port) & ULITE_STATUS_IE;
492*4882a593Smuzhiyun 	uart_out32(0, ULITE_CONTROL, port);
493*4882a593Smuzhiyun 
494*4882a593Smuzhiyun 	uart_console_write(port, s, count, ulite_console_putchar);
495*4882a593Smuzhiyun 
496*4882a593Smuzhiyun 	ulite_console_wait_tx(port);
497*4882a593Smuzhiyun 
498*4882a593Smuzhiyun 	/* restore interrupt state */
499*4882a593Smuzhiyun 	if (ier)
500*4882a593Smuzhiyun 		uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
501*4882a593Smuzhiyun 
502*4882a593Smuzhiyun 	if (locked)
503*4882a593Smuzhiyun 		spin_unlock_irqrestore(&port->lock, flags);
504*4882a593Smuzhiyun }
505*4882a593Smuzhiyun 
ulite_console_setup(struct console * co,char * options)506*4882a593Smuzhiyun static int ulite_console_setup(struct console *co, char *options)
507*4882a593Smuzhiyun {
508*4882a593Smuzhiyun 	struct uart_port *port = NULL;
509*4882a593Smuzhiyun 	int baud = 9600;
510*4882a593Smuzhiyun 	int bits = 8;
511*4882a593Smuzhiyun 	int parity = 'n';
512*4882a593Smuzhiyun 	int flow = 'n';
513*4882a593Smuzhiyun 
514*4882a593Smuzhiyun 	if (co->index >= 0 && co->index < ULITE_NR_UARTS)
515*4882a593Smuzhiyun 		port = ulite_ports + co->index;
516*4882a593Smuzhiyun 
517*4882a593Smuzhiyun 	/* Has the device been initialized yet? */
518*4882a593Smuzhiyun 	if (!port || !port->mapbase) {
519*4882a593Smuzhiyun 		pr_debug("console on ttyUL%i not present\n", co->index);
520*4882a593Smuzhiyun 		return -ENODEV;
521*4882a593Smuzhiyun 	}
522*4882a593Smuzhiyun 
523*4882a593Smuzhiyun 	console_port = port;
524*4882a593Smuzhiyun 
525*4882a593Smuzhiyun 	/* not initialized yet? */
526*4882a593Smuzhiyun 	if (!port->membase) {
527*4882a593Smuzhiyun 		if (ulite_request_port(port))
528*4882a593Smuzhiyun 			return -ENODEV;
529*4882a593Smuzhiyun 	}
530*4882a593Smuzhiyun 
531*4882a593Smuzhiyun 	if (options)
532*4882a593Smuzhiyun 		uart_parse_options(options, &baud, &parity, &bits, &flow);
533*4882a593Smuzhiyun 
534*4882a593Smuzhiyun 	return uart_set_options(port, co, baud, parity, bits, flow);
535*4882a593Smuzhiyun }
536*4882a593Smuzhiyun 
537*4882a593Smuzhiyun static struct uart_driver ulite_uart_driver;
538*4882a593Smuzhiyun 
539*4882a593Smuzhiyun static struct console ulite_console = {
540*4882a593Smuzhiyun 	.name	= ULITE_NAME,
541*4882a593Smuzhiyun 	.write	= ulite_console_write,
542*4882a593Smuzhiyun 	.device	= uart_console_device,
543*4882a593Smuzhiyun 	.setup	= ulite_console_setup,
544*4882a593Smuzhiyun 	.flags	= CON_PRINTBUFFER,
545*4882a593Smuzhiyun 	.index	= -1, /* Specified on the cmdline (e.g. console=ttyUL0 ) */
546*4882a593Smuzhiyun 	.data	= &ulite_uart_driver,
547*4882a593Smuzhiyun };
548*4882a593Smuzhiyun 
early_uartlite_putc(struct uart_port * port,int c)549*4882a593Smuzhiyun static void early_uartlite_putc(struct uart_port *port, int c)
550*4882a593Smuzhiyun {
551*4882a593Smuzhiyun 	/*
552*4882a593Smuzhiyun 	 * Limit how many times we'll spin waiting for TX FIFO status.
553*4882a593Smuzhiyun 	 * This will prevent lockups if the base address is incorrectly
554*4882a593Smuzhiyun 	 * set, or any other issue on the UARTLITE.
555*4882a593Smuzhiyun 	 * This limit is pretty arbitrary, unless we are at about 10 baud
556*4882a593Smuzhiyun 	 * we'll never timeout on a working UART.
557*4882a593Smuzhiyun 	 */
558*4882a593Smuzhiyun 
559*4882a593Smuzhiyun 	unsigned retries = 1000000;
560*4882a593Smuzhiyun 	/* read status bit - 0x8 offset */
561*4882a593Smuzhiyun 	while (--retries && (readl(port->membase + 8) & (1 << 3)))
562*4882a593Smuzhiyun 		;
563*4882a593Smuzhiyun 
564*4882a593Smuzhiyun 	/* Only attempt the iowrite if we didn't timeout */
565*4882a593Smuzhiyun 	/* write to TX_FIFO - 0x4 offset */
566*4882a593Smuzhiyun 	if (retries)
567*4882a593Smuzhiyun 		writel(c & 0xff, port->membase + 4);
568*4882a593Smuzhiyun }
569*4882a593Smuzhiyun 
early_uartlite_write(struct console * console,const char * s,unsigned n)570*4882a593Smuzhiyun static void early_uartlite_write(struct console *console,
571*4882a593Smuzhiyun 				 const char *s, unsigned n)
572*4882a593Smuzhiyun {
573*4882a593Smuzhiyun 	struct earlycon_device *device = console->data;
574*4882a593Smuzhiyun 	uart_console_write(&device->port, s, n, early_uartlite_putc);
575*4882a593Smuzhiyun }
576*4882a593Smuzhiyun 
early_uartlite_setup(struct earlycon_device * device,const char * options)577*4882a593Smuzhiyun static int __init early_uartlite_setup(struct earlycon_device *device,
578*4882a593Smuzhiyun 				       const char *options)
579*4882a593Smuzhiyun {
580*4882a593Smuzhiyun 	if (!device->port.membase)
581*4882a593Smuzhiyun 		return -ENODEV;
582*4882a593Smuzhiyun 
583*4882a593Smuzhiyun 	device->con->write = early_uartlite_write;
584*4882a593Smuzhiyun 	return 0;
585*4882a593Smuzhiyun }
586*4882a593Smuzhiyun EARLYCON_DECLARE(uartlite, early_uartlite_setup);
587*4882a593Smuzhiyun OF_EARLYCON_DECLARE(uartlite_b, "xlnx,opb-uartlite-1.00.b", early_uartlite_setup);
588*4882a593Smuzhiyun OF_EARLYCON_DECLARE(uartlite_a, "xlnx,xps-uartlite-1.00.a", early_uartlite_setup);
589*4882a593Smuzhiyun 
590*4882a593Smuzhiyun #endif /* CONFIG_SERIAL_UARTLITE_CONSOLE */
591*4882a593Smuzhiyun 
592*4882a593Smuzhiyun static struct uart_driver ulite_uart_driver = {
593*4882a593Smuzhiyun 	.owner		= THIS_MODULE,
594*4882a593Smuzhiyun 	.driver_name	= "uartlite",
595*4882a593Smuzhiyun 	.dev_name	= ULITE_NAME,
596*4882a593Smuzhiyun 	.major		= ULITE_MAJOR,
597*4882a593Smuzhiyun 	.minor		= ULITE_MINOR,
598*4882a593Smuzhiyun 	.nr		= ULITE_NR_UARTS,
599*4882a593Smuzhiyun #ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
600*4882a593Smuzhiyun 	.cons		= &ulite_console,
601*4882a593Smuzhiyun #endif
602*4882a593Smuzhiyun };
603*4882a593Smuzhiyun 
604*4882a593Smuzhiyun /* ---------------------------------------------------------------------
605*4882a593Smuzhiyun  * Port assignment functions (mapping devices to uart_port structures)
606*4882a593Smuzhiyun  */
607*4882a593Smuzhiyun 
608*4882a593Smuzhiyun /** ulite_assign: register a uartlite device with the driver
609*4882a593Smuzhiyun  *
610*4882a593Smuzhiyun  * @dev: pointer to device structure
611*4882a593Smuzhiyun  * @id: requested id number.  Pass -1 for automatic port assignment
612*4882a593Smuzhiyun  * @base: base address of uartlite registers
613*4882a593Smuzhiyun  * @irq: irq number for uartlite
614*4882a593Smuzhiyun  * @pdata: private data for uartlite
615*4882a593Smuzhiyun  *
616*4882a593Smuzhiyun  * Returns: 0 on success, <0 otherwise
617*4882a593Smuzhiyun  */
ulite_assign(struct device * dev,int id,phys_addr_t base,int irq,struct uartlite_data * pdata)618*4882a593Smuzhiyun static int ulite_assign(struct device *dev, int id, phys_addr_t base, int irq,
619*4882a593Smuzhiyun 			struct uartlite_data *pdata)
620*4882a593Smuzhiyun {
621*4882a593Smuzhiyun 	struct uart_port *port;
622*4882a593Smuzhiyun 	int rc;
623*4882a593Smuzhiyun 
624*4882a593Smuzhiyun 	/* if id = -1; then scan for a free id and use that */
625*4882a593Smuzhiyun 	if (id < 0) {
626*4882a593Smuzhiyun 		for (id = 0; id < ULITE_NR_UARTS; id++)
627*4882a593Smuzhiyun 			if (ulite_ports[id].mapbase == 0)
628*4882a593Smuzhiyun 				break;
629*4882a593Smuzhiyun 	}
630*4882a593Smuzhiyun 	if (id < 0 || id >= ULITE_NR_UARTS) {
631*4882a593Smuzhiyun 		dev_err(dev, "%s%i too large\n", ULITE_NAME, id);
632*4882a593Smuzhiyun 		return -EINVAL;
633*4882a593Smuzhiyun 	}
634*4882a593Smuzhiyun 
635*4882a593Smuzhiyun 	if ((ulite_ports[id].mapbase) && (ulite_ports[id].mapbase != base)) {
636*4882a593Smuzhiyun 		dev_err(dev, "cannot assign to %s%i; it is already in use\n",
637*4882a593Smuzhiyun 			ULITE_NAME, id);
638*4882a593Smuzhiyun 		return -EBUSY;
639*4882a593Smuzhiyun 	}
640*4882a593Smuzhiyun 
641*4882a593Smuzhiyun 	port = &ulite_ports[id];
642*4882a593Smuzhiyun 
643*4882a593Smuzhiyun 	spin_lock_init(&port->lock);
644*4882a593Smuzhiyun 	port->fifosize = 16;
645*4882a593Smuzhiyun 	port->regshift = 2;
646*4882a593Smuzhiyun 	port->iotype = UPIO_MEM;
647*4882a593Smuzhiyun 	port->iobase = 1; /* mark port in use */
648*4882a593Smuzhiyun 	port->mapbase = base;
649*4882a593Smuzhiyun 	port->membase = NULL;
650*4882a593Smuzhiyun 	port->ops = &ulite_ops;
651*4882a593Smuzhiyun 	port->irq = irq;
652*4882a593Smuzhiyun 	port->flags = UPF_BOOT_AUTOCONF;
653*4882a593Smuzhiyun 	port->dev = dev;
654*4882a593Smuzhiyun 	port->type = PORT_UNKNOWN;
655*4882a593Smuzhiyun 	port->line = id;
656*4882a593Smuzhiyun 	port->private_data = pdata;
657*4882a593Smuzhiyun 
658*4882a593Smuzhiyun 	dev_set_drvdata(dev, port);
659*4882a593Smuzhiyun 
660*4882a593Smuzhiyun 	/* Register the port */
661*4882a593Smuzhiyun 	rc = uart_add_one_port(&ulite_uart_driver, port);
662*4882a593Smuzhiyun 	if (rc) {
663*4882a593Smuzhiyun 		dev_err(dev, "uart_add_one_port() failed; err=%i\n", rc);
664*4882a593Smuzhiyun 		port->mapbase = 0;
665*4882a593Smuzhiyun 		dev_set_drvdata(dev, NULL);
666*4882a593Smuzhiyun 		return rc;
667*4882a593Smuzhiyun 	}
668*4882a593Smuzhiyun 
669*4882a593Smuzhiyun 	return 0;
670*4882a593Smuzhiyun }
671*4882a593Smuzhiyun 
672*4882a593Smuzhiyun /** ulite_release: register a uartlite device with the driver
673*4882a593Smuzhiyun  *
674*4882a593Smuzhiyun  * @dev: pointer to device structure
675*4882a593Smuzhiyun  */
ulite_release(struct device * dev)676*4882a593Smuzhiyun static int ulite_release(struct device *dev)
677*4882a593Smuzhiyun {
678*4882a593Smuzhiyun 	struct uart_port *port = dev_get_drvdata(dev);
679*4882a593Smuzhiyun 	int rc = 0;
680*4882a593Smuzhiyun 
681*4882a593Smuzhiyun 	if (port) {
682*4882a593Smuzhiyun 		rc = uart_remove_one_port(&ulite_uart_driver, port);
683*4882a593Smuzhiyun 		dev_set_drvdata(dev, NULL);
684*4882a593Smuzhiyun 		port->mapbase = 0;
685*4882a593Smuzhiyun 	}
686*4882a593Smuzhiyun 
687*4882a593Smuzhiyun 	return rc;
688*4882a593Smuzhiyun }
689*4882a593Smuzhiyun 
690*4882a593Smuzhiyun /**
691*4882a593Smuzhiyun  * ulite_suspend - Stop the device.
692*4882a593Smuzhiyun  *
693*4882a593Smuzhiyun  * @dev: handle to the device structure.
694*4882a593Smuzhiyun  * Return: 0 always.
695*4882a593Smuzhiyun  */
ulite_suspend(struct device * dev)696*4882a593Smuzhiyun static int __maybe_unused ulite_suspend(struct device *dev)
697*4882a593Smuzhiyun {
698*4882a593Smuzhiyun 	struct uart_port *port = dev_get_drvdata(dev);
699*4882a593Smuzhiyun 
700*4882a593Smuzhiyun 	if (port)
701*4882a593Smuzhiyun 		uart_suspend_port(&ulite_uart_driver, port);
702*4882a593Smuzhiyun 
703*4882a593Smuzhiyun 	return 0;
704*4882a593Smuzhiyun }
705*4882a593Smuzhiyun 
706*4882a593Smuzhiyun /**
707*4882a593Smuzhiyun  * ulite_resume - Resume the device.
708*4882a593Smuzhiyun  *
709*4882a593Smuzhiyun  * @dev: handle to the device structure.
710*4882a593Smuzhiyun  * Return: 0 on success, errno otherwise.
711*4882a593Smuzhiyun  */
ulite_resume(struct device * dev)712*4882a593Smuzhiyun static int __maybe_unused ulite_resume(struct device *dev)
713*4882a593Smuzhiyun {
714*4882a593Smuzhiyun 	struct uart_port *port = dev_get_drvdata(dev);
715*4882a593Smuzhiyun 
716*4882a593Smuzhiyun 	if (port)
717*4882a593Smuzhiyun 		uart_resume_port(&ulite_uart_driver, port);
718*4882a593Smuzhiyun 
719*4882a593Smuzhiyun 	return 0;
720*4882a593Smuzhiyun }
721*4882a593Smuzhiyun 
722*4882a593Smuzhiyun /* ---------------------------------------------------------------------
723*4882a593Smuzhiyun  * Platform bus binding
724*4882a593Smuzhiyun  */
725*4882a593Smuzhiyun 
726*4882a593Smuzhiyun static SIMPLE_DEV_PM_OPS(ulite_pm_ops, ulite_suspend, ulite_resume);
727*4882a593Smuzhiyun 
728*4882a593Smuzhiyun #if defined(CONFIG_OF)
729*4882a593Smuzhiyun /* Match table for of_platform binding */
730*4882a593Smuzhiyun static const struct of_device_id ulite_of_match[] = {
731*4882a593Smuzhiyun 	{ .compatible = "xlnx,opb-uartlite-1.00.b", },
732*4882a593Smuzhiyun 	{ .compatible = "xlnx,xps-uartlite-1.00.a", },
733*4882a593Smuzhiyun 	{}
734*4882a593Smuzhiyun };
735*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, ulite_of_match);
736*4882a593Smuzhiyun #endif /* CONFIG_OF */
737*4882a593Smuzhiyun 
ulite_probe(struct platform_device * pdev)738*4882a593Smuzhiyun static int ulite_probe(struct platform_device *pdev)
739*4882a593Smuzhiyun {
740*4882a593Smuzhiyun 	struct resource *res;
741*4882a593Smuzhiyun 	struct uartlite_data *pdata;
742*4882a593Smuzhiyun 	int irq, ret;
743*4882a593Smuzhiyun 	int id = pdev->id;
744*4882a593Smuzhiyun #ifdef CONFIG_OF
745*4882a593Smuzhiyun 	const __be32 *prop;
746*4882a593Smuzhiyun 
747*4882a593Smuzhiyun 	prop = of_get_property(pdev->dev.of_node, "port-number", NULL);
748*4882a593Smuzhiyun 	if (prop)
749*4882a593Smuzhiyun 		id = be32_to_cpup(prop);
750*4882a593Smuzhiyun #endif
751*4882a593Smuzhiyun 	pdata = devm_kzalloc(&pdev->dev, sizeof(struct uartlite_data),
752*4882a593Smuzhiyun 			     GFP_KERNEL);
753*4882a593Smuzhiyun 	if (!pdata)
754*4882a593Smuzhiyun 		return -ENOMEM;
755*4882a593Smuzhiyun 
756*4882a593Smuzhiyun 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
757*4882a593Smuzhiyun 	if (!res)
758*4882a593Smuzhiyun 		return -ENODEV;
759*4882a593Smuzhiyun 
760*4882a593Smuzhiyun 	irq = platform_get_irq(pdev, 0);
761*4882a593Smuzhiyun 	if (irq <= 0)
762*4882a593Smuzhiyun 		return -ENXIO;
763*4882a593Smuzhiyun 
764*4882a593Smuzhiyun 	pdata->clk = devm_clk_get(&pdev->dev, "s_axi_aclk");
765*4882a593Smuzhiyun 	if (IS_ERR(pdata->clk)) {
766*4882a593Smuzhiyun 		if (PTR_ERR(pdata->clk) != -ENOENT)
767*4882a593Smuzhiyun 			return PTR_ERR(pdata->clk);
768*4882a593Smuzhiyun 
769*4882a593Smuzhiyun 		/*
770*4882a593Smuzhiyun 		 * Clock framework support is optional, continue on
771*4882a593Smuzhiyun 		 * anyways if we don't find a matching clock.
772*4882a593Smuzhiyun 		 */
773*4882a593Smuzhiyun 		pdata->clk = NULL;
774*4882a593Smuzhiyun 	}
775*4882a593Smuzhiyun 
776*4882a593Smuzhiyun 	ret = clk_prepare_enable(pdata->clk);
777*4882a593Smuzhiyun 	if (ret) {
778*4882a593Smuzhiyun 		dev_err(&pdev->dev, "Failed to prepare clock\n");
779*4882a593Smuzhiyun 		return ret;
780*4882a593Smuzhiyun 	}
781*4882a593Smuzhiyun 
782*4882a593Smuzhiyun 	if (!ulite_uart_driver.state) {
783*4882a593Smuzhiyun 		dev_dbg(&pdev->dev, "uartlite: calling uart_register_driver()\n");
784*4882a593Smuzhiyun 		ret = uart_register_driver(&ulite_uart_driver);
785*4882a593Smuzhiyun 		if (ret < 0) {
786*4882a593Smuzhiyun 			dev_err(&pdev->dev, "Failed to register driver\n");
787*4882a593Smuzhiyun 			return ret;
788*4882a593Smuzhiyun 		}
789*4882a593Smuzhiyun 	}
790*4882a593Smuzhiyun 
791*4882a593Smuzhiyun 	ret = ulite_assign(&pdev->dev, id, res->start, irq, pdata);
792*4882a593Smuzhiyun 
793*4882a593Smuzhiyun 	clk_disable(pdata->clk);
794*4882a593Smuzhiyun 
795*4882a593Smuzhiyun 	return ret;
796*4882a593Smuzhiyun }
797*4882a593Smuzhiyun 
ulite_remove(struct platform_device * pdev)798*4882a593Smuzhiyun static int ulite_remove(struct platform_device *pdev)
799*4882a593Smuzhiyun {
800*4882a593Smuzhiyun 	struct uart_port *port = dev_get_drvdata(&pdev->dev);
801*4882a593Smuzhiyun 	struct uartlite_data *pdata = port->private_data;
802*4882a593Smuzhiyun 
803*4882a593Smuzhiyun 	clk_disable_unprepare(pdata->clk);
804*4882a593Smuzhiyun 	return ulite_release(&pdev->dev);
805*4882a593Smuzhiyun }
806*4882a593Smuzhiyun 
807*4882a593Smuzhiyun /* work with hotplug and coldplug */
808*4882a593Smuzhiyun MODULE_ALIAS("platform:uartlite");
809*4882a593Smuzhiyun 
810*4882a593Smuzhiyun static struct platform_driver ulite_platform_driver = {
811*4882a593Smuzhiyun 	.probe = ulite_probe,
812*4882a593Smuzhiyun 	.remove = ulite_remove,
813*4882a593Smuzhiyun 	.driver = {
814*4882a593Smuzhiyun 		.name  = "uartlite",
815*4882a593Smuzhiyun 		.of_match_table = of_match_ptr(ulite_of_match),
816*4882a593Smuzhiyun 		.pm = &ulite_pm_ops,
817*4882a593Smuzhiyun 	},
818*4882a593Smuzhiyun };
819*4882a593Smuzhiyun 
820*4882a593Smuzhiyun /* ---------------------------------------------------------------------
821*4882a593Smuzhiyun  * Module setup/teardown
822*4882a593Smuzhiyun  */
823*4882a593Smuzhiyun 
ulite_init(void)824*4882a593Smuzhiyun static int __init ulite_init(void)
825*4882a593Smuzhiyun {
826*4882a593Smuzhiyun 
827*4882a593Smuzhiyun 	pr_debug("uartlite: calling platform_driver_register()\n");
828*4882a593Smuzhiyun 	return platform_driver_register(&ulite_platform_driver);
829*4882a593Smuzhiyun }
830*4882a593Smuzhiyun 
ulite_exit(void)831*4882a593Smuzhiyun static void __exit ulite_exit(void)
832*4882a593Smuzhiyun {
833*4882a593Smuzhiyun 	platform_driver_unregister(&ulite_platform_driver);
834*4882a593Smuzhiyun 	if (ulite_uart_driver.state)
835*4882a593Smuzhiyun 		uart_unregister_driver(&ulite_uart_driver);
836*4882a593Smuzhiyun }
837*4882a593Smuzhiyun 
838*4882a593Smuzhiyun module_init(ulite_init);
839*4882a593Smuzhiyun module_exit(ulite_exit);
840*4882a593Smuzhiyun 
841*4882a593Smuzhiyun MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
842*4882a593Smuzhiyun MODULE_DESCRIPTION("Xilinx uartlite serial driver");
843*4882a593Smuzhiyun MODULE_LICENSE("GPL");
844