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