Merge branches 'sh/intc-extension', 'sh/dmaengine', 'sh/serial-dma' and 'sh/clkfwk'
[firefly-linux-kernel-4.4.55.git] / drivers / serial / sh-sci.c
1 /*
2  * drivers/serial/sh-sci.c
3  *
4  * SuperH on-chip serial module support.  (SCI with no FIFO / with FIFO)
5  *
6  *  Copyright (C) 2002 - 2008  Paul Mundt
7  *  Modified to support SH7720 SCIF. Markus Brunner, Mark Jonas (Jul 2007).
8  *
9  * based off of the old drivers/char/sh-sci.c by:
10  *
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).
17  *
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.
21  */
22 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
23 #define SUPPORT_SYSRQ
24 #endif
25
26 #undef DEBUG
27
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
54 #ifdef CONFIG_SUPERH
55 #include <asm/sh_bios.h>
56 #endif
57
58 #ifdef CONFIG_H8300
59 #include <asm/gpio.h>
60 #endif
61
62 #include "sh-sci.h"
63
64 struct sci_port {
65         struct uart_port        port;
66
67         /* Port type */
68         unsigned int            type;
69
70         /* Port IRQs: ERI, RXI, TXI, BRI (optional) */
71         unsigned int            irqs[SCIx_NR_IRQS];
72
73         /* Port enable callback */
74         void                    (*enable)(struct uart_port *port);
75
76         /* Port disable callback */
77         void                    (*disable)(struct uart_port *port);
78
79         /* Break timer */
80         struct timer_list       break_timer;
81         int                     break_flag;
82
83         /* Interface clock */
84         struct clk              *iclk;
85         /* Function clock */
86         struct clk              *fclk;
87
88         struct list_head        node;
89         struct dma_chan                 *chan_tx;
90         struct dma_chan                 *chan_rx;
91 #ifdef CONFIG_SERIAL_SH_SCI_DMA
92         struct device                   *dma_dev;
93         unsigned int                    slave_tx;
94         unsigned int                    slave_rx;
95         struct dma_async_tx_descriptor  *desc_tx;
96         struct dma_async_tx_descriptor  *desc_rx[2];
97         dma_cookie_t                    cookie_tx;
98         dma_cookie_t                    cookie_rx[2];
99         dma_cookie_t                    active_rx;
100         struct scatterlist              sg_tx;
101         unsigned int                    sg_len_tx;
102         struct scatterlist              sg_rx[2];
103         size_t                          buf_len_rx;
104         struct sh_dmae_slave            param_tx;
105         struct sh_dmae_slave            param_rx;
106         struct work_struct              work_tx;
107         struct work_struct              work_rx;
108         struct timer_list               rx_timer;
109         unsigned int                    rx_timeout;
110 #endif
111 };
112
113 struct sh_sci_priv {
114         spinlock_t lock;
115         struct list_head ports;
116         struct notifier_block clk_nb;
117 };
118
119 /* Function prototypes */
120 static void sci_stop_tx(struct uart_port *port);
121
122 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
123
124 static struct sci_port sci_ports[SCI_NPORTS];
125 static struct uart_driver sci_uart_driver;
126
127 static inline struct sci_port *
128 to_sci_port(struct uart_port *uart)
129 {
130         return container_of(uart, struct sci_port, port);
131 }
132
133 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
134
135 #ifdef CONFIG_CONSOLE_POLL
136 static inline void handle_error(struct uart_port *port)
137 {
138         /* Clear error flags */
139         sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
140 }
141
142 static int sci_poll_get_char(struct uart_port *port)
143 {
144         unsigned short status;
145         int c;
146
147         do {
148                 status = sci_in(port, SCxSR);
149                 if (status & SCxSR_ERRORS(port)) {
150                         handle_error(port);
151                         continue;
152                 }
153         } while (!(status & SCxSR_RDxF(port)));
154
155         c = sci_in(port, SCxRDR);
156
157         /* Dummy read */
158         sci_in(port, SCxSR);
159         sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
160
161         return c;
162 }
163 #endif
164
165 static void sci_poll_put_char(struct uart_port *port, unsigned char c)
166 {
167         unsigned short status;
168
169         do {
170                 status = sci_in(port, SCxSR);
171         } while (!(status & SCxSR_TDxE(port)));
172
173         sci_out(port, SCxTDR, c);
174         sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port) & ~SCxSR_TEND(port));
175 }
176 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE */
177
178 #if defined(__H8300H__) || defined(__H8300S__)
179 static void sci_init_pins(struct uart_port *port, unsigned int cflag)
180 {
181         int ch = (port->mapbase - SMR0) >> 3;
182
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);
190
191         /* tx mark output*/
192         H8300_SCI_DR(ch) |= h8300_sci_pins[ch].tx;
193 }
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)
196 {
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);
202 }
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)
205 {
206         unsigned short data;
207
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);
218                 }
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);
228                 }
229         }
230 }
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)
234 {
235         unsigned short data;
236
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);
241
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);
248
249                 data = __raw_readb(SCPDR);
250                 /* Set /RTS2 (bit6) = 0 */
251                 __raw_writeb(data & 0xbf, SCPDR);
252         }
253 }
254 #elif defined(CONFIG_CPU_SUBTYPE_SH7722)
255 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
256 {
257         unsigned short data;
258
259         if (port->mapbase == 0xffe00000) {
260                 data = __raw_readw(PSCR);
261                 data &= ~0x03cf;
262                 if (!(cflag & CRTSCTS))
263                         data |= 0x0340;
264
265                 __raw_writew(data, PSCR);
266         }
267 }
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)
275 {
276         if (!(cflag & CRTSCTS))
277                 __raw_writew(0x0080, SCSPTR0); /* Set RTS = 1 */
278 }
279 #elif defined(CONFIG_CPU_SH4) && !defined(CONFIG_CPU_SH4A)
280 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
281 {
282         if (!(cflag & CRTSCTS))
283                 __raw_writew(0x0080, SCSPTR2); /* Set RTS = 1 */
284 }
285 #else
286 static inline void sci_init_pins(struct uart_port *port, unsigned int cflag)
287 {
288         /* Nothing to do */
289 }
290 #endif
291
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)
297 {
298         return sci_in(port, SCTFDR) & 0xff;
299 }
300
301 static int scif_txroom(struct uart_port *port)
302 {
303         return SCIF_TXROOM_MAX - scif_txfill(port);
304 }
305
306 static int scif_rxfill(struct uart_port *port)
307 {
308         return sci_in(port, SCRFDR) & 0xff;
309 }
310 #elif defined(CONFIG_CPU_SUBTYPE_SH7763)
311 static int scif_txfill(struct uart_port *port)
312 {
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;
320 }
321
322 static int scif_txroom(struct uart_port *port)
323 {
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);
331 }
332
333 static int scif_rxfill(struct uart_port *port)
334 {
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;
342         }
343 }
344 #else
345 static int scif_txfill(struct uart_port *port)
346 {
347         return sci_in(port, SCFDR) >> 8;
348 }
349
350 static int scif_txroom(struct uart_port *port)
351 {
352         return SCIF_TXROOM_MAX - scif_txfill(port);
353 }
354
355 static int scif_rxfill(struct uart_port *port)
356 {
357         return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
358 }
359 #endif
360
361 static int sci_txfill(struct uart_port *port)
362 {
363         return !(sci_in(port, SCxSR) & SCI_TDRE);
364 }
365
366 static int sci_txroom(struct uart_port *port)
367 {
368         return !sci_txfill(port);
369 }
370
371 static int sci_rxfill(struct uart_port *port)
372 {
373         return (sci_in(port, SCxSR) & SCxSR_RDxF(port)) != 0;
374 }
375
376 /* ********************************************************************** *
377  *                   the interrupt related routines                       *
378  * ********************************************************************** */
379
380 static void sci_transmit_chars(struct uart_port *port)
381 {
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;
387
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;
397         }
398
399         if (port->type == PORT_SCI)
400                 count = sci_txroom(port);
401         else
402                 count = scif_txroom(port);
403
404         do {
405                 unsigned char c;
406
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;
415                 }
416
417                 sci_out(port, SCxTDR, c);
418
419                 port->icount.tx++;
420         } while (--count > 0);
421
422         sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
423
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);
430
431                 if (port->type != PORT_SCI) {
432                         sci_in(port, SCxSR); /* Dummy read */
433                         sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
434                 }
435
436                 ctrl |= SCI_CTRL_FLAGS_TIE;
437                 sci_out(port, SCSCR, ctrl);
438         }
439 }
440
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); })
443
444 static inline void sci_receive_chars(struct uart_port *port)
445 {
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;
451
452         status = sci_in(port, SCxSR);
453         if (!(status & SCxSR_RDxF(port)))
454                 return;
455
456         while (1) {
457                 if (port->type == PORT_SCI)
458                         count = sci_rxfill(port);
459                 else
460                         count = scif_rxfill(port);
461
462                 /* Don't copy more bytes than there is room for in the buffer */
463                 count = tty_buffer_request_room(tty, count);
464
465                 /* If for any reason we can't copy more data, we're done! */
466                 if (count == 0)
467                         break;
468
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;
487                                         }
488
489                                         /* Nonzero => end-of-break */
490                                         dev_dbg(port->dev, "debounce<%02x>\n", c);
491                                         sci_port->break_flag = 0;
492
493                                         if (STEPFN(c)) {
494                                                 count--; i--;
495                                                 continue;
496                                         }
497                                 }
498 #endif /* CONFIG_CPU_SH3 */
499                                 if (uart_handle_sysrq_char(port, c)) {
500                                         count--; i--;
501                                         continue;
502                                 }
503
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;
513
514                                 tty_insert_flip_char(tty, c, flag);
515                         }
516                 }
517
518                 sci_in(port, SCxSR); /* dummy read */
519                 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
520
521                 copied += count;
522                 port->icount.rx += count;
523         }
524
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));
531         }
532 }
533
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.
541  */
542 static void sci_schedule_break_timer(struct sci_port *port)
543 {
544         port->break_timer.expires = jiffies + SCI_BREAK_JIFFIES;
545         add_timer(&port->break_timer);
546 }
547 /* Ensure that two consecutive samples find the break over. */
548 static void sci_break_timer(unsigned long data)
549 {
550         struct sci_port *port = (struct sci_port *)data;
551
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;
561 }
562
563 static inline int sci_handle_errors(struct uart_port *port)
564 {
565         int copied = 0;
566         unsigned short status = sci_in(port, SCxSR);
567         struct tty_struct *tty = port->state->port.tty;
568
569         if (status & SCxSR_ORER(port)) {
570                 /* overrun error */
571                 if (tty_insert_flip_char(tty, 0, TTY_OVERRUN))
572                         copied++;
573
574                 dev_notice(port->dev, "overrun error");
575         }
576
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);
581
582                         if (!sci_port->break_flag) {
583                                 sci_port->break_flag = 1;
584                                 sci_schedule_break_timer(sci_port);
585
586                                 /* Do sysrq handling. */
587                                 if (uart_handle_break(port))
588                                         return 0;
589
590                                 dev_dbg(port->dev, "BREAK detected\n");
591
592                                 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
593                                         copied++;
594                         }
595
596                 } else {
597                         /* frame error */
598                         if (tty_insert_flip_char(tty, 0, TTY_FRAME))
599                                 copied++;
600
601                         dev_notice(port->dev, "frame error\n");
602                 }
603         }
604
605         if (status & SCxSR_PER(port)) {
606                 /* parity error */
607                 if (tty_insert_flip_char(tty, 0, TTY_PARITY))
608                         copied++;
609
610                 dev_notice(port->dev, "parity error");
611         }
612
613         if (copied)
614                 tty_flip_buffer_push(tty);
615
616         return copied;
617 }
618
619 static inline int sci_handle_fifo_overrun(struct uart_port *port)
620 {
621         struct tty_struct *tty = port->state->port.tty;
622         int copied = 0;
623
624         if (port->type != PORT_SCIF)
625                 return 0;
626
627         if ((sci_in(port, SCLSR) & SCIF_ORER) != 0) {
628                 sci_out(port, SCLSR, 0);
629
630                 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
631                 tty_flip_buffer_push(tty);
632
633                 dev_notice(port->dev, "overrun error\n");
634                 copied++;
635         }
636
637         return copied;
638 }
639
640 static inline int sci_handle_breaks(struct uart_port *port)
641 {
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);
646
647         if (uart_handle_break(port))
648                 return 0;
649
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++;
658
659                 dev_dbg(port->dev, "BREAK detected\n");
660         }
661
662         if (copied)
663                 tty_flip_buffer_push(tty);
664
665         copied += sci_handle_fifo_overrun(port);
666
667         return copied;
668 }
669
670 static irqreturn_t sci_rx_interrupt(int irq, void *ptr)
671 {
672 #ifdef CONFIG_SERIAL_SH_SCI_DMA
673         struct uart_port *port = ptr;
674         struct sci_port *s = to_sci_port(port);
675
676         if (s->chan_rx) {
677                 u16 scr = sci_in(port, SCSCR);
678                 u16 ssr = sci_in(port, SCxSR);
679
680                 /* Disable future Rx interrupts */
681                 if (port->type == PORT_SCIFA) {
682                         disable_irq_nosync(irq);
683                         scr |= 0x4000;
684                 } else {
685                         scr &= ~SCI_CTRL_FLAGS_RIE;
686                 }
687                 sci_out(port, SCSCR, scr);
688                 /* Clear current interrupt */
689                 sci_out(port, SCxSR, ssr & ~(1 | SCxSR_RDxF(port)));
690                 dev_dbg(port->dev, "Rx IRQ %lu: setup t-out in %u jiffies\n",
691                         jiffies, s->rx_timeout);
692                 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
693
694                 return IRQ_HANDLED;
695         }
696 #endif
697
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?
701          */
702         sci_receive_chars(ptr);
703
704         return IRQ_HANDLED;
705 }
706
707 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
708 {
709         struct uart_port *port = ptr;
710         unsigned long flags;
711
712         spin_lock_irqsave(&port->lock, flags);
713         sci_transmit_chars(port);
714         spin_unlock_irqrestore(&port->lock, flags);
715
716         return IRQ_HANDLED;
717 }
718
719 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
720 {
721         struct uart_port *port = ptr;
722
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));
729                 }
730         } else {
731                 sci_handle_fifo_overrun(port);
732                 sci_rx_interrupt(irq, ptr);
733         }
734
735         sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
736
737         /* Kick the transmission */
738         sci_tx_interrupt(irq, ptr);
739
740         return IRQ_HANDLED;
741 }
742
743 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
744 {
745         struct uart_port *port = ptr;
746
747         /* Handle BREAKs */
748         sci_handle_breaks(port);
749         sci_out(port, SCxSR, SCxSR_BREAK_CLEAR(port));
750
751         return IRQ_HANDLED;
752 }
753
754 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
755 {
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;
760
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);
764
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);
769         /*
770          * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
771          * DR flags
772          */
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);
782
783         return ret;
784 }
785
786 /*
787  * Here we define a transistion notifier so that we can update all of our
788  * ports' baud rate when the peripheral clock changes.
789  */
790 static int sci_notifier(struct notifier_block *self,
791                         unsigned long phase, void *p)
792 {
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;
797
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->iclk);
803                 spin_unlock_irqrestore(&priv->lock, flags);
804         }
805
806         return NOTIFY_OK;
807 }
808
809 static void sci_clk_enable(struct uart_port *port)
810 {
811         struct sci_port *sci_port = to_sci_port(port);
812
813         clk_enable(sci_port->iclk);
814         sci_port->port.uartclk = clk_get_rate(sci_port->iclk);
815         clk_enable(sci_port->fclk);
816 }
817
818 static void sci_clk_disable(struct uart_port *port)
819 {
820         struct sci_port *sci_port = to_sci_port(port);
821
822         clk_disable(sci_port->fclk);
823         clk_disable(sci_port->iclk);
824 }
825
826 static int sci_request_irq(struct sci_port *port)
827 {
828         int i;
829         irqreturn_t (*handlers[4])(int irq, void *ptr) = {
830                 sci_er_interrupt, sci_rx_interrupt, sci_tx_interrupt,
831                 sci_br_interrupt,
832         };
833         const char *desc[] = { "SCI Receive Error", "SCI Receive Data Full",
834                                "SCI Transmit Data Empty", "SCI Break" };
835
836         if (port->irqs[0] == port->irqs[1]) {
837                 if (unlikely(!port->irqs[0]))
838                         return -ENODEV;
839
840                 if (request_irq(port->irqs[0], sci_mpxed_interrupt,
841                                 IRQF_DISABLED, "sci", port)) {
842                         dev_err(port->port.dev, "Can't allocate IRQ\n");
843                         return -ENODEV;
844                 }
845         } else {
846                 for (i = 0; i < ARRAY_SIZE(handlers); i++) {
847                         if (unlikely(!port->irqs[i]))
848                                 continue;
849
850                         if (request_irq(port->irqs[i], handlers[i],
851                                         IRQF_DISABLED, desc[i], port)) {
852                                 dev_err(port->port.dev, "Can't allocate IRQ\n");
853                                 return -ENODEV;
854                         }
855                 }
856         }
857
858         return 0;
859 }
860
861 static void sci_free_irq(struct sci_port *port)
862 {
863         int i;
864
865         if (port->irqs[0] == port->irqs[1])
866                 free_irq(port->irqs[0], port);
867         else {
868                 for (i = 0; i < ARRAY_SIZE(port->irqs); i++) {
869                         if (!port->irqs[i])
870                                 continue;
871
872                         free_irq(port->irqs[i], port);
873                 }
874         }
875 }
876
877 static unsigned int sci_tx_empty(struct uart_port *port)
878 {
879         unsigned short status = sci_in(port, SCxSR);
880         unsigned short in_tx_fifo = scif_txfill(port);
881
882         return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
883 }
884
885 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
886 {
887         /* This routine is used for seting signals of: DTR, DCD, CTS/RTS */
888         /* We use SCIF's hardware for CTS/RTS, so don't need any for that. */
889         /* If you have signals for DTR and DCD, please implement here. */
890 }
891
892 static unsigned int sci_get_mctrl(struct uart_port *port)
893 {
894         /* This routine is used for getting signals of: DTR, DCD, DSR, RI,
895            and CTS/RTS */
896
897         return TIOCM_DTR | TIOCM_RTS | TIOCM_DSR;
898 }
899
900 #ifdef CONFIG_SERIAL_SH_SCI_DMA
901 static void sci_dma_tx_complete(void *arg)
902 {
903         struct sci_port *s = arg;
904         struct uart_port *port = &s->port;
905         struct circ_buf *xmit = &port->state->xmit;
906         unsigned long flags;
907
908         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
909
910         spin_lock_irqsave(&port->lock, flags);
911
912         xmit->tail += sg_dma_len(&s->sg_tx);
913         xmit->tail &= UART_XMIT_SIZE - 1;
914
915         port->icount.tx += sg_dma_len(&s->sg_tx);
916
917         async_tx_ack(s->desc_tx);
918         s->cookie_tx = -EINVAL;
919         s->desc_tx = NULL;
920
921         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
922                 uart_write_wakeup(port);
923
924         if (!uart_circ_empty(xmit)) {
925                 schedule_work(&s->work_tx);
926         } else if (port->type == PORT_SCIFA) {
927                 u16 ctrl = sci_in(port, SCSCR);
928                 sci_out(port, SCSCR, ctrl & ~SCI_CTRL_FLAGS_TIE);
929         }
930
931         spin_unlock_irqrestore(&port->lock, flags);
932 }
933
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)
937 {
938         struct uart_port *port = &s->port;
939         int i, active, room;
940
941         room = tty_buffer_request_room(tty, count);
942
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;
950         }
951
952         if (room < count)
953                 dev_warn(port->dev, "Rx overrun: dropping %u bytes\n",
954                          count - room);
955         if (!room)
956                 return room;
957
958         for (i = 0; i < room; i++)
959                 tty_insert_flip_char(tty, ((u8 *)sg_virt(&s->sg_rx[active]))[i],
960                                      TTY_NORMAL);
961
962         port->icount.rx += room;
963
964         return room;
965 }
966
967 static void sci_dma_rx_complete(void *arg)
968 {
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;
974
975         dev_dbg(port->dev, "%s(%d) active #%d\n", __func__, port->line, s->active_rx);
976
977         spin_lock_irqsave(&port->lock, flags);
978
979         count = sci_dma_rx_push(s, tty, s->buf_len_rx);
980
981         mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
982
983         spin_unlock_irqrestore(&port->lock, flags);
984
985         if (count)
986                 tty_flip_buffer_push(tty);
987
988         schedule_work(&s->work_rx);
989 }
990
991 static void sci_start_rx(struct uart_port *port);
992 static void sci_start_tx(struct uart_port *port);
993
994 static void sci_rx_dma_release(struct sci_port *s, bool enable_pio)
995 {
996         struct dma_chan *chan = s->chan_rx;
997         struct uart_port *port = &s->port;
998
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);
1006 }
1007
1008 static void sci_tx_dma_release(struct sci_port *s, bool enable_pio)
1009 {
1010         struct dma_chan *chan = s->chan_tx;
1011         struct uart_port *port = &s->port;
1012
1013         s->chan_tx = NULL;
1014         s->cookie_tx = -EINVAL;
1015         dma_release_channel(chan);
1016         if (enable_pio)
1017                 sci_start_tx(port);
1018 }
1019
1020 static void sci_submit_rx(struct sci_port *s)
1021 {
1022         struct dma_chan *chan = s->chan_rx;
1023         int i;
1024
1025         for (i = 0; i < 2; i++) {
1026                 struct scatterlist *sg = &s->sg_rx[i];
1027                 struct dma_async_tx_descriptor *desc;
1028
1029                 desc = chan->device->device_prep_slave_sg(chan,
1030                         sg, 1, DMA_FROM_DEVICE, DMA_PREP_INTERRUPT);
1031
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);
1037                 }
1038
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;
1043                         }
1044                         if (desc) {
1045                                 async_tx_ack(desc);
1046                                 s->cookie_rx[i] = -EINVAL;
1047                         }
1048                         dev_warn(s->port.dev,
1049                                  "failed to re-start DMA, using PIO\n");
1050                         sci_rx_dma_release(s, true);
1051                         return;
1052                 }
1053                 dev_dbg(s->port.dev, "%s(): cookie %d to #%d\n", __func__,
1054                         s->cookie_rx[i], i);
1055         }
1056
1057         s->active_rx = s->cookie_rx[0];
1058
1059         dma_async_issue_pending(chan);
1060 }
1061
1062 static void work_fn_rx(struct work_struct *work)
1063 {
1064         struct sci_port *s = container_of(work, struct sci_port, work_rx);
1065         struct uart_port *port = &s->port;
1066         struct dma_async_tx_descriptor *desc;
1067         int new;
1068
1069         if (s->active_rx == s->cookie_rx[0]) {
1070                 new = 0;
1071         } else if (s->active_rx == s->cookie_rx[1]) {
1072                 new = 1;
1073         } else {
1074                 dev_err(port->dev, "cookie %d not found!\n", s->active_rx);
1075                 return;
1076         }
1077         desc = s->desc_rx[new];
1078
1079         if (dma_async_is_tx_complete(s->chan_rx, s->active_rx, NULL, NULL) !=
1080             DMA_SUCCESS) {
1081                 /* Handle incomplete DMA receive */
1082                 struct tty_struct *tty = port->state->port.tty;
1083                 struct dma_chan *chan = s->chan_rx;
1084                 struct sh_desc *sh_desc = container_of(desc, struct sh_desc,
1085                                                        async_tx);
1086                 unsigned long flags;
1087                 int count;
1088
1089                 chan->device->device_terminate_all(chan);
1090                 dev_dbg(port->dev, "Read %u bytes with cookie %d\n",
1091                         sh_desc->partial, sh_desc->cookie);
1092
1093                 spin_lock_irqsave(&port->lock, flags);
1094                 count = sci_dma_rx_push(s, tty, sh_desc->partial);
1095                 spin_unlock_irqrestore(&port->lock, flags);
1096
1097                 if (count)
1098                         tty_flip_buffer_push(tty);
1099
1100                 sci_submit_rx(s);
1101
1102                 return;
1103         }
1104
1105         s->cookie_rx[new] = desc->tx_submit(desc);
1106         if (s->cookie_rx[new] < 0) {
1107                 dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1108                 sci_rx_dma_release(s, true);
1109                 return;
1110         }
1111
1112         s->active_rx = s->cookie_rx[!new];
1113
1114         dev_dbg(port->dev, "%s: cookie %d #%d, new active #%d\n", __func__,
1115                 s->cookie_rx[new], new, s->active_rx);
1116 }
1117
1118 static void work_fn_tx(struct work_struct *work)
1119 {
1120         struct sci_port *s = container_of(work, struct sci_port, work_tx);
1121         struct dma_async_tx_descriptor *desc;
1122         struct dma_chan *chan = s->chan_tx;
1123         struct uart_port *port = &s->port;
1124         struct circ_buf *xmit = &port->state->xmit;
1125         struct scatterlist *sg = &s->sg_tx;
1126
1127         /*
1128          * DMA is idle now.
1129          * Port xmit buffer is already mapped, and it is one page... Just adjust
1130          * offsets and lengths. Since it is a circular buffer, we have to
1131          * transmit till the end, and then the rest. Take the port lock to get a
1132          * consistent xmit buffer state.
1133          */
1134         spin_lock_irq(&port->lock);
1135         sg->offset = xmit->tail & (UART_XMIT_SIZE - 1);
1136         sg_dma_address(sg) = (sg_dma_address(sg) & ~(UART_XMIT_SIZE - 1)) +
1137                 sg->offset;
1138         sg_dma_len(sg) = min((int)CIRC_CNT(xmit->head, xmit->tail, UART_XMIT_SIZE),
1139                 CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE));
1140         spin_unlock_irq(&port->lock);
1141
1142         BUG_ON(!sg_dma_len(sg));
1143
1144         desc = chan->device->device_prep_slave_sg(chan,
1145                         sg, s->sg_len_tx, DMA_TO_DEVICE,
1146                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1147         if (!desc) {
1148                 /* switch to PIO */
1149                 sci_tx_dma_release(s, true);
1150                 return;
1151         }
1152
1153         dma_sync_sg_for_device(port->dev, sg, 1, DMA_TO_DEVICE);
1154
1155         spin_lock_irq(&port->lock);
1156         s->desc_tx = desc;
1157         desc->callback = sci_dma_tx_complete;
1158         desc->callback_param = s;
1159         spin_unlock_irq(&port->lock);
1160         s->cookie_tx = desc->tx_submit(desc);
1161         if (s->cookie_tx < 0) {
1162                 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1163                 /* switch to PIO */
1164                 sci_tx_dma_release(s, true);
1165                 return;
1166         }
1167
1168         dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n", __func__,
1169                 xmit->buf, xmit->tail, xmit->head, s->cookie_tx);
1170
1171         dma_async_issue_pending(chan);
1172 }
1173 #endif
1174
1175 static void sci_start_tx(struct uart_port *port)
1176 {
1177         struct sci_port *s = to_sci_port(port);
1178         unsigned short ctrl;
1179
1180 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1181         if (port->type == PORT_SCIFA) {
1182                 u16 new, scr = sci_in(port, SCSCR);
1183                 if (s->chan_tx)
1184                         new = scr | 0x8000;
1185                 else
1186                         new = scr & ~0x8000;
1187                 if (new != scr)
1188                         sci_out(port, SCSCR, new);
1189         }
1190         if (s->chan_tx && !uart_circ_empty(&s->port.state->xmit) &&
1191             s->cookie_tx < 0)
1192                 schedule_work(&s->work_tx);
1193 #endif
1194         if (!s->chan_tx || port->type == PORT_SCIFA) {
1195                 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
1196                 ctrl = sci_in(port, SCSCR);
1197                 sci_out(port, SCSCR, ctrl | SCI_CTRL_FLAGS_TIE);
1198         }
1199 }
1200
1201 static void sci_stop_tx(struct uart_port *port)
1202 {
1203         unsigned short ctrl;
1204
1205         /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
1206         ctrl = sci_in(port, SCSCR);
1207         if (port->type == PORT_SCIFA)
1208                 ctrl &= ~0x8000;
1209         ctrl &= ~SCI_CTRL_FLAGS_TIE;
1210         sci_out(port, SCSCR, ctrl);
1211 }
1212
1213 static void sci_start_rx(struct uart_port *port)
1214 {
1215         unsigned short ctrl = SCI_CTRL_FLAGS_RIE | SCI_CTRL_FLAGS_REIE;
1216
1217         /* Set RIE (Receive Interrupt Enable) bit in SCSCR */
1218         ctrl |= sci_in(port, SCSCR);
1219         if (port->type == PORT_SCIFA)
1220                 ctrl &= ~0x4000;
1221         sci_out(port, SCSCR, ctrl);
1222 }
1223
1224 static void sci_stop_rx(struct uart_port *port)
1225 {
1226         unsigned short ctrl;
1227
1228         /* Clear RIE (Receive Interrupt Enable) bit in SCSCR */
1229         ctrl = sci_in(port, SCSCR);
1230         if (port->type == PORT_SCIFA)
1231                 ctrl &= ~0x4000;
1232         ctrl &= ~(SCI_CTRL_FLAGS_RIE | SCI_CTRL_FLAGS_REIE);
1233         sci_out(port, SCSCR, ctrl);
1234 }
1235
1236 static void sci_enable_ms(struct uart_port *port)
1237 {
1238         /* Nothing here yet .. */
1239 }
1240
1241 static void sci_break_ctl(struct uart_port *port, int break_state)
1242 {
1243         /* Nothing here yet .. */
1244 }
1245
1246 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1247 static bool filter(struct dma_chan *chan, void *slave)
1248 {
1249         struct sh_dmae_slave *param = slave;
1250
1251         dev_dbg(chan->device->dev, "%s: slave ID %d\n", __func__,
1252                 param->slave_id);
1253
1254         if (param->dma_dev == chan->device->dev) {
1255                 chan->private = param;
1256                 return true;
1257         } else {
1258                 return false;
1259         }
1260 }
1261
1262 static void rx_timer_fn(unsigned long arg)
1263 {
1264         struct sci_port *s = (struct sci_port *)arg;
1265         struct uart_port *port = &s->port;
1266         u16 scr = sci_in(port, SCSCR);
1267
1268         if (port->type == PORT_SCIFA) {
1269                 scr &= ~0x4000;
1270                 enable_irq(s->irqs[1]);
1271         }
1272         sci_out(port, SCSCR, scr | SCI_CTRL_FLAGS_RIE);
1273         dev_dbg(port->dev, "DMA Rx timed out\n");
1274         schedule_work(&s->work_rx);
1275 }
1276
1277 static void sci_request_dma(struct uart_port *port)
1278 {
1279         struct sci_port *s = to_sci_port(port);
1280         struct sh_dmae_slave *param;
1281         struct dma_chan *chan;
1282         dma_cap_mask_t mask;
1283         int nent;
1284
1285         dev_dbg(port->dev, "%s: port %d DMA %p\n", __func__,
1286                 port->line, s->dma_dev);
1287
1288         if (!s->dma_dev)
1289                 return;
1290
1291         dma_cap_zero(mask);
1292         dma_cap_set(DMA_SLAVE, mask);
1293
1294         param = &s->param_tx;
1295
1296         /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_TX */
1297         param->slave_id = s->slave_tx;
1298         param->dma_dev = s->dma_dev;
1299
1300         s->cookie_tx = -EINVAL;
1301         chan = dma_request_channel(mask, filter, param);
1302         dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1303         if (chan) {
1304                 s->chan_tx = chan;
1305                 sg_init_table(&s->sg_tx, 1);
1306                 /* UART circular tx buffer is an aligned page. */
1307                 BUG_ON((int)port->state->xmit.buf & ~PAGE_MASK);
1308                 sg_set_page(&s->sg_tx, virt_to_page(port->state->xmit.buf),
1309                             UART_XMIT_SIZE, (int)port->state->xmit.buf & ~PAGE_MASK);
1310                 nent = dma_map_sg(port->dev, &s->sg_tx, 1, DMA_TO_DEVICE);
1311                 if (!nent)
1312                         sci_tx_dma_release(s, false);
1313                 else
1314                         dev_dbg(port->dev, "%s: mapped %d@%p to %x\n", __func__,
1315                                 sg_dma_len(&s->sg_tx),
1316                                 port->state->xmit.buf, sg_dma_address(&s->sg_tx));
1317
1318                 s->sg_len_tx = nent;
1319
1320                 INIT_WORK(&s->work_tx, work_fn_tx);
1321         }
1322
1323         param = &s->param_rx;
1324
1325         /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_RX */
1326         param->slave_id = s->slave_rx;
1327         param->dma_dev = s->dma_dev;
1328
1329         chan = dma_request_channel(mask, filter, param);
1330         dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1331         if (chan) {
1332                 dma_addr_t dma[2];
1333                 void *buf[2];
1334                 int i;
1335
1336                 s->chan_rx = chan;
1337
1338                 s->buf_len_rx = 2 * max(16, (int)port->fifosize);
1339                 buf[0] = dma_alloc_coherent(port->dev, s->buf_len_rx * 2,
1340                                             &dma[0], GFP_KERNEL);
1341
1342                 if (!buf[0]) {
1343                         dev_warn(port->dev,
1344                                  "failed to allocate dma buffer, using PIO\n");
1345                         sci_rx_dma_release(s, true);
1346                         return;
1347                 }
1348
1349                 buf[1] = buf[0] + s->buf_len_rx;
1350                 dma[1] = dma[0] + s->buf_len_rx;
1351
1352                 for (i = 0; i < 2; i++) {
1353                         struct scatterlist *sg = &s->sg_rx[i];
1354
1355                         sg_init_table(sg, 1);
1356                         sg_set_page(sg, virt_to_page(buf[i]), s->buf_len_rx,
1357                                     (int)buf[i] & ~PAGE_MASK);
1358                         sg_dma_address(sg) = dma[i];
1359                 }
1360
1361                 INIT_WORK(&s->work_rx, work_fn_rx);
1362                 setup_timer(&s->rx_timer, rx_timer_fn, (unsigned long)s);
1363
1364                 sci_submit_rx(s);
1365         }
1366 }
1367
1368 static void sci_free_dma(struct uart_port *port)
1369 {
1370         struct sci_port *s = to_sci_port(port);
1371
1372         if (!s->dma_dev)
1373                 return;
1374
1375         if (s->chan_tx)
1376                 sci_tx_dma_release(s, false);
1377         if (s->chan_rx)
1378                 sci_rx_dma_release(s, false);
1379 }
1380 #endif
1381
1382 static int sci_startup(struct uart_port *port)
1383 {
1384         struct sci_port *s = to_sci_port(port);
1385
1386         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1387
1388         if (s->enable)
1389                 s->enable(port);
1390
1391         sci_request_irq(s);
1392 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1393         sci_request_dma(port);
1394 #endif
1395         sci_start_tx(port);
1396         sci_start_rx(port);
1397
1398         return 0;
1399 }
1400
1401 static void sci_shutdown(struct uart_port *port)
1402 {
1403         struct sci_port *s = to_sci_port(port);
1404
1405         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1406
1407         sci_stop_rx(port);
1408         sci_stop_tx(port);
1409 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1410         sci_free_dma(port);
1411 #endif
1412         sci_free_irq(s);
1413
1414         if (s->disable)
1415                 s->disable(port);
1416 }
1417
1418 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
1419                             struct ktermios *old)
1420 {
1421 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1422         struct sci_port *s = to_sci_port(port);
1423 #endif
1424         unsigned int status, baud, smr_val, max_baud;
1425         int t = -1;
1426         u16 scfcr = 0;
1427
1428         /*
1429          * earlyprintk comes here early on with port->uartclk set to zero.
1430          * the clock framework is not up and running at this point so here
1431          * we assume that 115200 is the maximum baud rate. please note that
1432          * the baud rate is not programmed during earlyprintk - it is assumed
1433          * that the previous boot loader has enabled required clocks and
1434          * setup the baud rate generator hardware for us already.
1435          */
1436         max_baud = port->uartclk ? port->uartclk / 16 : 115200;
1437
1438         baud = uart_get_baud_rate(port, termios, old, 0, max_baud);
1439         if (likely(baud && port->uartclk))
1440                 t = SCBRR_VALUE(baud, port->uartclk);
1441
1442         do {
1443                 status = sci_in(port, SCxSR);
1444         } while (!(status & SCxSR_TEND(port)));
1445
1446         sci_out(port, SCSCR, 0x00);     /* TE=0, RE=0, CKE1=0 */
1447
1448         if (port->type != PORT_SCI)
1449                 sci_out(port, SCFCR, scfcr | SCFCR_RFRST | SCFCR_TFRST);
1450
1451         smr_val = sci_in(port, SCSMR) & 3;
1452         if ((termios->c_cflag & CSIZE) == CS7)
1453                 smr_val |= 0x40;
1454         if (termios->c_cflag & PARENB)
1455                 smr_val |= 0x20;
1456         if (termios->c_cflag & PARODD)
1457                 smr_val |= 0x30;
1458         if (termios->c_cflag & CSTOPB)
1459                 smr_val |= 0x08;
1460
1461         uart_update_timeout(port, termios->c_cflag, baud);
1462
1463         sci_out(port, SCSMR, smr_val);
1464
1465         dev_dbg(port->dev, "%s: SMR %x, t %x, SCSCR %x\n", __func__, smr_val, t,
1466                 SCSCR_INIT(port));
1467
1468         if (t > 0) {
1469                 if (t >= 256) {
1470                         sci_out(port, SCSMR, (sci_in(port, SCSMR) & ~3) | 1);
1471                         t >>= 2;
1472                 } else
1473                         sci_out(port, SCSMR, sci_in(port, SCSMR) & ~3);
1474
1475                 sci_out(port, SCBRR, t);
1476                 udelay((1000000+(baud-1)) / baud); /* Wait one bit interval */
1477         }
1478
1479         sci_init_pins(port, termios->c_cflag);
1480         sci_out(port, SCFCR, scfcr | ((termios->c_cflag & CRTSCTS) ? SCFCR_MCE : 0));
1481
1482         sci_out(port, SCSCR, SCSCR_INIT(port));
1483
1484 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1485         /*
1486          * Calculate delay for 1.5 DMA buffers: see
1487          * drivers/serial/serial_core.c::uart_update_timeout(). With 10 bits
1488          * (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above function
1489          * calculates 1 jiffie for the data plus 5 jiffies for the "slop(e)."
1490          * Then below we calculate 3 jiffies (12ms) for 1.5 DMA buffers (3 FIFO
1491          * sizes), but it has been found out experimentally, that this is not
1492          * enough: the driver too often needlessly runs on a DMA timeout. 20ms
1493          * as a minimum seem to work perfectly.
1494          */
1495         if (s->chan_rx) {
1496                 s->rx_timeout = (port->timeout - HZ / 50) * s->buf_len_rx * 3 /
1497                         port->fifosize / 2;
1498                 dev_dbg(port->dev,
1499                         "DMA Rx t-out %ums, tty t-out %u jiffies\n",
1500                         s->rx_timeout * 1000 / HZ, port->timeout);
1501                 if (s->rx_timeout < msecs_to_jiffies(20))
1502                         s->rx_timeout = msecs_to_jiffies(20);
1503         }
1504 #endif
1505
1506         if ((termios->c_cflag & CREAD) != 0)
1507                 sci_start_rx(port);
1508 }
1509
1510 static const char *sci_type(struct uart_port *port)
1511 {
1512         switch (port->type) {
1513         case PORT_IRDA:
1514                 return "irda";
1515         case PORT_SCI:
1516                 return "sci";
1517         case PORT_SCIF:
1518                 return "scif";
1519         case PORT_SCIFA:
1520                 return "scifa";
1521         }
1522
1523         return NULL;
1524 }
1525
1526 static void sci_release_port(struct uart_port *port)
1527 {
1528         /* Nothing here yet .. */
1529 }
1530
1531 static int sci_request_port(struct uart_port *port)
1532 {
1533         /* Nothing here yet .. */
1534         return 0;
1535 }
1536
1537 static void sci_config_port(struct uart_port *port, int flags)
1538 {
1539         struct sci_port *s = to_sci_port(port);
1540
1541         port->type = s->type;
1542
1543         if (port->membase)
1544                 return;
1545
1546         if (port->flags & UPF_IOREMAP) {
1547                 port->membase = ioremap_nocache(port->mapbase, 0x40);
1548
1549                 if (IS_ERR(port->membase))
1550                         dev_err(port->dev, "can't remap port#%d\n", port->line);
1551         } else {
1552                 /*
1553                  * For the simple (and majority of) cases where we don't
1554                  * need to do any remapping, just cast the cookie
1555                  * directly.
1556                  */
1557                 port->membase = (void __iomem *)port->mapbase;
1558         }
1559 }
1560
1561 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
1562 {
1563         struct sci_port *s = to_sci_port(port);
1564
1565         if (ser->irq != s->irqs[SCIx_TXI_IRQ] || ser->irq > nr_irqs)
1566                 return -EINVAL;
1567         if (ser->baud_base < 2400)
1568                 /* No paper tape reader for Mitch.. */
1569                 return -EINVAL;
1570
1571         return 0;
1572 }
1573
1574 static struct uart_ops sci_uart_ops = {
1575         .tx_empty       = sci_tx_empty,
1576         .set_mctrl      = sci_set_mctrl,
1577         .get_mctrl      = sci_get_mctrl,
1578         .start_tx       = sci_start_tx,
1579         .stop_tx        = sci_stop_tx,
1580         .stop_rx        = sci_stop_rx,
1581         .enable_ms      = sci_enable_ms,
1582         .break_ctl      = sci_break_ctl,
1583         .startup        = sci_startup,
1584         .shutdown       = sci_shutdown,
1585         .set_termios    = sci_set_termios,
1586         .type           = sci_type,
1587         .release_port   = sci_release_port,
1588         .request_port   = sci_request_port,
1589         .config_port    = sci_config_port,
1590         .verify_port    = sci_verify_port,
1591 #ifdef CONFIG_CONSOLE_POLL
1592         .poll_get_char  = sci_poll_get_char,
1593         .poll_put_char  = sci_poll_put_char,
1594 #endif
1595 };
1596
1597 static int __devinit sci_init_single(struct platform_device *dev,
1598                                      struct sci_port *sci_port,
1599                                      unsigned int index,
1600                                      struct plat_sci_port *p)
1601 {
1602         struct uart_port *port = &sci_port->port;
1603
1604         port->ops       = &sci_uart_ops;
1605         port->iotype    = UPIO_MEM;
1606         port->line      = index;
1607
1608         switch (p->type) {
1609         case PORT_SCIFA:
1610                 port->fifosize = 64;
1611                 break;
1612         case PORT_SCIF:
1613                 port->fifosize = 16;
1614                 break;
1615         default:
1616                 port->fifosize = 1;
1617                 break;
1618         }
1619
1620         if (dev) {
1621                 sci_port->iclk = clk_get(&dev->dev, "sci_ick");
1622                 if (IS_ERR(sci_port->iclk)) {
1623                         sci_port->iclk = clk_get(&dev->dev, "peripheral_clk");
1624                         if (IS_ERR(sci_port->iclk)) {
1625                                 dev_err(&dev->dev, "can't get iclk\n");
1626                                 return PTR_ERR(sci_port->iclk);
1627                         }
1628                 }
1629
1630                 /*
1631                  * The function clock is optional, ignore it if we can't
1632                  * find it.
1633                  */
1634                 sci_port->fclk = clk_get(&dev->dev, "sci_fck");
1635                 if (IS_ERR(sci_port->fclk))
1636                         sci_port->fclk = NULL;
1637
1638                 sci_port->enable = sci_clk_enable;
1639                 sci_port->disable = sci_clk_disable;
1640                 port->dev = &dev->dev;
1641         }
1642
1643         sci_port->break_timer.data = (unsigned long)sci_port;
1644         sci_port->break_timer.function = sci_break_timer;
1645         init_timer(&sci_port->break_timer);
1646
1647         port->mapbase   = p->mapbase;
1648         port->membase   = p->membase;
1649
1650         port->irq       = p->irqs[SCIx_TXI_IRQ];
1651         port->flags     = p->flags;
1652         sci_port->type  = port->type = p->type;
1653
1654 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1655         sci_port->dma_dev       = p->dma_dev;
1656         sci_port->slave_tx      = p->dma_slave_tx;
1657         sci_port->slave_rx      = p->dma_slave_rx;
1658
1659         dev_dbg(port->dev, "%s: DMA device %p, tx %d, rx %d\n", __func__,
1660                 p->dma_dev, p->dma_slave_tx, p->dma_slave_rx);
1661 #endif
1662
1663         memcpy(&sci_port->irqs, &p->irqs, sizeof(p->irqs));
1664         return 0;
1665 }
1666
1667 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1668 static struct tty_driver *serial_console_device(struct console *co, int *index)
1669 {
1670         struct uart_driver *p = &sci_uart_driver;
1671         *index = co->index;
1672         return p->tty_driver;
1673 }
1674
1675 static void serial_console_putchar(struct uart_port *port, int ch)
1676 {
1677         sci_poll_put_char(port, ch);
1678 }
1679
1680 /*
1681  *      Print a string to the serial port trying not to disturb
1682  *      any possible real use of the port...
1683  */
1684 static void serial_console_write(struct console *co, const char *s,
1685                                  unsigned count)
1686 {
1687         struct uart_port *port = co->data;
1688         struct sci_port *sci_port = to_sci_port(port);
1689         unsigned short bits;
1690
1691         if (sci_port->enable)
1692                 sci_port->enable(port);
1693
1694         uart_console_write(port, s, count, serial_console_putchar);
1695
1696         /* wait until fifo is empty and last bit has been transmitted */
1697         bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
1698         while ((sci_in(port, SCxSR) & bits) != bits)
1699                 cpu_relax();
1700
1701         if (sci_port->disable)
1702                 sci_port->disable(port);
1703 }
1704
1705 static int __devinit serial_console_setup(struct console *co, char *options)
1706 {
1707         struct sci_port *sci_port;
1708         struct uart_port *port;
1709         int baud = 115200;
1710         int bits = 8;
1711         int parity = 'n';
1712         int flow = 'n';
1713         int ret;
1714
1715         /*
1716          * Check whether an invalid uart number has been specified, and
1717          * if so, search for the first available port that does have
1718          * console support.
1719          */
1720         if (co->index >= SCI_NPORTS)
1721                 co->index = 0;
1722
1723         if (co->data) {
1724                 port = co->data;
1725                 sci_port = to_sci_port(port);
1726         } else {
1727                 sci_port = &sci_ports[co->index];
1728                 port = &sci_port->port;
1729                 co->data = port;
1730         }
1731
1732         /*
1733          * Also need to check port->type, we don't actually have any
1734          * UPIO_PORT ports, but uart_report_port() handily misreports
1735          * it anyways if we don't have a port available by the time this is
1736          * called.
1737          */
1738         if (!port->type)
1739                 return -ENODEV;
1740
1741         sci_config_port(port, 0);
1742
1743         if (sci_port->enable)
1744                 sci_port->enable(port);
1745
1746         if (options)
1747                 uart_parse_options(options, &baud, &parity, &bits, &flow);
1748
1749         ret = uart_set_options(port, co, baud, parity, bits, flow);
1750 #if defined(__H8300H__) || defined(__H8300S__)
1751         /* disable rx interrupt */
1752         if (ret == 0)
1753                 sci_stop_rx(port);
1754 #endif
1755         /* TODO: disable clock */
1756         return ret;
1757 }
1758
1759 static struct console serial_console = {
1760         .name           = "ttySC",
1761         .device         = serial_console_device,
1762         .write          = serial_console_write,
1763         .setup          = serial_console_setup,
1764         .flags          = CON_PRINTBUFFER,
1765         .index          = -1,
1766 };
1767
1768 static int __init sci_console_init(void)
1769 {
1770         register_console(&serial_console);
1771         return 0;
1772 }
1773 console_initcall(sci_console_init);
1774
1775 static struct sci_port early_serial_port;
1776 static struct console early_serial_console = {
1777         .name           = "early_ttySC",
1778         .write          = serial_console_write,
1779         .flags          = CON_PRINTBUFFER,
1780 };
1781 static char early_serial_buf[32];
1782
1783 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
1784
1785 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
1786 #define SCI_CONSOLE     (&serial_console)
1787 #else
1788 #define SCI_CONSOLE     0
1789 #endif
1790
1791 static char banner[] __initdata =
1792         KERN_INFO "SuperH SCI(F) driver initialized\n";
1793
1794 static struct uart_driver sci_uart_driver = {
1795         .owner          = THIS_MODULE,
1796         .driver_name    = "sci",
1797         .dev_name       = "ttySC",
1798         .major          = SCI_MAJOR,
1799         .minor          = SCI_MINOR_START,
1800         .nr             = SCI_NPORTS,
1801         .cons           = SCI_CONSOLE,
1802 };
1803
1804
1805 static int sci_remove(struct platform_device *dev)
1806 {
1807         struct sh_sci_priv *priv = platform_get_drvdata(dev);
1808         struct sci_port *p;
1809         unsigned long flags;
1810
1811         cpufreq_unregister_notifier(&priv->clk_nb, CPUFREQ_TRANSITION_NOTIFIER);
1812
1813         spin_lock_irqsave(&priv->lock, flags);
1814         list_for_each_entry(p, &priv->ports, node) {
1815                 uart_remove_one_port(&sci_uart_driver, &p->port);
1816                 clk_put(p->iclk);
1817                 clk_put(p->fclk);
1818         }
1819         spin_unlock_irqrestore(&priv->lock, flags);
1820
1821         kfree(priv);
1822         return 0;
1823 }
1824
1825 static int __devinit sci_probe_single(struct platform_device *dev,
1826                                       unsigned int index,
1827                                       struct plat_sci_port *p,
1828                                       struct sci_port *sciport)
1829 {
1830         struct sh_sci_priv *priv = platform_get_drvdata(dev);
1831         unsigned long flags;
1832         int ret;
1833
1834         /* Sanity check */
1835         if (unlikely(index >= SCI_NPORTS)) {
1836                 dev_notice(&dev->dev, "Attempting to register port "
1837                            "%d when only %d are available.\n",
1838                            index+1, SCI_NPORTS);
1839                 dev_notice(&dev->dev, "Consider bumping "
1840                            "CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
1841                 return 0;
1842         }
1843
1844         ret = sci_init_single(dev, sciport, index, p);
1845         if (ret)
1846                 return ret;
1847
1848         ret = uart_add_one_port(&sci_uart_driver, &sciport->port);
1849         if (ret)
1850                 return ret;
1851
1852         INIT_LIST_HEAD(&sciport->node);
1853
1854         spin_lock_irqsave(&priv->lock, flags);
1855         list_add(&sciport->node, &priv->ports);
1856         spin_unlock_irqrestore(&priv->lock, flags);
1857
1858         return 0;
1859 }
1860
1861 /*
1862  * Register a set of serial devices attached to a platform device.  The
1863  * list is terminated with a zero flags entry, which means we expect
1864  * all entries to have at least UPF_BOOT_AUTOCONF set. Platforms that need
1865  * remapping (such as sh64) should also set UPF_IOREMAP.
1866  */
1867 static int __devinit sci_probe(struct platform_device *dev)
1868 {
1869         struct plat_sci_port *p = dev->dev.platform_data;
1870         struct sh_sci_priv *priv;
1871         int i, ret = -EINVAL;
1872
1873 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1874         if (is_early_platform_device(dev)) {
1875                 if (dev->id == -1)
1876                         return -ENOTSUPP;
1877                 early_serial_console.index = dev->id;
1878                 early_serial_console.data = &early_serial_port.port;
1879                 sci_init_single(NULL, &early_serial_port, dev->id, p);
1880                 serial_console_setup(&early_serial_console, early_serial_buf);
1881                 if (!strstr(early_serial_buf, "keep"))
1882                         early_serial_console.flags |= CON_BOOT;
1883                 register_console(&early_serial_console);
1884                 return 0;
1885         }
1886 #endif
1887
1888         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1889         if (!priv)
1890                 return -ENOMEM;
1891
1892         INIT_LIST_HEAD(&priv->ports);
1893         spin_lock_init(&priv->lock);
1894         platform_set_drvdata(dev, priv);
1895
1896         priv->clk_nb.notifier_call = sci_notifier;
1897         cpufreq_register_notifier(&priv->clk_nb, CPUFREQ_TRANSITION_NOTIFIER);
1898
1899         if (dev->id != -1) {
1900                 ret = sci_probe_single(dev, dev->id, p, &sci_ports[dev->id]);
1901                 if (ret)
1902                         goto err_unreg;
1903         } else {
1904                 for (i = 0; p && p->flags != 0; p++, i++) {
1905                         ret = sci_probe_single(dev, i, p, &sci_ports[i]);
1906                         if (ret)
1907                                 goto err_unreg;
1908                 }
1909         }
1910
1911 #ifdef CONFIG_SH_STANDARD_BIOS
1912         sh_bios_gdb_detach();
1913 #endif
1914
1915         return 0;
1916
1917 err_unreg:
1918         sci_remove(dev);
1919         return ret;
1920 }
1921
1922 static int sci_suspend(struct device *dev)
1923 {
1924         struct sh_sci_priv *priv = dev_get_drvdata(dev);
1925         struct sci_port *p;
1926         unsigned long flags;
1927
1928         spin_lock_irqsave(&priv->lock, flags);
1929         list_for_each_entry(p, &priv->ports, node)
1930                 uart_suspend_port(&sci_uart_driver, &p->port);
1931         spin_unlock_irqrestore(&priv->lock, flags);
1932
1933         return 0;
1934 }
1935
1936 static int sci_resume(struct device *dev)
1937 {
1938         struct sh_sci_priv *priv = dev_get_drvdata(dev);
1939         struct sci_port *p;
1940         unsigned long flags;
1941
1942         spin_lock_irqsave(&priv->lock, flags);
1943         list_for_each_entry(p, &priv->ports, node)
1944                 uart_resume_port(&sci_uart_driver, &p->port);
1945         spin_unlock_irqrestore(&priv->lock, flags);
1946
1947         return 0;
1948 }
1949
1950 static const struct dev_pm_ops sci_dev_pm_ops = {
1951         .suspend        = sci_suspend,
1952         .resume         = sci_resume,
1953 };
1954
1955 static struct platform_driver sci_driver = {
1956         .probe          = sci_probe,
1957         .remove         = sci_remove,
1958         .driver         = {
1959                 .name   = "sh-sci",
1960                 .owner  = THIS_MODULE,
1961                 .pm     = &sci_dev_pm_ops,
1962         },
1963 };
1964
1965 static int __init sci_init(void)
1966 {
1967         int ret;
1968
1969         printk(banner);
1970
1971         ret = uart_register_driver(&sci_uart_driver);
1972         if (likely(ret == 0)) {
1973                 ret = platform_driver_register(&sci_driver);
1974                 if (unlikely(ret))
1975                         uart_unregister_driver(&sci_uart_driver);
1976         }
1977
1978         return ret;
1979 }
1980
1981 static void __exit sci_exit(void)
1982 {
1983         platform_driver_unregister(&sci_driver);
1984         uart_unregister_driver(&sci_uart_driver);
1985 }
1986
1987 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1988 early_platform_init_buffer("earlyprintk", &sci_driver,
1989                            early_serial_buf, ARRAY_SIZE(early_serial_buf));
1990 #endif
1991 module_init(sci_init);
1992 module_exit(sci_exit);
1993
1994 MODULE_LICENSE("GPL");
1995 MODULE_ALIAS("platform:sh-sci");