2 * drivers/serial/sh-sci.c
4 * SuperH on-chip serial module support. (SCI with no FIFO / with FIFO)
6 * Copyright (C) 2002 - 2008 Paul Mundt
7 * Modified to support SH7720 SCIF. Markus Brunner, Mark Jonas (Jul 2007).
9 * based off of the old drivers/char/sh-sci.c by:
11 * Copyright (C) 1999, 2000 Niibe Yutaka
12 * Copyright (C) 2000 Sugioka Toshinobu
13 * Modified to support multiple serial ports. Stuart Menefy (May 2000).
14 * Modified to support SecureEdge. David McCullough (2002)
15 * Modified to support SH7300 SCIF. Takashi Kusuda (Jun 2003).
16 * Removed SH7300 support (Jul 2007).
18 * This file is subject to the terms and conditions of the GNU General Public
19 * License. See the file "COPYING" in the main directory of this archive
22 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
28 #include <linux/module.h>
29 #include <linux/errno.h>
30 #include <linux/timer.h>
31 #include <linux/interrupt.h>
32 #include <linux/tty.h>
33 #include <linux/tty_flip.h>
34 #include <linux/serial.h>
35 #include <linux/major.h>
36 #include <linux/string.h>
37 #include <linux/sysrq.h>
38 #include <linux/ioport.h>
40 #include <linux/init.h>
41 #include <linux/delay.h>
42 #include <linux/console.h>
43 #include <linux/platform_device.h>
44 #include <linux/serial_sci.h>
45 #include <linux/notifier.h>
46 #include <linux/cpufreq.h>
47 #include <linux/clk.h>
48 #include <linux/ctype.h>
49 #include <linux/err.h>
52 #include <asm/clock.h>
53 #include <asm/sh_bios.h>
60 struct uart_port port;
65 /* Port IRQs: ERI, RXI, TXI, BRI (optional) */
66 unsigned int irqs[SCIx_NR_IRQS];
68 /* Port pin configuration */
69 void (*init_pins)(struct uart_port *port,
72 /* Port enable callback */
73 void (*enable)(struct uart_port *port);
75 /* Port disable callback */
76 void (*disable)(struct uart_port *port);
79 struct timer_list break_timer;
82 #ifdef CONFIG_HAVE_CLK
89 static struct sci_port *kgdb_sci_port;
92 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
93 static struct sci_port *serial_console_port;
96 /* Function prototypes */
97 static void sci_stop_tx(struct uart_port *port);
99 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
101 static struct sci_port sci_ports[SCI_NPORTS];
102 static struct uart_driver sci_uart_driver;
104 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && \
105 defined(CONFIG_SH_STANDARD_BIOS) || defined(CONFIG_SH_KGDB)
106 static inline void handle_error(struct uart_port *port)
108 /* Clear error flags */
109 sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
112 static int get_char(struct uart_port *port)
115 unsigned short status;
118 spin_lock_irqsave(&port->lock, flags);
120 status = sci_in(port, SCxSR);
121 if (status & SCxSR_ERRORS(port)) {
125 } while (!(status & SCxSR_RDxF(port)));
126 c = sci_in(port, SCxRDR);
127 sci_in(port, SCxSR); /* Dummy read */
128 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
129 spin_unlock_irqrestore(&port->lock, flags);
133 #endif /* CONFIG_SH_STANDARD_BIOS || CONFIG_SH_KGDB */
135 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || defined(CONFIG_SH_KGDB)
136 static void put_char(struct uart_port *port, char c)
139 unsigned short status;
141 spin_lock_irqsave(&port->lock, flags);
144 status = sci_in(port, SCxSR);
145 } while (!(status & SCxSR_TDxE(port)));
147 sci_out(port, SCxTDR, c);
148 sci_in(port, SCxSR); /* Dummy read */
149 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
151 spin_unlock_irqrestore(&port->lock, flags);
155 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
156 static void put_string(struct sci_port *sci_port, const char *buffer, int count)
158 struct uart_port *port = &sci_port->port;
159 const unsigned char *p = buffer;
162 #if defined(CONFIG_SH_STANDARD_BIOS) || defined(CONFIG_SH_KGDB)
166 #ifdef CONFIG_SH_STANDARD_BIOS
167 /* This call only does a trap the first time it is
168 * called, and so is safe to do here unconditionally
170 usegdb |= sh_bios_in_gdb_mode();
172 #ifdef CONFIG_SH_KGDB
173 usegdb |= (kgdb_in_gdb_mode && (sci_port == kgdb_sci_port));
177 /* $<packet info>#<checksum>. */
181 put_char(port, 'O'); /* 'O'utput to console */
184 for (i=0; i<count; i++) { /* Don't use run length encoding */
195 put_char(port, hex_asc_hi(checksum));
196 put_char(port, hex_asc_lo(checksum));
197 } while (get_char(port) != '+');
199 #endif /* CONFIG_SH_STANDARD_BIOS || CONFIG_SH_KGDB */
200 for (i=0; i<count; i++) {
202 put_char(port, '\r');
203 put_char(port, *p++);
206 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
208 #ifdef CONFIG_SH_KGDB
209 static int kgdb_sci_getchar(void)
213 /* Keep trying to read a character, this could be neater */
214 while ((c = get_char(&kgdb_sci_port->port)) < 0)
220 static inline void kgdb_sci_putchar(int c)
222 put_char(&kgdb_sci_port->port, c);
224 #endif /* CONFIG_SH_KGDB */
226 #if defined(__H8300S__)
227 enum { sci_disable, sci_enable };
229 static void h8300_sci_config(struct uart_port* port, unsigned int ctrl)
231 volatile unsigned char *mstpcrl=(volatile unsigned char *)MSTPCRL;
232 int ch = (port->mapbase - SMR0) >> 3;
233 unsigned char mask = 1 << (ch+1);
235 if (ctrl == sci_disable) {
242 static inline void h8300_sci_enable(struct uart_port *port)
244 h8300_sci_config(port, sci_enable);
247 static inline void h8300_sci_disable(struct uart_port *port)
249 h8300_sci_config(port, sci_disable);
253 #if defined(SCI_ONLY) || defined(SCI_AND_SCIF) && \
254 defined(__H8300H__) || defined(__H8300S__)
255 static void sci_init_pins_sci(struct uart_port* port, unsigned int cflag)
257 int ch = (port->mapbase - SMR0) >> 3;
260 H8300_GPIO_DDR(h8300_sci_pins[ch].port,
261 h8300_sci_pins[ch].rx,
263 H8300_GPIO_DDR(h8300_sci_pins[ch].port,
264 h8300_sci_pins[ch].tx,
268 H8300_SCI_DR(ch) |= h8300_sci_pins[ch].tx;
271 #define sci_init_pins_sci NULL
274 #if defined(CONFIG_CPU_SUBTYPE_SH7707) || defined(CONFIG_CPU_SUBTYPE_SH7709)
275 static void sci_init_pins_irda(struct uart_port *port, unsigned int cflag)
277 unsigned int fcr_val = 0;
280 fcr_val |= SCFCR_MCE;
282 sci_out(port, SCFCR, fcr_val);
285 #define sci_init_pins_irda NULL
289 #define sci_init_pins_scif NULL
292 #if defined(SCIF_ONLY) || defined(SCI_AND_SCIF)
293 #if defined(CONFIG_CPU_SUBTYPE_SH7710) || defined(CONFIG_CPU_SUBTYPE_SH7712)
294 static void sci_init_pins_scif(struct uart_port* port, unsigned int cflag)
296 unsigned int fcr_val = 0;
298 set_sh771x_scif_pfc(port);
299 if (cflag & CRTSCTS) {
300 fcr_val |= SCFCR_MCE;
302 sci_out(port, SCFCR, fcr_val);
304 #elif defined(CONFIG_CPU_SUBTYPE_SH7720) || defined(CONFIG_CPU_SUBTYPE_SH7721)
305 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
307 unsigned int fcr_val = 0;
310 if (cflag & CRTSCTS) {
312 if (port->mapbase == 0xa4430000) { /* SCIF0 */
313 /* Clear PTCR bit 9-2; enable all scif pins but sck */
314 data = ctrl_inw(PORT_PTCR);
315 ctrl_outw((data & 0xfc03), PORT_PTCR);
316 } else if (port->mapbase == 0xa4438000) { /* SCIF1 */
317 /* Clear PVCR bit 9-2 */
318 data = ctrl_inw(PORT_PVCR);
319 ctrl_outw((data & 0xfc03), PORT_PVCR);
321 fcr_val |= SCFCR_MCE;
323 if (port->mapbase == 0xa4430000) { /* SCIF0 */
324 /* Clear PTCR bit 5-2; enable only tx and rx */
325 data = ctrl_inw(PORT_PTCR);
326 ctrl_outw((data & 0xffc3), PORT_PTCR);
327 } else if (port->mapbase == 0xa4438000) { /* SCIF1 */
328 /* Clear PVCR bit 5-2 */
329 data = ctrl_inw(PORT_PVCR);
330 ctrl_outw((data & 0xffc3), PORT_PVCR);
333 sci_out(port, SCFCR, fcr_val);
335 #elif defined(CONFIG_CPU_SH3)
336 /* For SH7705, SH7706, SH7707, SH7709, SH7709A, SH7729 */
337 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
339 unsigned int fcr_val = 0;
342 /* We need to set SCPCR to enable RTS/CTS */
343 data = ctrl_inw(SCPCR);
344 /* Clear out SCP7MD1,0, SCP6MD1,0, SCP4MD1,0*/
345 ctrl_outw(data & 0x0fcf, SCPCR);
348 fcr_val |= SCFCR_MCE;
350 /* We need to set SCPCR to enable RTS/CTS */
351 data = ctrl_inw(SCPCR);
352 /* Clear out SCP7MD1,0, SCP4MD1,0,
353 Set SCP6MD1,0 = {01} (output) */
354 ctrl_outw((data & 0x0fcf) | 0x1000, SCPCR);
356 data = ctrl_inb(SCPDR);
357 /* Set /RTS2 (bit6) = 0 */
358 ctrl_outb(data & 0xbf, SCPDR);
361 sci_out(port, SCFCR, fcr_val);
363 #elif defined(CONFIG_CPU_SUBTYPE_SH7722)
364 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
366 unsigned int fcr_val = 0;
369 if (port->mapbase == 0xffe00000) {
370 data = ctrl_inw(PSCR);
373 fcr_val |= SCFCR_MCE;
377 ctrl_outw(data, PSCR);
379 /* SCIF1 and SCIF2 should be setup by board code */
381 sci_out(port, SCFCR, fcr_val);
383 #elif defined(CONFIG_CPU_SUBTYPE_SH7723)
384 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
386 /* Nothing to do here.. */
387 sci_out(port, SCFCR, 0);
391 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
393 unsigned int fcr_val = 0;
395 if (cflag & CRTSCTS) {
396 fcr_val |= SCFCR_MCE;
398 #if defined(CONFIG_CPU_SUBTYPE_SH7343) || defined(CONFIG_CPU_SUBTYPE_SH7366)
400 #elif defined(CONFIG_CPU_SUBTYPE_SH7763) || \
401 defined(CONFIG_CPU_SUBTYPE_SH7780) || \
402 defined(CONFIG_CPU_SUBTYPE_SH7785) || \
403 defined(CONFIG_CPU_SUBTYPE_SHX3)
404 ctrl_outw(0x0080, SCSPTR0); /* Set RTS = 1 */
406 ctrl_outw(0x0080, SCSPTR2); /* Set RTS = 1 */
409 sci_out(port, SCFCR, fcr_val);
413 #if defined(CONFIG_CPU_SUBTYPE_SH7760) || \
414 defined(CONFIG_CPU_SUBTYPE_SH7780) || \
415 defined(CONFIG_CPU_SUBTYPE_SH7785)
416 static inline int scif_txroom(struct uart_port *port)
418 return SCIF_TXROOM_MAX - (sci_in(port, SCTFDR) & 0xff);
421 static inline int scif_rxroom(struct uart_port *port)
423 return sci_in(port, SCRFDR) & 0xff;
425 #elif defined(CONFIG_CPU_SUBTYPE_SH7763)
426 static inline int scif_txroom(struct uart_port *port)
428 if((port->mapbase == 0xffe00000) || (port->mapbase == 0xffe08000)) /* SCIF0/1*/
429 return SCIF_TXROOM_MAX - (sci_in(port, SCTFDR) & 0xff);
431 return SCIF2_TXROOM_MAX - (sci_in(port, SCFDR) >> 8);
434 static inline int scif_rxroom(struct uart_port *port)
436 if((port->mapbase == 0xffe00000) || (port->mapbase == 0xffe08000)) /* SCIF0/1*/
437 return sci_in(port, SCRFDR) & 0xff;
439 return sci_in(port, SCFDR) & SCIF2_RFDC_MASK;
442 static inline int scif_txroom(struct uart_port *port)
444 return SCIF_TXROOM_MAX - (sci_in(port, SCFDR) >> 8);
447 static inline int scif_rxroom(struct uart_port *port)
449 return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
452 #endif /* SCIF_ONLY || SCI_AND_SCIF */
454 static inline int sci_txroom(struct uart_port *port)
456 return ((sci_in(port, SCxSR) & SCI_TDRE) != 0);
459 static inline int sci_rxroom(struct uart_port *port)
461 return ((sci_in(port, SCxSR) & SCxSR_RDxF(port)) != 0);
464 /* ********************************************************************** *
465 * the interrupt related routines *
466 * ********************************************************************** */
468 static void sci_transmit_chars(struct uart_port *port)
470 struct circ_buf *xmit = &port->info->xmit;
471 unsigned int stopped = uart_tx_stopped(port);
472 unsigned short status;
476 status = sci_in(port, SCxSR);
477 if (!(status & SCxSR_TDxE(port))) {
478 ctrl = sci_in(port, SCSCR);
479 if (uart_circ_empty(xmit)) {
480 ctrl &= ~SCI_CTRL_FLAGS_TIE;
482 ctrl |= SCI_CTRL_FLAGS_TIE;
484 sci_out(port, SCSCR, ctrl);
489 if (port->type == PORT_SCIF)
490 count = scif_txroom(port);
493 count = sci_txroom(port);
501 } else if (!uart_circ_empty(xmit) && !stopped) {
502 c = xmit->buf[xmit->tail];
503 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
508 sci_out(port, SCxTDR, c);
511 } while (--count > 0);
513 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
515 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
516 uart_write_wakeup(port);
517 if (uart_circ_empty(xmit)) {
520 ctrl = sci_in(port, SCSCR);
522 #if !defined(SCI_ONLY)
523 if (port->type == PORT_SCIF) {
524 sci_in(port, SCxSR); /* Dummy read */
525 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
529 ctrl |= SCI_CTRL_FLAGS_TIE;
530 sci_out(port, SCSCR, ctrl);
534 /* On SH3, SCIF may read end-of-break as a space->mark char */
535 #define STEPFN(c) ({int __c=(c); (((__c-1)|(__c)) == -1); })
537 static inline void sci_receive_chars(struct uart_port *port)
539 struct sci_port *sci_port = (struct sci_port *)port;
540 struct tty_struct *tty = port->info->port.tty;
541 int i, count, copied = 0;
542 unsigned short status;
545 status = sci_in(port, SCxSR);
546 if (!(status & SCxSR_RDxF(port)))
550 #if !defined(SCI_ONLY)
551 if (port->type == PORT_SCIF)
552 count = scif_rxroom(port);
555 count = sci_rxroom(port);
557 /* Don't copy more bytes than there is room for in the buffer */
558 count = tty_buffer_request_room(tty, count);
560 /* If for any reason we can't copy more data, we're done! */
564 if (port->type == PORT_SCI) {
565 char c = sci_in(port, SCxRDR);
566 if (uart_handle_sysrq_char(port, c) || sci_port->break_flag)
569 tty_insert_flip_char(tty, c, TTY_NORMAL);
572 for (i=0; i<count; i++) {
573 char c = sci_in(port, SCxRDR);
574 status = sci_in(port, SCxSR);
575 #if defined(CONFIG_CPU_SH3)
576 /* Skip "chars" during break */
577 if (sci_port->break_flag) {
579 (status & SCxSR_FER(port))) {
584 /* Nonzero => end-of-break */
585 pr_debug("scif: debounce<%02x>\n", c);
586 sci_port->break_flag = 0;
593 #endif /* CONFIG_CPU_SH3 */
594 if (uart_handle_sysrq_char(port, c)) {
599 /* Store data and status */
600 if (status&SCxSR_FER(port)) {
602 pr_debug("sci: frame error\n");
603 } else if (status&SCxSR_PER(port)) {
605 pr_debug("sci: parity error\n");
608 tty_insert_flip_char(tty, c, flag);
612 sci_in(port, SCxSR); /* dummy read */
613 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
616 port->icount.rx += count;
620 /* Tell the rest of the system the news. New characters! */
621 tty_flip_buffer_push(tty);
623 sci_in(port, SCxSR); /* dummy read */
624 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
628 #define SCI_BREAK_JIFFIES (HZ/20)
629 /* The sci generates interrupts during the break,
630 * 1 per millisecond or so during the break period, for 9600 baud.
631 * So dont bother disabling interrupts.
632 * But dont want more than 1 break event.
633 * Use a kernel timer to periodically poll the rx line until
634 * the break is finished.
636 static void sci_schedule_break_timer(struct sci_port *port)
638 port->break_timer.expires = jiffies + SCI_BREAK_JIFFIES;
639 add_timer(&port->break_timer);
641 /* Ensure that two consecutive samples find the break over. */
642 static void sci_break_timer(unsigned long data)
644 struct sci_port *port = (struct sci_port *)data;
646 if (sci_rxd_in(&port->port) == 0) {
647 port->break_flag = 1;
648 sci_schedule_break_timer(port);
649 } else if (port->break_flag == 1) {
651 port->break_flag = 2;
652 sci_schedule_break_timer(port);
654 port->break_flag = 0;
657 static inline int sci_handle_errors(struct uart_port *port)
660 unsigned short status = sci_in(port, SCxSR);
661 struct tty_struct *tty = port->info->port.tty;
663 if (status & SCxSR_ORER(port)) {
665 if (tty_insert_flip_char(tty, 0, TTY_OVERRUN))
667 pr_debug("sci: overrun error\n");
670 if (status & SCxSR_FER(port)) {
671 if (sci_rxd_in(port) == 0) {
672 /* Notify of BREAK */
673 struct sci_port *sci_port = (struct sci_port *)port;
675 if (!sci_port->break_flag) {
676 sci_port->break_flag = 1;
677 sci_schedule_break_timer(sci_port);
679 /* Do sysrq handling. */
680 if (uart_handle_break(port))
682 pr_debug("sci: BREAK detected\n");
683 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
688 if (tty_insert_flip_char(tty, 0, TTY_FRAME))
690 pr_debug("sci: frame error\n");
694 if (status & SCxSR_PER(port)) {
696 if (tty_insert_flip_char(tty, 0, TTY_PARITY))
698 pr_debug("sci: parity error\n");
702 tty_flip_buffer_push(tty);
707 static inline int sci_handle_breaks(struct uart_port *port)
710 unsigned short status = sci_in(port, SCxSR);
711 struct tty_struct *tty = port->info->port.tty;
712 struct sci_port *s = &sci_ports[port->line];
714 if (uart_handle_break(port))
717 if (!s->break_flag && status & SCxSR_BRK(port)) {
718 #if defined(CONFIG_CPU_SH3)
722 /* Notify of BREAK */
723 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
725 pr_debug("sci: BREAK detected\n");
728 #if defined(SCIF_ORER)
729 /* XXX: Handle SCIF overrun error */
730 if (port->type == PORT_SCIF && (sci_in(port, SCLSR) & SCIF_ORER) != 0) {
731 sci_out(port, SCLSR, 0);
732 if (tty_insert_flip_char(tty, 0, TTY_OVERRUN)) {
734 pr_debug("sci: overrun error\n");
740 tty_flip_buffer_push(tty);
745 static irqreturn_t sci_rx_interrupt(int irq, void *port)
747 /* I think sci_receive_chars has to be called irrespective
748 * of whether the I_IXOFF is set, otherwise, how is the interrupt
751 sci_receive_chars(port);
756 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
758 struct uart_port *port = ptr;
760 spin_lock_irq(&port->lock);
761 sci_transmit_chars(port);
762 spin_unlock_irq(&port->lock);
767 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
769 struct uart_port *port = ptr;
772 if (port->type == PORT_SCI) {
773 if (sci_handle_errors(port)) {
774 /* discard character in rx buffer */
776 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
779 #if defined(SCIF_ORER)
780 if((sci_in(port, SCLSR) & SCIF_ORER) != 0) {
781 struct tty_struct *tty = port->info->port.tty;
783 sci_out(port, SCLSR, 0);
784 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
785 tty_flip_buffer_push(tty);
786 pr_debug("scif: overrun error\n");
789 sci_rx_interrupt(irq, ptr);
792 sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
794 /* Kick the transmission */
795 sci_tx_interrupt(irq, ptr);
800 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
802 struct uart_port *port = ptr;
805 sci_handle_breaks(port);
806 sci_out(port, SCxSR, SCxSR_BREAK_CLEAR(port));
811 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
813 unsigned short ssr_status, scr_status;
814 struct uart_port *port = ptr;
816 ssr_status = sci_in(port,SCxSR);
817 scr_status = sci_in(port,SCSCR);
820 if ((ssr_status & 0x0020) && (scr_status & 0x0080))
821 sci_tx_interrupt(irq, ptr);
823 if ((ssr_status & 0x0002) && (scr_status & 0x0040))
824 sci_rx_interrupt(irq, ptr);
825 /* Error Interrupt */
826 if ((ssr_status & 0x0080) && (scr_status & 0x0400))
827 sci_er_interrupt(irq, ptr);
828 /* Break Interrupt */
829 if ((ssr_status & 0x0010) && (scr_status & 0x0200))
830 sci_br_interrupt(irq, ptr);
835 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_HAVE_CLK)
837 * Here we define a transistion notifier so that we can update all of our
838 * ports' baud rate when the peripheral clock changes.
840 static int sci_notifier(struct notifier_block *self,
841 unsigned long phase, void *p)
843 struct cpufreq_freqs *freqs = p;
846 if ((phase == CPUFREQ_POSTCHANGE) ||
847 (phase == CPUFREQ_RESUMECHANGE)){
848 for (i = 0; i < SCI_NPORTS; i++) {
849 struct uart_port *port = &sci_ports[i].port;
853 * Update the uartclk per-port if frequency has
854 * changed, since it will no longer necessarily be
855 * consistent with the old frequency.
857 * Really we want to be able to do something like
858 * uart_change_speed() or something along those lines
859 * here to implicitly reset the per-port baud rate..
861 * Clean this up later..
863 clk = clk_get(NULL, "module_clk");
864 port->uartclk = clk_get_rate(clk);
868 printk(KERN_INFO "%s: got a postchange notification "
869 "for cpu %d (old %d, new %d)\n",
870 __func__, freqs->cpu, freqs->old, freqs->new);
876 static struct notifier_block sci_nb = { &sci_notifier, NULL, 0 };
877 #endif /* CONFIG_CPU_FREQ && CONFIG_HAVE_CLK */
879 static int sci_request_irq(struct sci_port *port)
882 irqreturn_t (*handlers[4])(int irq, void *ptr) = {
883 sci_er_interrupt, sci_rx_interrupt, sci_tx_interrupt,
886 const char *desc[] = { "SCI Receive Error", "SCI Receive Data Full",
887 "SCI Transmit Data Empty", "SCI Break" };
889 if (port->irqs[0] == port->irqs[1]) {
890 if (!port->irqs[0]) {
891 printk(KERN_ERR "sci: Cannot allocate irq.(IRQ=0)\n");
895 if (request_irq(port->irqs[0], sci_mpxed_interrupt,
896 IRQF_DISABLED, "sci", port)) {
897 printk(KERN_ERR "sci: Cannot allocate irq.\n");
901 for (i = 0; i < ARRAY_SIZE(handlers); i++) {
904 if (request_irq(port->irqs[i], handlers[i],
905 IRQF_DISABLED, desc[i], port)) {
906 printk(KERN_ERR "sci: Cannot allocate irq.\n");
915 static void sci_free_irq(struct sci_port *port)
919 if (port->irqs[0] == port->irqs[1]) {
921 printk("sci: sci_free_irq error\n");
923 free_irq(port->irqs[0], port);
925 for (i = 0; i < ARRAY_SIZE(port->irqs); i++) {
929 free_irq(port->irqs[i], port);
934 static unsigned int sci_tx_empty(struct uart_port *port)
940 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
942 /* This routine is used for seting signals of: DTR, DCD, CTS/RTS */
943 /* We use SCIF's hardware for CTS/RTS, so don't need any for that. */
944 /* If you have signals for DTR and DCD, please implement here. */
947 static unsigned int sci_get_mctrl(struct uart_port *port)
949 /* This routine is used for geting signals of: DTR, DCD, DSR, RI,
952 return TIOCM_DTR | TIOCM_RTS | TIOCM_DSR;
955 static void sci_start_tx(struct uart_port *port)
959 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
960 ctrl = sci_in(port, SCSCR);
961 ctrl |= SCI_CTRL_FLAGS_TIE;
962 sci_out(port, SCSCR, ctrl);
965 static void sci_stop_tx(struct uart_port *port)
969 /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
970 ctrl = sci_in(port, SCSCR);
971 ctrl &= ~SCI_CTRL_FLAGS_TIE;
972 sci_out(port, SCSCR, ctrl);
975 static void sci_start_rx(struct uart_port *port, unsigned int tty_start)
979 /* Set RIE (Receive Interrupt Enable) bit in SCSCR */
980 ctrl = sci_in(port, SCSCR);
981 ctrl |= SCI_CTRL_FLAGS_RIE | SCI_CTRL_FLAGS_REIE;
982 sci_out(port, SCSCR, ctrl);
985 static void sci_stop_rx(struct uart_port *port)
989 /* Clear RIE (Receive Interrupt Enable) bit in SCSCR */
990 ctrl = sci_in(port, SCSCR);
991 ctrl &= ~(SCI_CTRL_FLAGS_RIE | SCI_CTRL_FLAGS_REIE);
992 sci_out(port, SCSCR, ctrl);
995 static void sci_enable_ms(struct uart_port *port)
997 /* Nothing here yet .. */
1000 static void sci_break_ctl(struct uart_port *port, int break_state)
1002 /* Nothing here yet .. */
1005 static int sci_startup(struct uart_port *port)
1007 struct sci_port *s = &sci_ports[port->line];
1012 #ifdef CONFIG_HAVE_CLK
1013 s->clk = clk_get(NULL, "module_clk");
1018 sci_start_rx(port, 1);
1023 static void sci_shutdown(struct uart_port *port)
1025 struct sci_port *s = &sci_ports[port->line];
1034 #ifdef CONFIG_HAVE_CLK
1040 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
1041 struct ktermios *old)
1043 struct sci_port *s = &sci_ports[port->line];
1044 unsigned int status, baud, smr_val;
1047 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
1049 t = SCBRR_VALUE(baud, port->uartclk);
1052 status = sci_in(port, SCxSR);
1053 } while (!(status & SCxSR_TEND(port)));
1055 sci_out(port, SCSCR, 0x00); /* TE=0, RE=0, CKE1=0 */
1057 #if !defined(SCI_ONLY)
1058 if (port->type == PORT_SCIF)
1059 sci_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
1062 smr_val = sci_in(port, SCSMR) & 3;
1063 if ((termios->c_cflag & CSIZE) == CS7)
1065 if (termios->c_cflag & PARENB)
1067 if (termios->c_cflag & PARODD)
1069 if (termios->c_cflag & CSTOPB)
1072 uart_update_timeout(port, termios->c_cflag, baud);
1074 sci_out(port, SCSMR, smr_val);
1078 sci_out(port, SCSMR, (sci_in(port, SCSMR) & ~3) | 1);
1081 sci_out(port, SCSMR, sci_in(port, SCSMR) & ~3);
1083 sci_out(port, SCBRR, t);
1084 udelay((1000000+(baud-1)) / baud); /* Wait one bit interval */
1087 if (likely(s->init_pins))
1088 s->init_pins(port, termios->c_cflag);
1090 sci_out(port, SCSCR, SCSCR_INIT(port));
1092 if ((termios->c_cflag & CREAD) != 0)
1093 sci_start_rx(port,0);
1096 static const char *sci_type(struct uart_port *port)
1098 switch (port->type) {
1099 case PORT_SCI: return "sci";
1100 case PORT_SCIF: return "scif";
1101 case PORT_IRDA: return "irda";
1107 static void sci_release_port(struct uart_port *port)
1109 /* Nothing here yet .. */
1112 static int sci_request_port(struct uart_port *port)
1114 /* Nothing here yet .. */
1118 static void sci_config_port(struct uart_port *port, int flags)
1120 struct sci_port *s = &sci_ports[port->line];
1122 port->type = s->type;
1124 switch (port->type) {
1126 s->init_pins = sci_init_pins_sci;
1129 s->init_pins = sci_init_pins_scif;
1132 s->init_pins = sci_init_pins_irda;
1136 if (port->flags & UPF_IOREMAP && !port->membase) {
1137 #if defined(CONFIG_SUPERH64)
1138 port->mapbase = onchip_remap(SCIF_ADDR_SH5, 1024, "SCIF");
1139 port->membase = (void __iomem *)port->mapbase;
1141 port->membase = ioremap_nocache(port->mapbase, 0x40);
1144 printk(KERN_ERR "sci: can't remap port#%d\n", port->line);
1148 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
1150 struct sci_port *s = &sci_ports[port->line];
1152 if (ser->irq != s->irqs[SCIx_TXI_IRQ] || ser->irq > nr_irqs)
1154 if (ser->baud_base < 2400)
1155 /* No paper tape reader for Mitch.. */
1161 static struct uart_ops sci_uart_ops = {
1162 .tx_empty = sci_tx_empty,
1163 .set_mctrl = sci_set_mctrl,
1164 .get_mctrl = sci_get_mctrl,
1165 .start_tx = sci_start_tx,
1166 .stop_tx = sci_stop_tx,
1167 .stop_rx = sci_stop_rx,
1168 .enable_ms = sci_enable_ms,
1169 .break_ctl = sci_break_ctl,
1170 .startup = sci_startup,
1171 .shutdown = sci_shutdown,
1172 .set_termios = sci_set_termios,
1174 .release_port = sci_release_port,
1175 .request_port = sci_request_port,
1176 .config_port = sci_config_port,
1177 .verify_port = sci_verify_port,
1180 static void __init sci_init_ports(void)
1182 static int first = 1;
1190 for (i = 0; i < SCI_NPORTS; i++) {
1191 sci_ports[i].port.ops = &sci_uart_ops;
1192 sci_ports[i].port.iotype = UPIO_MEM;
1193 sci_ports[i].port.line = i;
1194 sci_ports[i].port.fifosize = 1;
1196 #if defined(__H8300H__) || defined(__H8300S__)
1198 sci_ports[i].enable = h8300_sci_enable;
1199 sci_ports[i].disable = h8300_sci_disable;
1201 sci_ports[i].port.uartclk = CONFIG_CPU_CLOCK;
1202 #elif defined(CONFIG_HAVE_CLK)
1204 * XXX: We should use a proper SCI/SCIF clock
1207 struct clk *clk = clk_get(NULL, "module_clk");
1208 sci_ports[i].port.uartclk = clk_get_rate(clk);
1212 #error "Need a valid uartclk"
1215 sci_ports[i].break_timer.data = (unsigned long)&sci_ports[i];
1216 sci_ports[i].break_timer.function = sci_break_timer;
1218 init_timer(&sci_ports[i].break_timer);
1222 int __init early_sci_setup(struct uart_port *port)
1224 if (unlikely(port->line > SCI_NPORTS))
1229 sci_ports[port->line].port.membase = port->membase;
1230 sci_ports[port->line].port.mapbase = port->mapbase;
1231 sci_ports[port->line].port.type = port->type;
1236 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1238 * Print a string to the serial port trying not to disturb
1239 * any possible real use of the port...
1241 static void serial_console_write(struct console *co, const char *s,
1244 put_string(serial_console_port, s, count);
1247 static int __init serial_console_setup(struct console *co, char *options)
1249 struct uart_port *port;
1257 * Check whether an invalid uart number has been specified, and
1258 * if so, search for the first available port that does have
1261 if (co->index >= SCI_NPORTS)
1264 serial_console_port = &sci_ports[co->index];
1265 port = &serial_console_port->port;
1268 * Also need to check port->type, we don't actually have any
1269 * UPIO_PORT ports, but uart_report_port() handily misreports
1270 * it anyways if we don't have a port available by the time this is
1275 if (!port->membase || !port->mapbase)
1278 port->type = serial_console_port->type;
1280 #ifdef CONFIG_HAVE_CLK
1281 if (!serial_console_port->clk)
1282 serial_console_port->clk = clk_get(NULL, "module_clk");
1285 if (port->flags & UPF_IOREMAP)
1286 sci_config_port(port, 0);
1288 if (serial_console_port->enable)
1289 serial_console_port->enable(port);
1292 uart_parse_options(options, &baud, &parity, &bits, &flow);
1294 ret = uart_set_options(port, co, baud, parity, bits, flow);
1295 #if defined(__H8300H__) || defined(__H8300S__)
1296 /* disable rx interrupt */
1303 static struct console serial_console = {
1305 .device = uart_console_device,
1306 .write = serial_console_write,
1307 .setup = serial_console_setup,
1308 .flags = CON_PRINTBUFFER,
1310 .data = &sci_uart_driver,
1313 static int __init sci_console_init(void)
1316 register_console(&serial_console);
1319 console_initcall(sci_console_init);
1320 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
1322 #ifdef CONFIG_SH_KGDB_CONSOLE
1324 * FIXME: Most of this can go away.. at the moment, we rely on
1325 * arch/sh/kernel/setup.c to do the command line parsing for kgdb, though
1326 * most of that can easily be done here instead.
1328 * For the time being, just accept the values that were parsed earlier..
1330 static void __init kgdb_console_get_options(struct uart_port *port, int *baud,
1331 int *parity, int *bits)
1334 *parity = tolower(kgdb_parity);
1335 *bits = kgdb_bits - '0';
1339 * The naming here is somewhat misleading, since kgdb_console_setup() takes
1340 * care of the early-on initialization for kgdb, regardless of whether we
1341 * actually use kgdb as a console or not.
1343 * On the plus side, this lets us kill off the old kgdb_sci_setup() nonsense.
1345 int __init kgdb_console_setup(struct console *co, char *options)
1347 struct uart_port *port = &sci_ports[kgdb_portnum].port;
1353 if (co->index != kgdb_portnum)
1354 co->index = kgdb_portnum;
1356 kgdb_sci_port = &sci_ports[co->index];
1357 port = &kgdb_sci_port->port;
1360 * Also need to check port->type, we don't actually have any
1361 * UPIO_PORT ports, but uart_report_port() handily misreports
1362 * it anyways if we don't have a port available by the time this is
1367 if (!port->membase || !port->mapbase)
1371 uart_parse_options(options, &baud, &parity, &bits, &flow);
1373 kgdb_console_get_options(port, &baud, &parity, &bits);
1375 kgdb_getchar = kgdb_sci_getchar;
1376 kgdb_putchar = kgdb_sci_putchar;
1378 return uart_set_options(port, co, baud, parity, bits, flow);
1381 static struct console kgdb_console = {
1383 .device = uart_console_device,
1384 .write = kgdb_console_write,
1385 .setup = kgdb_console_setup,
1386 .flags = CON_PRINTBUFFER,
1388 .data = &sci_uart_driver,
1391 /* Register the KGDB console so we get messages (d'oh!) */
1392 static int __init kgdb_console_init(void)
1395 register_console(&kgdb_console);
1398 console_initcall(kgdb_console_init);
1399 #endif /* CONFIG_SH_KGDB_CONSOLE */
1401 #if defined(CONFIG_SH_KGDB_CONSOLE)
1402 #define SCI_CONSOLE &kgdb_console
1403 #elif defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
1404 #define SCI_CONSOLE &serial_console
1406 #define SCI_CONSOLE 0
1409 static char banner[] __initdata =
1410 KERN_INFO "SuperH SCI(F) driver initialized\n";
1412 static struct uart_driver sci_uart_driver = {
1413 .owner = THIS_MODULE,
1414 .driver_name = "sci",
1415 .dev_name = "ttySC",
1417 .minor = SCI_MINOR_START,
1419 .cons = SCI_CONSOLE,
1423 * Register a set of serial devices attached to a platform device. The
1424 * list is terminated with a zero flags entry, which means we expect
1425 * all entries to have at least UPF_BOOT_AUTOCONF set. Platforms that need
1426 * remapping (such as sh64) should also set UPF_IOREMAP.
1428 static int __devinit sci_probe(struct platform_device *dev)
1430 struct plat_sci_port *p = dev->dev.platform_data;
1431 int i, ret = -EINVAL;
1433 for (i = 0; p && p->flags != 0; p++, i++) {
1434 struct sci_port *sciport = &sci_ports[i];
1437 if (unlikely(i == SCI_NPORTS)) {
1438 dev_notice(&dev->dev, "Attempting to register port "
1439 "%d when only %d are available.\n",
1441 dev_notice(&dev->dev, "Consider bumping "
1442 "CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
1446 sciport->port.mapbase = p->mapbase;
1448 if (p->mapbase && !p->membase) {
1449 if (p->flags & UPF_IOREMAP) {
1450 p->membase = ioremap_nocache(p->mapbase, 0x40);
1451 if (IS_ERR(p->membase)) {
1452 ret = PTR_ERR(p->membase);
1457 * For the simple (and majority of) cases
1458 * where we don't need to do any remapping,
1459 * just cast the cookie directly.
1461 p->membase = (void __iomem *)p->mapbase;
1465 sciport->port.membase = p->membase;
1467 sciport->port.irq = p->irqs[SCIx_TXI_IRQ];
1468 sciport->port.flags = p->flags;
1469 sciport->port.dev = &dev->dev;
1471 sciport->type = sciport->port.type = p->type;
1473 memcpy(&sciport->irqs, &p->irqs, sizeof(p->irqs));
1475 uart_add_one_port(&sci_uart_driver, &sciport->port);
1478 #if defined(CONFIG_SH_KGDB) && !defined(CONFIG_SH_KGDB_CONSOLE)
1479 kgdb_sci_port = &sci_ports[kgdb_portnum];
1480 kgdb_getchar = kgdb_sci_getchar;
1481 kgdb_putchar = kgdb_sci_putchar;
1484 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_HAVE_CLK)
1485 cpufreq_register_notifier(&sci_nb, CPUFREQ_TRANSITION_NOTIFIER);
1486 dev_info(&dev->dev, "CPU frequency notifier registered\n");
1489 #ifdef CONFIG_SH_STANDARD_BIOS
1490 sh_bios_gdb_detach();
1496 for (i = i - 1; i >= 0; i--)
1497 uart_remove_one_port(&sci_uart_driver, &sci_ports[i].port);
1502 static int __devexit sci_remove(struct platform_device *dev)
1506 for (i = 0; i < SCI_NPORTS; i++)
1507 uart_remove_one_port(&sci_uart_driver, &sci_ports[i].port);
1512 static int sci_suspend(struct platform_device *dev, pm_message_t state)
1516 for (i = 0; i < SCI_NPORTS; i++) {
1517 struct sci_port *p = &sci_ports[i];
1519 if (p->type != PORT_UNKNOWN && p->port.dev == &dev->dev)
1520 uart_suspend_port(&sci_uart_driver, &p->port);
1526 static int sci_resume(struct platform_device *dev)
1530 for (i = 0; i < SCI_NPORTS; i++) {
1531 struct sci_port *p = &sci_ports[i];
1533 if (p->type != PORT_UNKNOWN && p->port.dev == &dev->dev)
1534 uart_resume_port(&sci_uart_driver, &p->port);
1540 static struct platform_driver sci_driver = {
1542 .remove = __devexit_p(sci_remove),
1543 .suspend = sci_suspend,
1544 .resume = sci_resume,
1547 .owner = THIS_MODULE,
1551 static int __init sci_init(void)
1559 ret = uart_register_driver(&sci_uart_driver);
1560 if (likely(ret == 0)) {
1561 ret = platform_driver_register(&sci_driver);
1563 uart_unregister_driver(&sci_uart_driver);
1569 static void __exit sci_exit(void)
1571 platform_driver_unregister(&sci_driver);
1572 uart_unregister_driver(&sci_uart_driver);
1575 module_init(sci_init);
1576 module_exit(sci_exit);
1578 MODULE_LICENSE("GPL");
1579 MODULE_ALIAS("platform:sh-sci");