xref: /linux/drivers/tty/serial/uartlite.c (revision ed623dffdeebcc0acac7be6af4a301ee7169cd21)
1e3b3d0f5SGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0
2ab4382d2SGreg Kroah-Hartman /*
3ab4382d2SGreg Kroah-Hartman  * uartlite.c: Serial driver for Xilinx uartlite serial controller
4ab4382d2SGreg Kroah-Hartman  *
5ab4382d2SGreg Kroah-Hartman  * Copyright (C) 2006 Peter Korsgaard <jacmet@sunsite.dk>
6ab4382d2SGreg Kroah-Hartman  * Copyright (C) 2007 Secret Lab Technologies Ltd.
7ab4382d2SGreg Kroah-Hartman  */
8ab4382d2SGreg Kroah-Hartman 
9ab4382d2SGreg Kroah-Hartman #include <linux/platform_device.h>
10ab4382d2SGreg Kroah-Hartman #include <linux/module.h>
11ab4382d2SGreg Kroah-Hartman #include <linux/console.h>
12ab4382d2SGreg Kroah-Hartman #include <linux/serial.h>
13ab4382d2SGreg Kroah-Hartman #include <linux/serial_core.h>
14ab4382d2SGreg Kroah-Hartman #include <linux/tty.h>
15ee160a38SJiri Slaby #include <linux/tty_flip.h>
16ab4382d2SGreg Kroah-Hartman #include <linux/delay.h>
17ab4382d2SGreg Kroah-Hartman #include <linux/interrupt.h>
18ab4382d2SGreg Kroah-Hartman #include <linux/init.h>
193240b48dSMichal Simek #include <linux/io.h>
20ab4382d2SGreg Kroah-Hartman #include <linux/of.h>
21ab4382d2SGreg Kroah-Hartman #include <linux/of_address.h>
22ab4382d2SGreg Kroah-Hartman #include <linux/of_device.h>
23ab4382d2SGreg Kroah-Hartman #include <linux/of_platform.h>
2414288befSShubhrajyoti Datta #include <linux/clk.h>
25ab4382d2SGreg Kroah-Hartman 
26ab4382d2SGreg Kroah-Hartman #define ULITE_NAME		"ttyUL"
27ab4382d2SGreg Kroah-Hartman #define ULITE_MAJOR		204
28ab4382d2SGreg Kroah-Hartman #define ULITE_MINOR		187
29b44b96a0SSam Povilus #define ULITE_NR_UARTS		CONFIG_SERIAL_UARTLITE_NR_UARTS
30ab4382d2SGreg Kroah-Hartman 
31ab4382d2SGreg Kroah-Hartman /* ---------------------------------------------------------------------
32ab4382d2SGreg Kroah-Hartman  * Register definitions
33ab4382d2SGreg Kroah-Hartman  *
34ab4382d2SGreg Kroah-Hartman  * For register details see datasheet:
3582ee0b14SAlexander A. Klimov  * https://www.xilinx.com/support/documentation/ip_documentation/opb_uartlite.pdf
36ab4382d2SGreg Kroah-Hartman  */
37ab4382d2SGreg Kroah-Hartman 
38ab4382d2SGreg Kroah-Hartman #define ULITE_RX		0x00
39ab4382d2SGreg Kroah-Hartman #define ULITE_TX		0x04
40ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS		0x08
41ab4382d2SGreg Kroah-Hartman #define ULITE_CONTROL		0x0c
42ab4382d2SGreg Kroah-Hartman 
43ab4382d2SGreg Kroah-Hartman #define ULITE_REGION		16
44ab4382d2SGreg Kroah-Hartman 
45ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS_RXVALID	0x01
46ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS_RXFULL	0x02
47ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS_TXEMPTY	0x04
48ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS_TXFULL	0x08
49ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS_IE		0x10
50ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS_OVERRUN	0x20
51ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS_FRAME	0x40
52ab4382d2SGreg Kroah-Hartman #define ULITE_STATUS_PARITY	0x80
53ab4382d2SGreg Kroah-Hartman 
54ab4382d2SGreg Kroah-Hartman #define ULITE_CONTROL_RST_TX	0x01
55ab4382d2SGreg Kroah-Hartman #define ULITE_CONTROL_RST_RX	0x02
56ab4382d2SGreg Kroah-Hartman #define ULITE_CONTROL_IE	0x10
57ab4382d2SGreg Kroah-Hartman 
58deeb33e8SShubhrajyoti Datta /* Static pointer to console port */
59deeb33e8SShubhrajyoti Datta #ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
60deeb33e8SShubhrajyoti Datta static struct uart_port *console_port;
61deeb33e8SShubhrajyoti Datta #endif
62deeb33e8SShubhrajyoti Datta 
63da7bf20eSShubhrajyoti Datta struct uartlite_data {
64da7bf20eSShubhrajyoti Datta 	const struct uartlite_reg_ops *reg_ops;
6514288befSShubhrajyoti Datta 	struct clk *clk;
66da7bf20eSShubhrajyoti Datta };
67da7bf20eSShubhrajyoti Datta 
686d53c3b7SMichal Simek struct uartlite_reg_ops {
696d53c3b7SMichal Simek 	u32 (*in)(void __iomem *addr);
706d53c3b7SMichal Simek 	void (*out)(u32 val, void __iomem *addr);
716d53c3b7SMichal Simek };
726d53c3b7SMichal Simek 
736d53c3b7SMichal Simek static u32 uartlite_inbe32(void __iomem *addr)
746d53c3b7SMichal Simek {
756d53c3b7SMichal Simek 	return ioread32be(addr);
766d53c3b7SMichal Simek }
776d53c3b7SMichal Simek 
786d53c3b7SMichal Simek static void uartlite_outbe32(u32 val, void __iomem *addr)
796d53c3b7SMichal Simek {
806d53c3b7SMichal Simek 	iowrite32be(val, addr);
816d53c3b7SMichal Simek }
826d53c3b7SMichal Simek 
83973ea59eSMaarten Brock static const struct uartlite_reg_ops uartlite_be = {
846d53c3b7SMichal Simek 	.in = uartlite_inbe32,
856d53c3b7SMichal Simek 	.out = uartlite_outbe32,
866d53c3b7SMichal Simek };
876d53c3b7SMichal Simek 
886d53c3b7SMichal Simek static u32 uartlite_inle32(void __iomem *addr)
896d53c3b7SMichal Simek {
906d53c3b7SMichal Simek 	return ioread32(addr);
916d53c3b7SMichal Simek }
926d53c3b7SMichal Simek 
936d53c3b7SMichal Simek static void uartlite_outle32(u32 val, void __iomem *addr)
946d53c3b7SMichal Simek {
956d53c3b7SMichal Simek 	iowrite32(val, addr);
966d53c3b7SMichal Simek }
976d53c3b7SMichal Simek 
98973ea59eSMaarten Brock static const struct uartlite_reg_ops uartlite_le = {
996d53c3b7SMichal Simek 	.in = uartlite_inle32,
1006d53c3b7SMichal Simek 	.out = uartlite_outle32,
1016d53c3b7SMichal Simek };
1026d53c3b7SMichal Simek 
1036d53c3b7SMichal Simek static inline u32 uart_in32(u32 offset, struct uart_port *port)
1046d53c3b7SMichal Simek {
105da7bf20eSShubhrajyoti Datta 	struct uartlite_data *pdata = port->private_data;
1066d53c3b7SMichal Simek 
107da7bf20eSShubhrajyoti Datta 	return pdata->reg_ops->in(port->membase + offset);
1086d53c3b7SMichal Simek }
1096d53c3b7SMichal Simek 
1106d53c3b7SMichal Simek static inline void uart_out32(u32 val, u32 offset, struct uart_port *port)
1116d53c3b7SMichal Simek {
112da7bf20eSShubhrajyoti Datta 	struct uartlite_data *pdata = port->private_data;
1136d53c3b7SMichal Simek 
114da7bf20eSShubhrajyoti Datta 	pdata->reg_ops->out(val, port->membase + offset);
1156d53c3b7SMichal Simek }
116ab4382d2SGreg Kroah-Hartman 
117ab4382d2SGreg Kroah-Hartman static struct uart_port ulite_ports[ULITE_NR_UARTS];
118ab4382d2SGreg Kroah-Hartman 
119ab4382d2SGreg Kroah-Hartman /* ---------------------------------------------------------------------
120ab4382d2SGreg Kroah-Hartman  * Core UART driver operations
121ab4382d2SGreg Kroah-Hartman  */
122ab4382d2SGreg Kroah-Hartman 
123ab4382d2SGreg Kroah-Hartman static int ulite_receive(struct uart_port *port, int stat)
124ab4382d2SGreg Kroah-Hartman {
12592a19f9cSJiri Slaby 	struct tty_port *tport = &port->state->port;
126ab4382d2SGreg Kroah-Hartman 	unsigned char ch = 0;
127ab4382d2SGreg Kroah-Hartman 	char flag = TTY_NORMAL;
128ab4382d2SGreg Kroah-Hartman 
129ab4382d2SGreg Kroah-Hartman 	if ((stat & (ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
130ab4382d2SGreg Kroah-Hartman 		     | ULITE_STATUS_FRAME)) == 0)
131ab4382d2SGreg Kroah-Hartman 		return 0;
132ab4382d2SGreg Kroah-Hartman 
133ab4382d2SGreg Kroah-Hartman 	/* stats */
134ab4382d2SGreg Kroah-Hartman 	if (stat & ULITE_STATUS_RXVALID) {
135ab4382d2SGreg Kroah-Hartman 		port->icount.rx++;
1366d53c3b7SMichal Simek 		ch = uart_in32(ULITE_RX, port);
137ab4382d2SGreg Kroah-Hartman 
138ab4382d2SGreg Kroah-Hartman 		if (stat & ULITE_STATUS_PARITY)
139ab4382d2SGreg Kroah-Hartman 			port->icount.parity++;
140ab4382d2SGreg Kroah-Hartman 	}
141ab4382d2SGreg Kroah-Hartman 
142ab4382d2SGreg Kroah-Hartman 	if (stat & ULITE_STATUS_OVERRUN)
143ab4382d2SGreg Kroah-Hartman 		port->icount.overrun++;
144ab4382d2SGreg Kroah-Hartman 
145ab4382d2SGreg Kroah-Hartman 	if (stat & ULITE_STATUS_FRAME)
146ab4382d2SGreg Kroah-Hartman 		port->icount.frame++;
147ab4382d2SGreg Kroah-Hartman 
148ab4382d2SGreg Kroah-Hartman 
149ab4382d2SGreg Kroah-Hartman 	/* drop byte with parity error if IGNPAR specificed */
150ab4382d2SGreg Kroah-Hartman 	if (stat & port->ignore_status_mask & ULITE_STATUS_PARITY)
151ab4382d2SGreg Kroah-Hartman 		stat &= ~ULITE_STATUS_RXVALID;
152ab4382d2SGreg Kroah-Hartman 
153ab4382d2SGreg Kroah-Hartman 	stat &= port->read_status_mask;
154ab4382d2SGreg Kroah-Hartman 
155ab4382d2SGreg Kroah-Hartman 	if (stat & ULITE_STATUS_PARITY)
156ab4382d2SGreg Kroah-Hartman 		flag = TTY_PARITY;
157ab4382d2SGreg Kroah-Hartman 
158ab4382d2SGreg Kroah-Hartman 
159ab4382d2SGreg Kroah-Hartman 	stat &= ~port->ignore_status_mask;
160ab4382d2SGreg Kroah-Hartman 
161ab4382d2SGreg Kroah-Hartman 	if (stat & ULITE_STATUS_RXVALID)
16292a19f9cSJiri Slaby 		tty_insert_flip_char(tport, ch, flag);
163ab4382d2SGreg Kroah-Hartman 
164ab4382d2SGreg Kroah-Hartman 	if (stat & ULITE_STATUS_FRAME)
16592a19f9cSJiri Slaby 		tty_insert_flip_char(tport, 0, TTY_FRAME);
166ab4382d2SGreg Kroah-Hartman 
167ab4382d2SGreg Kroah-Hartman 	if (stat & ULITE_STATUS_OVERRUN)
16892a19f9cSJiri Slaby 		tty_insert_flip_char(tport, 0, TTY_OVERRUN);
169ab4382d2SGreg Kroah-Hartman 
170ab4382d2SGreg Kroah-Hartman 	return 1;
171ab4382d2SGreg Kroah-Hartman }
172ab4382d2SGreg Kroah-Hartman 
173ab4382d2SGreg Kroah-Hartman static int ulite_transmit(struct uart_port *port, int stat)
174ab4382d2SGreg Kroah-Hartman {
175ab4382d2SGreg Kroah-Hartman 	struct circ_buf *xmit  = &port->state->xmit;
176ab4382d2SGreg Kroah-Hartman 
177ab4382d2SGreg Kroah-Hartman 	if (stat & ULITE_STATUS_TXFULL)
178ab4382d2SGreg Kroah-Hartman 		return 0;
179ab4382d2SGreg Kroah-Hartman 
180ab4382d2SGreg Kroah-Hartman 	if (port->x_char) {
1816d53c3b7SMichal Simek 		uart_out32(port->x_char, ULITE_TX, port);
182ab4382d2SGreg Kroah-Hartman 		port->x_char = 0;
183ab4382d2SGreg Kroah-Hartman 		port->icount.tx++;
184ab4382d2SGreg Kroah-Hartman 		return 1;
185ab4382d2SGreg Kroah-Hartman 	}
186ab4382d2SGreg Kroah-Hartman 
187ab4382d2SGreg Kroah-Hartman 	if (uart_circ_empty(xmit) || uart_tx_stopped(port))
188ab4382d2SGreg Kroah-Hartman 		return 0;
189ab4382d2SGreg Kroah-Hartman 
1906d53c3b7SMichal Simek 	uart_out32(xmit->buf[xmit->tail], ULITE_TX, port);
191ab4382d2SGreg Kroah-Hartman 	xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE-1);
192ab4382d2SGreg Kroah-Hartman 	port->icount.tx++;
193ab4382d2SGreg Kroah-Hartman 
194ab4382d2SGreg Kroah-Hartman 	/* wake up */
195ab4382d2SGreg Kroah-Hartman 	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
196ab4382d2SGreg Kroah-Hartman 		uart_write_wakeup(port);
197ab4382d2SGreg Kroah-Hartman 
198ab4382d2SGreg Kroah-Hartman 	return 1;
199ab4382d2SGreg Kroah-Hartman }
200ab4382d2SGreg Kroah-Hartman 
201ab4382d2SGreg Kroah-Hartman static irqreturn_t ulite_isr(int irq, void *dev_id)
202ab4382d2SGreg Kroah-Hartman {
203ab4382d2SGreg Kroah-Hartman 	struct uart_port *port = dev_id;
20419606eafSMaarten Brock 	int stat, busy, n = 0;
2059e370d2cSRich Felker 	unsigned long flags;
206ab4382d2SGreg Kroah-Hartman 
207ab4382d2SGreg Kroah-Hartman 	do {
20819606eafSMaarten Brock 		spin_lock_irqsave(&port->lock, flags);
20919606eafSMaarten Brock 		stat = uart_in32(ULITE_STATUS, port);
210ab4382d2SGreg Kroah-Hartman 		busy  = ulite_receive(port, stat);
211ab4382d2SGreg Kroah-Hartman 		busy |= ulite_transmit(port, stat);
21219606eafSMaarten Brock 		spin_unlock_irqrestore(&port->lock, flags);
213ab4382d2SGreg Kroah-Hartman 		n++;
214ab4382d2SGreg Kroah-Hartman 	} while (busy);
215ab4382d2SGreg Kroah-Hartman 
216ab4382d2SGreg Kroah-Hartman 	/* work done? */
217ab4382d2SGreg Kroah-Hartman 	if (n > 1) {
2182e124b4aSJiri Slaby 		tty_flip_buffer_push(&port->state->port);
219ab4382d2SGreg Kroah-Hartman 		return IRQ_HANDLED;
220ab4382d2SGreg Kroah-Hartman 	} else {
221ab4382d2SGreg Kroah-Hartman 		return IRQ_NONE;
222ab4382d2SGreg Kroah-Hartman 	}
223ab4382d2SGreg Kroah-Hartman }
224ab4382d2SGreg Kroah-Hartman 
225ab4382d2SGreg Kroah-Hartman static unsigned int ulite_tx_empty(struct uart_port *port)
226ab4382d2SGreg Kroah-Hartman {
227ab4382d2SGreg Kroah-Hartman 	unsigned long flags;
228ab4382d2SGreg Kroah-Hartman 	unsigned int ret;
229ab4382d2SGreg Kroah-Hartman 
230ab4382d2SGreg Kroah-Hartman 	spin_lock_irqsave(&port->lock, flags);
2316d53c3b7SMichal Simek 	ret = uart_in32(ULITE_STATUS, port);
232ab4382d2SGreg Kroah-Hartman 	spin_unlock_irqrestore(&port->lock, flags);
233ab4382d2SGreg Kroah-Hartman 
234ab4382d2SGreg Kroah-Hartman 	return ret & ULITE_STATUS_TXEMPTY ? TIOCSER_TEMT : 0;
235ab4382d2SGreg Kroah-Hartman }
236ab4382d2SGreg Kroah-Hartman 
237ab4382d2SGreg Kroah-Hartman static unsigned int ulite_get_mctrl(struct uart_port *port)
238ab4382d2SGreg Kroah-Hartman {
239ab4382d2SGreg Kroah-Hartman 	return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
240ab4382d2SGreg Kroah-Hartman }
241ab4382d2SGreg Kroah-Hartman 
242ab4382d2SGreg Kroah-Hartman static void ulite_set_mctrl(struct uart_port *port, unsigned int mctrl)
243ab4382d2SGreg Kroah-Hartman {
244ab4382d2SGreg Kroah-Hartman 	/* N/A */
245ab4382d2SGreg Kroah-Hartman }
246ab4382d2SGreg Kroah-Hartman 
247ab4382d2SGreg Kroah-Hartman static void ulite_stop_tx(struct uart_port *port)
248ab4382d2SGreg Kroah-Hartman {
249ab4382d2SGreg Kroah-Hartman 	/* N/A */
250ab4382d2SGreg Kroah-Hartman }
251ab4382d2SGreg Kroah-Hartman 
252ab4382d2SGreg Kroah-Hartman static void ulite_start_tx(struct uart_port *port)
253ab4382d2SGreg Kroah-Hartman {
2546d53c3b7SMichal Simek 	ulite_transmit(port, uart_in32(ULITE_STATUS, port));
255ab4382d2SGreg Kroah-Hartman }
256ab4382d2SGreg Kroah-Hartman 
257ab4382d2SGreg Kroah-Hartman static void ulite_stop_rx(struct uart_port *port)
258ab4382d2SGreg Kroah-Hartman {
259ab4382d2SGreg Kroah-Hartman 	/* don't forward any more data (like !CREAD) */
260ab4382d2SGreg Kroah-Hartman 	port->ignore_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
261ab4382d2SGreg Kroah-Hartman 		| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
262ab4382d2SGreg Kroah-Hartman }
263ab4382d2SGreg Kroah-Hartman 
264ab4382d2SGreg Kroah-Hartman static void ulite_break_ctl(struct uart_port *port, int ctl)
265ab4382d2SGreg Kroah-Hartman {
266ab4382d2SGreg Kroah-Hartman 	/* N/A */
267ab4382d2SGreg Kroah-Hartman }
268ab4382d2SGreg Kroah-Hartman 
269ab4382d2SGreg Kroah-Hartman static int ulite_startup(struct uart_port *port)
270ab4382d2SGreg Kroah-Hartman {
27114288befSShubhrajyoti Datta 	struct uartlite_data *pdata = port->private_data;
272ab4382d2SGreg Kroah-Hartman 	int ret;
273ab4382d2SGreg Kroah-Hartman 
27414288befSShubhrajyoti Datta 	ret = clk_enable(pdata->clk);
27514288befSShubhrajyoti Datta 	if (ret) {
27614288befSShubhrajyoti Datta 		dev_err(port->dev, "Failed to enable clock\n");
27714288befSShubhrajyoti Datta 		return ret;
27814288befSShubhrajyoti Datta 	}
27914288befSShubhrajyoti Datta 
280106020ccSMaarten Brock 	ret = request_irq(port->irq, ulite_isr, IRQF_SHARED | IRQF_TRIGGER_RISING,
281106020ccSMaarten Brock 			  "uartlite", port);
282ab4382d2SGreg Kroah-Hartman 	if (ret)
283ab4382d2SGreg Kroah-Hartman 		return ret;
284ab4382d2SGreg Kroah-Hartman 
2856d53c3b7SMichal Simek 	uart_out32(ULITE_CONTROL_RST_RX | ULITE_CONTROL_RST_TX,
2866d53c3b7SMichal Simek 		ULITE_CONTROL, port);
2876d53c3b7SMichal Simek 	uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
288ab4382d2SGreg Kroah-Hartman 
289ab4382d2SGreg Kroah-Hartman 	return 0;
290ab4382d2SGreg Kroah-Hartman }
291ab4382d2SGreg Kroah-Hartman 
292ab4382d2SGreg Kroah-Hartman static void ulite_shutdown(struct uart_port *port)
293ab4382d2SGreg Kroah-Hartman {
29414288befSShubhrajyoti Datta 	struct uartlite_data *pdata = port->private_data;
29514288befSShubhrajyoti Datta 
2966d53c3b7SMichal Simek 	uart_out32(0, ULITE_CONTROL, port);
2976d53c3b7SMichal Simek 	uart_in32(ULITE_CONTROL, port); /* dummy */
298ab4382d2SGreg Kroah-Hartman 	free_irq(port->irq, port);
29914288befSShubhrajyoti Datta 	clk_disable(pdata->clk);
300ab4382d2SGreg Kroah-Hartman }
301ab4382d2SGreg Kroah-Hartman 
302ab4382d2SGreg Kroah-Hartman static void ulite_set_termios(struct uart_port *port, struct ktermios *termios,
303ab4382d2SGreg Kroah-Hartman 			      struct ktermios *old)
304ab4382d2SGreg Kroah-Hartman {
305ab4382d2SGreg Kroah-Hartman 	unsigned long flags;
306ab4382d2SGreg Kroah-Hartman 	unsigned int baud;
307ab4382d2SGreg Kroah-Hartman 
308ab4382d2SGreg Kroah-Hartman 	spin_lock_irqsave(&port->lock, flags);
309ab4382d2SGreg Kroah-Hartman 
310ab4382d2SGreg Kroah-Hartman 	port->read_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
311ab4382d2SGreg Kroah-Hartman 		| ULITE_STATUS_TXFULL;
312ab4382d2SGreg Kroah-Hartman 
313ab4382d2SGreg Kroah-Hartman 	if (termios->c_iflag & INPCK)
314ab4382d2SGreg Kroah-Hartman 		port->read_status_mask |=
315ab4382d2SGreg Kroah-Hartman 			ULITE_STATUS_PARITY | ULITE_STATUS_FRAME;
316ab4382d2SGreg Kroah-Hartman 
317ab4382d2SGreg Kroah-Hartman 	port->ignore_status_mask = 0;
318ab4382d2SGreg Kroah-Hartman 	if (termios->c_iflag & IGNPAR)
319ab4382d2SGreg Kroah-Hartman 		port->ignore_status_mask |= ULITE_STATUS_PARITY
320ab4382d2SGreg Kroah-Hartman 			| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
321ab4382d2SGreg Kroah-Hartman 
322ab4382d2SGreg Kroah-Hartman 	/* ignore all characters if CREAD is not set */
323ab4382d2SGreg Kroah-Hartman 	if ((termios->c_cflag & CREAD) == 0)
324ab4382d2SGreg Kroah-Hartman 		port->ignore_status_mask |=
325ab4382d2SGreg Kroah-Hartman 			ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
326ab4382d2SGreg Kroah-Hartman 			| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
327ab4382d2SGreg Kroah-Hartman 
328ab4382d2SGreg Kroah-Hartman 	/* update timeout */
329ab4382d2SGreg Kroah-Hartman 	baud = uart_get_baud_rate(port, termios, old, 0, 460800);
330ab4382d2SGreg Kroah-Hartman 	uart_update_timeout(port, termios->c_cflag, baud);
331ab4382d2SGreg Kroah-Hartman 
332ab4382d2SGreg Kroah-Hartman 	spin_unlock_irqrestore(&port->lock, flags);
333ab4382d2SGreg Kroah-Hartman }
334ab4382d2SGreg Kroah-Hartman 
335ab4382d2SGreg Kroah-Hartman static const char *ulite_type(struct uart_port *port)
336ab4382d2SGreg Kroah-Hartman {
337ab4382d2SGreg Kroah-Hartman 	return port->type == PORT_UARTLITE ? "uartlite" : NULL;
338ab4382d2SGreg Kroah-Hartman }
339ab4382d2SGreg Kroah-Hartman 
340ab4382d2SGreg Kroah-Hartman static void ulite_release_port(struct uart_port *port)
341ab4382d2SGreg Kroah-Hartman {
342ab4382d2SGreg Kroah-Hartman 	release_mem_region(port->mapbase, ULITE_REGION);
343ab4382d2SGreg Kroah-Hartman 	iounmap(port->membase);
344ab4382d2SGreg Kroah-Hartman 	port->membase = NULL;
345ab4382d2SGreg Kroah-Hartman }
346ab4382d2SGreg Kroah-Hartman 
347ab4382d2SGreg Kroah-Hartman static int ulite_request_port(struct uart_port *port)
348ab4382d2SGreg Kroah-Hartman {
349da7bf20eSShubhrajyoti Datta 	struct uartlite_data *pdata = port->private_data;
3506d53c3b7SMichal Simek 	int ret;
3516d53c3b7SMichal Simek 
352ab4382d2SGreg Kroah-Hartman 	pr_debug("ulite console: port=%p; port->mapbase=%llx\n",
353ab4382d2SGreg Kroah-Hartman 		 port, (unsigned long long) port->mapbase);
354ab4382d2SGreg Kroah-Hartman 
355ab4382d2SGreg Kroah-Hartman 	if (!request_mem_region(port->mapbase, ULITE_REGION, "uartlite")) {
356ab4382d2SGreg Kroah-Hartman 		dev_err(port->dev, "Memory region busy\n");
357ab4382d2SGreg Kroah-Hartman 		return -EBUSY;
358ab4382d2SGreg Kroah-Hartman 	}
359ab4382d2SGreg Kroah-Hartman 
360ab4382d2SGreg Kroah-Hartman 	port->membase = ioremap(port->mapbase, ULITE_REGION);
361ab4382d2SGreg Kroah-Hartman 	if (!port->membase) {
362ab4382d2SGreg Kroah-Hartman 		dev_err(port->dev, "Unable to map registers\n");
363ab4382d2SGreg Kroah-Hartman 		release_mem_region(port->mapbase, ULITE_REGION);
364ab4382d2SGreg Kroah-Hartman 		return -EBUSY;
365ab4382d2SGreg Kroah-Hartman 	}
366ab4382d2SGreg Kroah-Hartman 
367da7bf20eSShubhrajyoti Datta 	pdata->reg_ops = &uartlite_be;
3686d53c3b7SMichal Simek 	ret = uart_in32(ULITE_CONTROL, port);
3696d53c3b7SMichal Simek 	uart_out32(ULITE_CONTROL_RST_TX, ULITE_CONTROL, port);
3706d53c3b7SMichal Simek 	ret = uart_in32(ULITE_STATUS, port);
3716d53c3b7SMichal Simek 	/* Endianess detection */
3726d53c3b7SMichal Simek 	if ((ret & ULITE_STATUS_TXEMPTY) != ULITE_STATUS_TXEMPTY)
373da7bf20eSShubhrajyoti Datta 		pdata->reg_ops = &uartlite_le;
3746d53c3b7SMichal Simek 
375ab4382d2SGreg Kroah-Hartman 	return 0;
376ab4382d2SGreg Kroah-Hartman }
377ab4382d2SGreg Kroah-Hartman 
378ab4382d2SGreg Kroah-Hartman static void ulite_config_port(struct uart_port *port, int flags)
379ab4382d2SGreg Kroah-Hartman {
380ab4382d2SGreg Kroah-Hartman 	if (!ulite_request_port(port))
381ab4382d2SGreg Kroah-Hartman 		port->type = PORT_UARTLITE;
382ab4382d2SGreg Kroah-Hartman }
383ab4382d2SGreg Kroah-Hartman 
384ab4382d2SGreg Kroah-Hartman static int ulite_verify_port(struct uart_port *port, struct serial_struct *ser)
385ab4382d2SGreg Kroah-Hartman {
386ab4382d2SGreg Kroah-Hartman 	/* we don't want the core code to modify any port params */
387ab4382d2SGreg Kroah-Hartman 	return -EINVAL;
388ab4382d2SGreg Kroah-Hartman }
389ab4382d2SGreg Kroah-Hartman 
39014288befSShubhrajyoti Datta static void ulite_pm(struct uart_port *port, unsigned int state,
39114288befSShubhrajyoti Datta 		     unsigned int oldstate)
39214288befSShubhrajyoti Datta {
39307e5d4ffSGreg Kroah-Hartman 	struct uartlite_data *pdata = port->private_data;
39407e5d4ffSGreg Kroah-Hartman 
39507e5d4ffSGreg Kroah-Hartman 	if (!state)
39607e5d4ffSGreg Kroah-Hartman 		clk_enable(pdata->clk);
39707e5d4ffSGreg Kroah-Hartman 	else
39807e5d4ffSGreg Kroah-Hartman 		clk_disable(pdata->clk);
39914288befSShubhrajyoti Datta }
40014288befSShubhrajyoti Datta 
401ab4382d2SGreg Kroah-Hartman #ifdef CONFIG_CONSOLE_POLL
402ab4382d2SGreg Kroah-Hartman static int ulite_get_poll_char(struct uart_port *port)
403ab4382d2SGreg Kroah-Hartman {
4046d53c3b7SMichal Simek 	if (!(uart_in32(ULITE_STATUS, port) & ULITE_STATUS_RXVALID))
405ab4382d2SGreg Kroah-Hartman 		return NO_POLL_CHAR;
406ab4382d2SGreg Kroah-Hartman 
4076d53c3b7SMichal Simek 	return uart_in32(ULITE_RX, port);
408ab4382d2SGreg Kroah-Hartman }
409ab4382d2SGreg Kroah-Hartman 
410ab4382d2SGreg Kroah-Hartman static void ulite_put_poll_char(struct uart_port *port, unsigned char ch)
411ab4382d2SGreg Kroah-Hartman {
4126d53c3b7SMichal Simek 	while (uart_in32(ULITE_STATUS, port) & ULITE_STATUS_TXFULL)
413ab4382d2SGreg Kroah-Hartman 		cpu_relax();
414ab4382d2SGreg Kroah-Hartman 
415ab4382d2SGreg Kroah-Hartman 	/* write char to device */
4166d53c3b7SMichal Simek 	uart_out32(ch, ULITE_TX, port);
417ab4382d2SGreg Kroah-Hartman }
418ab4382d2SGreg Kroah-Hartman #endif
419ab4382d2SGreg Kroah-Hartman 
42031d054dcSJulia Lawall static const struct uart_ops ulite_ops = {
421ab4382d2SGreg Kroah-Hartman 	.tx_empty	= ulite_tx_empty,
422ab4382d2SGreg Kroah-Hartman 	.set_mctrl	= ulite_set_mctrl,
423ab4382d2SGreg Kroah-Hartman 	.get_mctrl	= ulite_get_mctrl,
424ab4382d2SGreg Kroah-Hartman 	.stop_tx	= ulite_stop_tx,
425ab4382d2SGreg Kroah-Hartman 	.start_tx	= ulite_start_tx,
426ab4382d2SGreg Kroah-Hartman 	.stop_rx	= ulite_stop_rx,
427ab4382d2SGreg Kroah-Hartman 	.break_ctl	= ulite_break_ctl,
428ab4382d2SGreg Kroah-Hartman 	.startup	= ulite_startup,
429ab4382d2SGreg Kroah-Hartman 	.shutdown	= ulite_shutdown,
430ab4382d2SGreg Kroah-Hartman 	.set_termios	= ulite_set_termios,
431ab4382d2SGreg Kroah-Hartman 	.type		= ulite_type,
432ab4382d2SGreg Kroah-Hartman 	.release_port	= ulite_release_port,
433ab4382d2SGreg Kroah-Hartman 	.request_port	= ulite_request_port,
434ab4382d2SGreg Kroah-Hartman 	.config_port	= ulite_config_port,
435ab4382d2SGreg Kroah-Hartman 	.verify_port	= ulite_verify_port,
43614288befSShubhrajyoti Datta 	.pm		= ulite_pm,
437ab4382d2SGreg Kroah-Hartman #ifdef CONFIG_CONSOLE_POLL
438ab4382d2SGreg Kroah-Hartman 	.poll_get_char	= ulite_get_poll_char,
439ab4382d2SGreg Kroah-Hartman 	.poll_put_char	= ulite_put_poll_char,
440ab4382d2SGreg Kroah-Hartman #endif
441ab4382d2SGreg Kroah-Hartman };
442ab4382d2SGreg Kroah-Hartman 
443ab4382d2SGreg Kroah-Hartman /* ---------------------------------------------------------------------
444ab4382d2SGreg Kroah-Hartman  * Console driver operations
445ab4382d2SGreg Kroah-Hartman  */
446ab4382d2SGreg Kroah-Hartman 
447ab4382d2SGreg Kroah-Hartman #ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
448ab4382d2SGreg Kroah-Hartman static void ulite_console_wait_tx(struct uart_port *port)
449ab4382d2SGreg Kroah-Hartman {
450ab4382d2SGreg Kroah-Hartman 	u8 val;
451d3352154SMichal Simek 	unsigned long timeout;
452ab4382d2SGreg Kroah-Hartman 
453d3352154SMichal Simek 	/*
454d3352154SMichal Simek 	 * Spin waiting for TX fifo to have space available.
455d3352154SMichal Simek 	 * When using the Microblaze Debug Module this can take up to 1s
456d3352154SMichal Simek 	 */
457d3352154SMichal Simek 	timeout = jiffies + msecs_to_jiffies(1000);
458d3352154SMichal Simek 	while (1) {
4596d53c3b7SMichal Simek 		val = uart_in32(ULITE_STATUS, port);
460ab4382d2SGreg Kroah-Hartman 		if ((val & ULITE_STATUS_TXFULL) == 0)
461ab4382d2SGreg Kroah-Hartman 			break;
462d3352154SMichal Simek 		if (time_after(jiffies, timeout)) {
463d3352154SMichal Simek 			dev_warn(port->dev,
464d3352154SMichal Simek 				 "timeout waiting for TX buffer empty\n");
465d3352154SMichal Simek 			break;
466d3352154SMichal Simek 		}
467ab4382d2SGreg Kroah-Hartman 		cpu_relax();
468ab4382d2SGreg Kroah-Hartman 	}
469ab4382d2SGreg Kroah-Hartman }
470ab4382d2SGreg Kroah-Hartman 
471ab4382d2SGreg Kroah-Hartman static void ulite_console_putchar(struct uart_port *port, int ch)
472ab4382d2SGreg Kroah-Hartman {
473ab4382d2SGreg Kroah-Hartman 	ulite_console_wait_tx(port);
4746d53c3b7SMichal Simek 	uart_out32(ch, ULITE_TX, port);
475ab4382d2SGreg Kroah-Hartman }
476ab4382d2SGreg Kroah-Hartman 
477ab4382d2SGreg Kroah-Hartman static void ulite_console_write(struct console *co, const char *s,
478ab4382d2SGreg Kroah-Hartman 				unsigned int count)
479ab4382d2SGreg Kroah-Hartman {
480deeb33e8SShubhrajyoti Datta 	struct uart_port *port = console_port;
481ab4382d2SGreg Kroah-Hartman 	unsigned long flags;
482ab4382d2SGreg Kroah-Hartman 	unsigned int ier;
483ab4382d2SGreg Kroah-Hartman 	int locked = 1;
484ab4382d2SGreg Kroah-Hartman 
485ab4382d2SGreg Kroah-Hartman 	if (oops_in_progress) {
486ab4382d2SGreg Kroah-Hartman 		locked = spin_trylock_irqsave(&port->lock, flags);
487ab4382d2SGreg Kroah-Hartman 	} else
488ab4382d2SGreg Kroah-Hartman 		spin_lock_irqsave(&port->lock, flags);
489ab4382d2SGreg Kroah-Hartman 
490ab4382d2SGreg Kroah-Hartman 	/* save and disable interrupt */
4916d53c3b7SMichal Simek 	ier = uart_in32(ULITE_STATUS, port) & ULITE_STATUS_IE;
4926d53c3b7SMichal Simek 	uart_out32(0, ULITE_CONTROL, port);
493ab4382d2SGreg Kroah-Hartman 
494ab4382d2SGreg Kroah-Hartman 	uart_console_write(port, s, count, ulite_console_putchar);
495ab4382d2SGreg Kroah-Hartman 
496ab4382d2SGreg Kroah-Hartman 	ulite_console_wait_tx(port);
497ab4382d2SGreg Kroah-Hartman 
498ab4382d2SGreg Kroah-Hartman 	/* restore interrupt state */
499ab4382d2SGreg Kroah-Hartman 	if (ier)
5006d53c3b7SMichal Simek 		uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
501ab4382d2SGreg Kroah-Hartman 
502ab4382d2SGreg Kroah-Hartman 	if (locked)
503ab4382d2SGreg Kroah-Hartman 		spin_unlock_irqrestore(&port->lock, flags);
504ab4382d2SGreg Kroah-Hartman }
505ab4382d2SGreg Kroah-Hartman 
5069671f099SBill Pemberton static int ulite_console_setup(struct console *co, char *options)
507ab4382d2SGreg Kroah-Hartman {
508d157fca7SDaniel Mack 	struct uart_port *port = NULL;
509ab4382d2SGreg Kroah-Hartman 	int baud = 9600;
510ab4382d2SGreg Kroah-Hartman 	int bits = 8;
511ab4382d2SGreg Kroah-Hartman 	int parity = 'n';
512ab4382d2SGreg Kroah-Hartman 	int flow = 'n';
513ab4382d2SGreg Kroah-Hartman 
514d157fca7SDaniel Mack 	if (co->index >= 0 && co->index < ULITE_NR_UARTS)
515d157fca7SDaniel Mack 		port = ulite_ports + co->index;
516ab4382d2SGreg Kroah-Hartman 
517ab4382d2SGreg Kroah-Hartman 	/* Has the device been initialized yet? */
518d157fca7SDaniel Mack 	if (!port || !port->mapbase) {
519ab4382d2SGreg Kroah-Hartman 		pr_debug("console on ttyUL%i not present\n", co->index);
520ab4382d2SGreg Kroah-Hartman 		return -ENODEV;
521ab4382d2SGreg Kroah-Hartman 	}
522ab4382d2SGreg Kroah-Hartman 
523d157fca7SDaniel Mack 	console_port = port;
524d157fca7SDaniel Mack 
525ab4382d2SGreg Kroah-Hartman 	/* not initialized yet? */
526ab4382d2SGreg Kroah-Hartman 	if (!port->membase) {
527ab4382d2SGreg Kroah-Hartman 		if (ulite_request_port(port))
528ab4382d2SGreg Kroah-Hartman 			return -ENODEV;
529ab4382d2SGreg Kroah-Hartman 	}
530ab4382d2SGreg Kroah-Hartman 
531ab4382d2SGreg Kroah-Hartman 	if (options)
532ab4382d2SGreg Kroah-Hartman 		uart_parse_options(options, &baud, &parity, &bits, &flow);
533ab4382d2SGreg Kroah-Hartman 
534ab4382d2SGreg Kroah-Hartman 	return uart_set_options(port, co, baud, parity, bits, flow);
535ab4382d2SGreg Kroah-Hartman }
536ab4382d2SGreg Kroah-Hartman 
537ab4382d2SGreg Kroah-Hartman static struct uart_driver ulite_uart_driver;
538ab4382d2SGreg Kroah-Hartman 
539ab4382d2SGreg Kroah-Hartman static struct console ulite_console = {
540ab4382d2SGreg Kroah-Hartman 	.name	= ULITE_NAME,
541ab4382d2SGreg Kroah-Hartman 	.write	= ulite_console_write,
542ab4382d2SGreg Kroah-Hartman 	.device	= uart_console_device,
543ab4382d2SGreg Kroah-Hartman 	.setup	= ulite_console_setup,
544ab4382d2SGreg Kroah-Hartman 	.flags	= CON_PRINTBUFFER,
545ab4382d2SGreg Kroah-Hartman 	.index	= -1, /* Specified on the cmdline (e.g. console=ttyUL0 ) */
546ab4382d2SGreg Kroah-Hartman 	.data	= &ulite_uart_driver,
547ab4382d2SGreg Kroah-Hartman };
548ab4382d2SGreg Kroah-Hartman 
5497cdcc29eSRich Felker static void early_uartlite_putc(struct uart_port *port, int c)
5507cdcc29eSRich Felker {
5517cdcc29eSRich Felker 	/*
5527cdcc29eSRich Felker 	 * Limit how many times we'll spin waiting for TX FIFO status.
5537cdcc29eSRich Felker 	 * This will prevent lockups if the base address is incorrectly
5547cdcc29eSRich Felker 	 * set, or any other issue on the UARTLITE.
5557cdcc29eSRich Felker 	 * This limit is pretty arbitrary, unless we are at about 10 baud
5567cdcc29eSRich Felker 	 * we'll never timeout on a working UART.
5577cdcc29eSRich Felker 	 */
5587cdcc29eSRich Felker 
5597cdcc29eSRich Felker 	unsigned retries = 1000000;
5607cdcc29eSRich Felker 	/* read status bit - 0x8 offset */
5617cdcc29eSRich Felker 	while (--retries && (readl(port->membase + 8) & (1 << 3)))
5627cdcc29eSRich Felker 		;
5637cdcc29eSRich Felker 
5647cdcc29eSRich Felker 	/* Only attempt the iowrite if we didn't timeout */
5657cdcc29eSRich Felker 	/* write to TX_FIFO - 0x4 offset */
5667cdcc29eSRich Felker 	if (retries)
5677cdcc29eSRich Felker 		writel(c & 0xff, port->membase + 4);
5687cdcc29eSRich Felker }
5697cdcc29eSRich Felker 
5707cdcc29eSRich Felker static void early_uartlite_write(struct console *console,
5717cdcc29eSRich Felker 				 const char *s, unsigned n)
5727cdcc29eSRich Felker {
5737cdcc29eSRich Felker 	struct earlycon_device *device = console->data;
5747cdcc29eSRich Felker 	uart_console_write(&device->port, s, n, early_uartlite_putc);
5757cdcc29eSRich Felker }
5767cdcc29eSRich Felker 
5777cdcc29eSRich Felker static int __init early_uartlite_setup(struct earlycon_device *device,
5787cdcc29eSRich Felker 				       const char *options)
5797cdcc29eSRich Felker {
5807cdcc29eSRich Felker 	if (!device->port.membase)
5817cdcc29eSRich Felker 		return -ENODEV;
5827cdcc29eSRich Felker 
5837cdcc29eSRich Felker 	device->con->write = early_uartlite_write;
5847cdcc29eSRich Felker 	return 0;
5857cdcc29eSRich Felker }
5867cdcc29eSRich Felker EARLYCON_DECLARE(uartlite, early_uartlite_setup);
5877cdcc29eSRich Felker OF_EARLYCON_DECLARE(uartlite_b, "xlnx,opb-uartlite-1.00.b", early_uartlite_setup);
5887cdcc29eSRich Felker OF_EARLYCON_DECLARE(uartlite_a, "xlnx,xps-uartlite-1.00.a", early_uartlite_setup);
5897cdcc29eSRich Felker 
590ab4382d2SGreg Kroah-Hartman #endif /* CONFIG_SERIAL_UARTLITE_CONSOLE */
591ab4382d2SGreg Kroah-Hartman 
592ab4382d2SGreg Kroah-Hartman static struct uart_driver ulite_uart_driver = {
593ab4382d2SGreg Kroah-Hartman 	.owner		= THIS_MODULE,
594ab4382d2SGreg Kroah-Hartman 	.driver_name	= "uartlite",
595ab4382d2SGreg Kroah-Hartman 	.dev_name	= ULITE_NAME,
596ab4382d2SGreg Kroah-Hartman 	.major		= ULITE_MAJOR,
597ab4382d2SGreg Kroah-Hartman 	.minor		= ULITE_MINOR,
598ab4382d2SGreg Kroah-Hartman 	.nr		= ULITE_NR_UARTS,
599ab4382d2SGreg Kroah-Hartman #ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
600ab4382d2SGreg Kroah-Hartman 	.cons		= &ulite_console,
601ab4382d2SGreg Kroah-Hartman #endif
602ab4382d2SGreg Kroah-Hartman };
603ab4382d2SGreg Kroah-Hartman 
604ab4382d2SGreg Kroah-Hartman /* ---------------------------------------------------------------------
605ab4382d2SGreg Kroah-Hartman  * Port assignment functions (mapping devices to uart_port structures)
606ab4382d2SGreg Kroah-Hartman  */
607ab4382d2SGreg Kroah-Hartman 
608ab4382d2SGreg Kroah-Hartman /** ulite_assign: register a uartlite device with the driver
609ab4382d2SGreg Kroah-Hartman  *
610ab4382d2SGreg Kroah-Hartman  * @dev: pointer to device structure
611ab4382d2SGreg Kroah-Hartman  * @id: requested id number.  Pass -1 for automatic port assignment
612ab4382d2SGreg Kroah-Hartman  * @base: base address of uartlite registers
613ab4382d2SGreg Kroah-Hartman  * @irq: irq number for uartlite
614da7bf20eSShubhrajyoti Datta  * @pdata: private data for uartlite
615ab4382d2SGreg Kroah-Hartman  *
616ab4382d2SGreg Kroah-Hartman  * Returns: 0 on success, <0 otherwise
617ab4382d2SGreg Kroah-Hartman  */
618da7bf20eSShubhrajyoti Datta static int ulite_assign(struct device *dev, int id, u32 base, int irq,
619da7bf20eSShubhrajyoti Datta 			struct uartlite_data *pdata)
620ab4382d2SGreg Kroah-Hartman {
621ab4382d2SGreg Kroah-Hartman 	struct uart_port *port;
622ab4382d2SGreg Kroah-Hartman 	int rc;
623ab4382d2SGreg Kroah-Hartman 
624ab4382d2SGreg Kroah-Hartman 	/* if id = -1; then scan for a free id and use that */
625ab4382d2SGreg Kroah-Hartman 	if (id < 0) {
626ab4382d2SGreg Kroah-Hartman 		for (id = 0; id < ULITE_NR_UARTS; id++)
627ab4382d2SGreg Kroah-Hartman 			if (ulite_ports[id].mapbase == 0)
628ab4382d2SGreg Kroah-Hartman 				break;
629ab4382d2SGreg Kroah-Hartman 	}
630ab4382d2SGreg Kroah-Hartman 	if (id < 0 || id >= ULITE_NR_UARTS) {
631ab4382d2SGreg Kroah-Hartman 		dev_err(dev, "%s%i too large\n", ULITE_NAME, id);
632ab4382d2SGreg Kroah-Hartman 		return -EINVAL;
633ab4382d2SGreg Kroah-Hartman 	}
634ab4382d2SGreg Kroah-Hartman 
635ab4382d2SGreg Kroah-Hartman 	if ((ulite_ports[id].mapbase) && (ulite_ports[id].mapbase != base)) {
636ab4382d2SGreg Kroah-Hartman 		dev_err(dev, "cannot assign to %s%i; it is already in use\n",
637ab4382d2SGreg Kroah-Hartman 			ULITE_NAME, id);
638ab4382d2SGreg Kroah-Hartman 		return -EBUSY;
639ab4382d2SGreg Kroah-Hartman 	}
640ab4382d2SGreg Kroah-Hartman 
641ab4382d2SGreg Kroah-Hartman 	port = &ulite_ports[id];
642ab4382d2SGreg Kroah-Hartman 
643ab4382d2SGreg Kroah-Hartman 	spin_lock_init(&port->lock);
644ab4382d2SGreg Kroah-Hartman 	port->fifosize = 16;
645ab4382d2SGreg Kroah-Hartman 	port->regshift = 2;
646ab4382d2SGreg Kroah-Hartman 	port->iotype = UPIO_MEM;
647ab4382d2SGreg Kroah-Hartman 	port->iobase = 1; /* mark port in use */
648ab4382d2SGreg Kroah-Hartman 	port->mapbase = base;
649ab4382d2SGreg Kroah-Hartman 	port->membase = NULL;
650ab4382d2SGreg Kroah-Hartman 	port->ops = &ulite_ops;
651ab4382d2SGreg Kroah-Hartman 	port->irq = irq;
652ab4382d2SGreg Kroah-Hartman 	port->flags = UPF_BOOT_AUTOCONF;
653ab4382d2SGreg Kroah-Hartman 	port->dev = dev;
654ab4382d2SGreg Kroah-Hartman 	port->type = PORT_UNKNOWN;
655ab4382d2SGreg Kroah-Hartman 	port->line = id;
656da7bf20eSShubhrajyoti Datta 	port->private_data = pdata;
657ab4382d2SGreg Kroah-Hartman 
658ab4382d2SGreg Kroah-Hartman 	dev_set_drvdata(dev, port);
659ab4382d2SGreg Kroah-Hartman 
660ab4382d2SGreg Kroah-Hartman 	/* Register the port */
66161ad2a02SGreg Kroah-Hartman 	rc = uart_add_one_port(&ulite_uart_driver, port);
662ab4382d2SGreg Kroah-Hartman 	if (rc) {
663ab4382d2SGreg Kroah-Hartman 		dev_err(dev, "uart_add_one_port() failed; err=%i\n", rc);
664ab4382d2SGreg Kroah-Hartman 		port->mapbase = 0;
665ab4382d2SGreg Kroah-Hartman 		dev_set_drvdata(dev, NULL);
666ab4382d2SGreg Kroah-Hartman 		return rc;
667ab4382d2SGreg Kroah-Hartman 	}
668ab4382d2SGreg Kroah-Hartman 
669ab4382d2SGreg Kroah-Hartman 	return 0;
670ab4382d2SGreg Kroah-Hartman }
671ab4382d2SGreg Kroah-Hartman 
672ab4382d2SGreg Kroah-Hartman /** ulite_release: register a uartlite device with the driver
673ab4382d2SGreg Kroah-Hartman  *
674ab4382d2SGreg Kroah-Hartman  * @dev: pointer to device structure
675ab4382d2SGreg Kroah-Hartman  */
676ae8d8a14SBill Pemberton static int ulite_release(struct device *dev)
677ab4382d2SGreg Kroah-Hartman {
678ab4382d2SGreg Kroah-Hartman 	struct uart_port *port = dev_get_drvdata(dev);
679ab4382d2SGreg Kroah-Hartman 	int rc = 0;
680ab4382d2SGreg Kroah-Hartman 
681ab4382d2SGreg Kroah-Hartman 	if (port) {
6825d8508aaSGreg Kroah-Hartman 		rc = uart_remove_one_port(&ulite_uart_driver, port);
683ab4382d2SGreg Kroah-Hartman 		dev_set_drvdata(dev, NULL);
684ab4382d2SGreg Kroah-Hartman 		port->mapbase = 0;
685ab4382d2SGreg Kroah-Hartman 	}
686ab4382d2SGreg Kroah-Hartman 
687ab4382d2SGreg Kroah-Hartman 	return rc;
688ab4382d2SGreg Kroah-Hartman }
689ab4382d2SGreg Kroah-Hartman 
690a3a10614SShubhrajyoti Datta /**
691a3a10614SShubhrajyoti Datta  * ulite_suspend - Stop the device.
692a3a10614SShubhrajyoti Datta  *
693a3a10614SShubhrajyoti Datta  * @dev: handle to the device structure.
694a3a10614SShubhrajyoti Datta  * Return: 0 always.
695a3a10614SShubhrajyoti Datta  */
696a3a10614SShubhrajyoti Datta static int __maybe_unused ulite_suspend(struct device *dev)
697a3a10614SShubhrajyoti Datta {
698a3a10614SShubhrajyoti Datta 	struct uart_port *port = dev_get_drvdata(dev);
699ee0a29baSColin Ian King 
7005d8508aaSGreg Kroah-Hartman 	if (port)
7015d8508aaSGreg Kroah-Hartman 		uart_suspend_port(&ulite_uart_driver, port);
702a3a10614SShubhrajyoti Datta 
703a3a10614SShubhrajyoti Datta 	return 0;
704a3a10614SShubhrajyoti Datta }
705a3a10614SShubhrajyoti Datta 
706a3a10614SShubhrajyoti Datta /**
707a3a10614SShubhrajyoti Datta  * ulite_resume - Resume the device.
708a3a10614SShubhrajyoti Datta  *
709a3a10614SShubhrajyoti Datta  * @dev: handle to the device structure.
710a3a10614SShubhrajyoti Datta  * Return: 0 on success, errno otherwise.
711a3a10614SShubhrajyoti Datta  */
712a3a10614SShubhrajyoti Datta static int __maybe_unused ulite_resume(struct device *dev)
713a3a10614SShubhrajyoti Datta {
714a3a10614SShubhrajyoti Datta 	struct uart_port *port = dev_get_drvdata(dev);
715ee0a29baSColin Ian King 
7165d8508aaSGreg Kroah-Hartman 	if (port)
7175d8508aaSGreg Kroah-Hartman 		uart_resume_port(&ulite_uart_driver, port);
718a3a10614SShubhrajyoti Datta 
719a3a10614SShubhrajyoti Datta 	return 0;
720a3a10614SShubhrajyoti Datta }
721a3a10614SShubhrajyoti Datta 
722ab4382d2SGreg Kroah-Hartman /* ---------------------------------------------------------------------
723ab4382d2SGreg Kroah-Hartman  * Platform bus binding
724ab4382d2SGreg Kroah-Hartman  */
725a3a10614SShubhrajyoti Datta 
72607e5d4ffSGreg Kroah-Hartman static SIMPLE_DEV_PM_OPS(ulite_pm_ops, ulite_suspend, ulite_resume);
727a3a10614SShubhrajyoti Datta 
728e5263a51SGrant Likely #if defined(CONFIG_OF)
729e5263a51SGrant Likely /* Match table for of_platform binding */
730ed0bb232SFabian Frederick static const struct of_device_id ulite_of_match[] = {
731e5263a51SGrant Likely 	{ .compatible = "xlnx,opb-uartlite-1.00.b", },
732e5263a51SGrant Likely 	{ .compatible = "xlnx,xps-uartlite-1.00.a", },
733e5263a51SGrant Likely 	{}
734e5263a51SGrant Likely };
735e5263a51SGrant Likely MODULE_DEVICE_TABLE(of, ulite_of_match);
736e5263a51SGrant Likely #endif /* CONFIG_OF */
737e5263a51SGrant Likely 
7389671f099SBill Pemberton static int ulite_probe(struct platform_device *pdev)
739ab4382d2SGreg Kroah-Hartman {
7405c90c07bSMichal Simek 	struct resource *res;
741da7bf20eSShubhrajyoti Datta 	struct uartlite_data *pdata;
74214288befSShubhrajyoti Datta 	int irq, ret;
743e5263a51SGrant Likely 	int id = pdev->id;
744e5263a51SGrant Likely #ifdef CONFIG_OF
745e5263a51SGrant Likely 	const __be32 *prop;
746e5263a51SGrant Likely 
747e5263a51SGrant Likely 	prop = of_get_property(pdev->dev.of_node, "port-number", NULL);
748e5263a51SGrant Likely 	if (prop)
749e5263a51SGrant Likely 		id = be32_to_cpup(prop);
750e5263a51SGrant Likely #endif
751da7bf20eSShubhrajyoti Datta 	pdata = devm_kzalloc(&pdev->dev, sizeof(struct uartlite_data),
752da7bf20eSShubhrajyoti Datta 			     GFP_KERNEL);
753da7bf20eSShubhrajyoti Datta 	if (!pdata)
754da7bf20eSShubhrajyoti Datta 		return -ENOMEM;
755ab4382d2SGreg Kroah-Hartman 
756ab4382d2SGreg Kroah-Hartman 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
757ab4382d2SGreg Kroah-Hartman 	if (!res)
758ab4382d2SGreg Kroah-Hartman 		return -ENODEV;
759ab4382d2SGreg Kroah-Hartman 
7605c90c07bSMichal Simek 	irq = platform_get_irq(pdev, 0);
7610b60525bSAlexander Sverdlin 	if (irq < 0)
7620b60525bSAlexander Sverdlin 		return irq;
763ab4382d2SGreg Kroah-Hartman 
76414288befSShubhrajyoti Datta 	pdata->clk = devm_clk_get(&pdev->dev, "s_axi_aclk");
76514288befSShubhrajyoti Datta 	if (IS_ERR(pdata->clk)) {
76614288befSShubhrajyoti Datta 		if (PTR_ERR(pdata->clk) != -ENOENT)
76714288befSShubhrajyoti Datta 			return PTR_ERR(pdata->clk);
76814288befSShubhrajyoti Datta 
76914288befSShubhrajyoti Datta 		/*
77014288befSShubhrajyoti Datta 		 * Clock framework support is optional, continue on
77114288befSShubhrajyoti Datta 		 * anyways if we don't find a matching clock.
77214288befSShubhrajyoti Datta 		 */
77314288befSShubhrajyoti Datta 		pdata->clk = NULL;
77414288befSShubhrajyoti Datta 	}
77514288befSShubhrajyoti Datta 
776ea42d7a6SShubhrajyoti Datta 	ret = clk_prepare_enable(pdata->clk);
77714288befSShubhrajyoti Datta 	if (ret) {
77814288befSShubhrajyoti Datta 		dev_err(&pdev->dev, "Failed to prepare clock\n");
77914288befSShubhrajyoti Datta 		return ret;
78014288befSShubhrajyoti Datta 	}
78114288befSShubhrajyoti Datta 
782f4c47547SGreg Kroah-Hartman 	if (!ulite_uart_driver.state) {
783f4c47547SGreg Kroah-Hartman 		dev_dbg(&pdev->dev, "uartlite: calling uart_register_driver()\n");
784f4c47547SGreg Kroah-Hartman 		ret = uart_register_driver(&ulite_uart_driver);
785f4c47547SGreg Kroah-Hartman 		if (ret < 0) {
786f4c47547SGreg Kroah-Hartman 			dev_err(&pdev->dev, "Failed to register driver\n");
787*ed623dffSShubhrajyoti Datta 			clk_disable_unprepare(pdata->clk);
788f4c47547SGreg Kroah-Hartman 			return ret;
789f4c47547SGreg Kroah-Hartman 		}
790f4c47547SGreg Kroah-Hartman 	}
791f4c47547SGreg Kroah-Hartman 
792ea42d7a6SShubhrajyoti Datta 	ret = ulite_assign(&pdev->dev, id, res->start, irq, pdata);
793ea42d7a6SShubhrajyoti Datta 
79407e5d4ffSGreg Kroah-Hartman 	clk_disable(pdata->clk);
795ea42d7a6SShubhrajyoti Datta 
796ea42d7a6SShubhrajyoti Datta 	return ret;
797ab4382d2SGreg Kroah-Hartman }
798ab4382d2SGreg Kroah-Hartman 
799ae8d8a14SBill Pemberton static int ulite_remove(struct platform_device *pdev)
800ab4382d2SGreg Kroah-Hartman {
80114288befSShubhrajyoti Datta 	struct uart_port *port = dev_get_drvdata(&pdev->dev);
80214288befSShubhrajyoti Datta 	struct uartlite_data *pdata = port->private_data;
80314288befSShubhrajyoti Datta 
8046a7ce07dSChuhong Yuan 	clk_disable_unprepare(pdata->clk);
80507e5d4ffSGreg Kroah-Hartman 	return ulite_release(&pdev->dev);
806ab4382d2SGreg Kroah-Hartman }
807ab4382d2SGreg Kroah-Hartman 
808ab4382d2SGreg Kroah-Hartman /* work with hotplug and coldplug */
809ab4382d2SGreg Kroah-Hartman MODULE_ALIAS("platform:uartlite");
810ab4382d2SGreg Kroah-Hartman 
811ab4382d2SGreg Kroah-Hartman static struct platform_driver ulite_platform_driver = {
812ab4382d2SGreg Kroah-Hartman 	.probe = ulite_probe,
8132d47b716SBill Pemberton 	.remove = ulite_remove,
814ab4382d2SGreg Kroah-Hartman 	.driver = {
815ab4382d2SGreg Kroah-Hartman 		.name  = "uartlite",
81685888069SBen Dooks 		.of_match_table = of_match_ptr(ulite_of_match),
817a3a10614SShubhrajyoti Datta 		.pm = &ulite_pm_ops,
818ab4382d2SGreg Kroah-Hartman 	},
819ab4382d2SGreg Kroah-Hartman };
820ab4382d2SGreg Kroah-Hartman 
821ab4382d2SGreg Kroah-Hartman /* ---------------------------------------------------------------------
822ab4382d2SGreg Kroah-Hartman  * Module setup/teardown
823ab4382d2SGreg Kroah-Hartman  */
824ab4382d2SGreg Kroah-Hartman 
8253240b48dSMichal Simek static int __init ulite_init(void)
826ab4382d2SGreg Kroah-Hartman {
827ab4382d2SGreg Kroah-Hartman 
828ab4382d2SGreg Kroah-Hartman 	pr_debug("uartlite: calling platform_driver_register()\n");
829415b43bdSShubhrajyoti Datta 	return platform_driver_register(&ulite_platform_driver);
830ab4382d2SGreg Kroah-Hartman }
831ab4382d2SGreg Kroah-Hartman 
8323240b48dSMichal Simek static void __exit ulite_exit(void)
833ab4382d2SGreg Kroah-Hartman {
834ab4382d2SGreg Kroah-Hartman 	platform_driver_unregister(&ulite_platform_driver);
835a553add0SRandy Dunlap 	if (ulite_uart_driver.state)
836ab4382d2SGreg Kroah-Hartman 		uart_unregister_driver(&ulite_uart_driver);
837ab4382d2SGreg Kroah-Hartman }
838ab4382d2SGreg Kroah-Hartman 
839ab4382d2SGreg Kroah-Hartman module_init(ulite_init);
840ab4382d2SGreg Kroah-Hartman module_exit(ulite_exit);
841ab4382d2SGreg Kroah-Hartman 
842ab4382d2SGreg Kroah-Hartman MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
843ab4382d2SGreg Kroah-Hartman MODULE_DESCRIPTION("Xilinx uartlite serial driver");
844ab4382d2SGreg Kroah-Hartman MODULE_LICENSE("GPL");
845