blob: f42ccc40ffa647c5eb2470220e53f3115e5c8236 [file] [log] [blame]
Greg Kroah-Hartmane3b3d0f2017-11-06 18:11:51 +01001// SPDX-License-Identifier: GPL-2.0
Peter Korsgaard238b8722006-12-06 20:35:17 -08002/*
3 * uartlite.c: Serial driver for Xilinx uartlite serial controller
4 *
Grant Likely852e1ea2007-10-02 12:16:04 +10005 * Copyright (C) 2006 Peter Korsgaard <jacmet@sunsite.dk>
6 * Copyright (C) 2007 Secret Lab Technologies Ltd.
Peter Korsgaard238b8722006-12-06 20:35:17 -08007 */
8
9#include <linux/platform_device.h>
10#include <linux/module.h>
11#include <linux/console.h>
12#include <linux/serial.h>
13#include <linux/serial_core.h>
14#include <linux/tty.h>
Jiri Slabyee160a32011-09-01 16:20:57 +020015#include <linux/tty_flip.h>
Peter Korsgaard238b8722006-12-06 20:35:17 -080016#include <linux/delay.h>
17#include <linux/interrupt.h>
Stephen Neuendorffer0e349b02008-01-09 06:35:05 +110018#include <linux/init.h>
Michal Simek3240b48d2013-02-11 19:04:33 +010019#include <linux/io.h>
Stephen Neuendorffer0e349b02008-01-09 06:35:05 +110020#include <linux/of.h>
Grant Likely22ae7822010-07-29 11:49:01 -060021#include <linux/of_address.h>
Grant Likely852e1ea2007-10-02 12:16:04 +100022#include <linux/of_device.h>
23#include <linux/of_platform.h>
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +053024#include <linux/clk.h>
Stephen Neuendorffer0e349b02008-01-09 06:35:05 +110025
Grant Likely00775822007-10-02 12:15:49 +100026#define ULITE_NAME "ttyUL"
Peter Korsgaard238b8722006-12-06 20:35:17 -080027#define ULITE_MAJOR 204
28#define ULITE_MINOR 187
Sam Povilusb44b96a2017-03-15 20:43:24 -060029#define ULITE_NR_UARTS CONFIG_SERIAL_UARTLITE_NR_UARTS
Peter Korsgaard238b8722006-12-06 20:35:17 -080030
Grant Likely435706b2007-10-02 12:15:59 +100031/* ---------------------------------------------------------------------
32 * Register definitions
33 *
34 * For register details see datasheet:
Alexander A. Klimov82ee0b12020-07-18 12:08:07 +020035 * https://www.xilinx.com/support/documentation/ip_documentation/opb_uartlite.pdf
Grant Likely435706b2007-10-02 12:15:59 +100036 */
37
Peter Korsgaard238b8722006-12-06 20:35:17 -080038#define ULITE_RX 0x00
39#define ULITE_TX 0x04
40#define ULITE_STATUS 0x08
41#define ULITE_CONTROL 0x0c
42
43#define ULITE_REGION 16
44
45#define ULITE_STATUS_RXVALID 0x01
46#define ULITE_STATUS_RXFULL 0x02
47#define ULITE_STATUS_TXEMPTY 0x04
48#define ULITE_STATUS_TXFULL 0x08
49#define ULITE_STATUS_IE 0x10
50#define ULITE_STATUS_OVERRUN 0x20
51#define ULITE_STATUS_FRAME 0x40
52#define ULITE_STATUS_PARITY 0x80
53
54#define ULITE_CONTROL_RST_TX 0x01
55#define ULITE_CONTROL_RST_RX 0x02
56#define ULITE_CONTROL_IE 0x10
57
Shubhrajyoti Dattadeeb33e2018-08-06 14:22:14 +053058/* Static pointer to console port */
59#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
60static struct uart_port *console_port;
61#endif
62
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +053063struct uartlite_data {
64 const struct uartlite_reg_ops *reg_ops;
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +053065 struct clk *clk;
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +053066};
67
Michal Simek6d53c3b2013-02-11 19:04:34 +010068struct uartlite_reg_ops {
69 u32 (*in)(void __iomem *addr);
70 void (*out)(u32 val, void __iomem *addr);
71};
72
73static u32 uartlite_inbe32(void __iomem *addr)
74{
75 return ioread32be(addr);
76}
77
78static void uartlite_outbe32(u32 val, void __iomem *addr)
79{
80 iowrite32be(val, addr);
81}
82
Maarten Brock973ea592016-04-22 18:19:33 +020083static const struct uartlite_reg_ops uartlite_be = {
Michal Simek6d53c3b2013-02-11 19:04:34 +010084 .in = uartlite_inbe32,
85 .out = uartlite_outbe32,
86};
87
88static u32 uartlite_inle32(void __iomem *addr)
89{
90 return ioread32(addr);
91}
92
93static void uartlite_outle32(u32 val, void __iomem *addr)
94{
95 iowrite32(val, addr);
96}
97
Maarten Brock973ea592016-04-22 18:19:33 +020098static const struct uartlite_reg_ops uartlite_le = {
Michal Simek6d53c3b2013-02-11 19:04:34 +010099 .in = uartlite_inle32,
100 .out = uartlite_outle32,
101};
102
103static inline u32 uart_in32(u32 offset, struct uart_port *port)
104{
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530105 struct uartlite_data *pdata = port->private_data;
Michal Simek6d53c3b2013-02-11 19:04:34 +0100106
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530107 return pdata->reg_ops->in(port->membase + offset);
Michal Simek6d53c3b2013-02-11 19:04:34 +0100108}
109
110static inline void uart_out32(u32 val, u32 offset, struct uart_port *port)
111{
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530112 struct uartlite_data *pdata = port->private_data;
Michal Simek6d53c3b2013-02-11 19:04:34 +0100113
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530114 pdata->reg_ops->out(val, port->membase + offset);
Michal Simek6d53c3b2013-02-11 19:04:34 +0100115}
Peter Korsgaard238b8722006-12-06 20:35:17 -0800116
Grant Likely483c79d2007-10-02 12:15:44 +1000117static struct uart_port ulite_ports[ULITE_NR_UARTS];
Peter Korsgaard238b8722006-12-06 20:35:17 -0800118
Grant Likely435706b2007-10-02 12:15:59 +1000119/* ---------------------------------------------------------------------
120 * Core UART driver operations
121 */
122
Peter Korsgaard238b8722006-12-06 20:35:17 -0800123static int ulite_receive(struct uart_port *port, int stat)
124{
Jiri Slaby92a19f92013-01-03 15:53:03 +0100125 struct tty_port *tport = &port->state->port;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800126 unsigned char ch = 0;
127 char flag = TTY_NORMAL;
128
129 if ((stat & (ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
130 | ULITE_STATUS_FRAME)) == 0)
131 return 0;
132
133 /* stats */
134 if (stat & ULITE_STATUS_RXVALID) {
135 port->icount.rx++;
Michal Simek6d53c3b2013-02-11 19:04:34 +0100136 ch = uart_in32(ULITE_RX, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800137
138 if (stat & ULITE_STATUS_PARITY)
139 port->icount.parity++;
140 }
141
142 if (stat & ULITE_STATUS_OVERRUN)
143 port->icount.overrun++;
144
145 if (stat & ULITE_STATUS_FRAME)
146 port->icount.frame++;
147
148
149 /* drop byte with parity error if IGNPAR specificed */
150 if (stat & port->ignore_status_mask & ULITE_STATUS_PARITY)
151 stat &= ~ULITE_STATUS_RXVALID;
152
153 stat &= port->read_status_mask;
154
155 if (stat & ULITE_STATUS_PARITY)
156 flag = TTY_PARITY;
157
158
159 stat &= ~port->ignore_status_mask;
160
161 if (stat & ULITE_STATUS_RXVALID)
Jiri Slaby92a19f92013-01-03 15:53:03 +0100162 tty_insert_flip_char(tport, ch, flag);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800163
164 if (stat & ULITE_STATUS_FRAME)
Jiri Slaby92a19f92013-01-03 15:53:03 +0100165 tty_insert_flip_char(tport, 0, TTY_FRAME);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800166
167 if (stat & ULITE_STATUS_OVERRUN)
Jiri Slaby92a19f92013-01-03 15:53:03 +0100168 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800169
170 return 1;
171}
172
173static int ulite_transmit(struct uart_port *port, int stat)
174{
Alan Coxebd2c8f2009-09-19 13:13:28 -0700175 struct circ_buf *xmit = &port->state->xmit;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800176
177 if (stat & ULITE_STATUS_TXFULL)
178 return 0;
179
180 if (port->x_char) {
Michal Simek6d53c3b2013-02-11 19:04:34 +0100181 uart_out32(port->x_char, ULITE_TX, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800182 port->x_char = 0;
183 port->icount.tx++;
184 return 1;
185 }
186
187 if (uart_circ_empty(xmit) || uart_tx_stopped(port))
188 return 0;
189
Michal Simek6d53c3b2013-02-11 19:04:34 +0100190 uart_out32(xmit->buf[xmit->tail], ULITE_TX, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800191 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE-1);
192 port->icount.tx++;
193
194 /* wake up */
195 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
196 uart_write_wakeup(port);
197
198 return 1;
199}
200
201static irqreturn_t ulite_isr(int irq, void *dev_id)
202{
Jeff Garzik15aafa22008-02-06 01:36:20 -0800203 struct uart_port *port = dev_id;
Maarten Brock19606ea2016-02-16 18:59:03 +0100204 int stat, busy, n = 0;
Rich Felker9e370d22016-01-08 15:33:50 -0500205 unsigned long flags;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800206
207 do {
Maarten Brock19606ea2016-02-16 18:59:03 +0100208 spin_lock_irqsave(&port->lock, flags);
209 stat = uart_in32(ULITE_STATUS, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800210 busy = ulite_receive(port, stat);
211 busy |= ulite_transmit(port, stat);
Maarten Brock19606ea2016-02-16 18:59:03 +0100212 spin_unlock_irqrestore(&port->lock, flags);
Peter Korsgaardd2cfe962009-09-09 16:54:04 +0200213 n++;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800214 } while (busy);
215
Peter Korsgaardd2cfe962009-09-09 16:54:04 +0200216 /* work done? */
217 if (n > 1) {
Jiri Slaby2e124b42013-01-03 15:53:06 +0100218 tty_flip_buffer_push(&port->state->port);
Peter Korsgaardd2cfe962009-09-09 16:54:04 +0200219 return IRQ_HANDLED;
220 } else {
221 return IRQ_NONE;
222 }
Peter Korsgaard238b8722006-12-06 20:35:17 -0800223}
224
225static unsigned int ulite_tx_empty(struct uart_port *port)
226{
227 unsigned long flags;
228 unsigned int ret;
229
230 spin_lock_irqsave(&port->lock, flags);
Michal Simek6d53c3b2013-02-11 19:04:34 +0100231 ret = uart_in32(ULITE_STATUS, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800232 spin_unlock_irqrestore(&port->lock, flags);
233
234 return ret & ULITE_STATUS_TXEMPTY ? TIOCSER_TEMT : 0;
235}
236
237static unsigned int ulite_get_mctrl(struct uart_port *port)
238{
239 return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
240}
241
242static void ulite_set_mctrl(struct uart_port *port, unsigned int mctrl)
243{
244 /* N/A */
245}
246
247static void ulite_stop_tx(struct uart_port *port)
248{
249 /* N/A */
250}
251
252static void ulite_start_tx(struct uart_port *port)
253{
Michal Simek6d53c3b2013-02-11 19:04:34 +0100254 ulite_transmit(port, uart_in32(ULITE_STATUS, port));
Peter Korsgaard238b8722006-12-06 20:35:17 -0800255}
256
257static void ulite_stop_rx(struct uart_port *port)
258{
259 /* don't forward any more data (like !CREAD) */
260 port->ignore_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
261 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
262}
263
Peter Korsgaard238b8722006-12-06 20:35:17 -0800264static void ulite_break_ctl(struct uart_port *port, int ctl)
265{
266 /* N/A */
267}
268
269static int ulite_startup(struct uart_port *port)
270{
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530271 struct uartlite_data *pdata = port->private_data;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800272 int ret;
273
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530274 ret = clk_enable(pdata->clk);
275 if (ret) {
276 dev_err(port->dev, "Failed to enable clock\n");
277 return ret;
278 }
279
Maarten Brock106020c2016-02-16 18:59:04 +0100280 ret = request_irq(port->irq, ulite_isr, IRQF_SHARED | IRQF_TRIGGER_RISING,
281 "uartlite", port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800282 if (ret)
283 return ret;
284
Michal Simek6d53c3b2013-02-11 19:04:34 +0100285 uart_out32(ULITE_CONTROL_RST_RX | ULITE_CONTROL_RST_TX,
286 ULITE_CONTROL, port);
287 uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800288
289 return 0;
290}
291
292static void ulite_shutdown(struct uart_port *port)
293{
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530294 struct uartlite_data *pdata = port->private_data;
295
Michal Simek6d53c3b2013-02-11 19:04:34 +0100296 uart_out32(0, ULITE_CONTROL, port);
297 uart_in32(ULITE_CONTROL, port); /* dummy */
Peter Korsgaard238b8722006-12-06 20:35:17 -0800298 free_irq(port->irq, port);
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530299 clk_disable(pdata->clk);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800300}
301
Alan Cox606d0992006-12-08 02:38:45 -0800302static void ulite_set_termios(struct uart_port *port, struct ktermios *termios,
303 struct ktermios *old)
Peter Korsgaard238b8722006-12-06 20:35:17 -0800304{
305 unsigned long flags;
306 unsigned int baud;
307
308 spin_lock_irqsave(&port->lock, flags);
309
310 port->read_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
311 | ULITE_STATUS_TXFULL;
312
313 if (termios->c_iflag & INPCK)
314 port->read_status_mask |=
315 ULITE_STATUS_PARITY | ULITE_STATUS_FRAME;
316
317 port->ignore_status_mask = 0;
318 if (termios->c_iflag & IGNPAR)
319 port->ignore_status_mask |= ULITE_STATUS_PARITY
320 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
321
322 /* ignore all characters if CREAD is not set */
323 if ((termios->c_cflag & CREAD) == 0)
324 port->ignore_status_mask |=
325 ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
326 | ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
327
328 /* update timeout */
329 baud = uart_get_baud_rate(port, termios, old, 0, 460800);
330 uart_update_timeout(port, termios->c_cflag, baud);
331
332 spin_unlock_irqrestore(&port->lock, flags);
333}
334
335static const char *ulite_type(struct uart_port *port)
336{
337 return port->type == PORT_UARTLITE ? "uartlite" : NULL;
338}
339
340static void ulite_release_port(struct uart_port *port)
341{
342 release_mem_region(port->mapbase, ULITE_REGION);
343 iounmap(port->membase);
Al Virob81831c62007-02-09 16:38:25 +0000344 port->membase = NULL;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800345}
346
347static int ulite_request_port(struct uart_port *port)
348{
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530349 struct uartlite_data *pdata = port->private_data;
Michal Simek6d53c3b2013-02-11 19:04:34 +0100350 int ret;
351
Grant Likelya1080962008-11-14 09:59:48 -0700352 pr_debug("ulite console: port=%p; port->mapbase=%llx\n",
353 port, (unsigned long long) port->mapbase);
Stephen Neuendorffer0e349b02008-01-09 06:35:05 +1100354
Peter Korsgaard238b8722006-12-06 20:35:17 -0800355 if (!request_mem_region(port->mapbase, ULITE_REGION, "uartlite")) {
356 dev_err(port->dev, "Memory region busy\n");
357 return -EBUSY;
358 }
359
360 port->membase = ioremap(port->mapbase, ULITE_REGION);
361 if (!port->membase) {
362 dev_err(port->dev, "Unable to map registers\n");
363 release_mem_region(port->mapbase, ULITE_REGION);
364 return -EBUSY;
365 }
366
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530367 pdata->reg_ops = &uartlite_be;
Michal Simek6d53c3b2013-02-11 19:04:34 +0100368 ret = uart_in32(ULITE_CONTROL, port);
369 uart_out32(ULITE_CONTROL_RST_TX, ULITE_CONTROL, port);
370 ret = uart_in32(ULITE_STATUS, port);
371 /* Endianess detection */
372 if ((ret & ULITE_STATUS_TXEMPTY) != ULITE_STATUS_TXEMPTY)
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530373 pdata->reg_ops = &uartlite_le;
Michal Simek6d53c3b2013-02-11 19:04:34 +0100374
Peter Korsgaard238b8722006-12-06 20:35:17 -0800375 return 0;
376}
377
378static void ulite_config_port(struct uart_port *port, int flags)
379{
Peter Korsgaarde21654a2006-12-22 16:38:40 +0100380 if (!ulite_request_port(port))
381 port->type = PORT_UARTLITE;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800382}
383
384static int ulite_verify_port(struct uart_port *port, struct serial_struct *ser)
385{
386 /* we don't want the core code to modify any port params */
387 return -EINVAL;
388}
389
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530390static void ulite_pm(struct uart_port *port, unsigned int state,
391 unsigned int oldstate)
392{
Greg Kroah-Hartman07e5d4f2019-11-14 06:25:17 +0800393 struct uartlite_data *pdata = port->private_data;
394
395 if (!state)
396 clk_enable(pdata->clk);
397 else
398 clk_disable(pdata->clk);
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530399}
400
Michal Simek8a28af7f2010-08-17 10:42:05 +0200401#ifdef CONFIG_CONSOLE_POLL
402static int ulite_get_poll_char(struct uart_port *port)
403{
Michal Simek6d53c3b2013-02-11 19:04:34 +0100404 if (!(uart_in32(ULITE_STATUS, port) & ULITE_STATUS_RXVALID))
Michal Simek8a28af7f2010-08-17 10:42:05 +0200405 return NO_POLL_CHAR;
406
Michal Simek6d53c3b2013-02-11 19:04:34 +0100407 return uart_in32(ULITE_RX, port);
Michal Simek8a28af7f2010-08-17 10:42:05 +0200408}
409
410static void ulite_put_poll_char(struct uart_port *port, unsigned char ch)
411{
Michal Simek6d53c3b2013-02-11 19:04:34 +0100412 while (uart_in32(ULITE_STATUS, port) & ULITE_STATUS_TXFULL)
Michal Simek8a28af7f2010-08-17 10:42:05 +0200413 cpu_relax();
414
415 /* write char to device */
Michal Simek6d53c3b2013-02-11 19:04:34 +0100416 uart_out32(ch, ULITE_TX, port);
Michal Simek8a28af7f2010-08-17 10:42:05 +0200417}
418#endif
419
Julia Lawall31d054d2016-09-01 19:51:37 +0200420static const struct uart_ops ulite_ops = {
Peter Korsgaard238b8722006-12-06 20:35:17 -0800421 .tx_empty = ulite_tx_empty,
422 .set_mctrl = ulite_set_mctrl,
423 .get_mctrl = ulite_get_mctrl,
424 .stop_tx = ulite_stop_tx,
425 .start_tx = ulite_start_tx,
426 .stop_rx = ulite_stop_rx,
Peter Korsgaard238b8722006-12-06 20:35:17 -0800427 .break_ctl = ulite_break_ctl,
428 .startup = ulite_startup,
429 .shutdown = ulite_shutdown,
430 .set_termios = ulite_set_termios,
431 .type = ulite_type,
432 .release_port = ulite_release_port,
433 .request_port = ulite_request_port,
434 .config_port = ulite_config_port,
Michal Simek8a28af7f2010-08-17 10:42:05 +0200435 .verify_port = ulite_verify_port,
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530436 .pm = ulite_pm,
Michal Simek8a28af7f2010-08-17 10:42:05 +0200437#ifdef CONFIG_CONSOLE_POLL
438 .poll_get_char = ulite_get_poll_char,
439 .poll_put_char = ulite_put_poll_char,
440#endif
Peter Korsgaard238b8722006-12-06 20:35:17 -0800441};
442
Grant Likely435706b2007-10-02 12:15:59 +1000443/* ---------------------------------------------------------------------
444 * Console driver operations
445 */
446
Peter Korsgaard238b8722006-12-06 20:35:17 -0800447#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
448static void ulite_console_wait_tx(struct uart_port *port)
449{
Grant Likely1d6b6982007-10-23 14:27:46 +1000450 u8 val;
Michal Simekd3352152014-05-06 06:46:15 +0200451 unsigned long timeout;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800452
Michal Simekd3352152014-05-06 06:46:15 +0200453 /*
454 * Spin waiting for TX fifo to have space available.
455 * When using the Microblaze Debug Module this can take up to 1s
456 */
457 timeout = jiffies + msecs_to_jiffies(1000);
458 while (1) {
Michal Simek6d53c3b2013-02-11 19:04:34 +0100459 val = uart_in32(ULITE_STATUS, port);
Grant Likely1d6b6982007-10-23 14:27:46 +1000460 if ((val & ULITE_STATUS_TXFULL) == 0)
Peter Korsgaard238b8722006-12-06 20:35:17 -0800461 break;
Michal Simekd3352152014-05-06 06:46:15 +0200462 if (time_after(jiffies, timeout)) {
463 dev_warn(port->dev,
464 "timeout waiting for TX buffer empty\n");
465 break;
466 }
Grant Likely1d6b6982007-10-23 14:27:46 +1000467 cpu_relax();
Peter Korsgaard238b8722006-12-06 20:35:17 -0800468 }
469}
470
471static void ulite_console_putchar(struct uart_port *port, int ch)
472{
473 ulite_console_wait_tx(port);
Michal Simek6d53c3b2013-02-11 19:04:34 +0100474 uart_out32(ch, ULITE_TX, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800475}
476
477static void ulite_console_write(struct console *co, const char *s,
478 unsigned int count)
479{
Shubhrajyoti Dattadeeb33e2018-08-06 14:22:14 +0530480 struct uart_port *port = console_port;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800481 unsigned long flags;
482 unsigned int ier;
483 int locked = 1;
484
485 if (oops_in_progress) {
486 locked = spin_trylock_irqsave(&port->lock, flags);
487 } else
488 spin_lock_irqsave(&port->lock, flags);
489
490 /* save and disable interrupt */
Michal Simek6d53c3b2013-02-11 19:04:34 +0100491 ier = uart_in32(ULITE_STATUS, port) & ULITE_STATUS_IE;
492 uart_out32(0, ULITE_CONTROL, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800493
494 uart_console_write(port, s, count, ulite_console_putchar);
495
496 ulite_console_wait_tx(port);
497
498 /* restore interrupt state */
499 if (ier)
Michal Simek6d53c3b2013-02-11 19:04:34 +0100500 uart_out32(ULITE_CONTROL_IE, ULITE_CONTROL, port);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800501
502 if (locked)
503 spin_unlock_irqrestore(&port->lock, flags);
504}
505
Bill Pemberton9671f092012-11-19 13:21:50 -0500506static int ulite_console_setup(struct console *co, char *options)
Peter Korsgaard238b8722006-12-06 20:35:17 -0800507{
508 struct uart_port *port;
509 int baud = 9600;
510 int bits = 8;
511 int parity = 'n';
512 int flow = 'n';
513
Peter Korsgaard238b8722006-12-06 20:35:17 -0800514
Shubhrajyoti Dattadeeb33e2018-08-06 14:22:14 +0530515 port = console_port;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800516
Grant Likely3de66a12008-02-06 10:23:41 -0700517 /* Has the device been initialized yet? */
Grant Likelyfb4e6e62007-10-02 12:16:09 +1000518 if (!port->mapbase) {
519 pr_debug("console on ttyUL%i not present\n", co->index);
520 return -ENODEV;
521 }
522
Peter Korsgaard238b8722006-12-06 20:35:17 -0800523 /* not initialized yet? */
Grant Likely852e1ea2007-10-02 12:16:04 +1000524 if (!port->membase) {
Grant Likelyfb4e6e62007-10-02 12:16:09 +1000525 if (ulite_request_port(port))
526 return -ENODEV;
Grant Likely852e1ea2007-10-02 12:16:04 +1000527 }
Peter Korsgaard238b8722006-12-06 20:35:17 -0800528
529 if (options)
530 uart_parse_options(options, &baud, &parity, &bits, &flow);
531
532 return uart_set_options(port, co, baud, parity, bits, flow);
533}
534
535static struct uart_driver ulite_uart_driver;
536
537static struct console ulite_console = {
Grant Likely00775822007-10-02 12:15:49 +1000538 .name = ULITE_NAME,
Peter Korsgaard238b8722006-12-06 20:35:17 -0800539 .write = ulite_console_write,
540 .device = uart_console_device,
541 .setup = ulite_console_setup,
542 .flags = CON_PRINTBUFFER,
543 .index = -1, /* Specified on the cmdline (e.g. console=ttyUL0 ) */
544 .data = &ulite_uart_driver,
545};
546
Rich Felker7cdcc292016-01-08 15:34:05 -0500547static void early_uartlite_putc(struct uart_port *port, int c)
548{
549 /*
550 * Limit how many times we'll spin waiting for TX FIFO status.
551 * This will prevent lockups if the base address is incorrectly
552 * set, or any other issue on the UARTLITE.
553 * This limit is pretty arbitrary, unless we are at about 10 baud
554 * we'll never timeout on a working UART.
555 */
556
557 unsigned retries = 1000000;
558 /* read status bit - 0x8 offset */
559 while (--retries && (readl(port->membase + 8) & (1 << 3)))
560 ;
561
562 /* Only attempt the iowrite if we didn't timeout */
563 /* write to TX_FIFO - 0x4 offset */
564 if (retries)
565 writel(c & 0xff, port->membase + 4);
566}
567
568static void early_uartlite_write(struct console *console,
569 const char *s, unsigned n)
570{
571 struct earlycon_device *device = console->data;
572 uart_console_write(&device->port, s, n, early_uartlite_putc);
573}
574
575static int __init early_uartlite_setup(struct earlycon_device *device,
576 const char *options)
577{
578 if (!device->port.membase)
579 return -ENODEV;
580
581 device->con->write = early_uartlite_write;
582 return 0;
583}
584EARLYCON_DECLARE(uartlite, early_uartlite_setup);
585OF_EARLYCON_DECLARE(uartlite_b, "xlnx,opb-uartlite-1.00.b", early_uartlite_setup);
586OF_EARLYCON_DECLARE(uartlite_a, "xlnx,xps-uartlite-1.00.a", early_uartlite_setup);
587
Peter Korsgaard238b8722006-12-06 20:35:17 -0800588#endif /* CONFIG_SERIAL_UARTLITE_CONSOLE */
589
590static struct uart_driver ulite_uart_driver = {
591 .owner = THIS_MODULE,
592 .driver_name = "uartlite",
Grant Likely00775822007-10-02 12:15:49 +1000593 .dev_name = ULITE_NAME,
Peter Korsgaard238b8722006-12-06 20:35:17 -0800594 .major = ULITE_MAJOR,
595 .minor = ULITE_MINOR,
596 .nr = ULITE_NR_UARTS,
597#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
598 .cons = &ulite_console,
599#endif
600};
601
Grant Likely435706b2007-10-02 12:15:59 +1000602/* ---------------------------------------------------------------------
603 * Port assignment functions (mapping devices to uart_port structures)
604 */
605
606/** ulite_assign: register a uartlite device with the driver
607 *
608 * @dev: pointer to device structure
609 * @id: requested id number. Pass -1 for automatic port assignment
610 * @base: base address of uartlite registers
611 * @irq: irq number for uartlite
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530612 * @pdata: private data for uartlite
Grant Likely435706b2007-10-02 12:15:59 +1000613 *
614 * Returns: 0 on success, <0 otherwise
615 */
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530616static int ulite_assign(struct device *dev, int id, u32 base, int irq,
617 struct uartlite_data *pdata)
Grant Likely8fa7b612007-10-02 12:15:54 +1000618{
619 struct uart_port *port;
620 int rc;
621
622 /* if id = -1; then scan for a free id and use that */
623 if (id < 0) {
624 for (id = 0; id < ULITE_NR_UARTS; id++)
625 if (ulite_ports[id].mapbase == 0)
626 break;
627 }
628 if (id < 0 || id >= ULITE_NR_UARTS) {
629 dev_err(dev, "%s%i too large\n", ULITE_NAME, id);
630 return -EINVAL;
631 }
632
Grant Likelyfb4e6e62007-10-02 12:16:09 +1000633 if ((ulite_ports[id].mapbase) && (ulite_ports[id].mapbase != base)) {
Grant Likely8fa7b612007-10-02 12:15:54 +1000634 dev_err(dev, "cannot assign to %s%i; it is already in use\n",
635 ULITE_NAME, id);
636 return -EBUSY;
637 }
638
639 port = &ulite_ports[id];
640
641 spin_lock_init(&port->lock);
642 port->fifosize = 16;
643 port->regshift = 2;
644 port->iotype = UPIO_MEM;
645 port->iobase = 1; /* mark port in use */
646 port->mapbase = base;
647 port->membase = NULL;
648 port->ops = &ulite_ops;
649 port->irq = irq;
650 port->flags = UPF_BOOT_AUTOCONF;
651 port->dev = dev;
652 port->type = PORT_UNKNOWN;
653 port->line = id;
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530654 port->private_data = pdata;
Grant Likely8fa7b612007-10-02 12:15:54 +1000655
656 dev_set_drvdata(dev, port);
657
Shubhrajyoti Dattadeeb33e2018-08-06 14:22:14 +0530658#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
659 /*
660 * If console hasn't been found yet try to assign this port
661 * because it is required to be assigned for console setup function.
662 * If register_console() don't assign value, then console_port pointer
663 * is cleanup.
664 */
Greg Kroah-Hartman5042ffb2019-11-14 06:22:56 +0800665 if (ulite_uart_driver.cons->index == -1)
Shubhrajyoti Dattadeeb33e2018-08-06 14:22:14 +0530666 console_port = port;
667#endif
668
Grant Likely8fa7b612007-10-02 12:15:54 +1000669 /* Register the port */
Greg Kroah-Hartman61ad2a02019-11-14 06:20:35 +0800670 rc = uart_add_one_port(&ulite_uart_driver, port);
Grant Likely8fa7b612007-10-02 12:15:54 +1000671 if (rc) {
672 dev_err(dev, "uart_add_one_port() failed; err=%i\n", rc);
673 port->mapbase = 0;
674 dev_set_drvdata(dev, NULL);
675 return rc;
676 }
677
Shubhrajyoti Dattadeeb33e2018-08-06 14:22:14 +0530678#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
679 /* This is not port which is used for console that's why clean it up */
Greg Kroah-Hartman5042ffb2019-11-14 06:22:56 +0800680 if (ulite_uart_driver.cons->index == -1)
Shubhrajyoti Dattadeeb33e2018-08-06 14:22:14 +0530681 console_port = NULL;
682#endif
683
Grant Likely8fa7b612007-10-02 12:15:54 +1000684 return 0;
685}
686
Grant Likely435706b2007-10-02 12:15:59 +1000687/** ulite_release: register a uartlite device with the driver
688 *
689 * @dev: pointer to device structure
690 */
Bill Pembertonae8d8a12012-11-19 13:26:18 -0500691static int ulite_release(struct device *dev)
Grant Likely8fa7b612007-10-02 12:15:54 +1000692{
693 struct uart_port *port = dev_get_drvdata(dev);
694 int rc = 0;
695
696 if (port) {
Greg Kroah-Hartman5d8508a2019-11-14 06:28:15 +0800697 rc = uart_remove_one_port(&ulite_uart_driver, port);
Grant Likely8fa7b612007-10-02 12:15:54 +1000698 dev_set_drvdata(dev, NULL);
699 port->mapbase = 0;
700 }
701
702 return rc;
703}
704
Shubhrajyoti Dattaa3a10612018-07-21 17:19:06 +0530705/**
706 * ulite_suspend - Stop the device.
707 *
708 * @dev: handle to the device structure.
709 * Return: 0 always.
710 */
711static int __maybe_unused ulite_suspend(struct device *dev)
712{
713 struct uart_port *port = dev_get_drvdata(dev);
714
Greg Kroah-Hartman5d8508a2019-11-14 06:28:15 +0800715 if (port)
716 uart_suspend_port(&ulite_uart_driver, port);
Shubhrajyoti Dattaa3a10612018-07-21 17:19:06 +0530717
718 return 0;
719}
720
721/**
722 * ulite_resume - Resume the device.
723 *
724 * @dev: handle to the device structure.
725 * Return: 0 on success, errno otherwise.
726 */
727static int __maybe_unused ulite_resume(struct device *dev)
728{
729 struct uart_port *port = dev_get_drvdata(dev);
730
Greg Kroah-Hartman5d8508a2019-11-14 06:28:15 +0800731 if (port)
732 uart_resume_port(&ulite_uart_driver, port);
Shubhrajyoti Dattaa3a10612018-07-21 17:19:06 +0530733
734 return 0;
735}
736
Grant Likely435706b2007-10-02 12:15:59 +1000737/* ---------------------------------------------------------------------
738 * Platform bus binding
739 */
Shubhrajyoti Dattaa3a10612018-07-21 17:19:06 +0530740
Greg Kroah-Hartman07e5d4f2019-11-14 06:25:17 +0800741static SIMPLE_DEV_PM_OPS(ulite_pm_ops, ulite_suspend, ulite_resume);
Shubhrajyoti Dattaa3a10612018-07-21 17:19:06 +0530742
Grant Likelye5263a52011-02-22 20:16:13 -0700743#if defined(CONFIG_OF)
744/* Match table for of_platform binding */
Fabian Fredericked0bb232015-03-16 20:17:11 +0100745static const struct of_device_id ulite_of_match[] = {
Grant Likelye5263a52011-02-22 20:16:13 -0700746 { .compatible = "xlnx,opb-uartlite-1.00.b", },
747 { .compatible = "xlnx,xps-uartlite-1.00.a", },
748 {}
749};
750MODULE_DEVICE_TABLE(of, ulite_of_match);
Grant Likelye5263a52011-02-22 20:16:13 -0700751#endif /* CONFIG_OF */
752
Bill Pemberton9671f092012-11-19 13:21:50 -0500753static int ulite_probe(struct platform_device *pdev)
Peter Korsgaard238b8722006-12-06 20:35:17 -0800754{
Michal Simek5c90c072015-04-13 16:34:21 +0200755 struct resource *res;
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530756 struct uartlite_data *pdata;
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530757 int irq, ret;
Grant Likelye5263a52011-02-22 20:16:13 -0700758 int id = pdev->id;
759#ifdef CONFIG_OF
760 const __be32 *prop;
761
762 prop = of_get_property(pdev->dev.of_node, "port-number", NULL);
763 if (prop)
764 id = be32_to_cpup(prop);
765#endif
Shubhrajyoti Dattada7bf202018-07-21 17:19:04 +0530766 pdata = devm_kzalloc(&pdev->dev, sizeof(struct uartlite_data),
767 GFP_KERNEL);
768 if (!pdata)
769 return -ENOMEM;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800770
771 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
772 if (!res)
773 return -ENODEV;
774
Michal Simek5c90c072015-04-13 16:34:21 +0200775 irq = platform_get_irq(pdev, 0);
Alexander Sverdlin0b605252020-11-27 11:19:53 +0100776 if (irq < 0)
777 return irq;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800778
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530779 pdata->clk = devm_clk_get(&pdev->dev, "s_axi_aclk");
780 if (IS_ERR(pdata->clk)) {
781 if (PTR_ERR(pdata->clk) != -ENOENT)
782 return PTR_ERR(pdata->clk);
783
784 /*
785 * Clock framework support is optional, continue on
786 * anyways if we don't find a matching clock.
787 */
788 pdata->clk = NULL;
789 }
790
Shubhrajyoti Dattaea42d7a2018-08-06 14:22:11 +0530791 ret = clk_prepare_enable(pdata->clk);
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530792 if (ret) {
793 dev_err(&pdev->dev, "Failed to prepare clock\n");
794 return ret;
795 }
796
Greg Kroah-Hartmanf4c47542019-11-14 06:29:08 +0800797 if (!ulite_uart_driver.state) {
798 dev_dbg(&pdev->dev, "uartlite: calling uart_register_driver()\n");
799 ret = uart_register_driver(&ulite_uart_driver);
800 if (ret < 0) {
801 dev_err(&pdev->dev, "Failed to register driver\n");
802 return ret;
803 }
804 }
805
Shubhrajyoti Dattaea42d7a2018-08-06 14:22:11 +0530806 ret = ulite_assign(&pdev->dev, id, res->start, irq, pdata);
807
Greg Kroah-Hartman07e5d4f2019-11-14 06:25:17 +0800808 clk_disable(pdata->clk);
Shubhrajyoti Dattaea42d7a2018-08-06 14:22:11 +0530809
810 return ret;
Peter Korsgaard238b8722006-12-06 20:35:17 -0800811}
812
Bill Pembertonae8d8a12012-11-19 13:26:18 -0500813static int ulite_remove(struct platform_device *pdev)
Peter Korsgaard238b8722006-12-06 20:35:17 -0800814{
Shubhrajyoti Datta14288be2018-07-21 17:19:05 +0530815 struct uart_port *port = dev_get_drvdata(&pdev->dev);
816 struct uartlite_data *pdata = port->private_data;
817
Chuhong Yuan6a7ce072019-11-01 16:54:33 +0800818 clk_disable_unprepare(pdata->clk);
Greg Kroah-Hartman07e5d4f2019-11-14 06:25:17 +0800819 return ulite_release(&pdev->dev);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800820}
821
Kay Sieverse169c132008-04-15 14:34:35 -0700822/* work with hotplug and coldplug */
823MODULE_ALIAS("platform:uartlite");
824
Peter Korsgaard238b8722006-12-06 20:35:17 -0800825static struct platform_driver ulite_platform_driver = {
Grant Likelye5263a52011-02-22 20:16:13 -0700826 .probe = ulite_probe,
Bill Pemberton2d47b712012-11-19 13:21:34 -0500827 .remove = ulite_remove,
Grant Likely852e1ea2007-10-02 12:16:04 +1000828 .driver = {
Grant Likelye5263a52011-02-22 20:16:13 -0700829 .name = "uartlite",
Ben Dooks85888062011-08-03 10:11:43 +0100830 .of_match_table = of_match_ptr(ulite_of_match),
Shubhrajyoti Dattaa3a10612018-07-21 17:19:06 +0530831 .pm = &ulite_pm_ops,
Grant Likely852e1ea2007-10-02 12:16:04 +1000832 },
833};
834
Grant Likely852e1ea2007-10-02 12:16:04 +1000835/* ---------------------------------------------------------------------
Grant Likely435706b2007-10-02 12:15:59 +1000836 * Module setup/teardown
837 */
838
Michal Simek3240b48d2013-02-11 19:04:33 +0100839static int __init ulite_init(void)
Peter Korsgaard238b8722006-12-06 20:35:17 -0800840{
Peter Korsgaard238b8722006-12-06 20:35:17 -0800841
Grant Likely852e1ea2007-10-02 12:16:04 +1000842 pr_debug("uartlite: calling platform_driver_register()\n");
Shubhrajyoti Datta415b43b2018-08-06 14:22:12 +0530843 return platform_driver_register(&ulite_platform_driver);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800844}
845
Michal Simek3240b48d2013-02-11 19:04:33 +0100846static void __exit ulite_exit(void)
Peter Korsgaard238b8722006-12-06 20:35:17 -0800847{
848 platform_driver_unregister(&ulite_platform_driver);
Randy Dunlapa553add2019-09-16 16:12:23 -0700849 if (ulite_uart_driver.state)
850 uart_unregister_driver(&ulite_uart_driver);
Peter Korsgaard238b8722006-12-06 20:35:17 -0800851}
852
853module_init(ulite_init);
854module_exit(ulite_exit);
855
856MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
857MODULE_DESCRIPTION("Xilinx uartlite serial driver");
858MODULE_LICENSE("GPL");