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