2 * Driver for AMBA serial ports
4 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
6 * Copyright 1999 ARM Limited
7 * Copyright (C) 2000 Deep Blue Solutions Ltd.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * This is a generic driver for ARM AMBA-type serial ports. They
24 * have a lot of 16550-like features, but are not register compatible.
25 * Note that although they do have CTS, DCD and DSR inputs, they do
26 * not have an RI input, nor do they have DTR or RTS outputs. If
27 * required, these have to be supplied via some other means (eg, GPIO)
28 * and hooked into this driver.
31 #if defined(CONFIG_SERIAL_AMBA_PL010_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
35 #include <linux/module.h>
36 #include <linux/ioport.h>
37 #include <linux/init.h>
38 #include <linux/console.h>
39 #include <linux/sysrq.h>
40 #include <linux/device.h>
41 #include <linux/tty.h>
42 #include <linux/tty_flip.h>
43 #include <linux/serial_core.h>
44 #include <linux/serial.h>
45 #include <linux/amba/bus.h>
46 #include <linux/amba/serial.h>
47 #include <linux/clk.h>
48 #include <linux/slab.h>
53 #define SERIAL_AMBA_MAJOR 204
54 #define SERIAL_AMBA_MINOR 16
55 #define SERIAL_AMBA_NR UART_NR
57 #define AMBA_ISR_PASS_LIMIT 256
59 #define UART_RX_DATA(s) (((s) & UART01x_FR_RXFE) == 0)
60 #define UART_TX_READY(s) (((s) & UART01x_FR_TXFF) == 0)
62 #define UART_DUMMY_RSR_RX 256
63 #define UART_PORT_SIZE 64
66 * We wrap our port structure around the generic uart_port.
68 struct uart_amba_port {
69 struct uart_port port;
71 struct amba_device *dev;
72 struct amba_pl010_data *data;
73 unsigned int old_status;
76 static void pl010_stop_tx(struct uart_port *port)
78 struct uart_amba_port *uap =
79 container_of(port, struct uart_amba_port, port);
82 cr = readb(uap->port.membase + UART010_CR);
83 cr &= ~UART010_CR_TIE;
84 writel(cr, uap->port.membase + UART010_CR);
87 static void pl010_start_tx(struct uart_port *port)
89 struct uart_amba_port *uap =
90 container_of(port, struct uart_amba_port, port);
93 cr = readb(uap->port.membase + UART010_CR);
95 writel(cr, uap->port.membase + UART010_CR);
98 static void pl010_stop_rx(struct uart_port *port)
100 struct uart_amba_port *uap =
101 container_of(port, struct uart_amba_port, port);
104 cr = readb(uap->port.membase + UART010_CR);
105 cr &= ~(UART010_CR_RIE | UART010_CR_RTIE);
106 writel(cr, uap->port.membase + UART010_CR);
109 static void pl010_disable_ms(struct uart_port *port)
111 struct uart_amba_port *uap = (struct uart_amba_port *)port;
114 cr = readb(uap->port.membase + UART010_CR);
115 cr &= ~UART010_CR_MSIE;
116 writel(cr, uap->port.membase + UART010_CR);
119 static void pl010_enable_ms(struct uart_port *port)
121 struct uart_amba_port *uap =
122 container_of(port, struct uart_amba_port, port);
125 cr = readb(uap->port.membase + UART010_CR);
126 cr |= UART010_CR_MSIE;
127 writel(cr, uap->port.membase + UART010_CR);
130 static void pl010_rx_chars(struct uart_amba_port *uap)
132 unsigned int status, ch, flag, rsr, max_count = 256;
134 status = readb(uap->port.membase + UART01x_FR);
135 while (UART_RX_DATA(status) && max_count--) {
136 ch = readb(uap->port.membase + UART01x_DR);
139 uap->port.icount.rx++;
142 * Note that the error handling code is
143 * out of the main execution path
145 rsr = readb(uap->port.membase + UART01x_RSR) | UART_DUMMY_RSR_RX;
146 if (unlikely(rsr & UART01x_RSR_ANY)) {
147 writel(0, uap->port.membase + UART01x_ECR);
149 if (rsr & UART01x_RSR_BE) {
150 rsr &= ~(UART01x_RSR_FE | UART01x_RSR_PE);
151 uap->port.icount.brk++;
152 if (uart_handle_break(&uap->port))
154 } else if (rsr & UART01x_RSR_PE)
155 uap->port.icount.parity++;
156 else if (rsr & UART01x_RSR_FE)
157 uap->port.icount.frame++;
158 if (rsr & UART01x_RSR_OE)
159 uap->port.icount.overrun++;
161 rsr &= uap->port.read_status_mask;
163 if (rsr & UART01x_RSR_BE)
165 else if (rsr & UART01x_RSR_PE)
167 else if (rsr & UART01x_RSR_FE)
171 if (uart_handle_sysrq_char(&uap->port, ch))
174 uart_insert_char(&uap->port, rsr, UART01x_RSR_OE, ch, flag);
177 status = readb(uap->port.membase + UART01x_FR);
179 spin_unlock(&uap->port.lock);
180 tty_flip_buffer_push(&uap->port.state->port);
181 spin_lock(&uap->port.lock);
184 static void pl010_tx_chars(struct uart_amba_port *uap)
186 struct circ_buf *xmit = &uap->port.state->xmit;
189 if (uap->port.x_char) {
190 writel(uap->port.x_char, uap->port.membase + UART01x_DR);
191 uap->port.icount.tx++;
192 uap->port.x_char = 0;
195 if (uart_circ_empty(xmit) || uart_tx_stopped(&uap->port)) {
196 pl010_stop_tx(&uap->port);
200 count = uap->port.fifosize >> 1;
202 writel(xmit->buf[xmit->tail], uap->port.membase + UART01x_DR);
203 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
204 uap->port.icount.tx++;
205 if (uart_circ_empty(xmit))
207 } while (--count > 0);
209 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
210 uart_write_wakeup(&uap->port);
212 if (uart_circ_empty(xmit))
213 pl010_stop_tx(&uap->port);
216 static void pl010_modem_status(struct uart_amba_port *uap)
218 unsigned int status, delta;
220 writel(0, uap->port.membase + UART010_ICR);
222 status = readb(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
224 delta = status ^ uap->old_status;
225 uap->old_status = status;
230 if (delta & UART01x_FR_DCD)
231 uart_handle_dcd_change(&uap->port, status & UART01x_FR_DCD);
233 if (delta & UART01x_FR_DSR)
234 uap->port.icount.dsr++;
236 if (delta & UART01x_FR_CTS)
237 uart_handle_cts_change(&uap->port, status & UART01x_FR_CTS);
239 wake_up_interruptible(&uap->port.state->port.delta_msr_wait);
242 static irqreturn_t pl010_int(int irq, void *dev_id)
244 struct uart_amba_port *uap = dev_id;
245 unsigned int status, pass_counter = AMBA_ISR_PASS_LIMIT;
248 spin_lock(&uap->port.lock);
250 status = readb(uap->port.membase + UART010_IIR);
253 if (status & (UART010_IIR_RTIS | UART010_IIR_RIS))
255 if (status & UART010_IIR_MIS)
256 pl010_modem_status(uap);
257 if (status & UART010_IIR_TIS)
260 if (pass_counter-- == 0)
263 status = readb(uap->port.membase + UART010_IIR);
264 } while (status & (UART010_IIR_RTIS | UART010_IIR_RIS |
269 spin_unlock(&uap->port.lock);
271 return IRQ_RETVAL(handled);
274 static unsigned int pl010_tx_empty(struct uart_port *port)
276 struct uart_amba_port *uap =
277 container_of(port, struct uart_amba_port, port);
278 unsigned int status = readb(uap->port.membase + UART01x_FR);
279 return status & UART01x_FR_BUSY ? 0 : TIOCSER_TEMT;
282 static unsigned int pl010_get_mctrl(struct uart_port *port)
284 struct uart_amba_port *uap =
285 container_of(port, struct uart_amba_port, port);
286 unsigned int result = 0;
289 status = readb(uap->port.membase + UART01x_FR);
290 if (status & UART01x_FR_DCD)
292 if (status & UART01x_FR_DSR)
294 if (status & UART01x_FR_CTS)
300 static void pl010_set_mctrl(struct uart_port *port, unsigned int mctrl)
302 struct uart_amba_port *uap =
303 container_of(port, struct uart_amba_port, port);
306 uap->data->set_mctrl(uap->dev, uap->port.membase, mctrl);
309 static void pl010_break_ctl(struct uart_port *port, int break_state)
311 struct uart_amba_port *uap =
312 container_of(port, struct uart_amba_port, port);
316 spin_lock_irqsave(&uap->port.lock, flags);
317 lcr_h = readb(uap->port.membase + UART010_LCRH);
318 if (break_state == -1)
319 lcr_h |= UART01x_LCRH_BRK;
321 lcr_h &= ~UART01x_LCRH_BRK;
322 writel(lcr_h, uap->port.membase + UART010_LCRH);
323 spin_unlock_irqrestore(&uap->port.lock, flags);
326 static int pl010_startup(struct uart_port *port)
328 struct uart_amba_port *uap =
329 container_of(port, struct uart_amba_port, port);
333 * Try to enable the clock producer.
335 retval = clk_prepare_enable(uap->clk);
339 uap->port.uartclk = clk_get_rate(uap->clk);
344 retval = request_irq(uap->port.irq, pl010_int, 0, "uart-pl010", uap);
349 * initialise the old status of the modem signals
351 uap->old_status = readb(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
354 * Finally, enable interrupts
356 writel(UART01x_CR_UARTEN | UART010_CR_RIE | UART010_CR_RTIE,
357 uap->port.membase + UART010_CR);
362 clk_disable_unprepare(uap->clk);
367 static void pl010_shutdown(struct uart_port *port)
369 struct uart_amba_port *uap =
370 container_of(port, struct uart_amba_port, port);
375 free_irq(uap->port.irq, uap);
378 * disable all interrupts, disable the port
380 writel(0, uap->port.membase + UART010_CR);
382 /* disable break condition and fifos */
383 writel(readb(uap->port.membase + UART010_LCRH) &
384 ~(UART01x_LCRH_BRK | UART01x_LCRH_FEN),
385 uap->port.membase + UART010_LCRH);
388 * Shut down the clock producer
390 clk_disable_unprepare(uap->clk);
394 pl010_set_termios(struct uart_port *port, struct ktermios *termios,
395 struct ktermios *old)
397 struct uart_amba_port *uap =
398 container_of(port, struct uart_amba_port, port);
399 unsigned int lcr_h, old_cr;
401 unsigned int baud, quot;
404 * Ask the core to calculate the divisor for us.
406 baud = uart_get_baud_rate(port, termios, old, 0, uap->port.uartclk/16);
407 quot = uart_get_divisor(port, baud);
409 switch (termios->c_cflag & CSIZE) {
411 lcr_h = UART01x_LCRH_WLEN_5;
414 lcr_h = UART01x_LCRH_WLEN_6;
417 lcr_h = UART01x_LCRH_WLEN_7;
420 lcr_h = UART01x_LCRH_WLEN_8;
423 if (termios->c_cflag & CSTOPB)
424 lcr_h |= UART01x_LCRH_STP2;
425 if (termios->c_cflag & PARENB) {
426 lcr_h |= UART01x_LCRH_PEN;
427 if (!(termios->c_cflag & PARODD))
428 lcr_h |= UART01x_LCRH_EPS;
430 if (uap->port.fifosize > 1)
431 lcr_h |= UART01x_LCRH_FEN;
433 spin_lock_irqsave(&uap->port.lock, flags);
436 * Update the per-port timeout.
438 uart_update_timeout(port, termios->c_cflag, baud);
440 uap->port.read_status_mask = UART01x_RSR_OE;
441 if (termios->c_iflag & INPCK)
442 uap->port.read_status_mask |= UART01x_RSR_FE | UART01x_RSR_PE;
443 if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK))
444 uap->port.read_status_mask |= UART01x_RSR_BE;
447 * Characters to ignore
449 uap->port.ignore_status_mask = 0;
450 if (termios->c_iflag & IGNPAR)
451 uap->port.ignore_status_mask |= UART01x_RSR_FE | UART01x_RSR_PE;
452 if (termios->c_iflag & IGNBRK) {
453 uap->port.ignore_status_mask |= UART01x_RSR_BE;
455 * If we're ignoring parity and break indicators,
456 * ignore overruns too (for real raw support).
458 if (termios->c_iflag & IGNPAR)
459 uap->port.ignore_status_mask |= UART01x_RSR_OE;
463 * Ignore all characters if CREAD is not set.
465 if ((termios->c_cflag & CREAD) == 0)
466 uap->port.ignore_status_mask |= UART_DUMMY_RSR_RX;
468 /* first, disable everything */
469 old_cr = readb(uap->port.membase + UART010_CR) & ~UART010_CR_MSIE;
471 if (UART_ENABLE_MS(port, termios->c_cflag))
472 old_cr |= UART010_CR_MSIE;
474 writel(0, uap->port.membase + UART010_CR);
478 writel((quot & 0xf00) >> 8, uap->port.membase + UART010_LCRM);
479 writel(quot & 0xff, uap->port.membase + UART010_LCRL);
482 * ----------v----------v----------v----------v-----
483 * NOTE: MUST BE WRITTEN AFTER UARTLCR_M & UARTLCR_L
484 * ----------^----------^----------^----------^-----
486 writel(lcr_h, uap->port.membase + UART010_LCRH);
487 writel(old_cr, uap->port.membase + UART010_CR);
489 spin_unlock_irqrestore(&uap->port.lock, flags);
492 static void pl010_set_ldisc(struct uart_port *port, struct ktermios *termios)
494 if (termios->c_line == N_PPS) {
495 port->flags |= UPF_HARDPPS_CD;
496 spin_lock_irq(&port->lock);
497 pl010_enable_ms(port);
498 spin_unlock_irq(&port->lock);
500 port->flags &= ~UPF_HARDPPS_CD;
501 if (!UART_ENABLE_MS(port, termios->c_cflag)) {
502 spin_lock_irq(&port->lock);
503 pl010_disable_ms(port);
504 spin_unlock_irq(&port->lock);
509 static const char *pl010_type(struct uart_port *port)
511 return port->type == PORT_AMBA ? "AMBA" : NULL;
515 * Release the memory region(s) being used by 'port'
517 static void pl010_release_port(struct uart_port *port)
519 release_mem_region(port->mapbase, UART_PORT_SIZE);
523 * Request the memory region(s) being used by 'port'
525 static int pl010_request_port(struct uart_port *port)
527 return request_mem_region(port->mapbase, UART_PORT_SIZE, "uart-pl010")
528 != NULL ? 0 : -EBUSY;
532 * Configure/autoconfigure the port.
534 static void pl010_config_port(struct uart_port *port, int flags)
536 if (flags & UART_CONFIG_TYPE) {
537 port->type = PORT_AMBA;
538 pl010_request_port(port);
543 * verify the new serial_struct (for TIOCSSERIAL).
545 static int pl010_verify_port(struct uart_port *port, struct serial_struct *ser)
548 if (ser->type != PORT_UNKNOWN && ser->type != PORT_AMBA)
550 if (ser->irq < 0 || ser->irq >= nr_irqs)
552 if (ser->baud_base < 9600)
557 static struct uart_ops amba_pl010_pops = {
558 .tx_empty = pl010_tx_empty,
559 .set_mctrl = pl010_set_mctrl,
560 .get_mctrl = pl010_get_mctrl,
561 .stop_tx = pl010_stop_tx,
562 .start_tx = pl010_start_tx,
563 .stop_rx = pl010_stop_rx,
564 .enable_ms = pl010_enable_ms,
565 .break_ctl = pl010_break_ctl,
566 .startup = pl010_startup,
567 .shutdown = pl010_shutdown,
568 .set_termios = pl010_set_termios,
569 .set_ldisc = pl010_set_ldisc,
571 .release_port = pl010_release_port,
572 .request_port = pl010_request_port,
573 .config_port = pl010_config_port,
574 .verify_port = pl010_verify_port,
577 static struct uart_amba_port *amba_ports[UART_NR];
579 #ifdef CONFIG_SERIAL_AMBA_PL010_CONSOLE
581 static void pl010_console_putchar(struct uart_port *port, int ch)
583 struct uart_amba_port *uap =
584 container_of(port, struct uart_amba_port, port);
588 status = readb(uap->port.membase + UART01x_FR);
590 } while (!UART_TX_READY(status));
591 writel(ch, uap->port.membase + UART01x_DR);
595 pl010_console_write(struct console *co, const char *s, unsigned int count)
597 struct uart_amba_port *uap = amba_ports[co->index];
598 unsigned int status, old_cr;
600 clk_enable(uap->clk);
603 * First save the CR then disable the interrupts
605 old_cr = readb(uap->port.membase + UART010_CR);
606 writel(UART01x_CR_UARTEN, uap->port.membase + UART010_CR);
608 uart_console_write(&uap->port, s, count, pl010_console_putchar);
611 * Finally, wait for transmitter to become empty
612 * and restore the TCR
615 status = readb(uap->port.membase + UART01x_FR);
617 } while (status & UART01x_FR_BUSY);
618 writel(old_cr, uap->port.membase + UART010_CR);
620 clk_disable(uap->clk);
624 pl010_console_get_options(struct uart_amba_port *uap, int *baud,
625 int *parity, int *bits)
627 if (readb(uap->port.membase + UART010_CR) & UART01x_CR_UARTEN) {
628 unsigned int lcr_h, quot;
629 lcr_h = readb(uap->port.membase + UART010_LCRH);
632 if (lcr_h & UART01x_LCRH_PEN) {
633 if (lcr_h & UART01x_LCRH_EPS)
639 if ((lcr_h & 0x60) == UART01x_LCRH_WLEN_7)
644 quot = readb(uap->port.membase + UART010_LCRL) |
645 readb(uap->port.membase + UART010_LCRM) << 8;
646 *baud = uap->port.uartclk / (16 * (quot + 1));
650 static int __init pl010_console_setup(struct console *co, char *options)
652 struct uart_amba_port *uap;
660 * Check whether an invalid uart number has been specified, and
661 * if so, search for the first available port that does have
664 if (co->index >= UART_NR)
666 uap = amba_ports[co->index];
670 ret = clk_prepare(uap->clk);
674 uap->port.uartclk = clk_get_rate(uap->clk);
677 uart_parse_options(options, &baud, &parity, &bits, &flow);
679 pl010_console_get_options(uap, &baud, &parity, &bits);
681 return uart_set_options(&uap->port, co, baud, parity, bits, flow);
684 static struct uart_driver amba_reg;
685 static struct console amba_console = {
687 .write = pl010_console_write,
688 .device = uart_console_device,
689 .setup = pl010_console_setup,
690 .flags = CON_PRINTBUFFER,
695 #define AMBA_CONSOLE &amba_console
697 #define AMBA_CONSOLE NULL
700 static struct uart_driver amba_reg = {
701 .owner = THIS_MODULE,
702 .driver_name = "ttyAM",
704 .major = SERIAL_AMBA_MAJOR,
705 .minor = SERIAL_AMBA_MINOR,
707 .cons = AMBA_CONSOLE,
710 static int pl010_probe(struct amba_device *dev, const struct amba_id *id)
712 struct uart_amba_port *uap;
716 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
717 if (amba_ports[i] == NULL)
720 if (i == ARRAY_SIZE(amba_ports))
723 uap = devm_kzalloc(&dev->dev, sizeof(struct uart_amba_port),
728 base = devm_ioremap(&dev->dev, dev->res.start,
729 resource_size(&dev->res));
733 uap->clk = devm_clk_get(&dev->dev, NULL);
734 if (IS_ERR(uap->clk))
735 return PTR_ERR(uap->clk);
737 uap->port.dev = &dev->dev;
738 uap->port.mapbase = dev->res.start;
739 uap->port.membase = base;
740 uap->port.iotype = UPIO_MEM;
741 uap->port.irq = dev->irq[0];
742 uap->port.fifosize = 16;
743 uap->port.ops = &amba_pl010_pops;
744 uap->port.flags = UPF_BOOT_AUTOCONF;
747 uap->data = dev_get_platdata(&dev->dev);
751 amba_set_drvdata(dev, uap);
752 ret = uart_add_one_port(&amba_reg, &uap->port);
754 amba_ports[i] = NULL;
759 static int pl010_remove(struct amba_device *dev)
761 struct uart_amba_port *uap = amba_get_drvdata(dev);
764 uart_remove_one_port(&amba_reg, &uap->port);
766 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
767 if (amba_ports[i] == uap)
768 amba_ports[i] = NULL;
773 #ifdef CONFIG_PM_SLEEP
774 static int pl010_suspend(struct device *dev)
776 struct uart_amba_port *uap = dev_get_drvdata(dev);
779 uart_suspend_port(&amba_reg, &uap->port);
784 static int pl010_resume(struct device *dev)
786 struct uart_amba_port *uap = dev_get_drvdata(dev);
789 uart_resume_port(&amba_reg, &uap->port);
795 static SIMPLE_DEV_PM_OPS(pl010_dev_pm_ops, pl010_suspend, pl010_resume);
797 static struct amba_id pl010_ids[] = {
805 MODULE_DEVICE_TABLE(amba, pl010_ids);
807 static struct amba_driver pl010_driver = {
809 .name = "uart-pl010",
810 .pm = &pl010_dev_pm_ops,
812 .id_table = pl010_ids,
813 .probe = pl010_probe,
814 .remove = pl010_remove,
817 static int __init pl010_init(void)
821 printk(KERN_INFO "Serial: AMBA driver\n");
823 ret = uart_register_driver(&amba_reg);
825 ret = amba_driver_register(&pl010_driver);
827 uart_unregister_driver(&amba_reg);
832 static void __exit pl010_exit(void)
834 amba_driver_unregister(&pl010_driver);
835 uart_unregister_driver(&amba_reg);
838 module_init(pl010_init);
839 module_exit(pl010_exit);
841 MODULE_AUTHOR("ARM Ltd/Deep Blue Solutions Ltd");
842 MODULE_DESCRIPTION("ARM AMBA serial port driver");
843 MODULE_LICENSE("GPL");