2 * Atheros AR933X SoC built-in UART driver
4 * Copyright (C) 2011 Gabor Juhos <juhosg@openwrt.org>
6 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published
10 * by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/ioport.h>
15 #include <linux/init.h>
16 #include <linux/console.h>
17 #include <linux/sysrq.h>
18 #include <linux/delay.h>
19 #include <linux/platform_device.h>
20 #include <linux/tty.h>
21 #include <linux/tty_flip.h>
22 #include <linux/serial_core.h>
23 #include <linux/serial.h>
24 #include <linux/slab.h>
26 #include <linux/irq.h>
28 #include <asm/div64.h>
30 #include <asm/mach-ath79/ar933x_uart.h>
31 #include <asm/mach-ath79/ar933x_uart_platform.h>
33 #define DRIVER_NAME "ar933x-uart"
35 #define AR933X_UART_MAX_SCALE 0xff
36 #define AR933X_UART_MAX_STEP 0xffff
38 #define AR933X_UART_MIN_BAUD 300
39 #define AR933X_UART_MAX_BAUD 3000000
41 #define AR933X_DUMMY_STATUS_RD 0x01
43 static struct uart_driver ar933x_uart_driver;
45 struct ar933x_uart_port {
46 struct uart_port port;
47 unsigned int ier; /* shadow Interrupt Enable Register */
48 unsigned int min_baud;
49 unsigned int max_baud;
52 static inline unsigned int ar933x_uart_read(struct ar933x_uart_port *up,
55 return readl(up->port.membase + offset);
58 static inline void ar933x_uart_write(struct ar933x_uart_port *up,
59 int offset, unsigned int value)
61 writel(value, up->port.membase + offset);
64 static inline void ar933x_uart_rmw(struct ar933x_uart_port *up,
71 t = ar933x_uart_read(up, offset);
74 ar933x_uart_write(up, offset, t);
77 static inline void ar933x_uart_rmw_set(struct ar933x_uart_port *up,
81 ar933x_uart_rmw(up, offset, 0, val);
84 static inline void ar933x_uart_rmw_clear(struct ar933x_uart_port *up,
88 ar933x_uart_rmw(up, offset, val, 0);
91 static inline void ar933x_uart_start_tx_interrupt(struct ar933x_uart_port *up)
93 up->ier |= AR933X_UART_INT_TX_EMPTY;
94 ar933x_uart_write(up, AR933X_UART_INT_EN_REG, up->ier);
97 static inline void ar933x_uart_stop_tx_interrupt(struct ar933x_uart_port *up)
99 up->ier &= ~AR933X_UART_INT_TX_EMPTY;
100 ar933x_uart_write(up, AR933X_UART_INT_EN_REG, up->ier);
103 static inline void ar933x_uart_putc(struct ar933x_uart_port *up, int ch)
107 rdata = ch & AR933X_UART_DATA_TX_RX_MASK;
108 rdata |= AR933X_UART_DATA_TX_CSR;
109 ar933x_uart_write(up, AR933X_UART_DATA_REG, rdata);
112 static unsigned int ar933x_uart_tx_empty(struct uart_port *port)
114 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
118 spin_lock_irqsave(&up->port.lock, flags);
119 rdata = ar933x_uart_read(up, AR933X_UART_DATA_REG);
120 spin_unlock_irqrestore(&up->port.lock, flags);
122 return (rdata & AR933X_UART_DATA_TX_CSR) ? 0 : TIOCSER_TEMT;
125 static unsigned int ar933x_uart_get_mctrl(struct uart_port *port)
130 static void ar933x_uart_set_mctrl(struct uart_port *port, unsigned int mctrl)
134 static void ar933x_uart_start_tx(struct uart_port *port)
136 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
138 ar933x_uart_start_tx_interrupt(up);
141 static void ar933x_uart_stop_tx(struct uart_port *port)
143 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
145 ar933x_uart_stop_tx_interrupt(up);
148 static void ar933x_uart_stop_rx(struct uart_port *port)
150 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
152 up->ier &= ~AR933X_UART_INT_RX_VALID;
153 ar933x_uart_write(up, AR933X_UART_INT_EN_REG, up->ier);
156 static void ar933x_uart_break_ctl(struct uart_port *port, int break_state)
158 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
161 spin_lock_irqsave(&up->port.lock, flags);
162 if (break_state == -1)
163 ar933x_uart_rmw_set(up, AR933X_UART_CS_REG,
164 AR933X_UART_CS_TX_BREAK);
166 ar933x_uart_rmw_clear(up, AR933X_UART_CS_REG,
167 AR933X_UART_CS_TX_BREAK);
168 spin_unlock_irqrestore(&up->port.lock, flags);
171 static void ar933x_uart_enable_ms(struct uart_port *port)
176 * baudrate = (clk / (scale + 1)) * (step * (1 / 2^17))
178 static unsigned long ar933x_uart_get_baud(unsigned int clk,
185 div = (2 << 16) * (scale + 1);
194 static void ar933x_uart_get_scale_step(unsigned int clk,
206 for (tscale = 0; tscale < AR933X_UART_MAX_SCALE; tscale++) {
210 tstep = baud * (tscale + 1);
214 if (tstep > AR933X_UART_MAX_STEP)
217 diff = abs(ar933x_uart_get_baud(clk, tscale, tstep) - baud);
218 if (diff < min_diff) {
226 static void ar933x_uart_set_termios(struct uart_port *port,
227 struct ktermios *new,
228 struct ktermios *old)
230 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
233 unsigned int baud, scale, step;
235 /* Only CS8 is supported */
236 new->c_cflag &= ~CSIZE;
239 /* Only one stop bit is supported */
240 new->c_cflag &= ~CSTOPB;
243 if (new->c_cflag & PARENB) {
244 if (!(new->c_cflag & PARODD))
245 cs |= AR933X_UART_CS_PARITY_EVEN;
247 cs |= AR933X_UART_CS_PARITY_ODD;
249 cs |= AR933X_UART_CS_PARITY_NONE;
252 /* Mark/space parity is not supported */
253 new->c_cflag &= ~CMSPAR;
255 baud = uart_get_baud_rate(port, new, old, up->min_baud, up->max_baud);
256 ar933x_uart_get_scale_step(port->uartclk, baud, &scale, &step);
259 * Ok, we're now changing the port state. Do it with
260 * interrupts disabled.
262 spin_lock_irqsave(&up->port.lock, flags);
264 /* disable the UART */
265 ar933x_uart_rmw_clear(up, AR933X_UART_CS_REG,
266 AR933X_UART_CS_IF_MODE_M << AR933X_UART_CS_IF_MODE_S);
268 /* Update the per-port timeout. */
269 uart_update_timeout(port, new->c_cflag, baud);
271 up->port.ignore_status_mask = 0;
273 /* ignore all characters if CREAD is not set */
274 if ((new->c_cflag & CREAD) == 0)
275 up->port.ignore_status_mask |= AR933X_DUMMY_STATUS_RD;
277 ar933x_uart_write(up, AR933X_UART_CLOCK_REG,
278 scale << AR933X_UART_CLOCK_SCALE_S | step);
280 /* setup configuration register */
281 ar933x_uart_rmw(up, AR933X_UART_CS_REG, AR933X_UART_CS_PARITY_M, cs);
283 /* enable host interrupt */
284 ar933x_uart_rmw_set(up, AR933X_UART_CS_REG,
285 AR933X_UART_CS_HOST_INT_EN);
287 /* reenable the UART */
288 ar933x_uart_rmw(up, AR933X_UART_CS_REG,
289 AR933X_UART_CS_IF_MODE_M << AR933X_UART_CS_IF_MODE_S,
290 AR933X_UART_CS_IF_MODE_DCE << AR933X_UART_CS_IF_MODE_S);
292 spin_unlock_irqrestore(&up->port.lock, flags);
294 if (tty_termios_baud_rate(new))
295 tty_termios_encode_baud_rate(new, baud, baud);
298 static void ar933x_uart_rx_chars(struct ar933x_uart_port *up)
300 struct tty_port *port = &up->port.state->port;
301 struct tty_struct *tty;
304 tty = tty_port_tty_get(port);
309 rdata = ar933x_uart_read(up, AR933X_UART_DATA_REG);
310 if ((rdata & AR933X_UART_DATA_RX_CSR) == 0)
313 /* remove the character from the FIFO */
314 ar933x_uart_write(up, AR933X_UART_DATA_REG,
315 AR933X_UART_DATA_RX_CSR);
317 up->port.icount.rx++;
318 ch = rdata & AR933X_UART_DATA_TX_RX_MASK;
320 if (uart_handle_sysrq_char(&up->port, ch))
323 if ((up->port.ignore_status_mask & AR933X_DUMMY_STATUS_RD) == 0)
324 tty_insert_flip_char(port, ch, TTY_NORMAL);
325 } while (max_count-- > 0);
328 tty_flip_buffer_push(tty);
333 static void ar933x_uart_tx_chars(struct ar933x_uart_port *up)
335 struct circ_buf *xmit = &up->port.state->xmit;
338 if (uart_tx_stopped(&up->port))
341 count = up->port.fifosize;
345 rdata = ar933x_uart_read(up, AR933X_UART_DATA_REG);
346 if ((rdata & AR933X_UART_DATA_TX_CSR) == 0)
349 if (up->port.x_char) {
350 ar933x_uart_putc(up, up->port.x_char);
351 up->port.icount.tx++;
356 if (uart_circ_empty(xmit))
359 ar933x_uart_putc(up, xmit->buf[xmit->tail]);
361 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
362 up->port.icount.tx++;
363 } while (--count > 0);
365 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
366 uart_write_wakeup(&up->port);
368 if (!uart_circ_empty(xmit))
369 ar933x_uart_start_tx_interrupt(up);
372 static irqreturn_t ar933x_uart_interrupt(int irq, void *dev_id)
374 struct ar933x_uart_port *up = dev_id;
377 status = ar933x_uart_read(up, AR933X_UART_CS_REG);
378 if ((status & AR933X_UART_CS_HOST_INT) == 0)
381 spin_lock(&up->port.lock);
383 status = ar933x_uart_read(up, AR933X_UART_INT_REG);
384 status &= ar933x_uart_read(up, AR933X_UART_INT_EN_REG);
386 if (status & AR933X_UART_INT_RX_VALID) {
387 ar933x_uart_write(up, AR933X_UART_INT_REG,
388 AR933X_UART_INT_RX_VALID);
389 ar933x_uart_rx_chars(up);
392 if (status & AR933X_UART_INT_TX_EMPTY) {
393 ar933x_uart_write(up, AR933X_UART_INT_REG,
394 AR933X_UART_INT_TX_EMPTY);
395 ar933x_uart_stop_tx_interrupt(up);
396 ar933x_uart_tx_chars(up);
399 spin_unlock(&up->port.lock);
404 static int ar933x_uart_startup(struct uart_port *port)
406 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
410 ret = request_irq(up->port.irq, ar933x_uart_interrupt,
411 up->port.irqflags, dev_name(up->port.dev), up);
415 spin_lock_irqsave(&up->port.lock, flags);
417 /* Enable HOST interrupts */
418 ar933x_uart_rmw_set(up, AR933X_UART_CS_REG,
419 AR933X_UART_CS_HOST_INT_EN);
421 /* Enable RX interrupts */
422 up->ier = AR933X_UART_INT_RX_VALID;
423 ar933x_uart_write(up, AR933X_UART_INT_EN_REG, up->ier);
425 spin_unlock_irqrestore(&up->port.lock, flags);
430 static void ar933x_uart_shutdown(struct uart_port *port)
432 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
434 /* Disable all interrupts */
436 ar933x_uart_write(up, AR933X_UART_INT_EN_REG, up->ier);
438 /* Disable break condition */
439 ar933x_uart_rmw_clear(up, AR933X_UART_CS_REG,
440 AR933X_UART_CS_TX_BREAK);
442 free_irq(up->port.irq, up);
445 static const char *ar933x_uart_type(struct uart_port *port)
447 return (port->type == PORT_AR933X) ? "AR933X UART" : NULL;
450 static void ar933x_uart_release_port(struct uart_port *port)
452 /* Nothing to release ... */
455 static int ar933x_uart_request_port(struct uart_port *port)
457 /* UARTs always present */
461 static void ar933x_uart_config_port(struct uart_port *port, int flags)
463 if (flags & UART_CONFIG_TYPE)
464 port->type = PORT_AR933X;
467 static int ar933x_uart_verify_port(struct uart_port *port,
468 struct serial_struct *ser)
470 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
472 if (ser->type != PORT_UNKNOWN &&
473 ser->type != PORT_AR933X)
476 if (ser->irq < 0 || ser->irq >= NR_IRQS)
479 if (ser->baud_base < up->min_baud ||
480 ser->baud_base > up->max_baud)
486 static struct uart_ops ar933x_uart_ops = {
487 .tx_empty = ar933x_uart_tx_empty,
488 .set_mctrl = ar933x_uart_set_mctrl,
489 .get_mctrl = ar933x_uart_get_mctrl,
490 .stop_tx = ar933x_uart_stop_tx,
491 .start_tx = ar933x_uart_start_tx,
492 .stop_rx = ar933x_uart_stop_rx,
493 .enable_ms = ar933x_uart_enable_ms,
494 .break_ctl = ar933x_uart_break_ctl,
495 .startup = ar933x_uart_startup,
496 .shutdown = ar933x_uart_shutdown,
497 .set_termios = ar933x_uart_set_termios,
498 .type = ar933x_uart_type,
499 .release_port = ar933x_uart_release_port,
500 .request_port = ar933x_uart_request_port,
501 .config_port = ar933x_uart_config_port,
502 .verify_port = ar933x_uart_verify_port,
505 #ifdef CONFIG_SERIAL_AR933X_CONSOLE
507 static struct ar933x_uart_port *
508 ar933x_console_ports[CONFIG_SERIAL_AR933X_NR_UARTS];
510 static void ar933x_uart_wait_xmitr(struct ar933x_uart_port *up)
513 unsigned int timeout = 60000;
515 /* Wait up to 60ms for the character(s) to be sent. */
517 status = ar933x_uart_read(up, AR933X_UART_DATA_REG);
521 } while ((status & AR933X_UART_DATA_TX_CSR) == 0);
524 static void ar933x_uart_console_putchar(struct uart_port *port, int ch)
526 struct ar933x_uart_port *up = (struct ar933x_uart_port *) port;
528 ar933x_uart_wait_xmitr(up);
529 ar933x_uart_putc(up, ch);
532 static void ar933x_uart_console_write(struct console *co, const char *s,
535 struct ar933x_uart_port *up = ar933x_console_ports[co->index];
540 local_irq_save(flags);
544 else if (oops_in_progress)
545 locked = spin_trylock(&up->port.lock);
547 spin_lock(&up->port.lock);
550 * First save the IER then disable the interrupts
552 int_en = ar933x_uart_read(up, AR933X_UART_INT_EN_REG);
553 ar933x_uart_write(up, AR933X_UART_INT_EN_REG, 0);
555 uart_console_write(&up->port, s, count, ar933x_uart_console_putchar);
558 * Finally, wait for transmitter to become empty
559 * and restore the IER
561 ar933x_uart_wait_xmitr(up);
562 ar933x_uart_write(up, AR933X_UART_INT_EN_REG, int_en);
564 ar933x_uart_write(up, AR933X_UART_INT_REG, AR933X_UART_INT_ALLINTS);
567 spin_unlock(&up->port.lock);
569 local_irq_restore(flags);
572 static int ar933x_uart_console_setup(struct console *co, char *options)
574 struct ar933x_uart_port *up;
580 if (co->index < 0 || co->index >= CONFIG_SERIAL_AR933X_NR_UARTS)
583 up = ar933x_console_ports[co->index];
588 uart_parse_options(options, &baud, &parity, &bits, &flow);
590 return uart_set_options(&up->port, co, baud, parity, bits, flow);
593 static struct console ar933x_uart_console = {
595 .write = ar933x_uart_console_write,
596 .device = uart_console_device,
597 .setup = ar933x_uart_console_setup,
598 .flags = CON_PRINTBUFFER,
600 .data = &ar933x_uart_driver,
603 static void ar933x_uart_add_console_port(struct ar933x_uart_port *up)
605 ar933x_console_ports[up->port.line] = up;
608 #define AR933X_SERIAL_CONSOLE (&ar933x_uart_console)
612 static inline void ar933x_uart_add_console_port(struct ar933x_uart_port *up) {}
614 #define AR933X_SERIAL_CONSOLE NULL
616 #endif /* CONFIG_SERIAL_AR933X_CONSOLE */
618 static struct uart_driver ar933x_uart_driver = {
619 .owner = THIS_MODULE,
620 .driver_name = DRIVER_NAME,
621 .dev_name = "ttyATH",
622 .nr = CONFIG_SERIAL_AR933X_NR_UARTS,
623 .cons = AR933X_SERIAL_CONSOLE,
626 static int ar933x_uart_probe(struct platform_device *pdev)
628 struct ar933x_uart_platform_data *pdata;
629 struct ar933x_uart_port *up;
630 struct uart_port *port;
631 struct resource *mem_res;
632 struct resource *irq_res;
637 pdata = pdev->dev.platform_data;
645 if (id > CONFIG_SERIAL_AR933X_NR_UARTS)
648 mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
650 dev_err(&pdev->dev, "no MEM resource\n");
654 irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
656 dev_err(&pdev->dev, "no IRQ resource\n");
660 up = kzalloc(sizeof(struct ar933x_uart_port), GFP_KERNEL);
665 port->mapbase = mem_res->start;
667 port->membase = ioremap(mem_res->start, AR933X_UART_REGS_SIZE);
668 if (!port->membase) {
674 port->irq = irq_res->start;
675 port->dev = &pdev->dev;
676 port->type = PORT_AR933X;
677 port->iotype = UPIO_MEM32;
678 port->uartclk = pdata->uartclk;
681 port->fifosize = AR933X_UART_FIFO_SIZE;
682 port->ops = &ar933x_uart_ops;
684 baud = ar933x_uart_get_baud(port->uartclk, AR933X_UART_MAX_SCALE, 1);
685 up->min_baud = max_t(unsigned int, baud, AR933X_UART_MIN_BAUD);
687 baud = ar933x_uart_get_baud(port->uartclk, 0, AR933X_UART_MAX_STEP);
688 up->max_baud = min_t(unsigned int, baud, AR933X_UART_MAX_BAUD);
690 ar933x_uart_add_console_port(up);
692 ret = uart_add_one_port(&ar933x_uart_driver, &up->port);
696 platform_set_drvdata(pdev, up);
700 iounmap(up->port.membase);
706 static int ar933x_uart_remove(struct platform_device *pdev)
708 struct ar933x_uart_port *up;
710 up = platform_get_drvdata(pdev);
711 platform_set_drvdata(pdev, NULL);
714 uart_remove_one_port(&ar933x_uart_driver, &up->port);
715 iounmap(up->port.membase);
722 static struct platform_driver ar933x_uart_platform_driver = {
723 .probe = ar933x_uart_probe,
724 .remove = ar933x_uart_remove,
727 .owner = THIS_MODULE,
731 static int __init ar933x_uart_init(void)
735 ar933x_uart_driver.nr = CONFIG_SERIAL_AR933X_NR_UARTS;
736 ret = uart_register_driver(&ar933x_uart_driver);
740 ret = platform_driver_register(&ar933x_uart_platform_driver);
742 goto err_unregister_uart_driver;
746 err_unregister_uart_driver:
747 uart_unregister_driver(&ar933x_uart_driver);
752 static void __exit ar933x_uart_exit(void)
754 platform_driver_unregister(&ar933x_uart_platform_driver);
755 uart_unregister_driver(&ar933x_uart_driver);
758 module_init(ar933x_uart_init);
759 module_exit(ar933x_uart_exit);
761 MODULE_DESCRIPTION("Atheros AR933X UART driver");
762 MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
763 MODULE_LICENSE("GPL v2");
764 MODULE_ALIAS("platform:" DRIVER_NAME);