Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3* ***************************************************************************
4* Marvell Armada-3700 Serial Driver
5* Author: Wilson Ding <dingwei@marvell.com>
6* Copyright (C) 2015 Marvell International Ltd.
7* ***************************************************************************
8*/
9
10#include <linux/clk.h>
11#include <linux/console.h>
12#include <linux/delay.h>
13#include <linux/device.h>
14#include <linux/init.h>
15#include <linux/io.h>
16#include <linux/iopoll.h>
17#include <linux/of.h>
18#include <linux/of_address.h>
19#include <linux/of_device.h>
20#include <linux/of_irq.h>
21#include <linux/of_platform.h>
22#include <linux/platform_device.h>
23#include <linux/serial.h>
24#include <linux/serial_core.h>
25#include <linux/slab.h>
26#include <linux/tty.h>
27#include <linux/tty_flip.h>
28
29/* Register Map */
30#define UART_STD_RBR 0x00
31#define UART_EXT_RBR 0x18
32
33#define UART_STD_TSH 0x04
34#define UART_EXT_TSH 0x1C
35
36#define UART_STD_CTRL1 0x08
37#define UART_EXT_CTRL1 0x04
38#define CTRL_SOFT_RST BIT(31)
39#define CTRL_TXFIFO_RST BIT(15)
40#define CTRL_RXFIFO_RST BIT(14)
41#define CTRL_SND_BRK_SEQ BIT(11)
42#define CTRL_BRK_DET_INT BIT(3)
43#define CTRL_FRM_ERR_INT BIT(2)
44#define CTRL_PAR_ERR_INT BIT(1)
45#define CTRL_OVR_ERR_INT BIT(0)
46#define CTRL_BRK_INT (CTRL_BRK_DET_INT | CTRL_FRM_ERR_INT | \
47 CTRL_PAR_ERR_INT | CTRL_OVR_ERR_INT)
48
49#define UART_STD_CTRL2 UART_STD_CTRL1
50#define UART_EXT_CTRL2 0x20
51#define CTRL_STD_TX_RDY_INT BIT(5)
52#define CTRL_EXT_TX_RDY_INT BIT(6)
53#define CTRL_STD_RX_RDY_INT BIT(4)
54#define CTRL_EXT_RX_RDY_INT BIT(5)
55
56#define UART_STAT 0x0C
57#define STAT_TX_FIFO_EMP BIT(13)
58#define STAT_TX_FIFO_FUL BIT(11)
59#define STAT_TX_EMP BIT(6)
60#define STAT_STD_TX_RDY BIT(5)
61#define STAT_EXT_TX_RDY BIT(15)
62#define STAT_STD_RX_RDY BIT(4)
63#define STAT_EXT_RX_RDY BIT(14)
64#define STAT_BRK_DET BIT(3)
65#define STAT_FRM_ERR BIT(2)
66#define STAT_PAR_ERR BIT(1)
67#define STAT_OVR_ERR BIT(0)
68#define STAT_BRK_ERR (STAT_BRK_DET | STAT_FRM_ERR \
69 | STAT_PAR_ERR | STAT_OVR_ERR)
70
71#define UART_BRDV 0x10
72#define BRDV_BAUD_MASK 0x3FF
73
74#define UART_OSAMP 0x14
75#define OSAMP_DEFAULT_DIVISOR 16
76#define OSAMP_DIVISORS_MASK 0x3F3F3F3F
77
78#define MVEBU_NR_UARTS 2
79
80#define MVEBU_UART_TYPE "mvebu-uart"
81#define DRIVER_NAME "mvebu_serial"
82
83enum {
84 /* Either there is only one summed IRQ... */
85 UART_IRQ_SUM = 0,
86 /* ...or there are two separate IRQ for RX and TX */
87 UART_RX_IRQ = 0,
88 UART_TX_IRQ,
89 UART_IRQ_COUNT
90};
91
92/* Diverging register offsets */
93struct uart_regs_layout {
94 unsigned int rbr;
95 unsigned int tsh;
96 unsigned int ctrl;
97 unsigned int intr;
98};
99
100/* Diverging flags */
101struct uart_flags {
102 unsigned int ctrl_tx_rdy_int;
103 unsigned int ctrl_rx_rdy_int;
104 unsigned int stat_tx_rdy;
105 unsigned int stat_rx_rdy;
106};
107
108/* Driver data, a structure for each UART port */
109struct mvebu_uart_driver_data {
110 bool is_ext;
111 struct uart_regs_layout regs;
112 struct uart_flags flags;
113};
114
115/* Saved registers during suspend */
116struct mvebu_uart_pm_regs {
117 unsigned int rbr;
118 unsigned int tsh;
119 unsigned int ctrl;
120 unsigned int intr;
121 unsigned int stat;
122 unsigned int brdv;
123 unsigned int osamp;
124};
125
126/* MVEBU UART driver structure */
127struct mvebu_uart {
128 struct uart_port *port;
129 struct clk *clk;
130 int irq[UART_IRQ_COUNT];
131 unsigned char __iomem *nb;
132 struct mvebu_uart_driver_data *data;
133#if defined(CONFIG_PM)
134 struct mvebu_uart_pm_regs pm_regs;
135#endif /* CONFIG_PM */
136};
137
138static struct mvebu_uart *to_mvuart(struct uart_port *port)
139{
140 return (struct mvebu_uart *)port->private_data;
141}
142
143#define IS_EXTENDED(port) (to_mvuart(port)->data->is_ext)
144
145#define UART_RBR(port) (to_mvuart(port)->data->regs.rbr)
146#define UART_TSH(port) (to_mvuart(port)->data->regs.tsh)
147#define UART_CTRL(port) (to_mvuart(port)->data->regs.ctrl)
148#define UART_INTR(port) (to_mvuart(port)->data->regs.intr)
149
150#define CTRL_TX_RDY_INT(port) (to_mvuart(port)->data->flags.ctrl_tx_rdy_int)
151#define CTRL_RX_RDY_INT(port) (to_mvuart(port)->data->flags.ctrl_rx_rdy_int)
152#define STAT_TX_RDY(port) (to_mvuart(port)->data->flags.stat_tx_rdy)
153#define STAT_RX_RDY(port) (to_mvuart(port)->data->flags.stat_rx_rdy)
154
155static struct uart_port mvebu_uart_ports[MVEBU_NR_UARTS];
156
157/* Core UART Driver Operations */
158static unsigned int mvebu_uart_tx_empty(struct uart_port *port)
159{
160 unsigned long flags;
161 unsigned int st;
162
163 spin_lock_irqsave(&port->lock, flags);
164 st = readl(port->membase + UART_STAT);
165 spin_unlock_irqrestore(&port->lock, flags);
166
167 return (st & STAT_TX_FIFO_EMP) ? TIOCSER_TEMT : 0;
168}
169
170static unsigned int mvebu_uart_get_mctrl(struct uart_port *port)
171{
172 return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
173}
174
175static void mvebu_uart_set_mctrl(struct uart_port *port,
176 unsigned int mctrl)
177{
178/*
179 * Even if we do not support configuring the modem control lines, this
180 * function must be proided to the serial core
181 */
182}
183
184static void mvebu_uart_stop_tx(struct uart_port *port)
185{
186 unsigned int ctl = readl(port->membase + UART_INTR(port));
187
188 ctl &= ~CTRL_TX_RDY_INT(port);
189 writel(ctl, port->membase + UART_INTR(port));
190}
191
192static void mvebu_uart_start_tx(struct uart_port *port)
193{
194 unsigned int ctl;
195 struct circ_buf *xmit = &port->state->xmit;
196
197 if (IS_EXTENDED(port) && !uart_circ_empty(xmit)) {
198 writel(xmit->buf[xmit->tail], port->membase + UART_TSH(port));
199 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
200 port->icount.tx++;
201 }
202
203 ctl = readl(port->membase + UART_INTR(port));
204 ctl |= CTRL_TX_RDY_INT(port);
205 writel(ctl, port->membase + UART_INTR(port));
206}
207
208static void mvebu_uart_stop_rx(struct uart_port *port)
209{
210 unsigned int ctl;
211
212 ctl = readl(port->membase + UART_CTRL(port));
213 ctl &= ~CTRL_BRK_INT;
214 writel(ctl, port->membase + UART_CTRL(port));
215
216 ctl = readl(port->membase + UART_INTR(port));
217 ctl &= ~CTRL_RX_RDY_INT(port);
218 writel(ctl, port->membase + UART_INTR(port));
219}
220
221static void mvebu_uart_break_ctl(struct uart_port *port, int brk)
222{
223 unsigned int ctl;
224 unsigned long flags;
225
226 spin_lock_irqsave(&port->lock, flags);
227 ctl = readl(port->membase + UART_CTRL(port));
228 if (brk == -1)
229 ctl |= CTRL_SND_BRK_SEQ;
230 else
231 ctl &= ~CTRL_SND_BRK_SEQ;
232 writel(ctl, port->membase + UART_CTRL(port));
233 spin_unlock_irqrestore(&port->lock, flags);
234}
235
236static void mvebu_uart_rx_chars(struct uart_port *port, unsigned int status)
237{
238 struct tty_port *tport = &port->state->port;
239 unsigned char ch = 0;
240 char flag = 0;
241
242 do {
243 if (status & STAT_RX_RDY(port)) {
244 ch = readl(port->membase + UART_RBR(port));
245 ch &= 0xff;
246 flag = TTY_NORMAL;
247 port->icount.rx++;
248
249 if (status & STAT_PAR_ERR)
250 port->icount.parity++;
251 }
252
253 if (status & STAT_BRK_DET) {
254 port->icount.brk++;
255 status &= ~(STAT_FRM_ERR | STAT_PAR_ERR);
256 if (uart_handle_break(port))
257 goto ignore_char;
258 }
259
260 if (status & STAT_OVR_ERR)
261 port->icount.overrun++;
262
263 if (status & STAT_FRM_ERR)
264 port->icount.frame++;
265
266 if (uart_handle_sysrq_char(port, ch))
267 goto ignore_char;
268
269 if (status & port->ignore_status_mask & STAT_PAR_ERR)
270 status &= ~STAT_RX_RDY(port);
271
272 status &= port->read_status_mask;
273
274 if (status & STAT_PAR_ERR)
275 flag = TTY_PARITY;
276
277 status &= ~port->ignore_status_mask;
278
279 if (status & STAT_RX_RDY(port))
280 tty_insert_flip_char(tport, ch, flag);
281
282 if (status & STAT_BRK_DET)
283 tty_insert_flip_char(tport, 0, TTY_BREAK);
284
285 if (status & STAT_FRM_ERR)
286 tty_insert_flip_char(tport, 0, TTY_FRAME);
287
288 if (status & STAT_OVR_ERR)
289 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
290
291ignore_char:
292 status = readl(port->membase + UART_STAT);
293 } while (status & (STAT_RX_RDY(port) | STAT_BRK_DET));
294
295 tty_flip_buffer_push(tport);
296}
297
298static void mvebu_uart_tx_chars(struct uart_port *port, unsigned int status)
299{
300 struct circ_buf *xmit = &port->state->xmit;
301 unsigned int count;
302 unsigned int st;
303
304 if (port->x_char) {
305 writel(port->x_char, port->membase + UART_TSH(port));
306 port->icount.tx++;
307 port->x_char = 0;
308 return;
309 }
310
311 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
312 mvebu_uart_stop_tx(port);
313 return;
314 }
315
316 for (count = 0; count < port->fifosize; count++) {
317 writel(xmit->buf[xmit->tail], port->membase + UART_TSH(port));
318 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
319 port->icount.tx++;
320
321 if (uart_circ_empty(xmit))
322 break;
323
324 st = readl(port->membase + UART_STAT);
325 if (st & STAT_TX_FIFO_FUL)
326 break;
327 }
328
329 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
330 uart_write_wakeup(port);
331
332 if (uart_circ_empty(xmit))
333 mvebu_uart_stop_tx(port);
334}
335
336static irqreturn_t mvebu_uart_isr(int irq, void *dev_id)
337{
338 struct uart_port *port = (struct uart_port *)dev_id;
339 unsigned int st = readl(port->membase + UART_STAT);
340
341 if (st & (STAT_RX_RDY(port) | STAT_OVR_ERR | STAT_FRM_ERR |
342 STAT_BRK_DET))
343 mvebu_uart_rx_chars(port, st);
344
345 if (st & STAT_TX_RDY(port))
346 mvebu_uart_tx_chars(port, st);
347
348 return IRQ_HANDLED;
349}
350
351static irqreturn_t mvebu_uart_rx_isr(int irq, void *dev_id)
352{
353 struct uart_port *port = (struct uart_port *)dev_id;
354 unsigned int st = readl(port->membase + UART_STAT);
355
356 if (st & (STAT_RX_RDY(port) | STAT_OVR_ERR | STAT_FRM_ERR |
357 STAT_BRK_DET))
358 mvebu_uart_rx_chars(port, st);
359
360 return IRQ_HANDLED;
361}
362
363static irqreturn_t mvebu_uart_tx_isr(int irq, void *dev_id)
364{
365 struct uart_port *port = (struct uart_port *)dev_id;
366 unsigned int st = readl(port->membase + UART_STAT);
367
368 if (st & STAT_TX_RDY(port))
369 mvebu_uart_tx_chars(port, st);
370
371 return IRQ_HANDLED;
372}
373
374static int mvebu_uart_startup(struct uart_port *port)
375{
376 struct mvebu_uart *mvuart = to_mvuart(port);
377 unsigned int ctl;
378 int ret;
379
380 writel(CTRL_TXFIFO_RST | CTRL_RXFIFO_RST,
381 port->membase + UART_CTRL(port));
382 udelay(1);
383
384 /* Clear the error bits of state register before IRQ request */
385 ret = readl(port->membase + UART_STAT);
386 ret |= STAT_BRK_ERR;
387 writel(ret, port->membase + UART_STAT);
388
389 writel(CTRL_BRK_INT, port->membase + UART_CTRL(port));
390
391 ctl = readl(port->membase + UART_INTR(port));
392 ctl |= CTRL_RX_RDY_INT(port);
393 writel(ctl, port->membase + UART_INTR(port));
394
395 if (!mvuart->irq[UART_TX_IRQ]) {
396 /* Old bindings with just one interrupt (UART0 only) */
397 ret = devm_request_irq(port->dev, mvuart->irq[UART_IRQ_SUM],
398 mvebu_uart_isr, port->irqflags,
399 dev_name(port->dev), port);
400 if (ret) {
401 dev_err(port->dev, "unable to request IRQ %d\n",
402 mvuart->irq[UART_IRQ_SUM]);
403 return ret;
404 }
405 } else {
406 /* New bindings with an IRQ for RX and TX (both UART) */
407 ret = devm_request_irq(port->dev, mvuart->irq[UART_RX_IRQ],
408 mvebu_uart_rx_isr, port->irqflags,
409 dev_name(port->dev), port);
410 if (ret) {
411 dev_err(port->dev, "unable to request IRQ %d\n",
412 mvuart->irq[UART_RX_IRQ]);
413 return ret;
414 }
415
416 ret = devm_request_irq(port->dev, mvuart->irq[UART_TX_IRQ],
417 mvebu_uart_tx_isr, port->irqflags,
418 dev_name(port->dev),
419 port);
420 if (ret) {
421 dev_err(port->dev, "unable to request IRQ %d\n",
422 mvuart->irq[UART_TX_IRQ]);
423 devm_free_irq(port->dev, mvuart->irq[UART_RX_IRQ],
424 port);
425 return ret;
426 }
427 }
428
429 return 0;
430}
431
432static void mvebu_uart_shutdown(struct uart_port *port)
433{
434 struct mvebu_uart *mvuart = to_mvuart(port);
435
436 writel(0, port->membase + UART_INTR(port));
437
438 if (!mvuart->irq[UART_TX_IRQ]) {
439 devm_free_irq(port->dev, mvuart->irq[UART_IRQ_SUM], port);
440 } else {
441 devm_free_irq(port->dev, mvuart->irq[UART_RX_IRQ], port);
442 devm_free_irq(port->dev, mvuart->irq[UART_TX_IRQ], port);
443 }
444}
445
446static int mvebu_uart_baud_rate_set(struct uart_port *port, unsigned int baud)
447{
448 struct mvebu_uart *mvuart = to_mvuart(port);
449 unsigned int d_divisor, m_divisor;
450 u32 brdv, osamp;
451
452 if (IS_ERR(mvuart->clk))
453 return -PTR_ERR(mvuart->clk);
454
455 /*
456 * The baudrate is derived from the UART clock thanks to two divisors:
457 * > D ("baud generator"): can divide the clock from 2 to 2^10 - 1.
458 * > M ("fractional divisor"): allows a better accuracy for
459 * baudrates higher than 230400.
460 *
461 * As the derivation of M is rather complicated, the code sticks to its
462 * default value (x16) when all the prescalers are zeroed, and only
463 * makes use of D to configure the desired baudrate.
464 */
465 m_divisor = OSAMP_DEFAULT_DIVISOR;
466 d_divisor = DIV_ROUND_UP(port->uartclk, baud * m_divisor);
467
468 brdv = readl(port->membase + UART_BRDV);
469 brdv &= ~BRDV_BAUD_MASK;
470 brdv |= d_divisor;
471 writel(brdv, port->membase + UART_BRDV);
472
473 osamp = readl(port->membase + UART_OSAMP);
474 osamp &= ~OSAMP_DIVISORS_MASK;
475 writel(osamp, port->membase + UART_OSAMP);
476
477 return 0;
478}
479
480static void mvebu_uart_set_termios(struct uart_port *port,
481 struct ktermios *termios,
482 struct ktermios *old)
483{
484 unsigned long flags;
485 unsigned int baud;
486
487 spin_lock_irqsave(&port->lock, flags);
488
489 port->read_status_mask = STAT_RX_RDY(port) | STAT_OVR_ERR |
490 STAT_TX_RDY(port) | STAT_TX_FIFO_FUL;
491
492 if (termios->c_iflag & INPCK)
493 port->read_status_mask |= STAT_FRM_ERR | STAT_PAR_ERR;
494
495 port->ignore_status_mask = 0;
496 if (termios->c_iflag & IGNPAR)
497 port->ignore_status_mask |=
498 STAT_FRM_ERR | STAT_PAR_ERR | STAT_OVR_ERR;
499
500 if ((termios->c_cflag & CREAD) == 0)
501 port->ignore_status_mask |= STAT_RX_RDY(port) | STAT_BRK_ERR;
502
503 /*
504 * Maximum achievable frequency with simple baudrate divisor is 230400.
505 * Since the error per bit frame would be of more than 15%, achieving
506 * higher frequencies would require to implement the fractional divisor
507 * feature.
508 */
509 baud = uart_get_baud_rate(port, termios, old, 0, 230400);
510 if (mvebu_uart_baud_rate_set(port, baud)) {
511 /* No clock available, baudrate cannot be changed */
512 if (old)
513 baud = uart_get_baud_rate(port, old, NULL, 0, 230400);
514 } else {
515 tty_termios_encode_baud_rate(termios, baud, baud);
516 uart_update_timeout(port, termios->c_cflag, baud);
517 }
518
519 /* Only the following flag changes are supported */
520 if (old) {
521 termios->c_iflag &= INPCK | IGNPAR;
522 termios->c_iflag |= old->c_iflag & ~(INPCK | IGNPAR);
523 termios->c_cflag &= CREAD | CBAUD;
524 termios->c_cflag |= old->c_cflag & ~(CREAD | CBAUD);
525 termios->c_cflag |= CS8;
526 }
527
528 spin_unlock_irqrestore(&port->lock, flags);
529}
530
531static const char *mvebu_uart_type(struct uart_port *port)
532{
533 return MVEBU_UART_TYPE;
534}
535
536static void mvebu_uart_release_port(struct uart_port *port)
537{
538 /* Nothing to do here */
539}
540
541static int mvebu_uart_request_port(struct uart_port *port)
542{
543 return 0;
544}
545
546#ifdef CONFIG_CONSOLE_POLL
547static int mvebu_uart_get_poll_char(struct uart_port *port)
548{
549 unsigned int st = readl(port->membase + UART_STAT);
550
551 if (!(st & STAT_RX_RDY(port)))
552 return NO_POLL_CHAR;
553
554 return readl(port->membase + UART_RBR(port));
555}
556
557static void mvebu_uart_put_poll_char(struct uart_port *port, unsigned char c)
558{
559 unsigned int st;
560
561 for (;;) {
562 st = readl(port->membase + UART_STAT);
563
564 if (!(st & STAT_TX_FIFO_FUL))
565 break;
566
567 udelay(1);
568 }
569
570 writel(c, port->membase + UART_TSH(port));
571}
572#endif
573
574static const struct uart_ops mvebu_uart_ops = {
575 .tx_empty = mvebu_uart_tx_empty,
576 .set_mctrl = mvebu_uart_set_mctrl,
577 .get_mctrl = mvebu_uart_get_mctrl,
578 .stop_tx = mvebu_uart_stop_tx,
579 .start_tx = mvebu_uart_start_tx,
580 .stop_rx = mvebu_uart_stop_rx,
581 .break_ctl = mvebu_uart_break_ctl,
582 .startup = mvebu_uart_startup,
583 .shutdown = mvebu_uart_shutdown,
584 .set_termios = mvebu_uart_set_termios,
585 .type = mvebu_uart_type,
586 .release_port = mvebu_uart_release_port,
587 .request_port = mvebu_uart_request_port,
588#ifdef CONFIG_CONSOLE_POLL
589 .poll_get_char = mvebu_uart_get_poll_char,
590 .poll_put_char = mvebu_uart_put_poll_char,
591#endif
592};
593
594/* Console Driver Operations */
595
596#ifdef CONFIG_SERIAL_MVEBU_CONSOLE
597/* Early Console */
598static void mvebu_uart_putc(struct uart_port *port, int c)
599{
600 unsigned int st;
601
602 for (;;) {
603 st = readl(port->membase + UART_STAT);
604 if (!(st & STAT_TX_FIFO_FUL))
605 break;
606 }
607
608 /* At early stage, DT is not parsed yet, only use UART0 */
609 writel(c, port->membase + UART_STD_TSH);
610
611 for (;;) {
612 st = readl(port->membase + UART_STAT);
613 if (st & STAT_TX_FIFO_EMP)
614 break;
615 }
616}
617
618static void mvebu_uart_putc_early_write(struct console *con,
619 const char *s,
620 unsigned n)
621{
622 struct earlycon_device *dev = con->data;
623
624 uart_console_write(&dev->port, s, n, mvebu_uart_putc);
625}
626
627static int __init
628mvebu_uart_early_console_setup(struct earlycon_device *device,
629 const char *opt)
630{
631 if (!device->port.membase)
632 return -ENODEV;
633
634 device->con->write = mvebu_uart_putc_early_write;
635
636 return 0;
637}
638
639EARLYCON_DECLARE(ar3700_uart, mvebu_uart_early_console_setup);
640OF_EARLYCON_DECLARE(ar3700_uart, "marvell,armada-3700-uart",
641 mvebu_uart_early_console_setup);
642
643static void wait_for_xmitr(struct uart_port *port)
644{
645 u32 val;
646
647 readl_poll_timeout_atomic(port->membase + UART_STAT, val,
648 (val & STAT_TX_RDY(port)), 1, 10000);
649}
650
651static void mvebu_uart_console_putchar(struct uart_port *port, int ch)
652{
653 wait_for_xmitr(port);
654 writel(ch, port->membase + UART_TSH(port));
655}
656
657static void mvebu_uart_console_write(struct console *co, const char *s,
658 unsigned int count)
659{
660 struct uart_port *port = &mvebu_uart_ports[co->index];
661 unsigned long flags;
662 unsigned int ier, intr, ctl;
663 int locked = 1;
664
665 if (oops_in_progress)
666 locked = spin_trylock_irqsave(&port->lock, flags);
667 else
668 spin_lock_irqsave(&port->lock, flags);
669
670 ier = readl(port->membase + UART_CTRL(port)) & CTRL_BRK_INT;
671 intr = readl(port->membase + UART_INTR(port)) &
672 (CTRL_RX_RDY_INT(port) | CTRL_TX_RDY_INT(port));
673 writel(0, port->membase + UART_CTRL(port));
674 writel(0, port->membase + UART_INTR(port));
675
676 uart_console_write(port, s, count, mvebu_uart_console_putchar);
677
678 wait_for_xmitr(port);
679
680 if (ier)
681 writel(ier, port->membase + UART_CTRL(port));
682
683 if (intr) {
684 ctl = intr | readl(port->membase + UART_INTR(port));
685 writel(ctl, port->membase + UART_INTR(port));
686 }
687
688 if (locked)
689 spin_unlock_irqrestore(&port->lock, flags);
690}
691
692static int mvebu_uart_console_setup(struct console *co, char *options)
693{
694 struct uart_port *port;
695 int baud = 9600;
696 int bits = 8;
697 int parity = 'n';
698 int flow = 'n';
699
700 if (co->index < 0 || co->index >= MVEBU_NR_UARTS)
701 return -EINVAL;
702
703 port = &mvebu_uart_ports[co->index];
704
705 if (!port->mapbase || !port->membase) {
706 pr_debug("console on ttyMV%i not present\n", co->index);
707 return -ENODEV;
708 }
709
710 if (options)
711 uart_parse_options(options, &baud, &parity, &bits, &flow);
712
713 return uart_set_options(port, co, baud, parity, bits, flow);
714}
715
716static struct uart_driver mvebu_uart_driver;
717
718static struct console mvebu_uart_console = {
719 .name = "ttyMV",
720 .write = mvebu_uart_console_write,
721 .device = uart_console_device,
722 .setup = mvebu_uart_console_setup,
723 .flags = CON_PRINTBUFFER,
724 .index = -1,
725 .data = &mvebu_uart_driver,
726};
727
728static int __init mvebu_uart_console_init(void)
729{
730 register_console(&mvebu_uart_console);
731 return 0;
732}
733
734console_initcall(mvebu_uart_console_init);
735
736
737#endif /* CONFIG_SERIAL_MVEBU_CONSOLE */
738
739static struct uart_driver mvebu_uart_driver = {
740 .owner = THIS_MODULE,
741 .driver_name = DRIVER_NAME,
742 .dev_name = "ttyMV",
743 .nr = MVEBU_NR_UARTS,
744#ifdef CONFIG_SERIAL_MVEBU_CONSOLE
745 .cons = &mvebu_uart_console,
746#endif
747};
748
749#if defined(CONFIG_PM)
750static int mvebu_uart_suspend(struct device *dev)
751{
752 struct mvebu_uart *mvuart = dev_get_drvdata(dev);
753 struct uart_port *port = mvuart->port;
754
755 uart_suspend_port(&mvebu_uart_driver, port);
756
757 mvuart->pm_regs.rbr = readl(port->membase + UART_RBR(port));
758 mvuart->pm_regs.tsh = readl(port->membase + UART_TSH(port));
759 mvuart->pm_regs.ctrl = readl(port->membase + UART_CTRL(port));
760 mvuart->pm_regs.intr = readl(port->membase + UART_INTR(port));
761 mvuart->pm_regs.stat = readl(port->membase + UART_STAT);
762 mvuart->pm_regs.brdv = readl(port->membase + UART_BRDV);
763 mvuart->pm_regs.osamp = readl(port->membase + UART_OSAMP);
764
765 device_set_wakeup_enable(dev, true);
766
767 return 0;
768}
769
770static int mvebu_uart_resume(struct device *dev)
771{
772 struct mvebu_uart *mvuart = dev_get_drvdata(dev);
773 struct uart_port *port = mvuart->port;
774
775 writel(mvuart->pm_regs.rbr, port->membase + UART_RBR(port));
776 writel(mvuart->pm_regs.tsh, port->membase + UART_TSH(port));
777 writel(mvuart->pm_regs.ctrl, port->membase + UART_CTRL(port));
778 writel(mvuart->pm_regs.intr, port->membase + UART_INTR(port));
779 writel(mvuart->pm_regs.stat, port->membase + UART_STAT);
780 writel(mvuart->pm_regs.brdv, port->membase + UART_BRDV);
781 writel(mvuart->pm_regs.osamp, port->membase + UART_OSAMP);
782
783 uart_resume_port(&mvebu_uart_driver, port);
784
785 return 0;
786}
787
788static const struct dev_pm_ops mvebu_uart_pm_ops = {
789 .suspend = mvebu_uart_suspend,
790 .resume = mvebu_uart_resume,
791};
792#endif /* CONFIG_PM */
793
794static const struct of_device_id mvebu_uart_of_match[];
795
796/* Counter to keep track of each UART port id when not using CONFIG_OF */
797static int uart_num_counter;
798
799static int mvebu_uart_probe(struct platform_device *pdev)
800{
801 struct resource *reg = platform_get_resource(pdev, IORESOURCE_MEM, 0);
802 const struct of_device_id *match = of_match_device(mvebu_uart_of_match,
803 &pdev->dev);
804 struct uart_port *port;
805 struct mvebu_uart *mvuart;
806 int ret, id, irq;
807
808 if (!reg) {
809 dev_err(&pdev->dev, "no registers defined\n");
810 return -EINVAL;
811 }
812
813 if (!match)
814 return -ENODEV;
815
816 /* Assume that all UART ports have a DT alias or none has */
817 id = of_alias_get_id(pdev->dev.of_node, "serial");
818 if (!pdev->dev.of_node || id < 0)
819 pdev->id = uart_num_counter++;
820 else
821 pdev->id = id;
822
823 if (pdev->id >= MVEBU_NR_UARTS) {
824 dev_err(&pdev->dev, "cannot have more than %d UART ports\n",
825 MVEBU_NR_UARTS);
826 return -EINVAL;
827 }
828
829 port = &mvebu_uart_ports[pdev->id];
830
831 spin_lock_init(&port->lock);
832
833 port->dev = &pdev->dev;
834 port->type = PORT_MVEBU;
835 port->ops = &mvebu_uart_ops;
836 port->regshift = 0;
837
838 port->fifosize = 32;
839 port->iotype = UPIO_MEM32;
840 port->flags = UPF_FIXED_PORT;
841 port->line = pdev->id;
842
843 /*
844 * IRQ number is not stored in this structure because we may have two of
845 * them per port (RX and TX). Instead, use the driver UART structure
846 * array so called ->irq[].
847 */
848 port->irq = 0;
849 port->irqflags = 0;
850 port->mapbase = reg->start;
851
852 port->membase = devm_ioremap_resource(&pdev->dev, reg);
853 if (IS_ERR(port->membase))
854 return PTR_ERR(port->membase);
855
856 mvuart = devm_kzalloc(&pdev->dev, sizeof(struct mvebu_uart),
857 GFP_KERNEL);
858 if (!mvuart)
859 return -ENOMEM;
860
861 /* Get controller data depending on the compatible string */
862 mvuart->data = (struct mvebu_uart_driver_data *)match->data;
863 mvuart->port = port;
864
865 port->private_data = mvuart;
866 platform_set_drvdata(pdev, mvuart);
867
868 /* Get fixed clock frequency */
869 mvuart->clk = devm_clk_get(&pdev->dev, NULL);
870 if (IS_ERR(mvuart->clk)) {
871 if (PTR_ERR(mvuart->clk) == -EPROBE_DEFER)
872 return PTR_ERR(mvuart->clk);
873
874 if (IS_EXTENDED(port)) {
875 dev_err(&pdev->dev, "unable to get UART clock\n");
876 return PTR_ERR(mvuart->clk);
877 }
878 } else {
879 if (!clk_prepare_enable(mvuart->clk))
880 port->uartclk = clk_get_rate(mvuart->clk);
881 }
882
883 /* Manage interrupts */
884 if (platform_irq_count(pdev) == 1) {
885 /* Old bindings: no name on the single unamed UART0 IRQ */
886 irq = platform_get_irq(pdev, 0);
887 if (irq < 0)
888 return irq;
889
890 mvuart->irq[UART_IRQ_SUM] = irq;
891 } else {
892 /*
893 * New bindings: named interrupts (RX, TX) for both UARTS,
894 * only make use of uart-rx and uart-tx interrupts, do not use
895 * uart-sum of UART0 port.
896 */
897 irq = platform_get_irq_byname(pdev, "uart-rx");
898 if (irq < 0)
899 return irq;
900
901 mvuart->irq[UART_RX_IRQ] = irq;
902
903 irq = platform_get_irq_byname(pdev, "uart-tx");
904 if (irq < 0)
905 return irq;
906
907 mvuart->irq[UART_TX_IRQ] = irq;
908 }
909
910 /* UART Soft Reset*/
911 writel(CTRL_SOFT_RST, port->membase + UART_CTRL(port));
912 udelay(1);
913 writel(0, port->membase + UART_CTRL(port));
914
915 ret = uart_add_one_port(&mvebu_uart_driver, port);
916 if (ret)
917 return ret;
918 return 0;
919}
920
921static struct mvebu_uart_driver_data uart_std_driver_data = {
922 .is_ext = false,
923 .regs.rbr = UART_STD_RBR,
924 .regs.tsh = UART_STD_TSH,
925 .regs.ctrl = UART_STD_CTRL1,
926 .regs.intr = UART_STD_CTRL2,
927 .flags.ctrl_tx_rdy_int = CTRL_STD_TX_RDY_INT,
928 .flags.ctrl_rx_rdy_int = CTRL_STD_RX_RDY_INT,
929 .flags.stat_tx_rdy = STAT_STD_TX_RDY,
930 .flags.stat_rx_rdy = STAT_STD_RX_RDY,
931};
932
933static struct mvebu_uart_driver_data uart_ext_driver_data = {
934 .is_ext = true,
935 .regs.rbr = UART_EXT_RBR,
936 .regs.tsh = UART_EXT_TSH,
937 .regs.ctrl = UART_EXT_CTRL1,
938 .regs.intr = UART_EXT_CTRL2,
939 .flags.ctrl_tx_rdy_int = CTRL_EXT_TX_RDY_INT,
940 .flags.ctrl_rx_rdy_int = CTRL_EXT_RX_RDY_INT,
941 .flags.stat_tx_rdy = STAT_EXT_TX_RDY,
942 .flags.stat_rx_rdy = STAT_EXT_RX_RDY,
943};
944
945/* Match table for of_platform binding */
946static const struct of_device_id mvebu_uart_of_match[] = {
947 {
948 .compatible = "marvell,armada-3700-uart",
949 .data = (void *)&uart_std_driver_data,
950 },
951 {
952 .compatible = "marvell,armada-3700-uart-ext",
953 .data = (void *)&uart_ext_driver_data,
954 },
955 {}
956};
957
958static struct platform_driver mvebu_uart_platform_driver = {
959 .probe = mvebu_uart_probe,
960 .driver = {
961 .name = "mvebu-uart",
962 .of_match_table = of_match_ptr(mvebu_uart_of_match),
963 .suppress_bind_attrs = true,
964#if defined(CONFIG_PM)
965 .pm = &mvebu_uart_pm_ops,
966#endif /* CONFIG_PM */
967 },
968};
969
970static int __init mvebu_uart_init(void)
971{
972 int ret;
973
974 ret = uart_register_driver(&mvebu_uart_driver);
975 if (ret)
976 return ret;
977
978 ret = platform_driver_register(&mvebu_uart_platform_driver);
979 if (ret)
980 uart_unregister_driver(&mvebu_uart_driver);
981
982 return ret;
983}
984arch_initcall(mvebu_uart_init);
1// SPDX-License-Identifier: GPL-2.0+
2/*
3* ***************************************************************************
4* Marvell Armada-3700 Serial Driver
5* Author: Wilson Ding <dingwei@marvell.com>
6* Copyright (C) 2015 Marvell International Ltd.
7* ***************************************************************************
8*/
9
10#include <linux/clk.h>
11#include <linux/console.h>
12#include <linux/delay.h>
13#include <linux/device.h>
14#include <linux/init.h>
15#include <linux/io.h>
16#include <linux/iopoll.h>
17#include <linux/of.h>
18#include <linux/of_address.h>
19#include <linux/of_device.h>
20#include <linux/of_irq.h>
21#include <linux/of_platform.h>
22#include <linux/platform_device.h>
23#include <linux/serial.h>
24#include <linux/serial_core.h>
25#include <linux/slab.h>
26#include <linux/tty.h>
27#include <linux/tty_flip.h>
28
29/* Register Map */
30#define UART_STD_RBR 0x00
31#define UART_EXT_RBR 0x18
32
33#define UART_STD_TSH 0x04
34#define UART_EXT_TSH 0x1C
35
36#define UART_STD_CTRL1 0x08
37#define UART_EXT_CTRL1 0x04
38#define CTRL_SOFT_RST BIT(31)
39#define CTRL_TXFIFO_RST BIT(15)
40#define CTRL_RXFIFO_RST BIT(14)
41#define CTRL_SND_BRK_SEQ BIT(11)
42#define CTRL_BRK_DET_INT BIT(3)
43#define CTRL_FRM_ERR_INT BIT(2)
44#define CTRL_PAR_ERR_INT BIT(1)
45#define CTRL_OVR_ERR_INT BIT(0)
46#define CTRL_BRK_INT (CTRL_BRK_DET_INT | CTRL_FRM_ERR_INT | \
47 CTRL_PAR_ERR_INT | CTRL_OVR_ERR_INT)
48
49#define UART_STD_CTRL2 UART_STD_CTRL1
50#define UART_EXT_CTRL2 0x20
51#define CTRL_STD_TX_RDY_INT BIT(5)
52#define CTRL_EXT_TX_RDY_INT BIT(6)
53#define CTRL_STD_RX_RDY_INT BIT(4)
54#define CTRL_EXT_RX_RDY_INT BIT(5)
55
56#define UART_STAT 0x0C
57#define STAT_TX_FIFO_EMP BIT(13)
58#define STAT_TX_FIFO_FUL BIT(11)
59#define STAT_TX_EMP BIT(6)
60#define STAT_STD_TX_RDY BIT(5)
61#define STAT_EXT_TX_RDY BIT(15)
62#define STAT_STD_RX_RDY BIT(4)
63#define STAT_EXT_RX_RDY BIT(14)
64#define STAT_BRK_DET BIT(3)
65#define STAT_FRM_ERR BIT(2)
66#define STAT_PAR_ERR BIT(1)
67#define STAT_OVR_ERR BIT(0)
68#define STAT_BRK_ERR (STAT_BRK_DET | STAT_FRM_ERR \
69 | STAT_PAR_ERR | STAT_OVR_ERR)
70
71#define UART_BRDV 0x10
72#define BRDV_BAUD_MASK 0x3FF
73
74#define MVEBU_NR_UARTS 2
75
76#define MVEBU_UART_TYPE "mvebu-uart"
77#define DRIVER_NAME "mvebu_serial"
78
79enum {
80 /* Either there is only one summed IRQ... */
81 UART_IRQ_SUM = 0,
82 /* ...or there are two separate IRQ for RX and TX */
83 UART_RX_IRQ = 0,
84 UART_TX_IRQ,
85 UART_IRQ_COUNT
86};
87
88/* Diverging register offsets */
89struct uart_regs_layout {
90 unsigned int rbr;
91 unsigned int tsh;
92 unsigned int ctrl;
93 unsigned int intr;
94};
95
96/* Diverging flags */
97struct uart_flags {
98 unsigned int ctrl_tx_rdy_int;
99 unsigned int ctrl_rx_rdy_int;
100 unsigned int stat_tx_rdy;
101 unsigned int stat_rx_rdy;
102};
103
104/* Driver data, a structure for each UART port */
105struct mvebu_uart_driver_data {
106 bool is_ext;
107 struct uart_regs_layout regs;
108 struct uart_flags flags;
109};
110
111/* MVEBU UART driver structure */
112struct mvebu_uart {
113 struct uart_port *port;
114 struct clk *clk;
115 int irq[UART_IRQ_COUNT];
116 unsigned char __iomem *nb;
117 struct mvebu_uart_driver_data *data;
118};
119
120static struct mvebu_uart *to_mvuart(struct uart_port *port)
121{
122 return (struct mvebu_uart *)port->private_data;
123}
124
125#define IS_EXTENDED(port) (to_mvuart(port)->data->is_ext)
126
127#define UART_RBR(port) (to_mvuart(port)->data->regs.rbr)
128#define UART_TSH(port) (to_mvuart(port)->data->regs.tsh)
129#define UART_CTRL(port) (to_mvuart(port)->data->regs.ctrl)
130#define UART_INTR(port) (to_mvuart(port)->data->regs.intr)
131
132#define CTRL_TX_RDY_INT(port) (to_mvuart(port)->data->flags.ctrl_tx_rdy_int)
133#define CTRL_RX_RDY_INT(port) (to_mvuart(port)->data->flags.ctrl_rx_rdy_int)
134#define STAT_TX_RDY(port) (to_mvuart(port)->data->flags.stat_tx_rdy)
135#define STAT_RX_RDY(port) (to_mvuart(port)->data->flags.stat_rx_rdy)
136
137static struct uart_port mvebu_uart_ports[MVEBU_NR_UARTS];
138
139/* Core UART Driver Operations */
140static unsigned int mvebu_uart_tx_empty(struct uart_port *port)
141{
142 unsigned long flags;
143 unsigned int st;
144
145 spin_lock_irqsave(&port->lock, flags);
146 st = readl(port->membase + UART_STAT);
147 spin_unlock_irqrestore(&port->lock, flags);
148
149 return (st & STAT_TX_FIFO_EMP) ? TIOCSER_TEMT : 0;
150}
151
152static unsigned int mvebu_uart_get_mctrl(struct uart_port *port)
153{
154 return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
155}
156
157static void mvebu_uart_set_mctrl(struct uart_port *port,
158 unsigned int mctrl)
159{
160/*
161 * Even if we do not support configuring the modem control lines, this
162 * function must be proided to the serial core
163 */
164}
165
166static void mvebu_uart_stop_tx(struct uart_port *port)
167{
168 unsigned int ctl = readl(port->membase + UART_INTR(port));
169
170 ctl &= ~CTRL_TX_RDY_INT(port);
171 writel(ctl, port->membase + UART_INTR(port));
172}
173
174static void mvebu_uart_start_tx(struct uart_port *port)
175{
176 unsigned int ctl;
177 struct circ_buf *xmit = &port->state->xmit;
178
179 if (IS_EXTENDED(port) && !uart_circ_empty(xmit)) {
180 writel(xmit->buf[xmit->tail], port->membase + UART_TSH(port));
181 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
182 port->icount.tx++;
183 }
184
185 ctl = readl(port->membase + UART_INTR(port));
186 ctl |= CTRL_TX_RDY_INT(port);
187 writel(ctl, port->membase + UART_INTR(port));
188}
189
190static void mvebu_uart_stop_rx(struct uart_port *port)
191{
192 unsigned int ctl;
193
194 ctl = readl(port->membase + UART_CTRL(port));
195 ctl &= ~CTRL_BRK_INT;
196 writel(ctl, port->membase + UART_CTRL(port));
197
198 ctl = readl(port->membase + UART_INTR(port));
199 ctl &= ~CTRL_RX_RDY_INT(port);
200 writel(ctl, port->membase + UART_INTR(port));
201}
202
203static void mvebu_uart_break_ctl(struct uart_port *port, int brk)
204{
205 unsigned int ctl;
206 unsigned long flags;
207
208 spin_lock_irqsave(&port->lock, flags);
209 ctl = readl(port->membase + UART_CTRL(port));
210 if (brk == -1)
211 ctl |= CTRL_SND_BRK_SEQ;
212 else
213 ctl &= ~CTRL_SND_BRK_SEQ;
214 writel(ctl, port->membase + UART_CTRL(port));
215 spin_unlock_irqrestore(&port->lock, flags);
216}
217
218static void mvebu_uart_rx_chars(struct uart_port *port, unsigned int status)
219{
220 struct tty_port *tport = &port->state->port;
221 unsigned char ch = 0;
222 char flag = 0;
223
224 do {
225 if (status & STAT_RX_RDY(port)) {
226 ch = readl(port->membase + UART_RBR(port));
227 ch &= 0xff;
228 flag = TTY_NORMAL;
229 port->icount.rx++;
230
231 if (status & STAT_PAR_ERR)
232 port->icount.parity++;
233 }
234
235 if (status & STAT_BRK_DET) {
236 port->icount.brk++;
237 status &= ~(STAT_FRM_ERR | STAT_PAR_ERR);
238 if (uart_handle_break(port))
239 goto ignore_char;
240 }
241
242 if (status & STAT_OVR_ERR)
243 port->icount.overrun++;
244
245 if (status & STAT_FRM_ERR)
246 port->icount.frame++;
247
248 if (uart_handle_sysrq_char(port, ch))
249 goto ignore_char;
250
251 if (status & port->ignore_status_mask & STAT_PAR_ERR)
252 status &= ~STAT_RX_RDY(port);
253
254 status &= port->read_status_mask;
255
256 if (status & STAT_PAR_ERR)
257 flag = TTY_PARITY;
258
259 status &= ~port->ignore_status_mask;
260
261 if (status & STAT_RX_RDY(port))
262 tty_insert_flip_char(tport, ch, flag);
263
264 if (status & STAT_BRK_DET)
265 tty_insert_flip_char(tport, 0, TTY_BREAK);
266
267 if (status & STAT_FRM_ERR)
268 tty_insert_flip_char(tport, 0, TTY_FRAME);
269
270 if (status & STAT_OVR_ERR)
271 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
272
273ignore_char:
274 status = readl(port->membase + UART_STAT);
275 } while (status & (STAT_RX_RDY(port) | STAT_BRK_DET));
276
277 tty_flip_buffer_push(tport);
278}
279
280static void mvebu_uart_tx_chars(struct uart_port *port, unsigned int status)
281{
282 struct circ_buf *xmit = &port->state->xmit;
283 unsigned int count;
284 unsigned int st;
285
286 if (port->x_char) {
287 writel(port->x_char, port->membase + UART_TSH(port));
288 port->icount.tx++;
289 port->x_char = 0;
290 return;
291 }
292
293 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
294 mvebu_uart_stop_tx(port);
295 return;
296 }
297
298 for (count = 0; count < port->fifosize; count++) {
299 writel(xmit->buf[xmit->tail], port->membase + UART_TSH(port));
300 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
301 port->icount.tx++;
302
303 if (uart_circ_empty(xmit))
304 break;
305
306 st = readl(port->membase + UART_STAT);
307 if (st & STAT_TX_FIFO_FUL)
308 break;
309 }
310
311 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
312 uart_write_wakeup(port);
313
314 if (uart_circ_empty(xmit))
315 mvebu_uart_stop_tx(port);
316}
317
318static irqreturn_t mvebu_uart_isr(int irq, void *dev_id)
319{
320 struct uart_port *port = (struct uart_port *)dev_id;
321 unsigned int st = readl(port->membase + UART_STAT);
322
323 if (st & (STAT_RX_RDY(port) | STAT_OVR_ERR | STAT_FRM_ERR |
324 STAT_BRK_DET))
325 mvebu_uart_rx_chars(port, st);
326
327 if (st & STAT_TX_RDY(port))
328 mvebu_uart_tx_chars(port, st);
329
330 return IRQ_HANDLED;
331}
332
333static irqreturn_t mvebu_uart_rx_isr(int irq, void *dev_id)
334{
335 struct uart_port *port = (struct uart_port *)dev_id;
336 unsigned int st = readl(port->membase + UART_STAT);
337
338 if (st & (STAT_RX_RDY(port) | STAT_OVR_ERR | STAT_FRM_ERR |
339 STAT_BRK_DET))
340 mvebu_uart_rx_chars(port, st);
341
342 return IRQ_HANDLED;
343}
344
345static irqreturn_t mvebu_uart_tx_isr(int irq, void *dev_id)
346{
347 struct uart_port *port = (struct uart_port *)dev_id;
348 unsigned int st = readl(port->membase + UART_STAT);
349
350 if (st & STAT_TX_RDY(port))
351 mvebu_uart_tx_chars(port, st);
352
353 return IRQ_HANDLED;
354}
355
356static int mvebu_uart_startup(struct uart_port *port)
357{
358 struct mvebu_uart *mvuart = to_mvuart(port);
359 unsigned int ctl;
360 int ret;
361
362 writel(CTRL_TXFIFO_RST | CTRL_RXFIFO_RST,
363 port->membase + UART_CTRL(port));
364 udelay(1);
365
366 /* Clear the error bits of state register before IRQ request */
367 ret = readl(port->membase + UART_STAT);
368 ret |= STAT_BRK_ERR;
369 writel(ret, port->membase + UART_STAT);
370
371 writel(CTRL_BRK_INT, port->membase + UART_CTRL(port));
372
373 ctl = readl(port->membase + UART_INTR(port));
374 ctl |= CTRL_RX_RDY_INT(port);
375 writel(ctl, port->membase + UART_INTR(port));
376
377 if (!mvuart->irq[UART_TX_IRQ]) {
378 /* Old bindings with just one interrupt (UART0 only) */
379 ret = devm_request_irq(port->dev, mvuart->irq[UART_IRQ_SUM],
380 mvebu_uart_isr, port->irqflags,
381 dev_name(port->dev), port);
382 if (ret) {
383 dev_err(port->dev, "unable to request IRQ %d\n",
384 mvuart->irq[UART_IRQ_SUM]);
385 return ret;
386 }
387 } else {
388 /* New bindings with an IRQ for RX and TX (both UART) */
389 ret = devm_request_irq(port->dev, mvuart->irq[UART_RX_IRQ],
390 mvebu_uart_rx_isr, port->irqflags,
391 dev_name(port->dev), port);
392 if (ret) {
393 dev_err(port->dev, "unable to request IRQ %d\n",
394 mvuart->irq[UART_RX_IRQ]);
395 return ret;
396 }
397
398 ret = devm_request_irq(port->dev, mvuart->irq[UART_TX_IRQ],
399 mvebu_uart_tx_isr, port->irqflags,
400 dev_name(port->dev),
401 port);
402 if (ret) {
403 dev_err(port->dev, "unable to request IRQ %d\n",
404 mvuart->irq[UART_TX_IRQ]);
405 devm_free_irq(port->dev, mvuart->irq[UART_RX_IRQ],
406 port);
407 return ret;
408 }
409 }
410
411 return 0;
412}
413
414static void mvebu_uart_shutdown(struct uart_port *port)
415{
416 struct mvebu_uart *mvuart = to_mvuart(port);
417
418 writel(0, port->membase + UART_INTR(port));
419
420 if (!mvuart->irq[UART_TX_IRQ]) {
421 devm_free_irq(port->dev, mvuart->irq[UART_IRQ_SUM], port);
422 } else {
423 devm_free_irq(port->dev, mvuart->irq[UART_RX_IRQ], port);
424 devm_free_irq(port->dev, mvuart->irq[UART_TX_IRQ], port);
425 }
426}
427
428static int mvebu_uart_baud_rate_set(struct uart_port *port, unsigned int baud)
429{
430 struct mvebu_uart *mvuart = to_mvuart(port);
431 unsigned int baud_rate_div;
432 u32 brdv;
433
434 if (IS_ERR(mvuart->clk))
435 return -PTR_ERR(mvuart->clk);
436
437 /*
438 * The UART clock is divided by the value of the divisor to generate
439 * UCLK_OUT clock, which is 16 times faster than the baudrate.
440 * This prescaler can achieve all standard baudrates until 230400.
441 * Higher baudrates could be achieved for the extended UART by using the
442 * programmable oversampling stack (also called fractional divisor).
443 */
444 baud_rate_div = DIV_ROUND_UP(port->uartclk, baud * 16);
445 brdv = readl(port->membase + UART_BRDV);
446 brdv &= ~BRDV_BAUD_MASK;
447 brdv |= baud_rate_div;
448 writel(brdv, port->membase + UART_BRDV);
449
450 return 0;
451}
452
453static void mvebu_uart_set_termios(struct uart_port *port,
454 struct ktermios *termios,
455 struct ktermios *old)
456{
457 unsigned long flags;
458 unsigned int baud;
459
460 spin_lock_irqsave(&port->lock, flags);
461
462 port->read_status_mask = STAT_RX_RDY(port) | STAT_OVR_ERR |
463 STAT_TX_RDY(port) | STAT_TX_FIFO_FUL;
464
465 if (termios->c_iflag & INPCK)
466 port->read_status_mask |= STAT_FRM_ERR | STAT_PAR_ERR;
467
468 port->ignore_status_mask = 0;
469 if (termios->c_iflag & IGNPAR)
470 port->ignore_status_mask |=
471 STAT_FRM_ERR | STAT_PAR_ERR | STAT_OVR_ERR;
472
473 if ((termios->c_cflag & CREAD) == 0)
474 port->ignore_status_mask |= STAT_RX_RDY(port) | STAT_BRK_ERR;
475
476 /*
477 * Maximum achievable frequency with simple baudrate divisor is 230400.
478 * Since the error per bit frame would be of more than 15%, achieving
479 * higher frequencies would require to implement the fractional divisor
480 * feature.
481 */
482 baud = uart_get_baud_rate(port, termios, old, 0, 230400);
483 if (mvebu_uart_baud_rate_set(port, baud)) {
484 /* No clock available, baudrate cannot be changed */
485 if (old)
486 baud = uart_get_baud_rate(port, old, NULL, 0, 230400);
487 } else {
488 tty_termios_encode_baud_rate(termios, baud, baud);
489 uart_update_timeout(port, termios->c_cflag, baud);
490 }
491
492 /* Only the following flag changes are supported */
493 if (old) {
494 termios->c_iflag &= INPCK | IGNPAR;
495 termios->c_iflag |= old->c_iflag & ~(INPCK | IGNPAR);
496 termios->c_cflag &= CREAD | CBAUD;
497 termios->c_cflag |= old->c_cflag & ~(CREAD | CBAUD);
498 }
499
500 spin_unlock_irqrestore(&port->lock, flags);
501}
502
503static const char *mvebu_uart_type(struct uart_port *port)
504{
505 return MVEBU_UART_TYPE;
506}
507
508static void mvebu_uart_release_port(struct uart_port *port)
509{
510 /* Nothing to do here */
511}
512
513static int mvebu_uart_request_port(struct uart_port *port)
514{
515 return 0;
516}
517
518#ifdef CONFIG_CONSOLE_POLL
519static int mvebu_uart_get_poll_char(struct uart_port *port)
520{
521 unsigned int st = readl(port->membase + UART_STAT);
522
523 if (!(st & STAT_RX_RDY(port)))
524 return NO_POLL_CHAR;
525
526 return readl(port->membase + UART_RBR(port));
527}
528
529static void mvebu_uart_put_poll_char(struct uart_port *port, unsigned char c)
530{
531 unsigned int st;
532
533 for (;;) {
534 st = readl(port->membase + UART_STAT);
535
536 if (!(st & STAT_TX_FIFO_FUL))
537 break;
538
539 udelay(1);
540 }
541
542 writel(c, port->membase + UART_TSH(port));
543}
544#endif
545
546static const struct uart_ops mvebu_uart_ops = {
547 .tx_empty = mvebu_uart_tx_empty,
548 .set_mctrl = mvebu_uart_set_mctrl,
549 .get_mctrl = mvebu_uart_get_mctrl,
550 .stop_tx = mvebu_uart_stop_tx,
551 .start_tx = mvebu_uart_start_tx,
552 .stop_rx = mvebu_uart_stop_rx,
553 .break_ctl = mvebu_uart_break_ctl,
554 .startup = mvebu_uart_startup,
555 .shutdown = mvebu_uart_shutdown,
556 .set_termios = mvebu_uart_set_termios,
557 .type = mvebu_uart_type,
558 .release_port = mvebu_uart_release_port,
559 .request_port = mvebu_uart_request_port,
560#ifdef CONFIG_CONSOLE_POLL
561 .poll_get_char = mvebu_uart_get_poll_char,
562 .poll_put_char = mvebu_uart_put_poll_char,
563#endif
564};
565
566/* Console Driver Operations */
567
568#ifdef CONFIG_SERIAL_MVEBU_CONSOLE
569/* Early Console */
570static void mvebu_uart_putc(struct uart_port *port, int c)
571{
572 unsigned int st;
573
574 for (;;) {
575 st = readl(port->membase + UART_STAT);
576 if (!(st & STAT_TX_FIFO_FUL))
577 break;
578 }
579
580 /* At early stage, DT is not parsed yet, only use UART0 */
581 writel(c, port->membase + UART_STD_TSH);
582
583 for (;;) {
584 st = readl(port->membase + UART_STAT);
585 if (st & STAT_TX_FIFO_EMP)
586 break;
587 }
588}
589
590static void mvebu_uart_putc_early_write(struct console *con,
591 const char *s,
592 unsigned n)
593{
594 struct earlycon_device *dev = con->data;
595
596 uart_console_write(&dev->port, s, n, mvebu_uart_putc);
597}
598
599static int __init
600mvebu_uart_early_console_setup(struct earlycon_device *device,
601 const char *opt)
602{
603 if (!device->port.membase)
604 return -ENODEV;
605
606 device->con->write = mvebu_uart_putc_early_write;
607
608 return 0;
609}
610
611EARLYCON_DECLARE(ar3700_uart, mvebu_uart_early_console_setup);
612OF_EARLYCON_DECLARE(ar3700_uart, "marvell,armada-3700-uart",
613 mvebu_uart_early_console_setup);
614
615static void wait_for_xmitr(struct uart_port *port)
616{
617 u32 val;
618
619 readl_poll_timeout_atomic(port->membase + UART_STAT, val,
620 (val & STAT_TX_RDY(port)), 1, 10000);
621}
622
623static void mvebu_uart_console_putchar(struct uart_port *port, int ch)
624{
625 wait_for_xmitr(port);
626 writel(ch, port->membase + UART_TSH(port));
627}
628
629static void mvebu_uart_console_write(struct console *co, const char *s,
630 unsigned int count)
631{
632 struct uart_port *port = &mvebu_uart_ports[co->index];
633 unsigned long flags;
634 unsigned int ier, intr, ctl;
635 int locked = 1;
636
637 if (oops_in_progress)
638 locked = spin_trylock_irqsave(&port->lock, flags);
639 else
640 spin_lock_irqsave(&port->lock, flags);
641
642 ier = readl(port->membase + UART_CTRL(port)) & CTRL_BRK_INT;
643 intr = readl(port->membase + UART_INTR(port)) &
644 (CTRL_RX_RDY_INT(port) | CTRL_TX_RDY_INT(port));
645 writel(0, port->membase + UART_CTRL(port));
646 writel(0, port->membase + UART_INTR(port));
647
648 uart_console_write(port, s, count, mvebu_uart_console_putchar);
649
650 wait_for_xmitr(port);
651
652 if (ier)
653 writel(ier, port->membase + UART_CTRL(port));
654
655 if (intr) {
656 ctl = intr | readl(port->membase + UART_INTR(port));
657 writel(ctl, port->membase + UART_INTR(port));
658 }
659
660 if (locked)
661 spin_unlock_irqrestore(&port->lock, flags);
662}
663
664static int mvebu_uart_console_setup(struct console *co, char *options)
665{
666 struct uart_port *port;
667 int baud = 9600;
668 int bits = 8;
669 int parity = 'n';
670 int flow = 'n';
671
672 if (co->index < 0 || co->index >= MVEBU_NR_UARTS)
673 return -EINVAL;
674
675 port = &mvebu_uart_ports[co->index];
676
677 if (!port->mapbase || !port->membase) {
678 pr_debug("console on ttyMV%i not present\n", co->index);
679 return -ENODEV;
680 }
681
682 if (options)
683 uart_parse_options(options, &baud, &parity, &bits, &flow);
684
685 return uart_set_options(port, co, baud, parity, bits, flow);
686}
687
688static struct uart_driver mvebu_uart_driver;
689
690static struct console mvebu_uart_console = {
691 .name = "ttyMV",
692 .write = mvebu_uart_console_write,
693 .device = uart_console_device,
694 .setup = mvebu_uart_console_setup,
695 .flags = CON_PRINTBUFFER,
696 .index = -1,
697 .data = &mvebu_uart_driver,
698};
699
700static int __init mvebu_uart_console_init(void)
701{
702 register_console(&mvebu_uart_console);
703 return 0;
704}
705
706console_initcall(mvebu_uart_console_init);
707
708
709#endif /* CONFIG_SERIAL_MVEBU_CONSOLE */
710
711static struct uart_driver mvebu_uart_driver = {
712 .owner = THIS_MODULE,
713 .driver_name = DRIVER_NAME,
714 .dev_name = "ttyMV",
715 .nr = MVEBU_NR_UARTS,
716#ifdef CONFIG_SERIAL_MVEBU_CONSOLE
717 .cons = &mvebu_uart_console,
718#endif
719};
720
721static const struct of_device_id mvebu_uart_of_match[];
722
723/* Counter to keep track of each UART port id when not using CONFIG_OF */
724static int uart_num_counter;
725
726static int mvebu_uart_probe(struct platform_device *pdev)
727{
728 struct resource *reg = platform_get_resource(pdev, IORESOURCE_MEM, 0);
729 const struct of_device_id *match = of_match_device(mvebu_uart_of_match,
730 &pdev->dev);
731 struct uart_port *port;
732 struct mvebu_uart *mvuart;
733 int ret, id, irq;
734
735 if (!reg) {
736 dev_err(&pdev->dev, "no registers defined\n");
737 return -EINVAL;
738 }
739
740 /* Assume that all UART ports have a DT alias or none has */
741 id = of_alias_get_id(pdev->dev.of_node, "serial");
742 if (!pdev->dev.of_node || id < 0)
743 pdev->id = uart_num_counter++;
744 else
745 pdev->id = id;
746
747 if (pdev->id >= MVEBU_NR_UARTS) {
748 dev_err(&pdev->dev, "cannot have more than %d UART ports\n",
749 MVEBU_NR_UARTS);
750 return -EINVAL;
751 }
752
753 port = &mvebu_uart_ports[pdev->id];
754
755 spin_lock_init(&port->lock);
756
757 port->dev = &pdev->dev;
758 port->type = PORT_MVEBU;
759 port->ops = &mvebu_uart_ops;
760 port->regshift = 0;
761
762 port->fifosize = 32;
763 port->iotype = UPIO_MEM32;
764 port->flags = UPF_FIXED_PORT;
765 port->line = pdev->id;
766
767 /*
768 * IRQ number is not stored in this structure because we may have two of
769 * them per port (RX and TX). Instead, use the driver UART structure
770 * array so called ->irq[].
771 */
772 port->irq = 0;
773 port->irqflags = 0;
774 port->mapbase = reg->start;
775
776 port->membase = devm_ioremap_resource(&pdev->dev, reg);
777 if (IS_ERR(port->membase))
778 return -PTR_ERR(port->membase);
779
780 mvuart = devm_kzalloc(&pdev->dev, sizeof(struct mvebu_uart),
781 GFP_KERNEL);
782 if (!mvuart)
783 return -ENOMEM;
784
785 /* Get controller data depending on the compatible string */
786 mvuart->data = (struct mvebu_uart_driver_data *)match->data;
787 mvuart->port = port;
788
789 port->private_data = mvuart;
790 platform_set_drvdata(pdev, mvuart);
791
792 /* Get fixed clock frequency */
793 mvuart->clk = devm_clk_get(&pdev->dev, NULL);
794 if (IS_ERR(mvuart->clk)) {
795 if (PTR_ERR(mvuart->clk) == -EPROBE_DEFER)
796 return PTR_ERR(mvuart->clk);
797
798 if (IS_EXTENDED(port)) {
799 dev_err(&pdev->dev, "unable to get UART clock\n");
800 return PTR_ERR(mvuart->clk);
801 }
802 } else {
803 if (!clk_prepare_enable(mvuart->clk))
804 port->uartclk = clk_get_rate(mvuart->clk);
805 }
806
807 /* Manage interrupts */
808 if (platform_irq_count(pdev) == 1) {
809 /* Old bindings: no name on the single unamed UART0 IRQ */
810 irq = platform_get_irq(pdev, 0);
811 if (irq < 0) {
812 dev_err(&pdev->dev, "unable to get UART IRQ\n");
813 return irq;
814 }
815
816 mvuart->irq[UART_IRQ_SUM] = irq;
817 } else {
818 /*
819 * New bindings: named interrupts (RX, TX) for both UARTS,
820 * only make use of uart-rx and uart-tx interrupts, do not use
821 * uart-sum of UART0 port.
822 */
823 irq = platform_get_irq_byname(pdev, "uart-rx");
824 if (irq < 0) {
825 dev_err(&pdev->dev, "unable to get 'uart-rx' IRQ\n");
826 return irq;
827 }
828
829 mvuart->irq[UART_RX_IRQ] = irq;
830
831 irq = platform_get_irq_byname(pdev, "uart-tx");
832 if (irq < 0) {
833 dev_err(&pdev->dev, "unable to get 'uart-tx' IRQ\n");
834 return irq;
835 }
836
837 mvuart->irq[UART_TX_IRQ] = irq;
838 }
839
840 /* UART Soft Reset*/
841 writel(CTRL_SOFT_RST, port->membase + UART_CTRL(port));
842 udelay(1);
843 writel(0, port->membase + UART_CTRL(port));
844
845 ret = uart_add_one_port(&mvebu_uart_driver, port);
846 if (ret)
847 return ret;
848 return 0;
849}
850
851static struct mvebu_uart_driver_data uart_std_driver_data = {
852 .is_ext = false,
853 .regs.rbr = UART_STD_RBR,
854 .regs.tsh = UART_STD_TSH,
855 .regs.ctrl = UART_STD_CTRL1,
856 .regs.intr = UART_STD_CTRL2,
857 .flags.ctrl_tx_rdy_int = CTRL_STD_TX_RDY_INT,
858 .flags.ctrl_rx_rdy_int = CTRL_STD_RX_RDY_INT,
859 .flags.stat_tx_rdy = STAT_STD_TX_RDY,
860 .flags.stat_rx_rdy = STAT_STD_RX_RDY,
861};
862
863static struct mvebu_uart_driver_data uart_ext_driver_data = {
864 .is_ext = true,
865 .regs.rbr = UART_EXT_RBR,
866 .regs.tsh = UART_EXT_TSH,
867 .regs.ctrl = UART_EXT_CTRL1,
868 .regs.intr = UART_EXT_CTRL2,
869 .flags.ctrl_tx_rdy_int = CTRL_EXT_TX_RDY_INT,
870 .flags.ctrl_rx_rdy_int = CTRL_EXT_RX_RDY_INT,
871 .flags.stat_tx_rdy = STAT_EXT_TX_RDY,
872 .flags.stat_rx_rdy = STAT_EXT_RX_RDY,
873};
874
875/* Match table for of_platform binding */
876static const struct of_device_id mvebu_uart_of_match[] = {
877 {
878 .compatible = "marvell,armada-3700-uart",
879 .data = (void *)&uart_std_driver_data,
880 },
881 {
882 .compatible = "marvell,armada-3700-uart-ext",
883 .data = (void *)&uart_ext_driver_data,
884 },
885 {}
886};
887
888static struct platform_driver mvebu_uart_platform_driver = {
889 .probe = mvebu_uart_probe,
890 .driver = {
891 .name = "mvebu-uart",
892 .of_match_table = of_match_ptr(mvebu_uart_of_match),
893 .suppress_bind_attrs = true,
894 },
895};
896
897static int __init mvebu_uart_init(void)
898{
899 int ret;
900
901 ret = uart_register_driver(&mvebu_uart_driver);
902 if (ret)
903 return ret;
904
905 ret = platform_driver_register(&mvebu_uart_platform_driver);
906 if (ret)
907 uart_unregister_driver(&mvebu_uart_driver);
908
909 return ret;
910}
911arch_initcall(mvebu_uart_init);