2 * drivers/serial/sh-sci.c
4 * SuperH on-chip serial module support. (SCI with no FIFO / with FIFO)
6 * Copyright (C) 2002 - 2006 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>
46 #ifdef CONFIG_CPU_FREQ
47 #include <linux/notifier.h>
48 #include <linux/cpufreq.h>
51 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
52 #include <linux/ctype.h>
53 #include <asm/clock.h>
54 #include <asm/sh_bios.h>
61 struct uart_port port;
66 /* Port IRQs: ERI, RXI, TXI, BRI (optional) */
67 unsigned int irqs[SCIx_NR_IRQS];
69 /* Port pin configuration */
70 void (*init_pins)(struct uart_port *port,
73 /* Port enable callback */
74 void (*enable)(struct uart_port *port);
76 /* Port disable callback */
77 void (*disable)(struct uart_port *port);
80 struct timer_list break_timer;
83 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
90 static struct sci_port *kgdb_sci_port;
93 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
94 static struct sci_port *serial_console_port;
97 /* Function prototypes */
98 static void sci_stop_tx(struct uart_port *port);
100 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
102 static struct sci_port sci_ports[SCI_NPORTS];
103 static struct uart_driver sci_uart_driver;
105 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && \
106 defined(CONFIG_SH_STANDARD_BIOS) || defined(CONFIG_SH_KGDB)
107 static inline void handle_error(struct uart_port *port)
109 /* Clear error flags */
110 sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
113 static int get_char(struct uart_port *port)
116 unsigned short status;
119 spin_lock_irqsave(&port->lock, flags);
121 status = sci_in(port, SCxSR);
122 if (status & SCxSR_ERRORS(port)) {
126 } while (!(status & SCxSR_RDxF(port)));
127 c = sci_in(port, SCxRDR);
128 sci_in(port, SCxSR); /* Dummy read */
129 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
130 spin_unlock_irqrestore(&port->lock, flags);
134 #endif /* CONFIG_SH_STANDARD_BIOS || CONFIG_SH_KGDB */
136 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || defined(CONFIG_SH_KGDB)
137 static void put_char(struct uart_port *port, char c)
140 unsigned short status;
142 spin_lock_irqsave(&port->lock, flags);
145 status = sci_in(port, SCxSR);
146 } while (!(status & SCxSR_TDxE(port)));
148 sci_out(port, SCxTDR, c);
149 sci_in(port, SCxSR); /* Dummy read */
150 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
152 spin_unlock_irqrestore(&port->lock, flags);
156 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
157 static void put_string(struct sci_port *sci_port, const char *buffer, int count)
159 struct uart_port *port = &sci_port->port;
160 const unsigned char *p = buffer;
163 #if defined(CONFIG_SH_STANDARD_BIOS) || defined(CONFIG_SH_KGDB)
167 #ifdef CONFIG_SH_STANDARD_BIOS
168 /* This call only does a trap the first time it is
169 * called, and so is safe to do here unconditionally
171 usegdb |= sh_bios_in_gdb_mode();
173 #ifdef CONFIG_SH_KGDB
174 usegdb |= (kgdb_in_gdb_mode && (sci_port == kgdb_sci_port));
178 /* $<packet info>#<checksum>. */
182 put_char(port, 'O'); /* 'O'utput to console */
185 for (i=0; i<count; i++) { /* Don't use run length encoding */
196 put_char(port, highhex(checksum));
197 put_char(port, lowhex(checksum));
198 } while (get_char(port) != '+');
200 #endif /* CONFIG_SH_STANDARD_BIOS || CONFIG_SH_KGDB */
201 for (i=0; i<count; i++) {
203 put_char(port, '\r');
204 put_char(port, *p++);
207 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
209 #ifdef CONFIG_SH_KGDB
210 static int kgdb_sci_getchar(void)
214 /* Keep trying to read a character, this could be neater */
215 while ((c = get_char(&kgdb_sci_port->port)) < 0)
221 static inline void kgdb_sci_putchar(int c)
223 put_char(&kgdb_sci_port->port, c);
225 #endif /* CONFIG_SH_KGDB */
227 #if defined(__H8300S__)
228 enum { sci_disable, sci_enable };
230 static void h8300_sci_config(struct uart_port* port, unsigned int ctrl)
232 volatile unsigned char *mstpcrl=(volatile unsigned char *)MSTPCRL;
233 int ch = (port->mapbase - SMR0) >> 3;
234 unsigned char mask = 1 << (ch+1);
236 if (ctrl == sci_disable) {
243 static inline void h8300_sci_enable(struct uart_port *port)
245 h8300_sci_config(port, sci_enable);
248 static inline void h8300_sci_disable(struct uart_port *port)
250 h8300_sci_config(port, sci_disable);
254 #if defined(SCI_ONLY) || defined(SCI_AND_SCIF) && \
255 defined(__H8300H__) || defined(__H8300S__)
256 static void sci_init_pins_sci(struct uart_port* port, unsigned int cflag)
258 int ch = (port->mapbase - SMR0) >> 3;
261 H8300_GPIO_DDR(h8300_sci_pins[ch].port,
262 h8300_sci_pins[ch].rx,
264 H8300_GPIO_DDR(h8300_sci_pins[ch].port,
265 h8300_sci_pins[ch].tx,
269 H8300_SCI_DR(ch) |= h8300_sci_pins[ch].tx;
272 #define sci_init_pins_sci NULL
275 #if defined(CONFIG_CPU_SUBTYPE_SH7707) || defined(CONFIG_CPU_SUBTYPE_SH7709)
276 static void sci_init_pins_irda(struct uart_port *port, unsigned int cflag)
278 unsigned int fcr_val = 0;
281 fcr_val |= SCFCR_MCE;
283 sci_out(port, SCFCR, fcr_val);
286 #define sci_init_pins_irda NULL
290 #define sci_init_pins_scif NULL
293 #if defined(SCIF_ONLY) || defined(SCI_AND_SCIF)
294 #if defined(CONFIG_CPU_SUBTYPE_SH7710) || defined(CONFIG_CPU_SUBTYPE_SH7712)
295 static void sci_init_pins_scif(struct uart_port* port, unsigned int cflag)
297 unsigned int fcr_val = 0;
299 set_sh771x_scif_pfc(port);
300 if (cflag & CRTSCTS) {
301 fcr_val |= SCFCR_MCE;
303 sci_out(port, SCFCR, fcr_val);
305 #elif defined(CONFIG_CPU_SUBTYPE_SH7720) || defined(CONFIG_CPU_SUBTYPE_SH7721)
306 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
308 unsigned int fcr_val = 0;
311 if (cflag & CRTSCTS) {
313 if (port->mapbase == 0xa4430000) { /* SCIF0 */
314 /* Clear PTCR bit 9-2; enable all scif pins but sck */
315 data = ctrl_inw(PORT_PTCR);
316 ctrl_outw((data & 0xfc03), PORT_PTCR);
317 } else if (port->mapbase == 0xa4438000) { /* SCIF1 */
318 /* Clear PVCR bit 9-2 */
319 data = ctrl_inw(PORT_PVCR);
320 ctrl_outw((data & 0xfc03), PORT_PVCR);
322 fcr_val |= SCFCR_MCE;
324 if (port->mapbase == 0xa4430000) { /* SCIF0 */
325 /* Clear PTCR bit 5-2; enable only tx and rx */
326 data = ctrl_inw(PORT_PTCR);
327 ctrl_outw((data & 0xffc3), PORT_PTCR);
328 } else if (port->mapbase == 0xa4438000) { /* SCIF1 */
329 /* Clear PVCR bit 5-2 */
330 data = ctrl_inw(PORT_PVCR);
331 ctrl_outw((data & 0xffc3), PORT_PVCR);
334 sci_out(port, SCFCR, fcr_val);
337 #elif defined(CONFIG_CPU_SH3)
338 /* For SH7705, SH7706, SH7707, SH7709, SH7709A, SH7729 */
339 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
341 unsigned int fcr_val = 0;
344 /* We need to set SCPCR to enable RTS/CTS */
345 data = ctrl_inw(SCPCR);
346 /* Clear out SCP7MD1,0, SCP6MD1,0, SCP4MD1,0*/
347 ctrl_outw(data & 0x0fcf, SCPCR);
350 fcr_val |= SCFCR_MCE;
352 /* We need to set SCPCR to enable RTS/CTS */
353 data = ctrl_inw(SCPCR);
354 /* Clear out SCP7MD1,0, SCP4MD1,0,
355 Set SCP6MD1,0 = {01} (output) */
356 ctrl_outw((data & 0x0fcf) | 0x1000, SCPCR);
358 data = ctrl_inb(SCPDR);
359 /* Set /RTS2 (bit6) = 0 */
360 ctrl_outb(data & 0xbf, SCPDR);
363 sci_out(port, SCFCR, fcr_val);
365 #elif defined(CONFIG_CPU_SUBTYPE_SH7722)
366 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
368 unsigned int fcr_val = 0;
370 if (cflag & CRTSCTS) {
371 fcr_val |= SCFCR_MCE;
373 ctrl_outw(0x0000, PORT_PSCR);
377 data = ctrl_inw(PORT_PSCR);
380 ctrl_outw(data, PORT_PSCR);
382 ctrl_outw(ctrl_inw(SCSPTR0) & 0x17, SCSPTR0);
385 sci_out(port, SCFCR, fcr_val);
389 static void sci_init_pins_scif(struct uart_port *port, unsigned int cflag)
391 unsigned int fcr_val = 0;
393 if (cflag & CRTSCTS) {
394 fcr_val |= SCFCR_MCE;
396 #if defined(CONFIG_CPU_SUBTYPE_SH7343) || defined(CONFIG_CPU_SUBTYPE_SH7366)
398 #elif defined(CONFIG_CPU_SUBTYPE_SH7763) || \
399 defined(CONFIG_CPU_SUBTYPE_SH7780) || \
400 defined(CONFIG_CPU_SUBTYPE_SH7785) || \
401 defined(CONFIG_CPU_SUBTYPE_SHX3)
402 ctrl_outw(0x0080, SCSPTR0); /* Set RTS = 1 */
404 ctrl_outw(0x0080, SCSPTR2); /* Set RTS = 1 */
407 sci_out(port, SCFCR, fcr_val);
411 #if defined(CONFIG_CPU_SUBTYPE_SH7760) || \
412 defined(CONFIG_CPU_SUBTYPE_SH7763) || \
413 defined(CONFIG_CPU_SUBTYPE_SH7780) || \
414 defined(CONFIG_CPU_SUBTYPE_SH7785)
415 static inline int scif_txroom(struct uart_port *port)
417 return SCIF_TXROOM_MAX - (sci_in(port, SCTFDR) & 0xff);
420 static inline int scif_rxroom(struct uart_port *port)
422 return sci_in(port, SCRFDR) & 0xff;
425 static inline int scif_txroom(struct uart_port *port)
427 return SCIF_TXROOM_MAX - (sci_in(port, SCFDR) >> 8);
430 static inline int scif_rxroom(struct uart_port *port)
432 return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
435 #endif /* SCIF_ONLY || SCI_AND_SCIF */
437 static inline int sci_txroom(struct uart_port *port)
439 return ((sci_in(port, SCxSR) & SCI_TDRE) != 0);
442 static inline int sci_rxroom(struct uart_port *port)
444 return ((sci_in(port, SCxSR) & SCxSR_RDxF(port)) != 0);
447 /* ********************************************************************** *
448 * the interrupt related routines *
449 * ********************************************************************** */
451 static void sci_transmit_chars(struct uart_port *port)
453 struct circ_buf *xmit = &port->info->xmit;
454 unsigned int stopped = uart_tx_stopped(port);
455 unsigned short status;
459 status = sci_in(port, SCxSR);
460 if (!(status & SCxSR_TDxE(port))) {
461 ctrl = sci_in(port, SCSCR);
462 if (uart_circ_empty(xmit)) {
463 ctrl &= ~SCI_CTRL_FLAGS_TIE;
465 ctrl |= SCI_CTRL_FLAGS_TIE;
467 sci_out(port, SCSCR, ctrl);
472 if (port->type == PORT_SCIF)
473 count = scif_txroom(port);
476 count = sci_txroom(port);
484 } else if (!uart_circ_empty(xmit) && !stopped) {
485 c = xmit->buf[xmit->tail];
486 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
491 sci_out(port, SCxTDR, c);
494 } while (--count > 0);
496 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
498 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
499 uart_write_wakeup(port);
500 if (uart_circ_empty(xmit)) {
503 ctrl = sci_in(port, SCSCR);
505 #if !defined(SCI_ONLY)
506 if (port->type == PORT_SCIF) {
507 sci_in(port, SCxSR); /* Dummy read */
508 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
512 ctrl |= SCI_CTRL_FLAGS_TIE;
513 sci_out(port, SCSCR, ctrl);
517 /* On SH3, SCIF may read end-of-break as a space->mark char */
518 #define STEPFN(c) ({int __c=(c); (((__c-1)|(__c)) == -1); })
520 static inline void sci_receive_chars(struct uart_port *port)
522 struct sci_port *sci_port = (struct sci_port *)port;
523 struct tty_struct *tty = port->info->tty;
524 int i, count, copied = 0;
525 unsigned short status;
528 status = sci_in(port, SCxSR);
529 if (!(status & SCxSR_RDxF(port)))
533 #if !defined(SCI_ONLY)
534 if (port->type == PORT_SCIF)
535 count = scif_rxroom(port);
538 count = sci_rxroom(port);
540 /* Don't copy more bytes than there is room for in the buffer */
541 count = tty_buffer_request_room(tty, count);
543 /* If for any reason we can't copy more data, we're done! */
547 if (port->type == PORT_SCI) {
548 char c = sci_in(port, SCxRDR);
549 if (uart_handle_sysrq_char(port, c) || sci_port->break_flag)
552 tty_insert_flip_char(tty, c, TTY_NORMAL);
555 for (i=0; i<count; i++) {
556 char c = sci_in(port, SCxRDR);
557 status = sci_in(port, SCxSR);
558 #if defined(CONFIG_CPU_SH3)
559 /* Skip "chars" during break */
560 if (sci_port->break_flag) {
562 (status & SCxSR_FER(port))) {
567 /* Nonzero => end-of-break */
568 pr_debug("scif: debounce<%02x>\n", c);
569 sci_port->break_flag = 0;
576 #endif /* CONFIG_CPU_SH3 */
577 if (uart_handle_sysrq_char(port, c)) {
582 /* Store data and status */
583 if (status&SCxSR_FER(port)) {
585 pr_debug("sci: frame error\n");
586 } else if (status&SCxSR_PER(port)) {
588 pr_debug("sci: parity error\n");
591 tty_insert_flip_char(tty, c, flag);
595 sci_in(port, SCxSR); /* dummy read */
596 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
599 port->icount.rx += count;
603 /* Tell the rest of the system the news. New characters! */
604 tty_flip_buffer_push(tty);
606 sci_in(port, SCxSR); /* dummy read */
607 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
611 #define SCI_BREAK_JIFFIES (HZ/20)
612 /* The sci generates interrupts during the break,
613 * 1 per millisecond or so during the break period, for 9600 baud.
614 * So dont bother disabling interrupts.
615 * But dont want more than 1 break event.
616 * Use a kernel timer to periodically poll the rx line until
617 * the break is finished.
619 static void sci_schedule_break_timer(struct sci_port *port)
621 port->break_timer.expires = jiffies + SCI_BREAK_JIFFIES;
622 add_timer(&port->break_timer);
624 /* Ensure that two consecutive samples find the break over. */
625 static void sci_break_timer(unsigned long data)
627 struct sci_port *port = (struct sci_port *)data;
629 if (sci_rxd_in(&port->port) == 0) {
630 port->break_flag = 1;
631 sci_schedule_break_timer(port);
632 } else if (port->break_flag == 1) {
634 port->break_flag = 2;
635 sci_schedule_break_timer(port);
637 port->break_flag = 0;
640 static inline int sci_handle_errors(struct uart_port *port)
643 unsigned short status = sci_in(port, SCxSR);
644 struct tty_struct *tty = port->info->tty;
646 if (status & SCxSR_ORER(port)) {
648 if (tty_insert_flip_char(tty, 0, TTY_OVERRUN))
650 pr_debug("sci: overrun error\n");
653 if (status & SCxSR_FER(port)) {
654 if (sci_rxd_in(port) == 0) {
655 /* Notify of BREAK */
656 struct sci_port *sci_port = (struct sci_port *)port;
658 if (!sci_port->break_flag) {
659 sci_port->break_flag = 1;
660 sci_schedule_break_timer(sci_port);
662 /* Do sysrq handling. */
663 if (uart_handle_break(port))
665 pr_debug("sci: BREAK detected\n");
666 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
671 if (tty_insert_flip_char(tty, 0, TTY_FRAME))
673 pr_debug("sci: frame error\n");
677 if (status & SCxSR_PER(port)) {
679 if (tty_insert_flip_char(tty, 0, TTY_PARITY))
681 pr_debug("sci: parity error\n");
685 tty_flip_buffer_push(tty);
690 static inline int sci_handle_breaks(struct uart_port *port)
693 unsigned short status = sci_in(port, SCxSR);
694 struct tty_struct *tty = port->info->tty;
695 struct sci_port *s = &sci_ports[port->line];
697 if (uart_handle_break(port))
700 if (!s->break_flag && status & SCxSR_BRK(port)) {
701 #if defined(CONFIG_CPU_SH3)
705 /* Notify of BREAK */
706 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
708 pr_debug("sci: BREAK detected\n");
711 #if defined(SCIF_ORER)
712 /* XXX: Handle SCIF overrun error */
713 if (port->type == PORT_SCIF && (sci_in(port, SCLSR) & SCIF_ORER) != 0) {
714 sci_out(port, SCLSR, 0);
715 if (tty_insert_flip_char(tty, 0, TTY_OVERRUN)) {
717 pr_debug("sci: overrun error\n");
723 tty_flip_buffer_push(tty);
728 static irqreturn_t sci_rx_interrupt(int irq, void *port)
730 /* I think sci_receive_chars has to be called irrespective
731 * of whether the I_IXOFF is set, otherwise, how is the interrupt
734 sci_receive_chars(port);
739 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
741 struct uart_port *port = ptr;
743 spin_lock_irq(&port->lock);
744 sci_transmit_chars(port);
745 spin_unlock_irq(&port->lock);
750 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
752 struct uart_port *port = ptr;
755 if (port->type == PORT_SCI) {
756 if (sci_handle_errors(port)) {
757 /* discard character in rx buffer */
759 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
762 #if defined(SCIF_ORER)
763 if((sci_in(port, SCLSR) & SCIF_ORER) != 0) {
764 struct tty_struct *tty = port->info->tty;
766 sci_out(port, SCLSR, 0);
767 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
768 tty_flip_buffer_push(tty);
769 pr_debug("scif: overrun error\n");
772 sci_rx_interrupt(irq, ptr);
775 sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
777 /* Kick the transmission */
778 sci_tx_interrupt(irq, ptr);
783 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
785 struct uart_port *port = ptr;
788 sci_handle_breaks(port);
789 sci_out(port, SCxSR, SCxSR_BREAK_CLEAR(port));
794 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
796 unsigned short ssr_status, scr_status;
797 struct uart_port *port = ptr;
799 ssr_status = sci_in(port,SCxSR);
800 scr_status = sci_in(port,SCSCR);
803 if ((ssr_status & 0x0020) && (scr_status & 0x0080))
804 sci_tx_interrupt(irq, ptr);
806 if ((ssr_status & 0x0002) && (scr_status & 0x0040))
807 sci_rx_interrupt(irq, ptr);
808 /* Error Interrupt */
809 if ((ssr_status & 0x0080) && (scr_status & 0x0400))
810 sci_er_interrupt(irq, ptr);
811 /* Break Interrupt */
812 if ((ssr_status & 0x0010) && (scr_status & 0x0200))
813 sci_br_interrupt(irq, ptr);
818 #ifdef CONFIG_CPU_FREQ
820 * Here we define a transistion notifier so that we can update all of our
821 * ports' baud rate when the peripheral clock changes.
823 static int sci_notifier(struct notifier_block *self,
824 unsigned long phase, void *p)
826 struct cpufreq_freqs *freqs = p;
829 if ((phase == CPUFREQ_POSTCHANGE) ||
830 (phase == CPUFREQ_RESUMECHANGE)){
831 for (i = 0; i < SCI_NPORTS; i++) {
832 struct uart_port *port = &sci_ports[i].port;
836 * Update the uartclk per-port if frequency has
837 * changed, since it will no longer necessarily be
838 * consistent with the old frequency.
840 * Really we want to be able to do something like
841 * uart_change_speed() or something along those lines
842 * here to implicitly reset the per-port baud rate..
844 * Clean this up later..
846 clk = clk_get(NULL, "module_clk");
847 port->uartclk = clk_get_rate(clk) * 16;
851 printk(KERN_INFO "%s: got a postchange notification "
852 "for cpu %d (old %d, new %d)\n",
853 __FUNCTION__, freqs->cpu, freqs->old, freqs->new);
859 static struct notifier_block sci_nb = { &sci_notifier, NULL, 0 };
860 #endif /* CONFIG_CPU_FREQ */
862 static int sci_request_irq(struct sci_port *port)
865 irqreturn_t (*handlers[4])(int irq, void *ptr) = {
866 sci_er_interrupt, sci_rx_interrupt, sci_tx_interrupt,
869 const char *desc[] = { "SCI Receive Error", "SCI Receive Data Full",
870 "SCI Transmit Data Empty", "SCI Break" };
872 if (port->irqs[0] == port->irqs[1]) {
873 if (!port->irqs[0]) {
874 printk(KERN_ERR "sci: Cannot allocate irq.(IRQ=0)\n");
878 if (request_irq(port->irqs[0], sci_mpxed_interrupt,
879 IRQF_DISABLED, "sci", port)) {
880 printk(KERN_ERR "sci: Cannot allocate irq.\n");
884 for (i = 0; i < ARRAY_SIZE(handlers); i++) {
887 if (request_irq(port->irqs[i], handlers[i],
888 IRQF_DISABLED, desc[i], port)) {
889 printk(KERN_ERR "sci: Cannot allocate irq.\n");
898 static void sci_free_irq(struct sci_port *port)
902 if (port->irqs[0] == port->irqs[1]) {
904 printk("sci: sci_free_irq error\n");
906 free_irq(port->irqs[0], port);
908 for (i = 0; i < ARRAY_SIZE(port->irqs); i++) {
912 free_irq(port->irqs[i], port);
917 static unsigned int sci_tx_empty(struct uart_port *port)
923 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
925 /* This routine is used for seting signals of: DTR, DCD, CTS/RTS */
926 /* We use SCIF's hardware for CTS/RTS, so don't need any for that. */
927 /* If you have signals for DTR and DCD, please implement here. */
930 static unsigned int sci_get_mctrl(struct uart_port *port)
932 /* This routine is used for geting signals of: DTR, DCD, DSR, RI,
935 return TIOCM_DTR | TIOCM_RTS | TIOCM_DSR;
938 static void sci_start_tx(struct uart_port *port)
942 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
943 ctrl = sci_in(port, SCSCR);
944 ctrl |= SCI_CTRL_FLAGS_TIE;
945 sci_out(port, SCSCR, ctrl);
948 static void sci_stop_tx(struct uart_port *port)
952 /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
953 ctrl = sci_in(port, SCSCR);
954 ctrl &= ~SCI_CTRL_FLAGS_TIE;
955 sci_out(port, SCSCR, ctrl);
958 static void sci_start_rx(struct uart_port *port, unsigned int tty_start)
962 /* Set RIE (Receive Interrupt Enable) bit in SCSCR */
963 ctrl = sci_in(port, SCSCR);
964 ctrl |= SCI_CTRL_FLAGS_RIE | SCI_CTRL_FLAGS_REIE;
965 sci_out(port, SCSCR, ctrl);
968 static void sci_stop_rx(struct uart_port *port)
972 /* Clear RIE (Receive Interrupt Enable) bit in SCSCR */
973 ctrl = sci_in(port, SCSCR);
974 ctrl &= ~(SCI_CTRL_FLAGS_RIE | SCI_CTRL_FLAGS_REIE);
975 sci_out(port, SCSCR, ctrl);
978 static void sci_enable_ms(struct uart_port *port)
980 /* Nothing here yet .. */
983 static void sci_break_ctl(struct uart_port *port, int break_state)
985 /* Nothing here yet .. */
988 static int sci_startup(struct uart_port *port)
990 struct sci_port *s = &sci_ports[port->line];
995 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
996 s->clk = clk_get(NULL, "module_clk");
1001 sci_start_rx(port, 1);
1006 static void sci_shutdown(struct uart_port *port)
1008 struct sci_port *s = &sci_ports[port->line];
1017 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
1023 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
1024 struct ktermios *old)
1026 struct sci_port *s = &sci_ports[port->line];
1027 unsigned int status, baud, smr_val;
1030 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
1038 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
1039 t = SCBRR_VALUE(baud, clk_get_rate(s->clk));
1041 t = SCBRR_VALUE(baud);
1048 status = sci_in(port, SCxSR);
1049 } while (!(status & SCxSR_TEND(port)));
1051 sci_out(port, SCSCR, 0x00); /* TE=0, RE=0, CKE1=0 */
1053 #if !defined(SCI_ONLY)
1054 if (port->type == PORT_SCIF)
1055 sci_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
1058 smr_val = sci_in(port, SCSMR) & 3;
1059 if ((termios->c_cflag & CSIZE) == CS7)
1061 if (termios->c_cflag & PARENB)
1063 if (termios->c_cflag & PARODD)
1065 if (termios->c_cflag & CSTOPB)
1068 uart_update_timeout(port, termios->c_cflag, baud);
1070 sci_out(port, SCSMR, smr_val);
1074 sci_out(port, SCSMR, (sci_in(port, SCSMR) & ~3) | 1);
1077 sci_out(port, SCSMR, sci_in(port, SCSMR) & ~3);
1079 sci_out(port, SCBRR, t);
1080 udelay((1000000+(baud-1)) / baud); /* Wait one bit interval */
1083 if (likely(s->init_pins))
1084 s->init_pins(port, termios->c_cflag);
1086 sci_out(port, SCSCR, SCSCR_INIT(port));
1088 if ((termios->c_cflag & CREAD) != 0)
1089 sci_start_rx(port,0);
1092 static const char *sci_type(struct uart_port *port)
1094 switch (port->type) {
1095 case PORT_SCI: return "sci";
1096 case PORT_SCIF: return "scif";
1097 case PORT_IRDA: return "irda";
1103 static void sci_release_port(struct uart_port *port)
1105 /* Nothing here yet .. */
1108 static int sci_request_port(struct uart_port *port)
1110 /* Nothing here yet .. */
1114 static void sci_config_port(struct uart_port *port, int flags)
1116 struct sci_port *s = &sci_ports[port->line];
1118 port->type = s->type;
1120 switch (port->type) {
1122 s->init_pins = sci_init_pins_sci;
1125 s->init_pins = sci_init_pins_scif;
1128 s->init_pins = sci_init_pins_irda;
1132 #if defined(CONFIG_CPU_SUBTYPE_SH5_101) || defined(CONFIG_CPU_SUBTYPE_SH5_103)
1133 if (port->mapbase == 0)
1134 port->mapbase = onchip_remap(SCIF_ADDR_SH5, 1024, "SCIF");
1136 port->membase = (void __iomem *)port->mapbase;
1140 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
1142 struct sci_port *s = &sci_ports[port->line];
1144 if (ser->irq != s->irqs[SCIx_TXI_IRQ] || ser->irq > NR_IRQS)
1146 if (ser->baud_base < 2400)
1147 /* No paper tape reader for Mitch.. */
1153 static struct uart_ops sci_uart_ops = {
1154 .tx_empty = sci_tx_empty,
1155 .set_mctrl = sci_set_mctrl,
1156 .get_mctrl = sci_get_mctrl,
1157 .start_tx = sci_start_tx,
1158 .stop_tx = sci_stop_tx,
1159 .stop_rx = sci_stop_rx,
1160 .enable_ms = sci_enable_ms,
1161 .break_ctl = sci_break_ctl,
1162 .startup = sci_startup,
1163 .shutdown = sci_shutdown,
1164 .set_termios = sci_set_termios,
1166 .release_port = sci_release_port,
1167 .request_port = sci_request_port,
1168 .config_port = sci_config_port,
1169 .verify_port = sci_verify_port,
1172 static void __init sci_init_ports(void)
1174 static int first = 1;
1182 for (i = 0; i < SCI_NPORTS; i++) {
1183 sci_ports[i].port.ops = &sci_uart_ops;
1184 sci_ports[i].port.iotype = UPIO_MEM;
1185 sci_ports[i].port.line = i;
1186 sci_ports[i].port.fifosize = 1;
1188 #if defined(__H8300H__) || defined(__H8300S__)
1190 sci_ports[i].enable = h8300_sci_enable;
1191 sci_ports[i].disable = h8300_sci_disable;
1193 sci_ports[i].port.uartclk = CONFIG_CPU_CLOCK;
1194 #elif defined(CONFIG_SUPERH64)
1195 sci_ports[i].port.uartclk = current_cpu_data.module_clock * 16;
1198 * XXX: We should use a proper SCI/SCIF clock
1201 struct clk *clk = clk_get(NULL, "module_clk");
1202 sci_ports[i].port.uartclk = clk_get_rate(clk) * 16;
1207 sci_ports[i].break_timer.data = (unsigned long)&sci_ports[i];
1208 sci_ports[i].break_timer.function = sci_break_timer;
1210 init_timer(&sci_ports[i].break_timer);
1214 int __init early_sci_setup(struct uart_port *port)
1216 if (unlikely(port->line > SCI_NPORTS))
1221 sci_ports[port->line].port.membase = port->membase;
1222 sci_ports[port->line].port.mapbase = port->mapbase;
1223 sci_ports[port->line].port.type = port->type;
1228 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1230 * Print a string to the serial port trying not to disturb
1231 * any possible real use of the port...
1233 static void serial_console_write(struct console *co, const char *s,
1236 put_string(serial_console_port, s, count);
1239 static int __init serial_console_setup(struct console *co, char *options)
1241 struct uart_port *port;
1249 * Check whether an invalid uart number has been specified, and
1250 * if so, search for the first available port that does have
1253 if (co->index >= SCI_NPORTS)
1256 serial_console_port = &sci_ports[co->index];
1257 port = &serial_console_port->port;
1260 * Also need to check port->type, we don't actually have any
1261 * UPIO_PORT ports, but uart_report_port() handily misreports
1262 * it anyways if we don't have a port available by the time this is
1267 if (!port->membase || !port->mapbase)
1270 port->type = serial_console_port->type;
1272 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
1273 if (!serial_console_port->clk)
1274 serial_console_port->clk = clk_get(NULL, "module_clk");
1277 if (port->flags & UPF_IOREMAP)
1278 sci_config_port(port, 0);
1280 if (serial_console_port->enable)
1281 serial_console_port->enable(port);
1284 uart_parse_options(options, &baud, &parity, &bits, &flow);
1286 ret = uart_set_options(port, co, baud, parity, bits, flow);
1287 #if defined(__H8300H__) || defined(__H8300S__)
1288 /* disable rx interrupt */
1295 static struct console serial_console = {
1297 .device = uart_console_device,
1298 .write = serial_console_write,
1299 .setup = serial_console_setup,
1300 .flags = CON_PRINTBUFFER,
1302 .data = &sci_uart_driver,
1305 static int __init sci_console_init(void)
1308 register_console(&serial_console);
1311 console_initcall(sci_console_init);
1312 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
1314 #ifdef CONFIG_SH_KGDB_CONSOLE
1316 * FIXME: Most of this can go away.. at the moment, we rely on
1317 * arch/sh/kernel/setup.c to do the command line parsing for kgdb, though
1318 * most of that can easily be done here instead.
1320 * For the time being, just accept the values that were parsed earlier..
1322 static void __init kgdb_console_get_options(struct uart_port *port, int *baud,
1323 int *parity, int *bits)
1326 *parity = tolower(kgdb_parity);
1327 *bits = kgdb_bits - '0';
1331 * The naming here is somewhat misleading, since kgdb_console_setup() takes
1332 * care of the early-on initialization for kgdb, regardless of whether we
1333 * actually use kgdb as a console or not.
1335 * On the plus side, this lets us kill off the old kgdb_sci_setup() nonsense.
1337 int __init kgdb_console_setup(struct console *co, char *options)
1339 struct uart_port *port = &sci_ports[kgdb_portnum].port;
1345 if (co->index != kgdb_portnum)
1346 co->index = kgdb_portnum;
1348 kgdb_sci_port = &sci_ports[co->index];
1349 port = &kgdb_sci_port->port;
1352 * Also need to check port->type, we don't actually have any
1353 * UPIO_PORT ports, but uart_report_port() handily misreports
1354 * it anyways if we don't have a port available by the time this is
1359 if (!port->membase || !port->mapbase)
1363 uart_parse_options(options, &baud, &parity, &bits, &flow);
1365 kgdb_console_get_options(port, &baud, &parity, &bits);
1367 kgdb_getchar = kgdb_sci_getchar;
1368 kgdb_putchar = kgdb_sci_putchar;
1370 return uart_set_options(port, co, baud, parity, bits, flow);
1373 static struct console kgdb_console = {
1375 .device = uart_console_device,
1376 .write = kgdb_console_write,
1377 .setup = kgdb_console_setup,
1378 .flags = CON_PRINTBUFFER,
1380 .data = &sci_uart_driver,
1383 /* Register the KGDB console so we get messages (d'oh!) */
1384 static int __init kgdb_console_init(void)
1387 register_console(&kgdb_console);
1390 console_initcall(kgdb_console_init);
1391 #endif /* CONFIG_SH_KGDB_CONSOLE */
1393 #if defined(CONFIG_SH_KGDB_CONSOLE)
1394 #define SCI_CONSOLE &kgdb_console
1395 #elif defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
1396 #define SCI_CONSOLE &serial_console
1398 #define SCI_CONSOLE 0
1401 static char banner[] __initdata =
1402 KERN_INFO "SuperH SCI(F) driver initialized\n";
1404 static struct uart_driver sci_uart_driver = {
1405 .owner = THIS_MODULE,
1406 .driver_name = "sci",
1407 .dev_name = "ttySC",
1409 .minor = SCI_MINOR_START,
1411 .cons = SCI_CONSOLE,
1415 * Register a set of serial devices attached to a platform device. The
1416 * list is terminated with a zero flags entry, which means we expect
1417 * all entries to have at least UPF_BOOT_AUTOCONF set. Platforms that need
1418 * remapping (such as sh64) should also set UPF_IOREMAP.
1420 static int __devinit sci_probe(struct platform_device *dev)
1422 struct plat_sci_port *p = dev->dev.platform_data;
1425 for (i = 0; p && p->flags != 0; p++, i++) {
1426 struct sci_port *sciport = &sci_ports[i];
1429 if (unlikely(i == SCI_NPORTS)) {
1430 dev_notice(&dev->dev, "Attempting to register port "
1431 "%d when only %d are available.\n",
1433 dev_notice(&dev->dev, "Consider bumping "
1434 "CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
1438 sciport->port.mapbase = p->mapbase;
1441 * For the simple (and majority of) cases where we don't need
1442 * to do any remapping, just cast the cookie directly.
1444 if (p->mapbase && !p->membase && !(p->flags & UPF_IOREMAP))
1445 p->membase = (void __iomem *)p->mapbase;
1447 sciport->port.membase = p->membase;
1449 sciport->port.irq = p->irqs[SCIx_TXI_IRQ];
1450 sciport->port.flags = p->flags;
1451 sciport->port.dev = &dev->dev;
1453 sciport->type = sciport->port.type = p->type;
1455 memcpy(&sciport->irqs, &p->irqs, sizeof(p->irqs));
1457 uart_add_one_port(&sci_uart_driver, &sciport->port);
1460 #if defined(CONFIG_SH_KGDB) && !defined(CONFIG_SH_KGDB_CONSOLE)
1461 kgdb_sci_port = &sci_ports[kgdb_portnum];
1462 kgdb_getchar = kgdb_sci_getchar;
1463 kgdb_putchar = kgdb_sci_putchar;
1466 #ifdef CONFIG_CPU_FREQ
1467 cpufreq_register_notifier(&sci_nb, CPUFREQ_TRANSITION_NOTIFIER);
1468 dev_info(&dev->dev, "CPU frequency notifier registered\n");
1471 #ifdef CONFIG_SH_STANDARD_BIOS
1472 sh_bios_gdb_detach();
1478 static int __devexit sci_remove(struct platform_device *dev)
1482 for (i = 0; i < SCI_NPORTS; i++)
1483 uart_remove_one_port(&sci_uart_driver, &sci_ports[i].port);
1488 static int sci_suspend(struct platform_device *dev, pm_message_t state)
1492 for (i = 0; i < SCI_NPORTS; i++) {
1493 struct sci_port *p = &sci_ports[i];
1495 if (p->type != PORT_UNKNOWN && p->port.dev == &dev->dev)
1496 uart_suspend_port(&sci_uart_driver, &p->port);
1502 static int sci_resume(struct platform_device *dev)
1506 for (i = 0; i < SCI_NPORTS; i++) {
1507 struct sci_port *p = &sci_ports[i];
1509 if (p->type != PORT_UNKNOWN && p->port.dev == &dev->dev)
1510 uart_resume_port(&sci_uart_driver, &p->port);
1516 static struct platform_driver sci_driver = {
1518 .remove = __devexit_p(sci_remove),
1519 .suspend = sci_suspend,
1520 .resume = sci_resume,
1523 .owner = THIS_MODULE,
1527 static int __init sci_init(void)
1535 ret = uart_register_driver(&sci_uart_driver);
1536 if (likely(ret == 0)) {
1537 ret = platform_driver_register(&sci_driver);
1539 uart_unregister_driver(&sci_uart_driver);
1545 static void __exit sci_exit(void)
1547 platform_driver_unregister(&sci_driver);
1548 uart_unregister_driver(&sci_uart_driver);
1551 module_init(sci_init);
1552 module_exit(sci_exit);
1554 MODULE_LICENSE("GPL");
1555 MODULE_ALIAS("platform:sh-sci");