2 * Driver for NEC VR4100 series Serial Interface Unit.
4 * Copyright (C) 2004-2008 Yoichi Yuasa <yoichi_yuasa@tripeaks.co.jp>
6 * Based on drivers/serial/8250.c, by Russell King.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #if defined(CONFIG_SERIAL_VR41XX_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
27 #include <linux/console.h>
28 #include <linux/errno.h>
29 #include <linux/init.h>
30 #include <linux/interrupt.h>
31 #include <linux/ioport.h>
32 #include <linux/module.h>
33 #include <linux/platform_device.h>
34 #include <linux/serial.h>
35 #include <linux/serial_core.h>
36 #include <linux/serial_reg.h>
37 #include <linux/tty.h>
38 #include <linux/tty_flip.h>
41 #include <asm/vr41xx/siu.h>
42 #include <asm/vr41xx/vr41xx.h>
44 #define SIU_BAUD_BASE 1152000
46 #define SIU_MINOR_BASE 82
48 #define RX_MAX_COUNT 256
49 #define TX_MAX_COUNT 15
55 #define IRMSEL_HP 0x08
56 #define IRMSEL_TEMIC 0x04
57 #define IRMSEL_SHARP 0x00
61 static struct uart_port siu_uart_ports[SIU_PORTS_MAX] = {
62 [0 ... SIU_PORTS_MAX-1] = {
63 .lock = __SPIN_LOCK_UNLOCKED(siu_uart_ports->lock),
68 #ifdef CONFIG_SERIAL_VR41XX_CONSOLE
69 static uint8_t lsr_break_flag[SIU_PORTS_MAX];
72 #define siu_read(port, offset) readb((port)->membase + (offset))
73 #define siu_write(port, offset, value) writeb((value), (port)->membase + (offset))
75 void vr41xx_select_siu_interface(siu_interface_t interface)
77 struct uart_port *port;
81 port = &siu_uart_ports[0];
83 spin_lock_irqsave(&port->lock, flags);
85 irsel = siu_read(port, SIUIRSEL);
86 if (interface == SIU_INTERFACE_IRDA)
90 siu_write(port, SIUIRSEL, irsel);
92 spin_unlock_irqrestore(&port->lock, flags);
94 EXPORT_SYMBOL_GPL(vr41xx_select_siu_interface);
96 void vr41xx_use_irda(irda_use_t use)
98 struct uart_port *port;
102 port = &siu_uart_ports[0];
104 spin_lock_irqsave(&port->lock, flags);
106 irsel = siu_read(port, SIUIRSEL);
107 if (use == FIR_USE_IRDA)
111 siu_write(port, SIUIRSEL, irsel);
113 spin_unlock_irqrestore(&port->lock, flags);
115 EXPORT_SYMBOL_GPL(vr41xx_use_irda);
117 void vr41xx_select_irda_module(irda_module_t module, irda_speed_t speed)
119 struct uart_port *port;
123 port = &siu_uart_ports[0];
125 spin_lock_irqsave(&port->lock, flags);
127 irsel = siu_read(port, SIUIRSEL);
128 irsel &= ~(IRMSEL | TMICTX | TMICMODE);
131 irsel |= IRMSEL_SHARP;
134 irsel |= IRMSEL_TEMIC | TMICMODE;
135 if (speed == IRDA_TX_4MBPS)
144 siu_write(port, SIUIRSEL, irsel);
146 spin_unlock_irqrestore(&port->lock, flags);
148 EXPORT_SYMBOL_GPL(vr41xx_select_irda_module);
150 static inline void siu_clear_fifo(struct uart_port *port)
152 siu_write(port, UART_FCR, UART_FCR_ENABLE_FIFO);
153 siu_write(port, UART_FCR, UART_FCR_ENABLE_FIFO | UART_FCR_CLEAR_RCVR |
154 UART_FCR_CLEAR_XMIT);
155 siu_write(port, UART_FCR, 0);
158 static inline unsigned long siu_port_size(struct uart_port *port)
160 switch (port->type) {
161 case PORT_VR41XX_SIU:
163 case PORT_VR41XX_DSIU:
170 static inline unsigned int siu_check_type(struct uart_port *port)
173 return PORT_VR41XX_SIU;
174 if (port->line == 1 && port->irq != -1)
175 return PORT_VR41XX_DSIU;
180 static inline const char *siu_type_name(struct uart_port *port)
182 switch (port->type) {
183 case PORT_VR41XX_SIU:
185 case PORT_VR41XX_DSIU:
192 static unsigned int siu_tx_empty(struct uart_port *port)
196 lsr = siu_read(port, UART_LSR);
197 if (lsr & UART_LSR_TEMT)
203 static void siu_set_mctrl(struct uart_port *port, unsigned int mctrl)
207 if (mctrl & TIOCM_DTR)
209 if (mctrl & TIOCM_RTS)
211 if (mctrl & TIOCM_OUT1)
212 mcr |= UART_MCR_OUT1;
213 if (mctrl & TIOCM_OUT2)
214 mcr |= UART_MCR_OUT2;
215 if (mctrl & TIOCM_LOOP)
216 mcr |= UART_MCR_LOOP;
218 siu_write(port, UART_MCR, mcr);
221 static unsigned int siu_get_mctrl(struct uart_port *port)
224 unsigned int mctrl = 0;
226 msr = siu_read(port, UART_MSR);
227 if (msr & UART_MSR_DCD)
229 if (msr & UART_MSR_RI)
231 if (msr & UART_MSR_DSR)
233 if (msr & UART_MSR_CTS)
239 static void siu_stop_tx(struct uart_port *port)
244 spin_lock_irqsave(&port->lock, flags);
246 ier = siu_read(port, UART_IER);
247 ier &= ~UART_IER_THRI;
248 siu_write(port, UART_IER, ier);
250 spin_unlock_irqrestore(&port->lock, flags);
253 static void siu_start_tx(struct uart_port *port)
258 spin_lock_irqsave(&port->lock, flags);
260 ier = siu_read(port, UART_IER);
261 ier |= UART_IER_THRI;
262 siu_write(port, UART_IER, ier);
264 spin_unlock_irqrestore(&port->lock, flags);
267 static void siu_stop_rx(struct uart_port *port)
272 spin_lock_irqsave(&port->lock, flags);
274 ier = siu_read(port, UART_IER);
275 ier &= ~UART_IER_RLSI;
276 siu_write(port, UART_IER, ier);
278 port->read_status_mask &= ~UART_LSR_DR;
280 spin_unlock_irqrestore(&port->lock, flags);
283 static void siu_enable_ms(struct uart_port *port)
288 spin_lock_irqsave(&port->lock, flags);
290 ier = siu_read(port, UART_IER);
292 siu_write(port, UART_IER, ier);
294 spin_unlock_irqrestore(&port->lock, flags);
297 static void siu_break_ctl(struct uart_port *port, int ctl)
302 spin_lock_irqsave(&port->lock, flags);
304 lcr = siu_read(port, UART_LCR);
308 lcr &= ~UART_LCR_SBC;
309 siu_write(port, UART_LCR, lcr);
311 spin_unlock_irqrestore(&port->lock, flags);
314 static inline void receive_chars(struct uart_port *port, uint8_t *status)
316 struct tty_struct *tty;
319 int max_count = RX_MAX_COUNT;
321 tty = port->info->tty;
325 ch = siu_read(port, UART_RX);
329 #ifdef CONFIG_SERIAL_VR41XX_CONSOLE
330 lsr |= lsr_break_flag[port->line];
331 lsr_break_flag[port->line] = 0;
333 if (unlikely(lsr & (UART_LSR_BI | UART_LSR_FE |
334 UART_LSR_PE | UART_LSR_OE))) {
335 if (lsr & UART_LSR_BI) {
336 lsr &= ~(UART_LSR_FE | UART_LSR_PE);
339 if (uart_handle_break(port))
343 if (lsr & UART_LSR_FE)
344 port->icount.frame++;
345 if (lsr & UART_LSR_PE)
346 port->icount.parity++;
347 if (lsr & UART_LSR_OE)
348 port->icount.overrun++;
350 lsr &= port->read_status_mask;
351 if (lsr & UART_LSR_BI)
353 if (lsr & UART_LSR_FE)
355 if (lsr & UART_LSR_PE)
359 if (uart_handle_sysrq_char(port, ch))
362 uart_insert_char(port, lsr, UART_LSR_OE, ch, flag);
365 lsr = siu_read(port, UART_LSR);
366 } while ((lsr & UART_LSR_DR) && (max_count-- > 0));
368 tty_flip_buffer_push(tty);
373 static inline void check_modem_status(struct uart_port *port)
377 msr = siu_read(port, UART_MSR);
378 if ((msr & UART_MSR_ANY_DELTA) == 0)
380 if (msr & UART_MSR_DDCD)
381 uart_handle_dcd_change(port, msr & UART_MSR_DCD);
382 if (msr & UART_MSR_TERI)
384 if (msr & UART_MSR_DDSR)
386 if (msr & UART_MSR_DCTS)
387 uart_handle_cts_change(port, msr & UART_MSR_CTS);
389 wake_up_interruptible(&port->info->delta_msr_wait);
392 static inline void transmit_chars(struct uart_port *port)
394 struct circ_buf *xmit;
395 int max_count = TX_MAX_COUNT;
397 xmit = &port->info->xmit;
400 siu_write(port, UART_TX, port->x_char);
406 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
412 siu_write(port, UART_TX, xmit->buf[xmit->tail]);
413 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
415 if (uart_circ_empty(xmit))
417 } while (max_count-- > 0);
419 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
420 uart_write_wakeup(port);
422 if (uart_circ_empty(xmit))
426 static irqreturn_t siu_interrupt(int irq, void *dev_id)
428 struct uart_port *port;
431 port = (struct uart_port *)dev_id;
433 iir = siu_read(port, UART_IIR);
434 if (iir & UART_IIR_NO_INT)
437 lsr = siu_read(port, UART_LSR);
438 if (lsr & UART_LSR_DR)
439 receive_chars(port, &lsr);
441 check_modem_status(port);
443 if (lsr & UART_LSR_THRE)
444 transmit_chars(port);
449 static int siu_startup(struct uart_port *port)
453 if (port->membase == NULL)
456 siu_clear_fifo(port);
458 (void)siu_read(port, UART_LSR);
459 (void)siu_read(port, UART_RX);
460 (void)siu_read(port, UART_IIR);
461 (void)siu_read(port, UART_MSR);
463 if (siu_read(port, UART_LSR) == 0xff)
466 retval = request_irq(port->irq, siu_interrupt, 0, siu_type_name(port), port);
470 if (port->type == PORT_VR41XX_DSIU)
471 vr41xx_enable_dsiuint(DSIUINT_ALL);
473 siu_write(port, UART_LCR, UART_LCR_WLEN8);
475 spin_lock_irq(&port->lock);
476 siu_set_mctrl(port, port->mctrl);
477 spin_unlock_irq(&port->lock);
479 siu_write(port, UART_IER, UART_IER_RLSI | UART_IER_RDI);
481 (void)siu_read(port, UART_LSR);
482 (void)siu_read(port, UART_RX);
483 (void)siu_read(port, UART_IIR);
484 (void)siu_read(port, UART_MSR);
489 static void siu_shutdown(struct uart_port *port)
494 siu_write(port, UART_IER, 0);
496 spin_lock_irqsave(&port->lock, flags);
498 port->mctrl &= ~TIOCM_OUT2;
499 siu_set_mctrl(port, port->mctrl);
501 spin_unlock_irqrestore(&port->lock, flags);
503 lcr = siu_read(port, UART_LCR);
504 lcr &= ~UART_LCR_SBC;
505 siu_write(port, UART_LCR, lcr);
507 siu_clear_fifo(port);
509 (void)siu_read(port, UART_RX);
511 if (port->type == PORT_VR41XX_DSIU)
512 vr41xx_disable_dsiuint(DSIUINT_ALL);
514 free_irq(port->irq, port);
517 static void siu_set_termios(struct uart_port *port, struct ktermios *new,
518 struct ktermios *old)
520 tcflag_t c_cflag, c_iflag;
521 uint8_t lcr, fcr, ier;
522 unsigned int baud, quot;
525 c_cflag = new->c_cflag;
526 switch (c_cflag & CSIZE) {
528 lcr = UART_LCR_WLEN5;
531 lcr = UART_LCR_WLEN6;
534 lcr = UART_LCR_WLEN7;
537 lcr = UART_LCR_WLEN8;
541 if (c_cflag & CSTOPB)
542 lcr |= UART_LCR_STOP;
543 if (c_cflag & PARENB)
544 lcr |= UART_LCR_PARITY;
545 if ((c_cflag & PARODD) != PARODD)
546 lcr |= UART_LCR_EPAR;
547 if (c_cflag & CMSPAR)
548 lcr |= UART_LCR_SPAR;
550 baud = uart_get_baud_rate(port, new, old, 0, port->uartclk/16);
551 quot = uart_get_divisor(port, baud);
553 fcr = UART_FCR_ENABLE_FIFO | UART_FCR_R_TRIG_10;
555 spin_lock_irqsave(&port->lock, flags);
557 uart_update_timeout(port, c_cflag, baud);
559 c_iflag = new->c_iflag;
561 port->read_status_mask = UART_LSR_THRE | UART_LSR_OE | UART_LSR_DR;
563 port->read_status_mask |= UART_LSR_FE | UART_LSR_PE;
564 if (c_iflag & (BRKINT | PARMRK))
565 port->read_status_mask |= UART_LSR_BI;
567 port->ignore_status_mask = 0;
568 if (c_iflag & IGNPAR)
569 port->ignore_status_mask |= UART_LSR_FE | UART_LSR_PE;
570 if (c_iflag & IGNBRK) {
571 port->ignore_status_mask |= UART_LSR_BI;
572 if (c_iflag & IGNPAR)
573 port->ignore_status_mask |= UART_LSR_OE;
576 if ((c_cflag & CREAD) == 0)
577 port->ignore_status_mask |= UART_LSR_DR;
579 ier = siu_read(port, UART_IER);
580 ier &= ~UART_IER_MSI;
581 if (UART_ENABLE_MS(port, c_cflag))
583 siu_write(port, UART_IER, ier);
585 siu_write(port, UART_LCR, lcr | UART_LCR_DLAB);
587 siu_write(port, UART_DLL, (uint8_t)quot);
588 siu_write(port, UART_DLM, (uint8_t)(quot >> 8));
590 siu_write(port, UART_LCR, lcr);
592 siu_write(port, UART_FCR, fcr);
594 siu_set_mctrl(port, port->mctrl);
596 spin_unlock_irqrestore(&port->lock, flags);
599 static void siu_pm(struct uart_port *port, unsigned int state, unsigned int oldstate)
603 switch (port->type) {
604 case PORT_VR41XX_SIU:
605 vr41xx_supply_clock(SIU_CLOCK);
607 case PORT_VR41XX_DSIU:
608 vr41xx_supply_clock(DSIU_CLOCK);
613 switch (port->type) {
614 case PORT_VR41XX_SIU:
615 vr41xx_mask_clock(SIU_CLOCK);
617 case PORT_VR41XX_DSIU:
618 vr41xx_mask_clock(DSIU_CLOCK);
625 static const char *siu_type(struct uart_port *port)
627 return siu_type_name(port);
630 static void siu_release_port(struct uart_port *port)
634 if (port->flags & UPF_IOREMAP) {
635 iounmap(port->membase);
636 port->membase = NULL;
639 size = siu_port_size(port);
640 release_mem_region(port->mapbase, size);
643 static int siu_request_port(struct uart_port *port)
646 struct resource *res;
648 size = siu_port_size(port);
649 res = request_mem_region(port->mapbase, size, siu_type_name(port));
653 if (port->flags & UPF_IOREMAP) {
654 port->membase = ioremap(port->mapbase, size);
655 if (port->membase == NULL) {
656 release_resource(res);
664 static void siu_config_port(struct uart_port *port, int flags)
666 if (flags & UART_CONFIG_TYPE) {
667 port->type = siu_check_type(port);
668 (void)siu_request_port(port);
672 static int siu_verify_port(struct uart_port *port, struct serial_struct *serial)
674 if (port->type != PORT_VR41XX_SIU && port->type != PORT_VR41XX_DSIU)
676 if (port->irq != serial->irq)
678 if (port->iotype != serial->io_type)
680 if (port->mapbase != (unsigned long)serial->iomem_base)
686 static struct uart_ops siu_uart_ops = {
687 .tx_empty = siu_tx_empty,
688 .set_mctrl = siu_set_mctrl,
689 .get_mctrl = siu_get_mctrl,
690 .stop_tx = siu_stop_tx,
691 .start_tx = siu_start_tx,
692 .stop_rx = siu_stop_rx,
693 .enable_ms = siu_enable_ms,
694 .break_ctl = siu_break_ctl,
695 .startup = siu_startup,
696 .shutdown = siu_shutdown,
697 .set_termios = siu_set_termios,
700 .release_port = siu_release_port,
701 .request_port = siu_request_port,
702 .config_port = siu_config_port,
703 .verify_port = siu_verify_port,
706 static int siu_init_ports(struct platform_device *pdev)
708 struct uart_port *port;
709 struct resource *res;
710 int *type = pdev->dev.platform_data;
716 port = siu_uart_ports;
717 for (i = 0; i < SIU_PORTS_MAX; i++) {
718 port->type = type[i];
719 if (port->type == PORT_UNKNOWN)
721 port->irq = platform_get_irq(pdev, i);
722 port->uartclk = SIU_BAUD_BASE * 16;
725 port->iotype = UPIO_MEM;
726 port->flags = UPF_IOREMAP | UPF_BOOT_AUTOCONF;
728 res = platform_get_resource(pdev, IORESOURCE_MEM, i);
729 port->mapbase = res->start;
736 #ifdef CONFIG_SERIAL_VR41XX_CONSOLE
738 #define BOTH_EMPTY (UART_LSR_TEMT | UART_LSR_THRE)
740 static void wait_for_xmitr(struct uart_port *port)
746 lsr = siu_read(port, UART_LSR);
747 if (lsr & UART_LSR_BI)
748 lsr_break_flag[port->line] = UART_LSR_BI;
750 if ((lsr & BOTH_EMPTY) == BOTH_EMPTY)
752 } while (timeout-- > 0);
754 if (port->flags & UPF_CONS_FLOW) {
758 msr = siu_read(port, UART_MSR);
759 if ((msr & UART_MSR_CTS) != 0)
761 } while (timeout-- > 0);
765 static void siu_console_putchar(struct uart_port *port, int ch)
767 wait_for_xmitr(port);
768 siu_write(port, UART_TX, ch);
771 static void siu_console_write(struct console *con, const char *s, unsigned count)
773 struct uart_port *port;
776 port = &siu_uart_ports[con->index];
778 ier = siu_read(port, UART_IER);
779 siu_write(port, UART_IER, 0);
781 uart_console_write(port, s, count, siu_console_putchar);
783 wait_for_xmitr(port);
784 siu_write(port, UART_IER, ier);
787 static int __init siu_console_setup(struct console *con, char *options)
789 struct uart_port *port;
795 if (con->index >= SIU_PORTS_MAX)
798 port = &siu_uart_ports[con->index];
799 if (port->membase == NULL) {
800 if (port->mapbase == 0)
802 port->membase = ioremap(port->mapbase, siu_port_size(port));
805 if (port->type == PORT_VR41XX_SIU)
806 vr41xx_select_siu_interface(SIU_INTERFACE_RS232C);
809 uart_parse_options(options, &baud, &parity, &bits, &flow);
811 return uart_set_options(port, con, baud, parity, bits, flow);
814 static struct uart_driver siu_uart_driver;
816 static struct console siu_console = {
818 .write = siu_console_write,
819 .device = uart_console_device,
820 .setup = siu_console_setup,
821 .flags = CON_PRINTBUFFER,
823 .data = &siu_uart_driver,
826 static int __devinit siu_console_init(void)
828 struct uart_port *port;
831 for (i = 0; i < SIU_PORTS_MAX; i++) {
832 port = &siu_uart_ports[i];
833 port->ops = &siu_uart_ops;
836 register_console(&siu_console);
841 console_initcall(siu_console_init);
843 void __init vr41xx_siu_early_setup(struct uart_port *port)
845 if (port->type == PORT_UNKNOWN)
848 siu_uart_ports[port->line].line = port->line;
849 siu_uart_ports[port->line].type = port->type;
850 siu_uart_ports[port->line].uartclk = SIU_BAUD_BASE * 16;
851 siu_uart_ports[port->line].mapbase = port->mapbase;
852 siu_uart_ports[port->line].mapbase = port->mapbase;
853 siu_uart_ports[port->line].ops = &siu_uart_ops;
856 #define SERIAL_VR41XX_CONSOLE &siu_console
858 #define SERIAL_VR41XX_CONSOLE NULL
861 static struct uart_driver siu_uart_driver = {
862 .owner = THIS_MODULE,
863 .driver_name = "SIU",
866 .minor = SIU_MINOR_BASE,
867 .cons = SERIAL_VR41XX_CONSOLE,
870 static int __devinit siu_probe(struct platform_device *dev)
872 struct uart_port *port;
875 num = siu_init_ports(dev);
879 siu_uart_driver.nr = num;
880 retval = uart_register_driver(&siu_uart_driver);
884 for (i = 0; i < num; i++) {
885 port = &siu_uart_ports[i];
886 port->ops = &siu_uart_ops;
887 port->dev = &dev->dev;
889 retval = uart_add_one_port(&siu_uart_driver, port);
896 if (i == 0 && retval < 0) {
897 uart_unregister_driver(&siu_uart_driver);
904 static int __devexit siu_remove(struct platform_device *dev)
906 struct uart_port *port;
909 for (i = 0; i < siu_uart_driver.nr; i++) {
910 port = &siu_uart_ports[i];
911 if (port->dev == &dev->dev) {
912 uart_remove_one_port(&siu_uart_driver, port);
917 uart_unregister_driver(&siu_uart_driver);
922 static int siu_suspend(struct platform_device *dev, pm_message_t state)
924 struct uart_port *port;
927 for (i = 0; i < siu_uart_driver.nr; i++) {
928 port = &siu_uart_ports[i];
929 if ((port->type == PORT_VR41XX_SIU ||
930 port->type == PORT_VR41XX_DSIU) && port->dev == &dev->dev)
931 uart_suspend_port(&siu_uart_driver, port);
938 static int siu_resume(struct platform_device *dev)
940 struct uart_port *port;
943 for (i = 0; i < siu_uart_driver.nr; i++) {
944 port = &siu_uart_ports[i];
945 if ((port->type == PORT_VR41XX_SIU ||
946 port->type == PORT_VR41XX_DSIU) && port->dev == &dev->dev)
947 uart_resume_port(&siu_uart_driver, port);
953 static struct platform_driver siu_device_driver = {
955 .remove = __devexit_p(siu_remove),
956 .suspend = siu_suspend,
957 .resume = siu_resume,
960 .owner = THIS_MODULE,
964 static int __init vr41xx_siu_init(void)
966 return platform_driver_register(&siu_device_driver);
969 static void __exit vr41xx_siu_exit(void)
971 platform_driver_unregister(&siu_device_driver);
974 module_init(vr41xx_siu_init);
975 module_exit(vr41xx_siu_exit);
977 MODULE_LICENSE("GPL");
978 MODULE_ALIAS("platform:SIU");