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