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/hardware/amba.h>
54 #include <asm/hardware/clock.h>
55 #include <asm/hardware/amba_serial.h>
59 #define SERIAL_AMBA_MAJOR 204
60 #define SERIAL_AMBA_MINOR 64
61 #define SERIAL_AMBA_NR UART_NR
63 #define AMBA_ISR_PASS_LIMIT 256
65 #define UART_DUMMY_RSR_RX 256
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, unsigned int tty_stop)
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, unsigned int tty_start)
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);
112 pl011_rx_chars(struct uart_amba_port *uap, struct pt_regs *regs)
114 pl011_rx_chars(struct uart_amba_port *uap)
117 struct tty_struct *tty = uap->port.info->tty;
118 unsigned int status, ch, flag, rsr, max_count = 256;
120 status = readw(uap->port.membase + UART01x_FR);
121 while ((status & UART01x_FR_RXFE) == 0 && max_count--) {
122 if (tty->flip.count >= TTY_FLIPBUF_SIZE) {
123 if (tty->low_latency)
124 tty_flip_buffer_push(tty);
126 * If this failed then we will throw away the
127 * bytes but must do so to clear interrupts
131 ch = readw(uap->port.membase + UART01x_DR);
133 uap->port.icount.rx++;
136 * Note that the error handling code is
137 * out of the main execution path
139 rsr = readw(uap->port.membase + UART01x_RSR) | UART_DUMMY_RSR_RX;
140 if (rsr & UART01x_RSR_ANY) {
141 if (rsr & UART01x_RSR_BE) {
142 rsr &= ~(UART01x_RSR_FE | UART01x_RSR_PE);
143 uap->port.icount.brk++;
144 if (uart_handle_break(&uap->port))
146 } else if (rsr & UART01x_RSR_PE)
147 uap->port.icount.parity++;
148 else if (rsr & UART01x_RSR_FE)
149 uap->port.icount.frame++;
150 if (rsr & UART01x_RSR_OE)
151 uap->port.icount.overrun++;
153 rsr &= uap->port.read_status_mask;
155 if (rsr & UART01x_RSR_BE)
157 else if (rsr & UART01x_RSR_PE)
159 else if (rsr & UART01x_RSR_FE)
163 if (uart_handle_sysrq_char(&uap->port, ch, regs))
166 if ((rsr & uap->port.ignore_status_mask) == 0) {
167 tty_insert_flip_char(tty, ch, flag);
169 if ((rsr & UART01x_RSR_OE) &&
170 tty->flip.count < TTY_FLIPBUF_SIZE) {
172 * Overrun is special, since it's reported
173 * immediately, and doesn't affect the current
176 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
179 status = readw(uap->port.membase + UART01x_FR);
181 tty_flip_buffer_push(tty);
185 static void pl011_tx_chars(struct uart_amba_port *uap)
187 struct circ_buf *xmit = &uap->port.info->xmit;
190 if (uap->port.x_char) {
191 writew(uap->port.x_char, uap->port.membase + UART01x_DR);
192 uap->port.icount.tx++;
193 uap->port.x_char = 0;
196 if (uart_circ_empty(xmit) || uart_tx_stopped(&uap->port)) {
197 pl011_stop_tx(&uap->port, 0);
201 count = uap->port.fifosize >> 1;
203 writew(xmit->buf[xmit->tail], uap->port.membase + UART01x_DR);
204 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
205 uap->port.icount.tx++;
206 if (uart_circ_empty(xmit))
208 } while (--count > 0);
210 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
211 uart_write_wakeup(&uap->port);
213 if (uart_circ_empty(xmit))
214 pl011_stop_tx(&uap->port, 0);
217 static void pl011_modem_status(struct uart_amba_port *uap)
219 unsigned int status, delta;
221 status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
223 delta = status ^ uap->old_status;
224 uap->old_status = status;
229 if (delta & UART01x_FR_DCD)
230 uart_handle_dcd_change(&uap->port, status & UART01x_FR_DCD);
232 if (delta & UART01x_FR_DSR)
233 uap->port.icount.dsr++;
235 if (delta & UART01x_FR_CTS)
236 uart_handle_cts_change(&uap->port, status & UART01x_FR_CTS);
238 wake_up_interruptible(&uap->port.info->delta_msr_wait);
241 static irqreturn_t pl011_int(int irq, void *dev_id, struct pt_regs *regs)
243 struct uart_amba_port *uap = dev_id;
244 unsigned int status, pass_counter = AMBA_ISR_PASS_LIMIT;
247 spin_lock(&uap->port.lock);
249 status = readw(uap->port.membase + UART011_MIS);
252 writew(status & ~(UART011_TXIS|UART011_RTIS|
254 uap->port.membase + UART011_ICR);
256 if (status & (UART011_RTIS|UART011_RXIS))
258 pl011_rx_chars(uap, regs);
262 if (status & (UART011_DSRMIS|UART011_DCDMIS|
263 UART011_CTSMIS|UART011_RIMIS))
264 pl011_modem_status(uap);
265 if (status & UART011_TXIS)
268 if (pass_counter-- == 0)
271 status = readw(uap->port.membase + UART011_MIS);
272 } while (status != 0);
276 spin_unlock(&uap->port.lock);
278 return IRQ_RETVAL(handled);
281 static unsigned int pl01x_tx_empty(struct uart_port *port)
283 struct uart_amba_port *uap = (struct uart_amba_port *)port;
284 unsigned int status = readw(uap->port.membase + UART01x_FR);
285 return status & (UART01x_FR_BUSY|UART01x_FR_TXFF) ? 0 : TIOCSER_TEMT;
288 static unsigned int pl01x_get_mctrl(struct uart_port *port)
290 struct uart_amba_port *uap = (struct uart_amba_port *)port;
291 unsigned int result = 0;
292 unsigned int status = readw(uap->port.membase + UART01x_FR);
294 #define BIT(uartbit, tiocmbit) \
295 if (status & uartbit) \
298 BIT(UART01x_FR_DCD, TIOCM_CAR);
299 BIT(UART01x_FR_DSR, TIOCM_DSR);
300 BIT(UART01x_FR_CTS, TIOCM_CTS);
301 BIT(UART011_FR_RI, TIOCM_RNG);
306 static void pl011_set_mctrl(struct uart_port *port, unsigned int mctrl)
308 struct uart_amba_port *uap = (struct uart_amba_port *)port;
311 cr = readw(uap->port.membase + UART011_CR);
313 #define BIT(tiocmbit, uartbit) \
314 if (mctrl & tiocmbit) \
319 BIT(TIOCM_RTS, UART011_CR_RTS);
320 BIT(TIOCM_DTR, UART011_CR_DTR);
321 BIT(TIOCM_OUT1, UART011_CR_OUT1);
322 BIT(TIOCM_OUT2, UART011_CR_OUT2);
323 BIT(TIOCM_LOOP, UART011_CR_LBE);
326 writew(cr, uap->port.membase + UART011_CR);
329 static void pl011_break_ctl(struct uart_port *port, int break_state)
331 struct uart_amba_port *uap = (struct uart_amba_port *)port;
335 spin_lock_irqsave(&uap->port.lock, flags);
336 lcr_h = readw(uap->port.membase + UART011_LCRH);
337 if (break_state == -1)
338 lcr_h |= UART01x_LCRH_BRK;
340 lcr_h &= ~UART01x_LCRH_BRK;
341 writew(lcr_h, uap->port.membase + UART011_LCRH);
342 spin_unlock_irqrestore(&uap->port.lock, flags);
345 static int pl011_startup(struct uart_port *port)
347 struct uart_amba_port *uap = (struct uart_amba_port *)port;
352 * Try to enable the clock producer.
354 retval = clk_enable(uap->clk);
358 uap->port.uartclk = clk_get_rate(uap->clk);
363 retval = request_irq(uap->port.irq, pl011_int, 0, "uart-pl011", uap);
367 writew(UART011_IFLS_RX4_8|UART011_IFLS_TX4_8,
368 uap->port.membase + UART011_IFLS);
371 * Provoke TX FIFO interrupt into asserting.
373 cr = UART01x_CR_UARTEN | UART011_CR_TXE | UART011_CR_LBE;
374 writew(cr, uap->port.membase + UART011_CR);
375 writew(0, uap->port.membase + UART011_FBRD);
376 writew(1, uap->port.membase + UART011_IBRD);
377 writew(0, uap->port.membase + UART011_LCRH);
378 writew(0, uap->port.membase + UART01x_DR);
379 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_BUSY)
382 cr = UART01x_CR_UARTEN | UART011_CR_RXE | UART011_CR_TXE;
383 writew(cr, uap->port.membase + UART011_CR);
386 * initialise the old status of the modem signals
388 uap->old_status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
391 * Finally, enable interrupts
393 spin_lock_irq(&uap->port.lock);
394 uap->im = UART011_RXIM | UART011_RTIM;
395 writew(uap->im, uap->port.membase + UART011_IMSC);
396 spin_unlock_irq(&uap->port.lock);
401 clk_disable(uap->clk);
406 static void pl011_shutdown(struct uart_port *port)
408 struct uart_amba_port *uap = (struct uart_amba_port *)port;
412 * disable all interrupts
414 spin_lock_irq(&uap->port.lock);
416 writew(uap->im, uap->port.membase + UART011_IMSC);
417 writew(0xffff, uap->port.membase + UART011_ICR);
418 spin_unlock_irq(&uap->port.lock);
423 free_irq(uap->port.irq, uap);
428 writew(UART01x_CR_UARTEN | UART011_CR_TXE, uap->port.membase + UART011_CR);
431 * disable break condition and fifos
433 val = readw(uap->port.membase + UART011_LCRH);
434 val &= ~(UART01x_LCRH_BRK | UART01x_LCRH_FEN);
435 writew(val, uap->port.membase + UART011_LCRH);
438 * Shut down the clock producer
440 clk_disable(uap->clk);
444 pl011_set_termios(struct uart_port *port, struct termios *termios,
447 unsigned int lcr_h, old_cr;
449 unsigned int baud, quot;
452 * Ask the core to calculate the divisor for us.
454 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
455 quot = port->uartclk * 4 / baud;
457 switch (termios->c_cflag & CSIZE) {
459 lcr_h = UART01x_LCRH_WLEN_5;
462 lcr_h = UART01x_LCRH_WLEN_6;
465 lcr_h = UART01x_LCRH_WLEN_7;
468 lcr_h = UART01x_LCRH_WLEN_8;
471 if (termios->c_cflag & CSTOPB)
472 lcr_h |= UART01x_LCRH_STP2;
473 if (termios->c_cflag & PARENB) {
474 lcr_h |= UART01x_LCRH_PEN;
475 if (!(termios->c_cflag & PARODD))
476 lcr_h |= UART01x_LCRH_EPS;
478 if (port->fifosize > 1)
479 lcr_h |= UART01x_LCRH_FEN;
481 spin_lock_irqsave(&port->lock, flags);
484 * Update the per-port timeout.
486 uart_update_timeout(port, termios->c_cflag, baud);
488 port->read_status_mask = UART01x_RSR_OE;
489 if (termios->c_iflag & INPCK)
490 port->read_status_mask |= UART01x_RSR_FE | UART01x_RSR_PE;
491 if (termios->c_iflag & (BRKINT | PARMRK))
492 port->read_status_mask |= UART01x_RSR_BE;
495 * Characters to ignore
497 port->ignore_status_mask = 0;
498 if (termios->c_iflag & IGNPAR)
499 port->ignore_status_mask |= UART01x_RSR_FE | UART01x_RSR_PE;
500 if (termios->c_iflag & IGNBRK) {
501 port->ignore_status_mask |= UART01x_RSR_BE;
503 * If we're ignoring parity and break indicators,
504 * ignore overruns too (for real raw support).
506 if (termios->c_iflag & IGNPAR)
507 port->ignore_status_mask |= UART01x_RSR_OE;
511 * Ignore all characters if CREAD is not set.
513 if ((termios->c_cflag & CREAD) == 0)
514 port->ignore_status_mask |= UART_DUMMY_RSR_RX;
516 if (UART_ENABLE_MS(port, termios->c_cflag))
517 pl011_enable_ms(port);
519 /* first, disable everything */
520 old_cr = readw(port->membase + UART011_CR);
521 writew(0, port->membase + UART011_CR);
524 writew(quot & 0x3f, port->membase + UART011_FBRD);
525 writew(quot >> 6, port->membase + UART011_IBRD);
528 * ----------v----------v----------v----------v-----
529 * NOTE: MUST BE WRITTEN AFTER UARTLCR_M & UARTLCR_L
530 * ----------^----------^----------^----------^-----
532 writew(lcr_h, port->membase + UART011_LCRH);
533 writew(old_cr, port->membase + UART011_CR);
535 spin_unlock_irqrestore(&port->lock, flags);
538 static const char *pl011_type(struct uart_port *port)
540 return port->type == PORT_AMBA ? "AMBA/PL011" : NULL;
544 * Release the memory region(s) being used by 'port'
546 static void pl010_release_port(struct uart_port *port)
548 release_mem_region(port->mapbase, SZ_4K);
552 * Request the memory region(s) being used by 'port'
554 static int pl010_request_port(struct uart_port *port)
556 return request_mem_region(port->mapbase, SZ_4K, "uart-pl011")
557 != NULL ? 0 : -EBUSY;
561 * Configure/autoconfigure the port.
563 static void pl010_config_port(struct uart_port *port, int flags)
565 if (flags & UART_CONFIG_TYPE) {
566 port->type = PORT_AMBA;
567 pl010_request_port(port);
572 * verify the new serial_struct (for TIOCSSERIAL).
574 static int pl010_verify_port(struct uart_port *port, struct serial_struct *ser)
577 if (ser->type != PORT_UNKNOWN && ser->type != PORT_AMBA)
579 if (ser->irq < 0 || ser->irq >= NR_IRQS)
581 if (ser->baud_base < 9600)
586 static struct uart_ops amba_pl011_pops = {
587 .tx_empty = pl01x_tx_empty,
588 .set_mctrl = pl011_set_mctrl,
589 .get_mctrl = pl01x_get_mctrl,
590 .stop_tx = pl011_stop_tx,
591 .start_tx = pl011_start_tx,
592 .stop_rx = pl011_stop_rx,
593 .enable_ms = pl011_enable_ms,
594 .break_ctl = pl011_break_ctl,
595 .startup = pl011_startup,
596 .shutdown = pl011_shutdown,
597 .set_termios = pl011_set_termios,
599 .release_port = pl010_release_port,
600 .request_port = pl010_request_port,
601 .config_port = pl010_config_port,
602 .verify_port = pl010_verify_port,
605 static struct uart_amba_port *amba_ports[UART_NR];
607 #ifdef CONFIG_SERIAL_AMBA_PL011_CONSOLE
610 pl011_console_write_char(struct uart_amba_port *uap, char ch)
615 status = readw(uap->port.membase + UART01x_FR);
616 } while (status & UART01x_FR_TXFF);
617 writew(ch, uap->port.membase + UART01x_DR);
621 pl011_console_write(struct console *co, const char *s, unsigned int count)
623 struct uart_amba_port *uap = amba_ports[co->index];
624 unsigned int status, old_cr, new_cr;
627 clk_enable(uap->clk);
630 * First save the CR then disable the interrupts
632 old_cr = readw(uap->port.membase + UART011_CR);
633 new_cr = old_cr & ~UART011_CR_CTSEN;
634 new_cr |= UART01x_CR_UARTEN | UART011_CR_TXE;
635 writew(new_cr, uap->port.membase + UART011_CR);
638 * Now, do each character
640 for (i = 0; i < count; i++) {
641 pl011_console_write_char(uap, s[i]);
643 pl011_console_write_char(uap, '\r');
647 * Finally, wait for transmitter to become empty
648 * and restore the TCR
651 status = readw(uap->port.membase + UART01x_FR);
652 } while (status & UART01x_FR_BUSY);
653 writew(old_cr, uap->port.membase + UART011_CR);
655 clk_disable(uap->clk);
659 pl011_console_get_options(struct uart_amba_port *uap, int *baud,
660 int *parity, int *bits)
662 if (readw(uap->port.membase + UART011_CR) & UART01x_CR_UARTEN) {
663 unsigned int lcr_h, ibrd, fbrd;
665 lcr_h = readw(uap->port.membase + UART011_LCRH);
668 if (lcr_h & UART01x_LCRH_PEN) {
669 if (lcr_h & UART01x_LCRH_EPS)
675 if ((lcr_h & 0x60) == UART01x_LCRH_WLEN_7)
680 ibrd = readw(uap->port.membase + UART011_IBRD);
681 fbrd = readw(uap->port.membase + UART011_FBRD);
683 *baud = uap->port.uartclk * 4 / (64 * ibrd + fbrd);
687 static int __init pl011_console_setup(struct console *co, char *options)
689 struct uart_amba_port *uap;
696 * Check whether an invalid uart number has been specified, and
697 * if so, search for the first available port that does have
700 if (co->index >= UART_NR)
702 uap = amba_ports[co->index];
704 uap->port.uartclk = clk_get_rate(uap->clk);
707 uart_parse_options(options, &baud, &parity, &bits, &flow);
709 pl011_console_get_options(uap, &baud, &parity, &bits);
711 return uart_set_options(&uap->port, co, baud, parity, bits, flow);
714 extern struct uart_driver amba_reg;
715 static struct console amba_console = {
717 .write = pl011_console_write,
718 .device = uart_console_device,
719 .setup = pl011_console_setup,
720 .flags = CON_PRINTBUFFER,
725 #define AMBA_CONSOLE (&amba_console)
727 #define AMBA_CONSOLE NULL
730 static struct uart_driver amba_reg = {
731 .owner = THIS_MODULE,
732 .driver_name = "ttyAMA",
733 .dev_name = "ttyAMA",
734 .major = SERIAL_AMBA_MAJOR,
735 .minor = SERIAL_AMBA_MINOR,
737 .cons = AMBA_CONSOLE,
740 static int pl011_probe(struct amba_device *dev, void *id)
742 struct uart_amba_port *uap;
746 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
747 if (amba_ports[i] == NULL)
750 if (i == ARRAY_SIZE(amba_ports)) {
755 uap = kmalloc(sizeof(struct uart_amba_port), GFP_KERNEL);
761 base = ioremap(dev->res.start, PAGE_SIZE);
767 memset(uap, 0, sizeof(struct uart_amba_port));
768 uap->clk = clk_get(&dev->dev, "UARTCLK");
769 if (IS_ERR(uap->clk)) {
770 ret = PTR_ERR(uap->clk);
774 ret = clk_use(uap->clk);
778 uap->port.dev = &dev->dev;
779 uap->port.mapbase = dev->res.start;
780 uap->port.membase = base;
781 uap->port.iotype = UPIO_MEM;
782 uap->port.irq = dev->irq[0];
783 uap->port.fifosize = 16;
784 uap->port.ops = &amba_pl011_pops;
785 uap->port.flags = UPF_BOOT_AUTOCONF;
790 amba_set_drvdata(dev, uap);
791 ret = uart_add_one_port(&amba_reg, &uap->port);
793 amba_set_drvdata(dev, NULL);
794 amba_ports[i] = NULL;
807 static int pl011_remove(struct amba_device *dev)
809 struct uart_amba_port *uap = amba_get_drvdata(dev);
812 amba_set_drvdata(dev, NULL);
814 uart_remove_one_port(&amba_reg, &uap->port);
816 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
817 if (amba_ports[i] == uap)
818 amba_ports[i] = NULL;
820 iounmap(uap->port.membase);
827 static struct amba_id pl011_ids[] __initdata = {
835 static struct amba_driver pl011_driver = {
837 .name = "uart-pl011",
839 .id_table = pl011_ids,
840 .probe = pl011_probe,
841 .remove = pl011_remove,
844 static int __init pl011_init(void)
847 printk(KERN_INFO "Serial: AMBA PL011 UART driver\n");
849 ret = uart_register_driver(&amba_reg);
851 ret = amba_driver_register(&pl011_driver);
853 uart_unregister_driver(&amba_reg);
858 static void __exit pl011_exit(void)
860 amba_driver_unregister(&pl011_driver);
861 uart_unregister_driver(&amba_reg);
864 module_init(pl011_init);
865 module_exit(pl011_exit);
867 MODULE_AUTHOR("ARM Ltd/Deep Blue Solutions Ltd");
868 MODULE_DESCRIPTION("ARM AMBA serial port driver");
869 MODULE_LICENSE("GPL");