2 * Driver for NEC VR4100 series Serial Interface Unit.
4 * Copyright (C) 2004-2005 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/platform_device.h>
29 #include <linux/err.h>
30 #include <linux/ioport.h>
31 #include <linux/init.h>
32 #include <linux/interrupt.h>
33 #include <linux/module.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/irq.h>
42 #include <asm/vr41xx/siu.h>
43 #include <asm/vr41xx/vr41xx.h>
45 #define SIU_PORTS_MAX 2
46 #define SIU_BAUD_BASE 1152000
48 #define SIU_MINOR_BASE 82
50 #define RX_MAX_COUNT 256
51 #define TX_MAX_COUNT 15
57 #define IRMSEL_HP 0x08
58 #define IRMSEL_TEMIC 0x04
59 #define IRMSEL_SHARP 0x00
69 static const struct siu_port siu_type1_ports[] = {
70 { .type = PORT_VR41XX_SIU,
72 .start = 0x0c000000UL, },
75 #define SIU_TYPE1_NR_PORTS (sizeof(siu_type1_ports) / sizeof(struct siu_port))
77 static const struct siu_port siu_type2_ports[] = {
78 { .type = PORT_VR41XX_SIU,
80 .start = 0x0f000800UL, },
81 { .type = PORT_VR41XX_DSIU,
83 .start = 0x0f000820UL, },
86 #define SIU_TYPE2_NR_PORTS (sizeof(siu_type2_ports) / sizeof(struct siu_port))
88 static struct uart_port siu_uart_ports[SIU_PORTS_MAX];
89 static uint8_t lsr_break_flag[SIU_PORTS_MAX];
91 #define siu_read(port, offset) readb((port)->membase + (offset))
92 #define siu_write(port, offset, value) writeb((value), (port)->membase + (offset))
94 void vr41xx_select_siu_interface(siu_interface_t interface)
96 struct uart_port *port;
100 port = &siu_uart_ports[0];
102 spin_lock_irqsave(&port->lock, flags);
104 irsel = siu_read(port, SIUIRSEL);
105 if (interface == SIU_INTERFACE_IRDA)
109 siu_write(port, SIUIRSEL, irsel);
111 spin_unlock_irqrestore(&port->lock, flags);
114 EXPORT_SYMBOL_GPL(vr41xx_select_siu_interface);
116 void vr41xx_use_irda(irda_use_t use)
118 struct uart_port *port;
122 port = &siu_uart_ports[0];
124 spin_lock_irqsave(&port->lock, flags);
126 irsel = siu_read(port, SIUIRSEL);
127 if (use == FIR_USE_IRDA)
131 siu_write(port, SIUIRSEL, irsel);
133 spin_unlock_irqrestore(&port->lock, flags);
136 EXPORT_SYMBOL_GPL(vr41xx_use_irda);
138 void vr41xx_select_irda_module(irda_module_t module, irda_speed_t speed)
140 struct uart_port *port;
144 port = &siu_uart_ports[0];
146 spin_lock_irqsave(&port->lock, flags);
148 irsel = siu_read(port, SIUIRSEL);
149 irsel &= ~(IRMSEL | TMICTX | TMICMODE);
152 irsel |= IRMSEL_SHARP;
155 irsel |= IRMSEL_TEMIC | TMICMODE;
156 if (speed == IRDA_TX_4MBPS)
165 siu_write(port, SIUIRSEL, irsel);
167 spin_unlock_irqrestore(&port->lock, flags);
170 EXPORT_SYMBOL_GPL(vr41xx_select_irda_module);
172 static inline void siu_clear_fifo(struct uart_port *port)
174 siu_write(port, UART_FCR, UART_FCR_ENABLE_FIFO);
175 siu_write(port, UART_FCR, UART_FCR_ENABLE_FIFO | UART_FCR_CLEAR_RCVR |
176 UART_FCR_CLEAR_XMIT);
177 siu_write(port, UART_FCR, 0);
180 static inline int siu_probe_ports(void)
182 switch (current_cpu_data.cputype) {
185 return SIU_TYPE1_NR_PORTS;
189 return SIU_TYPE2_NR_PORTS;
195 static inline unsigned long siu_port_size(struct uart_port *port)
197 switch (port->type) {
198 case PORT_VR41XX_SIU:
200 case PORT_VR41XX_DSIU:
207 static inline unsigned int siu_check_type(struct uart_port *port)
209 switch (current_cpu_data.cputype) {
213 return PORT_VR41XX_SIU;
219 return PORT_VR41XX_SIU;
220 else if (port->line == 1)
221 return PORT_VR41XX_DSIU;
228 static inline const char *siu_type_name(struct uart_port *port)
230 switch (port->type) {
231 case PORT_VR41XX_SIU:
233 case PORT_VR41XX_DSIU:
240 static unsigned int siu_tx_empty(struct uart_port *port)
244 lsr = siu_read(port, UART_LSR);
245 if (lsr & UART_LSR_TEMT)
251 static void siu_set_mctrl(struct uart_port *port, unsigned int mctrl)
255 if (mctrl & TIOCM_DTR)
257 if (mctrl & TIOCM_RTS)
259 if (mctrl & TIOCM_OUT1)
260 mcr |= UART_MCR_OUT1;
261 if (mctrl & TIOCM_OUT2)
262 mcr |= UART_MCR_OUT2;
263 if (mctrl & TIOCM_LOOP)
264 mcr |= UART_MCR_LOOP;
266 siu_write(port, UART_MCR, mcr);
269 static unsigned int siu_get_mctrl(struct uart_port *port)
272 unsigned int mctrl = 0;
274 msr = siu_read(port, UART_MSR);
275 if (msr & UART_MSR_DCD)
277 if (msr & UART_MSR_RI)
279 if (msr & UART_MSR_DSR)
281 if (msr & UART_MSR_CTS)
287 static void siu_stop_tx(struct uart_port *port)
292 spin_lock_irqsave(&port->lock, flags);
294 ier = siu_read(port, UART_IER);
295 ier &= ~UART_IER_THRI;
296 siu_write(port, UART_IER, ier);
298 spin_unlock_irqrestore(&port->lock, flags);
301 static void siu_start_tx(struct uart_port *port)
306 spin_lock_irqsave(&port->lock, flags);
308 ier = siu_read(port, UART_IER);
309 ier |= UART_IER_THRI;
310 siu_write(port, UART_IER, ier);
312 spin_unlock_irqrestore(&port->lock, flags);
315 static void siu_stop_rx(struct uart_port *port)
320 spin_lock_irqsave(&port->lock, flags);
322 ier = siu_read(port, UART_IER);
323 ier &= ~UART_IER_RLSI;
324 siu_write(port, UART_IER, ier);
326 port->read_status_mask &= ~UART_LSR_DR;
328 spin_unlock_irqrestore(&port->lock, flags);
331 static void siu_enable_ms(struct uart_port *port)
336 spin_lock_irqsave(&port->lock, flags);
338 ier = siu_read(port, UART_IER);
340 siu_write(port, UART_IER, ier);
342 spin_unlock_irqrestore(&port->lock, flags);
345 static void siu_break_ctl(struct uart_port *port, int ctl)
350 spin_lock_irqsave(&port->lock, flags);
352 lcr = siu_read(port, UART_LCR);
356 lcr &= ~UART_LCR_SBC;
357 siu_write(port, UART_LCR, lcr);
359 spin_unlock_irqrestore(&port->lock, flags);
362 static inline void receive_chars(struct uart_port *port, uint8_t *status)
364 struct tty_struct *tty;
367 int max_count = RX_MAX_COUNT;
369 tty = port->info->tty;
373 ch = siu_read(port, UART_RX);
377 #ifdef CONFIG_SERIAL_VR41XX_CONSOLE
378 lsr |= lsr_break_flag[port->line];
379 lsr_break_flag[port->line] = 0;
381 if (unlikely(lsr & (UART_LSR_BI | UART_LSR_FE |
382 UART_LSR_PE | UART_LSR_OE))) {
383 if (lsr & UART_LSR_BI) {
384 lsr &= ~(UART_LSR_FE | UART_LSR_PE);
387 if (uart_handle_break(port))
391 if (lsr & UART_LSR_FE)
392 port->icount.frame++;
393 if (lsr & UART_LSR_PE)
394 port->icount.parity++;
395 if (lsr & UART_LSR_OE)
396 port->icount.overrun++;
398 lsr &= port->read_status_mask;
399 if (lsr & UART_LSR_BI)
401 if (lsr & UART_LSR_FE)
403 if (lsr & UART_LSR_PE)
407 if (uart_handle_sysrq_char(port, ch))
410 uart_insert_char(port, lsr, UART_LSR_OE, ch, flag);
413 lsr = siu_read(port, UART_LSR);
414 } while ((lsr & UART_LSR_DR) && (max_count-- > 0));
416 tty_flip_buffer_push(tty);
421 static inline void check_modem_status(struct uart_port *port)
425 msr = siu_read(port, UART_MSR);
426 if ((msr & UART_MSR_ANY_DELTA) == 0)
428 if (msr & UART_MSR_DDCD)
429 uart_handle_dcd_change(port, msr & UART_MSR_DCD);
430 if (msr & UART_MSR_TERI)
432 if (msr & UART_MSR_DDSR)
434 if (msr & UART_MSR_DCTS)
435 uart_handle_cts_change(port, msr & UART_MSR_CTS);
437 wake_up_interruptible(&port->info->delta_msr_wait);
440 static inline void transmit_chars(struct uart_port *port)
442 struct circ_buf *xmit;
443 int max_count = TX_MAX_COUNT;
445 xmit = &port->info->xmit;
448 siu_write(port, UART_TX, port->x_char);
454 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
460 siu_write(port, UART_TX, xmit->buf[xmit->tail]);
461 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
463 if (uart_circ_empty(xmit))
465 } while (max_count-- > 0);
467 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
468 uart_write_wakeup(port);
470 if (uart_circ_empty(xmit))
474 static irqreturn_t siu_interrupt(int irq, void *dev_id)
476 struct uart_port *port;
479 port = (struct uart_port *)dev_id;
481 iir = siu_read(port, UART_IIR);
482 if (iir & UART_IIR_NO_INT)
485 lsr = siu_read(port, UART_LSR);
486 if (lsr & UART_LSR_DR)
487 receive_chars(port, &lsr);
489 check_modem_status(port);
491 if (lsr & UART_LSR_THRE)
492 transmit_chars(port);
497 static int siu_startup(struct uart_port *port)
501 if (port->membase == NULL)
504 siu_clear_fifo(port);
506 (void)siu_read(port, UART_LSR);
507 (void)siu_read(port, UART_RX);
508 (void)siu_read(port, UART_IIR);
509 (void)siu_read(port, UART_MSR);
511 if (siu_read(port, UART_LSR) == 0xff)
514 retval = request_irq(port->irq, siu_interrupt, 0, siu_type_name(port), port);
518 if (port->type == PORT_VR41XX_DSIU)
519 vr41xx_enable_dsiuint(DSIUINT_ALL);
521 siu_write(port, UART_LCR, UART_LCR_WLEN8);
523 spin_lock_irq(&port->lock);
524 siu_set_mctrl(port, port->mctrl);
525 spin_unlock_irq(&port->lock);
527 siu_write(port, UART_IER, UART_IER_RLSI | UART_IER_RDI);
529 (void)siu_read(port, UART_LSR);
530 (void)siu_read(port, UART_RX);
531 (void)siu_read(port, UART_IIR);
532 (void)siu_read(port, UART_MSR);
537 static void siu_shutdown(struct uart_port *port)
542 siu_write(port, UART_IER, 0);
544 spin_lock_irqsave(&port->lock, flags);
546 port->mctrl &= ~TIOCM_OUT2;
547 siu_set_mctrl(port, port->mctrl);
549 spin_unlock_irqrestore(&port->lock, flags);
551 lcr = siu_read(port, UART_LCR);
552 lcr &= ~UART_LCR_SBC;
553 siu_write(port, UART_LCR, lcr);
555 siu_clear_fifo(port);
557 (void)siu_read(port, UART_RX);
559 if (port->type == PORT_VR41XX_DSIU)
560 vr41xx_disable_dsiuint(DSIUINT_ALL);
562 free_irq(port->irq, port);
565 static void siu_set_termios(struct uart_port *port, struct ktermios *new,
566 struct ktermios *old)
568 tcflag_t c_cflag, c_iflag;
569 uint8_t lcr, fcr, ier;
570 unsigned int baud, quot;
573 c_cflag = new->c_cflag;
574 switch (c_cflag & CSIZE) {
576 lcr = UART_LCR_WLEN5;
579 lcr = UART_LCR_WLEN6;
582 lcr = UART_LCR_WLEN7;
585 lcr = UART_LCR_WLEN8;
589 if (c_cflag & CSTOPB)
590 lcr |= UART_LCR_STOP;
591 if (c_cflag & PARENB)
592 lcr |= UART_LCR_PARITY;
593 if ((c_cflag & PARODD) != PARODD)
594 lcr |= UART_LCR_EPAR;
595 if (c_cflag & CMSPAR)
596 lcr |= UART_LCR_SPAR;
598 baud = uart_get_baud_rate(port, new, old, 0, port->uartclk/16);
599 quot = uart_get_divisor(port, baud);
601 fcr = UART_FCR_ENABLE_FIFO | UART_FCR_R_TRIG_10;
603 spin_lock_irqsave(&port->lock, flags);
605 uart_update_timeout(port, c_cflag, baud);
607 c_iflag = new->c_iflag;
609 port->read_status_mask = UART_LSR_THRE | UART_LSR_OE | UART_LSR_DR;
611 port->read_status_mask |= UART_LSR_FE | UART_LSR_PE;
612 if (c_iflag & (BRKINT | PARMRK))
613 port->read_status_mask |= UART_LSR_BI;
615 port->ignore_status_mask = 0;
616 if (c_iflag & IGNPAR)
617 port->ignore_status_mask |= UART_LSR_FE | UART_LSR_PE;
618 if (c_iflag & IGNBRK) {
619 port->ignore_status_mask |= UART_LSR_BI;
620 if (c_iflag & IGNPAR)
621 port->ignore_status_mask |= UART_LSR_OE;
624 if ((c_cflag & CREAD) == 0)
625 port->ignore_status_mask |= UART_LSR_DR;
627 ier = siu_read(port, UART_IER);
628 ier &= ~UART_IER_MSI;
629 if (UART_ENABLE_MS(port, c_cflag))
631 siu_write(port, UART_IER, ier);
633 siu_write(port, UART_LCR, lcr | UART_LCR_DLAB);
635 siu_write(port, UART_DLL, (uint8_t)quot);
636 siu_write(port, UART_DLM, (uint8_t)(quot >> 8));
638 siu_write(port, UART_LCR, lcr);
640 siu_write(port, UART_FCR, fcr);
642 siu_set_mctrl(port, port->mctrl);
644 spin_unlock_irqrestore(&port->lock, flags);
647 static void siu_pm(struct uart_port *port, unsigned int state, unsigned int oldstate)
651 switch (port->type) {
652 case PORT_VR41XX_SIU:
653 vr41xx_supply_clock(SIU_CLOCK);
655 case PORT_VR41XX_DSIU:
656 vr41xx_supply_clock(DSIU_CLOCK);
661 switch (port->type) {
662 case PORT_VR41XX_SIU:
663 vr41xx_mask_clock(SIU_CLOCK);
665 case PORT_VR41XX_DSIU:
666 vr41xx_mask_clock(DSIU_CLOCK);
673 static const char *siu_type(struct uart_port *port)
675 return siu_type_name(port);
678 static void siu_release_port(struct uart_port *port)
682 if (port->flags & UPF_IOREMAP) {
683 iounmap(port->membase);
684 port->membase = NULL;
687 size = siu_port_size(port);
688 release_mem_region(port->mapbase, size);
691 static int siu_request_port(struct uart_port *port)
694 struct resource *res;
696 size = siu_port_size(port);
697 res = request_mem_region(port->mapbase, size, siu_type_name(port));
701 if (port->flags & UPF_IOREMAP) {
702 port->membase = ioremap(port->mapbase, size);
703 if (port->membase == NULL) {
704 release_resource(res);
712 static void siu_config_port(struct uart_port *port, int flags)
714 if (flags & UART_CONFIG_TYPE) {
715 port->type = siu_check_type(port);
716 (void)siu_request_port(port);
720 static int siu_verify_port(struct uart_port *port, struct serial_struct *serial)
722 if (port->type != PORT_VR41XX_SIU && port->type != PORT_VR41XX_DSIU)
724 if (port->irq != serial->irq)
726 if (port->iotype != serial->io_type)
728 if (port->mapbase != (unsigned long)serial->iomem_base)
734 static struct uart_ops siu_uart_ops = {
735 .tx_empty = siu_tx_empty,
736 .set_mctrl = siu_set_mctrl,
737 .get_mctrl = siu_get_mctrl,
738 .stop_tx = siu_stop_tx,
739 .start_tx = siu_start_tx,
740 .stop_rx = siu_stop_rx,
741 .enable_ms = siu_enable_ms,
742 .break_ctl = siu_break_ctl,
743 .startup = siu_startup,
744 .shutdown = siu_shutdown,
745 .set_termios = siu_set_termios,
748 .release_port = siu_release_port,
749 .request_port = siu_request_port,
750 .config_port = siu_config_port,
751 .verify_port = siu_verify_port,
754 static int siu_init_ports(void)
756 const struct siu_port *siu;
757 struct uart_port *port;
760 switch (current_cpu_data.cputype) {
763 siu = siu_type1_ports;
768 siu = siu_type2_ports;
774 port = siu_uart_ports;
775 num = siu_probe_ports();
776 for (i = 0; i < num; i++) {
777 spin_lock_init(&port->lock);
778 port->irq = siu->irq;
779 port->uartclk = SIU_BAUD_BASE * 16;
782 port->iotype = UPIO_MEM;
783 port->flags = UPF_IOREMAP | UPF_BOOT_AUTOCONF;
784 port->type = siu->type;
786 port->mapbase = siu->start;
794 #ifdef CONFIG_SERIAL_VR41XX_CONSOLE
796 #define BOTH_EMPTY (UART_LSR_TEMT | UART_LSR_THRE)
798 static void wait_for_xmitr(struct uart_port *port)
804 lsr = siu_read(port, UART_LSR);
805 if (lsr & UART_LSR_BI)
806 lsr_break_flag[port->line] = UART_LSR_BI;
808 if ((lsr & BOTH_EMPTY) == BOTH_EMPTY)
810 } while (timeout-- > 0);
812 if (port->flags & UPF_CONS_FLOW) {
816 msr = siu_read(port, UART_MSR);
817 if ((msr & UART_MSR_CTS) != 0)
819 } while (timeout-- > 0);
823 static void siu_console_putchar(struct uart_port *port, int ch)
825 wait_for_xmitr(port);
826 siu_write(port, UART_TX, ch);
829 static void siu_console_write(struct console *con, const char *s, unsigned count)
831 struct uart_port *port;
834 port = &siu_uart_ports[con->index];
836 ier = siu_read(port, UART_IER);
837 siu_write(port, UART_IER, 0);
839 uart_console_write(port, s, count, siu_console_putchar);
841 wait_for_xmitr(port);
842 siu_write(port, UART_IER, ier);
845 static int siu_console_setup(struct console *con, char *options)
847 struct uart_port *port;
853 if (con->index >= SIU_PORTS_MAX)
856 port = &siu_uart_ports[con->index];
857 if (port->membase == NULL) {
858 if (port->mapbase == 0)
860 port->membase = ioremap(port->mapbase, siu_port_size(port));
863 vr41xx_select_siu_interface(SIU_INTERFACE_RS232C);
866 uart_parse_options(options, &baud, &parity, &bits, &flow);
868 return uart_set_options(port, con, baud, parity, bits, flow);
871 static struct uart_driver siu_uart_driver;
873 static struct console siu_console = {
875 .write = siu_console_write,
876 .device = uart_console_device,
877 .setup = siu_console_setup,
878 .flags = CON_PRINTBUFFER,
880 .data = &siu_uart_driver,
883 static int __devinit siu_console_init(void)
885 struct uart_port *port;
888 num = siu_init_ports();
892 for (i = 0; i < num; i++) {
893 port = &siu_uart_ports[i];
894 port->ops = &siu_uart_ops;
897 register_console(&siu_console);
902 console_initcall(siu_console_init);
904 #define SERIAL_VR41XX_CONSOLE &siu_console
906 #define SERIAL_VR41XX_CONSOLE NULL
909 static struct uart_driver siu_uart_driver = {
910 .owner = THIS_MODULE,
911 .driver_name = "SIU",
914 .minor = SIU_MINOR_BASE,
915 .cons = SERIAL_VR41XX_CONSOLE,
918 static int __devinit siu_probe(struct platform_device *dev)
920 struct uart_port *port;
923 num = siu_init_ports();
927 siu_uart_driver.nr = num;
928 retval = uart_register_driver(&siu_uart_driver);
932 for (i = 0; i < num; i++) {
933 port = &siu_uart_ports[i];
934 port->ops = &siu_uart_ops;
935 port->dev = &dev->dev;
937 retval = uart_add_one_port(&siu_uart_driver, port);
944 if (i == 0 && retval < 0) {
945 uart_unregister_driver(&siu_uart_driver);
952 static int __devexit siu_remove(struct platform_device *dev)
954 struct uart_port *port;
957 for (i = 0; i < siu_uart_driver.nr; i++) {
958 port = &siu_uart_ports[i];
959 if (port->dev == &dev->dev) {
960 uart_remove_one_port(&siu_uart_driver, port);
965 uart_unregister_driver(&siu_uart_driver);
970 static int siu_suspend(struct platform_device *dev, pm_message_t state)
972 struct uart_port *port;
975 for (i = 0; i < siu_uart_driver.nr; i++) {
976 port = &siu_uart_ports[i];
977 if ((port->type == PORT_VR41XX_SIU ||
978 port->type == PORT_VR41XX_DSIU) && port->dev == &dev->dev)
979 uart_suspend_port(&siu_uart_driver, port);
986 static int siu_resume(struct platform_device *dev)
988 struct uart_port *port;
991 for (i = 0; i < siu_uart_driver.nr; i++) {
992 port = &siu_uart_ports[i];
993 if ((port->type == PORT_VR41XX_SIU ||
994 port->type == PORT_VR41XX_DSIU) && port->dev == &dev->dev)
995 uart_resume_port(&siu_uart_driver, port);
1001 static struct platform_device *siu_platform_device;
1003 static struct platform_driver siu_device_driver = {
1005 .remove = __devexit_p(siu_remove),
1006 .suspend = siu_suspend,
1007 .resume = siu_resume,
1010 .owner = THIS_MODULE,
1014 static int __init vr41xx_siu_init(void)
1018 siu_platform_device = platform_device_alloc("SIU", -1);
1019 if (!siu_platform_device)
1022 retval = platform_device_add(siu_platform_device);
1024 platform_device_put(siu_platform_device);
1028 retval = platform_driver_register(&siu_device_driver);
1030 platform_device_unregister(siu_platform_device);
1035 static void __exit vr41xx_siu_exit(void)
1037 platform_driver_unregister(&siu_device_driver);
1038 platform_device_unregister(siu_platform_device);
1041 module_init(vr41xx_siu_init);
1042 module_exit(vr41xx_siu_exit);