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.
35 #if defined(CONFIG_SERIAL_AMBA_PL011_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
39 #include <linux/module.h>
40 #include <linux/ioport.h>
41 #include <linux/init.h>
42 #include <linux/console.h>
43 #include <linux/sysrq.h>
44 #include <linux/device.h>
45 #include <linux/tty.h>
46 #include <linux/tty_flip.h>
47 #include <linux/serial_core.h>
48 #include <linux/serial.h>
49 #include <linux/amba/bus.h>
50 #include <linux/amba/serial.h>
51 #include <linux/clk.h>
54 #include <asm/sizes.h>
58 #define SERIAL_AMBA_MAJOR 204
59 #define SERIAL_AMBA_MINOR 64
60 #define SERIAL_AMBA_NR UART_NR
62 #define AMBA_ISR_PASS_LIMIT 256
64 #define UART_DR_ERROR (UART011_DR_OE|UART011_DR_BE|UART011_DR_PE|UART011_DR_FE)
65 #define UART_DUMMY_DR_RX (1 << 16)
68 * We wrap our port structure around the generic uart_port.
70 struct uart_amba_port {
71 struct uart_port port;
73 unsigned int im; /* interrupt mask */
74 unsigned int old_status;
77 static void pl011_stop_tx(struct uart_port *port)
79 struct uart_amba_port *uap = (struct uart_amba_port *)port;
81 uap->im &= ~UART011_TXIM;
82 writew(uap->im, uap->port.membase + UART011_IMSC);
85 static void pl011_start_tx(struct uart_port *port)
87 struct uart_amba_port *uap = (struct uart_amba_port *)port;
89 uap->im |= UART011_TXIM;
90 writew(uap->im, uap->port.membase + UART011_IMSC);
93 static void pl011_stop_rx(struct uart_port *port)
95 struct uart_amba_port *uap = (struct uart_amba_port *)port;
97 uap->im &= ~(UART011_RXIM|UART011_RTIM|UART011_FEIM|
98 UART011_PEIM|UART011_BEIM|UART011_OEIM);
99 writew(uap->im, uap->port.membase + UART011_IMSC);
102 static void pl011_enable_ms(struct uart_port *port)
104 struct uart_amba_port *uap = (struct uart_amba_port *)port;
106 uap->im |= UART011_RIMIM|UART011_CTSMIM|UART011_DCDMIM|UART011_DSRMIM;
107 writew(uap->im, uap->port.membase + UART011_IMSC);
110 static void pl011_rx_chars(struct uart_amba_port *uap)
112 struct tty_struct *tty = uap->port.info->tty;
113 unsigned int status, ch, flag, max_count = 256;
115 status = readw(uap->port.membase + UART01x_FR);
116 while ((status & UART01x_FR_RXFE) == 0 && max_count--) {
117 ch = readw(uap->port.membase + UART01x_DR) | UART_DUMMY_DR_RX;
119 uap->port.icount.rx++;
122 * Note that the error handling code is
123 * out of the main execution path
125 if (unlikely(ch & UART_DR_ERROR)) {
126 if (ch & UART011_DR_BE) {
127 ch &= ~(UART011_DR_FE | UART011_DR_PE);
128 uap->port.icount.brk++;
129 if (uart_handle_break(&uap->port))
131 } else if (ch & UART011_DR_PE)
132 uap->port.icount.parity++;
133 else if (ch & UART011_DR_FE)
134 uap->port.icount.frame++;
135 if (ch & UART011_DR_OE)
136 uap->port.icount.overrun++;
138 ch &= uap->port.read_status_mask;
140 if (ch & UART011_DR_BE)
142 else if (ch & UART011_DR_PE)
144 else if (ch & UART011_DR_FE)
148 if (uart_handle_sysrq_char(&uap->port, ch & 255))
151 uart_insert_char(&uap->port, ch, UART011_DR_OE, ch, flag);
154 status = readw(uap->port.membase + UART01x_FR);
156 spin_unlock(&uap->port.lock);
157 tty_flip_buffer_push(tty);
158 spin_lock(&uap->port.lock);
161 static void pl011_tx_chars(struct uart_amba_port *uap)
163 struct circ_buf *xmit = &uap->port.info->xmit;
166 if (uap->port.x_char) {
167 writew(uap->port.x_char, uap->port.membase + UART01x_DR);
168 uap->port.icount.tx++;
169 uap->port.x_char = 0;
172 if (uart_circ_empty(xmit) || uart_tx_stopped(&uap->port)) {
173 pl011_stop_tx(&uap->port);
177 count = uap->port.fifosize >> 1;
179 writew(xmit->buf[xmit->tail], uap->port.membase + UART01x_DR);
180 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
181 uap->port.icount.tx++;
182 if (uart_circ_empty(xmit))
184 } while (--count > 0);
186 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
187 uart_write_wakeup(&uap->port);
189 if (uart_circ_empty(xmit))
190 pl011_stop_tx(&uap->port);
193 static void pl011_modem_status(struct uart_amba_port *uap)
195 unsigned int status, delta;
197 status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
199 delta = status ^ uap->old_status;
200 uap->old_status = status;
205 if (delta & UART01x_FR_DCD)
206 uart_handle_dcd_change(&uap->port, status & UART01x_FR_DCD);
208 if (delta & UART01x_FR_DSR)
209 uap->port.icount.dsr++;
211 if (delta & UART01x_FR_CTS)
212 uart_handle_cts_change(&uap->port, status & UART01x_FR_CTS);
214 wake_up_interruptible(&uap->port.info->delta_msr_wait);
217 static irqreturn_t pl011_int(int irq, void *dev_id)
219 struct uart_amba_port *uap = dev_id;
220 unsigned int status, pass_counter = AMBA_ISR_PASS_LIMIT;
223 spin_lock(&uap->port.lock);
225 status = readw(uap->port.membase + UART011_MIS);
228 writew(status & ~(UART011_TXIS|UART011_RTIS|
230 uap->port.membase + UART011_ICR);
232 if (status & (UART011_RTIS|UART011_RXIS))
234 if (status & (UART011_DSRMIS|UART011_DCDMIS|
235 UART011_CTSMIS|UART011_RIMIS))
236 pl011_modem_status(uap);
237 if (status & UART011_TXIS)
240 if (pass_counter-- == 0)
243 status = readw(uap->port.membase + UART011_MIS);
244 } while (status != 0);
248 spin_unlock(&uap->port.lock);
250 return IRQ_RETVAL(handled);
253 static unsigned int pl01x_tx_empty(struct uart_port *port)
255 struct uart_amba_port *uap = (struct uart_amba_port *)port;
256 unsigned int status = readw(uap->port.membase + UART01x_FR);
257 return status & (UART01x_FR_BUSY|UART01x_FR_TXFF) ? 0 : TIOCSER_TEMT;
260 static unsigned int pl01x_get_mctrl(struct uart_port *port)
262 struct uart_amba_port *uap = (struct uart_amba_port *)port;
263 unsigned int result = 0;
264 unsigned int status = readw(uap->port.membase + UART01x_FR);
266 #define TIOCMBIT(uartbit, tiocmbit) \
267 if (status & uartbit) \
270 TIOCMBIT(UART01x_FR_DCD, TIOCM_CAR);
271 TIOCMBIT(UART01x_FR_DSR, TIOCM_DSR);
272 TIOCMBIT(UART01x_FR_CTS, TIOCM_CTS);
273 TIOCMBIT(UART011_FR_RI, TIOCM_RNG);
278 static void pl011_set_mctrl(struct uart_port *port, unsigned int mctrl)
280 struct uart_amba_port *uap = (struct uart_amba_port *)port;
283 cr = readw(uap->port.membase + UART011_CR);
285 #define TIOCMBIT(tiocmbit, uartbit) \
286 if (mctrl & tiocmbit) \
291 TIOCMBIT(TIOCM_RTS, UART011_CR_RTS);
292 TIOCMBIT(TIOCM_DTR, UART011_CR_DTR);
293 TIOCMBIT(TIOCM_OUT1, UART011_CR_OUT1);
294 TIOCMBIT(TIOCM_OUT2, UART011_CR_OUT2);
295 TIOCMBIT(TIOCM_LOOP, UART011_CR_LBE);
298 writew(cr, uap->port.membase + UART011_CR);
301 static void pl011_break_ctl(struct uart_port *port, int break_state)
303 struct uart_amba_port *uap = (struct uart_amba_port *)port;
307 spin_lock_irqsave(&uap->port.lock, flags);
308 lcr_h = readw(uap->port.membase + UART011_LCRH);
309 if (break_state == -1)
310 lcr_h |= UART01x_LCRH_BRK;
312 lcr_h &= ~UART01x_LCRH_BRK;
313 writew(lcr_h, uap->port.membase + UART011_LCRH);
314 spin_unlock_irqrestore(&uap->port.lock, flags);
317 static int pl011_startup(struct uart_port *port)
319 struct uart_amba_port *uap = (struct uart_amba_port *)port;
324 * Try to enable the clock producer.
326 retval = clk_enable(uap->clk);
330 uap->port.uartclk = clk_get_rate(uap->clk);
335 retval = request_irq(uap->port.irq, pl011_int, 0, "uart-pl011", uap);
339 writew(UART011_IFLS_RX4_8|UART011_IFLS_TX4_8,
340 uap->port.membase + UART011_IFLS);
343 * Provoke TX FIFO interrupt into asserting.
345 cr = UART01x_CR_UARTEN | UART011_CR_TXE | UART011_CR_LBE;
346 writew(cr, uap->port.membase + UART011_CR);
347 writew(0, uap->port.membase + UART011_FBRD);
348 writew(1, uap->port.membase + UART011_IBRD);
349 writew(0, uap->port.membase + UART011_LCRH);
350 writew(0, uap->port.membase + UART01x_DR);
351 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_BUSY)
354 cr = UART01x_CR_UARTEN | UART011_CR_RXE | UART011_CR_TXE;
355 writew(cr, uap->port.membase + UART011_CR);
358 * initialise the old status of the modem signals
360 uap->old_status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
363 * Finally, enable interrupts
365 spin_lock_irq(&uap->port.lock);
366 uap->im = UART011_RXIM | UART011_RTIM;
367 writew(uap->im, uap->port.membase + UART011_IMSC);
368 spin_unlock_irq(&uap->port.lock);
373 clk_disable(uap->clk);
378 static void pl011_shutdown(struct uart_port *port)
380 struct uart_amba_port *uap = (struct uart_amba_port *)port;
384 * disable all interrupts
386 spin_lock_irq(&uap->port.lock);
388 writew(uap->im, uap->port.membase + UART011_IMSC);
389 writew(0xffff, uap->port.membase + UART011_ICR);
390 spin_unlock_irq(&uap->port.lock);
395 free_irq(uap->port.irq, uap);
400 writew(UART01x_CR_UARTEN | UART011_CR_TXE, uap->port.membase + UART011_CR);
403 * disable break condition and fifos
405 val = readw(uap->port.membase + UART011_LCRH);
406 val &= ~(UART01x_LCRH_BRK | UART01x_LCRH_FEN);
407 writew(val, uap->port.membase + UART011_LCRH);
410 * Shut down the clock producer
412 clk_disable(uap->clk);
416 pl011_set_termios(struct uart_port *port, struct ktermios *termios,
417 struct ktermios *old)
419 unsigned int lcr_h, old_cr;
421 unsigned int baud, quot;
424 * Ask the core to calculate the divisor for us.
426 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
427 quot = port->uartclk * 4 / baud;
429 switch (termios->c_cflag & CSIZE) {
431 lcr_h = UART01x_LCRH_WLEN_5;
434 lcr_h = UART01x_LCRH_WLEN_6;
437 lcr_h = UART01x_LCRH_WLEN_7;
440 lcr_h = UART01x_LCRH_WLEN_8;
443 if (termios->c_cflag & CSTOPB)
444 lcr_h |= UART01x_LCRH_STP2;
445 if (termios->c_cflag & PARENB) {
446 lcr_h |= UART01x_LCRH_PEN;
447 if (!(termios->c_cflag & PARODD))
448 lcr_h |= UART01x_LCRH_EPS;
450 if (port->fifosize > 1)
451 lcr_h |= UART01x_LCRH_FEN;
453 spin_lock_irqsave(&port->lock, flags);
456 * Update the per-port timeout.
458 uart_update_timeout(port, termios->c_cflag, baud);
460 port->read_status_mask = UART011_DR_OE | 255;
461 if (termios->c_iflag & INPCK)
462 port->read_status_mask |= UART011_DR_FE | UART011_DR_PE;
463 if (termios->c_iflag & (BRKINT | PARMRK))
464 port->read_status_mask |= UART011_DR_BE;
467 * Characters to ignore
469 port->ignore_status_mask = 0;
470 if (termios->c_iflag & IGNPAR)
471 port->ignore_status_mask |= UART011_DR_FE | UART011_DR_PE;
472 if (termios->c_iflag & IGNBRK) {
473 port->ignore_status_mask |= UART011_DR_BE;
475 * If we're ignoring parity and break indicators,
476 * ignore overruns too (for real raw support).
478 if (termios->c_iflag & IGNPAR)
479 port->ignore_status_mask |= UART011_DR_OE;
483 * Ignore all characters if CREAD is not set.
485 if ((termios->c_cflag & CREAD) == 0)
486 port->ignore_status_mask |= UART_DUMMY_DR_RX;
488 if (UART_ENABLE_MS(port, termios->c_cflag))
489 pl011_enable_ms(port);
491 /* first, disable everything */
492 old_cr = readw(port->membase + UART011_CR);
493 writew(0, port->membase + UART011_CR);
496 writew(quot & 0x3f, port->membase + UART011_FBRD);
497 writew(quot >> 6, port->membase + UART011_IBRD);
500 * ----------v----------v----------v----------v-----
501 * NOTE: MUST BE WRITTEN AFTER UARTLCR_M & UARTLCR_L
502 * ----------^----------^----------^----------^-----
504 writew(lcr_h, port->membase + UART011_LCRH);
505 writew(old_cr, port->membase + UART011_CR);
507 spin_unlock_irqrestore(&port->lock, flags);
510 static const char *pl011_type(struct uart_port *port)
512 return port->type == PORT_AMBA ? "AMBA/PL011" : NULL;
516 * Release the memory region(s) being used by 'port'
518 static void pl010_release_port(struct uart_port *port)
520 release_mem_region(port->mapbase, SZ_4K);
524 * Request the memory region(s) being used by 'port'
526 static int pl010_request_port(struct uart_port *port)
528 return request_mem_region(port->mapbase, SZ_4K, "uart-pl011")
529 != NULL ? 0 : -EBUSY;
533 * Configure/autoconfigure the port.
535 static void pl010_config_port(struct uart_port *port, int flags)
537 if (flags & UART_CONFIG_TYPE) {
538 port->type = PORT_AMBA;
539 pl010_request_port(port);
544 * verify the new serial_struct (for TIOCSSERIAL).
546 static int pl010_verify_port(struct uart_port *port, struct serial_struct *ser)
549 if (ser->type != PORT_UNKNOWN && ser->type != PORT_AMBA)
551 if (ser->irq < 0 || ser->irq >= NR_IRQS)
553 if (ser->baud_base < 9600)
558 static struct uart_ops amba_pl011_pops = {
559 .tx_empty = pl01x_tx_empty,
560 .set_mctrl = pl011_set_mctrl,
561 .get_mctrl = pl01x_get_mctrl,
562 .stop_tx = pl011_stop_tx,
563 .start_tx = pl011_start_tx,
564 .stop_rx = pl011_stop_rx,
565 .enable_ms = pl011_enable_ms,
566 .break_ctl = pl011_break_ctl,
567 .startup = pl011_startup,
568 .shutdown = pl011_shutdown,
569 .set_termios = pl011_set_termios,
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_PL011_CONSOLE
581 static void pl011_console_putchar(struct uart_port *port, int ch)
583 struct uart_amba_port *uap = (struct uart_amba_port *)port;
585 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_TXFF)
587 writew(ch, uap->port.membase + UART01x_DR);
591 pl011_console_write(struct console *co, const char *s, unsigned int count)
593 struct uart_amba_port *uap = amba_ports[co->index];
594 unsigned int status, old_cr, new_cr;
596 clk_enable(uap->clk);
599 * First save the CR then disable the interrupts
601 old_cr = readw(uap->port.membase + UART011_CR);
602 new_cr = old_cr & ~UART011_CR_CTSEN;
603 new_cr |= UART01x_CR_UARTEN | UART011_CR_TXE;
604 writew(new_cr, uap->port.membase + UART011_CR);
606 uart_console_write(&uap->port, s, count, pl011_console_putchar);
609 * Finally, wait for transmitter to become empty
610 * and restore the TCR
613 status = readw(uap->port.membase + UART01x_FR);
614 } while (status & UART01x_FR_BUSY);
615 writew(old_cr, uap->port.membase + UART011_CR);
617 clk_disable(uap->clk);
621 pl011_console_get_options(struct uart_amba_port *uap, int *baud,
622 int *parity, int *bits)
624 if (readw(uap->port.membase + UART011_CR) & UART01x_CR_UARTEN) {
625 unsigned int lcr_h, ibrd, fbrd;
627 lcr_h = readw(uap->port.membase + UART011_LCRH);
630 if (lcr_h & UART01x_LCRH_PEN) {
631 if (lcr_h & UART01x_LCRH_EPS)
637 if ((lcr_h & 0x60) == UART01x_LCRH_WLEN_7)
642 ibrd = readw(uap->port.membase + UART011_IBRD);
643 fbrd = readw(uap->port.membase + UART011_FBRD);
645 *baud = uap->port.uartclk * 4 / (64 * ibrd + fbrd);
649 static int __init pl011_console_setup(struct console *co, char *options)
651 struct uart_amba_port *uap;
658 * Check whether an invalid uart number has been specified, and
659 * if so, search for the first available port that does have
662 if (co->index >= UART_NR)
664 uap = amba_ports[co->index];
668 uap->port.uartclk = clk_get_rate(uap->clk);
671 uart_parse_options(options, &baud, &parity, &bits, &flow);
673 pl011_console_get_options(uap, &baud, &parity, &bits);
675 return uart_set_options(&uap->port, co, baud, parity, bits, flow);
678 static struct uart_driver amba_reg;
679 static struct console amba_console = {
681 .write = pl011_console_write,
682 .device = uart_console_device,
683 .setup = pl011_console_setup,
684 .flags = CON_PRINTBUFFER,
689 #define AMBA_CONSOLE (&amba_console)
691 #define AMBA_CONSOLE NULL
694 static struct uart_driver amba_reg = {
695 .owner = THIS_MODULE,
696 .driver_name = "ttyAMA",
697 .dev_name = "ttyAMA",
698 .major = SERIAL_AMBA_MAJOR,
699 .minor = SERIAL_AMBA_MINOR,
701 .cons = AMBA_CONSOLE,
704 static int pl011_probe(struct amba_device *dev, void *id)
706 struct uart_amba_port *uap;
710 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
711 if (amba_ports[i] == NULL)
714 if (i == ARRAY_SIZE(amba_ports)) {
719 uap = kzalloc(sizeof(struct uart_amba_port), GFP_KERNEL);
725 base = ioremap(dev->res.start, PAGE_SIZE);
731 uap->clk = clk_get(&dev->dev, "UARTCLK");
732 if (IS_ERR(uap->clk)) {
733 ret = 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_pl011_pops;
744 uap->port.flags = UPF_BOOT_AUTOCONF;
749 amba_set_drvdata(dev, uap);
750 ret = uart_add_one_port(&amba_reg, &uap->port);
752 amba_set_drvdata(dev, NULL);
753 amba_ports[i] = NULL;
764 static int pl011_remove(struct amba_device *dev)
766 struct uart_amba_port *uap = amba_get_drvdata(dev);
769 amba_set_drvdata(dev, NULL);
771 uart_remove_one_port(&amba_reg, &uap->port);
773 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
774 if (amba_ports[i] == uap)
775 amba_ports[i] = NULL;
777 iounmap(uap->port.membase);
783 static struct amba_id pl011_ids[] __initdata = {
791 static struct amba_driver pl011_driver = {
793 .name = "uart-pl011",
795 .id_table = pl011_ids,
796 .probe = pl011_probe,
797 .remove = pl011_remove,
800 static int __init pl011_init(void)
803 printk(KERN_INFO "Serial: AMBA PL011 UART driver\n");
805 ret = uart_register_driver(&amba_reg);
807 ret = amba_driver_register(&pl011_driver);
809 uart_unregister_driver(&amba_reg);
814 static void __exit pl011_exit(void)
816 amba_driver_unregister(&pl011_driver);
817 uart_unregister_driver(&amba_reg);
820 module_init(pl011_init);
821 module_exit(pl011_exit);
823 MODULE_AUTHOR("ARM Ltd/Deep Blue Solutions Ltd");
824 MODULE_DESCRIPTION("ARM AMBA serial port driver");
825 MODULE_LICENSE("GPL");