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 * This is a generic driver for ARM AMBA-type serial ports. They
26 * have a lot of 16550-like features, but are not register compatible.
27 * Note that although they do have CTS, DCD and DSR inputs, they do
28 * not have an RI input, nor do they have DTR or RTS outputs. If
29 * required, these have to be supplied via some other means (eg, GPIO)
30 * and hooked into this driver.
33 #if defined(CONFIG_SERIAL_AMBA_PL011_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
37 #include <linux/module.h>
38 #include <linux/ioport.h>
39 #include <linux/init.h>
40 #include <linux/console.h>
41 #include <linux/sysrq.h>
42 #include <linux/device.h>
43 #include <linux/tty.h>
44 #include <linux/tty_flip.h>
45 #include <linux/serial_core.h>
46 #include <linux/serial.h>
47 #include <linux/amba/bus.h>
48 #include <linux/amba/serial.h>
49 #include <linux/clk.h>
52 #include <asm/sizes.h>
56 #define SERIAL_AMBA_MAJOR 204
57 #define SERIAL_AMBA_MINOR 64
58 #define SERIAL_AMBA_NR UART_NR
60 #define AMBA_ISR_PASS_LIMIT 256
62 #define UART_DR_ERROR (UART011_DR_OE|UART011_DR_BE|UART011_DR_PE|UART011_DR_FE)
63 #define UART_DUMMY_DR_RX (1 << 16)
66 * We wrap our port structure around the generic uart_port.
68 struct uart_amba_port {
69 struct uart_port port;
71 unsigned int im; /* interrupt mask */
72 unsigned int old_status;
75 static void pl011_stop_tx(struct uart_port *port)
77 struct uart_amba_port *uap = (struct uart_amba_port *)port;
79 uap->im &= ~UART011_TXIM;
80 writew(uap->im, uap->port.membase + UART011_IMSC);
83 static void pl011_start_tx(struct uart_port *port)
85 struct uart_amba_port *uap = (struct uart_amba_port *)port;
87 uap->im |= UART011_TXIM;
88 writew(uap->im, uap->port.membase + UART011_IMSC);
91 static void pl011_stop_rx(struct uart_port *port)
93 struct uart_amba_port *uap = (struct uart_amba_port *)port;
95 uap->im &= ~(UART011_RXIM|UART011_RTIM|UART011_FEIM|
96 UART011_PEIM|UART011_BEIM|UART011_OEIM);
97 writew(uap->im, uap->port.membase + UART011_IMSC);
100 static void pl011_enable_ms(struct uart_port *port)
102 struct uart_amba_port *uap = (struct uart_amba_port *)port;
104 uap->im |= UART011_RIMIM|UART011_CTSMIM|UART011_DCDMIM|UART011_DSRMIM;
105 writew(uap->im, uap->port.membase + UART011_IMSC);
108 static void pl011_rx_chars(struct uart_amba_port *uap)
110 struct tty_struct *tty = uap->port.info->port.tty;
111 unsigned int status, ch, flag, max_count = 256;
113 status = readw(uap->port.membase + UART01x_FR);
114 while ((status & UART01x_FR_RXFE) == 0 && max_count--) {
115 ch = readw(uap->port.membase + UART01x_DR) | UART_DUMMY_DR_RX;
117 uap->port.icount.rx++;
120 * Note that the error handling code is
121 * out of the main execution path
123 if (unlikely(ch & UART_DR_ERROR)) {
124 if (ch & UART011_DR_BE) {
125 ch &= ~(UART011_DR_FE | UART011_DR_PE);
126 uap->port.icount.brk++;
127 if (uart_handle_break(&uap->port))
129 } else if (ch & UART011_DR_PE)
130 uap->port.icount.parity++;
131 else if (ch & UART011_DR_FE)
132 uap->port.icount.frame++;
133 if (ch & UART011_DR_OE)
134 uap->port.icount.overrun++;
136 ch &= uap->port.read_status_mask;
138 if (ch & UART011_DR_BE)
140 else if (ch & UART011_DR_PE)
142 else if (ch & UART011_DR_FE)
146 if (uart_handle_sysrq_char(&uap->port, ch & 255))
149 uart_insert_char(&uap->port, ch, UART011_DR_OE, ch, flag);
152 status = readw(uap->port.membase + UART01x_FR);
154 spin_unlock(&uap->port.lock);
155 tty_flip_buffer_push(tty);
156 spin_lock(&uap->port.lock);
159 static void pl011_tx_chars(struct uart_amba_port *uap)
161 struct circ_buf *xmit = &uap->port.info->xmit;
164 if (uap->port.x_char) {
165 writew(uap->port.x_char, uap->port.membase + UART01x_DR);
166 uap->port.icount.tx++;
167 uap->port.x_char = 0;
170 if (uart_circ_empty(xmit) || uart_tx_stopped(&uap->port)) {
171 pl011_stop_tx(&uap->port);
175 count = uap->port.fifosize >> 1;
177 writew(xmit->buf[xmit->tail], uap->port.membase + UART01x_DR);
178 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
179 uap->port.icount.tx++;
180 if (uart_circ_empty(xmit))
182 } while (--count > 0);
184 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
185 uart_write_wakeup(&uap->port);
187 if (uart_circ_empty(xmit))
188 pl011_stop_tx(&uap->port);
191 static void pl011_modem_status(struct uart_amba_port *uap)
193 unsigned int status, delta;
195 status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
197 delta = status ^ uap->old_status;
198 uap->old_status = status;
203 if (delta & UART01x_FR_DCD)
204 uart_handle_dcd_change(&uap->port, status & UART01x_FR_DCD);
206 if (delta & UART01x_FR_DSR)
207 uap->port.icount.dsr++;
209 if (delta & UART01x_FR_CTS)
210 uart_handle_cts_change(&uap->port, status & UART01x_FR_CTS);
212 wake_up_interruptible(&uap->port.info->delta_msr_wait);
215 static irqreturn_t pl011_int(int irq, void *dev_id)
217 struct uart_amba_port *uap = dev_id;
218 unsigned int status, pass_counter = AMBA_ISR_PASS_LIMIT;
221 spin_lock(&uap->port.lock);
223 status = readw(uap->port.membase + UART011_MIS);
226 writew(status & ~(UART011_TXIS|UART011_RTIS|
228 uap->port.membase + UART011_ICR);
230 if (status & (UART011_RTIS|UART011_RXIS))
232 if (status & (UART011_DSRMIS|UART011_DCDMIS|
233 UART011_CTSMIS|UART011_RIMIS))
234 pl011_modem_status(uap);
235 if (status & UART011_TXIS)
238 if (pass_counter-- == 0)
241 status = readw(uap->port.membase + UART011_MIS);
242 } while (status != 0);
246 spin_unlock(&uap->port.lock);
248 return IRQ_RETVAL(handled);
251 static unsigned int pl01x_tx_empty(struct uart_port *port)
253 struct uart_amba_port *uap = (struct uart_amba_port *)port;
254 unsigned int status = readw(uap->port.membase + UART01x_FR);
255 return status & (UART01x_FR_BUSY|UART01x_FR_TXFF) ? 0 : TIOCSER_TEMT;
258 static unsigned int pl01x_get_mctrl(struct uart_port *port)
260 struct uart_amba_port *uap = (struct uart_amba_port *)port;
261 unsigned int result = 0;
262 unsigned int status = readw(uap->port.membase + UART01x_FR);
264 #define TIOCMBIT(uartbit, tiocmbit) \
265 if (status & uartbit) \
268 TIOCMBIT(UART01x_FR_DCD, TIOCM_CAR);
269 TIOCMBIT(UART01x_FR_DSR, TIOCM_DSR);
270 TIOCMBIT(UART01x_FR_CTS, TIOCM_CTS);
271 TIOCMBIT(UART011_FR_RI, TIOCM_RNG);
276 static void pl011_set_mctrl(struct uart_port *port, unsigned int mctrl)
278 struct uart_amba_port *uap = (struct uart_amba_port *)port;
281 cr = readw(uap->port.membase + UART011_CR);
283 #define TIOCMBIT(tiocmbit, uartbit) \
284 if (mctrl & tiocmbit) \
289 TIOCMBIT(TIOCM_RTS, UART011_CR_RTS);
290 TIOCMBIT(TIOCM_DTR, UART011_CR_DTR);
291 TIOCMBIT(TIOCM_OUT1, UART011_CR_OUT1);
292 TIOCMBIT(TIOCM_OUT2, UART011_CR_OUT2);
293 TIOCMBIT(TIOCM_LOOP, UART011_CR_LBE);
296 writew(cr, uap->port.membase + UART011_CR);
299 static void pl011_break_ctl(struct uart_port *port, int break_state)
301 struct uart_amba_port *uap = (struct uart_amba_port *)port;
305 spin_lock_irqsave(&uap->port.lock, flags);
306 lcr_h = readw(uap->port.membase + UART011_LCRH);
307 if (break_state == -1)
308 lcr_h |= UART01x_LCRH_BRK;
310 lcr_h &= ~UART01x_LCRH_BRK;
311 writew(lcr_h, uap->port.membase + UART011_LCRH);
312 spin_unlock_irqrestore(&uap->port.lock, flags);
315 #ifdef CONFIG_CONSOLE_POLL
316 static int pl010_get_poll_char(struct uart_port *port)
318 struct uart_amba_port *uap = (struct uart_amba_port *)port;
322 status = readw(uap->port.membase + UART01x_FR);
323 } while (status & UART01x_FR_RXFE);
325 return readw(uap->port.membase + UART01x_DR);
328 static void pl010_put_poll_char(struct uart_port *port,
331 struct uart_amba_port *uap = (struct uart_amba_port *)port;
333 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_TXFF)
336 writew(ch, uap->port.membase + UART01x_DR);
339 #endif /* CONFIG_CONSOLE_POLL */
341 static int pl011_startup(struct uart_port *port)
343 struct uart_amba_port *uap = (struct uart_amba_port *)port;
348 * Try to enable the clock producer.
350 retval = clk_enable(uap->clk);
354 uap->port.uartclk = clk_get_rate(uap->clk);
359 retval = request_irq(uap->port.irq, pl011_int, 0, "uart-pl011", uap);
363 writew(UART011_IFLS_RX4_8|UART011_IFLS_TX4_8,
364 uap->port.membase + UART011_IFLS);
367 * Provoke TX FIFO interrupt into asserting.
369 cr = UART01x_CR_UARTEN | UART011_CR_TXE | UART011_CR_LBE;
370 writew(cr, uap->port.membase + UART011_CR);
371 writew(0, uap->port.membase + UART011_FBRD);
372 writew(1, uap->port.membase + UART011_IBRD);
373 writew(0, uap->port.membase + UART011_LCRH);
374 writew(0, uap->port.membase + UART01x_DR);
375 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_BUSY)
378 cr = UART01x_CR_UARTEN | UART011_CR_RXE | UART011_CR_TXE;
379 writew(cr, uap->port.membase + UART011_CR);
382 * initialise the old status of the modem signals
384 uap->old_status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
387 * Finally, enable interrupts
389 spin_lock_irq(&uap->port.lock);
390 uap->im = UART011_RXIM | UART011_RTIM;
391 writew(uap->im, uap->port.membase + UART011_IMSC);
392 spin_unlock_irq(&uap->port.lock);
397 clk_disable(uap->clk);
402 static void pl011_shutdown(struct uart_port *port)
404 struct uart_amba_port *uap = (struct uart_amba_port *)port;
408 * disable all interrupts
410 spin_lock_irq(&uap->port.lock);
412 writew(uap->im, uap->port.membase + UART011_IMSC);
413 writew(0xffff, uap->port.membase + UART011_ICR);
414 spin_unlock_irq(&uap->port.lock);
419 free_irq(uap->port.irq, uap);
424 writew(UART01x_CR_UARTEN | UART011_CR_TXE, uap->port.membase + UART011_CR);
427 * disable break condition and fifos
429 val = readw(uap->port.membase + UART011_LCRH);
430 val &= ~(UART01x_LCRH_BRK | UART01x_LCRH_FEN);
431 writew(val, uap->port.membase + UART011_LCRH);
434 * Shut down the clock producer
436 clk_disable(uap->clk);
440 pl011_set_termios(struct uart_port *port, struct ktermios *termios,
441 struct ktermios *old)
443 unsigned int lcr_h, old_cr;
445 unsigned int baud, quot;
448 * Ask the core to calculate the divisor for us.
450 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
451 quot = port->uartclk * 4 / baud;
453 switch (termios->c_cflag & CSIZE) {
455 lcr_h = UART01x_LCRH_WLEN_5;
458 lcr_h = UART01x_LCRH_WLEN_6;
461 lcr_h = UART01x_LCRH_WLEN_7;
464 lcr_h = UART01x_LCRH_WLEN_8;
467 if (termios->c_cflag & CSTOPB)
468 lcr_h |= UART01x_LCRH_STP2;
469 if (termios->c_cflag & PARENB) {
470 lcr_h |= UART01x_LCRH_PEN;
471 if (!(termios->c_cflag & PARODD))
472 lcr_h |= UART01x_LCRH_EPS;
474 if (port->fifosize > 1)
475 lcr_h |= UART01x_LCRH_FEN;
477 spin_lock_irqsave(&port->lock, flags);
480 * Update the per-port timeout.
482 uart_update_timeout(port, termios->c_cflag, baud);
484 port->read_status_mask = UART011_DR_OE | 255;
485 if (termios->c_iflag & INPCK)
486 port->read_status_mask |= UART011_DR_FE | UART011_DR_PE;
487 if (termios->c_iflag & (BRKINT | PARMRK))
488 port->read_status_mask |= UART011_DR_BE;
491 * Characters to ignore
493 port->ignore_status_mask = 0;
494 if (termios->c_iflag & IGNPAR)
495 port->ignore_status_mask |= UART011_DR_FE | UART011_DR_PE;
496 if (termios->c_iflag & IGNBRK) {
497 port->ignore_status_mask |= UART011_DR_BE;
499 * If we're ignoring parity and break indicators,
500 * ignore overruns too (for real raw support).
502 if (termios->c_iflag & IGNPAR)
503 port->ignore_status_mask |= UART011_DR_OE;
507 * Ignore all characters if CREAD is not set.
509 if ((termios->c_cflag & CREAD) == 0)
510 port->ignore_status_mask |= UART_DUMMY_DR_RX;
512 if (UART_ENABLE_MS(port, termios->c_cflag))
513 pl011_enable_ms(port);
515 /* first, disable everything */
516 old_cr = readw(port->membase + UART011_CR);
517 writew(0, port->membase + UART011_CR);
520 writew(quot & 0x3f, port->membase + UART011_FBRD);
521 writew(quot >> 6, port->membase + UART011_IBRD);
524 * ----------v----------v----------v----------v-----
525 * NOTE: MUST BE WRITTEN AFTER UARTLCR_M & UARTLCR_L
526 * ----------^----------^----------^----------^-----
528 writew(lcr_h, port->membase + UART011_LCRH);
529 writew(old_cr, port->membase + UART011_CR);
531 spin_unlock_irqrestore(&port->lock, flags);
534 static const char *pl011_type(struct uart_port *port)
536 return port->type == PORT_AMBA ? "AMBA/PL011" : NULL;
540 * Release the memory region(s) being used by 'port'
542 static void pl010_release_port(struct uart_port *port)
544 release_mem_region(port->mapbase, SZ_4K);
548 * Request the memory region(s) being used by 'port'
550 static int pl010_request_port(struct uart_port *port)
552 return request_mem_region(port->mapbase, SZ_4K, "uart-pl011")
553 != NULL ? 0 : -EBUSY;
557 * Configure/autoconfigure the port.
559 static void pl010_config_port(struct uart_port *port, int flags)
561 if (flags & UART_CONFIG_TYPE) {
562 port->type = PORT_AMBA;
563 pl010_request_port(port);
568 * verify the new serial_struct (for TIOCSSERIAL).
570 static int pl010_verify_port(struct uart_port *port, struct serial_struct *ser)
573 if (ser->type != PORT_UNKNOWN && ser->type != PORT_AMBA)
575 if (ser->irq < 0 || ser->irq >= nr_irqs)
577 if (ser->baud_base < 9600)
582 static struct uart_ops amba_pl011_pops = {
583 .tx_empty = pl01x_tx_empty,
584 .set_mctrl = pl011_set_mctrl,
585 .get_mctrl = pl01x_get_mctrl,
586 .stop_tx = pl011_stop_tx,
587 .start_tx = pl011_start_tx,
588 .stop_rx = pl011_stop_rx,
589 .enable_ms = pl011_enable_ms,
590 .break_ctl = pl011_break_ctl,
591 .startup = pl011_startup,
592 .shutdown = pl011_shutdown,
593 .set_termios = pl011_set_termios,
595 .release_port = pl010_release_port,
596 .request_port = pl010_request_port,
597 .config_port = pl010_config_port,
598 .verify_port = pl010_verify_port,
599 #ifdef CONFIG_CONSOLE_POLL
600 .poll_get_char = pl010_get_poll_char,
601 .poll_put_char = pl010_put_poll_char,
605 static struct uart_amba_port *amba_ports[UART_NR];
607 #ifdef CONFIG_SERIAL_AMBA_PL011_CONSOLE
609 static void pl011_console_putchar(struct uart_port *port, int ch)
611 struct uart_amba_port *uap = (struct uart_amba_port *)port;
613 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_TXFF)
615 writew(ch, uap->port.membase + UART01x_DR);
619 pl011_console_write(struct console *co, const char *s, unsigned int count)
621 struct uart_amba_port *uap = amba_ports[co->index];
622 unsigned int status, old_cr, new_cr;
624 clk_enable(uap->clk);
627 * First save the CR then disable the interrupts
629 old_cr = readw(uap->port.membase + UART011_CR);
630 new_cr = old_cr & ~UART011_CR_CTSEN;
631 new_cr |= UART01x_CR_UARTEN | UART011_CR_TXE;
632 writew(new_cr, uap->port.membase + UART011_CR);
634 uart_console_write(&uap->port, s, count, pl011_console_putchar);
637 * Finally, wait for transmitter to become empty
638 * and restore the TCR
641 status = readw(uap->port.membase + UART01x_FR);
642 } while (status & UART01x_FR_BUSY);
643 writew(old_cr, uap->port.membase + UART011_CR);
645 clk_disable(uap->clk);
649 pl011_console_get_options(struct uart_amba_port *uap, int *baud,
650 int *parity, int *bits)
652 if (readw(uap->port.membase + UART011_CR) & UART01x_CR_UARTEN) {
653 unsigned int lcr_h, ibrd, fbrd;
655 lcr_h = readw(uap->port.membase + UART011_LCRH);
658 if (lcr_h & UART01x_LCRH_PEN) {
659 if (lcr_h & UART01x_LCRH_EPS)
665 if ((lcr_h & 0x60) == UART01x_LCRH_WLEN_7)
670 ibrd = readw(uap->port.membase + UART011_IBRD);
671 fbrd = readw(uap->port.membase + UART011_FBRD);
673 *baud = uap->port.uartclk * 4 / (64 * ibrd + fbrd);
677 static int __init pl011_console_setup(struct console *co, char *options)
679 struct uart_amba_port *uap;
686 * Check whether an invalid uart number has been specified, and
687 * if so, search for the first available port that does have
690 if (co->index >= UART_NR)
692 uap = amba_ports[co->index];
696 uap->port.uartclk = clk_get_rate(uap->clk);
699 uart_parse_options(options, &baud, &parity, &bits, &flow);
701 pl011_console_get_options(uap, &baud, &parity, &bits);
703 return uart_set_options(&uap->port, co, baud, parity, bits, flow);
706 static struct uart_driver amba_reg;
707 static struct console amba_console = {
709 .write = pl011_console_write,
710 .device = uart_console_device,
711 .setup = pl011_console_setup,
712 .flags = CON_PRINTBUFFER,
717 #define AMBA_CONSOLE (&amba_console)
719 #define AMBA_CONSOLE NULL
722 static struct uart_driver amba_reg = {
723 .owner = THIS_MODULE,
724 .driver_name = "ttyAMA",
725 .dev_name = "ttyAMA",
726 .major = SERIAL_AMBA_MAJOR,
727 .minor = SERIAL_AMBA_MINOR,
729 .cons = AMBA_CONSOLE,
732 static int pl011_probe(struct amba_device *dev, void *id)
734 struct uart_amba_port *uap;
738 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
739 if (amba_ports[i] == NULL)
742 if (i == ARRAY_SIZE(amba_ports)) {
747 uap = kzalloc(sizeof(struct uart_amba_port), GFP_KERNEL);
753 base = ioremap(dev->res.start, PAGE_SIZE);
759 uap->clk = clk_get(&dev->dev, NULL);
760 if (IS_ERR(uap->clk)) {
761 ret = PTR_ERR(uap->clk);
765 uap->port.dev = &dev->dev;
766 uap->port.mapbase = dev->res.start;
767 uap->port.membase = base;
768 uap->port.iotype = UPIO_MEM;
769 uap->port.irq = dev->irq[0];
770 uap->port.fifosize = 16;
771 uap->port.ops = &amba_pl011_pops;
772 uap->port.flags = UPF_BOOT_AUTOCONF;
777 amba_set_drvdata(dev, uap);
778 ret = uart_add_one_port(&amba_reg, &uap->port);
780 amba_set_drvdata(dev, NULL);
781 amba_ports[i] = NULL;
792 static int pl011_remove(struct amba_device *dev)
794 struct uart_amba_port *uap = amba_get_drvdata(dev);
797 amba_set_drvdata(dev, NULL);
799 uart_remove_one_port(&amba_reg, &uap->port);
801 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
802 if (amba_ports[i] == uap)
803 amba_ports[i] = NULL;
805 iounmap(uap->port.membase);
811 static struct amba_id pl011_ids[] __initdata = {
819 static struct amba_driver pl011_driver = {
821 .name = "uart-pl011",
823 .id_table = pl011_ids,
824 .probe = pl011_probe,
825 .remove = pl011_remove,
828 static int __init pl011_init(void)
831 printk(KERN_INFO "Serial: AMBA PL011 UART driver\n");
833 ret = uart_register_driver(&amba_reg);
835 ret = amba_driver_register(&pl011_driver);
837 uart_unregister_driver(&amba_reg);
842 static void __exit pl011_exit(void)
844 amba_driver_unregister(&pl011_driver);
845 uart_unregister_driver(&amba_reg);
848 module_init(pl011_init);
849 module_exit(pl011_exit);
851 MODULE_AUTHOR("ARM Ltd/Deep Blue Solutions Ltd");
852 MODULE_DESCRIPTION("ARM AMBA serial port driver");
853 MODULE_LICENSE("GPL");