2 * linux/drivers/char/amba.c
4 * Driver for AMBA serial ports
6 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
8 * Copyright 1999 ARM Limited
9 * Copyright (C) 2000 Deep Blue Solutions Ltd.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * $Id: amba.c,v 1.41 2002/07/28 10:03:27 rmk Exp $
27 * This is a generic driver for ARM AMBA-type serial ports. They
28 * have a lot of 16550-like features, but are not register compatible.
29 * Note that although they do have CTS, DCD and DSR inputs, they do
30 * not have an RI input, nor do they have DTR or RTS outputs. If
31 * required, these have to be supplied via some other means (eg, GPIO)
32 * and hooked into this driver.
34 #include <linux/config.h>
36 #if defined(CONFIG_SERIAL_AMBA_PL011_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
40 #include <linux/module.h>
41 #include <linux/ioport.h>
42 #include <linux/init.h>
43 #include <linux/console.h>
44 #include <linux/sysrq.h>
45 #include <linux/device.h>
46 #include <linux/tty.h>
47 #include <linux/tty_flip.h>
48 #include <linux/serial_core.h>
49 #include <linux/serial.h>
53 #include <asm/sizes.h>
54 #include <asm/hardware/amba.h>
55 #include <asm/hardware/clock.h>
56 #include <asm/hardware/amba_serial.h>
60 #define SERIAL_AMBA_MAJOR 204
61 #define SERIAL_AMBA_MINOR 64
62 #define SERIAL_AMBA_NR UART_NR
64 #define AMBA_ISR_PASS_LIMIT 256
66 #define UART_DUMMY_RSR_RX 256
69 * We wrap our port structure around the generic uart_port.
71 struct uart_amba_port {
72 struct uart_port port;
74 unsigned int im; /* interrupt mask */
75 unsigned int old_status;
78 static void pl011_stop_tx(struct uart_port *port)
80 struct uart_amba_port *uap = (struct uart_amba_port *)port;
82 uap->im &= ~UART011_TXIM;
83 writew(uap->im, uap->port.membase + UART011_IMSC);
86 static void pl011_start_tx(struct uart_port *port)
88 struct uart_amba_port *uap = (struct uart_amba_port *)port;
90 uap->im |= UART011_TXIM;
91 writew(uap->im, uap->port.membase + UART011_IMSC);
94 static void pl011_stop_rx(struct uart_port *port)
96 struct uart_amba_port *uap = (struct uart_amba_port *)port;
98 uap->im &= ~(UART011_RXIM|UART011_RTIM|UART011_FEIM|
99 UART011_PEIM|UART011_BEIM|UART011_OEIM);
100 writew(uap->im, uap->port.membase + UART011_IMSC);
103 static void pl011_enable_ms(struct uart_port *port)
105 struct uart_amba_port *uap = (struct uart_amba_port *)port;
107 uap->im |= UART011_RIMIM|UART011_CTSMIM|UART011_DCDMIM|UART011_DSRMIM;
108 writew(uap->im, uap->port.membase + UART011_IMSC);
113 pl011_rx_chars(struct uart_amba_port *uap, struct pt_regs *regs)
115 pl011_rx_chars(struct uart_amba_port *uap)
118 struct tty_struct *tty = uap->port.info->tty;
119 unsigned int status, ch, flag, rsr, max_count = 256;
121 status = readw(uap->port.membase + UART01x_FR);
122 while ((status & UART01x_FR_RXFE) == 0 && max_count--) {
123 if (tty->flip.count >= TTY_FLIPBUF_SIZE) {
124 if (tty->low_latency)
125 tty_flip_buffer_push(tty);
127 * If this failed then we will throw away the
128 * bytes but must do so to clear interrupts
132 ch = readw(uap->port.membase + UART01x_DR);
134 uap->port.icount.rx++;
137 * Note that the error handling code is
138 * out of the main execution path
140 rsr = readw(uap->port.membase + UART01x_RSR) | UART_DUMMY_RSR_RX;
141 if (unlikely(rsr & UART01x_RSR_ANY)) {
142 if (rsr & UART01x_RSR_BE) {
143 rsr &= ~(UART01x_RSR_FE | UART01x_RSR_PE);
144 uap->port.icount.brk++;
145 if (uart_handle_break(&uap->port))
147 } else if (rsr & UART01x_RSR_PE)
148 uap->port.icount.parity++;
149 else if (rsr & UART01x_RSR_FE)
150 uap->port.icount.frame++;
151 if (rsr & UART01x_RSR_OE)
152 uap->port.icount.overrun++;
154 rsr &= uap->port.read_status_mask;
156 if (rsr & UART01x_RSR_BE)
158 else if (rsr & UART01x_RSR_PE)
160 else if (rsr & UART01x_RSR_FE)
164 if (uart_handle_sysrq_char(&uap->port, ch, regs))
167 uart_insert_char(&uap->port, rsr, UART01x_RSR_OE, ch, flag);
170 status = readw(uap->port.membase + UART01x_FR);
172 tty_flip_buffer_push(tty);
176 static void pl011_tx_chars(struct uart_amba_port *uap)
178 struct circ_buf *xmit = &uap->port.info->xmit;
181 if (uap->port.x_char) {
182 writew(uap->port.x_char, uap->port.membase + UART01x_DR);
183 uap->port.icount.tx++;
184 uap->port.x_char = 0;
187 if (uart_circ_empty(xmit) || uart_tx_stopped(&uap->port)) {
188 pl011_stop_tx(&uap->port);
192 count = uap->port.fifosize >> 1;
194 writew(xmit->buf[xmit->tail], uap->port.membase + UART01x_DR);
195 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
196 uap->port.icount.tx++;
197 if (uart_circ_empty(xmit))
199 } while (--count > 0);
201 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
202 uart_write_wakeup(&uap->port);
204 if (uart_circ_empty(xmit))
205 pl011_stop_tx(&uap->port);
208 static void pl011_modem_status(struct uart_amba_port *uap)
210 unsigned int status, delta;
212 status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
214 delta = status ^ uap->old_status;
215 uap->old_status = status;
220 if (delta & UART01x_FR_DCD)
221 uart_handle_dcd_change(&uap->port, status & UART01x_FR_DCD);
223 if (delta & UART01x_FR_DSR)
224 uap->port.icount.dsr++;
226 if (delta & UART01x_FR_CTS)
227 uart_handle_cts_change(&uap->port, status & UART01x_FR_CTS);
229 wake_up_interruptible(&uap->port.info->delta_msr_wait);
232 static irqreturn_t pl011_int(int irq, void *dev_id, struct pt_regs *regs)
234 struct uart_amba_port *uap = dev_id;
235 unsigned int status, pass_counter = AMBA_ISR_PASS_LIMIT;
238 spin_lock(&uap->port.lock);
240 status = readw(uap->port.membase + UART011_MIS);
243 writew(status & ~(UART011_TXIS|UART011_RTIS|
245 uap->port.membase + UART011_ICR);
247 if (status & (UART011_RTIS|UART011_RXIS))
249 pl011_rx_chars(uap, regs);
253 if (status & (UART011_DSRMIS|UART011_DCDMIS|
254 UART011_CTSMIS|UART011_RIMIS))
255 pl011_modem_status(uap);
256 if (status & UART011_TXIS)
259 if (pass_counter-- == 0)
262 status = readw(uap->port.membase + UART011_MIS);
263 } while (status != 0);
267 spin_unlock(&uap->port.lock);
269 return IRQ_RETVAL(handled);
272 static unsigned int pl01x_tx_empty(struct uart_port *port)
274 struct uart_amba_port *uap = (struct uart_amba_port *)port;
275 unsigned int status = readw(uap->port.membase + UART01x_FR);
276 return status & (UART01x_FR_BUSY|UART01x_FR_TXFF) ? 0 : TIOCSER_TEMT;
279 static unsigned int pl01x_get_mctrl(struct uart_port *port)
281 struct uart_amba_port *uap = (struct uart_amba_port *)port;
282 unsigned int result = 0;
283 unsigned int status = readw(uap->port.membase + UART01x_FR);
285 #define BIT(uartbit, tiocmbit) \
286 if (status & uartbit) \
289 BIT(UART01x_FR_DCD, TIOCM_CAR);
290 BIT(UART01x_FR_DSR, TIOCM_DSR);
291 BIT(UART01x_FR_CTS, TIOCM_CTS);
292 BIT(UART011_FR_RI, TIOCM_RNG);
297 static void pl011_set_mctrl(struct uart_port *port, unsigned int mctrl)
299 struct uart_amba_port *uap = (struct uart_amba_port *)port;
302 cr = readw(uap->port.membase + UART011_CR);
304 #define BIT(tiocmbit, uartbit) \
305 if (mctrl & tiocmbit) \
310 BIT(TIOCM_RTS, UART011_CR_RTS);
311 BIT(TIOCM_DTR, UART011_CR_DTR);
312 BIT(TIOCM_OUT1, UART011_CR_OUT1);
313 BIT(TIOCM_OUT2, UART011_CR_OUT2);
314 BIT(TIOCM_LOOP, UART011_CR_LBE);
317 writew(cr, uap->port.membase + UART011_CR);
320 static void pl011_break_ctl(struct uart_port *port, int break_state)
322 struct uart_amba_port *uap = (struct uart_amba_port *)port;
326 spin_lock_irqsave(&uap->port.lock, flags);
327 lcr_h = readw(uap->port.membase + UART011_LCRH);
328 if (break_state == -1)
329 lcr_h |= UART01x_LCRH_BRK;
331 lcr_h &= ~UART01x_LCRH_BRK;
332 writew(lcr_h, uap->port.membase + UART011_LCRH);
333 spin_unlock_irqrestore(&uap->port.lock, flags);
336 static int pl011_startup(struct uart_port *port)
338 struct uart_amba_port *uap = (struct uart_amba_port *)port;
343 * Try to enable the clock producer.
345 retval = clk_enable(uap->clk);
349 uap->port.uartclk = clk_get_rate(uap->clk);
354 retval = request_irq(uap->port.irq, pl011_int, 0, "uart-pl011", uap);
358 writew(UART011_IFLS_RX4_8|UART011_IFLS_TX4_8,
359 uap->port.membase + UART011_IFLS);
362 * Provoke TX FIFO interrupt into asserting.
364 cr = UART01x_CR_UARTEN | UART011_CR_TXE | UART011_CR_LBE;
365 writew(cr, uap->port.membase + UART011_CR);
366 writew(0, uap->port.membase + UART011_FBRD);
367 writew(1, uap->port.membase + UART011_IBRD);
368 writew(0, uap->port.membase + UART011_LCRH);
369 writew(0, uap->port.membase + UART01x_DR);
370 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_BUSY)
373 cr = UART01x_CR_UARTEN | UART011_CR_RXE | UART011_CR_TXE;
374 writew(cr, uap->port.membase + UART011_CR);
377 * initialise the old status of the modem signals
379 uap->old_status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
382 * Finally, enable interrupts
384 spin_lock_irq(&uap->port.lock);
385 uap->im = UART011_RXIM | UART011_RTIM;
386 writew(uap->im, uap->port.membase + UART011_IMSC);
387 spin_unlock_irq(&uap->port.lock);
392 clk_disable(uap->clk);
397 static void pl011_shutdown(struct uart_port *port)
399 struct uart_amba_port *uap = (struct uart_amba_port *)port;
403 * disable all interrupts
405 spin_lock_irq(&uap->port.lock);
407 writew(uap->im, uap->port.membase + UART011_IMSC);
408 writew(0xffff, uap->port.membase + UART011_ICR);
409 spin_unlock_irq(&uap->port.lock);
414 free_irq(uap->port.irq, uap);
419 writew(UART01x_CR_UARTEN | UART011_CR_TXE, uap->port.membase + UART011_CR);
422 * disable break condition and fifos
424 val = readw(uap->port.membase + UART011_LCRH);
425 val &= ~(UART01x_LCRH_BRK | UART01x_LCRH_FEN);
426 writew(val, uap->port.membase + UART011_LCRH);
429 * Shut down the clock producer
431 clk_disable(uap->clk);
435 pl011_set_termios(struct uart_port *port, struct termios *termios,
438 unsigned int lcr_h, old_cr;
440 unsigned int baud, quot;
443 * Ask the core to calculate the divisor for us.
445 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
446 quot = port->uartclk * 4 / baud;
448 switch (termios->c_cflag & CSIZE) {
450 lcr_h = UART01x_LCRH_WLEN_5;
453 lcr_h = UART01x_LCRH_WLEN_6;
456 lcr_h = UART01x_LCRH_WLEN_7;
459 lcr_h = UART01x_LCRH_WLEN_8;
462 if (termios->c_cflag & CSTOPB)
463 lcr_h |= UART01x_LCRH_STP2;
464 if (termios->c_cflag & PARENB) {
465 lcr_h |= UART01x_LCRH_PEN;
466 if (!(termios->c_cflag & PARODD))
467 lcr_h |= UART01x_LCRH_EPS;
469 if (port->fifosize > 1)
470 lcr_h |= UART01x_LCRH_FEN;
472 spin_lock_irqsave(&port->lock, flags);
475 * Update the per-port timeout.
477 uart_update_timeout(port, termios->c_cflag, baud);
479 port->read_status_mask = UART01x_RSR_OE;
480 if (termios->c_iflag & INPCK)
481 port->read_status_mask |= UART01x_RSR_FE | UART01x_RSR_PE;
482 if (termios->c_iflag & (BRKINT | PARMRK))
483 port->read_status_mask |= UART01x_RSR_BE;
486 * Characters to ignore
488 port->ignore_status_mask = 0;
489 if (termios->c_iflag & IGNPAR)
490 port->ignore_status_mask |= UART01x_RSR_FE | UART01x_RSR_PE;
491 if (termios->c_iflag & IGNBRK) {
492 port->ignore_status_mask |= UART01x_RSR_BE;
494 * If we're ignoring parity and break indicators,
495 * ignore overruns too (for real raw support).
497 if (termios->c_iflag & IGNPAR)
498 port->ignore_status_mask |= UART01x_RSR_OE;
502 * Ignore all characters if CREAD is not set.
504 if ((termios->c_cflag & CREAD) == 0)
505 port->ignore_status_mask |= UART_DUMMY_RSR_RX;
507 if (UART_ENABLE_MS(port, termios->c_cflag))
508 pl011_enable_ms(port);
510 /* first, disable everything */
511 old_cr = readw(port->membase + UART011_CR);
512 writew(0, port->membase + UART011_CR);
515 writew(quot & 0x3f, port->membase + UART011_FBRD);
516 writew(quot >> 6, port->membase + UART011_IBRD);
519 * ----------v----------v----------v----------v-----
520 * NOTE: MUST BE WRITTEN AFTER UARTLCR_M & UARTLCR_L
521 * ----------^----------^----------^----------^-----
523 writew(lcr_h, port->membase + UART011_LCRH);
524 writew(old_cr, port->membase + UART011_CR);
526 spin_unlock_irqrestore(&port->lock, flags);
529 static const char *pl011_type(struct uart_port *port)
531 return port->type == PORT_AMBA ? "AMBA/PL011" : NULL;
535 * Release the memory region(s) being used by 'port'
537 static void pl010_release_port(struct uart_port *port)
539 release_mem_region(port->mapbase, SZ_4K);
543 * Request the memory region(s) being used by 'port'
545 static int pl010_request_port(struct uart_port *port)
547 return request_mem_region(port->mapbase, SZ_4K, "uart-pl011")
548 != NULL ? 0 : -EBUSY;
552 * Configure/autoconfigure the port.
554 static void pl010_config_port(struct uart_port *port, int flags)
556 if (flags & UART_CONFIG_TYPE) {
557 port->type = PORT_AMBA;
558 pl010_request_port(port);
563 * verify the new serial_struct (for TIOCSSERIAL).
565 static int pl010_verify_port(struct uart_port *port, struct serial_struct *ser)
568 if (ser->type != PORT_UNKNOWN && ser->type != PORT_AMBA)
570 if (ser->irq < 0 || ser->irq >= NR_IRQS)
572 if (ser->baud_base < 9600)
577 static struct uart_ops amba_pl011_pops = {
578 .tx_empty = pl01x_tx_empty,
579 .set_mctrl = pl011_set_mctrl,
580 .get_mctrl = pl01x_get_mctrl,
581 .stop_tx = pl011_stop_tx,
582 .start_tx = pl011_start_tx,
583 .stop_rx = pl011_stop_rx,
584 .enable_ms = pl011_enable_ms,
585 .break_ctl = pl011_break_ctl,
586 .startup = pl011_startup,
587 .shutdown = pl011_shutdown,
588 .set_termios = pl011_set_termios,
590 .release_port = pl010_release_port,
591 .request_port = pl010_request_port,
592 .config_port = pl010_config_port,
593 .verify_port = pl010_verify_port,
596 static struct uart_amba_port *amba_ports[UART_NR];
598 #ifdef CONFIG_SERIAL_AMBA_PL011_CONSOLE
601 pl011_console_write_char(struct uart_amba_port *uap, char ch)
606 status = readw(uap->port.membase + UART01x_FR);
607 } while (status & UART01x_FR_TXFF);
608 writew(ch, uap->port.membase + UART01x_DR);
612 pl011_console_write(struct console *co, const char *s, unsigned int count)
614 struct uart_amba_port *uap = amba_ports[co->index];
615 unsigned int status, old_cr, new_cr;
618 clk_enable(uap->clk);
621 * First save the CR then disable the interrupts
623 old_cr = readw(uap->port.membase + UART011_CR);
624 new_cr = old_cr & ~UART011_CR_CTSEN;
625 new_cr |= UART01x_CR_UARTEN | UART011_CR_TXE;
626 writew(new_cr, uap->port.membase + UART011_CR);
629 * Now, do each character
631 for (i = 0; i < count; i++) {
632 pl011_console_write_char(uap, s[i]);
634 pl011_console_write_char(uap, '\r');
638 * Finally, wait for transmitter to become empty
639 * and restore the TCR
642 status = readw(uap->port.membase + UART01x_FR);
643 } while (status & UART01x_FR_BUSY);
644 writew(old_cr, uap->port.membase + UART011_CR);
646 clk_disable(uap->clk);
650 pl011_console_get_options(struct uart_amba_port *uap, int *baud,
651 int *parity, int *bits)
653 if (readw(uap->port.membase + UART011_CR) & UART01x_CR_UARTEN) {
654 unsigned int lcr_h, ibrd, fbrd;
656 lcr_h = readw(uap->port.membase + UART011_LCRH);
659 if (lcr_h & UART01x_LCRH_PEN) {
660 if (lcr_h & UART01x_LCRH_EPS)
666 if ((lcr_h & 0x60) == UART01x_LCRH_WLEN_7)
671 ibrd = readw(uap->port.membase + UART011_IBRD);
672 fbrd = readw(uap->port.membase + UART011_FBRD);
674 *baud = uap->port.uartclk * 4 / (64 * ibrd + fbrd);
678 static int __init pl011_console_setup(struct console *co, char *options)
680 struct uart_amba_port *uap;
687 * Check whether an invalid uart number has been specified, and
688 * if so, search for the first available port that does have
691 if (co->index >= UART_NR)
693 uap = amba_ports[co->index];
695 uap->port.uartclk = clk_get_rate(uap->clk);
698 uart_parse_options(options, &baud, &parity, &bits, &flow);
700 pl011_console_get_options(uap, &baud, &parity, &bits);
702 return uart_set_options(&uap->port, co, baud, parity, bits, flow);
705 static struct uart_driver amba_reg;
706 static struct console amba_console = {
708 .write = pl011_console_write,
709 .device = uart_console_device,
710 .setup = pl011_console_setup,
711 .flags = CON_PRINTBUFFER,
716 #define AMBA_CONSOLE (&amba_console)
718 #define AMBA_CONSOLE NULL
721 static struct uart_driver amba_reg = {
722 .owner = THIS_MODULE,
723 .driver_name = "ttyAMA",
724 .dev_name = "ttyAMA",
725 .major = SERIAL_AMBA_MAJOR,
726 .minor = SERIAL_AMBA_MINOR,
728 .cons = AMBA_CONSOLE,
731 static int pl011_probe(struct amba_device *dev, void *id)
733 struct uart_amba_port *uap;
737 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
738 if (amba_ports[i] == NULL)
741 if (i == ARRAY_SIZE(amba_ports)) {
746 uap = kmalloc(sizeof(struct uart_amba_port), GFP_KERNEL);
752 base = ioremap(dev->res.start, PAGE_SIZE);
758 memset(uap, 0, sizeof(struct uart_amba_port));
759 uap->clk = clk_get(&dev->dev, "UARTCLK");
760 if (IS_ERR(uap->clk)) {
761 ret = PTR_ERR(uap->clk);
765 ret = clk_use(uap->clk);
769 uap->port.dev = &dev->dev;
770 uap->port.mapbase = dev->res.start;
771 uap->port.membase = base;
772 uap->port.iotype = UPIO_MEM;
773 uap->port.irq = dev->irq[0];
774 uap->port.fifosize = 16;
775 uap->port.ops = &amba_pl011_pops;
776 uap->port.flags = UPF_BOOT_AUTOCONF;
781 amba_set_drvdata(dev, uap);
782 ret = uart_add_one_port(&amba_reg, &uap->port);
784 amba_set_drvdata(dev, NULL);
785 amba_ports[i] = NULL;
798 static int pl011_remove(struct amba_device *dev)
800 struct uart_amba_port *uap = amba_get_drvdata(dev);
803 amba_set_drvdata(dev, NULL);
805 uart_remove_one_port(&amba_reg, &uap->port);
807 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
808 if (amba_ports[i] == uap)
809 amba_ports[i] = NULL;
811 iounmap(uap->port.membase);
818 static struct amba_id pl011_ids[] __initdata = {
826 static struct amba_driver pl011_driver = {
828 .name = "uart-pl011",
830 .id_table = pl011_ids,
831 .probe = pl011_probe,
832 .remove = pl011_remove,
835 static int __init pl011_init(void)
838 printk(KERN_INFO "Serial: AMBA PL011 UART driver\n");
840 ret = uart_register_driver(&amba_reg);
842 ret = amba_driver_register(&pl011_driver);
844 uart_unregister_driver(&amba_reg);
849 static void __exit pl011_exit(void)
851 amba_driver_unregister(&pl011_driver);
852 uart_unregister_driver(&amba_reg);
855 module_init(pl011_init);
856 module_exit(pl011_exit);
858 MODULE_AUTHOR("ARM Ltd/Deep Blue Solutions Ltd");
859 MODULE_DESCRIPTION("ARM AMBA serial port driver");
860 MODULE_LICENSE("GPL");