drivers/tty/serial/sh-sci.c

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