drivers/tty/serial/sh-sci.c

   1 /*
   2  * SuperH on-chip serial module support.  (SCI with no FIFO / with FIFO)
   3  *
   4  *  Copyright (C) 2002 - 2011  Paul Mundt
   5  *  Modified to support SH7720 SCIF. Markus Brunner, Mark Jonas (Jul 2007).
   6  *
   7  * based off of the old drivers/char/sh-sci.c by:
   8  *
   9  *   Copyright (C) 1999, 2000  Niibe Yutaka
  10  *   Copyright (C) 2000  Sugioka Toshinobu
  11  *   Modified to support multiple serial ports. Stuart Menefy (May 2000).
  12  *   Modified to support SecureEdge. David McCullough (2002)
  13  *   Modified to support SH7300 SCIF. Takashi Kusuda (Jun 2003).
  14  *   Removed SH7300 support (Jul 2007).
  15  *
  16  * This file is subject to the terms and conditions of the GNU General Public
  17  * License.  See the file "COPYING" in the main directory of this archive
  18  * for more details.
  19  */
  20 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
  21 #define SUPPORT_SYSRQ
  22 #endif
  23
  24 #undef DEBUG
  25
  26 #include <linux/module.h>
  27 #include <linux/errno.h>
  28 #include <linux/timer.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/tty.h>
  31 #include <linux/tty_flip.h>
  32 #include <linux/serial.h>
  33 #include <linux/major.h>
  34 #include <linux/string.h>
  35 #include <linux/sysrq.h>
  36 #include <linux/ioport.h>
  37 #include <linux/mm.h>
  38 #include <linux/init.h>
  39 #include <linux/delay.h>
  40 #include <linux/console.h>
  41 #include <linux/platform_device.h>
  42 #include <linux/serial_sci.h>
  43 #include <linux/notifier.h>
  44 #include <linux/pm_runtime.h>
  45 #include <linux/cpufreq.h>
  46 #include <linux/clk.h>
  47 #include <linux/ctype.h>
  48 #include <linux/err.h>
  49 #include <linux/dmaengine.h>
  50 #include <linux/scatterlist.h>
  51 #include <linux/slab.h>
  52
  53 #ifdef CONFIG_SUPERH
  54 #include <asm/sh_bios.h>
  55 #endif
  56
  57 #include "sh-sci.h"
  58
  59 struct sci_port {
  60         struct uart_port        port;
  61
  62         /* Platform configuration */
  63         struct plat_sci_port    *cfg;
  64
  65         /* Port enable callback */
  66         void                    (*enable)(struct uart_port *port);
  67
  68         /* Port disable callback */
  69         void                    (*disable)(struct uart_port *port);
  70
  71         /* Break timer */
  72         struct timer_list       break_timer;
  73         int                     break_flag;
  74
  75         /* Interface clock */
  76         struct clk              *iclk;
  77         /* Function clock */
  78         struct clk              *fclk;
  79
  80         struct dma_chan                 *chan_tx;
  81         struct dma_chan                 *chan_rx;
  82
  83 #ifdef CONFIG_SERIAL_SH_SCI_DMA
  84         struct dma_async_tx_descriptor  *desc_tx;
  85         struct dma_async_tx_descriptor  *desc_rx[2];
  86         dma_cookie_t                    cookie_tx;
  87         dma_cookie_t                    cookie_rx[2];
  88         dma_cookie_t                    active_rx;
  89         struct scatterlist              sg_tx;
  90         unsigned int                    sg_len_tx;
  91         struct scatterlist              sg_rx[2];
  92         size_t                          buf_len_rx;
  93         struct sh_dmae_slave            param_tx;
  94         struct sh_dmae_slave            param_rx;
  95         struct work_struct              work_tx;
  96         struct work_struct              work_rx;
  97         struct timer_list               rx_timer;
  98         unsigned int                    rx_timeout;
  99 #endif
 100
 101         struct notifier_block           freq_transition;
 102 };
 103
 104 /* Function prototypes */
 105 static void sci_start_tx(struct uart_port *port);
 106 static void sci_stop_tx(struct uart_port *port);
 107 static void sci_start_rx(struct uart_port *port);
 108
 109 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
 110
 111 static struct sci_port sci_ports[SCI_NPORTS];
 112 static struct uart_driver sci_uart_driver;
 113
 114 static inline struct sci_port *
 115 to_sci_port(struct uart_port *uart)
 116 {
 117         return container_of(uart, struct sci_port, port);
 118 }
 119
 120 struct plat_sci_reg {
 121         u8 offset, size;
 122 };
 123
 124 /* Helper for invalidating specific entries of an inherited map. */
 125 #define sci_reg_invalid { .offset = 0, .size = 0 }
 126
 127 static struct plat_sci_reg sci_regmap[SCIx_NR_REGTYPES][SCIx_NR_REGS] = {
 128         [SCIx_PROBE_REGTYPE] = {
 129                 [0 ... SCIx_NR_REGS - 1] = sci_reg_invalid,
 130         },
 131
 132         /*
 133          * Common SCI definitions, dependent on the port's regshift
 134          * value.
 135          */
 136         [SCIx_SCI_REGTYPE] = {
 137                 [SCSMR]         = { 0x00,  8 },
 138                 [SCBRR]         = { 0x01,  8 },
 139                 [SCSCR]         = { 0x02,  8 },
 140                 [SCxTDR]        = { 0x03,  8 },
 141                 [SCxSR]         = { 0x04,  8 },
 142                 [SCxRDR]        = { 0x05,  8 },
 143                 [SCFCR]         = sci_reg_invalid,
 144                 [SCFDR]         = sci_reg_invalid,
 145                 [SCTFDR]        = sci_reg_invalid,
 146                 [SCRFDR]        = sci_reg_invalid,
 147                 [SCSPTR]        = sci_reg_invalid,
 148                 [SCLSR]         = sci_reg_invalid,
 149         },
 150
 151         /*
 152          * Common definitions for legacy IrDA ports, dependent on
 153          * regshift value.
 154          */
 155         [SCIx_IRDA_REGTYPE] = {
 156                 [SCSMR]         = { 0x00,  8 },
 157                 [SCBRR]         = { 0x01,  8 },
 158                 [SCSCR]         = { 0x02,  8 },
 159                 [SCxTDR]        = { 0x03,  8 },
 160                 [SCxSR]         = { 0x04,  8 },
 161                 [SCxRDR]        = { 0x05,  8 },
 162                 [SCFCR]         = { 0x06,  8 },
 163                 [SCFDR]         = { 0x07, 16 },
 164                 [SCTFDR]        = sci_reg_invalid,
 165                 [SCRFDR]        = sci_reg_invalid,
 166                 [SCSPTR]        = sci_reg_invalid,
 167                 [SCLSR]         = sci_reg_invalid,
 168         },
 169
 170         /*
 171          * Common SCIFA definitions.
 172          */
 173         [SCIx_SCIFA_REGTYPE] = {
 174                 [SCSMR]         = { 0x00, 16 },
 175                 [SCBRR]         = { 0x04,  8 },
 176                 [SCSCR]         = { 0x08, 16 },
 177                 [SCxTDR]        = { 0x20,  8 },
 178                 [SCxSR]         = { 0x14, 16 },
 179                 [SCxRDR]        = { 0x24,  8 },
 180                 [SCFCR]         = { 0x18, 16 },
 181                 [SCFDR]         = { 0x1c, 16 },
 182                 [SCTFDR]        = sci_reg_invalid,
 183                 [SCRFDR]        = sci_reg_invalid,
 184                 [SCSPTR]        = sci_reg_invalid,
 185                 [SCLSR]         = sci_reg_invalid,
 186         },
 187
 188         /*
 189          * Common SCIFB definitions.
 190          */
 191         [SCIx_SCIFB_REGTYPE] = {
 192                 [SCSMR]         = { 0x00, 16 },
 193                 [SCBRR]         = { 0x04,  8 },
 194                 [SCSCR]         = { 0x08, 16 },
 195                 [SCxTDR]        = { 0x40,  8 },
 196                 [SCxSR]         = { 0x14, 16 },
 197                 [SCxRDR]        = { 0x60,  8 },
 198                 [SCFCR]         = { 0x18, 16 },
 199                 [SCFDR]         = { 0x1c, 16 },
 200                 [SCTFDR]        = sci_reg_invalid,
 201                 [SCRFDR]        = sci_reg_invalid,
 202                 [SCSPTR]        = sci_reg_invalid,
 203                 [SCLSR]         = sci_reg_invalid,
 204         },
 205
 206         /*
 207          * Common SH-3 SCIF definitions.
 208          */
 209         [SCIx_SH3_SCIF_REGTYPE] = {
 210                 [SCSMR]         = { 0x00,  8 },
 211                 [SCBRR]         = { 0x02,  8 },
 212                 [SCSCR]         = { 0x04,  8 },
 213                 [SCxTDR]        = { 0x06,  8 },
 214                 [SCxSR]         = { 0x08, 16 },
 215                 [SCxRDR]        = { 0x0a,  8 },
 216                 [SCFCR]         = { 0x0c,  8 },
 217                 [SCFDR]         = { 0x0e, 16 },
 218                 [SCTFDR]        = sci_reg_invalid,
 219                 [SCRFDR]        = sci_reg_invalid,
 220                 [SCSPTR]        = sci_reg_invalid,
 221                 [SCLSR]         = sci_reg_invalid,
 222         },
 223
 224         /*
 225          * Common SH-4(A) SCIF(B) definitions.
 226          */
 227         [SCIx_SH4_SCIF_REGTYPE] = {
 228                 [SCSMR]         = { 0x00, 16 },
 229                 [SCBRR]         = { 0x04,  8 },
 230                 [SCSCR]         = { 0x08, 16 },
 231                 [SCxTDR]        = { 0x0c,  8 },
 232                 [SCxSR]         = { 0x10, 16 },
 233                 [SCxRDR]        = { 0x14,  8 },
 234                 [SCFCR]         = { 0x18, 16 },
 235                 [SCFDR]         = { 0x1c, 16 },
 236                 [SCTFDR]        = sci_reg_invalid,
 237                 [SCRFDR]        = sci_reg_invalid,
 238                 [SCSPTR]        = { 0x20, 16 },
 239                 [SCLSR]         = { 0x24, 16 },
 240         },
 241
 242         /*
 243          * Common SH-4(A) SCIF(B) definitions for ports without an SCSPTR
 244          * register.
 245          */
 246         [SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE] = {
 247                 [SCSMR]         = { 0x00, 16 },
 248                 [SCBRR]         = { 0x04,  8 },
 249                 [SCSCR]         = { 0x08, 16 },
 250                 [SCxTDR]        = { 0x0c,  8 },
 251                 [SCxSR]         = { 0x10, 16 },
 252                 [SCxRDR]        = { 0x14,  8 },
 253                 [SCFCR]         = { 0x18, 16 },
 254                 [SCFDR]         = { 0x1c, 16 },
 255                 [SCTFDR]        = sci_reg_invalid,
 256                 [SCRFDR]        = sci_reg_invalid,
 257                 [SCSPTR]        = sci_reg_invalid,
 258                 [SCLSR]         = { 0x24, 16 },
 259         },
 260
 261         /*
 262          * Common SH-4(A) SCIF(B) definitions for ports with FIFO data
 263          * count registers.
 264          */
 265         [SCIx_SH4_SCIF_FIFODATA_REGTYPE] = {
 266                 [SCSMR]         = { 0x00, 16 },
 267                 [SCBRR]         = { 0x04,  8 },
 268                 [SCSCR]         = { 0x08, 16 },
 269                 [SCxTDR]        = { 0x0c,  8 },
 270                 [SCxSR]         = { 0x10, 16 },
 271                 [SCxRDR]        = { 0x14,  8 },
 272                 [SCFCR]         = { 0x18, 16 },
 273                 [SCFDR]         = { 0x1c, 16 },
 274                 [SCTFDR]        = { 0x1c, 16 }, /* aliased to SCFDR */
 275                 [SCRFDR]        = { 0x20, 16 },
 276                 [SCSPTR]        = { 0x24, 16 },
 277                 [SCLSR]         = { 0x28, 16 },
 278         },
 279
 280         /*
 281          * SH7705-style SCIF(B) ports, lacking both SCSPTR and SCLSR
 282          * registers.
 283          */
 284         [SCIx_SH7705_SCIF_REGTYPE] = {
 285                 [SCSMR]         = { 0x00, 16 },
 286                 [SCBRR]         = { 0x04,  8 },
 287                 [SCSCR]         = { 0x08, 16 },
 288                 [SCxTDR]        = { 0x20,  8 },
 289                 [SCxSR]         = { 0x14, 16 },
 290                 [SCxRDR]        = { 0x24,  8 },
 291                 [SCFCR]         = { 0x18, 16 },
 292                 [SCFDR]         = { 0x1c, 16 },
 293                 [SCTFDR]        = sci_reg_invalid,
 294                 [SCRFDR]        = sci_reg_invalid,
 295                 [SCSPTR]        = sci_reg_invalid,
 296                 [SCLSR]         = sci_reg_invalid,
 297         },
 298 };
 299
 300 #define sci_getreg(up, offset)          (sci_regmap[to_sci_port(up)->cfg->regtype] + offset)
 301
 302 /*
 303  * The "offset" here is rather misleading, in that it refers to an enum
 304  * value relative to the port mapping rather than the fixed offset
 305  * itself, which needs to be manually retrieved from the platform's
 306  * register map for the given port.
 307  */
 308 static unsigned int sci_serial_in(struct uart_port *p, int offset)
 309 {
 310         struct plat_sci_reg *reg = sci_getreg(p, offset);
 311
 312         if (reg->size == 8)
 313                 return ioread8(p->membase + (reg->offset << p->regshift));
 314         else if (reg->size == 16)
 315                 return ioread16(p->membase + (reg->offset << p->regshift));
 316         else
 317                 WARN(1, "Invalid register access\n");
 318
 319         return 0;
 320 }
 321
 322 static void sci_serial_out(struct uart_port *p, int offset, int value)
 323 {
 324         struct plat_sci_reg *reg = sci_getreg(p, offset);
 325
 326         if (reg->size == 8)
 327                 iowrite8(value, p->membase + (reg->offset << p->regshift));
 328         else if (reg->size == 16)
 329                 iowrite16(value, p->membase + (reg->offset << p->regshift));
 330         else
 331                 WARN(1, "Invalid register access\n");
 332 }
 333
 334 #define sci_in(up, offset)              (up->serial_in(up, offset))
 335 #define sci_out(up, offset, value)      (up->serial_out(up, offset, value))
 336
 337 static int sci_probe_regmap(struct plat_sci_port *cfg)
 338 {
 339         switch (cfg->type) {
 340         case PORT_SCI:
 341                 cfg->regtype = SCIx_SCI_REGTYPE;
 342                 break;
 343         case PORT_IRDA:
 344                 cfg->regtype = SCIx_IRDA_REGTYPE;
 345                 break;
 346         case PORT_SCIFA:
 347                 cfg->regtype = SCIx_SCIFA_REGTYPE;
 348                 break;
 349         case PORT_SCIFB:
 350                 cfg->regtype = SCIx_SCIFB_REGTYPE;
 351                 break;
 352         case PORT_SCIF:
 353                 /*
 354                  * The SH-4 is a bit of a misnomer here, although that's
 355                  * where this particular port layout originated. This
 356                  * configuration (or some slight variation thereof)
 357                  * remains the dominant model for all SCIFs.
 358                  */
 359                 cfg->regtype = SCIx_SH4_SCIF_REGTYPE;
 360                 break;
 361         default:
 362                 printk(KERN_ERR "Can't probe register map for given port\n");
 363                 return -EINVAL;
 364         }
 365
 366         return 0;
 367 }
 368
 369 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE)
 370
 371 #ifdef CONFIG_CONSOLE_POLL
 372 static int sci_poll_get_char(struct uart_port *port)
 373 {
 374         unsigned short status;
 375         int c;
 376
 377         do {
 378                 status = sci_in(port, SCxSR);
 379                 if (status & SCxSR_ERRORS(port)) {
 380                         sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
 381                         continue;
 382                 }
 383                 break;
 384         } while (1);
 385
 386         if (!(status & SCxSR_RDxF(port)))
 387                 return NO_POLL_CHAR;
 388
 389         c = sci_in(port, SCxRDR);
 390
 391         /* Dummy read */
 392         sci_in(port, SCxSR);
 393         sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
 394
 395         return c;
 396 }
 397 #endif
 398
 399 static void sci_poll_put_char(struct uart_port *port, unsigned char c)
 400 {
 401         unsigned short status;
 402
 403         do {
 404                 status = sci_in(port, SCxSR);
 405         } while (!(status & SCxSR_TDxE(port)));
 406
 407         sci_out(port, SCxTDR, c);
 408         sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port) & ~SCxSR_TEND(port));
 409 }
 410 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE */
 411
 412 static void sci_init_pins(struct uart_port *port, unsigned int cflag)
 413 {
 414         struct sci_port *s = to_sci_port(port);
 415         struct plat_sci_reg *reg = sci_regmap[s->cfg->regtype] + SCSPTR;
 416
 417         /*
 418          * Use port-specific handler if provided.
 419          */
 420         if (s->cfg->ops && s->cfg->ops->init_pins) {
 421                 s->cfg->ops->init_pins(port, cflag);
 422                 return;
 423         }
 424
 425         /*
 426          * For the generic path SCSPTR is necessary. Bail out if that's
 427          * unavailable, too.
 428          */
 429         if (!reg->size)
 430                 return;
 431
 432         if (!(cflag & CRTSCTS))
 433                 sci_out(port, SCSPTR, 0x0080); /* Set RTS = 1 */
 434 }
 435
 436 static int sci_txfill(struct uart_port *port)
 437 {
 438         struct plat_sci_reg *reg;
 439
 440         reg = sci_getreg(port, SCTFDR);
 441         if (reg->size)
 442                 return sci_in(port, SCTFDR) & 0xff;
 443
 444         reg = sci_getreg(port, SCFDR);
 445         if (reg->size)
 446                 return sci_in(port, SCFDR) >> 8;
 447
 448         return !(sci_in(port, SCxSR) & SCI_TDRE);
 449 }
 450
 451 static int sci_txroom(struct uart_port *port)
 452 {
 453         return port->fifosize - sci_txfill(port);
 454 }
 455
 456 static int sci_rxfill(struct uart_port *port)
 457 {
 458         struct plat_sci_reg *reg;
 459
 460         reg = sci_getreg(port, SCRFDR);
 461         if (reg->size)
 462                 return sci_in(port, SCRFDR) & 0xff;
 463
 464         reg = sci_getreg(port, SCFDR);
 465         if (reg->size)
 466                 return sci_in(port, SCFDR) & ((port->fifosize << 1) - 1);
 467
 468         return (sci_in(port, SCxSR) & SCxSR_RDxF(port)) != 0;
 469 }
 470
 471 /*
 472  * SCI helper for checking the state of the muxed port/RXD pins.
 473  */
 474 static inline int sci_rxd_in(struct uart_port *port)
 475 {
 476         struct sci_port *s = to_sci_port(port);
 477
 478         if (s->cfg->port_reg <= 0)
 479                 return 1;
 480
 481         return !!__raw_readb(s->cfg->port_reg);
 482 }
 483
 484 /* ********************************************************************** *
 485  *                   the interrupt related routines                       *
 486  * ********************************************************************** */
 487
 488 static void sci_transmit_chars(struct uart_port *port)
 489 {
 490         struct circ_buf *xmit = &port->state->xmit;
 491         unsigned int stopped = uart_tx_stopped(port);
 492         unsigned short status;
 493         unsigned short ctrl;
 494         int count;
 495
 496         status = sci_in(port, SCxSR);
 497         if (!(status & SCxSR_TDxE(port))) {
 498                 ctrl = sci_in(port, SCSCR);
 499                 if (uart_circ_empty(xmit))
 500                         ctrl &= ~SCSCR_TIE;
 501                 else
 502                         ctrl |= SCSCR_TIE;
 503                 sci_out(port, SCSCR, ctrl);
 504                 return;
 505         }
 506
 507         count = sci_txroom(port);
 508
 509         do {
 510                 unsigned char c;
 511
 512                 if (port->x_char) {
 513                         c = port->x_char;
 514                         port->x_char = 0;
 515                 } else if (!uart_circ_empty(xmit) && !stopped) {
 516                         c = xmit->buf[xmit->tail];
 517                         xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
 518                 } else {
 519                         break;
 520                 }
 521
 522                 sci_out(port, SCxTDR, c);
 523
 524                 port->icount.tx++;
 525         } while (--count > 0);
 526
 527         sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
 528
 529         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 530                 uart_write_wakeup(port);
 531         if (uart_circ_empty(xmit)) {
 532                 sci_stop_tx(port);
 533         } else {
 534                 ctrl = sci_in(port, SCSCR);
 535
 536                 if (port->type != PORT_SCI) {
 537                         sci_in(port, SCxSR); /* Dummy read */
 538                         sci_out(port, SCxSR, SCxSR_TDxE_CLEAR(port));
 539                 }
 540
 541                 ctrl |= SCSCR_TIE;
 542                 sci_out(port, SCSCR, ctrl);
 543         }
 544 }
 545
 546 /* On SH3, SCIF may read end-of-break as a space->mark char */
 547 #define STEPFN(c)  ({int __c = (c); (((__c-1)|(__c)) == -1); })
 548
 549 static void sci_receive_chars(struct uart_port *port)
 550 {
 551         struct sci_port *sci_port = to_sci_port(port);
 552         struct tty_struct *tty = port->state->port.tty;
 553         int i, count, copied = 0;
 554         unsigned short status;
 555         unsigned char flag;
 556
 557         status = sci_in(port, SCxSR);
 558         if (!(status & SCxSR_RDxF(port)))
 559                 return;
 560
 561         while (1) {
 562                 /* Don't copy more bytes than there is room for in the buffer */
 563                 count = tty_buffer_request_room(tty, sci_rxfill(port));
 564
 565                 /* If for any reason we can't copy more data, we're done! */
 566                 if (count == 0)
 567                         break;
 568
 569                 if (port->type == PORT_SCI) {
 570                         char c = sci_in(port, SCxRDR);
 571                         if (uart_handle_sysrq_char(port, c) ||
 572                             sci_port->break_flag)
 573                                 count = 0;
 574                         else
 575                                 tty_insert_flip_char(tty, c, TTY_NORMAL);
 576                 } else {
 577                         for (i = 0; i < count; i++) {
 578                                 char c = sci_in(port, SCxRDR);
 579                                 status = sci_in(port, SCxSR);
 580 #if defined(CONFIG_CPU_SH3)
 581                                 /* Skip "chars" during break */
 582                                 if (sci_port->break_flag) {
 583                                         if ((c == 0) &&
 584                                             (status & SCxSR_FER(port))) {
 585                                                 count--; i--;
 586                                                 continue;
 587                                         }
 588
 589                                         /* Nonzero => end-of-break */
 590                                         dev_dbg(port->dev, "debounce<%02x>\n", c);
 591                                         sci_port->break_flag = 0;
 592
 593                                         if (STEPFN(c)) {
 594                                                 count--; i--;
 595                                                 continue;
 596                                         }
 597                                 }
 598 #endif /* CONFIG_CPU_SH3 */
 599                                 if (uart_handle_sysrq_char(port, c)) {
 600                                         count--; i--;
 601                                         continue;
 602                                 }
 603
 604                                 /* Store data and status */
 605                                 if (status & SCxSR_FER(port)) {
 606                                         flag = TTY_FRAME;
 607                                         dev_notice(port->dev, "frame error\n");
 608                                 } else if (status & SCxSR_PER(port)) {
 609                                         flag = TTY_PARITY;
 610                                         dev_notice(port->dev, "parity error\n");
 611                                 } else
 612                                         flag = TTY_NORMAL;
 613
 614                                 tty_insert_flip_char(tty, c, flag);
 615                         }
 616                 }
 617
 618                 sci_in(port, SCxSR); /* dummy read */
 619                 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
 620
 621                 copied += count;
 622                 port->icount.rx += count;
 623         }
 624
 625         if (copied) {
 626                 /* Tell the rest of the system the news. New characters! */
 627                 tty_flip_buffer_push(tty);
 628         } else {
 629                 sci_in(port, SCxSR); /* dummy read */
 630                 sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
 631         }
 632 }
 633
 634 #define SCI_BREAK_JIFFIES (HZ/20)
 635
 636 /*
 637  * The sci generates interrupts during the break,
 638  * 1 per millisecond or so during the break period, for 9600 baud.
 639  * So dont bother disabling interrupts.
 640  * But dont want more than 1 break event.
 641  * Use a kernel timer to periodically poll the rx line until
 642  * the break is finished.
 643  */
 644 static inline void sci_schedule_break_timer(struct sci_port *port)
 645 {
 646         mod_timer(&port->break_timer, jiffies + SCI_BREAK_JIFFIES);
 647 }
 648
 649 /* Ensure that two consecutive samples find the break over. */
 650 static void sci_break_timer(unsigned long data)
 651 {
 652         struct sci_port *port = (struct sci_port *)data;
 653
 654         if (port->enable)
 655                 port->enable(&port->port);
 656
 657         if (sci_rxd_in(&port->port) == 0) {
 658                 port->break_flag = 1;
 659                 sci_schedule_break_timer(port);
 660         } else if (port->break_flag == 1) {
 661                 /* break is over. */
 662                 port->break_flag = 2;
 663                 sci_schedule_break_timer(port);
 664         } else
 665                 port->break_flag = 0;
 666
 667         if (port->disable)
 668                 port->disable(&port->port);
 669 }
 670
 671 static int sci_handle_errors(struct uart_port *port)
 672 {
 673         int copied = 0;
 674         unsigned short status = sci_in(port, SCxSR);
 675         struct tty_struct *tty = port->state->port.tty;
 676         struct sci_port *s = to_sci_port(port);
 677
 678         /*
 679          * Handle overruns, if supported.
 680          */
 681         if (s->cfg->overrun_bit != SCIx_NOT_SUPPORTED) {
 682                 if (status & (1 << s->cfg->overrun_bit)) {
 683                         /* overrun error */
 684                         if (tty_insert_flip_char(tty, 0, TTY_OVERRUN))
 685                                 copied++;
 686
 687                         dev_notice(port->dev, "overrun error");
 688                 }
 689         }
 690
 691         if (status & SCxSR_FER(port)) {
 692                 if (sci_rxd_in(port) == 0) {
 693                         /* Notify of BREAK */
 694                         struct sci_port *sci_port = to_sci_port(port);
 695
 696                         if (!sci_port->break_flag) {
 697                                 sci_port->break_flag = 1;
 698                                 sci_schedule_break_timer(sci_port);
 699
 700                                 /* Do sysrq handling. */
 701                                 if (uart_handle_break(port))
 702                                         return 0;
 703
 704                                 dev_dbg(port->dev, "BREAK detected\n");
 705
 706                                 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
 707                                         copied++;
 708                         }
 709
 710                 } else {
 711                         /* frame error */
 712                         if (tty_insert_flip_char(tty, 0, TTY_FRAME))
 713                                 copied++;
 714
 715                         dev_notice(port->dev, "frame error\n");
 716                 }
 717         }
 718
 719         if (status & SCxSR_PER(port)) {
 720                 /* parity error */
 721                 if (tty_insert_flip_char(tty, 0, TTY_PARITY))
 722                         copied++;
 723
 724                 dev_notice(port->dev, "parity error");
 725         }
 726
 727         if (copied)
 728                 tty_flip_buffer_push(tty);
 729
 730         return copied;
 731 }
 732
 733 static int sci_handle_fifo_overrun(struct uart_port *port)
 734 {
 735         struct tty_struct *tty = port->state->port.tty;
 736         struct sci_port *s = to_sci_port(port);
 737         struct plat_sci_reg *reg;
 738         int copied = 0;
 739
 740         reg = sci_getreg(port, SCLSR);
 741         if (!reg->size)
 742                 return 0;
 743
 744         if ((sci_in(port, SCLSR) & (1 << s->cfg->overrun_bit))) {
 745                 sci_out(port, SCLSR, 0);
 746
 747                 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
 748                 tty_flip_buffer_push(tty);
 749
 750                 dev_notice(port->dev, "overrun error\n");
 751                 copied++;
 752         }
 753
 754         return copied;
 755 }
 756
 757 static int sci_handle_breaks(struct uart_port *port)
 758 {
 759         int copied = 0;
 760         unsigned short status = sci_in(port, SCxSR);
 761         struct tty_struct *tty = port->state->port.tty;
 762         struct sci_port *s = to_sci_port(port);
 763
 764         if (uart_handle_break(port))
 765                 return 0;
 766
 767         if (!s->break_flag && status & SCxSR_BRK(port)) {
 768 #if defined(CONFIG_CPU_SH3)
 769                 /* Debounce break */
 770                 s->break_flag = 1;
 771 #endif
 772                 /* Notify of BREAK */
 773                 if (tty_insert_flip_char(tty, 0, TTY_BREAK))
 774                         copied++;
 775
 776                 dev_dbg(port->dev, "BREAK detected\n");
 777         }
 778
 779         if (copied)
 780                 tty_flip_buffer_push(tty);
 781
 782         copied += sci_handle_fifo_overrun(port);
 783
 784         return copied;
 785 }
 786
 787 static irqreturn_t sci_rx_interrupt(int irq, void *ptr)
 788 {
 789 #ifdef CONFIG_SERIAL_SH_SCI_DMA
 790         struct uart_port *port = ptr;
 791         struct sci_port *s = to_sci_port(port);
 792
 793         if (s->chan_rx) {
 794                 u16 scr = sci_in(port, SCSCR);
 795                 u16 ssr = sci_in(port, SCxSR);
 796
 797                 /* Disable future Rx interrupts */
 798                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
 799                         disable_irq_nosync(irq);
 800                         scr |= 0x4000;
 801                 } else {
 802                         scr &= ~SCSCR_RIE;
 803                 }
 804                 sci_out(port, SCSCR, scr);
 805                 /* Clear current interrupt */
 806                 sci_out(port, SCxSR, ssr & ~(1 | SCxSR_RDxF(port)));
 807                 dev_dbg(port->dev, "Rx IRQ %lu: setup t-out in %u jiffies\n",
 808                         jiffies, s->rx_timeout);
 809                 mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
 810
 811                 return IRQ_HANDLED;
 812         }
 813 #endif
 814
 815         /* I think sci_receive_chars has to be called irrespective
 816          * of whether the I_IXOFF is set, otherwise, how is the interrupt
 817          * to be disabled?
 818          */
 819         sci_receive_chars(ptr);
 820
 821         return IRQ_HANDLED;
 822 }
 823
 824 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
 825 {
 826         struct uart_port *port = ptr;
 827         unsigned long flags;
 828
 829         spin_lock_irqsave(&port->lock, flags);
 830         sci_transmit_chars(port);
 831         spin_unlock_irqrestore(&port->lock, flags);
 832
 833         return IRQ_HANDLED;
 834 }
 835
 836 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
 837 {
 838         struct uart_port *port = ptr;
 839
 840         /* Handle errors */
 841         if (port->type == PORT_SCI) {
 842                 if (sci_handle_errors(port)) {
 843                         /* discard character in rx buffer */
 844                         sci_in(port, SCxSR);
 845                         sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
 846                 }
 847         } else {
 848                 sci_handle_fifo_overrun(port);
 849                 sci_rx_interrupt(irq, ptr);
 850         }
 851
 852         sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
 853
 854         /* Kick the transmission */
 855         sci_tx_interrupt(irq, ptr);
 856
 857         return IRQ_HANDLED;
 858 }
 859
 860 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
 861 {
 862         struct uart_port *port = ptr;
 863
 864         /* Handle BREAKs */
 865         sci_handle_breaks(port);
 866         sci_out(port, SCxSR, SCxSR_BREAK_CLEAR(port));
 867
 868         return IRQ_HANDLED;
 869 }
 870
 871 static inline unsigned long port_rx_irq_mask(struct uart_port *port)
 872 {
 873         /*
 874          * Not all ports (such as SCIFA) will support REIE. Rather than
 875          * special-casing the port type, we check the port initialization
 876          * IRQ enable mask to see whether the IRQ is desired at all. If
 877          * it's unset, it's logically inferred that there's no point in
 878          * testing for it.
 879          */
 880         return SCSCR_RIE | (to_sci_port(port)->cfg->scscr & SCSCR_REIE);
 881 }
 882
 883 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
 884 {
 885         unsigned short ssr_status, scr_status, err_enabled;
 886         struct uart_port *port = ptr;
 887         struct sci_port *s = to_sci_port(port);
 888         irqreturn_t ret = IRQ_NONE;
 889
 890         ssr_status = sci_in(port, SCxSR);
 891         scr_status = sci_in(port, SCSCR);
 892         err_enabled = scr_status & port_rx_irq_mask(port);
 893
 894         /* Tx Interrupt */
 895         if ((ssr_status & SCxSR_TDxE(port)) && (scr_status & SCSCR_TIE) &&
 896             !s->chan_tx)
 897                 ret = sci_tx_interrupt(irq, ptr);
 898
 899         /*
 900          * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
 901          * DR flags
 902          */
 903         if (((ssr_status & SCxSR_RDxF(port)) || s->chan_rx) &&
 904             (scr_status & SCSCR_RIE))
 905                 ret = sci_rx_interrupt(irq, ptr);
 906
 907         /* Error Interrupt */
 908         if ((ssr_status & SCxSR_ERRORS(port)) && err_enabled)
 909                 ret = sci_er_interrupt(irq, ptr);
 910
 911         /* Break Interrupt */
 912         if ((ssr_status & SCxSR_BRK(port)) && err_enabled)
 913                 ret = sci_br_interrupt(irq, ptr);
 914
 915         return ret;
 916 }
 917
 918 /*
 919  * Here we define a transition notifier so that we can update all of our
 920  * ports' baud rate when the peripheral clock changes.
 921  */
 922 static int sci_notifier(struct notifier_block *self,
 923                         unsigned long phase, void *p)
 924 {
 925         struct sci_port *sci_port;
 926         unsigned long flags;
 927
 928         sci_port = container_of(self, struct sci_port, freq_transition);
 929
 930         if ((phase == CPUFREQ_POSTCHANGE) ||
 931             (phase == CPUFREQ_RESUMECHANGE)) {
 932                 struct uart_port *port = &sci_port->port;
 933
 934                 spin_lock_irqsave(&port->lock, flags);
 935                 port->uartclk = clk_get_rate(sci_port->iclk);
 936                 spin_unlock_irqrestore(&port->lock, flags);
 937         }
 938
 939         return NOTIFY_OK;
 940 }
 941
 942 static void sci_clk_enable(struct uart_port *port)
 943 {
 944         struct sci_port *sci_port = to_sci_port(port);
 945
 946         pm_runtime_get_sync(port->dev);
 947
 948         clk_enable(sci_port->iclk);
 949         sci_port->port.uartclk = clk_get_rate(sci_port->iclk);
 950         clk_enable(sci_port->fclk);
 951 }
 952
 953 static void sci_clk_disable(struct uart_port *port)
 954 {
 955         struct sci_port *sci_port = to_sci_port(port);
 956
 957         clk_disable(sci_port->fclk);
 958         clk_disable(sci_port->iclk);
 959
 960         pm_runtime_put_sync(port->dev);
 961 }
 962
 963 static int sci_request_irq(struct sci_port *port)
 964 {
 965         int i;
 966         irqreturn_t (*handlers[4])(int irq, void *ptr) = {
 967                 sci_er_interrupt, sci_rx_interrupt, sci_tx_interrupt,
 968                 sci_br_interrupt,
 969         };
 970         const char *desc[] = { "SCI Receive Error", "SCI Receive Data Full",
 971                                "SCI Transmit Data Empty", "SCI Break" };
 972
 973         if (port->cfg->irqs[0] == port->cfg->irqs[1]) {
 974                 if (unlikely(!port->cfg->irqs[0]))
 975                         return -ENODEV;
 976
 977                 if (request_irq(port->cfg->irqs[0], sci_mpxed_interrupt,
 978                                 IRQF_DISABLED, "sci", port)) {
 979                         dev_err(port->port.dev, "Can't allocate IRQ\n");
 980                         return -ENODEV;
 981                 }
 982         } else {
 983                 for (i = 0; i < ARRAY_SIZE(handlers); i++) {
 984                         if (unlikely(!port->cfg->irqs[i]))
 985                                 continue;
 986
 987                         if (request_irq(port->cfg->irqs[i], handlers[i],
 988                                         IRQF_DISABLED, desc[i], port)) {
 989                                 dev_err(port->port.dev, "Can't allocate IRQ\n");
 990                                 return -ENODEV;
 991                         }
 992                 }
 993         }
 994
 995         return 0;
 996 }
 997
 998 static void sci_free_irq(struct sci_port *port)
 999 {
1000         int i;
1001
1002         if (port->cfg->irqs[0] == port->cfg->irqs[1])
1003                 free_irq(port->cfg->irqs[0], port);
1004         else {
1005                 for (i = 0; i < ARRAY_SIZE(port->cfg->irqs); i++) {
1006                         if (!port->cfg->irqs[i])
1007                                 continue;
1008
1009                         free_irq(port->cfg->irqs[i], port);
1010                 }
1011         }
1012 }
1013
1014 static unsigned int sci_tx_empty(struct uart_port *port)
1015 {
1016         unsigned short status = sci_in(port, SCxSR);
1017         unsigned short in_tx_fifo = sci_txfill(port);
1018
1019         return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
1020 }
1021
1022 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
1023 {
1024         /* This routine is used for seting signals of: DTR, DCD, CTS/RTS */
1025         /* We use SCIF's hardware for CTS/RTS, so don't need any for that. */
1026         /* If you have signals for DTR and DCD, please implement here. */
1027 }
1028
1029 static unsigned int sci_get_mctrl(struct uart_port *port)
1030 {
1031         /* This routine is used for getting signals of: DTR, DCD, DSR, RI,
1032            and CTS/RTS */
1033
1034         return TIOCM_DTR | TIOCM_RTS | TIOCM_DSR;
1035 }
1036
1037 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1038 static void sci_dma_tx_complete(void *arg)
1039 {
1040         struct sci_port *s = arg;
1041         struct uart_port *port = &s->port;
1042         struct circ_buf *xmit = &port->state->xmit;
1043         unsigned long flags;
1044
1045         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1046
1047         spin_lock_irqsave(&port->lock, flags);
1048
1049         xmit->tail += sg_dma_len(&s->sg_tx);
1050         xmit->tail &= UART_XMIT_SIZE - 1;
1051
1052         port->icount.tx += sg_dma_len(&s->sg_tx);
1053
1054         async_tx_ack(s->desc_tx);
1055         s->cookie_tx = -EINVAL;
1056         s->desc_tx = NULL;
1057
1058         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1059                 uart_write_wakeup(port);
1060
1061         if (!uart_circ_empty(xmit)) {
1062                 schedule_work(&s->work_tx);
1063         } else if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1064                 u16 ctrl = sci_in(port, SCSCR);
1065                 sci_out(port, SCSCR, ctrl & ~SCSCR_TIE);
1066         }
1067
1068         spin_unlock_irqrestore(&port->lock, flags);
1069 }
1070
1071 /* Locking: called with port lock held */
1072 static int sci_dma_rx_push(struct sci_port *s, struct tty_struct *tty,
1073                            size_t count)
1074 {
1075         struct uart_port *port = &s->port;
1076         int i, active, room;
1077
1078         room = tty_buffer_request_room(tty, count);
1079
1080         if (s->active_rx == s->cookie_rx[0]) {
1081                 active = 0;
1082         } else if (s->active_rx == s->cookie_rx[1]) {
1083                 active = 1;
1084         } else {
1085                 dev_err(port->dev, "cookie %d not found!\n", s->active_rx);
1086                 return 0;
1087         }
1088
1089         if (room < count)
1090                 dev_warn(port->dev, "Rx overrun: dropping %u bytes\n",
1091                          count - room);
1092         if (!room)
1093                 return room;
1094
1095         for (i = 0; i < room; i++)
1096                 tty_insert_flip_char(tty, ((u8 *)sg_virt(&s->sg_rx[active]))[i],
1097                                      TTY_NORMAL);
1098
1099         port->icount.rx += room;
1100
1101         return room;
1102 }
1103
1104 static void sci_dma_rx_complete(void *arg)
1105 {
1106         struct sci_port *s = arg;
1107         struct uart_port *port = &s->port;
1108         struct tty_struct *tty = port->state->port.tty;
1109         unsigned long flags;
1110         int count;
1111
1112         dev_dbg(port->dev, "%s(%d) active #%d\n", __func__, port->line, s->active_rx);
1113
1114         spin_lock_irqsave(&port->lock, flags);
1115
1116         count = sci_dma_rx_push(s, tty, s->buf_len_rx);
1117
1118         mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1119
1120         spin_unlock_irqrestore(&port->lock, flags);
1121
1122         if (count)
1123                 tty_flip_buffer_push(tty);
1124
1125         schedule_work(&s->work_rx);
1126 }
1127
1128 static void sci_rx_dma_release(struct sci_port *s, bool enable_pio)
1129 {
1130         struct dma_chan *chan = s->chan_rx;
1131         struct uart_port *port = &s->port;
1132
1133         s->chan_rx = NULL;
1134         s->cookie_rx[0] = s->cookie_rx[1] = -EINVAL;
1135         dma_release_channel(chan);
1136         if (sg_dma_address(&s->sg_rx[0]))
1137                 dma_free_coherent(port->dev, s->buf_len_rx * 2,
1138                                   sg_virt(&s->sg_rx[0]), sg_dma_address(&s->sg_rx[0]));
1139         if (enable_pio)
1140                 sci_start_rx(port);
1141 }
1142
1143 static void sci_tx_dma_release(struct sci_port *s, bool enable_pio)
1144 {
1145         struct dma_chan *chan = s->chan_tx;
1146         struct uart_port *port = &s->port;
1147
1148         s->chan_tx = NULL;
1149         s->cookie_tx = -EINVAL;
1150         dma_release_channel(chan);
1151         if (enable_pio)
1152                 sci_start_tx(port);
1153 }
1154
1155 static void sci_submit_rx(struct sci_port *s)
1156 {
1157         struct dma_chan *chan = s->chan_rx;
1158         int i;
1159
1160         for (i = 0; i < 2; i++) {
1161                 struct scatterlist *sg = &s->sg_rx[i];
1162                 struct dma_async_tx_descriptor *desc;
1163
1164                 desc = chan->device->device_prep_slave_sg(chan,
1165                         sg, 1, DMA_FROM_DEVICE, DMA_PREP_INTERRUPT);
1166
1167                 if (desc) {
1168                         s->desc_rx[i] = desc;
1169                         desc->callback = sci_dma_rx_complete;
1170                         desc->callback_param = s;
1171                         s->cookie_rx[i] = desc->tx_submit(desc);
1172                 }
1173
1174                 if (!desc || s->cookie_rx[i] < 0) {
1175                         if (i) {
1176                                 async_tx_ack(s->desc_rx[0]);
1177                                 s->cookie_rx[0] = -EINVAL;
1178                         }
1179                         if (desc) {
1180                                 async_tx_ack(desc);
1181                                 s->cookie_rx[i] = -EINVAL;
1182                         }
1183                         dev_warn(s->port.dev,
1184                                  "failed to re-start DMA, using PIO\n");
1185                         sci_rx_dma_release(s, true);
1186                         return;
1187                 }
1188                 dev_dbg(s->port.dev, "%s(): cookie %d to #%d\n", __func__,
1189                         s->cookie_rx[i], i);
1190         }
1191
1192         s->active_rx = s->cookie_rx[0];
1193
1194         dma_async_issue_pending(chan);
1195 }
1196
1197 static void work_fn_rx(struct work_struct *work)
1198 {
1199         struct sci_port *s = container_of(work, struct sci_port, work_rx);
1200         struct uart_port *port = &s->port;
1201         struct dma_async_tx_descriptor *desc;
1202         int new;
1203
1204         if (s->active_rx == s->cookie_rx[0]) {
1205                 new = 0;
1206         } else if (s->active_rx == s->cookie_rx[1]) {
1207                 new = 1;
1208         } else {
1209                 dev_err(port->dev, "cookie %d not found!\n", s->active_rx);
1210                 return;
1211         }
1212         desc = s->desc_rx[new];
1213
1214         if (dma_async_is_tx_complete(s->chan_rx, s->active_rx, NULL, NULL) !=
1215             DMA_SUCCESS) {
1216                 /* Handle incomplete DMA receive */
1217                 struct tty_struct *tty = port->state->port.tty;
1218                 struct dma_chan *chan = s->chan_rx;
1219                 struct sh_desc *sh_desc = container_of(desc, struct sh_desc,
1220                                                        async_tx);
1221                 unsigned long flags;
1222                 int count;
1223
1224                 chan->device->device_control(chan, DMA_TERMINATE_ALL, 0);
1225                 dev_dbg(port->dev, "Read %u bytes with cookie %d\n",
1226                         sh_desc->partial, sh_desc->cookie);
1227
1228                 spin_lock_irqsave(&port->lock, flags);
1229                 count = sci_dma_rx_push(s, tty, sh_desc->partial);
1230                 spin_unlock_irqrestore(&port->lock, flags);
1231
1232                 if (count)
1233                         tty_flip_buffer_push(tty);
1234
1235                 sci_submit_rx(s);
1236
1237                 return;
1238         }
1239
1240         s->cookie_rx[new] = desc->tx_submit(desc);
1241         if (s->cookie_rx[new] < 0) {
1242                 dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1243                 sci_rx_dma_release(s, true);
1244                 return;
1245         }
1246
1247         s->active_rx = s->cookie_rx[!new];
1248
1249         dev_dbg(port->dev, "%s: cookie %d #%d, new active #%d\n", __func__,
1250                 s->cookie_rx[new], new, s->active_rx);
1251 }
1252
1253 static void work_fn_tx(struct work_struct *work)
1254 {
1255         struct sci_port *s = container_of(work, struct sci_port, work_tx);
1256         struct dma_async_tx_descriptor *desc;
1257         struct dma_chan *chan = s->chan_tx;
1258         struct uart_port *port = &s->port;
1259         struct circ_buf *xmit = &port->state->xmit;
1260         struct scatterlist *sg = &s->sg_tx;
1261
1262         /*
1263          * DMA is idle now.
1264          * Port xmit buffer is already mapped, and it is one page... Just adjust
1265          * offsets and lengths. Since it is a circular buffer, we have to
1266          * transmit till the end, and then the rest. Take the port lock to get a
1267          * consistent xmit buffer state.
1268          */
1269         spin_lock_irq(&port->lock);
1270         sg->offset = xmit->tail & (UART_XMIT_SIZE - 1);
1271         sg_dma_address(sg) = (sg_dma_address(sg) & ~(UART_XMIT_SIZE - 1)) +
1272                 sg->offset;
1273         sg_dma_len(sg) = min((int)CIRC_CNT(xmit->head, xmit->tail, UART_XMIT_SIZE),
1274                 CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE));
1275         spin_unlock_irq(&port->lock);
1276
1277         BUG_ON(!sg_dma_len(sg));
1278
1279         desc = chan->device->device_prep_slave_sg(chan,
1280                         sg, s->sg_len_tx, DMA_TO_DEVICE,
1281                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1282         if (!desc) {
1283                 /* switch to PIO */
1284                 sci_tx_dma_release(s, true);
1285                 return;
1286         }
1287
1288         dma_sync_sg_for_device(port->dev, sg, 1, DMA_TO_DEVICE);
1289
1290         spin_lock_irq(&port->lock);
1291         s->desc_tx = desc;
1292         desc->callback = sci_dma_tx_complete;
1293         desc->callback_param = s;
1294         spin_unlock_irq(&port->lock);
1295         s->cookie_tx = desc->tx_submit(desc);
1296         if (s->cookie_tx < 0) {
1297                 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1298                 /* switch to PIO */
1299                 sci_tx_dma_release(s, true);
1300                 return;
1301         }
1302
1303         dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n", __func__,
1304                 xmit->buf, xmit->tail, xmit->head, s->cookie_tx);
1305
1306         dma_async_issue_pending(chan);
1307 }
1308 #endif
1309
1310 static void sci_start_tx(struct uart_port *port)
1311 {
1312         struct sci_port *s = to_sci_port(port);
1313         unsigned short ctrl;
1314
1315 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1316         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1317                 u16 new, scr = sci_in(port, SCSCR);
1318                 if (s->chan_tx)
1319                         new = scr | 0x8000;
1320                 else
1321                         new = scr & ~0x8000;
1322                 if (new != scr)
1323                         sci_out(port, SCSCR, new);
1324         }
1325
1326         if (s->chan_tx && !uart_circ_empty(&s->port.state->xmit) &&
1327             s->cookie_tx < 0)
1328                 schedule_work(&s->work_tx);
1329 #endif
1330
1331         if (!s->chan_tx || port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1332                 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
1333                 ctrl = sci_in(port, SCSCR);
1334                 sci_out(port, SCSCR, ctrl | SCSCR_TIE);
1335         }
1336 }
1337
1338 static void sci_stop_tx(struct uart_port *port)
1339 {
1340         unsigned short ctrl;
1341
1342         /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
1343         ctrl = sci_in(port, SCSCR);
1344
1345         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1346                 ctrl &= ~0x8000;
1347
1348         ctrl &= ~SCSCR_TIE;
1349
1350         sci_out(port, SCSCR, ctrl);
1351 }
1352
1353 static void sci_start_rx(struct uart_port *port)
1354 {
1355         unsigned short ctrl;
1356
1357         ctrl = sci_in(port, SCSCR) | port_rx_irq_mask(port);
1358
1359         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1360                 ctrl &= ~0x4000;
1361
1362         sci_out(port, SCSCR, ctrl);
1363 }
1364
1365 static void sci_stop_rx(struct uart_port *port)
1366 {
1367         unsigned short ctrl;
1368
1369         ctrl = sci_in(port, SCSCR);
1370
1371         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1372                 ctrl &= ~0x4000;
1373
1374         ctrl &= ~port_rx_irq_mask(port);
1375
1376         sci_out(port, SCSCR, ctrl);
1377 }
1378
1379 static void sci_enable_ms(struct uart_port *port)
1380 {
1381         /* Nothing here yet .. */
1382 }
1383
1384 static void sci_break_ctl(struct uart_port *port, int break_state)
1385 {
1386         /* Nothing here yet .. */
1387 }
1388
1389 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1390 static bool filter(struct dma_chan *chan, void *slave)
1391 {
1392         struct sh_dmae_slave *param = slave;
1393
1394         dev_dbg(chan->device->dev, "%s: slave ID %d\n", __func__,
1395                 param->slave_id);
1396
1397         if (param->dma_dev == chan->device->dev) {
1398                 chan->private = param;
1399                 return true;
1400         } else {
1401                 return false;
1402         }
1403 }
1404
1405 static void rx_timer_fn(unsigned long arg)
1406 {
1407         struct sci_port *s = (struct sci_port *)arg;
1408         struct uart_port *port = &s->port;
1409         u16 scr = sci_in(port, SCSCR);
1410
1411         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1412                 scr &= ~0x4000;
1413                 enable_irq(s->cfg->irqs[1]);
1414         }
1415         sci_out(port, SCSCR, scr | SCSCR_RIE);
1416         dev_dbg(port->dev, "DMA Rx timed out\n");
1417         schedule_work(&s->work_rx);
1418 }
1419
1420 static void sci_request_dma(struct uart_port *port)
1421 {
1422         struct sci_port *s = to_sci_port(port);
1423         struct sh_dmae_slave *param;
1424         struct dma_chan *chan;
1425         dma_cap_mask_t mask;
1426         int nent;
1427
1428         dev_dbg(port->dev, "%s: port %d DMA %p\n", __func__,
1429                 port->line, s->cfg->dma_dev);
1430
1431         if (!s->cfg->dma_dev)
1432                 return;
1433
1434         dma_cap_zero(mask);
1435         dma_cap_set(DMA_SLAVE, mask);
1436
1437         param = &s->param_tx;
1438
1439         /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_TX */
1440         param->slave_id = s->cfg->dma_slave_tx;
1441         param->dma_dev = s->cfg->dma_dev;
1442
1443         s->cookie_tx = -EINVAL;
1444         chan = dma_request_channel(mask, filter, param);
1445         dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1446         if (chan) {
1447                 s->chan_tx = chan;
1448                 sg_init_table(&s->sg_tx, 1);
1449                 /* UART circular tx buffer is an aligned page. */
1450                 BUG_ON((int)port->state->xmit.buf & ~PAGE_MASK);
1451                 sg_set_page(&s->sg_tx, virt_to_page(port->state->xmit.buf),
1452                             UART_XMIT_SIZE, (int)port->state->xmit.buf & ~PAGE_MASK);
1453                 nent = dma_map_sg(port->dev, &s->sg_tx, 1, DMA_TO_DEVICE);
1454                 if (!nent)
1455                         sci_tx_dma_release(s, false);
1456                 else
1457                         dev_dbg(port->dev, "%s: mapped %d@%p to %x\n", __func__,
1458                                 sg_dma_len(&s->sg_tx),
1459                                 port->state->xmit.buf, sg_dma_address(&s->sg_tx));
1460
1461                 s->sg_len_tx = nent;
1462
1463                 INIT_WORK(&s->work_tx, work_fn_tx);
1464         }
1465
1466         param = &s->param_rx;
1467
1468         /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_RX */
1469         param->slave_id = s->cfg->dma_slave_rx;
1470         param->dma_dev = s->cfg->dma_dev;
1471
1472         chan = dma_request_channel(mask, filter, param);
1473         dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1474         if (chan) {
1475                 dma_addr_t dma[2];
1476                 void *buf[2];
1477                 int i;
1478
1479                 s->chan_rx = chan;
1480
1481                 s->buf_len_rx = 2 * max(16, (int)port->fifosize);
1482                 buf[0] = dma_alloc_coherent(port->dev, s->buf_len_rx * 2,
1483                                             &dma[0], GFP_KERNEL);
1484
1485                 if (!buf[0]) {
1486                         dev_warn(port->dev,
1487                                  "failed to allocate dma buffer, using PIO\n");
1488                         sci_rx_dma_release(s, true);
1489                         return;
1490                 }
1491
1492                 buf[1] = buf[0] + s->buf_len_rx;
1493                 dma[1] = dma[0] + s->buf_len_rx;
1494
1495                 for (i = 0; i < 2; i++) {
1496                         struct scatterlist *sg = &s->sg_rx[i];
1497
1498                         sg_init_table(sg, 1);
1499                         sg_set_page(sg, virt_to_page(buf[i]), s->buf_len_rx,
1500                                     (int)buf[i] & ~PAGE_MASK);
1501                         sg_dma_address(sg) = dma[i];
1502                 }
1503
1504                 INIT_WORK(&s->work_rx, work_fn_rx);
1505                 setup_timer(&s->rx_timer, rx_timer_fn, (unsigned long)s);
1506
1507                 sci_submit_rx(s);
1508         }
1509 }
1510
1511 static void sci_free_dma(struct uart_port *port)
1512 {
1513         struct sci_port *s = to_sci_port(port);
1514
1515         if (!s->cfg->dma_dev)
1516                 return;
1517
1518         if (s->chan_tx)
1519                 sci_tx_dma_release(s, false);
1520         if (s->chan_rx)
1521                 sci_rx_dma_release(s, false);
1522 }
1523 #else
1524 static inline void sci_request_dma(struct uart_port *port)
1525 {
1526 }
1527
1528 static inline void sci_free_dma(struct uart_port *port)
1529 {
1530 }
1531 #endif
1532
1533 static int sci_startup(struct uart_port *port)
1534 {
1535         struct sci_port *s = to_sci_port(port);
1536         int ret;
1537
1538         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1539
1540         if (s->enable)
1541                 s->enable(port);
1542
1543         ret = sci_request_irq(s);
1544         if (unlikely(ret < 0))
1545                 return ret;
1546
1547         sci_request_dma(port);
1548
1549         sci_start_tx(port);
1550         sci_start_rx(port);
1551
1552         return 0;
1553 }
1554
1555 static void sci_shutdown(struct uart_port *port)
1556 {
1557         struct sci_port *s = to_sci_port(port);
1558
1559         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1560
1561         sci_stop_rx(port);
1562         sci_stop_tx(port);
1563
1564         sci_free_dma(port);
1565         sci_free_irq(s);
1566
1567         if (s->disable)
1568                 s->disable(port);
1569 }
1570
1571 static unsigned int sci_scbrr_calc(unsigned int algo_id, unsigned int bps,
1572                                    unsigned long freq)
1573 {
1574         switch (algo_id) {
1575         case SCBRR_ALGO_1:
1576                 return ((freq + 16 * bps) / (16 * bps) - 1);
1577         case SCBRR_ALGO_2:
1578                 return ((freq + 16 * bps) / (32 * bps) - 1);
1579         case SCBRR_ALGO_3:
1580                 return (((freq * 2) + 16 * bps) / (16 * bps) - 1);
1581         case SCBRR_ALGO_4:
1582                 return (((freq * 2) + 16 * bps) / (32 * bps) - 1);
1583         case SCBRR_ALGO_5:
1584                 return (((freq * 1000 / 32) / bps) - 1);
1585         }
1586
1587         /* Warn, but use a safe default */
1588         WARN_ON(1);
1589
1590         return ((freq + 16 * bps) / (32 * bps) - 1);
1591 }
1592
1593 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
1594                             struct ktermios *old)
1595 {
1596         struct sci_port *s = to_sci_port(port);
1597         unsigned int status, baud, smr_val, max_baud;
1598         int t = -1;
1599         u16 scfcr = 0;
1600
1601         /*
1602          * earlyprintk comes here early on with port->uartclk set to zero.
1603          * the clock framework is not up and running at this point so here
1604          * we assume that 115200 is the maximum baud rate. please note that
1605          * the baud rate is not programmed during earlyprintk - it is assumed
1606          * that the previous boot loader has enabled required clocks and
1607          * setup the baud rate generator hardware for us already.
1608          */
1609         max_baud = port->uartclk ? port->uartclk / 16 : 115200;
1610
1611         baud = uart_get_baud_rate(port, termios, old, 0, max_baud);
1612         if (likely(baud && port->uartclk))
1613                 t = sci_scbrr_calc(s->cfg->scbrr_algo_id, baud, port->uartclk);
1614
1615         if (s->enable)
1616                 s->enable(port);
1617
1618         do {
1619                 status = sci_in(port, SCxSR);
1620         } while (!(status & SCxSR_TEND(port)));
1621
1622         sci_out(port, SCSCR, 0x00);     /* TE=0, RE=0, CKE1=0 */
1623
1624         if (port->type != PORT_SCI)
1625                 sci_out(port, SCFCR, scfcr | SCFCR_RFRST | SCFCR_TFRST);
1626
1627         smr_val = sci_in(port, SCSMR) & 3;
1628
1629         if ((termios->c_cflag & CSIZE) == CS7)
1630                 smr_val |= 0x40;
1631         if (termios->c_cflag & PARENB)
1632                 smr_val |= 0x20;
1633         if (termios->c_cflag & PARODD)
1634                 smr_val |= 0x30;
1635         if (termios->c_cflag & CSTOPB)
1636                 smr_val |= 0x08;
1637
1638         uart_update_timeout(port, termios->c_cflag, baud);
1639
1640         sci_out(port, SCSMR, smr_val);
1641
1642         dev_dbg(port->dev, "%s: SMR %x, t %x, SCSCR %x\n", __func__, smr_val, t,
1643                 s->cfg->scscr);
1644
1645         if (t > 0) {
1646                 if (t >= 256) {
1647                         sci_out(port, SCSMR, (sci_in(port, SCSMR) & ~3) | 1);
1648                         t >>= 2;
1649                 } else
1650                         sci_out(port, SCSMR, sci_in(port, SCSMR) & ~3);
1651
1652                 sci_out(port, SCBRR, t);
1653                 udelay((1000000+(baud-1)) / baud); /* Wait one bit interval */
1654         }
1655
1656         sci_init_pins(port, termios->c_cflag);
1657         sci_out(port, SCFCR, scfcr | ((termios->c_cflag & CRTSCTS) ? SCFCR_MCE : 0));
1658
1659         sci_out(port, SCSCR, s->cfg->scscr);
1660
1661 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1662         /*
1663          * Calculate delay for 1.5 DMA buffers: see
1664          * drivers/serial/serial_core.c::uart_update_timeout(). With 10 bits
1665          * (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above function
1666          * calculates 1 jiffie for the data plus 5 jiffies for the "slop(e)."
1667          * Then below we calculate 3 jiffies (12ms) for 1.5 DMA buffers (3 FIFO
1668          * sizes), but it has been found out experimentally, that this is not
1669          * enough: the driver too often needlessly runs on a DMA timeout. 20ms
1670          * as a minimum seem to work perfectly.
1671          */
1672         if (s->chan_rx) {
1673                 s->rx_timeout = (port->timeout - HZ / 50) * s->buf_len_rx * 3 /
1674                         port->fifosize / 2;
1675                 dev_dbg(port->dev,
1676                         "DMA Rx t-out %ums, tty t-out %u jiffies\n",
1677                         s->rx_timeout * 1000 / HZ, port->timeout);
1678                 if (s->rx_timeout < msecs_to_jiffies(20))
1679                         s->rx_timeout = msecs_to_jiffies(20);
1680         }
1681 #endif
1682
1683         if ((termios->c_cflag & CREAD) != 0)
1684                 sci_start_rx(port);
1685
1686         if (s->disable)
1687                 s->disable(port);
1688 }
1689
1690 static const char *sci_type(struct uart_port *port)
1691 {
1692         switch (port->type) {
1693         case PORT_IRDA:
1694                 return "irda";
1695         case PORT_SCI:
1696                 return "sci";
1697         case PORT_SCIF:
1698                 return "scif";
1699         case PORT_SCIFA:
1700                 return "scifa";
1701         case PORT_SCIFB:
1702                 return "scifb";
1703         }
1704
1705         return NULL;
1706 }
1707
1708 static inline unsigned long sci_port_size(struct uart_port *port)
1709 {
1710         /*
1711          * Pick an arbitrary size that encapsulates all of the base
1712          * registers by default. This can be optimized later, or derived
1713          * from platform resource data at such a time that ports begin to
1714          * behave more erratically.
1715          */
1716         return 64;
1717 }
1718
1719 static int sci_remap_port(struct uart_port *port)
1720 {
1721         unsigned long size = sci_port_size(port);
1722
1723         /*
1724          * Nothing to do if there's already an established membase.
1725          */
1726         if (port->membase)
1727                 return 0;
1728
1729         if (port->flags & UPF_IOREMAP) {
1730                 port->membase = ioremap_nocache(port->mapbase, size);
1731                 if (unlikely(!port->membase)) {
1732                         dev_err(port->dev, "can't remap port#%d\n", port->line);
1733                         return -ENXIO;
1734                 }
1735         } else {
1736                 /*
1737                  * For the simple (and majority of) cases where we don't
1738                  * need to do any remapping, just cast the cookie
1739                  * directly.
1740                  */
1741                 port->membase = (void __iomem *)port->mapbase;
1742         }
1743
1744         return 0;
1745 }
1746
1747 static void sci_release_port(struct uart_port *port)
1748 {
1749         if (port->flags & UPF_IOREMAP) {
1750                 iounmap(port->membase);
1751                 port->membase = NULL;
1752         }
1753
1754         release_mem_region(port->mapbase, sci_port_size(port));
1755 }
1756
1757 static int sci_request_port(struct uart_port *port)
1758 {
1759         unsigned long size = sci_port_size(port);
1760         struct resource *res;
1761         int ret;
1762
1763         res = request_mem_region(port->mapbase, size, dev_name(port->dev));
1764         if (unlikely(res == NULL))
1765                 return -EBUSY;
1766
1767         ret = sci_remap_port(port);
1768         if (unlikely(ret != 0)) {
1769                 release_resource(res);
1770                 return ret;
1771         }
1772
1773         return 0;
1774 }
1775
1776 static void sci_config_port(struct uart_port *port, int flags)
1777 {
1778         if (flags & UART_CONFIG_TYPE) {
1779                 struct sci_port *sport = to_sci_port(port);
1780
1781                 port->type = sport->cfg->type;
1782                 sci_request_port(port);
1783         }
1784 }
1785
1786 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
1787 {
1788         struct sci_port *s = to_sci_port(port);
1789
1790         if (ser->irq != s->cfg->irqs[SCIx_TXI_IRQ] || ser->irq > nr_irqs)
1791                 return -EINVAL;
1792         if (ser->baud_base < 2400)
1793                 /* No paper tape reader for Mitch.. */
1794                 return -EINVAL;
1795
1796         return 0;
1797 }
1798
1799 static struct uart_ops sci_uart_ops = {
1800         .tx_empty       = sci_tx_empty,
1801         .set_mctrl      = sci_set_mctrl,
1802         .get_mctrl      = sci_get_mctrl,
1803         .start_tx       = sci_start_tx,
1804         .stop_tx        = sci_stop_tx,
1805         .stop_rx        = sci_stop_rx,
1806         .enable_ms      = sci_enable_ms,
1807         .break_ctl      = sci_break_ctl,
1808         .startup        = sci_startup,
1809         .shutdown       = sci_shutdown,
1810         .set_termios    = sci_set_termios,
1811         .type           = sci_type,
1812         .release_port   = sci_release_port,
1813         .request_port   = sci_request_port,
1814         .config_port    = sci_config_port,
1815         .verify_port    = sci_verify_port,
1816 #ifdef CONFIG_CONSOLE_POLL
1817         .poll_get_char  = sci_poll_get_char,
1818         .poll_put_char  = sci_poll_put_char,
1819 #endif
1820 };
1821
1822 static int __devinit sci_init_single(struct platform_device *dev,
1823                                      struct sci_port *sci_port,
1824                                      unsigned int index,
1825                                      struct plat_sci_port *p)
1826 {
1827         struct uart_port *port = &sci_port->port;
1828         int ret;
1829
1830         port->ops       = &sci_uart_ops;
1831         port->iotype    = UPIO_MEM;
1832         port->line      = index;
1833
1834         switch (p->type) {
1835         case PORT_SCIFB:
1836                 port->fifosize = 256;
1837                 break;
1838         case PORT_SCIFA:
1839                 port->fifosize = 64;
1840                 break;
1841         case PORT_SCIF:
1842                 port->fifosize = 16;
1843                 break;
1844         default:
1845                 port->fifosize = 1;
1846                 break;
1847         }
1848
1849         if (p->regtype == SCIx_PROBE_REGTYPE) {
1850                 ret = sci_probe_regmap(p);
1851                 if (unlikely(!ret))
1852                         return ret;
1853         }
1854
1855         if (dev) {
1856                 sci_port->iclk = clk_get(&dev->dev, "sci_ick");
1857                 if (IS_ERR(sci_port->iclk)) {
1858                         sci_port->iclk = clk_get(&dev->dev, "peripheral_clk");
1859                         if (IS_ERR(sci_port->iclk)) {
1860                                 dev_err(&dev->dev, "can't get iclk\n");
1861                                 return PTR_ERR(sci_port->iclk);
1862                         }
1863                 }
1864
1865                 /*
1866                  * The function clock is optional, ignore it if we can't
1867                  * find it.
1868                  */
1869                 sci_port->fclk = clk_get(&dev->dev, "sci_fck");
1870                 if (IS_ERR(sci_port->fclk))
1871                         sci_port->fclk = NULL;
1872
1873                 sci_port->enable = sci_clk_enable;
1874                 sci_port->disable = sci_clk_disable;
1875                 port->dev = &dev->dev;
1876
1877                 pm_runtime_enable(&dev->dev);
1878         }
1879
1880         sci_port->break_timer.data = (unsigned long)sci_port;
1881         sci_port->break_timer.function = sci_break_timer;
1882         init_timer(&sci_port->break_timer);
1883
1884         /*
1885          * Establish some sensible defaults for the error detection.
1886          */
1887         if (!p->error_mask)
1888                 p->error_mask = (p->type == PORT_SCI) ?
1889                         SCI_DEFAULT_ERROR_MASK : SCIF_DEFAULT_ERROR_MASK;
1890
1891         /*
1892          * Establish sensible defaults for the overrun detection, unless
1893          * the part has explicitly disabled support for it.
1894          */
1895         if (p->overrun_bit != SCIx_NOT_SUPPORTED) {
1896                 if (p->type == PORT_SCI)
1897                         p->overrun_bit = 5;
1898                 else if (p->scbrr_algo_id == SCBRR_ALGO_4)
1899                         p->overrun_bit = 9;
1900                 else
1901                         p->overrun_bit = 0;
1902
1903                 /*
1904                  * Make the error mask inclusive of overrun detection, if
1905                  * supported.
1906                  */
1907                 p->error_mask |= (1 << p->overrun_bit);
1908         }
1909
1910         sci_port->cfg           = p;
1911
1912         port->mapbase           = p->mapbase;
1913         port->type              = p->type;
1914         port->flags             = p->flags;
1915         port->regshift          = p->regshift;
1916
1917         /*
1918          * The UART port needs an IRQ value, so we peg this to the RX IRQ
1919          * for the multi-IRQ ports, which is where we are primarily
1920          * concerned with the shutdown path synchronization.
1921          *
1922          * For the muxed case there's nothing more to do.
1923          */
1924         port->irq               = p->irqs[SCIx_RXI_IRQ];
1925
1926         port->serial_in         = sci_serial_in;
1927         port->serial_out        = sci_serial_out;
1928
1929         if (p->dma_dev)
1930                 dev_dbg(port->dev, "DMA device %p, tx %d, rx %d\n",
1931                         p->dma_dev, p->dma_slave_tx, p->dma_slave_rx);
1932
1933         return 0;
1934 }
1935
1936 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
1937 static void serial_console_putchar(struct uart_port *port, int ch)
1938 {
1939         sci_poll_put_char(port, ch);
1940 }
1941
1942 /*
1943  *      Print a string to the serial port trying not to disturb
1944  *      any possible real use of the port...
1945  */
1946 static void serial_console_write(struct console *co, const char *s,
1947                                  unsigned count)
1948 {
1949         struct sci_port *sci_port = &sci_ports[co->index];
1950         struct uart_port *port = &sci_port->port;
1951         unsigned short bits;
1952
1953         if (sci_port->enable)
1954                 sci_port->enable(port);
1955
1956         uart_console_write(port, s, count, serial_console_putchar);
1957
1958         /* wait until fifo is empty and last bit has been transmitted */
1959         bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
1960         while ((sci_in(port, SCxSR) & bits) != bits)
1961                 cpu_relax();
1962
1963         if (sci_port->disable)
1964                 sci_port->disable(port);
1965 }
1966
1967 static int __devinit serial_console_setup(struct console *co, char *options)
1968 {
1969         struct sci_port *sci_port;
1970         struct uart_port *port;
1971         int baud = 115200;
1972         int bits = 8;
1973         int parity = 'n';
1974         int flow = 'n';
1975         int ret;
1976
1977         /*
1978          * Refuse to handle any bogus ports.
1979          */
1980         if (co->index < 0 || co->index >= SCI_NPORTS)
1981                 return -ENODEV;
1982
1983         sci_port = &sci_ports[co->index];
1984         port = &sci_port->port;
1985
1986         /*
1987          * Refuse to handle uninitialized ports.
1988          */
1989         if (!port->ops)
1990                 return -ENODEV;
1991
1992         ret = sci_remap_port(port);
1993         if (unlikely(ret != 0))
1994                 return ret;
1995
1996         if (sci_port->enable)
1997                 sci_port->enable(port);
1998
1999         if (options)
2000                 uart_parse_options(options, &baud, &parity, &bits, &flow);
2001
2002         /* TODO: disable clock */
2003         return uart_set_options(port, co, baud, parity, bits, flow);
2004 }
2005
2006 static struct console serial_console = {
2007         .name           = "ttySC",
2008         .device         = uart_console_device,
2009         .write          = serial_console_write,
2010         .setup          = serial_console_setup,
2011         .flags          = CON_PRINTBUFFER,
2012         .index          = -1,
2013         .data           = &sci_uart_driver,
2014 };
2015
2016 static struct console early_serial_console = {
2017         .name           = "early_ttySC",
2018         .write          = serial_console_write,
2019         .flags          = CON_PRINTBUFFER,
2020         .index          = -1,
2021 };
2022
2023 static char early_serial_buf[32];
2024
2025 static int __devinit sci_probe_earlyprintk(struct platform_device *pdev)
2026 {
2027         struct plat_sci_port *cfg = pdev->dev.platform_data;
2028
2029         if (early_serial_console.data)
2030                 return -EEXIST;
2031
2032         early_serial_console.index = pdev->id;
2033
2034         sci_init_single(NULL, &sci_ports[pdev->id], pdev->id, cfg);
2035
2036         serial_console_setup(&early_serial_console, early_serial_buf);
2037
2038         if (!strstr(early_serial_buf, "keep"))
2039                 early_serial_console.flags |= CON_BOOT;
2040
2041         register_console(&early_serial_console);
2042         return 0;
2043 }
2044
2045 #define SCI_CONSOLE     (&serial_console)
2046
2047 #else
2048 static inline int __devinit sci_probe_earlyprintk(struct platform_device *pdev)
2049 {
2050         return -EINVAL;
2051 }
2052
2053 #define SCI_CONSOLE     NULL
2054
2055 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
2056
2057 static char banner[] __initdata =
2058         KERN_INFO "SuperH SCI(F) driver initialized\n";
2059
2060 static struct uart_driver sci_uart_driver = {
2061         .owner          = THIS_MODULE,
2062         .driver_name    = "sci",
2063         .dev_name       = "ttySC",
2064         .major          = SCI_MAJOR,
2065         .minor          = SCI_MINOR_START,
2066         .nr             = SCI_NPORTS,
2067         .cons           = SCI_CONSOLE,
2068 };
2069
2070 static int sci_remove(struct platform_device *dev)
2071 {
2072         struct sci_port *port = platform_get_drvdata(dev);
2073
2074         cpufreq_unregister_notifier(&port->freq_transition,
2075                                     CPUFREQ_TRANSITION_NOTIFIER);
2076
2077         uart_remove_one_port(&sci_uart_driver, &port->port);
2078
2079         clk_put(port->iclk);
2080         clk_put(port->fclk);
2081
2082         pm_runtime_disable(&dev->dev);
2083         return 0;
2084 }
2085
2086 static int __devinit sci_probe_single(struct platform_device *dev,
2087                                       unsigned int index,
2088                                       struct plat_sci_port *p,
2089                                       struct sci_port *sciport)
2090 {
2091         int ret;
2092
2093         /* Sanity check */
2094         if (unlikely(index >= SCI_NPORTS)) {
2095                 dev_notice(&dev->dev, "Attempting to register port "
2096                            "%d when only %d are available.\n",
2097                            index+1, SCI_NPORTS);
2098                 dev_notice(&dev->dev, "Consider bumping "
2099                            "CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
2100                 return 0;
2101         }
2102
2103         ret = sci_init_single(dev, sciport, index, p);
2104         if (ret)
2105                 return ret;
2106
2107         return uart_add_one_port(&sci_uart_driver, &sciport->port);
2108 }
2109
2110 static int __devinit sci_probe(struct platform_device *dev)
2111 {
2112         struct plat_sci_port *p = dev->dev.platform_data;
2113         struct sci_port *sp = &sci_ports[dev->id];
2114         int ret;
2115
2116         /*
2117          * If we've come here via earlyprintk initialization, head off to
2118          * the special early probe. We don't have sufficient device state
2119          * to make it beyond this yet.
2120          */
2121         if (is_early_platform_device(dev))
2122                 return sci_probe_earlyprintk(dev);
2123
2124         platform_set_drvdata(dev, sp);
2125
2126         ret = sci_probe_single(dev, dev->id, p, sp);
2127         if (ret)
2128                 goto err_unreg;
2129
2130         sp->freq_transition.notifier_call = sci_notifier;
2131
2132         ret = cpufreq_register_notifier(&sp->freq_transition,
2133                                         CPUFREQ_TRANSITION_NOTIFIER);
2134         if (unlikely(ret < 0))
2135                 goto err_unreg;
2136
2137 #ifdef CONFIG_SH_STANDARD_BIOS
2138         sh_bios_gdb_detach();
2139 #endif
2140
2141         return 0;
2142
2143 err_unreg:
2144         sci_remove(dev);
2145         return ret;
2146 }
2147
2148 static int sci_suspend(struct device *dev)
2149 {
2150         struct sci_port *sport = dev_get_drvdata(dev);
2151
2152         if (sport)
2153                 uart_suspend_port(&sci_uart_driver, &sport->port);
2154
2155         return 0;
2156 }
2157
2158 static int sci_resume(struct device *dev)
2159 {
2160         struct sci_port *sport = dev_get_drvdata(dev);
2161
2162         if (sport)
2163                 uart_resume_port(&sci_uart_driver, &sport->port);
2164
2165         return 0;
2166 }
2167
2168 static const struct dev_pm_ops sci_dev_pm_ops = {
2169         .suspend        = sci_suspend,
2170         .resume         = sci_resume,
2171 };
2172
2173 static struct platform_driver sci_driver = {
2174         .probe          = sci_probe,
2175         .remove         = sci_remove,
2176         .driver         = {
2177                 .name   = "sh-sci",
2178                 .owner  = THIS_MODULE,
2179                 .pm     = &sci_dev_pm_ops,
2180         },
2181 };
2182
2183 static int __init sci_init(void)
2184 {
2185         int ret;
2186
2187         printk(banner);
2188
2189         ret = uart_register_driver(&sci_uart_driver);
2190         if (likely(ret == 0)) {
2191                 ret = platform_driver_register(&sci_driver);
2192                 if (unlikely(ret))
2193                         uart_unregister_driver(&sci_uart_driver);
2194         }
2195
2196         return ret;
2197 }
2198
2199 static void __exit sci_exit(void)
2200 {
2201         platform_driver_unregister(&sci_driver);
2202         uart_unregister_driver(&sci_uart_driver);
2203 }
2204
2205 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
2206 early_platform_init_buffer("earlyprintk", &sci_driver,
2207                            early_serial_buf, ARRAY_SIZE(early_serial_buf));
2208 #endif
2209 module_init(sci_init);
2210 module_exit(sci_exit);
2211
2212 MODULE_LICENSE("GPL");
2213 MODULE_ALIAS("platform:sh-sci");