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>
45 #include <linux/notifier.h>
46 #include <linux/cpufreq.h>
47 #include <linux/clk.h>
48 #include <linux/ctype.h>
51 #include <asm/clock.h>
52 #include <asm/sh_bios.h>
59 struct uart_port port
;
64 /* Port IRQs: ERI, RXI, TXI, BRI (optional) */
65 unsigned int irqs
[SCIx_NR_IRQS
];
67 /* Port pin configuration */
68 void (*init_pins
)(struct uart_port
*port
,
71 /* Port enable callback */
72 void (*enable
)(struct uart_port
*port
);
74 /* Port disable callback */
75 void (*disable
)(struct uart_port
*port
);
78 struct timer_list break_timer
;
88 static struct sci_port
*kgdb_sci_port
;
91 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
92 static struct sci_port
*serial_console_port
;
95 /* Function prototypes */
96 static void sci_stop_tx(struct uart_port
*port
);
98 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
100 static struct sci_port sci_ports
[SCI_NPORTS
];
101 static struct uart_driver sci_uart_driver
;
103 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && \
104 defined(CONFIG_SH_STANDARD_BIOS) || defined(CONFIG_SH_KGDB)
105 static inline void handle_error(struct uart_port
*port
)
107 /* Clear error flags */
108 sci_out(port
, SCxSR
, SCxSR_ERROR_CLEAR(port
));
111 static int get_char(struct uart_port
*port
)
114 unsigned short status
;
117 spin_lock_irqsave(&port
->lock
, flags
);
119 status
= sci_in(port
, SCxSR
);
120 if (status
& SCxSR_ERRORS(port
)) {
124 } while (!(status
& SCxSR_RDxF(port
)));
125 c
= sci_in(port
, SCxRDR
);
126 sci_in(port
, SCxSR
); /* Dummy read */
127 sci_out(port
, SCxSR
, SCxSR_RDxF_CLEAR(port
));
128 spin_unlock_irqrestore(&port
->lock
, flags
);
132 #endif /* CONFIG_SH_STANDARD_BIOS || CONFIG_SH_KGDB */
134 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || defined(CONFIG_SH_KGDB)
135 static void put_char(struct uart_port
*port
, char c
)
138 unsigned short status
;
140 spin_lock_irqsave(&port
->lock
, flags
);
143 status
= sci_in(port
, SCxSR
);
144 } while (!(status
& SCxSR_TDxE(port
)));
146 sci_out(port
, SCxTDR
, c
);
147 sci_in(port
, SCxSR
); /* Dummy read */
148 sci_out(port
, SCxSR
, SCxSR_TDxE_CLEAR(port
));
150 spin_unlock_irqrestore(&port
->lock
, flags
);
154 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
155 static void put_string(struct sci_port
*sci_port
, const char *buffer
, int count
)
157 struct uart_port
*port
= &sci_port
->port
;
158 const unsigned char *p
= buffer
;
161 #if defined(CONFIG_SH_STANDARD_BIOS) || defined(CONFIG_SH_KGDB)
165 #ifdef CONFIG_SH_STANDARD_BIOS
166 /* This call only does a trap the first time it is
167 * called, and so is safe to do here unconditionally
169 usegdb
|= sh_bios_in_gdb_mode();
171 #ifdef CONFIG_SH_KGDB
172 usegdb
|= (kgdb_in_gdb_mode
&& (sci_port
== kgdb_sci_port
));
176 /* $<packet info>#<checksum>. */
180 put_char(port
, 'O'); /* 'O'utput to console */
183 for (i
=0; i
<count
; i
++) { /* Don't use run length encoding */
194 put_char(port
, highhex(checksum
));
195 put_char(port
, lowhex(checksum
));
196 } while (get_char(port
) != '+');
198 #endif /* CONFIG_SH_STANDARD_BIOS || CONFIG_SH_KGDB */
199 for (i
=0; i
<count
; i
++) {
201 put_char(port
, '\r');
202 put_char(port
, *p
++);
205 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
207 #ifdef CONFIG_SH_KGDB
208 static int kgdb_sci_getchar(void)
212 /* Keep trying to read a character, this could be neater */
213 while ((c
= get_char(&kgdb_sci_port
->port
)) < 0)
219 static inline void kgdb_sci_putchar(int c
)
221 put_char(&kgdb_sci_port
->port
, c
);
223 #endif /* CONFIG_SH_KGDB */
225 #if defined(__H8300S__)
226 enum { sci_disable
, sci_enable
};
228 static void h8300_sci_config(struct uart_port
* port
, unsigned int ctrl
)
230 volatile unsigned char *mstpcrl
=(volatile unsigned char *)MSTPCRL
;
231 int ch
= (port
->mapbase
- SMR0
) >> 3;
232 unsigned char mask
= 1 << (ch
+1);
234 if (ctrl
== sci_disable
) {
241 static inline void h8300_sci_enable(struct uart_port
*port
)
243 h8300_sci_config(port
, sci_enable
);
246 static inline void h8300_sci_disable(struct uart_port
*port
)
248 h8300_sci_config(port
, sci_disable
);
252 #if defined(SCI_ONLY) || defined(SCI_AND_SCIF) && \
253 defined(__H8300H__) || defined(__H8300S__)
254 static void sci_init_pins_sci(struct uart_port
* port
, unsigned int cflag
)
256 int ch
= (port
->mapbase
- SMR0
) >> 3;
259 H8300_GPIO_DDR(h8300_sci_pins
[ch
].port
,
260 h8300_sci_pins
[ch
].rx
,
262 H8300_GPIO_DDR(h8300_sci_pins
[ch
].port
,
263 h8300_sci_pins
[ch
].tx
,
267 H8300_SCI_DR(ch
) |= h8300_sci_pins
[ch
].tx
;
270 #define sci_init_pins_sci NULL
273 #if defined(CONFIG_CPU_SUBTYPE_SH7707) || defined(CONFIG_CPU_SUBTYPE_SH7709)
274 static void sci_init_pins_irda(struct uart_port
*port
, unsigned int cflag
)
276 unsigned int fcr_val
= 0;
279 fcr_val
|= SCFCR_MCE
;
281 sci_out(port
, SCFCR
, fcr_val
);
284 #define sci_init_pins_irda NULL
288 #define sci_init_pins_scif NULL
291 #if defined(SCIF_ONLY) || defined(SCI_AND_SCIF)
292 #if defined(CONFIG_CPU_SUBTYPE_SH7710) || defined(CONFIG_CPU_SUBTYPE_SH7712)
293 static void sci_init_pins_scif(struct uart_port
* port
, unsigned int cflag
)
295 unsigned int fcr_val
= 0;
297 set_sh771x_scif_pfc(port
);
298 if (cflag
& CRTSCTS
) {
299 fcr_val
|= SCFCR_MCE
;
301 sci_out(port
, SCFCR
, fcr_val
);
303 #elif defined(CONFIG_CPU_SUBTYPE_SH7720) || defined(CONFIG_CPU_SUBTYPE_SH7721)
304 static void sci_init_pins_scif(struct uart_port
*port
, unsigned int cflag
)
306 unsigned int fcr_val
= 0;
309 if (cflag
& CRTSCTS
) {
311 if (port
->mapbase
== 0xa4430000) { /* SCIF0 */
312 /* Clear PTCR bit 9-2; enable all scif pins but sck */
313 data
= ctrl_inw(PORT_PTCR
);
314 ctrl_outw((data
& 0xfc03), PORT_PTCR
);
315 } else if (port
->mapbase
== 0xa4438000) { /* SCIF1 */
316 /* Clear PVCR bit 9-2 */
317 data
= ctrl_inw(PORT_PVCR
);
318 ctrl_outw((data
& 0xfc03), PORT_PVCR
);
320 fcr_val
|= SCFCR_MCE
;
322 if (port
->mapbase
== 0xa4430000) { /* SCIF0 */
323 /* Clear PTCR bit 5-2; enable only tx and rx */
324 data
= ctrl_inw(PORT_PTCR
);
325 ctrl_outw((data
& 0xffc3), PORT_PTCR
);
326 } else if (port
->mapbase
== 0xa4438000) { /* SCIF1 */
327 /* Clear PVCR bit 5-2 */
328 data
= ctrl_inw(PORT_PVCR
);
329 ctrl_outw((data
& 0xffc3), PORT_PVCR
);
332 sci_out(port
, SCFCR
, fcr_val
);
334 #elif defined(CONFIG_CPU_SH3)
335 /* For SH7705, SH7706, SH7707, SH7709, SH7709A, SH7729 */
336 static void sci_init_pins_scif(struct uart_port
*port
, unsigned int cflag
)
338 unsigned int fcr_val
= 0;
341 /* We need to set SCPCR to enable RTS/CTS */
342 data
= ctrl_inw(SCPCR
);
343 /* Clear out SCP7MD1,0, SCP6MD1,0, SCP4MD1,0*/
344 ctrl_outw(data
& 0x0fcf, SCPCR
);
347 fcr_val
|= SCFCR_MCE
;
349 /* We need to set SCPCR to enable RTS/CTS */
350 data
= ctrl_inw(SCPCR
);
351 /* Clear out SCP7MD1,0, SCP4MD1,0,
352 Set SCP6MD1,0 = {01} (output) */
353 ctrl_outw((data
& 0x0fcf) | 0x1000, SCPCR
);
355 data
= ctrl_inb(SCPDR
);
356 /* Set /RTS2 (bit6) = 0 */
357 ctrl_outb(data
& 0xbf, SCPDR
);
360 sci_out(port
, SCFCR
, fcr_val
);
362 #elif defined(CONFIG_CPU_SUBTYPE_SH7722)
363 static void sci_init_pins_scif(struct uart_port
*port
, unsigned int cflag
)
365 unsigned int fcr_val
= 0;
367 if (cflag
& CRTSCTS
) {
368 fcr_val
|= SCFCR_MCE
;
370 ctrl_outw(0x0000, PORT_PSCR
);
374 data
= ctrl_inw(PORT_PSCR
);
377 ctrl_outw(data
, PORT_PSCR
);
379 ctrl_outw(ctrl_inw(SCSPTR0
) & 0x17, SCSPTR0
);
382 sci_out(port
, SCFCR
, fcr_val
);
384 #elif defined(CONFIG_CPU_SUBTYPE_SH7723)
385 static void sci_init_pins_scif(struct uart_port
*port
, unsigned int cflag
)
387 /* Nothing to do here.. */
388 sci_out(port
, SCFCR
, 0);
392 static void sci_init_pins_scif(struct uart_port
*port
, unsigned int cflag
)
394 unsigned int fcr_val
= 0;
396 if (cflag
& CRTSCTS
) {
397 fcr_val
|= SCFCR_MCE
;
399 #if defined(CONFIG_CPU_SUBTYPE_SH7343) || defined(CONFIG_CPU_SUBTYPE_SH7366)
401 #elif defined(CONFIG_CPU_SUBTYPE_SH7763) || \
402 defined(CONFIG_CPU_SUBTYPE_SH7780) || \
403 defined(CONFIG_CPU_SUBTYPE_SH7785) || \
404 defined(CONFIG_CPU_SUBTYPE_SHX3)
405 ctrl_outw(0x0080, SCSPTR0
); /* Set RTS = 1 */
407 ctrl_outw(0x0080, SCSPTR2
); /* Set RTS = 1 */
410 sci_out(port
, SCFCR
, fcr_val
);
414 #if defined(CONFIG_CPU_SUBTYPE_SH7760) || \
415 defined(CONFIG_CPU_SUBTYPE_SH7763) || \
416 defined(CONFIG_CPU_SUBTYPE_SH7780) || \
417 defined(CONFIG_CPU_SUBTYPE_SH7785)
418 static inline int scif_txroom(struct uart_port
*port
)
420 return SCIF_TXROOM_MAX
- (sci_in(port
, SCTFDR
) & 0xff);
423 static inline int scif_rxroom(struct uart_port
*port
)
425 return sci_in(port
, SCRFDR
) & 0xff;
428 static inline int scif_txroom(struct uart_port
*port
)
430 return SCIF_TXROOM_MAX
- (sci_in(port
, SCFDR
) >> 8);
433 static inline int scif_rxroom(struct uart_port
*port
)
435 return sci_in(port
, SCFDR
) & SCIF_RFDC_MASK
;
438 #endif /* SCIF_ONLY || SCI_AND_SCIF */
440 static inline int sci_txroom(struct uart_port
*port
)
442 return ((sci_in(port
, SCxSR
) & SCI_TDRE
) != 0);
445 static inline int sci_rxroom(struct uart_port
*port
)
447 return ((sci_in(port
, SCxSR
) & SCxSR_RDxF(port
)) != 0);
450 /* ********************************************************************** *
451 * the interrupt related routines *
452 * ********************************************************************** */
454 static void sci_transmit_chars(struct uart_port
*port
)
456 struct circ_buf
*xmit
= &port
->info
->xmit
;
457 unsigned int stopped
= uart_tx_stopped(port
);
458 unsigned short status
;
462 status
= sci_in(port
, SCxSR
);
463 if (!(status
& SCxSR_TDxE(port
))) {
464 ctrl
= sci_in(port
, SCSCR
);
465 if (uart_circ_empty(xmit
)) {
466 ctrl
&= ~SCI_CTRL_FLAGS_TIE
;
468 ctrl
|= SCI_CTRL_FLAGS_TIE
;
470 sci_out(port
, SCSCR
, ctrl
);
475 if (port
->type
== PORT_SCIF
)
476 count
= scif_txroom(port
);
479 count
= sci_txroom(port
);
487 } else if (!uart_circ_empty(xmit
) && !stopped
) {
488 c
= xmit
->buf
[xmit
->tail
];
489 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
- 1);
494 sci_out(port
, SCxTDR
, c
);
497 } while (--count
> 0);
499 sci_out(port
, SCxSR
, SCxSR_TDxE_CLEAR(port
));
501 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
502 uart_write_wakeup(port
);
503 if (uart_circ_empty(xmit
)) {
506 ctrl
= sci_in(port
, SCSCR
);
508 #if !defined(SCI_ONLY)
509 if (port
->type
== PORT_SCIF
) {
510 sci_in(port
, SCxSR
); /* Dummy read */
511 sci_out(port
, SCxSR
, SCxSR_TDxE_CLEAR(port
));
515 ctrl
|= SCI_CTRL_FLAGS_TIE
;
516 sci_out(port
, SCSCR
, ctrl
);
520 /* On SH3, SCIF may read end-of-break as a space->mark char */
521 #define STEPFN(c) ({int __c=(c); (((__c-1)|(__c)) == -1); })
523 static inline void sci_receive_chars(struct uart_port
*port
)
525 struct sci_port
*sci_port
= (struct sci_port
*)port
;
526 struct tty_struct
*tty
= port
->info
->tty
;
527 int i
, count
, copied
= 0;
528 unsigned short status
;
531 status
= sci_in(port
, SCxSR
);
532 if (!(status
& SCxSR_RDxF(port
)))
536 #if !defined(SCI_ONLY)
537 if (port
->type
== PORT_SCIF
)
538 count
= scif_rxroom(port
);
541 count
= sci_rxroom(port
);
543 /* Don't copy more bytes than there is room for in the buffer */
544 count
= tty_buffer_request_room(tty
, count
);
546 /* If for any reason we can't copy more data, we're done! */
550 if (port
->type
== PORT_SCI
) {
551 char c
= sci_in(port
, SCxRDR
);
552 if (uart_handle_sysrq_char(port
, c
) || sci_port
->break_flag
)
555 tty_insert_flip_char(tty
, c
, TTY_NORMAL
);
558 for (i
=0; i
<count
; i
++) {
559 char c
= sci_in(port
, SCxRDR
);
560 status
= sci_in(port
, SCxSR
);
561 #if defined(CONFIG_CPU_SH3)
562 /* Skip "chars" during break */
563 if (sci_port
->break_flag
) {
565 (status
& SCxSR_FER(port
))) {
570 /* Nonzero => end-of-break */
571 pr_debug("scif: debounce<%02x>\n", c
);
572 sci_port
->break_flag
= 0;
579 #endif /* CONFIG_CPU_SH3 */
580 if (uart_handle_sysrq_char(port
, c
)) {
585 /* Store data and status */
586 if (status
&SCxSR_FER(port
)) {
588 pr_debug("sci: frame error\n");
589 } else if (status
&SCxSR_PER(port
)) {
591 pr_debug("sci: parity error\n");
594 tty_insert_flip_char(tty
, c
, flag
);
598 sci_in(port
, SCxSR
); /* dummy read */
599 sci_out(port
, SCxSR
, SCxSR_RDxF_CLEAR(port
));
602 port
->icount
.rx
+= count
;
606 /* Tell the rest of the system the news. New characters! */
607 tty_flip_buffer_push(tty
);
609 sci_in(port
, SCxSR
); /* dummy read */
610 sci_out(port
, SCxSR
, SCxSR_RDxF_CLEAR(port
));
614 #define SCI_BREAK_JIFFIES (HZ/20)
615 /* The sci generates interrupts during the break,
616 * 1 per millisecond or so during the break period, for 9600 baud.
617 * So dont bother disabling interrupts.
618 * But dont want more than 1 break event.
619 * Use a kernel timer to periodically poll the rx line until
620 * the break is finished.
622 static void sci_schedule_break_timer(struct sci_port
*port
)
624 port
->break_timer
.expires
= jiffies
+ SCI_BREAK_JIFFIES
;
625 add_timer(&port
->break_timer
);
627 /* Ensure that two consecutive samples find the break over. */
628 static void sci_break_timer(unsigned long data
)
630 struct sci_port
*port
= (struct sci_port
*)data
;
632 if (sci_rxd_in(&port
->port
) == 0) {
633 port
->break_flag
= 1;
634 sci_schedule_break_timer(port
);
635 } else if (port
->break_flag
== 1) {
637 port
->break_flag
= 2;
638 sci_schedule_break_timer(port
);
640 port
->break_flag
= 0;
643 static inline int sci_handle_errors(struct uart_port
*port
)
646 unsigned short status
= sci_in(port
, SCxSR
);
647 struct tty_struct
*tty
= port
->info
->tty
;
649 if (status
& SCxSR_ORER(port
)) {
651 if (tty_insert_flip_char(tty
, 0, TTY_OVERRUN
))
653 pr_debug("sci: overrun error\n");
656 if (status
& SCxSR_FER(port
)) {
657 if (sci_rxd_in(port
) == 0) {
658 /* Notify of BREAK */
659 struct sci_port
*sci_port
= (struct sci_port
*)port
;
661 if (!sci_port
->break_flag
) {
662 sci_port
->break_flag
= 1;
663 sci_schedule_break_timer(sci_port
);
665 /* Do sysrq handling. */
666 if (uart_handle_break(port
))
668 pr_debug("sci: BREAK detected\n");
669 if (tty_insert_flip_char(tty
, 0, TTY_BREAK
))
674 if (tty_insert_flip_char(tty
, 0, TTY_FRAME
))
676 pr_debug("sci: frame error\n");
680 if (status
& SCxSR_PER(port
)) {
682 if (tty_insert_flip_char(tty
, 0, TTY_PARITY
))
684 pr_debug("sci: parity error\n");
688 tty_flip_buffer_push(tty
);
693 static inline int sci_handle_breaks(struct uart_port
*port
)
696 unsigned short status
= sci_in(port
, SCxSR
);
697 struct tty_struct
*tty
= port
->info
->tty
;
698 struct sci_port
*s
= &sci_ports
[port
->line
];
700 if (uart_handle_break(port
))
703 if (!s
->break_flag
&& status
& SCxSR_BRK(port
)) {
704 #if defined(CONFIG_CPU_SH3)
708 /* Notify of BREAK */
709 if (tty_insert_flip_char(tty
, 0, TTY_BREAK
))
711 pr_debug("sci: BREAK detected\n");
714 #if defined(SCIF_ORER)
715 /* XXX: Handle SCIF overrun error */
716 if (port
->type
== PORT_SCIF
&& (sci_in(port
, SCLSR
) & SCIF_ORER
) != 0) {
717 sci_out(port
, SCLSR
, 0);
718 if (tty_insert_flip_char(tty
, 0, TTY_OVERRUN
)) {
720 pr_debug("sci: overrun error\n");
726 tty_flip_buffer_push(tty
);
731 static irqreturn_t
sci_rx_interrupt(int irq
, void *port
)
733 /* I think sci_receive_chars has to be called irrespective
734 * of whether the I_IXOFF is set, otherwise, how is the interrupt
737 sci_receive_chars(port
);
742 static irqreturn_t
sci_tx_interrupt(int irq
, void *ptr
)
744 struct uart_port
*port
= ptr
;
746 spin_lock_irq(&port
->lock
);
747 sci_transmit_chars(port
);
748 spin_unlock_irq(&port
->lock
);
753 static irqreturn_t
sci_er_interrupt(int irq
, void *ptr
)
755 struct uart_port
*port
= ptr
;
758 if (port
->type
== PORT_SCI
) {
759 if (sci_handle_errors(port
)) {
760 /* discard character in rx buffer */
762 sci_out(port
, SCxSR
, SCxSR_RDxF_CLEAR(port
));
765 #if defined(SCIF_ORER)
766 if((sci_in(port
, SCLSR
) & SCIF_ORER
) != 0) {
767 struct tty_struct
*tty
= port
->info
->tty
;
769 sci_out(port
, SCLSR
, 0);
770 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
771 tty_flip_buffer_push(tty
);
772 pr_debug("scif: overrun error\n");
775 sci_rx_interrupt(irq
, ptr
);
778 sci_out(port
, SCxSR
, SCxSR_ERROR_CLEAR(port
));
780 /* Kick the transmission */
781 sci_tx_interrupt(irq
, ptr
);
786 static irqreturn_t
sci_br_interrupt(int irq
, void *ptr
)
788 struct uart_port
*port
= ptr
;
791 sci_handle_breaks(port
);
792 sci_out(port
, SCxSR
, SCxSR_BREAK_CLEAR(port
));
797 static irqreturn_t
sci_mpxed_interrupt(int irq
, void *ptr
)
799 unsigned short ssr_status
, scr_status
;
800 struct uart_port
*port
= ptr
;
802 ssr_status
= sci_in(port
,SCxSR
);
803 scr_status
= sci_in(port
,SCSCR
);
806 if ((ssr_status
& 0x0020) && (scr_status
& 0x0080))
807 sci_tx_interrupt(irq
, ptr
);
809 if ((ssr_status
& 0x0002) && (scr_status
& 0x0040))
810 sci_rx_interrupt(irq
, ptr
);
811 /* Error Interrupt */
812 if ((ssr_status
& 0x0080) && (scr_status
& 0x0400))
813 sci_er_interrupt(irq
, ptr
);
814 /* Break Interrupt */
815 if ((ssr_status
& 0x0010) && (scr_status
& 0x0200))
816 sci_br_interrupt(irq
, ptr
);
821 #ifdef CONFIG_CPU_FREQ
823 * Here we define a transistion notifier so that we can update all of our
824 * ports' baud rate when the peripheral clock changes.
826 static int sci_notifier(struct notifier_block
*self
,
827 unsigned long phase
, void *p
)
829 struct cpufreq_freqs
*freqs
= p
;
832 if ((phase
== CPUFREQ_POSTCHANGE
) ||
833 (phase
== CPUFREQ_RESUMECHANGE
)){
834 for (i
= 0; i
< SCI_NPORTS
; i
++) {
835 struct uart_port
*port
= &sci_ports
[i
].port
;
839 * Update the uartclk per-port if frequency has
840 * changed, since it will no longer necessarily be
841 * consistent with the old frequency.
843 * Really we want to be able to do something like
844 * uart_change_speed() or something along those lines
845 * here to implicitly reset the per-port baud rate..
847 * Clean this up later..
849 clk
= clk_get(NULL
, "module_clk");
850 port
->uartclk
= clk_get_rate(clk
) * 16;
854 printk(KERN_INFO
"%s: got a postchange notification "
855 "for cpu %d (old %d, new %d)\n",
856 __func__
, freqs
->cpu
, freqs
->old
, freqs
->new);
862 static struct notifier_block sci_nb
= { &sci_notifier
, NULL
, 0 };
863 #endif /* CONFIG_CPU_FREQ */
865 static int sci_request_irq(struct sci_port
*port
)
868 irqreturn_t (*handlers
[4])(int irq
, void *ptr
) = {
869 sci_er_interrupt
, sci_rx_interrupt
, sci_tx_interrupt
,
872 const char *desc
[] = { "SCI Receive Error", "SCI Receive Data Full",
873 "SCI Transmit Data Empty", "SCI Break" };
875 if (port
->irqs
[0] == port
->irqs
[1]) {
876 if (!port
->irqs
[0]) {
877 printk(KERN_ERR
"sci: Cannot allocate irq.(IRQ=0)\n");
881 if (request_irq(port
->irqs
[0], sci_mpxed_interrupt
,
882 IRQF_DISABLED
, "sci", port
)) {
883 printk(KERN_ERR
"sci: Cannot allocate irq.\n");
887 for (i
= 0; i
< ARRAY_SIZE(handlers
); i
++) {
890 if (request_irq(port
->irqs
[i
], handlers
[i
],
891 IRQF_DISABLED
, desc
[i
], port
)) {
892 printk(KERN_ERR
"sci: Cannot allocate irq.\n");
901 static void sci_free_irq(struct sci_port
*port
)
905 if (port
->irqs
[0] == port
->irqs
[1]) {
907 printk("sci: sci_free_irq error\n");
909 free_irq(port
->irqs
[0], port
);
911 for (i
= 0; i
< ARRAY_SIZE(port
->irqs
); i
++) {
915 free_irq(port
->irqs
[i
], port
);
920 static unsigned int sci_tx_empty(struct uart_port
*port
)
926 static void sci_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
928 /* This routine is used for seting signals of: DTR, DCD, CTS/RTS */
929 /* We use SCIF's hardware for CTS/RTS, so don't need any for that. */
930 /* If you have signals for DTR and DCD, please implement here. */
933 static unsigned int sci_get_mctrl(struct uart_port
*port
)
935 /* This routine is used for geting signals of: DTR, DCD, DSR, RI,
938 return TIOCM_DTR
| TIOCM_RTS
| TIOCM_DSR
;
941 static void sci_start_tx(struct uart_port
*port
)
945 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
946 ctrl
= sci_in(port
, SCSCR
);
947 ctrl
|= SCI_CTRL_FLAGS_TIE
;
948 sci_out(port
, SCSCR
, ctrl
);
951 static void sci_stop_tx(struct uart_port
*port
)
955 /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
956 ctrl
= sci_in(port
, SCSCR
);
957 ctrl
&= ~SCI_CTRL_FLAGS_TIE
;
958 sci_out(port
, SCSCR
, ctrl
);
961 static void sci_start_rx(struct uart_port
*port
, unsigned int tty_start
)
965 /* Set RIE (Receive Interrupt Enable) bit in SCSCR */
966 ctrl
= sci_in(port
, SCSCR
);
967 ctrl
|= SCI_CTRL_FLAGS_RIE
| SCI_CTRL_FLAGS_REIE
;
968 sci_out(port
, SCSCR
, ctrl
);
971 static void sci_stop_rx(struct uart_port
*port
)
975 /* Clear RIE (Receive Interrupt Enable) bit in SCSCR */
976 ctrl
= sci_in(port
, SCSCR
);
977 ctrl
&= ~(SCI_CTRL_FLAGS_RIE
| SCI_CTRL_FLAGS_REIE
);
978 sci_out(port
, SCSCR
, ctrl
);
981 static void sci_enable_ms(struct uart_port
*port
)
983 /* Nothing here yet .. */
986 static void sci_break_ctl(struct uart_port
*port
, int break_state
)
988 /* Nothing here yet .. */
991 static int sci_startup(struct uart_port
*port
)
993 struct sci_port
*s
= &sci_ports
[port
->line
];
998 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
999 s
->clk
= clk_get(NULL
, "module_clk");
1004 sci_start_rx(port
, 1);
1009 static void sci_shutdown(struct uart_port
*port
)
1011 struct sci_port
*s
= &sci_ports
[port
->line
];
1020 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
1026 static void sci_set_termios(struct uart_port
*port
, struct ktermios
*termios
,
1027 struct ktermios
*old
)
1029 struct sci_port
*s
= &sci_ports
[port
->line
];
1030 unsigned int status
, baud
, smr_val
;
1033 baud
= uart_get_baud_rate(port
, termios
, old
, 0, port
->uartclk
/16);
1041 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
1042 t
= SCBRR_VALUE(baud
, clk_get_rate(s
->clk
));
1044 t
= SCBRR_VALUE(baud
);
1051 status
= sci_in(port
, SCxSR
);
1052 } while (!(status
& SCxSR_TEND(port
)));
1054 sci_out(port
, SCSCR
, 0x00); /* TE=0, RE=0, CKE1=0 */
1056 #if !defined(SCI_ONLY)
1057 if (port
->type
== PORT_SCIF
)
1058 sci_out(port
, SCFCR
, SCFCR_RFRST
| SCFCR_TFRST
);
1061 smr_val
= sci_in(port
, SCSMR
) & 3;
1062 if ((termios
->c_cflag
& CSIZE
) == CS7
)
1064 if (termios
->c_cflag
& PARENB
)
1066 if (termios
->c_cflag
& PARODD
)
1068 if (termios
->c_cflag
& CSTOPB
)
1071 uart_update_timeout(port
, termios
->c_cflag
, baud
);
1073 sci_out(port
, SCSMR
, smr_val
);
1077 sci_out(port
, SCSMR
, (sci_in(port
, SCSMR
) & ~3) | 1);
1080 sci_out(port
, SCSMR
, sci_in(port
, SCSMR
) & ~3);
1082 sci_out(port
, SCBRR
, t
);
1083 udelay((1000000+(baud
-1)) / baud
); /* Wait one bit interval */
1086 if (likely(s
->init_pins
))
1087 s
->init_pins(port
, termios
->c_cflag
);
1089 sci_out(port
, SCSCR
, SCSCR_INIT(port
));
1091 if ((termios
->c_cflag
& CREAD
) != 0)
1092 sci_start_rx(port
,0);
1095 static const char *sci_type(struct uart_port
*port
)
1097 switch (port
->type
) {
1098 case PORT_SCI
: return "sci";
1099 case PORT_SCIF
: return "scif";
1100 case PORT_IRDA
: return "irda";
1106 static void sci_release_port(struct uart_port
*port
)
1108 /* Nothing here yet .. */
1111 static int sci_request_port(struct uart_port
*port
)
1113 /* Nothing here yet .. */
1117 static void sci_config_port(struct uart_port
*port
, int flags
)
1119 struct sci_port
*s
= &sci_ports
[port
->line
];
1121 port
->type
= s
->type
;
1123 switch (port
->type
) {
1125 s
->init_pins
= sci_init_pins_sci
;
1128 s
->init_pins
= sci_init_pins_scif
;
1131 s
->init_pins
= sci_init_pins_irda
;
1135 #if defined(CONFIG_CPU_SUBTYPE_SH5_101) || defined(CONFIG_CPU_SUBTYPE_SH5_103)
1136 if (port
->mapbase
== 0)
1137 port
->mapbase
= onchip_remap(SCIF_ADDR_SH5
, 1024, "SCIF");
1139 port
->membase
= (void __iomem
*)port
->mapbase
;
1143 static int sci_verify_port(struct uart_port
*port
, struct serial_struct
*ser
)
1145 struct sci_port
*s
= &sci_ports
[port
->line
];
1147 if (ser
->irq
!= s
->irqs
[SCIx_TXI_IRQ
] || ser
->irq
> NR_IRQS
)
1149 if (ser
->baud_base
< 2400)
1150 /* No paper tape reader for Mitch.. */
1156 static struct uart_ops sci_uart_ops
= {
1157 .tx_empty
= sci_tx_empty
,
1158 .set_mctrl
= sci_set_mctrl
,
1159 .get_mctrl
= sci_get_mctrl
,
1160 .start_tx
= sci_start_tx
,
1161 .stop_tx
= sci_stop_tx
,
1162 .stop_rx
= sci_stop_rx
,
1163 .enable_ms
= sci_enable_ms
,
1164 .break_ctl
= sci_break_ctl
,
1165 .startup
= sci_startup
,
1166 .shutdown
= sci_shutdown
,
1167 .set_termios
= sci_set_termios
,
1169 .release_port
= sci_release_port
,
1170 .request_port
= sci_request_port
,
1171 .config_port
= sci_config_port
,
1172 .verify_port
= sci_verify_port
,
1175 static void __init
sci_init_ports(void)
1177 static int first
= 1;
1185 for (i
= 0; i
< SCI_NPORTS
; i
++) {
1186 sci_ports
[i
].port
.ops
= &sci_uart_ops
;
1187 sci_ports
[i
].port
.iotype
= UPIO_MEM
;
1188 sci_ports
[i
].port
.line
= i
;
1189 sci_ports
[i
].port
.fifosize
= 1;
1191 #if defined(__H8300H__) || defined(__H8300S__)
1193 sci_ports
[i
].enable
= h8300_sci_enable
;
1194 sci_ports
[i
].disable
= h8300_sci_disable
;
1196 sci_ports
[i
].port
.uartclk
= CONFIG_CPU_CLOCK
;
1197 #elif defined(CONFIG_SUPERH64)
1198 sci_ports
[i
].port
.uartclk
= current_cpu_data
.module_clock
* 16;
1201 * XXX: We should use a proper SCI/SCIF clock
1204 struct clk
*clk
= clk_get(NULL
, "module_clk");
1205 sci_ports
[i
].port
.uartclk
= clk_get_rate(clk
) * 16;
1210 sci_ports
[i
].break_timer
.data
= (unsigned long)&sci_ports
[i
];
1211 sci_ports
[i
].break_timer
.function
= sci_break_timer
;
1213 init_timer(&sci_ports
[i
].break_timer
);
1217 int __init
early_sci_setup(struct uart_port
*port
)
1219 if (unlikely(port
->line
> SCI_NPORTS
))
1224 sci_ports
[port
->line
].port
.membase
= port
->membase
;
1225 sci_ports
[port
->line
].port
.mapbase
= port
->mapbase
;
1226 sci_ports
[port
->line
].port
.type
= port
->type
;
1231 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1233 * Print a string to the serial port trying not to disturb
1234 * any possible real use of the port...
1236 static void serial_console_write(struct console
*co
, const char *s
,
1239 put_string(serial_console_port
, s
, count
);
1242 static int __init
serial_console_setup(struct console
*co
, char *options
)
1244 struct uart_port
*port
;
1252 * Check whether an invalid uart number has been specified, and
1253 * if so, search for the first available port that does have
1256 if (co
->index
>= SCI_NPORTS
)
1259 serial_console_port
= &sci_ports
[co
->index
];
1260 port
= &serial_console_port
->port
;
1263 * Also need to check port->type, we don't actually have any
1264 * UPIO_PORT ports, but uart_report_port() handily misreports
1265 * it anyways if we don't have a port available by the time this is
1270 if (!port
->membase
|| !port
->mapbase
)
1273 port
->type
= serial_console_port
->type
;
1275 #if defined(CONFIG_SUPERH) && !defined(CONFIG_SUPERH64)
1276 if (!serial_console_port
->clk
)
1277 serial_console_port
->clk
= clk_get(NULL
, "module_clk");
1280 if (port
->flags
& UPF_IOREMAP
)
1281 sci_config_port(port
, 0);
1283 if (serial_console_port
->enable
)
1284 serial_console_port
->enable(port
);
1287 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
1289 ret
= uart_set_options(port
, co
, baud
, parity
, bits
, flow
);
1290 #if defined(__H8300H__) || defined(__H8300S__)
1291 /* disable rx interrupt */
1298 static struct console serial_console
= {
1300 .device
= uart_console_device
,
1301 .write
= serial_console_write
,
1302 .setup
= serial_console_setup
,
1303 .flags
= CON_PRINTBUFFER
,
1305 .data
= &sci_uart_driver
,
1308 static int __init
sci_console_init(void)
1311 register_console(&serial_console
);
1314 console_initcall(sci_console_init
);
1315 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
1317 #ifdef CONFIG_SH_KGDB_CONSOLE
1319 * FIXME: Most of this can go away.. at the moment, we rely on
1320 * arch/sh/kernel/setup.c to do the command line parsing for kgdb, though
1321 * most of that can easily be done here instead.
1323 * For the time being, just accept the values that were parsed earlier..
1325 static void __init
kgdb_console_get_options(struct uart_port
*port
, int *baud
,
1326 int *parity
, int *bits
)
1329 *parity
= tolower(kgdb_parity
);
1330 *bits
= kgdb_bits
- '0';
1334 * The naming here is somewhat misleading, since kgdb_console_setup() takes
1335 * care of the early-on initialization for kgdb, regardless of whether we
1336 * actually use kgdb as a console or not.
1338 * On the plus side, this lets us kill off the old kgdb_sci_setup() nonsense.
1340 int __init
kgdb_console_setup(struct console
*co
, char *options
)
1342 struct uart_port
*port
= &sci_ports
[kgdb_portnum
].port
;
1348 if (co
->index
!= kgdb_portnum
)
1349 co
->index
= kgdb_portnum
;
1351 kgdb_sci_port
= &sci_ports
[co
->index
];
1352 port
= &kgdb_sci_port
->port
;
1355 * Also need to check port->type, we don't actually have any
1356 * UPIO_PORT ports, but uart_report_port() handily misreports
1357 * it anyways if we don't have a port available by the time this is
1362 if (!port
->membase
|| !port
->mapbase
)
1366 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
1368 kgdb_console_get_options(port
, &baud
, &parity
, &bits
);
1370 kgdb_getchar
= kgdb_sci_getchar
;
1371 kgdb_putchar
= kgdb_sci_putchar
;
1373 return uart_set_options(port
, co
, baud
, parity
, bits
, flow
);
1376 static struct console kgdb_console
= {
1378 .device
= uart_console_device
,
1379 .write
= kgdb_console_write
,
1380 .setup
= kgdb_console_setup
,
1381 .flags
= CON_PRINTBUFFER
,
1383 .data
= &sci_uart_driver
,
1386 /* Register the KGDB console so we get messages (d'oh!) */
1387 static int __init
kgdb_console_init(void)
1390 register_console(&kgdb_console
);
1393 console_initcall(kgdb_console_init
);
1394 #endif /* CONFIG_SH_KGDB_CONSOLE */
1396 #if defined(CONFIG_SH_KGDB_CONSOLE)
1397 #define SCI_CONSOLE &kgdb_console
1398 #elif defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
1399 #define SCI_CONSOLE &serial_console
1401 #define SCI_CONSOLE 0
1404 static char banner
[] __initdata
=
1405 KERN_INFO
"SuperH SCI(F) driver initialized\n";
1407 static struct uart_driver sci_uart_driver
= {
1408 .owner
= THIS_MODULE
,
1409 .driver_name
= "sci",
1410 .dev_name
= "ttySC",
1412 .minor
= SCI_MINOR_START
,
1414 .cons
= SCI_CONSOLE
,
1418 * Register a set of serial devices attached to a platform device. The
1419 * list is terminated with a zero flags entry, which means we expect
1420 * all entries to have at least UPF_BOOT_AUTOCONF set. Platforms that need
1421 * remapping (such as sh64) should also set UPF_IOREMAP.
1423 static int __devinit
sci_probe(struct platform_device
*dev
)
1425 struct plat_sci_port
*p
= dev
->dev
.platform_data
;
1428 for (i
= 0; p
&& p
->flags
!= 0; p
++, i
++) {
1429 struct sci_port
*sciport
= &sci_ports
[i
];
1432 if (unlikely(i
== SCI_NPORTS
)) {
1433 dev_notice(&dev
->dev
, "Attempting to register port "
1434 "%d when only %d are available.\n",
1436 dev_notice(&dev
->dev
, "Consider bumping "
1437 "CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
1441 sciport
->port
.mapbase
= p
->mapbase
;
1444 * For the simple (and majority of) cases where we don't need
1445 * to do any remapping, just cast the cookie directly.
1447 if (p
->mapbase
&& !p
->membase
&& !(p
->flags
& UPF_IOREMAP
))
1448 p
->membase
= (void __iomem
*)p
->mapbase
;
1450 sciport
->port
.membase
= p
->membase
;
1452 sciport
->port
.irq
= p
->irqs
[SCIx_TXI_IRQ
];
1453 sciport
->port
.flags
= p
->flags
;
1454 sciport
->port
.dev
= &dev
->dev
;
1456 sciport
->type
= sciport
->port
.type
= p
->type
;
1458 memcpy(&sciport
->irqs
, &p
->irqs
, sizeof(p
->irqs
));
1460 uart_add_one_port(&sci_uart_driver
, &sciport
->port
);
1463 #if defined(CONFIG_SH_KGDB) && !defined(CONFIG_SH_KGDB_CONSOLE)
1464 kgdb_sci_port
= &sci_ports
[kgdb_portnum
];
1465 kgdb_getchar
= kgdb_sci_getchar
;
1466 kgdb_putchar
= kgdb_sci_putchar
;
1469 #ifdef CONFIG_CPU_FREQ
1470 cpufreq_register_notifier(&sci_nb
, CPUFREQ_TRANSITION_NOTIFIER
);
1471 dev_info(&dev
->dev
, "CPU frequency notifier registered\n");
1474 #ifdef CONFIG_SH_STANDARD_BIOS
1475 sh_bios_gdb_detach();
1481 static int __devexit
sci_remove(struct platform_device
*dev
)
1485 for (i
= 0; i
< SCI_NPORTS
; i
++)
1486 uart_remove_one_port(&sci_uart_driver
, &sci_ports
[i
].port
);
1491 static int sci_suspend(struct platform_device
*dev
, pm_message_t state
)
1495 for (i
= 0; i
< SCI_NPORTS
; i
++) {
1496 struct sci_port
*p
= &sci_ports
[i
];
1498 if (p
->type
!= PORT_UNKNOWN
&& p
->port
.dev
== &dev
->dev
)
1499 uart_suspend_port(&sci_uart_driver
, &p
->port
);
1505 static int sci_resume(struct platform_device
*dev
)
1509 for (i
= 0; i
< SCI_NPORTS
; i
++) {
1510 struct sci_port
*p
= &sci_ports
[i
];
1512 if (p
->type
!= PORT_UNKNOWN
&& p
->port
.dev
== &dev
->dev
)
1513 uart_resume_port(&sci_uart_driver
, &p
->port
);
1519 static struct platform_driver sci_driver
= {
1521 .remove
= __devexit_p(sci_remove
),
1522 .suspend
= sci_suspend
,
1523 .resume
= sci_resume
,
1526 .owner
= THIS_MODULE
,
1530 static int __init
sci_init(void)
1538 ret
= uart_register_driver(&sci_uart_driver
);
1539 if (likely(ret
== 0)) {
1540 ret
= platform_driver_register(&sci_driver
);
1542 uart_unregister_driver(&sci_uart_driver
);
1548 static void __exit
sci_exit(void)
1550 platform_driver_unregister(&sci_driver
);
1551 uart_unregister_driver(&sci_uart_driver
);
1554 module_init(sci_init
);
1555 module_exit(sci_exit
);
1557 MODULE_LICENSE("GPL");
1558 MODULE_ALIAS("platform:sh-sci");