Merge branch 'ioat' into dmaengine
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / serial / sh-sci.c
blob8bddc70bb5864488760230c59af7f1d5cc57b8c3
1 /*
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
20 * for more details.
22 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
23 #define SUPPORT_SYSRQ
24 #endif
26 #undef DEBUG
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>
39 #include <linux/mm.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>
50 #include <linux/list.h>
51 #include <linux/dmaengine.h>
52 #include <linux/scatterlist.h>
53 #include <linux/slab.h>
55 #ifdef CONFIG_SUPERH
56 #include <asm/sh_bios.h>
57 #endif
59 #ifdef CONFIG_H8300
60 #include <asm/gpio.h>
61 #endif
63 #include "sh-sci.h"
65 struct sci_port {
66 struct uart_port port;
68 /* Port type */
69 unsigned int type;
71 /* Port IRQs: ERI, RXI, TXI, BRI (optional) */
72 unsigned int irqs[SCIx_NR_IRQS];
74 /* Port enable callback */
75 void (*enable)(struct uart_port *port);
77 /* Port disable callback */
78 void (*disable)(struct uart_port *port);
80 /* Break timer */
81 struct timer_list break_timer;
82 int break_flag;
84 /* Interface clock */
85 struct clk *iclk;
86 /* Data clock */
87 struct clk *dclk;
89 struct list_head node;
90 struct dma_chan *chan_tx;
91 struct dma_chan *chan_rx;
92 #ifdef CONFIG_SERIAL_SH_SCI_DMA
93 struct device *dma_dev;
94 enum sh_dmae_slave_chan_id slave_tx;
95 enum sh_dmae_slave_chan_id slave_rx;
96 struct dma_async_tx_descriptor *desc_tx;
97 struct dma_async_tx_descriptor *desc_rx[2];
98 dma_cookie_t cookie_tx;
99 dma_cookie_t cookie_rx[2];
100 dma_cookie_t active_rx;
101 struct scatterlist sg_tx;
102 unsigned int sg_len_tx;
103 struct scatterlist sg_rx[2];
104 size_t buf_len_rx;
105 struct sh_dmae_slave param_tx;
106 struct sh_dmae_slave param_rx;
107 struct work_struct work_tx;
108 struct work_struct work_rx;
109 struct timer_list rx_timer;
110 #endif
113 struct sh_sci_priv {
114 spinlock_t lock;
115 struct list_head ports;
116 struct notifier_block clk_nb;
119 /* Function prototypes */
120 static void sci_stop_tx(struct uart_port *port);
122 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
124 static struct sci_port sci_ports[SCI_NPORTS];
125 static struct uart_driver sci_uart_driver;
127 static inline struct sci_port *
128 to_sci_port(struct uart_port *uart)
130 return container_of(uart, struct sci_port, port);
133 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
135 #ifdef CONFIG_CONSOLE_POLL
136 static inline void handle_error(struct uart_port *port)
138 /* Clear error flags */
139 sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
142 static int sci_poll_get_char(struct uart_port *port)
144 unsigned short status;
145 int c;
147 do {
148 status = sci_in(port, SCxSR);
149 if (status & SCxSR_ERRORS(port)) {
150 handle_error(port);
151 continue;
153 } while (!(status & SCxSR_RDxF(port)));
155 c = sci_in(port, SCxRDR);
157 /* Dummy read */
158 sci_in(port, SCxSR);
159 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
161 return c;
163 #endif
165 static void sci_poll_put_char(struct uart_port *port, unsigned char c)
167 unsigned short status;
169 do {
170 status = sci_in(port, SCxSR);
171 } while (!(status & SCxSR_TDxE(port)));
173 sci_out(port, SCxTDR, c);
174 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port) & ~SCxSR_TEND(port));
176 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE */
178 #if defined(__H8300H__) || defined(__H8300S__)
179 static void sci_init_pins(struct uart_port *port, unsigned int cflag)
181 int ch = (port->mapbase - SMR0) >> 3;
183 /* set DDR regs */
184 H8300_GPIO_DDR(h8300_sci_pins[ch].port,
185 h8300_sci_pins[ch].rx,
186 H8300_GPIO_INPUT);
187 H8300_GPIO_DDR(h8300_sci_pins[ch].port,
188 h8300_sci_pins[ch].tx,
189 H8300_GPIO_OUTPUT);
191 /* tx mark output*/
192 H8300_SCI_DR(ch) |= h8300_sci_pins[ch].tx;
194 #elif defined(CONFIG_CPU_SUBTYPE_SH7710) || defined(CONFIG_CPU_SUBTYPE_SH7712)
195 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
197 if (port->mapbase == 0xA4400000) {
198 __raw_writew(__raw_readw(PACR) & 0xffc0, PACR);
199 __raw_writew(__raw_readw(PBCR) & 0x0fff, PBCR);
200 } else if (port->mapbase == 0xA4410000)
201 __raw_writew(__raw_readw(PBCR) & 0xf003, PBCR);
203 #elif defined(CONFIG_CPU_SUBTYPE_SH7720) || defined(CONFIG_CPU_SUBTYPE_SH7721)
204 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
206 unsigned short data;
208 if (cflag & CRTSCTS) {
209 /* enable RTS/CTS */
210 if (port->mapbase == 0xa4430000) { /* SCIF0 */
211 /* Clear PTCR bit 9-2; enable all scif pins but sck */
212 data = __raw_readw(PORT_PTCR);
213 __raw_writew((data & 0xfc03), PORT_PTCR);
214 } else if (port->mapbase == 0xa4438000) { /* SCIF1 */
215 /* Clear PVCR bit 9-2 */
216 data = __raw_readw(PORT_PVCR);
217 __raw_writew((data & 0xfc03), PORT_PVCR);
219 } else {
220 if (port->mapbase == 0xa4430000) { /* SCIF0 */
221 /* Clear PTCR bit 5-2; enable only tx and rx */
222 data = __raw_readw(PORT_PTCR);
223 __raw_writew((data & 0xffc3), PORT_PTCR);
224 } else if (port->mapbase == 0xa4438000) { /* SCIF1 */
225 /* Clear PVCR bit 5-2 */
226 data = __raw_readw(PORT_PVCR);
227 __raw_writew((data & 0xffc3), PORT_PVCR);
231 #elif defined(CONFIG_CPU_SH3)
232 /* For SH7705, SH7706, SH7707, SH7709, SH7709A, SH7729 */
233 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
235 unsigned short data;
237 /* We need to set SCPCR to enable RTS/CTS */
238 data = __raw_readw(SCPCR);
239 /* Clear out SCP7MD1,0, SCP6MD1,0, SCP4MD1,0*/
240 __raw_writew(data & 0x0fcf, SCPCR);
242 if (!(cflag & CRTSCTS)) {
243 /* We need to set SCPCR to enable RTS/CTS */
244 data = __raw_readw(SCPCR);
245 /* Clear out SCP7MD1,0, SCP4MD1,0,
246 Set SCP6MD1,0 = {01} (output) */
247 __raw_writew((data & 0x0fcf) | 0x1000, SCPCR);
249 data = __raw_readb(SCPDR);
250 /* Set /RTS2 (bit6) = 0 */
251 __raw_writeb(data & 0xbf, SCPDR);
254 #elif defined(CONFIG_CPU_SUBTYPE_SH7722)
255 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
257 unsigned short data;
259 if (port->mapbase == 0xffe00000) {
260 data = __raw_readw(PSCR);
261 data &= ~0x03cf;
262 if (!(cflag & CRTSCTS))
263 data |= 0x0340;
265 __raw_writew(data, PSCR);
268 #elif defined(CONFIG_CPU_SUBTYPE_SH7757) || \
269 defined(CONFIG_CPU_SUBTYPE_SH7763) || \
270 defined(CONFIG_CPU_SUBTYPE_SH7780) || \
271 defined(CONFIG_CPU_SUBTYPE_SH7785) || \
272 defined(CONFIG_CPU_SUBTYPE_SH7786) || \
273 defined(CONFIG_CPU_SUBTYPE_SHX3)
274 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
276 if (!(cflag & CRTSCTS))
277 __raw_writew(0x0080, SCSPTR0); /* Set RTS = 1 */
279 #elif defined(CONFIG_CPU_SH4) && !defined(CONFIG_CPU_SH4A)
280 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
282 if (!(cflag & CRTSCTS))
283 __raw_writew(0x0080, SCSPTR2); /* Set RTS = 1 */
285 #else
286 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
288 /* Nothing to do */
290 #endif
292 #if defined(CONFIG_CPU_SUBTYPE_SH7760) || \
293 defined(CONFIG_CPU_SUBTYPE_SH7780) || \
294 defined(CONFIG_CPU_SUBTYPE_SH7785) || \
295 defined(CONFIG_CPU_SUBTYPE_SH7786)
296 static int scif_txfill(struct uart_port *port)
298 return sci_in(port, SCTFDR) & 0xff;
301 static int scif_txroom(struct uart_port *port)
303 return SCIF_TXROOM_MAX - scif_txfill(port);
306 static int scif_rxfill(struct uart_port *port)
308 return sci_in(port, SCRFDR) & 0xff;
310 #elif defined(CONFIG_CPU_SUBTYPE_SH7763)
311 static int scif_txfill(struct uart_port *port)
313 if (port->mapbase == 0xffe00000 ||
314 port->mapbase == 0xffe08000)
315 /* SCIF0/1*/
316 return sci_in(port, SCTFDR) & 0xff;
317 else
318 /* SCIF2 */
319 return sci_in(port, SCFDR) >> 8;
322 static int scif_txroom(struct uart_port *port)
324 if (port->mapbase == 0xffe00000 ||
325 port->mapbase == 0xffe08000)
326 /* SCIF0/1*/
327 return SCIF_TXROOM_MAX - scif_txfill(port);
328 else
329 /* SCIF2 */
330 return SCIF2_TXROOM_MAX - scif_txfill(port);
333 static int scif_rxfill(struct uart_port *port)
335 if ((port->mapbase == 0xffe00000) ||
336 (port->mapbase == 0xffe08000)) {
337 /* SCIF0/1*/
338 return sci_in(port, SCRFDR) & 0xff;
339 } else {
340 /* SCIF2 */
341 return sci_in(port, SCFDR) & SCIF2_RFDC_MASK;
344 #else
345 static int scif_txfill(struct uart_port *port)
347 return sci_in(port, SCFDR) >> 8;
350 static int scif_txroom(struct uart_port *port)
352 return SCIF_TXROOM_MAX - scif_txfill(port);
355 static int scif_rxfill(struct uart_port *port)
357 return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
359 #endif
361 static int sci_txfill(struct uart_port *port)
363 return !(sci_in(port, SCxSR) & SCI_TDRE);
366 static int sci_txroom(struct uart_port *port)
368 return !sci_txfill(port);
371 static int sci_rxfill(struct uart_port *port)
373 return (sci_in(port, SCxSR) & SCxSR_RDxF(port)) != 0;
376 /* ********************************************************************** *
377 * the interrupt related routines *
378 * ********************************************************************** */
380 static void sci_transmit_chars(struct uart_port *port)
382 struct circ_buf *xmit = &port->state->xmit;
383 unsigned int stopped = uart_tx_stopped(port);
384 unsigned short status;
385 unsigned short ctrl;
386 int count;
388 status = sci_in(port, SCxSR);
389 if (!(status & SCxSR_TDxE(port))) {
390 ctrl = sci_in(port, SCSCR);
391 if (uart_circ_empty(xmit))
392 ctrl &= ~SCI_CTRL_FLAGS_TIE;
393 else
394 ctrl |= SCI_CTRL_FLAGS_TIE;
395 sci_out(port, SCSCR, ctrl);
396 return;
399 if (port->type == PORT_SCI)
400 count = sci_txroom(port);
401 else
402 count = scif_txroom(port);
404 do {
405 unsigned char c;
407 if (port->x_char) {
408 c = port->x_char;
409 port->x_char = 0;
410 } else if (!uart_circ_empty(xmit) && !stopped) {
411 c = xmit->buf[xmit->tail];
412 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
413 } else {
414 break;
417 sci_out(port, SCxTDR, c);
419 port->icount.tx++;
420 } while (--count > 0);
422 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
424 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
425 uart_write_wakeup(port);
426 if (uart_circ_empty(xmit)) {
427 sci_stop_tx(port);
428 } else {
429 ctrl = sci_in(port, SCSCR);
431 if (port->type != PORT_SCI) {
432 sci_in(port, SCxSR); /* Dummy read */
433 sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
436 ctrl |= SCI_CTRL_FLAGS_TIE;
437 sci_out(port, SCSCR, ctrl);
441 /* On SH3, SCIF may read end-of-break as a space->mark char */
442 #define STEPFN(c) ({int __c = (c); (((__c-1)|(__c)) == -1); })
444 static inline void sci_receive_chars(struct uart_port *port)
446 struct sci_port *sci_port = to_sci_port(port);
447 struct tty_struct *tty = port->state->port.tty;
448 int i, count, copied = 0;
449 unsigned short status;
450 unsigned char flag;
452 status = sci_in(port, SCxSR);
453 if (!(status & SCxSR_RDxF(port)))
454 return;
456 while (1) {
457 if (port->type == PORT_SCI)
458 count = sci_rxfill(port);
459 else
460 count = scif_rxfill(port);
462 /* Don't copy more bytes than there is room for in the buffer */
463 count = tty_buffer_request_room(tty, count);
465 /* If for any reason we can't copy more data, we're done! */
466 if (count == 0)
467 break;
469 if (port->type == PORT_SCI) {
470 char c = sci_in(port, SCxRDR);
471 if (uart_handle_sysrq_char(port, c) ||
472 sci_port->break_flag)
473 count = 0;
474 else
475 tty_insert_flip_char(tty, c, TTY_NORMAL);
476 } else {
477 for (i = 0; i < count; i++) {
478 char c = sci_in(port, SCxRDR);
479 status = sci_in(port, SCxSR);
480 #if defined(CONFIG_CPU_SH3)
481 /* Skip "chars" during break */
482 if (sci_port->break_flag) {
483 if ((c == 0) &&
484 (status & SCxSR_FER(port))) {
485 count--; i--;
486 continue;
489 /* Nonzero => end-of-break */
490 dev_dbg(port->dev, "debounce<%02x>\n", c);
491 sci_port->break_flag = 0;
493 if (STEPFN(c)) {
494 count--; i--;
495 continue;
498 #endif /* CONFIG_CPU_SH3 */
499 if (uart_handle_sysrq_char(port, c)) {
500 count--; i--;
501 continue;
504 /* Store data and status */
505 if (status & SCxSR_FER(port)) {
506 flag = TTY_FRAME;
507 dev_notice(port->dev, "frame error\n");
508 } else if (status & SCxSR_PER(port)) {
509 flag = TTY_PARITY;
510 dev_notice(port->dev, "parity error\n");
511 } else
512 flag = TTY_NORMAL;
514 tty_insert_flip_char(tty, c, flag);
518 sci_in(port, SCxSR); /* dummy read */
519 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
521 copied += count;
522 port->icount.rx += count;
525 if (copied) {
526 /* Tell the rest of the system the news. New characters! */
527 tty_flip_buffer_push(tty);
528 } else {
529 sci_in(port, SCxSR); /* dummy read */
530 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
534 #define SCI_BREAK_JIFFIES (HZ/20)
535 /* The sci generates interrupts during the break,
536 * 1 per millisecond or so during the break period, for 9600 baud.
537 * So dont bother disabling interrupts.
538 * But dont want more than 1 break event.
539 * Use a kernel timer to periodically poll the rx line until
540 * the break is finished.
542 static void sci_schedule_break_timer(struct sci_port *port)
544 port->break_timer.expires = jiffies + SCI_BREAK_JIFFIES;
545 add_timer(&port->break_timer);
547 /* Ensure that two consecutive samples find the break over. */
548 static void sci_break_timer(unsigned long data)
550 struct sci_port *port = (struct sci_port *)data;
552 if (sci_rxd_in(&port->port) == 0) {
553 port->break_flag = 1;
554 sci_schedule_break_timer(port);
555 } else if (port->break_flag == 1) {
556 /* break is over. */
557 port->break_flag = 2;
558 sci_schedule_break_timer(port);
559 } else
560 port->break_flag = 0;
563 static inline int sci_handle_errors(struct uart_port *port)
565 int copied = 0;
566 unsigned short status = sci_in(port, SCxSR);
567 struct tty_struct *tty = port->state->port.tty;
569 if (status & SCxSR_ORER(port)) {
570 /* overrun error */
571 if (tty_insert_flip_char(tty, 0, TTY_OVERRUN))
572 copied++;
574 dev_notice(port->dev, "overrun error");
577 if (status & SCxSR_FER(port)) {
578 if (sci_rxd_in(port) == 0) {
579 /* Notify of BREAK */
580 struct sci_port *sci_port = to_sci_port(port);
582 if (!sci_port->break_flag) {
583 sci_port->break_flag = 1;
584 sci_schedule_break_timer(sci_port);
586 /* Do sysrq handling. */
587 if (uart_handle_break(port))
588 return 0;
590 dev_dbg(port->dev, "BREAK detected\n");
592 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
593 copied++;
596 } else {
597 /* frame error */
598 if (tty_insert_flip_char(tty, 0, TTY_FRAME))
599 copied++;
601 dev_notice(port->dev, "frame error\n");
605 if (status & SCxSR_PER(port)) {
606 /* parity error */
607 if (tty_insert_flip_char(tty, 0, TTY_PARITY))
608 copied++;
610 dev_notice(port->dev, "parity error");
613 if (copied)
614 tty_flip_buffer_push(tty);
616 return copied;
619 static inline int sci_handle_fifo_overrun(struct uart_port *port)
621 struct tty_struct *tty = port->state->port.tty;
622 int copied = 0;
624 if (port->type != PORT_SCIF)
625 return 0;
627 if ((sci_in(port, SCLSR) & SCIF_ORER) != 0) {
628 sci_out(port, SCLSR, 0);
630 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
631 tty_flip_buffer_push(tty);
633 dev_notice(port->dev, "overrun error\n");
634 copied++;
637 return copied;
640 static inline int sci_handle_breaks(struct uart_port *port)
642 int copied = 0;
643 unsigned short status = sci_in(port, SCxSR);
644 struct tty_struct *tty = port->state->port.tty;
645 struct sci_port *s = to_sci_port(port);
647 if (uart_handle_break(port))
648 return 0;
650 if (!s->break_flag && status & SCxSR_BRK(port)) {
651 #if defined(CONFIG_CPU_SH3)
652 /* Debounce break */
653 s->break_flag = 1;
654 #endif
655 /* Notify of BREAK */
656 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
657 copied++;
659 dev_dbg(port->dev, "BREAK detected\n");
662 if (copied)
663 tty_flip_buffer_push(tty);
665 copied += sci_handle_fifo_overrun(port);
667 return copied;
670 static irqreturn_t sci_rx_interrupt(int irq, void *ptr)
672 #ifdef CONFIG_SERIAL_SH_SCI_DMA
673 struct uart_port *port = ptr;
674 struct sci_port *s = to_sci_port(port);
676 if (s->chan_rx) {
677 unsigned long tout;
678 u16 scr = sci_in(port, SCSCR);
679 u16 ssr = sci_in(port, SCxSR);
681 /* Disable future Rx interrupts */
682 sci_out(port, SCSCR, scr & ~SCI_CTRL_FLAGS_RIE);
683 /* Clear current interrupt */
684 sci_out(port, SCxSR, ssr & ~(1 | SCxSR_RDxF(port)));
685 /* Calculate delay for 1.5 DMA buffers */
686 tout = (port->timeout - HZ / 50) * s->buf_len_rx * 3 /
687 port->fifosize / 2;
688 dev_dbg(port->dev, "Rx IRQ: setup timeout in %lu ms\n",
689 tout * 1000 / HZ);
690 if (tout < 2)
691 tout = 2;
692 mod_timer(&s->rx_timer, jiffies + tout);
694 return IRQ_HANDLED;
696 #endif
698 /* I think sci_receive_chars has to be called irrespective
699 * of whether the I_IXOFF is set, otherwise, how is the interrupt
700 * to be disabled?
702 sci_receive_chars(ptr);
704 return IRQ_HANDLED;
707 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
709 struct uart_port *port = ptr;
710 unsigned long flags;
712 spin_lock_irqsave(&port->lock, flags);
713 sci_transmit_chars(port);
714 spin_unlock_irqrestore(&port->lock, flags);
716 return IRQ_HANDLED;
719 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
721 struct uart_port *port = ptr;
723 /* Handle errors */
724 if (port->type == PORT_SCI) {
725 if (sci_handle_errors(port)) {
726 /* discard character in rx buffer */
727 sci_in(port, SCxSR);
728 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
730 } else {
731 sci_handle_fifo_overrun(port);
732 sci_rx_interrupt(irq, ptr);
735 sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
737 /* Kick the transmission */
738 sci_tx_interrupt(irq, ptr);
740 return IRQ_HANDLED;
743 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
745 struct uart_port *port = ptr;
747 /* Handle BREAKs */
748 sci_handle_breaks(port);
749 sci_out(port, SCxSR, SCxSR_BREAK_CLEAR(port));
751 return IRQ_HANDLED;
754 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
756 unsigned short ssr_status, scr_status, err_enabled;
757 struct uart_port *port = ptr;
758 struct sci_port *s = to_sci_port(port);
759 irqreturn_t ret = IRQ_NONE;
761 ssr_status = sci_in(port, SCxSR);
762 scr_status = sci_in(port, SCSCR);
763 err_enabled = scr_status & (SCI_CTRL_FLAGS_REIE | SCI_CTRL_FLAGS_RIE);
765 /* Tx Interrupt */
766 if ((ssr_status & SCxSR_TDxE(port)) && (scr_status & SCI_CTRL_FLAGS_TIE) &&
767 !s->chan_tx)
768 ret = sci_tx_interrupt(irq, ptr);
770 * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
771 * DR flags
773 if (((ssr_status & SCxSR_RDxF(port)) || s->chan_rx) &&
774 (scr_status & SCI_CTRL_FLAGS_RIE))
775 ret = sci_rx_interrupt(irq, ptr);
776 /* Error Interrupt */
777 if ((ssr_status & SCxSR_ERRORS(port)) && err_enabled)
778 ret = sci_er_interrupt(irq, ptr);
779 /* Break Interrupt */
780 if ((ssr_status & SCxSR_BRK(port)) && err_enabled)
781 ret = sci_br_interrupt(irq, ptr);
783 return ret;
787 * Here we define a transistion notifier so that we can update all of our
788 * ports' baud rate when the peripheral clock changes.
790 static int sci_notifier(struct notifier_block *self,
791 unsigned long phase, void *p)
793 struct sh_sci_priv *priv = container_of(self,
794 struct sh_sci_priv, clk_nb);
795 struct sci_port *sci_port;
796 unsigned long flags;
798 if ((phase == CPUFREQ_POSTCHANGE) ||
799 (phase == CPUFREQ_RESUMECHANGE)) {
800 spin_lock_irqsave(&priv->lock, flags);
801 list_for_each_entry(sci_port, &priv->ports, node)
802 sci_port->port.uartclk = clk_get_rate(sci_port->dclk);
803 spin_unlock_irqrestore(&priv->lock, flags);
806 return NOTIFY_OK;
809 static void sci_clk_enable(struct uart_port *port)
811 struct sci_port *sci_port = to_sci_port(port);
813 clk_enable(sci_port->dclk);
814 sci_port->port.uartclk = clk_get_rate(sci_port->dclk);
816 if (sci_port->iclk)
817 clk_enable(sci_port->iclk);
820 static void sci_clk_disable(struct uart_port *port)
822 struct sci_port *sci_port = to_sci_port(port);
824 if (sci_port->iclk)
825 clk_disable(sci_port->iclk);
827 clk_disable(sci_port->dclk);
830 static int sci_request_irq(struct sci_port *port)
832 int i;
833 irqreturn_t (*handlers[4])(int irq, void *ptr) = {
834 sci_er_interrupt, sci_rx_interrupt, sci_tx_interrupt,
835 sci_br_interrupt,
837 const char *desc[] = { "SCI Receive Error", "SCI Receive Data Full",
838 "SCI Transmit Data Empty", "SCI Break" };
840 if (port->irqs[0] == port->irqs[1]) {
841 if (unlikely(!port->irqs[0]))
842 return -ENODEV;
844 if (request_irq(port->irqs[0], sci_mpxed_interrupt,
845 IRQF_DISABLED, "sci", port)) {
846 dev_err(port->port.dev, "Can't allocate IRQ\n");
847 return -ENODEV;
849 } else {
850 for (i = 0; i < ARRAY_SIZE(handlers); i++) {
851 if (unlikely(!port->irqs[i]))
852 continue;
854 if (request_irq(port->irqs[i], handlers[i],
855 IRQF_DISABLED, desc[i], port)) {
856 dev_err(port->port.dev, "Can't allocate IRQ\n");
857 return -ENODEV;
862 return 0;
865 static void sci_free_irq(struct sci_port *port)
867 int i;
869 if (port->irqs[0] == port->irqs[1])
870 free_irq(port->irqs[0], port);
871 else {
872 for (i = 0; i < ARRAY_SIZE(port->irqs); i++) {
873 if (!port->irqs[i])
874 continue;
876 free_irq(port->irqs[i], port);
881 static unsigned int sci_tx_empty(struct uart_port *port)
883 unsigned short status = sci_in(port, SCxSR);
884 unsigned short in_tx_fifo = scif_txfill(port);
886 return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
889 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
891 /* This routine is used for seting signals of: DTR, DCD, CTS/RTS */
892 /* We use SCIF's hardware for CTS/RTS, so don't need any for that. */
893 /* If you have signals for DTR and DCD, please implement here. */
896 static unsigned int sci_get_mctrl(struct uart_port *port)
898 /* This routine is used for getting signals of: DTR, DCD, DSR, RI,
899 and CTS/RTS */
901 return TIOCM_DTR | TIOCM_RTS | TIOCM_DSR;
904 #ifdef CONFIG_SERIAL_SH_SCI_DMA
905 static void sci_dma_tx_complete(void *arg)
907 struct sci_port *s = arg;
908 struct uart_port *port = &s->port;
909 struct circ_buf *xmit = &port->state->xmit;
910 unsigned long flags;
912 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
914 spin_lock_irqsave(&port->lock, flags);
916 xmit->tail += s->sg_tx.length;
917 xmit->tail &= UART_XMIT_SIZE - 1;
919 port->icount.tx += s->sg_tx.length;
921 async_tx_ack(s->desc_tx);
922 s->cookie_tx = -EINVAL;
923 s->desc_tx = NULL;
925 spin_unlock_irqrestore(&port->lock, flags);
927 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
928 uart_write_wakeup(port);
930 if (uart_circ_chars_pending(xmit))
931 schedule_work(&s->work_tx);
934 /* Locking: called with port lock held */
935 static int sci_dma_rx_push(struct sci_port *s, struct tty_struct *tty,
936 size_t count)
938 struct uart_port *port = &s->port;
939 int i, active, room;
941 room = tty_buffer_request_room(tty, count);
943 if (s->active_rx == s->cookie_rx[0]) {
944 active = 0;
945 } else if (s->active_rx == s->cookie_rx[1]) {
946 active = 1;
947 } else {
948 dev_err(port->dev, "cookie %d not found!\n", s->active_rx);
949 return 0;
952 if (room < count)
953 dev_warn(port->dev, "Rx overrun: dropping %u bytes\n",
954 count - room);
955 if (!room)
956 return room;
958 for (i = 0; i < room; i++)
959 tty_insert_flip_char(tty, ((u8 *)sg_virt(&s->sg_rx[active]))[i],
960 TTY_NORMAL);
962 port->icount.rx += room;
964 return room;
967 static void sci_dma_rx_complete(void *arg)
969 struct sci_port *s = arg;
970 struct uart_port *port = &s->port;
971 struct tty_struct *tty = port->state->port.tty;
972 unsigned long flags;
973 int count;
975 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
977 spin_lock_irqsave(&port->lock, flags);
979 count = sci_dma_rx_push(s, tty, s->buf_len_rx);
981 mod_timer(&s->rx_timer, jiffies + msecs_to_jiffies(5));
983 spin_unlock_irqrestore(&port->lock, flags);
985 if (count)
986 tty_flip_buffer_push(tty);
988 schedule_work(&s->work_rx);
991 static void sci_start_rx(struct uart_port *port);
992 static void sci_start_tx(struct uart_port *port);
994 static void sci_rx_dma_release(struct sci_port *s, bool enable_pio)
996 struct dma_chan *chan = s->chan_rx;
997 struct uart_port *port = &s->port;
999 s->chan_rx = NULL;
1000 s->cookie_rx[0] = s->cookie_rx[1] = -EINVAL;
1001 dma_release_channel(chan);
1002 dma_free_coherent(port->dev, s->buf_len_rx * 2,
1003 sg_virt(&s->sg_rx[0]), sg_dma_address(&s->sg_rx[0]));
1004 if (enable_pio)
1005 sci_start_rx(port);
1008 static void sci_tx_dma_release(struct sci_port *s, bool enable_pio)
1010 struct dma_chan *chan = s->chan_tx;
1011 struct uart_port *port = &s->port;
1013 s->chan_tx = NULL;
1014 s->cookie_tx = -EINVAL;
1015 dma_release_channel(chan);
1016 if (enable_pio)
1017 sci_start_tx(port);
1020 static void sci_submit_rx(struct sci_port *s)
1022 struct dma_chan *chan = s->chan_rx;
1023 int i;
1025 for (i = 0; i < 2; i++) {
1026 struct scatterlist *sg = &s->sg_rx[i];
1027 struct dma_async_tx_descriptor *desc;
1029 desc = chan->device->device_prep_slave_sg(chan,
1030 sg, 1, DMA_FROM_DEVICE, DMA_PREP_INTERRUPT);
1032 if (desc) {
1033 s->desc_rx[i] = desc;
1034 desc->callback = sci_dma_rx_complete;
1035 desc->callback_param = s;
1036 s->cookie_rx[i] = desc->tx_submit(desc);
1039 if (!desc || s->cookie_rx[i] < 0) {
1040 if (i) {
1041 async_tx_ack(s->desc_rx[0]);
1042 s->cookie_rx[0] = -EINVAL;
1044 if (desc) {
1045 async_tx_ack(desc);
1046 s->cookie_rx[i] = -EINVAL;
1048 dev_warn(s->port.dev,
1049 "failed to re-start DMA, using PIO\n");
1050 sci_rx_dma_release(s, true);
1051 return;
1055 s->active_rx = s->cookie_rx[0];
1057 dma_async_issue_pending(chan);
1060 static void work_fn_rx(struct work_struct *work)
1062 struct sci_port *s = container_of(work, struct sci_port, work_rx);
1063 struct uart_port *port = &s->port;
1064 struct dma_async_tx_descriptor *desc;
1065 int new;
1067 if (s->active_rx == s->cookie_rx[0]) {
1068 new = 0;
1069 } else if (s->active_rx == s->cookie_rx[1]) {
1070 new = 1;
1071 } else {
1072 dev_err(port->dev, "cookie %d not found!\n", s->active_rx);
1073 return;
1075 desc = s->desc_rx[new];
1077 if (dma_async_is_tx_complete(s->chan_rx, s->active_rx, NULL, NULL) !=
1078 DMA_SUCCESS) {
1079 /* Handle incomplete DMA receive */
1080 struct tty_struct *tty = port->state->port.tty;
1081 struct dma_chan *chan = s->chan_rx;
1082 struct sh_desc *sh_desc = container_of(desc, struct sh_desc,
1083 async_tx);
1084 unsigned long flags;
1085 int count;
1087 chan->device->device_control(chan, DMA_TERMINATE_ALL, 0);
1088 dev_dbg(port->dev, "Read %u bytes with cookie %d\n",
1089 sh_desc->partial, sh_desc->cookie);
1091 spin_lock_irqsave(&port->lock, flags);
1092 count = sci_dma_rx_push(s, tty, sh_desc->partial);
1093 spin_unlock_irqrestore(&port->lock, flags);
1095 if (count)
1096 tty_flip_buffer_push(tty);
1098 sci_submit_rx(s);
1100 return;
1103 s->cookie_rx[new] = desc->tx_submit(desc);
1104 if (s->cookie_rx[new] < 0) {
1105 dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1106 sci_rx_dma_release(s, true);
1107 return;
1110 dev_dbg(port->dev, "%s: cookie %d #%d\n", __func__,
1111 s->cookie_rx[new], new);
1113 s->active_rx = s->cookie_rx[!new];
1116 static void work_fn_tx(struct work_struct *work)
1118 struct sci_port *s = container_of(work, struct sci_port, work_tx);
1119 struct dma_async_tx_descriptor *desc;
1120 struct dma_chan *chan = s->chan_tx;
1121 struct uart_port *port = &s->port;
1122 struct circ_buf *xmit = &port->state->xmit;
1123 struct scatterlist *sg = &s->sg_tx;
1126 * DMA is idle now.
1127 * Port xmit buffer is already mapped, and it is one page... Just adjust
1128 * offsets and lengths. Since it is a circular buffer, we have to
1129 * transmit till the end, and then the rest. Take the port lock to get a
1130 * consistent xmit buffer state.
1132 spin_lock_irq(&port->lock);
1133 sg->offset = xmit->tail & (UART_XMIT_SIZE - 1);
1134 sg->dma_address = (sg_dma_address(sg) & ~(UART_XMIT_SIZE - 1)) +
1135 sg->offset;
1136 sg->length = min((int)CIRC_CNT(xmit->head, xmit->tail, UART_XMIT_SIZE),
1137 CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE));
1138 sg->dma_length = sg->length;
1139 spin_unlock_irq(&port->lock);
1141 BUG_ON(!sg->length);
1143 desc = chan->device->device_prep_slave_sg(chan,
1144 sg, s->sg_len_tx, DMA_TO_DEVICE,
1145 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1146 if (!desc) {
1147 /* switch to PIO */
1148 sci_tx_dma_release(s, true);
1149 return;
1152 dma_sync_sg_for_device(port->dev, sg, 1, DMA_TO_DEVICE);
1154 spin_lock_irq(&port->lock);
1155 s->desc_tx = desc;
1156 desc->callback = sci_dma_tx_complete;
1157 desc->callback_param = s;
1158 spin_unlock_irq(&port->lock);
1159 s->cookie_tx = desc->tx_submit(desc);
1160 if (s->cookie_tx < 0) {
1161 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1162 /* switch to PIO */
1163 sci_tx_dma_release(s, true);
1164 return;
1167 dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n", __func__,
1168 xmit->buf, xmit->tail, xmit->head, s->cookie_tx);
1170 dma_async_issue_pending(chan);
1172 #endif
1174 static void sci_start_tx(struct uart_port *port)
1176 unsigned short ctrl;
1178 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1179 struct sci_port *s = to_sci_port(port);
1181 if (s->chan_tx) {
1182 if (!uart_circ_empty(&s->port.state->xmit) && s->cookie_tx < 0)
1183 schedule_work(&s->work_tx);
1185 return;
1187 #endif
1189 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
1190 ctrl = sci_in(port, SCSCR);
1191 ctrl |= SCI_CTRL_FLAGS_TIE;
1192 sci_out(port, SCSCR, ctrl);
1195 static void sci_stop_tx(struct uart_port *port)
1197 unsigned short ctrl;
1199 /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
1200 ctrl = sci_in(port, SCSCR);
1201 ctrl &= ~SCI_CTRL_FLAGS_TIE;
1202 sci_out(port, SCSCR, ctrl);
1205 static void sci_start_rx(struct uart_port *port)
1207 unsigned short ctrl = SCI_CTRL_FLAGS_RIE | SCI_CTRL_FLAGS_REIE;
1209 /* Set RIE (Receive Interrupt Enable) bit in SCSCR */
1210 ctrl |= sci_in(port, SCSCR);
1211 sci_out(port, SCSCR, ctrl);
1214 static void sci_stop_rx(struct uart_port *port)
1216 unsigned short ctrl;
1218 /* Clear RIE (Receive Interrupt Enable) bit in SCSCR */
1219 ctrl = sci_in(port, SCSCR);
1220 ctrl &= ~(SCI_CTRL_FLAGS_RIE | SCI_CTRL_FLAGS_REIE);
1221 sci_out(port, SCSCR, ctrl);
1224 static void sci_enable_ms(struct uart_port *port)
1226 /* Nothing here yet .. */
1229 static void sci_break_ctl(struct uart_port *port, int break_state)
1231 /* Nothing here yet .. */
1234 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1235 static bool filter(struct dma_chan *chan, void *slave)
1237 struct sh_dmae_slave *param = slave;
1239 dev_dbg(chan->device->dev, "%s: slave ID %d\n", __func__,
1240 param->slave_id);
1242 if (param->dma_dev == chan->device->dev) {
1243 chan->private = param;
1244 return true;
1245 } else {
1246 return false;
1250 static void rx_timer_fn(unsigned long arg)
1252 struct sci_port *s = (struct sci_port *)arg;
1253 struct uart_port *port = &s->port;
1255 u16 scr = sci_in(port, SCSCR);
1256 sci_out(port, SCSCR, scr | SCI_CTRL_FLAGS_RIE);
1257 dev_dbg(port->dev, "DMA Rx timed out\n");
1258 schedule_work(&s->work_rx);
1261 static void sci_request_dma(struct uart_port *port)
1263 struct sci_port *s = to_sci_port(port);
1264 struct sh_dmae_slave *param;
1265 struct dma_chan *chan;
1266 dma_cap_mask_t mask;
1267 int nent;
1269 dev_dbg(port->dev, "%s: port %d DMA %p\n", __func__,
1270 port->line, s->dma_dev);
1272 if (!s->dma_dev)
1273 return;
1275 dma_cap_zero(mask);
1276 dma_cap_set(DMA_SLAVE, mask);
1278 param = &s->param_tx;
1280 /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_TX */
1281 param->slave_id = s->slave_tx;
1282 param->dma_dev = s->dma_dev;
1284 s->cookie_tx = -EINVAL;
1285 chan = dma_request_channel(mask, filter, param);
1286 dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1287 if (chan) {
1288 s->chan_tx = chan;
1289 sg_init_table(&s->sg_tx, 1);
1290 /* UART circular tx buffer is an aligned page. */
1291 BUG_ON((int)port->state->xmit.buf & ~PAGE_MASK);
1292 sg_set_page(&s->sg_tx, virt_to_page(port->state->xmit.buf),
1293 UART_XMIT_SIZE, (int)port->state->xmit.buf & ~PAGE_MASK);
1294 nent = dma_map_sg(port->dev, &s->sg_tx, 1, DMA_TO_DEVICE);
1295 if (!nent)
1296 sci_tx_dma_release(s, false);
1297 else
1298 dev_dbg(port->dev, "%s: mapped %d@%p to %x\n", __func__,
1299 sg_dma_len(&s->sg_tx),
1300 port->state->xmit.buf, sg_dma_address(&s->sg_tx));
1302 s->sg_len_tx = nent;
1304 INIT_WORK(&s->work_tx, work_fn_tx);
1307 param = &s->param_rx;
1309 /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_RX */
1310 param->slave_id = s->slave_rx;
1311 param->dma_dev = s->dma_dev;
1313 chan = dma_request_channel(mask, filter, param);
1314 dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1315 if (chan) {
1316 dma_addr_t dma[2];
1317 void *buf[2];
1318 int i;
1320 s->chan_rx = chan;
1322 s->buf_len_rx = 2 * max(16, (int)port->fifosize);
1323 buf[0] = dma_alloc_coherent(port->dev, s->buf_len_rx * 2,
1324 &dma[0], GFP_KERNEL);
1326 if (!buf[0]) {
1327 dev_warn(port->dev,
1328 "failed to allocate dma buffer, using PIO\n");
1329 sci_rx_dma_release(s, true);
1330 return;
1333 buf[1] = buf[0] + s->buf_len_rx;
1334 dma[1] = dma[0] + s->buf_len_rx;
1336 for (i = 0; i < 2; i++) {
1337 struct scatterlist *sg = &s->sg_rx[i];
1339 sg_init_table(sg, 1);
1340 sg_set_page(sg, virt_to_page(buf[i]), s->buf_len_rx,
1341 (int)buf[i] & ~PAGE_MASK);
1342 sg->dma_address = dma[i];
1343 sg->dma_length = sg->length;
1346 INIT_WORK(&s->work_rx, work_fn_rx);
1347 setup_timer(&s->rx_timer, rx_timer_fn, (unsigned long)s);
1349 sci_submit_rx(s);
1353 static void sci_free_dma(struct uart_port *port)
1355 struct sci_port *s = to_sci_port(port);
1357 if (!s->dma_dev)
1358 return;
1360 if (s->chan_tx)
1361 sci_tx_dma_release(s, false);
1362 if (s->chan_rx)
1363 sci_rx_dma_release(s, false);
1365 #endif
1367 static int sci_startup(struct uart_port *port)
1369 struct sci_port *s = to_sci_port(port);
1371 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1373 if (s->enable)
1374 s->enable(port);
1376 sci_request_irq(s);
1377 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1378 sci_request_dma(port);
1379 #endif
1380 sci_start_tx(port);
1381 sci_start_rx(port);
1383 return 0;
1386 static void sci_shutdown(struct uart_port *port)
1388 struct sci_port *s = to_sci_port(port);
1390 dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1392 sci_stop_rx(port);
1393 sci_stop_tx(port);
1394 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1395 sci_free_dma(port);
1396 #endif
1397 sci_free_irq(s);
1399 if (s->disable)
1400 s->disable(port);
1403 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
1404 struct ktermios *old)
1406 unsigned int status, baud, smr_val, max_baud;
1407 int t = -1;
1410 * earlyprintk comes here early on with port->uartclk set to zero.
1411 * the clock framework is not up and running at this point so here
1412 * we assume that 115200 is the maximum baud rate. please note that
1413 * the baud rate is not programmed during earlyprintk - it is assumed
1414 * that the previous boot loader has enabled required clocks and
1415 * setup the baud rate generator hardware for us already.
1417 max_baud = port->uartclk ? port->uartclk / 16 : 115200;
1419 baud = uart_get_baud_rate(port, termios, old, 0, max_baud);
1420 if (likely(baud && port->uartclk))
1421 t = SCBRR_VALUE(baud, port->uartclk);
1423 do {
1424 status = sci_in(port, SCxSR);
1425 } while (!(status & SCxSR_TEND(port)));
1427 sci_out(port, SCSCR, 0x00); /* TE=0, RE=0, CKE1=0 */
1429 if (port->type != PORT_SCI)
1430 sci_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
1432 smr_val = sci_in(port, SCSMR) & 3;
1433 if ((termios->c_cflag & CSIZE) == CS7)
1434 smr_val |= 0x40;
1435 if (termios->c_cflag & PARENB)
1436 smr_val |= 0x20;
1437 if (termios->c_cflag & PARODD)
1438 smr_val |= 0x30;
1439 if (termios->c_cflag & CSTOPB)
1440 smr_val |= 0x08;
1442 uart_update_timeout(port, termios->c_cflag, baud);
1444 sci_out(port, SCSMR, smr_val);
1446 dev_dbg(port->dev, "%s: SMR %x, t %x, SCSCR %x\n", __func__, smr_val, t,
1447 SCSCR_INIT(port));
1449 if (t > 0) {
1450 if (t >= 256) {
1451 sci_out(port, SCSMR, (sci_in(port, SCSMR) & ~3) | 1);
1452 t >>= 2;
1453 } else
1454 sci_out(port, SCSMR, sci_in(port, SCSMR) & ~3);
1456 sci_out(port, SCBRR, t);
1457 udelay((1000000+(baud-1)) / baud); /* Wait one bit interval */
1460 sci_init_pins(port, termios->c_cflag);
1461 sci_out(port, SCFCR, (termios->c_cflag & CRTSCTS) ? SCFCR_MCE : 0);
1463 sci_out(port, SCSCR, SCSCR_INIT(port));
1465 if ((termios->c_cflag & CREAD) != 0)
1466 sci_start_rx(port);
1469 static const char *sci_type(struct uart_port *port)
1471 switch (port->type) {
1472 case PORT_IRDA:
1473 return "irda";
1474 case PORT_SCI:
1475 return "sci";
1476 case PORT_SCIF:
1477 return "scif";
1478 case PORT_SCIFA:
1479 return "scifa";
1482 return NULL;
1485 static void sci_release_port(struct uart_port *port)
1487 /* Nothing here yet .. */
1490 static int sci_request_port(struct uart_port *port)
1492 /* Nothing here yet .. */
1493 return 0;
1496 static void sci_config_port(struct uart_port *port, int flags)
1498 struct sci_port *s = to_sci_port(port);
1500 port->type = s->type;
1502 if (port->membase)
1503 return;
1505 if (port->flags & UPF_IOREMAP) {
1506 port->membase = ioremap_nocache(port->mapbase, 0x40);
1508 if (IS_ERR(port->membase))
1509 dev_err(port->dev, "can't remap port#%d\n", port->line);
1510 } else {
1512 * For the simple (and majority of) cases where we don't
1513 * need to do any remapping, just cast the cookie
1514 * directly.
1516 port->membase = (void __iomem *)port->mapbase;
1520 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
1522 struct sci_port *s = to_sci_port(port);
1524 if (ser->irq != s->irqs[SCIx_TXI_IRQ] || ser->irq > nr_irqs)
1525 return -EINVAL;
1526 if (ser->baud_base < 2400)
1527 /* No paper tape reader for Mitch.. */
1528 return -EINVAL;
1530 return 0;
1533 static struct uart_ops sci_uart_ops = {
1534 .tx_empty = sci_tx_empty,
1535 .set_mctrl = sci_set_mctrl,
1536 .get_mctrl = sci_get_mctrl,
1537 .start_tx = sci_start_tx,
1538 .stop_tx = sci_stop_tx,
1539 .stop_rx = sci_stop_rx,
1540 .enable_ms = sci_enable_ms,
1541 .break_ctl = sci_break_ctl,
1542 .startup = sci_startup,
1543 .shutdown = sci_shutdown,
1544 .set_termios = sci_set_termios,
1545 .type = sci_type,
1546 .release_port = sci_release_port,
1547 .request_port = sci_request_port,
1548 .config_port = sci_config_port,
1549 .verify_port = sci_verify_port,
1550 #ifdef CONFIG_CONSOLE_POLL
1551 .poll_get_char = sci_poll_get_char,
1552 .poll_put_char = sci_poll_put_char,
1553 #endif
1556 static void __devinit sci_init_single(struct platform_device *dev,
1557 struct sci_port *sci_port,
1558 unsigned int index,
1559 struct plat_sci_port *p)
1561 struct uart_port *port = &sci_port->port;
1563 port->ops = &sci_uart_ops;
1564 port->iotype = UPIO_MEM;
1565 port->line = index;
1567 switch (p->type) {
1568 case PORT_SCIFA:
1569 port->fifosize = 64;
1570 break;
1571 case PORT_SCIF:
1572 port->fifosize = 16;
1573 break;
1574 default:
1575 port->fifosize = 1;
1576 break;
1579 if (dev) {
1580 sci_port->iclk = p->clk ? clk_get(&dev->dev, p->clk) : NULL;
1581 sci_port->dclk = clk_get(&dev->dev, "peripheral_clk");
1582 sci_port->enable = sci_clk_enable;
1583 sci_port->disable = sci_clk_disable;
1584 port->dev = &dev->dev;
1587 sci_port->break_timer.data = (unsigned long)sci_port;
1588 sci_port->break_timer.function = sci_break_timer;
1589 init_timer(&sci_port->break_timer);
1591 port->mapbase = p->mapbase;
1592 port->membase = p->membase;
1594 port->irq = p->irqs[SCIx_TXI_IRQ];
1595 port->flags = p->flags;
1596 sci_port->type = port->type = p->type;
1598 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1599 sci_port->dma_dev = p->dma_dev;
1600 sci_port->slave_tx = p->dma_slave_tx;
1601 sci_port->slave_rx = p->dma_slave_rx;
1603 dev_dbg(port->dev, "%s: DMA device %p, tx %d, rx %d\n", __func__,
1604 p->dma_dev, p->dma_slave_tx, p->dma_slave_rx);
1605 #endif
1607 memcpy(&sci_port->irqs, &p->irqs, sizeof(p->irqs));
1610 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1611 static struct tty_driver *serial_console_device(struct console *co, int *index)
1613 struct uart_driver *p = &sci_uart_driver;
1614 *index = co->index;
1615 return p->tty_driver;
1618 static void serial_console_putchar(struct uart_port *port, int ch)
1620 sci_poll_put_char(port, ch);
1624 * Print a string to the serial port trying not to disturb
1625 * any possible real use of the port...
1627 static void serial_console_write(struct console *co, const char *s,
1628 unsigned count)
1630 struct uart_port *port = co->data;
1631 struct sci_port *sci_port = to_sci_port(port);
1632 unsigned short bits;
1634 if (sci_port->enable)
1635 sci_port->enable(port);
1637 uart_console_write(port, s, count, serial_console_putchar);
1639 /* wait until fifo is empty and last bit has been transmitted */
1640 bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
1641 while ((sci_in(port, SCxSR) & bits) != bits)
1642 cpu_relax();
1644 if (sci_port->disable)
1645 sci_port->disable(port);
1648 static int __devinit serial_console_setup(struct console *co, char *options)
1650 struct sci_port *sci_port;
1651 struct uart_port *port;
1652 int baud = 115200;
1653 int bits = 8;
1654 int parity = 'n';
1655 int flow = 'n';
1656 int ret;
1659 * Check whether an invalid uart number has been specified, and
1660 * if so, search for the first available port that does have
1661 * console support.
1663 if (co->index >= SCI_NPORTS)
1664 co->index = 0;
1666 if (co->data) {
1667 port = co->data;
1668 sci_port = to_sci_port(port);
1669 } else {
1670 sci_port = &sci_ports[co->index];
1671 port = &sci_port->port;
1672 co->data = port;
1676 * Also need to check port->type, we don't actually have any
1677 * UPIO_PORT ports, but uart_report_port() handily misreports
1678 * it anyways if we don't have a port available by the time this is
1679 * called.
1681 if (!port->type)
1682 return -ENODEV;
1684 sci_config_port(port, 0);
1686 if (sci_port->enable)
1687 sci_port->enable(port);
1689 if (options)
1690 uart_parse_options(options, &baud, &parity, &bits, &flow);
1692 ret = uart_set_options(port, co, baud, parity, bits, flow);
1693 #if defined(__H8300H__) || defined(__H8300S__)
1694 /* disable rx interrupt */
1695 if (ret == 0)
1696 sci_stop_rx(port);
1697 #endif
1698 /* TODO: disable clock */
1699 return ret;
1702 static struct console serial_console = {
1703 .name = "ttySC",
1704 .device = serial_console_device,
1705 .write = serial_console_write,
1706 .setup = serial_console_setup,
1707 .flags = CON_PRINTBUFFER,
1708 .index = -1,
1711 static int __init sci_console_init(void)
1713 register_console(&serial_console);
1714 return 0;
1716 console_initcall(sci_console_init);
1718 static struct sci_port early_serial_port;
1719 static struct console early_serial_console = {
1720 .name = "early_ttySC",
1721 .write = serial_console_write,
1722 .flags = CON_PRINTBUFFER,
1724 static char early_serial_buf[32];
1726 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
1728 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
1729 #define SCI_CONSOLE (&serial_console)
1730 #else
1731 #define SCI_CONSOLE 0
1732 #endif
1734 static char banner[] __initdata =
1735 KERN_INFO "SuperH SCI(F) driver initialized\n";
1737 static struct uart_driver sci_uart_driver = {
1738 .owner = THIS_MODULE,
1739 .driver_name = "sci",
1740 .dev_name = "ttySC",
1741 .major = SCI_MAJOR,
1742 .minor = SCI_MINOR_START,
1743 .nr = SCI_NPORTS,
1744 .cons = SCI_CONSOLE,
1748 static int sci_remove(struct platform_device *dev)
1750 struct sh_sci_priv *priv = platform_get_drvdata(dev);
1751 struct sci_port *p;
1752 unsigned long flags;
1754 cpufreq_unregister_notifier(&priv->clk_nb, CPUFREQ_TRANSITION_NOTIFIER);
1756 spin_lock_irqsave(&priv->lock, flags);
1757 list_for_each_entry(p, &priv->ports, node)
1758 uart_remove_one_port(&sci_uart_driver, &p->port);
1759 spin_unlock_irqrestore(&priv->lock, flags);
1761 kfree(priv);
1762 return 0;
1765 static int __devinit sci_probe_single(struct platform_device *dev,
1766 unsigned int index,
1767 struct plat_sci_port *p,
1768 struct sci_port *sciport)
1770 struct sh_sci_priv *priv = platform_get_drvdata(dev);
1771 unsigned long flags;
1772 int ret;
1774 /* Sanity check */
1775 if (unlikely(index >= SCI_NPORTS)) {
1776 dev_notice(&dev->dev, "Attempting to register port "
1777 "%d when only %d are available.\n",
1778 index+1, SCI_NPORTS);
1779 dev_notice(&dev->dev, "Consider bumping "
1780 "CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
1781 return 0;
1784 sci_init_single(dev, sciport, index, p);
1786 ret = uart_add_one_port(&sci_uart_driver, &sciport->port);
1787 if (ret)
1788 return ret;
1790 INIT_LIST_HEAD(&sciport->node);
1792 spin_lock_irqsave(&priv->lock, flags);
1793 list_add(&sciport->node, &priv->ports);
1794 spin_unlock_irqrestore(&priv->lock, flags);
1796 return 0;
1800 * Register a set of serial devices attached to a platform device. The
1801 * list is terminated with a zero flags entry, which means we expect
1802 * all entries to have at least UPF_BOOT_AUTOCONF set. Platforms that need
1803 * remapping (such as sh64) should also set UPF_IOREMAP.
1805 static int __devinit sci_probe(struct platform_device *dev)
1807 struct plat_sci_port *p = dev->dev.platform_data;
1808 struct sh_sci_priv *priv;
1809 int i, ret = -EINVAL;
1811 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1812 if (is_early_platform_device(dev)) {
1813 if (dev->id == -1)
1814 return -ENOTSUPP;
1815 early_serial_console.index = dev->id;
1816 early_serial_console.data = &early_serial_port.port;
1817 sci_init_single(NULL, &early_serial_port, dev->id, p);
1818 serial_console_setup(&early_serial_console, early_serial_buf);
1819 if (!strstr(early_serial_buf, "keep"))
1820 early_serial_console.flags |= CON_BOOT;
1821 register_console(&early_serial_console);
1822 return 0;
1824 #endif
1826 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1827 if (!priv)
1828 return -ENOMEM;
1830 INIT_LIST_HEAD(&priv->ports);
1831 spin_lock_init(&priv->lock);
1832 platform_set_drvdata(dev, priv);
1834 priv->clk_nb.notifier_call = sci_notifier;
1835 cpufreq_register_notifier(&priv->clk_nb, CPUFREQ_TRANSITION_NOTIFIER);
1837 if (dev->id != -1) {
1838 ret = sci_probe_single(dev, dev->id, p, &sci_ports[dev->id]);
1839 if (ret)
1840 goto err_unreg;
1841 } else {
1842 for (i = 0; p && p->flags != 0; p++, i++) {
1843 ret = sci_probe_single(dev, i, p, &sci_ports[i]);
1844 if (ret)
1845 goto err_unreg;
1849 #ifdef CONFIG_SH_STANDARD_BIOS
1850 sh_bios_gdb_detach();
1851 #endif
1853 return 0;
1855 err_unreg:
1856 sci_remove(dev);
1857 return ret;
1860 static int sci_suspend(struct device *dev)
1862 struct sh_sci_priv *priv = dev_get_drvdata(dev);
1863 struct sci_port *p;
1864 unsigned long flags;
1866 spin_lock_irqsave(&priv->lock, flags);
1867 list_for_each_entry(p, &priv->ports, node)
1868 uart_suspend_port(&sci_uart_driver, &p->port);
1869 spin_unlock_irqrestore(&priv->lock, flags);
1871 return 0;
1874 static int sci_resume(struct device *dev)
1876 struct sh_sci_priv *priv = dev_get_drvdata(dev);
1877 struct sci_port *p;
1878 unsigned long flags;
1880 spin_lock_irqsave(&priv->lock, flags);
1881 list_for_each_entry(p, &priv->ports, node)
1882 uart_resume_port(&sci_uart_driver, &p->port);
1883 spin_unlock_irqrestore(&priv->lock, flags);
1885 return 0;
1888 static const struct dev_pm_ops sci_dev_pm_ops = {
1889 .suspend = sci_suspend,
1890 .resume = sci_resume,
1893 static struct platform_driver sci_driver = {
1894 .probe = sci_probe,
1895 .remove = sci_remove,
1896 .driver = {
1897 .name = "sh-sci",
1898 .owner = THIS_MODULE,
1899 .pm = &sci_dev_pm_ops,
1903 static int __init sci_init(void)
1905 int ret;
1907 printk(banner);
1909 ret = uart_register_driver(&sci_uart_driver);
1910 if (likely(ret == 0)) {
1911 ret = platform_driver_register(&sci_driver);
1912 if (unlikely(ret))
1913 uart_unregister_driver(&sci_uart_driver);
1916 return ret;
1919 static void __exit sci_exit(void)
1921 platform_driver_unregister(&sci_driver);
1922 uart_unregister_driver(&sci_uart_driver);
1925 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1926 early_platform_init_buffer("earlyprintk", &sci_driver,
1927 early_serial_buf, ARRAY_SIZE(early_serial_buf));
1928 #endif
1929 module_init(sci_init);
1930 module_exit(sci_exit);
1932 MODULE_LICENSE("GPL");
1933 MODULE_ALIAS("platform:sh-sci");