2 * Freescale STMP37XX/STMP378X Application UART driver
4 * Author: dmitry pervushin <dimka@embeddedalley.com>
6 * Copyright 2008-2010 Freescale Semiconductor, Inc.
7 * Copyright 2008 Embedded Alley Solutions, Inc All Rights Reserved.
9 * The code contained herein is licensed under the GNU General Public
10 * License. You may obtain a copy of the GNU General Public License
11 * Version 2 or later at the following locations:
13 * http://www.opensource.org/licenses/gpl-license.html
14 * http://www.gnu.org/copyleft/gpl.html
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/console.h>
21 #include <linux/interrupt.h>
22 #include <linux/module.h>
23 #include <linux/slab.h>
24 #include <linux/wait.h>
25 #include <linux/tty.h>
26 #include <linux/tty_driver.h>
27 #include <linux/tty_flip.h>
28 #include <linux/serial.h>
29 #include <linux/serial_core.h>
30 #include <linux/platform_device.h>
31 #include <linux/device.h>
32 #include <linux/clk.h>
33 #include <linux/delay.h>
35 #include <linux/pinctrl/consumer.h>
36 #include <linux/of_device.h>
38 #include <asm/cacheflush.h>
40 #define MXS_AUART_PORTS 5
42 #define AUART_CTRL0 0x00000000
43 #define AUART_CTRL0_SET 0x00000004
44 #define AUART_CTRL0_CLR 0x00000008
45 #define AUART_CTRL0_TOG 0x0000000c
46 #define AUART_CTRL1 0x00000010
47 #define AUART_CTRL1_SET 0x00000014
48 #define AUART_CTRL1_CLR 0x00000018
49 #define AUART_CTRL1_TOG 0x0000001c
50 #define AUART_CTRL2 0x00000020
51 #define AUART_CTRL2_SET 0x00000024
52 #define AUART_CTRL2_CLR 0x00000028
53 #define AUART_CTRL2_TOG 0x0000002c
54 #define AUART_LINECTRL 0x00000030
55 #define AUART_LINECTRL_SET 0x00000034
56 #define AUART_LINECTRL_CLR 0x00000038
57 #define AUART_LINECTRL_TOG 0x0000003c
58 #define AUART_LINECTRL2 0x00000040
59 #define AUART_LINECTRL2_SET 0x00000044
60 #define AUART_LINECTRL2_CLR 0x00000048
61 #define AUART_LINECTRL2_TOG 0x0000004c
62 #define AUART_INTR 0x00000050
63 #define AUART_INTR_SET 0x00000054
64 #define AUART_INTR_CLR 0x00000058
65 #define AUART_INTR_TOG 0x0000005c
66 #define AUART_DATA 0x00000060
67 #define AUART_STAT 0x00000070
68 #define AUART_DEBUG 0x00000080
69 #define AUART_VERSION 0x00000090
70 #define AUART_AUTOBAUD 0x000000a0
72 #define AUART_CTRL0_SFTRST (1 << 31)
73 #define AUART_CTRL0_CLKGATE (1 << 30)
75 #define AUART_CTRL2_CTSEN (1 << 15)
76 #define AUART_CTRL2_RTSEN (1 << 14)
77 #define AUART_CTRL2_RTS (1 << 11)
78 #define AUART_CTRL2_RXE (1 << 9)
79 #define AUART_CTRL2_TXE (1 << 8)
80 #define AUART_CTRL2_UARTEN (1 << 0)
82 #define AUART_LINECTRL_BAUD_DIVINT_SHIFT 16
83 #define AUART_LINECTRL_BAUD_DIVINT_MASK 0xffff0000
84 #define AUART_LINECTRL_BAUD_DIVINT(v) (((v) & 0xffff) << 16)
85 #define AUART_LINECTRL_BAUD_DIVFRAC_SHIFT 8
86 #define AUART_LINECTRL_BAUD_DIVFRAC_MASK 0x00003f00
87 #define AUART_LINECTRL_BAUD_DIVFRAC(v) (((v) & 0x3f) << 8)
88 #define AUART_LINECTRL_WLEN_MASK 0x00000060
89 #define AUART_LINECTRL_WLEN(v) (((v) & 0x3) << 5)
90 #define AUART_LINECTRL_FEN (1 << 4)
91 #define AUART_LINECTRL_STP2 (1 << 3)
92 #define AUART_LINECTRL_EPS (1 << 2)
93 #define AUART_LINECTRL_PEN (1 << 1)
94 #define AUART_LINECTRL_BRK (1 << 0)
96 #define AUART_INTR_RTIEN (1 << 22)
97 #define AUART_INTR_TXIEN (1 << 21)
98 #define AUART_INTR_RXIEN (1 << 20)
99 #define AUART_INTR_CTSMIEN (1 << 17)
100 #define AUART_INTR_RTIS (1 << 6)
101 #define AUART_INTR_TXIS (1 << 5)
102 #define AUART_INTR_RXIS (1 << 4)
103 #define AUART_INTR_CTSMIS (1 << 1)
105 #define AUART_STAT_BUSY (1 << 29)
106 #define AUART_STAT_CTS (1 << 28)
107 #define AUART_STAT_TXFE (1 << 27)
108 #define AUART_STAT_TXFF (1 << 25)
109 #define AUART_STAT_RXFE (1 << 24)
110 #define AUART_STAT_OERR (1 << 19)
111 #define AUART_STAT_BERR (1 << 18)
112 #define AUART_STAT_PERR (1 << 17)
113 #define AUART_STAT_FERR (1 << 16)
115 static struct uart_driver auart_driver;
117 struct mxs_auart_port {
118 struct uart_port port;
129 static void mxs_auart_stop_tx(struct uart_port *u);
131 #define to_auart_port(u) container_of(u, struct mxs_auart_port, port)
133 static inline void mxs_auart_tx_chars(struct mxs_auart_port *s)
135 struct circ_buf *xmit = &s->port.state->xmit;
137 while (!(readl(s->port.membase + AUART_STAT) &
139 if (s->port.x_char) {
141 writel(s->port.x_char,
142 s->port.membase + AUART_DATA);
146 if (!uart_circ_empty(xmit) && !uart_tx_stopped(&s->port)) {
148 writel(xmit->buf[xmit->tail],
149 s->port.membase + AUART_DATA);
150 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
154 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
155 uart_write_wakeup(&s->port);
157 if (uart_circ_empty(&(s->port.state->xmit)))
158 writel(AUART_INTR_TXIEN,
159 s->port.membase + AUART_INTR_CLR);
161 writel(AUART_INTR_TXIEN,
162 s->port.membase + AUART_INTR_SET);
164 if (uart_tx_stopped(&s->port))
165 mxs_auart_stop_tx(&s->port);
168 static void mxs_auart_rx_char(struct mxs_auart_port *s)
174 c = readl(s->port.membase + AUART_DATA);
175 stat = readl(s->port.membase + AUART_STAT);
180 if (stat & AUART_STAT_BERR) {
181 s->port.icount.brk++;
182 if (uart_handle_break(&s->port))
184 } else if (stat & AUART_STAT_PERR) {
185 s->port.icount.parity++;
186 } else if (stat & AUART_STAT_FERR) {
187 s->port.icount.frame++;
191 * Mask off conditions which should be ingored.
193 stat &= s->port.read_status_mask;
195 if (stat & AUART_STAT_BERR) {
197 } else if (stat & AUART_STAT_PERR)
199 else if (stat & AUART_STAT_FERR)
202 if (stat & AUART_STAT_OERR)
203 s->port.icount.overrun++;
205 if (uart_handle_sysrq_char(&s->port, c))
208 uart_insert_char(&s->port, stat, AUART_STAT_OERR, c, flag);
210 writel(stat, s->port.membase + AUART_STAT);
213 static void mxs_auart_rx_chars(struct mxs_auart_port *s)
215 struct tty_struct *tty = s->port.state->port.tty;
219 stat = readl(s->port.membase + AUART_STAT);
220 if (stat & AUART_STAT_RXFE)
222 mxs_auart_rx_char(s);
225 writel(stat, s->port.membase + AUART_STAT);
226 tty_flip_buffer_push(tty);
229 static int mxs_auart_request_port(struct uart_port *u)
234 static int mxs_auart_verify_port(struct uart_port *u,
235 struct serial_struct *ser)
237 if (u->type != PORT_UNKNOWN && u->type != PORT_IMX)
242 static void mxs_auart_config_port(struct uart_port *u, int flags)
246 static const char *mxs_auart_type(struct uart_port *u)
248 struct mxs_auart_port *s = to_auart_port(u);
250 return dev_name(s->dev);
253 static void mxs_auart_release_port(struct uart_port *u)
257 static void mxs_auart_set_mctrl(struct uart_port *u, unsigned mctrl)
259 struct mxs_auart_port *s = to_auart_port(u);
261 u32 ctrl = readl(u->membase + AUART_CTRL2);
263 ctrl &= ~AUART_CTRL2_RTSEN;
264 if (mctrl & TIOCM_RTS) {
265 if (u->state->port.flags & ASYNC_CTS_FLOW)
266 ctrl |= AUART_CTRL2_RTSEN;
270 writel(ctrl, u->membase + AUART_CTRL2);
273 static u32 mxs_auart_get_mctrl(struct uart_port *u)
275 struct mxs_auart_port *s = to_auart_port(u);
276 u32 stat = readl(u->membase + AUART_STAT);
277 int ctrl2 = readl(u->membase + AUART_CTRL2);
281 if (stat & AUART_STAT_CTS)
284 if (ctrl2 & AUART_CTRL2_RTS)
290 static void mxs_auart_settermios(struct uart_port *u,
291 struct ktermios *termios,
292 struct ktermios *old)
294 u32 bm, ctrl, ctrl2, div;
295 unsigned int cflag, baud;
297 cflag = termios->c_cflag;
299 ctrl = AUART_LINECTRL_FEN;
300 ctrl2 = readl(u->membase + AUART_CTRL2);
303 switch (cflag & CSIZE) {
320 ctrl |= AUART_LINECTRL_WLEN(bm);
323 if (cflag & PARENB) {
324 ctrl |= AUART_LINECTRL_PEN;
325 if ((cflag & PARODD) == 0)
326 ctrl |= AUART_LINECTRL_EPS;
329 u->read_status_mask = 0;
331 if (termios->c_iflag & INPCK)
332 u->read_status_mask |= AUART_STAT_PERR;
333 if (termios->c_iflag & (BRKINT | PARMRK))
334 u->read_status_mask |= AUART_STAT_BERR;
337 * Characters to ignore
339 u->ignore_status_mask = 0;
340 if (termios->c_iflag & IGNPAR)
341 u->ignore_status_mask |= AUART_STAT_PERR;
342 if (termios->c_iflag & IGNBRK) {
343 u->ignore_status_mask |= AUART_STAT_BERR;
345 * If we're ignoring parity and break indicators,
346 * ignore overruns too (for real raw support).
348 if (termios->c_iflag & IGNPAR)
349 u->ignore_status_mask |= AUART_STAT_OERR;
353 * ignore all characters if CREAD is not set
356 ctrl2 |= AUART_CTRL2_RXE;
358 ctrl2 &= ~AUART_CTRL2_RXE;
360 /* figure out the stop bits requested */
362 ctrl |= AUART_LINECTRL_STP2;
364 /* figure out the hardware flow control settings */
366 ctrl2 |= AUART_CTRL2_CTSEN | AUART_CTRL2_RTSEN;
368 ctrl2 &= ~(AUART_CTRL2_CTSEN | AUART_CTRL2_RTSEN);
371 baud = uart_get_baud_rate(u, termios, old, 0, u->uartclk);
372 div = u->uartclk * 32 / baud;
373 ctrl |= AUART_LINECTRL_BAUD_DIVFRAC(div & 0x3F);
374 ctrl |= AUART_LINECTRL_BAUD_DIVINT(div >> 6);
376 writel(ctrl, u->membase + AUART_LINECTRL);
377 writel(ctrl2, u->membase + AUART_CTRL2);
379 uart_update_timeout(u, termios->c_cflag, baud);
382 static irqreturn_t mxs_auart_irq_handle(int irq, void *context)
385 struct mxs_auart_port *s = context;
386 u32 stat = readl(s->port.membase + AUART_STAT);
388 istatus = istat = readl(s->port.membase + AUART_INTR);
390 if (istat & AUART_INTR_CTSMIS) {
391 uart_handle_cts_change(&s->port, stat & AUART_STAT_CTS);
392 writel(AUART_INTR_CTSMIS,
393 s->port.membase + AUART_INTR_CLR);
394 istat &= ~AUART_INTR_CTSMIS;
397 if (istat & (AUART_INTR_RTIS | AUART_INTR_RXIS)) {
398 mxs_auart_rx_chars(s);
399 istat &= ~(AUART_INTR_RTIS | AUART_INTR_RXIS);
402 if (istat & AUART_INTR_TXIS) {
403 mxs_auart_tx_chars(s);
404 istat &= ~AUART_INTR_TXIS;
407 writel(istatus & (AUART_INTR_RTIS
410 | AUART_INTR_CTSMIS),
411 s->port.membase + AUART_INTR_CLR);
416 static void mxs_auart_reset(struct uart_port *u)
421 writel(AUART_CTRL0_SFTRST, u->membase + AUART_CTRL0_CLR);
423 for (i = 0; i < 10000; i++) {
424 reg = readl(u->membase + AUART_CTRL0);
425 if (!(reg & AUART_CTRL0_SFTRST))
429 writel(AUART_CTRL0_CLKGATE, u->membase + AUART_CTRL0_CLR);
432 static int mxs_auart_startup(struct uart_port *u)
434 struct mxs_auart_port *s = to_auart_port(u);
436 clk_prepare_enable(s->clk);
438 writel(AUART_CTRL0_CLKGATE, u->membase + AUART_CTRL0_CLR);
440 writel(AUART_CTRL2_UARTEN, u->membase + AUART_CTRL2_SET);
442 writel(AUART_INTR_RXIEN | AUART_INTR_RTIEN | AUART_INTR_CTSMIEN,
443 u->membase + AUART_INTR);
446 * Enable fifo so all four bytes of a DMA word are written to
447 * output (otherwise, only the LSB is written, ie. 1 in 4 bytes)
449 writel(AUART_LINECTRL_FEN, u->membase + AUART_LINECTRL_SET);
454 static void mxs_auart_shutdown(struct uart_port *u)
456 struct mxs_auart_port *s = to_auart_port(u);
458 writel(AUART_CTRL2_UARTEN, u->membase + AUART_CTRL2_CLR);
460 writel(AUART_CTRL0_CLKGATE, u->membase + AUART_CTRL0_SET);
462 writel(AUART_INTR_RXIEN | AUART_INTR_RTIEN | AUART_INTR_CTSMIEN,
463 u->membase + AUART_INTR_CLR);
465 clk_disable_unprepare(s->clk);
468 static unsigned int mxs_auart_tx_empty(struct uart_port *u)
470 if (readl(u->membase + AUART_STAT) & AUART_STAT_TXFE)
476 static void mxs_auart_start_tx(struct uart_port *u)
478 struct mxs_auart_port *s = to_auart_port(u);
480 /* enable transmitter */
481 writel(AUART_CTRL2_TXE, u->membase + AUART_CTRL2_SET);
483 mxs_auart_tx_chars(s);
486 static void mxs_auart_stop_tx(struct uart_port *u)
488 writel(AUART_CTRL2_TXE, u->membase + AUART_CTRL2_CLR);
491 static void mxs_auart_stop_rx(struct uart_port *u)
493 writel(AUART_CTRL2_RXE, u->membase + AUART_CTRL2_CLR);
496 static void mxs_auart_break_ctl(struct uart_port *u, int ctl)
499 writel(AUART_LINECTRL_BRK,
500 u->membase + AUART_LINECTRL_SET);
502 writel(AUART_LINECTRL_BRK,
503 u->membase + AUART_LINECTRL_CLR);
506 static void mxs_auart_enable_ms(struct uart_port *port)
511 static struct uart_ops mxs_auart_ops = {
512 .tx_empty = mxs_auart_tx_empty,
513 .start_tx = mxs_auart_start_tx,
514 .stop_tx = mxs_auart_stop_tx,
515 .stop_rx = mxs_auart_stop_rx,
516 .enable_ms = mxs_auart_enable_ms,
517 .break_ctl = mxs_auart_break_ctl,
518 .set_mctrl = mxs_auart_set_mctrl,
519 .get_mctrl = mxs_auart_get_mctrl,
520 .startup = mxs_auart_startup,
521 .shutdown = mxs_auart_shutdown,
522 .set_termios = mxs_auart_settermios,
523 .type = mxs_auart_type,
524 .release_port = mxs_auart_release_port,
525 .request_port = mxs_auart_request_port,
526 .config_port = mxs_auart_config_port,
527 .verify_port = mxs_auart_verify_port,
530 static struct mxs_auart_port *auart_port[MXS_AUART_PORTS];
532 #ifdef CONFIG_SERIAL_MXS_AUART_CONSOLE
533 static void mxs_auart_console_putchar(struct uart_port *port, int ch)
535 unsigned int to = 1000;
537 while (readl(port->membase + AUART_STAT) & AUART_STAT_TXFF) {
543 writel(ch, port->membase + AUART_DATA);
547 auart_console_write(struct console *co, const char *str, unsigned int count)
549 struct mxs_auart_port *s;
550 struct uart_port *port;
551 unsigned int old_ctrl0, old_ctrl2;
552 unsigned int to = 1000;
554 if (co->index > MXS_AUART_PORTS || co->index < 0)
557 s = auart_port[co->index];
562 /* First save the CR then disable the interrupts */
563 old_ctrl2 = readl(port->membase + AUART_CTRL2);
564 old_ctrl0 = readl(port->membase + AUART_CTRL0);
566 writel(AUART_CTRL0_CLKGATE,
567 port->membase + AUART_CTRL0_CLR);
568 writel(AUART_CTRL2_UARTEN | AUART_CTRL2_TXE,
569 port->membase + AUART_CTRL2_SET);
571 uart_console_write(port, str, count, mxs_auart_console_putchar);
574 * Finally, wait for transmitter to become empty
575 * and restore the TCR
577 while (readl(port->membase + AUART_STAT) & AUART_STAT_BUSY) {
583 writel(old_ctrl0, port->membase + AUART_CTRL0);
584 writel(old_ctrl2, port->membase + AUART_CTRL2);
590 auart_console_get_options(struct uart_port *port, int *baud,
591 int *parity, int *bits)
593 unsigned int lcr_h, quot;
595 if (!(readl(port->membase + AUART_CTRL2) & AUART_CTRL2_UARTEN))
598 lcr_h = readl(port->membase + AUART_LINECTRL);
601 if (lcr_h & AUART_LINECTRL_PEN) {
602 if (lcr_h & AUART_LINECTRL_EPS)
608 if ((lcr_h & AUART_LINECTRL_WLEN_MASK) == AUART_LINECTRL_WLEN(2))
613 quot = ((readl(port->membase + AUART_LINECTRL)
614 & AUART_LINECTRL_BAUD_DIVINT_MASK))
615 >> (AUART_LINECTRL_BAUD_DIVINT_SHIFT - 6);
616 quot |= ((readl(port->membase + AUART_LINECTRL)
617 & AUART_LINECTRL_BAUD_DIVFRAC_MASK))
618 >> AUART_LINECTRL_BAUD_DIVFRAC_SHIFT;
622 *baud = (port->uartclk << 2) / quot;
626 auart_console_setup(struct console *co, char *options)
628 struct mxs_auart_port *s;
636 * Check whether an invalid uart number has been specified, and
637 * if so, search for the first available port that does have
640 if (co->index == -1 || co->index >= ARRAY_SIZE(auart_port))
642 s = auart_port[co->index];
646 clk_prepare_enable(s->clk);
649 uart_parse_options(options, &baud, &parity, &bits, &flow);
651 auart_console_get_options(&s->port, &baud, &parity, &bits);
653 ret = uart_set_options(&s->port, co, baud, parity, bits, flow);
655 clk_disable_unprepare(s->clk);
660 static struct console auart_console = {
662 .write = auart_console_write,
663 .device = uart_console_device,
664 .setup = auart_console_setup,
665 .flags = CON_PRINTBUFFER,
667 .data = &auart_driver,
671 static struct uart_driver auart_driver = {
672 .owner = THIS_MODULE,
673 .driver_name = "ttyAPP",
674 .dev_name = "ttyAPP",
677 .nr = MXS_AUART_PORTS,
678 #ifdef CONFIG_SERIAL_MXS_AUART_CONSOLE
679 .cons = &auart_console,
684 * This function returns 1 if pdev isn't a device instatiated by dt, 0 if it
685 * could successfully get all information from dt or a negative errno.
687 static int serial_mxs_probe_dt(struct mxs_auart_port *s,
688 struct platform_device *pdev)
690 struct device_node *np = pdev->dev.of_node;
694 /* no device tree device */
697 ret = of_alias_get_id(np, "serial");
699 dev_err(&pdev->dev, "failed to get alias id: %d\n", ret);
707 static int __devinit mxs_auart_probe(struct platform_device *pdev)
709 struct mxs_auart_port *s;
713 struct pinctrl *pinctrl;
715 s = kzalloc(sizeof(struct mxs_auart_port), GFP_KERNEL);
721 ret = serial_mxs_probe_dt(s, pdev);
723 s->port.line = pdev->id < 0 ? 0 : pdev->id;
727 pinctrl = devm_pinctrl_get_select_default(&pdev->dev);
728 if (IS_ERR(pinctrl)) {
729 ret = PTR_ERR(pinctrl);
733 s->clk = clk_get(&pdev->dev, NULL);
734 if (IS_ERR(s->clk)) {
735 ret = PTR_ERR(s->clk);
739 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
745 s->port.mapbase = r->start;
746 s->port.membase = ioremap(r->start, resource_size(r));
747 s->port.ops = &mxs_auart_ops;
748 s->port.iotype = UPIO_MEM;
749 s->port.fifosize = 16;
750 s->port.uartclk = clk_get_rate(s->clk);
751 s->port.type = PORT_IMX;
752 s->port.dev = s->dev = get_device(&pdev->dev);
757 s->irq = platform_get_irq(pdev, 0);
758 s->port.irq = s->irq;
759 ret = request_irq(s->irq, mxs_auart_irq_handle, 0, dev_name(&pdev->dev), s);
763 platform_set_drvdata(pdev, s);
765 auart_port[s->port.line] = s;
767 mxs_auart_reset(&s->port);
769 ret = uart_add_one_port(&auart_driver, &s->port);
773 version = readl(s->port.membase + AUART_VERSION);
774 dev_info(&pdev->dev, "Found APPUART %d.%d.%d\n",
775 (version >> 24) & 0xff,
776 (version >> 16) & 0xff, version & 0xffff);
781 auart_port[pdev->id] = NULL;
791 static int __devexit mxs_auart_remove(struct platform_device *pdev)
793 struct mxs_auart_port *s = platform_get_drvdata(pdev);
795 uart_remove_one_port(&auart_driver, &s->port);
797 auart_port[pdev->id] = NULL;
806 static struct of_device_id mxs_auart_dt_ids[] = {
807 { .compatible = "fsl,imx23-auart", },
810 MODULE_DEVICE_TABLE(of, mxs_auart_dt_ids);
812 static struct platform_driver mxs_auart_driver = {
813 .probe = mxs_auart_probe,
814 .remove = __devexit_p(mxs_auart_remove),
817 .owner = THIS_MODULE,
818 .of_match_table = mxs_auart_dt_ids,
822 static int __init mxs_auart_init(void)
826 r = uart_register_driver(&auart_driver);
830 r = platform_driver_register(&mxs_auart_driver);
836 uart_unregister_driver(&auart_driver);
841 static void __exit mxs_auart_exit(void)
843 platform_driver_unregister(&mxs_auart_driver);
844 uart_unregister_driver(&auart_driver);
847 module_init(mxs_auart_init);
848 module_exit(mxs_auart_exit);
849 MODULE_LICENSE("GPL");
850 MODULE_DESCRIPTION("Freescale MXS application uart driver");
851 MODULE_ALIAS("platform:mxs-auart");