2 * SC268xx.c: Serial driver for Philiphs SC2681/SC2692 devices.
4 * Copyright (C) 2006,2007 Thomas Bogendörfer (tsbogend@alpha.franken.de)
7 #include <linux/module.h>
8 #include <linux/kernel.h>
9 #include <linux/errno.h>
10 #include <linux/tty.h>
11 #include <linux/tty_flip.h>
12 #include <linux/major.h>
13 #include <linux/circ_buf.h>
14 #include <linux/serial.h>
15 #include <linux/sysrq.h>
16 #include <linux/console.h>
17 #include <linux/spinlock.h>
18 #include <linux/slab.h>
19 #include <linux/delay.h>
20 #include <linux/init.h>
21 #include <linux/platform_device.h>
22 #include <linux/irq.h>
25 #warning "Please try migrate to use new driver SCCNXP and report the status" \
26 "in the linux-serial mailing list."
28 #if defined(CONFIG_MAGIC_SYSRQ)
32 #include <linux/serial_core.h>
34 #define SC26XX_MAJOR 204
35 #define SC26XX_MINOR_START 205
38 struct uart_sc26xx_port {
39 struct uart_port port[2];
49 /* register common to both ports */
56 #define WR_OPR_SET 0x38
57 #define WR_OPR_CLR 0x3C
59 /* access common register */
60 #define READ_SC(p, r) readb((p)->membase + RD_##r)
61 #define WRITE_SC(p, r, v) writeb((v), (p)->membase + WR_##r)
63 /* register per port */
64 #define RD_PORT_MRx 0x00
65 #define RD_PORT_SR 0x04
66 #define RD_PORT_RHR 0x0c
68 #define WR_PORT_MRx 0x00
69 #define WR_PORT_CSR 0x04
70 #define WR_PORT_CR 0x08
71 #define WR_PORT_THR 0x0c
74 #define SR_BREAK (1 << 7)
75 #define SR_FRAME (1 << 6)
76 #define SR_PARITY (1 << 5)
77 #define SR_OVERRUN (1 << 4)
78 #define SR_TXRDY (1 << 2)
79 #define SR_RXRDY (1 << 0)
81 #define CR_RES_MR (1 << 4)
82 #define CR_RES_RX (2 << 4)
83 #define CR_RES_TX (3 << 4)
84 #define CR_STRT_BRK (6 << 4)
85 #define CR_STOP_BRK (7 << 4)
86 #define CR_DIS_TX (1 << 3)
87 #define CR_ENA_TX (1 << 2)
88 #define CR_DIS_RX (1 << 1)
89 #define CR_ENA_RX (1 << 0)
92 #define ISR_RXRDYB (1 << 5)
93 #define ISR_TXRDYB (1 << 4)
94 #define ISR_RXRDYA (1 << 1)
95 #define ISR_TXRDYA (1 << 0)
98 #define IMR_RXRDY (1 << 1)
99 #define IMR_TXRDY (1 << 0)
101 /* access port register */
102 static inline u8 read_sc_port(struct uart_port *p, u8 reg)
104 return readb(p->membase + p->line * 0x20 + reg);
107 static inline void write_sc_port(struct uart_port *p, u8 reg, u8 val)
109 writeb(val, p->membase + p->line * 0x20 + reg);
112 #define READ_SC_PORT(p, r) read_sc_port(p, RD_PORT_##r)
113 #define WRITE_SC_PORT(p, r, v) write_sc_port(p, WR_PORT_##r, v)
115 static void sc26xx_enable_irq(struct uart_port *port, int mask)
117 struct uart_sc26xx_port *up;
118 int line = port->line;
121 up = container_of(port, struct uart_sc26xx_port, port[0]);
123 up->imr |= mask << (line * 4);
124 WRITE_SC(port, IMR, up->imr);
127 static void sc26xx_disable_irq(struct uart_port *port, int mask)
129 struct uart_sc26xx_port *up;
130 int line = port->line;
133 up = container_of(port, struct uart_sc26xx_port, port[0]);
135 up->imr &= ~(mask << (line * 4));
136 WRITE_SC(port, IMR, up->imr);
139 static struct tty_struct *receive_chars(struct uart_port *port)
141 struct tty_port *tport = NULL;
142 struct tty_struct *tty = NULL;
148 /* FIXME what is this trying to achieve? */
149 if (port->state != NULL) { /* Unopened serial console */
150 tport = &port->state->port;
154 while (limit-- > 0) {
155 status = READ_SC_PORT(port, SR);
156 if (!(status & SR_RXRDY))
158 ch = READ_SC_PORT(port, RHR);
163 if (unlikely(status & (SR_BREAK | SR_FRAME |
164 SR_PARITY | SR_OVERRUN))) {
165 if (status & SR_BREAK) {
166 status &= ~(SR_PARITY | SR_FRAME);
168 if (uart_handle_break(port))
170 } else if (status & SR_PARITY)
171 port->icount.parity++;
172 else if (status & SR_FRAME)
173 port->icount.frame++;
174 if (status & SR_OVERRUN)
175 port->icount.overrun++;
177 status &= port->read_status_mask;
178 if (status & SR_BREAK)
180 else if (status & SR_PARITY)
182 else if (status & SR_FRAME)
186 if (uart_handle_sysrq_char(port, ch))
189 if (status & port->ignore_status_mask)
192 tty_insert_flip_char(tport, ch, flag);
197 static void transmit_chars(struct uart_port *port)
199 struct circ_buf *xmit;
204 xmit = &port->state->xmit;
205 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
206 sc26xx_disable_irq(port, IMR_TXRDY);
209 while (!uart_circ_empty(xmit)) {
210 if (!(READ_SC_PORT(port, SR) & SR_TXRDY))
213 WRITE_SC_PORT(port, THR, xmit->buf[xmit->tail]);
214 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
217 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
218 uart_write_wakeup(port);
221 static irqreturn_t sc26xx_interrupt(int irq, void *dev_id)
223 struct uart_sc26xx_port *up = dev_id;
224 struct tty_struct *tty;
228 spin_lock_irqsave(&up->port[0].lock, flags);
231 isr = READ_SC(&up->port[0], ISR);
232 if (isr & ISR_TXRDYA)
233 transmit_chars(&up->port[0]);
234 if (isr & ISR_RXRDYA)
235 tty = receive_chars(&up->port[0]);
237 spin_unlock(&up->port[0].lock);
240 tty_flip_buffer_push(tty);
242 spin_lock(&up->port[1].lock);
245 if (isr & ISR_TXRDYB)
246 transmit_chars(&up->port[1]);
247 if (isr & ISR_RXRDYB)
248 tty = receive_chars(&up->port[1]);
250 spin_unlock_irqrestore(&up->port[1].lock, flags);
253 tty_flip_buffer_push(tty);
258 /* port->lock is not held. */
259 static unsigned int sc26xx_tx_empty(struct uart_port *port)
261 return (READ_SC_PORT(port, SR) & SR_TXRDY) ? TIOCSER_TEMT : 0;
264 /* port->lock held by caller. */
265 static void sc26xx_set_mctrl(struct uart_port *port, unsigned int mctrl)
267 struct uart_sc26xx_port *up;
268 int line = port->line;
271 up = container_of(port, struct uart_sc26xx_port, port[0]);
273 if (up->dtr_mask[line]) {
274 if (mctrl & TIOCM_DTR)
275 WRITE_SC(port, OPR_SET, up->dtr_mask[line]);
277 WRITE_SC(port, OPR_CLR, up->dtr_mask[line]);
279 if (up->rts_mask[line]) {
280 if (mctrl & TIOCM_RTS)
281 WRITE_SC(port, OPR_SET, up->rts_mask[line]);
283 WRITE_SC(port, OPR_CLR, up->rts_mask[line]);
287 /* port->lock is held by caller and interrupts are disabled. */
288 static unsigned int sc26xx_get_mctrl(struct uart_port *port)
290 struct uart_sc26xx_port *up;
291 int line = port->line;
292 unsigned int mctrl = TIOCM_DSR | TIOCM_CTS | TIOCM_CAR;
296 up = container_of(port, struct uart_sc26xx_port, port[0]);
297 ipr = READ_SC(port, IPR) ^ 0xff;
299 if (up->dsr_mask[line]) {
301 mctrl |= ipr & up->dsr_mask[line] ? TIOCM_DSR : 0;
303 if (up->cts_mask[line]) {
305 mctrl |= ipr & up->cts_mask[line] ? TIOCM_CTS : 0;
307 if (up->dcd_mask[line]) {
309 mctrl |= ipr & up->dcd_mask[line] ? TIOCM_CAR : 0;
311 if (up->ri_mask[line]) {
313 mctrl |= ipr & up->ri_mask[line] ? TIOCM_RNG : 0;
318 /* port->lock held by caller. */
319 static void sc26xx_stop_tx(struct uart_port *port)
324 /* port->lock held by caller. */
325 static void sc26xx_start_tx(struct uart_port *port)
327 struct circ_buf *xmit = &port->state->xmit;
329 while (!uart_circ_empty(xmit)) {
330 if (!(READ_SC_PORT(port, SR) & SR_TXRDY)) {
331 sc26xx_enable_irq(port, IMR_TXRDY);
334 WRITE_SC_PORT(port, THR, xmit->buf[xmit->tail]);
335 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
340 /* port->lock held by caller. */
341 static void sc26xx_stop_rx(struct uart_port *port)
345 /* port->lock held by caller. */
346 static void sc26xx_enable_ms(struct uart_port *port)
350 /* port->lock is not held. */
351 static void sc26xx_break_ctl(struct uart_port *port, int break_state)
353 if (break_state == -1)
354 WRITE_SC_PORT(port, CR, CR_STRT_BRK);
356 WRITE_SC_PORT(port, CR, CR_STOP_BRK);
359 /* port->lock is not held. */
360 static int sc26xx_startup(struct uart_port *port)
362 sc26xx_disable_irq(port, IMR_TXRDY | IMR_RXRDY);
363 WRITE_SC(port, OPCR, 0);
365 /* reset tx and rx */
366 WRITE_SC_PORT(port, CR, CR_RES_RX);
367 WRITE_SC_PORT(port, CR, CR_RES_TX);
370 WRITE_SC_PORT(port, CR, CR_ENA_TX | CR_ENA_RX);
373 sc26xx_enable_irq(port, IMR_RXRDY);
377 /* port->lock is not held. */
378 static void sc26xx_shutdown(struct uart_port *port)
380 /* disable interrupst */
381 sc26xx_disable_irq(port, IMR_TXRDY | IMR_RXRDY);
384 WRITE_SC_PORT(port, CR, CR_DIS_TX | CR_DIS_RX);
387 /* port->lock is not held. */
388 static void sc26xx_set_termios(struct uart_port *port, struct ktermios *termios,
389 struct ktermios *old)
391 unsigned int baud = uart_get_baud_rate(port, termios, old, 0, 4000000);
392 unsigned int quot = uart_get_divisor(port, baud);
393 unsigned int iflag, cflag;
397 spin_lock_irqsave(&port->lock, flags);
399 while ((READ_SC_PORT(port, SR) & ((1 << 3) | (1 << 2))) != 0xc)
402 WRITE_SC_PORT(port, CR, CR_DIS_TX | CR_DIS_RX);
404 iflag = termios->c_iflag;
405 cflag = termios->c_cflag;
407 port->read_status_mask = SR_OVERRUN;
409 port->read_status_mask |= SR_PARITY | SR_FRAME;
410 if (iflag & (BRKINT | PARMRK))
411 port->read_status_mask |= SR_BREAK;
413 port->ignore_status_mask = 0;
415 port->ignore_status_mask |= SR_BREAK;
416 if ((cflag & CREAD) == 0)
417 port->ignore_status_mask |= SR_BREAK | SR_FRAME |
418 SR_PARITY | SR_OVERRUN;
420 switch (cflag & CSIZE) {
438 if (cflag & PARENB) {
481 WRITE_SC_PORT(port, CR, CR_RES_MR);
482 WRITE_SC_PORT(port, MRx, mr1);
483 WRITE_SC_PORT(port, MRx, mr2);
485 WRITE_SC(port, ACR, 0x80);
486 WRITE_SC_PORT(port, CSR, csr);
488 /* reset tx and rx */
489 WRITE_SC_PORT(port, CR, CR_RES_RX);
490 WRITE_SC_PORT(port, CR, CR_RES_TX);
492 WRITE_SC_PORT(port, CR, CR_ENA_TX | CR_ENA_RX);
493 while ((READ_SC_PORT(port, SR) & ((1 << 3) | (1 << 2))) != 0xc)
497 uart_update_timeout(port, cflag,
498 (port->uartclk / (16 * quot)));
500 spin_unlock_irqrestore(&port->lock, flags);
503 static const char *sc26xx_type(struct uart_port *port)
508 static void sc26xx_release_port(struct uart_port *port)
512 static int sc26xx_request_port(struct uart_port *port)
517 static void sc26xx_config_port(struct uart_port *port, int flags)
521 static int sc26xx_verify_port(struct uart_port *port, struct serial_struct *ser)
526 static struct uart_ops sc26xx_ops = {
527 .tx_empty = sc26xx_tx_empty,
528 .set_mctrl = sc26xx_set_mctrl,
529 .get_mctrl = sc26xx_get_mctrl,
530 .stop_tx = sc26xx_stop_tx,
531 .start_tx = sc26xx_start_tx,
532 .stop_rx = sc26xx_stop_rx,
533 .enable_ms = sc26xx_enable_ms,
534 .break_ctl = sc26xx_break_ctl,
535 .startup = sc26xx_startup,
536 .shutdown = sc26xx_shutdown,
537 .set_termios = sc26xx_set_termios,
539 .release_port = sc26xx_release_port,
540 .request_port = sc26xx_request_port,
541 .config_port = sc26xx_config_port,
542 .verify_port = sc26xx_verify_port,
545 static struct uart_port *sc26xx_port;
547 #ifdef CONFIG_SERIAL_SC26XX_CONSOLE
548 static void sc26xx_console_putchar(struct uart_port *port, char c)
553 spin_lock_irqsave(&port->lock, flags);
555 while (limit-- > 0) {
556 if (READ_SC_PORT(port, SR) & SR_TXRDY) {
557 WRITE_SC_PORT(port, THR, c);
563 spin_unlock_irqrestore(&port->lock, flags);
566 static void sc26xx_console_write(struct console *con, const char *s, unsigned n)
568 struct uart_port *port = sc26xx_port;
571 for (i = 0; i < n; i++) {
573 sc26xx_console_putchar(port, '\r');
574 sc26xx_console_putchar(port, *s++);
578 static int __init sc26xx_console_setup(struct console *con, char *options)
580 struct uart_port *port = sc26xx_port;
586 if (port->type != PORT_SC26XX)
589 printk(KERN_INFO "Console: ttySC%d (SC26XX)\n", con->index);
591 uart_parse_options(options, &baud, &parity, &bits, &flow);
593 return uart_set_options(port, con, baud, parity, bits, flow);
596 static struct uart_driver sc26xx_reg;
597 static struct console sc26xx_console = {
599 .write = sc26xx_console_write,
600 .device = uart_console_device,
601 .setup = sc26xx_console_setup,
602 .flags = CON_PRINTBUFFER,
606 #define SC26XX_CONSOLE &sc26xx_console
608 #define SC26XX_CONSOLE NULL
611 static struct uart_driver sc26xx_reg = {
612 .owner = THIS_MODULE,
613 .driver_name = "SC26xx",
615 .major = SC26XX_MAJOR,
616 .minor = SC26XX_MINOR_START,
618 .cons = SC26XX_CONSOLE,
621 static u8 sc26xx_flags2mask(unsigned int flags, unsigned int bitpos)
623 unsigned int bit = (flags >> bitpos) & 15;
625 return bit ? (1 << (bit - 1)) : 0;
628 static void sc26xx_init_masks(struct uart_sc26xx_port *up,
629 int line, unsigned int data)
631 up->dtr_mask[line] = sc26xx_flags2mask(data, 0);
632 up->rts_mask[line] = sc26xx_flags2mask(data, 4);
633 up->dsr_mask[line] = sc26xx_flags2mask(data, 8);
634 up->cts_mask[line] = sc26xx_flags2mask(data, 12);
635 up->dcd_mask[line] = sc26xx_flags2mask(data, 16);
636 up->ri_mask[line] = sc26xx_flags2mask(data, 20);
639 static int sc26xx_probe(struct platform_device *dev)
641 struct resource *res;
642 struct uart_sc26xx_port *up;
643 unsigned int *sc26xx_data = dev->dev.platform_data;
646 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
650 up = kzalloc(sizeof *up, GFP_KERNEL);
654 up->port[0].line = 0;
655 up->port[0].ops = &sc26xx_ops;
656 up->port[0].type = PORT_SC26XX;
657 up->port[0].uartclk = (29491200 / 16); /* arbitrary */
659 up->port[0].mapbase = res->start;
660 up->port[0].membase = ioremap_nocache(up->port[0].mapbase, 0x40);
661 up->port[0].iotype = UPIO_MEM;
662 up->port[0].irq = platform_get_irq(dev, 0);
664 up->port[0].dev = &dev->dev;
666 sc26xx_init_masks(up, 0, sc26xx_data[0]);
668 sc26xx_port = &up->port[0];
670 up->port[1].line = 1;
671 up->port[1].ops = &sc26xx_ops;
672 up->port[1].type = PORT_SC26XX;
673 up->port[1].uartclk = (29491200 / 16); /* arbitrary */
675 up->port[1].mapbase = up->port[0].mapbase;
676 up->port[1].membase = up->port[0].membase;
677 up->port[1].iotype = UPIO_MEM;
678 up->port[1].irq = up->port[0].irq;
680 up->port[1].dev = &dev->dev;
682 sc26xx_init_masks(up, 1, sc26xx_data[1]);
684 err = uart_register_driver(&sc26xx_reg);
688 sc26xx_reg.tty_driver->name_base = sc26xx_reg.minor;
690 err = uart_add_one_port(&sc26xx_reg, &up->port[0]);
692 goto out_unregister_driver;
694 err = uart_add_one_port(&sc26xx_reg, &up->port[1]);
696 goto out_remove_port0;
698 err = request_irq(up->port[0].irq, sc26xx_interrupt, 0, "sc26xx", up);
700 goto out_remove_ports;
702 dev_set_drvdata(&dev->dev, up);
706 uart_remove_one_port(&sc26xx_reg, &up->port[1]);
708 uart_remove_one_port(&sc26xx_reg, &up->port[0]);
710 out_unregister_driver:
711 uart_unregister_driver(&sc26xx_reg);
720 static int __exit sc26xx_driver_remove(struct platform_device *dev)
722 struct uart_sc26xx_port *up = dev_get_drvdata(&dev->dev);
724 free_irq(up->port[0].irq, up);
726 uart_remove_one_port(&sc26xx_reg, &up->port[0]);
727 uart_remove_one_port(&sc26xx_reg, &up->port[1]);
729 uart_unregister_driver(&sc26xx_reg);
734 dev_set_drvdata(&dev->dev, NULL);
738 static struct platform_driver sc26xx_driver = {
739 .probe = sc26xx_probe,
740 .remove = sc26xx_driver_remove,
743 .owner = THIS_MODULE,
747 module_platform_driver(sc26xx_driver);
749 MODULE_AUTHOR("Thomas Bogendörfer");
750 MODULE_DESCRIPTION("SC681/SC2692 serial driver");
751 MODULE_VERSION("1.0");
752 MODULE_LICENSE("GPL");
753 MODULE_ALIAS("platform:SC26xx");