drivers/tty/serial/sh-sci.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * SuperH on-chip serial module support.  (SCI with no FIFO / with FIFO)
   4  *
   5  *  Copyright (C) 2002 - 2011  Paul Mundt
   6  *  Copyright (C) 2015 Glider bvba
   7  *  Modified to support SH7720 SCIF. Markus Brunner, Mark Jonas (Jul 2007).
   8  *
   9  * based off of the old drivers/char/sh-sci.c by:
  10  *
  11  *   Copyright (C) 1999, 2000  Niibe Yutaka
  12  *   Copyright (C) 2000  Sugioka Toshinobu
  13  *   Modified to support multiple serial ports. Stuart Menefy (May 2000).
  14  *   Modified to support SecureEdge. David McCullough (2002)
  15  *   Modified to support SH7300 SCIF. Takashi Kusuda (Jun 2003).
  16  *   Removed SH7300 support (Jul 2007).
  17  */
  18 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
  19 #define SUPPORT_SYSRQ
  20 #endif
  21
  22 #undef DEBUG
  23
  24 #include <linux/clk.h>
  25 #include <linux/console.h>
  26 #include <linux/ctype.h>
  27 #include <linux/cpufreq.h>
  28 #include <linux/delay.h>
  29 #include <linux/dmaengine.h>
  30 #include <linux/dma-mapping.h>
  31 #include <linux/err.h>
  32 #include <linux/errno.h>
  33 #include <linux/init.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/ioport.h>
  36 #include <linux/ktime.h>
  37 #include <linux/major.h>
  38 #include <linux/module.h>
  39 #include <linux/mm.h>
  40 #include <linux/of.h>
  41 #include <linux/of_device.h>
  42 #include <linux/platform_device.h>
  43 #include <linux/pm_runtime.h>
  44 #include <linux/scatterlist.h>
  45 #include <linux/serial.h>
  46 #include <linux/serial_sci.h>
  47 #include <linux/sh_dma.h>
  48 #include <linux/slab.h>
  49 #include <linux/string.h>
  50 #include <linux/sysrq.h>
  51 #include <linux/timer.h>
  52 #include <linux/tty.h>
  53 #include <linux/tty_flip.h>
  54
  55 #ifdef CONFIG_SUPERH
  56 #include <asm/sh_bios.h>
  57 #endif
  58
  59 #include "serial_mctrl_gpio.h"
  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 enum SCI_CLKS {
  80         SCI_FCK,                /* Functional Clock */
  81         SCI_SCK,                /* Optional External Clock */
  82         SCI_BRG_INT,            /* Optional BRG Internal Clock Source */
  83         SCI_SCIF_CLK,           /* Optional BRG External Clock Source */
  84         SCI_NUM_CLKS
  85 };
  86
  87 /* Bit x set means sampling rate x + 1 is supported */
  88 #define SCI_SR(x)               BIT((x) - 1)
  89 #define SCI_SR_RANGE(x, y)      GENMASK((y) - 1, (x) - 1)
  90
  91 #define SCI_SR_SCIFAB           SCI_SR(5) | SCI_SR(7) | SCI_SR(11) | \
  92                                 SCI_SR(13) | SCI_SR(16) | SCI_SR(17) | \
  93                                 SCI_SR(19) | SCI_SR(27)
  94
  95 #define min_sr(_port)           ffs((_port)->sampling_rate_mask)
  96 #define max_sr(_port)           fls((_port)->sampling_rate_mask)
  97
  98 /* Iterate over all supported sampling rates, from high to low */
  99 #define for_each_sr(_sr, _port)                                         \
 100         for ((_sr) = max_sr(_port); (_sr) >= min_sr(_port); (_sr)--)    \
 101                 if ((_port)->sampling_rate_mask & SCI_SR((_sr)))
 102
 103 struct plat_sci_reg {
 104         u8 offset, size;
 105 };
 106
 107 struct sci_port_params {
 108         const struct plat_sci_reg regs[SCIx_NR_REGS];
 109         unsigned int fifosize;
 110         unsigned int overrun_reg;
 111         unsigned int overrun_mask;
 112         unsigned int sampling_rate_mask;
 113         unsigned int error_mask;
 114         unsigned int error_clear;
 115 };
 116
 117 struct sci_port {
 118         struct uart_port        port;
 119
 120         /* Platform configuration */
 121         const struct sci_port_params *params;
 122         const struct plat_sci_port *cfg;
 123         unsigned int            sampling_rate_mask;
 124         resource_size_t         reg_size;
 125         struct mctrl_gpios      *gpios;
 126
 127         /* Clocks */
 128         struct clk              *clks[SCI_NUM_CLKS];
 129         unsigned long           clk_rates[SCI_NUM_CLKS];
 130
 131         int                     irqs[SCIx_NR_IRQS];
 132         char                    *irqstr[SCIx_NR_IRQS];
 133
 134         struct dma_chan                 *chan_tx;
 135         struct dma_chan                 *chan_rx;
 136
 137 #ifdef CONFIG_SERIAL_SH_SCI_DMA
 138         struct dma_chan                 *chan_tx_saved;
 139         struct dma_chan                 *chan_rx_saved;
 140         dma_cookie_t                    cookie_tx;
 141         dma_cookie_t                    cookie_rx[2];
 142         dma_cookie_t                    active_rx;
 143         dma_addr_t                      tx_dma_addr;
 144         unsigned int                    tx_dma_len;
 145         struct scatterlist              sg_rx[2];
 146         void                            *rx_buf[2];
 147         size_t                          buf_len_rx;
 148         struct work_struct              work_tx;
 149         struct hrtimer                  rx_timer;
 150         unsigned int                    rx_timeout;     /* microseconds */
 151 #endif
 152         unsigned int                    rx_frame;
 153         int                             rx_trigger;
 154         struct timer_list               rx_fifo_timer;
 155         int                             rx_fifo_timeout;
 156         u16                             hscif_tot;
 157
 158         bool has_rtscts;
 159         bool autorts;
 160 };
 161
 162 #define SCI_NPORTS CONFIG_SERIAL_SH_SCI_NR_UARTS
 163
 164 static struct sci_port sci_ports[SCI_NPORTS];
 165 static unsigned long sci_ports_in_use;
 166 static struct uart_driver sci_uart_driver;
 167
 168 static inline struct sci_port *
 169 to_sci_port(struct uart_port *uart)
 170 {
 171         return container_of(uart, struct sci_port, port);
 172 }
 173
 174 static const struct sci_port_params sci_port_params[SCIx_NR_REGTYPES] = {
 175         /*
 176          * Common SCI definitions, dependent on the port's regshift
 177          * value.
 178          */
 179         [SCIx_SCI_REGTYPE] = {
 180                 .regs = {
 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                 },
 188                 .fifosize = 1,
 189                 .overrun_reg = SCxSR,
 190                 .overrun_mask = SCI_ORER,
 191                 .sampling_rate_mask = SCI_SR(32),
 192                 .error_mask = SCI_DEFAULT_ERROR_MASK | SCI_ORER,
 193                 .error_clear = SCI_ERROR_CLEAR & ~SCI_ORER,
 194         },
 195
 196         /*
 197          * Common definitions for legacy IrDA ports.
 198          */
 199         [SCIx_IRDA_REGTYPE] = {
 200                 .regs = {
 201                         [SCSMR]         = { 0x00,  8 },
 202                         [SCBRR]         = { 0x02,  8 },
 203                         [SCSCR]         = { 0x04,  8 },
 204                         [SCxTDR]        = { 0x06,  8 },
 205                         [SCxSR]         = { 0x08, 16 },
 206                         [SCxRDR]        = { 0x0a,  8 },
 207                         [SCFCR]         = { 0x0c,  8 },
 208                         [SCFDR]         = { 0x0e, 16 },
 209                 },
 210                 .fifosize = 1,
 211                 .overrun_reg = SCxSR,
 212                 .overrun_mask = SCI_ORER,
 213                 .sampling_rate_mask = SCI_SR(32),
 214                 .error_mask = SCI_DEFAULT_ERROR_MASK | SCI_ORER,
 215                 .error_clear = SCI_ERROR_CLEAR & ~SCI_ORER,
 216         },
 217
 218         /*
 219          * Common SCIFA definitions.
 220          */
 221         [SCIx_SCIFA_REGTYPE] = {
 222                 .regs = {
 223                         [SCSMR]         = { 0x00, 16 },
 224                         [SCBRR]         = { 0x04,  8 },
 225                         [SCSCR]         = { 0x08, 16 },
 226                         [SCxTDR]        = { 0x20,  8 },
 227                         [SCxSR]         = { 0x14, 16 },
 228                         [SCxRDR]        = { 0x24,  8 },
 229                         [SCFCR]         = { 0x18, 16 },
 230                         [SCFDR]         = { 0x1c, 16 },
 231                         [SCPCR]         = { 0x30, 16 },
 232                         [SCPDR]         = { 0x34, 16 },
 233                 },
 234                 .fifosize = 64,
 235                 .overrun_reg = SCxSR,
 236                 .overrun_mask = SCIFA_ORER,
 237                 .sampling_rate_mask = SCI_SR_SCIFAB,
 238                 .error_mask = SCIF_DEFAULT_ERROR_MASK | SCIFA_ORER,
 239                 .error_clear = SCIF_ERROR_CLEAR & ~SCIFA_ORER,
 240         },
 241
 242         /*
 243          * Common SCIFB definitions.
 244          */
 245         [SCIx_SCIFB_REGTYPE] = {
 246                 .regs = {
 247                         [SCSMR]         = { 0x00, 16 },
 248                         [SCBRR]         = { 0x04,  8 },
 249                         [SCSCR]         = { 0x08, 16 },
 250                         [SCxTDR]        = { 0x40,  8 },
 251                         [SCxSR]         = { 0x14, 16 },
 252                         [SCxRDR]        = { 0x60,  8 },
 253                         [SCFCR]         = { 0x18, 16 },
 254                         [SCTFDR]        = { 0x38, 16 },
 255                         [SCRFDR]        = { 0x3c, 16 },
 256                         [SCPCR]         = { 0x30, 16 },
 257                         [SCPDR]         = { 0x34, 16 },
 258                 },
 259                 .fifosize = 256,
 260                 .overrun_reg = SCxSR,
 261                 .overrun_mask = SCIFA_ORER,
 262                 .sampling_rate_mask = SCI_SR_SCIFAB,
 263                 .error_mask = SCIF_DEFAULT_ERROR_MASK | SCIFA_ORER,
 264                 .error_clear = SCIF_ERROR_CLEAR & ~SCIFA_ORER,
 265         },
 266
 267         /*
 268          * Common SH-2(A) SCIF definitions for ports with FIFO data
 269          * count registers.
 270          */
 271         [SCIx_SH2_SCIF_FIFODATA_REGTYPE] = {
 272                 .regs = {
 273                         [SCSMR]         = { 0x00, 16 },
 274                         [SCBRR]         = { 0x04,  8 },
 275                         [SCSCR]         = { 0x08, 16 },
 276                         [SCxTDR]        = { 0x0c,  8 },
 277                         [SCxSR]         = { 0x10, 16 },
 278                         [SCxRDR]        = { 0x14,  8 },
 279                         [SCFCR]         = { 0x18, 16 },
 280                         [SCFDR]         = { 0x1c, 16 },
 281                         [SCSPTR]        = { 0x20, 16 },
 282                         [SCLSR]         = { 0x24, 16 },
 283                 },
 284                 .fifosize = 16,
 285                 .overrun_reg = SCLSR,
 286                 .overrun_mask = SCLSR_ORER,
 287                 .sampling_rate_mask = SCI_SR(32),
 288                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
 289                 .error_clear = SCIF_ERROR_CLEAR,
 290         },
 291
 292         /*
 293          * Common SH-3 SCIF definitions.
 294          */
 295         [SCIx_SH3_SCIF_REGTYPE] = {
 296                 .regs = {
 297                         [SCSMR]         = { 0x00,  8 },
 298                         [SCBRR]         = { 0x02,  8 },
 299                         [SCSCR]         = { 0x04,  8 },
 300                         [SCxTDR]        = { 0x06,  8 },
 301                         [SCxSR]         = { 0x08, 16 },
 302                         [SCxRDR]        = { 0x0a,  8 },
 303                         [SCFCR]         = { 0x0c,  8 },
 304                         [SCFDR]         = { 0x0e, 16 },
 305                 },
 306                 .fifosize = 16,
 307                 .overrun_reg = SCLSR,
 308                 .overrun_mask = SCLSR_ORER,
 309                 .sampling_rate_mask = SCI_SR(32),
 310                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
 311                 .error_clear = SCIF_ERROR_CLEAR,
 312         },
 313
 314         /*
 315          * Common SH-4(A) SCIF(B) definitions.
 316          */
 317         [SCIx_SH4_SCIF_REGTYPE] = {
 318                 .regs = {
 319                         [SCSMR]         = { 0x00, 16 },
 320                         [SCBRR]         = { 0x04,  8 },
 321                         [SCSCR]         = { 0x08, 16 },
 322                         [SCxTDR]        = { 0x0c,  8 },
 323                         [SCxSR]         = { 0x10, 16 },
 324                         [SCxRDR]        = { 0x14,  8 },
 325                         [SCFCR]         = { 0x18, 16 },
 326                         [SCFDR]         = { 0x1c, 16 },
 327                         [SCSPTR]        = { 0x20, 16 },
 328                         [SCLSR]         = { 0x24, 16 },
 329                 },
 330                 .fifosize = 16,
 331                 .overrun_reg = SCLSR,
 332                 .overrun_mask = SCLSR_ORER,
 333                 .sampling_rate_mask = SCI_SR(32),
 334                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
 335                 .error_clear = SCIF_ERROR_CLEAR,
 336         },
 337
 338         /*
 339          * Common SCIF definitions for ports with a Baud Rate Generator for
 340          * External Clock (BRG).
 341          */
 342         [SCIx_SH4_SCIF_BRG_REGTYPE] = {
 343                 .regs = {
 344                         [SCSMR]         = { 0x00, 16 },
 345                         [SCBRR]         = { 0x04,  8 },
 346                         [SCSCR]         = { 0x08, 16 },
 347                         [SCxTDR]        = { 0x0c,  8 },
 348                         [SCxSR]         = { 0x10, 16 },
 349                         [SCxRDR]        = { 0x14,  8 },
 350                         [SCFCR]         = { 0x18, 16 },
 351                         [SCFDR]         = { 0x1c, 16 },
 352                         [SCSPTR]        = { 0x20, 16 },
 353                         [SCLSR]         = { 0x24, 16 },
 354                         [SCDL]          = { 0x30, 16 },
 355                         [SCCKS]         = { 0x34, 16 },
 356                 },
 357                 .fifosize = 16,
 358                 .overrun_reg = SCLSR,
 359                 .overrun_mask = SCLSR_ORER,
 360                 .sampling_rate_mask = SCI_SR(32),
 361                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
 362                 .error_clear = SCIF_ERROR_CLEAR,
 363         },
 364
 365         /*
 366          * Common HSCIF definitions.
 367          */
 368         [SCIx_HSCIF_REGTYPE] = {
 369                 .regs = {
 370                         [SCSMR]         = { 0x00, 16 },
 371                         [SCBRR]         = { 0x04,  8 },
 372                         [SCSCR]         = { 0x08, 16 },
 373                         [SCxTDR]        = { 0x0c,  8 },
 374                         [SCxSR]         = { 0x10, 16 },
 375                         [SCxRDR]        = { 0x14,  8 },
 376                         [SCFCR]         = { 0x18, 16 },
 377                         [SCFDR]         = { 0x1c, 16 },
 378                         [SCSPTR]        = { 0x20, 16 },
 379                         [SCLSR]         = { 0x24, 16 },
 380                         [HSSRR]         = { 0x40, 16 },
 381                         [SCDL]          = { 0x30, 16 },
 382                         [SCCKS]         = { 0x34, 16 },
 383                         [HSRTRGR]       = { 0x54, 16 },
 384                         [HSTTRGR]       = { 0x58, 16 },
 385                 },
 386                 .fifosize = 128,
 387                 .overrun_reg = SCLSR,
 388                 .overrun_mask = SCLSR_ORER,
 389                 .sampling_rate_mask = SCI_SR_RANGE(8, 32),
 390                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
 391                 .error_clear = SCIF_ERROR_CLEAR,
 392         },
 393
 394         /*
 395          * Common SH-4(A) SCIF(B) definitions for ports without an SCSPTR
 396          * register.
 397          */
 398         [SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE] = {
 399                 .regs = {
 400                         [SCSMR]         = { 0x00, 16 },
 401                         [SCBRR]         = { 0x04,  8 },
 402                         [SCSCR]         = { 0x08, 16 },
 403                         [SCxTDR]        = { 0x0c,  8 },
 404                         [SCxSR]         = { 0x10, 16 },
 405                         [SCxRDR]        = { 0x14,  8 },
 406                         [SCFCR]         = { 0x18, 16 },
 407                         [SCFDR]         = { 0x1c, 16 },
 408                         [SCLSR]         = { 0x24, 16 },
 409                 },
 410                 .fifosize = 16,
 411                 .overrun_reg = SCLSR,
 412                 .overrun_mask = SCLSR_ORER,
 413                 .sampling_rate_mask = SCI_SR(32),
 414                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
 415                 .error_clear = SCIF_ERROR_CLEAR,
 416         },
 417
 418         /*
 419          * Common SH-4(A) SCIF(B) definitions for ports with FIFO data
 420          * count registers.
 421          */
 422         [SCIx_SH4_SCIF_FIFODATA_REGTYPE] = {
 423                 .regs = {
 424                         [SCSMR]         = { 0x00, 16 },
 425                         [SCBRR]         = { 0x04,  8 },
 426                         [SCSCR]         = { 0x08, 16 },
 427                         [SCxTDR]        = { 0x0c,  8 },
 428                         [SCxSR]         = { 0x10, 16 },
 429                         [SCxRDR]        = { 0x14,  8 },
 430                         [SCFCR]         = { 0x18, 16 },
 431                         [SCFDR]         = { 0x1c, 16 },
 432                         [SCTFDR]        = { 0x1c, 16 }, /* aliased to SCFDR */
 433                         [SCRFDR]        = { 0x20, 16 },
 434                         [SCSPTR]        = { 0x24, 16 },
 435                         [SCLSR]         = { 0x28, 16 },
 436                 },
 437                 .fifosize = 16,
 438                 .overrun_reg = SCLSR,
 439                 .overrun_mask = SCLSR_ORER,
 440                 .sampling_rate_mask = SCI_SR(32),
 441                 .error_mask = SCIF_DEFAULT_ERROR_MASK,
 442                 .error_clear = SCIF_ERROR_CLEAR,
 443         },
 444
 445         /*
 446          * SH7705-style SCIF(B) ports, lacking both SCSPTR and SCLSR
 447          * registers.
 448          */
 449         [SCIx_SH7705_SCIF_REGTYPE] = {
 450                 .regs = {
 451                         [SCSMR]         = { 0x00, 16 },
 452                         [SCBRR]         = { 0x04,  8 },
 453                         [SCSCR]         = { 0x08, 16 },
 454                         [SCxTDR]        = { 0x20,  8 },
 455                         [SCxSR]         = { 0x14, 16 },
 456                         [SCxRDR]        = { 0x24,  8 },
 457                         [SCFCR]         = { 0x18, 16 },
 458                         [SCFDR]         = { 0x1c, 16 },
 459                 },
 460                 .fifosize = 64,
 461                 .overrun_reg = SCxSR,
 462                 .overrun_mask = SCIFA_ORER,
 463                 .sampling_rate_mask = SCI_SR(16),
 464                 .error_mask = SCIF_DEFAULT_ERROR_MASK | SCIFA_ORER,
 465                 .error_clear = SCIF_ERROR_CLEAR & ~SCIFA_ORER,
 466         },
 467 };
 468
 469 #define sci_getreg(up, offset)          (&to_sci_port(up)->params->regs[offset])
 470
 471 /*
 472  * The "offset" here is rather misleading, in that it refers to an enum
 473  * value relative to the port mapping rather than the fixed offset
 474  * itself, which needs to be manually retrieved from the platform's
 475  * register map for the given port.
 476  */
 477 static unsigned int sci_serial_in(struct uart_port *p, int offset)
 478 {
 479         const struct plat_sci_reg *reg = sci_getreg(p, offset);
 480
 481         if (reg->size == 8)
 482                 return ioread8(p->membase + (reg->offset << p->regshift));
 483         else if (reg->size == 16)
 484                 return ioread16(p->membase + (reg->offset << p->regshift));
 485         else
 486                 WARN(1, "Invalid register access\n");
 487
 488         return 0;
 489 }
 490
 491 static void sci_serial_out(struct uart_port *p, int offset, int value)
 492 {
 493         const struct plat_sci_reg *reg = sci_getreg(p, offset);
 494
 495         if (reg->size == 8)
 496                 iowrite8(value, p->membase + (reg->offset << p->regshift));
 497         else if (reg->size == 16)
 498                 iowrite16(value, p->membase + (reg->offset << p->regshift));
 499         else
 500                 WARN(1, "Invalid register access\n");
 501 }
 502
 503 static void sci_port_enable(struct sci_port *sci_port)
 504 {
 505         unsigned int i;
 506
 507         if (!sci_port->port.dev)
 508                 return;
 509
 510         pm_runtime_get_sync(sci_port->port.dev);
 511
 512         for (i = 0; i < SCI_NUM_CLKS; i++) {
 513                 clk_prepare_enable(sci_port->clks[i]);
 514                 sci_port->clk_rates[i] = clk_get_rate(sci_port->clks[i]);
 515         }
 516         sci_port->port.uartclk = sci_port->clk_rates[SCI_FCK];
 517 }
 518
 519 static void sci_port_disable(struct sci_port *sci_port)
 520 {
 521         unsigned int i;
 522
 523         if (!sci_port->port.dev)
 524                 return;
 525
 526         for (i = SCI_NUM_CLKS; i-- > 0; )
 527                 clk_disable_unprepare(sci_port->clks[i]);
 528
 529         pm_runtime_put_sync(sci_port->port.dev);
 530 }
 531
 532 static inline unsigned long port_rx_irq_mask(struct uart_port *port)
 533 {
 534         /*
 535          * Not all ports (such as SCIFA) will support REIE. Rather than
 536          * special-casing the port type, we check the port initialization
 537          * IRQ enable mask to see whether the IRQ is desired at all. If
 538          * it's unset, it's logically inferred that there's no point in
 539          * testing for it.
 540          */
 541         return SCSCR_RIE | (to_sci_port(port)->cfg->scscr & SCSCR_REIE);
 542 }
 543
 544 static void sci_start_tx(struct uart_port *port)
 545 {
 546         struct sci_port *s = to_sci_port(port);
 547         unsigned short ctrl;
 548
 549 #ifdef CONFIG_SERIAL_SH_SCI_DMA
 550         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
 551                 u16 new, scr = serial_port_in(port, SCSCR);
 552                 if (s->chan_tx)
 553                         new = scr | SCSCR_TDRQE;
 554                 else
 555                         new = scr & ~SCSCR_TDRQE;
 556                 if (new != scr)
 557                         serial_port_out(port, SCSCR, new);
 558         }
 559
 560         if (s->chan_tx && !uart_circ_empty(&s->port.state->xmit) &&
 561             dma_submit_error(s->cookie_tx)) {
 562                 s->cookie_tx = 0;
 563                 schedule_work(&s->work_tx);
 564         }
 565 #endif
 566
 567         if (!s->chan_tx || port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
 568                 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
 569                 ctrl = serial_port_in(port, SCSCR);
 570                 serial_port_out(port, SCSCR, ctrl | SCSCR_TIE);
 571         }
 572 }
 573
 574 static void sci_stop_tx(struct uart_port *port)
 575 {
 576         unsigned short ctrl;
 577
 578         /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
 579         ctrl = serial_port_in(port, SCSCR);
 580
 581         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
 582                 ctrl &= ~SCSCR_TDRQE;
 583
 584         ctrl &= ~SCSCR_TIE;
 585
 586         serial_port_out(port, SCSCR, ctrl);
 587 }
 588
 589 static void sci_start_rx(struct uart_port *port)
 590 {
 591         unsigned short ctrl;
 592
 593         ctrl = serial_port_in(port, SCSCR) | port_rx_irq_mask(port);
 594
 595         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
 596                 ctrl &= ~SCSCR_RDRQE;
 597
 598         serial_port_out(port, SCSCR, ctrl);
 599 }
 600
 601 static void sci_stop_rx(struct uart_port *port)
 602 {
 603         unsigned short ctrl;
 604
 605         ctrl = serial_port_in(port, SCSCR);
 606
 607         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
 608                 ctrl &= ~SCSCR_RDRQE;
 609
 610         ctrl &= ~port_rx_irq_mask(port);
 611
 612         serial_port_out(port, SCSCR, ctrl);
 613 }
 614
 615 static void sci_clear_SCxSR(struct uart_port *port, unsigned int mask)
 616 {
 617         if (port->type == PORT_SCI) {
 618                 /* Just store the mask */
 619                 serial_port_out(port, SCxSR, mask);
 620         } else if (to_sci_port(port)->params->overrun_mask == SCIFA_ORER) {
 621                 /* SCIFA/SCIFB and SCIF on SH7705/SH7720/SH7721 */
 622                 /* Only clear the status bits we want to clear */
 623                 serial_port_out(port, SCxSR,
 624                                 serial_port_in(port, SCxSR) & mask);
 625         } else {
 626                 /* Store the mask, clear parity/framing errors */
 627                 serial_port_out(port, SCxSR, mask & ~(SCIF_FERC | SCIF_PERC));
 628         }
 629 }
 630
 631 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || \
 632     defined(CONFIG_SERIAL_SH_SCI_EARLYCON)
 633
 634 #ifdef CONFIG_CONSOLE_POLL
 635 static int sci_poll_get_char(struct uart_port *port)
 636 {
 637         unsigned short status;
 638         int c;
 639
 640         do {
 641                 status = serial_port_in(port, SCxSR);
 642                 if (status & SCxSR_ERRORS(port)) {
 643                         sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
 644                         continue;
 645                 }
 646                 break;
 647         } while (1);
 648
 649         if (!(status & SCxSR_RDxF(port)))
 650                 return NO_POLL_CHAR;
 651
 652         c = serial_port_in(port, SCxRDR);
 653
 654         /* Dummy read */
 655         serial_port_in(port, SCxSR);
 656         sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
 657
 658         return c;
 659 }
 660 #endif
 661
 662 static void sci_poll_put_char(struct uart_port *port, unsigned char c)
 663 {
 664         unsigned short status;
 665
 666         do {
 667                 status = serial_port_in(port, SCxSR);
 668         } while (!(status & SCxSR_TDxE(port)));
 669
 670         serial_port_out(port, SCxTDR, c);
 671         sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port) & ~SCxSR_TEND(port));
 672 }
 673 #endif /* CONFIG_CONSOLE_POLL || CONFIG_SERIAL_SH_SCI_CONSOLE ||
 674           CONFIG_SERIAL_SH_SCI_EARLYCON */
 675
 676 static void sci_init_pins(struct uart_port *port, unsigned int cflag)
 677 {
 678         struct sci_port *s = to_sci_port(port);
 679
 680         /*
 681          * Use port-specific handler if provided.
 682          */
 683         if (s->cfg->ops && s->cfg->ops->init_pins) {
 684                 s->cfg->ops->init_pins(port, cflag);
 685                 return;
 686         }
 687
 688         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
 689                 u16 data = serial_port_in(port, SCPDR);
 690                 u16 ctrl = serial_port_in(port, SCPCR);
 691
 692                 /* Enable RXD and TXD pin functions */
 693                 ctrl &= ~(SCPCR_RXDC | SCPCR_TXDC);
 694                 if (to_sci_port(port)->has_rtscts) {
 695                         /* RTS# is output, active low, unless autorts */
 696                         if (!(port->mctrl & TIOCM_RTS)) {
 697                                 ctrl |= SCPCR_RTSC;
 698                                 data |= SCPDR_RTSD;
 699                         } else if (!s->autorts) {
 700                                 ctrl |= SCPCR_RTSC;
 701                                 data &= ~SCPDR_RTSD;
 702                         } else {
 703                                 /* Enable RTS# pin function */
 704                                 ctrl &= ~SCPCR_RTSC;
 705                         }
 706                         /* Enable CTS# pin function */
 707                         ctrl &= ~SCPCR_CTSC;
 708                 }
 709                 serial_port_out(port, SCPDR, data);
 710                 serial_port_out(port, SCPCR, ctrl);
 711         } else if (sci_getreg(port, SCSPTR)->size) {
 712                 u16 status = serial_port_in(port, SCSPTR);
 713
 714                 /* RTS# is always output; and active low, unless autorts */
 715                 status |= SCSPTR_RTSIO;
 716                 if (!(port->mctrl & TIOCM_RTS))
 717                         status |= SCSPTR_RTSDT;
 718                 else if (!s->autorts)
 719                         status &= ~SCSPTR_RTSDT;
 720                 /* CTS# and SCK are inputs */
 721                 status &= ~(SCSPTR_CTSIO | SCSPTR_SCKIO);
 722                 serial_port_out(port, SCSPTR, status);
 723         }
 724 }
 725
 726 static int sci_txfill(struct uart_port *port)
 727 {
 728         struct sci_port *s = to_sci_port(port);
 729         unsigned int fifo_mask = (s->params->fifosize << 1) - 1;
 730         const struct plat_sci_reg *reg;
 731
 732         reg = sci_getreg(port, SCTFDR);
 733         if (reg->size)
 734                 return serial_port_in(port, SCTFDR) & fifo_mask;
 735
 736         reg = sci_getreg(port, SCFDR);
 737         if (reg->size)
 738                 return serial_port_in(port, SCFDR) >> 8;
 739
 740         return !(serial_port_in(port, SCxSR) & SCI_TDRE);
 741 }
 742
 743 static int sci_txroom(struct uart_port *port)
 744 {
 745         return port->fifosize - sci_txfill(port);
 746 }
 747
 748 static int sci_rxfill(struct uart_port *port)
 749 {
 750         struct sci_port *s = to_sci_port(port);
 751         unsigned int fifo_mask = (s->params->fifosize << 1) - 1;
 752         const struct plat_sci_reg *reg;
 753
 754         reg = sci_getreg(port, SCRFDR);
 755         if (reg->size)
 756                 return serial_port_in(port, SCRFDR) & fifo_mask;
 757
 758         reg = sci_getreg(port, SCFDR);
 759         if (reg->size)
 760                 return serial_port_in(port, SCFDR) & fifo_mask;
 761
 762         return (serial_port_in(port, SCxSR) & SCxSR_RDxF(port)) != 0;
 763 }
 764
 765 /* ********************************************************************** *
 766  *                   the interrupt related routines                       *
 767  * ********************************************************************** */
 768
 769 static void sci_transmit_chars(struct uart_port *port)
 770 {
 771         struct circ_buf *xmit = &port->state->xmit;
 772         unsigned int stopped = uart_tx_stopped(port);
 773         unsigned short status;
 774         unsigned short ctrl;
 775         int count;
 776
 777         status = serial_port_in(port, SCxSR);
 778         if (!(status & SCxSR_TDxE(port))) {
 779                 ctrl = serial_port_in(port, SCSCR);
 780                 if (uart_circ_empty(xmit))
 781                         ctrl &= ~SCSCR_TIE;
 782                 else
 783                         ctrl |= SCSCR_TIE;
 784                 serial_port_out(port, SCSCR, ctrl);
 785                 return;
 786         }
 787
 788         count = sci_txroom(port);
 789
 790         do {
 791                 unsigned char c;
 792
 793                 if (port->x_char) {
 794                         c = port->x_char;
 795                         port->x_char = 0;
 796                 } else if (!uart_circ_empty(xmit) && !stopped) {
 797                         c = xmit->buf[xmit->tail];
 798                         xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
 799                 } else {
 800                         break;
 801                 }
 802
 803                 serial_port_out(port, SCxTDR, c);
 804
 805                 port->icount.tx++;
 806         } while (--count > 0);
 807
 808         sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
 809
 810         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 811                 uart_write_wakeup(port);
 812         if (uart_circ_empty(xmit)) {
 813                 sci_stop_tx(port);
 814         } else {
 815                 ctrl = serial_port_in(port, SCSCR);
 816
 817                 if (port->type != PORT_SCI) {
 818                         serial_port_in(port, SCxSR); /* Dummy read */
 819                         sci_clear_SCxSR(port, SCxSR_TDxE_CLEAR(port));
 820                 }
 821
 822                 ctrl |= SCSCR_TIE;
 823                 serial_port_out(port, SCSCR, ctrl);
 824         }
 825 }
 826
 827 /* On SH3, SCIF may read end-of-break as a space->mark char */
 828 #define STEPFN(c)  ({int __c = (c); (((__c-1)|(__c)) == -1); })
 829
 830 static void sci_receive_chars(struct uart_port *port)
 831 {
 832         struct tty_port *tport = &port->state->port;
 833         int i, count, copied = 0;
 834         unsigned short status;
 835         unsigned char flag;
 836
 837         status = serial_port_in(port, SCxSR);
 838         if (!(status & SCxSR_RDxF(port)))
 839                 return;
 840
 841         while (1) {
 842                 /* Don't copy more bytes than there is room for in the buffer */
 843                 count = tty_buffer_request_room(tport, sci_rxfill(port));
 844
 845                 /* If for any reason we can't copy more data, we're done! */
 846                 if (count == 0)
 847                         break;
 848
 849                 if (port->type == PORT_SCI) {
 850                         char c = serial_port_in(port, SCxRDR);
 851                         if (uart_handle_sysrq_char(port, c))
 852                                 count = 0;
 853                         else
 854                                 tty_insert_flip_char(tport, c, TTY_NORMAL);
 855                 } else {
 856                         for (i = 0; i < count; i++) {
 857                                 char c = serial_port_in(port, SCxRDR);
 858
 859                                 status = serial_port_in(port, SCxSR);
 860                                 if (uart_handle_sysrq_char(port, c)) {
 861                                         count--; i--;
 862                                         continue;
 863                                 }
 864
 865                                 /* Store data and status */
 866                                 if (status & SCxSR_FER(port)) {
 867                                         flag = TTY_FRAME;
 868                                         port->icount.frame++;
 869                                         dev_notice(port->dev, "frame error\n");
 870                                 } else if (status & SCxSR_PER(port)) {
 871                                         flag = TTY_PARITY;
 872                                         port->icount.parity++;
 873                                         dev_notice(port->dev, "parity error\n");
 874                                 } else
 875                                         flag = TTY_NORMAL;
 876
 877                                 tty_insert_flip_char(tport, c, flag);
 878                         }
 879                 }
 880
 881                 serial_port_in(port, SCxSR); /* dummy read */
 882                 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
 883
 884                 copied += count;
 885                 port->icount.rx += count;
 886         }
 887
 888         if (copied) {
 889                 /* Tell the rest of the system the news. New characters! */
 890                 tty_flip_buffer_push(tport);
 891         } else {
 892                 /* TTY buffers full; read from RX reg to prevent lockup */
 893                 serial_port_in(port, SCxRDR);
 894                 serial_port_in(port, SCxSR); /* dummy read */
 895                 sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
 896         }
 897 }
 898
 899 static int sci_handle_errors(struct uart_port *port)
 900 {
 901         int copied = 0;
 902         unsigned short status = serial_port_in(port, SCxSR);
 903         struct tty_port *tport = &port->state->port;
 904         struct sci_port *s = to_sci_port(port);
 905
 906         /* Handle overruns */
 907         if (status & s->params->overrun_mask) {
 908                 port->icount.overrun++;
 909
 910                 /* overrun error */
 911                 if (tty_insert_flip_char(tport, 0, TTY_OVERRUN))
 912                         copied++;
 913
 914                 dev_notice(port->dev, "overrun error\n");
 915         }
 916
 917         if (status & SCxSR_FER(port)) {
 918                 /* frame error */
 919                 port->icount.frame++;
 920
 921                 if (tty_insert_flip_char(tport, 0, TTY_FRAME))
 922                         copied++;
 923
 924                 dev_notice(port->dev, "frame error\n");
 925         }
 926
 927         if (status & SCxSR_PER(port)) {
 928                 /* parity error */
 929                 port->icount.parity++;
 930
 931                 if (tty_insert_flip_char(tport, 0, TTY_PARITY))
 932                         copied++;
 933
 934                 dev_notice(port->dev, "parity error\n");
 935         }
 936
 937         if (copied)
 938                 tty_flip_buffer_push(tport);
 939
 940         return copied;
 941 }
 942
 943 static int sci_handle_fifo_overrun(struct uart_port *port)
 944 {
 945         struct tty_port *tport = &port->state->port;
 946         struct sci_port *s = to_sci_port(port);
 947         const struct plat_sci_reg *reg;
 948         int copied = 0;
 949         u16 status;
 950
 951         reg = sci_getreg(port, s->params->overrun_reg);
 952         if (!reg->size)
 953                 return 0;
 954
 955         status = serial_port_in(port, s->params->overrun_reg);
 956         if (status & s->params->overrun_mask) {
 957                 status &= ~s->params->overrun_mask;
 958                 serial_port_out(port, s->params->overrun_reg, status);
 959
 960                 port->icount.overrun++;
 961
 962                 tty_insert_flip_char(tport, 0, TTY_OVERRUN);
 963                 tty_flip_buffer_push(tport);
 964
 965                 dev_dbg(port->dev, "overrun error\n");
 966                 copied++;
 967         }
 968
 969         return copied;
 970 }
 971
 972 static int sci_handle_breaks(struct uart_port *port)
 973 {
 974         int copied = 0;
 975         unsigned short status = serial_port_in(port, SCxSR);
 976         struct tty_port *tport = &port->state->port;
 977
 978         if (uart_handle_break(port))
 979                 return 0;
 980
 981         if (status & SCxSR_BRK(port)) {
 982                 port->icount.brk++;
 983
 984                 /* Notify of BREAK */
 985                 if (tty_insert_flip_char(tport, 0, TTY_BREAK))
 986                         copied++;
 987
 988                 dev_dbg(port->dev, "BREAK detected\n");
 989         }
 990
 991         if (copied)
 992                 tty_flip_buffer_push(tport);
 993
 994         copied += sci_handle_fifo_overrun(port);
 995
 996         return copied;
 997 }
 998
 999 static int scif_set_rtrg(struct uart_port *port, int rx_trig)
1000 {
1001         unsigned int bits;
1002
1003         if (rx_trig < 1)
1004                 rx_trig = 1;
1005         if (rx_trig >= port->fifosize)
1006                 rx_trig = port->fifosize;
1007
1008         /* HSCIF can be set to an arbitrary level. */
1009         if (sci_getreg(port, HSRTRGR)->size) {
1010                 serial_port_out(port, HSRTRGR, rx_trig);
1011                 return rx_trig;
1012         }
1013
1014         switch (port->type) {
1015         case PORT_SCIF:
1016                 if (rx_trig < 4) {
1017                         bits = 0;
1018                         rx_trig = 1;
1019                 } else if (rx_trig < 8) {
1020                         bits = SCFCR_RTRG0;
1021                         rx_trig = 4;
1022                 } else if (rx_trig < 14) {
1023                         bits = SCFCR_RTRG1;
1024                         rx_trig = 8;
1025                 } else {
1026                         bits = SCFCR_RTRG0 | SCFCR_RTRG1;
1027                         rx_trig = 14;
1028                 }
1029                 break;
1030         case PORT_SCIFA:
1031         case PORT_SCIFB:
1032                 if (rx_trig < 16) {
1033                         bits = 0;
1034                         rx_trig = 1;
1035                 } else if (rx_trig < 32) {
1036                         bits = SCFCR_RTRG0;
1037                         rx_trig = 16;
1038                 } else if (rx_trig < 48) {
1039                         bits = SCFCR_RTRG1;
1040                         rx_trig = 32;
1041                 } else {
1042                         bits = SCFCR_RTRG0 | SCFCR_RTRG1;
1043                         rx_trig = 48;
1044                 }
1045                 break;
1046         default:
1047                 WARN(1, "unknown FIFO configuration");
1048                 return 1;
1049         }
1050
1051         serial_port_out(port, SCFCR,
1052                 (serial_port_in(port, SCFCR) &
1053                 ~(SCFCR_RTRG1 | SCFCR_RTRG0)) | bits);
1054
1055         return rx_trig;
1056 }
1057
1058 static int scif_rtrg_enabled(struct uart_port *port)
1059 {
1060         if (sci_getreg(port, HSRTRGR)->size)
1061                 return serial_port_in(port, HSRTRGR) != 0;
1062         else
1063                 return (serial_port_in(port, SCFCR) &
1064                         (SCFCR_RTRG0 | SCFCR_RTRG1)) != 0;
1065 }
1066
1067 static void rx_fifo_timer_fn(struct timer_list *t)
1068 {
1069         struct sci_port *s = from_timer(s, t, rx_fifo_timer);
1070         struct uart_port *port = &s->port;
1071
1072         dev_dbg(port->dev, "Rx timed out\n");
1073         scif_set_rtrg(port, 1);
1074 }
1075
1076 static ssize_t rx_trigger_show(struct device *dev,
1077                                struct device_attribute *attr,
1078                                char *buf)
1079 {
1080         struct uart_port *port = dev_get_drvdata(dev);
1081         struct sci_port *sci = to_sci_port(port);
1082
1083         return sprintf(buf, "%d\n", sci->rx_trigger);
1084 }
1085
1086 static ssize_t rx_trigger_store(struct device *dev,
1087                                 struct device_attribute *attr,
1088                                 const char *buf,
1089                                 size_t count)
1090 {
1091         struct uart_port *port = dev_get_drvdata(dev);
1092         struct sci_port *sci = to_sci_port(port);
1093         int ret;
1094         long r;
1095
1096         ret = kstrtol(buf, 0, &r);
1097         if (ret)
1098                 return ret;
1099
1100         sci->rx_trigger = scif_set_rtrg(port, r);
1101         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1102                 scif_set_rtrg(port, 1);
1103
1104         return count;
1105 }
1106
1107 static DEVICE_ATTR(rx_fifo_trigger, 0644, rx_trigger_show, rx_trigger_store);
1108
1109 static ssize_t rx_fifo_timeout_show(struct device *dev,
1110                                struct device_attribute *attr,
1111                                char *buf)
1112 {
1113         struct uart_port *port = dev_get_drvdata(dev);
1114         struct sci_port *sci = to_sci_port(port);
1115         int v;
1116
1117         if (port->type == PORT_HSCIF)
1118                 v = sci->hscif_tot >> HSSCR_TOT_SHIFT;
1119         else
1120                 v = sci->rx_fifo_timeout;
1121
1122         return sprintf(buf, "%d\n", v);
1123 }
1124
1125 static ssize_t rx_fifo_timeout_store(struct device *dev,
1126                                 struct device_attribute *attr,
1127                                 const char *buf,
1128                                 size_t count)
1129 {
1130         struct uart_port *port = dev_get_drvdata(dev);
1131         struct sci_port *sci = to_sci_port(port);
1132         int ret;
1133         long r;
1134
1135         ret = kstrtol(buf, 0, &r);
1136         if (ret)
1137                 return ret;
1138
1139         if (port->type == PORT_HSCIF) {
1140                 if (r < 0 || r > 3)
1141                         return -EINVAL;
1142                 sci->hscif_tot = r << HSSCR_TOT_SHIFT;
1143         } else {
1144                 sci->rx_fifo_timeout = r;
1145                 scif_set_rtrg(port, 1);
1146                 if (r > 0)
1147                         timer_setup(&sci->rx_fifo_timer, rx_fifo_timer_fn, 0);
1148         }
1149
1150         return count;
1151 }
1152
1153 static DEVICE_ATTR_RW(rx_fifo_timeout);
1154
1155
1156 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1157 static void sci_dma_tx_complete(void *arg)
1158 {
1159         struct sci_port *s = arg;
1160         struct uart_port *port = &s->port;
1161         struct circ_buf *xmit = &port->state->xmit;
1162         unsigned long flags;
1163
1164         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1165
1166         spin_lock_irqsave(&port->lock, flags);
1167
1168         xmit->tail += s->tx_dma_len;
1169         xmit->tail &= UART_XMIT_SIZE - 1;
1170
1171         port->icount.tx += s->tx_dma_len;
1172
1173         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1174                 uart_write_wakeup(port);
1175
1176         if (!uart_circ_empty(xmit)) {
1177                 s->cookie_tx = 0;
1178                 schedule_work(&s->work_tx);
1179         } else {
1180                 s->cookie_tx = -EINVAL;
1181                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1182                         u16 ctrl = serial_port_in(port, SCSCR);
1183                         serial_port_out(port, SCSCR, ctrl & ~SCSCR_TIE);
1184                 }
1185         }
1186
1187         spin_unlock_irqrestore(&port->lock, flags);
1188 }
1189
1190 /* Locking: called with port lock held */
1191 static int sci_dma_rx_push(struct sci_port *s, void *buf, size_t count)
1192 {
1193         struct uart_port *port = &s->port;
1194         struct tty_port *tport = &port->state->port;
1195         int copied;
1196
1197         copied = tty_insert_flip_string(tport, buf, count);
1198         if (copied < count)
1199                 port->icount.buf_overrun++;
1200
1201         port->icount.rx += copied;
1202
1203         return copied;
1204 }
1205
1206 static int sci_dma_rx_find_active(struct sci_port *s)
1207 {
1208         unsigned int i;
1209
1210         for (i = 0; i < ARRAY_SIZE(s->cookie_rx); i++)
1211                 if (s->active_rx == s->cookie_rx[i])
1212                         return i;
1213
1214         return -1;
1215 }
1216
1217 static void sci_rx_dma_release(struct sci_port *s)
1218 {
1219         struct dma_chan *chan = s->chan_rx_saved;
1220
1221         s->chan_rx_saved = s->chan_rx = NULL;
1222         s->cookie_rx[0] = s->cookie_rx[1] = -EINVAL;
1223         dmaengine_terminate_sync(chan);
1224         dma_free_coherent(chan->device->dev, s->buf_len_rx * 2, s->rx_buf[0],
1225                           sg_dma_address(&s->sg_rx[0]));
1226         dma_release_channel(chan);
1227 }
1228
1229 static void start_hrtimer_us(struct hrtimer *hrt, unsigned long usec)
1230 {
1231         long sec = usec / 1000000;
1232         long nsec = (usec % 1000000) * 1000;
1233         ktime_t t = ktime_set(sec, nsec);
1234
1235         hrtimer_start(hrt, t, HRTIMER_MODE_REL);
1236 }
1237
1238 static void sci_dma_rx_complete(void *arg)
1239 {
1240         struct sci_port *s = arg;
1241         struct dma_chan *chan = s->chan_rx;
1242         struct uart_port *port = &s->port;
1243         struct dma_async_tx_descriptor *desc;
1244         unsigned long flags;
1245         int active, count = 0;
1246
1247         dev_dbg(port->dev, "%s(%d) active cookie %d\n", __func__, port->line,
1248                 s->active_rx);
1249
1250         spin_lock_irqsave(&port->lock, flags);
1251
1252         active = sci_dma_rx_find_active(s);
1253         if (active >= 0)
1254                 count = sci_dma_rx_push(s, s->rx_buf[active], s->buf_len_rx);
1255
1256         start_hrtimer_us(&s->rx_timer, s->rx_timeout);
1257
1258         if (count)
1259                 tty_flip_buffer_push(&port->state->port);
1260
1261         desc = dmaengine_prep_slave_sg(s->chan_rx, &s->sg_rx[active], 1,
1262                                        DMA_DEV_TO_MEM,
1263                                        DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1264         if (!desc)
1265                 goto fail;
1266
1267         desc->callback = sci_dma_rx_complete;
1268         desc->callback_param = s;
1269         s->cookie_rx[active] = dmaengine_submit(desc);
1270         if (dma_submit_error(s->cookie_rx[active]))
1271                 goto fail;
1272
1273         s->active_rx = s->cookie_rx[!active];
1274
1275         dma_async_issue_pending(chan);
1276
1277         spin_unlock_irqrestore(&port->lock, flags);
1278         dev_dbg(port->dev, "%s: cookie %d #%d, new active cookie %d\n",
1279                 __func__, s->cookie_rx[active], active, s->active_rx);
1280         return;
1281
1282 fail:
1283         spin_unlock_irqrestore(&port->lock, flags);
1284         dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1285         /* Switch to PIO */
1286         spin_lock_irqsave(&port->lock, flags);
1287         s->chan_rx = NULL;
1288         sci_start_rx(port);
1289         spin_unlock_irqrestore(&port->lock, flags);
1290 }
1291
1292 static void sci_tx_dma_release(struct sci_port *s)
1293 {
1294         struct dma_chan *chan = s->chan_tx_saved;
1295
1296         cancel_work_sync(&s->work_tx);
1297         s->chan_tx_saved = s->chan_tx = NULL;
1298         s->cookie_tx = -EINVAL;
1299         dmaengine_terminate_sync(chan);
1300         dma_unmap_single(chan->device->dev, s->tx_dma_addr, UART_XMIT_SIZE,
1301                          DMA_TO_DEVICE);
1302         dma_release_channel(chan);
1303 }
1304
1305 static void sci_submit_rx(struct sci_port *s)
1306 {
1307         struct dma_chan *chan = s->chan_rx;
1308         struct uart_port *port = &s->port;
1309         unsigned long flags;
1310         int i;
1311
1312         for (i = 0; i < 2; i++) {
1313                 struct scatterlist *sg = &s->sg_rx[i];
1314                 struct dma_async_tx_descriptor *desc;
1315
1316                 desc = dmaengine_prep_slave_sg(chan,
1317                         sg, 1, DMA_DEV_TO_MEM,
1318                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1319                 if (!desc)
1320                         goto fail;
1321
1322                 desc->callback = sci_dma_rx_complete;
1323                 desc->callback_param = s;
1324                 s->cookie_rx[i] = dmaengine_submit(desc);
1325                 if (dma_submit_error(s->cookie_rx[i]))
1326                         goto fail;
1327
1328         }
1329
1330         s->active_rx = s->cookie_rx[0];
1331
1332         dma_async_issue_pending(chan);
1333         return;
1334
1335 fail:
1336         if (i)
1337                 dmaengine_terminate_async(chan);
1338         for (i = 0; i < 2; i++)
1339                 s->cookie_rx[i] = -EINVAL;
1340         s->active_rx = -EINVAL;
1341         /* Switch to PIO */
1342         spin_lock_irqsave(&port->lock, flags);
1343         s->chan_rx = NULL;
1344         sci_start_rx(port);
1345         spin_unlock_irqrestore(&port->lock, flags);
1346 }
1347
1348 static void work_fn_tx(struct work_struct *work)
1349 {
1350         struct sci_port *s = container_of(work, struct sci_port, work_tx);
1351         struct dma_async_tx_descriptor *desc;
1352         struct dma_chan *chan = s->chan_tx;
1353         struct uart_port *port = &s->port;
1354         struct circ_buf *xmit = &port->state->xmit;
1355         unsigned long flags;
1356         dma_addr_t buf;
1357
1358         /*
1359          * DMA is idle now.
1360          * Port xmit buffer is already mapped, and it is one page... Just adjust
1361          * offsets and lengths. Since it is a circular buffer, we have to
1362          * transmit till the end, and then the rest. Take the port lock to get a
1363          * consistent xmit buffer state.
1364          */
1365         spin_lock_irq(&port->lock);
1366         buf = s->tx_dma_addr + (xmit->tail & (UART_XMIT_SIZE - 1));
1367         s->tx_dma_len = min_t(unsigned int,
1368                 CIRC_CNT(xmit->head, xmit->tail, UART_XMIT_SIZE),
1369                 CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE));
1370         spin_unlock_irq(&port->lock);
1371
1372         desc = dmaengine_prep_slave_single(chan, buf, s->tx_dma_len,
1373                                            DMA_MEM_TO_DEV,
1374                                            DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1375         if (!desc) {
1376                 dev_warn(port->dev, "Failed preparing Tx DMA descriptor\n");
1377                 goto switch_to_pio;
1378         }
1379
1380         dma_sync_single_for_device(chan->device->dev, buf, s->tx_dma_len,
1381                                    DMA_TO_DEVICE);
1382
1383         spin_lock_irq(&port->lock);
1384         desc->callback = sci_dma_tx_complete;
1385         desc->callback_param = s;
1386         spin_unlock_irq(&port->lock);
1387         s->cookie_tx = dmaengine_submit(desc);
1388         if (dma_submit_error(s->cookie_tx)) {
1389                 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1390                 goto switch_to_pio;
1391         }
1392
1393         dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n",
1394                 __func__, xmit->buf, xmit->tail, xmit->head, s->cookie_tx);
1395
1396         dma_async_issue_pending(chan);
1397         return;
1398
1399 switch_to_pio:
1400         spin_lock_irqsave(&port->lock, flags);
1401         s->chan_tx = NULL;
1402         sci_start_tx(port);
1403         spin_unlock_irqrestore(&port->lock, flags);
1404         return;
1405 }
1406
1407 static enum hrtimer_restart rx_timer_fn(struct hrtimer *t)
1408 {
1409         struct sci_port *s = container_of(t, struct sci_port, rx_timer);
1410         struct dma_chan *chan = s->chan_rx;
1411         struct uart_port *port = &s->port;
1412         struct dma_tx_state state;
1413         enum dma_status status;
1414         unsigned long flags;
1415         unsigned int read;
1416         int active, count;
1417         u16 scr;
1418
1419         dev_dbg(port->dev, "DMA Rx timed out\n");
1420
1421         spin_lock_irqsave(&port->lock, flags);
1422
1423         active = sci_dma_rx_find_active(s);
1424         if (active < 0) {
1425                 spin_unlock_irqrestore(&port->lock, flags);
1426                 return HRTIMER_NORESTART;
1427         }
1428
1429         status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1430         if (status == DMA_COMPLETE) {
1431                 spin_unlock_irqrestore(&port->lock, flags);
1432                 dev_dbg(port->dev, "Cookie %d #%d has already completed\n",
1433                         s->active_rx, active);
1434
1435                 /* Let packet complete handler take care of the packet */
1436                 return HRTIMER_NORESTART;
1437         }
1438
1439         dmaengine_pause(chan);
1440
1441         /*
1442          * sometimes DMA transfer doesn't stop even if it is stopped and
1443          * data keeps on coming until transaction is complete so check
1444          * for DMA_COMPLETE again
1445          * Let packet complete handler take care of the packet
1446          */
1447         status = dmaengine_tx_status(s->chan_rx, s->active_rx, &state);
1448         if (status == DMA_COMPLETE) {
1449                 spin_unlock_irqrestore(&port->lock, flags);
1450                 dev_dbg(port->dev, "Transaction complete after DMA engine was stopped");
1451                 return HRTIMER_NORESTART;
1452         }
1453
1454         /* Handle incomplete DMA receive */
1455         dmaengine_terminate_async(s->chan_rx);
1456         read = sg_dma_len(&s->sg_rx[active]) - state.residue;
1457
1458         if (read) {
1459                 count = sci_dma_rx_push(s, s->rx_buf[active], read);
1460                 if (count)
1461                         tty_flip_buffer_push(&port->state->port);
1462         }
1463
1464         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1465                 sci_submit_rx(s);
1466
1467         /* Direct new serial port interrupts back to CPU */
1468         scr = serial_port_in(port, SCSCR);
1469         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1470                 scr &= ~SCSCR_RDRQE;
1471                 enable_irq(s->irqs[SCIx_RXI_IRQ]);
1472         }
1473         serial_port_out(port, SCSCR, scr | SCSCR_RIE);
1474
1475         spin_unlock_irqrestore(&port->lock, flags);
1476
1477         return HRTIMER_NORESTART;
1478 }
1479
1480 static struct dma_chan *sci_request_dma_chan(struct uart_port *port,
1481                                              enum dma_transfer_direction dir)
1482 {
1483         struct dma_chan *chan;
1484         struct dma_slave_config cfg;
1485         int ret;
1486
1487         chan = dma_request_slave_channel(port->dev,
1488                                          dir == DMA_MEM_TO_DEV ? "tx" : "rx");
1489         if (!chan) {
1490                 dev_warn(port->dev, "dma_request_slave_channel failed\n");
1491                 return NULL;
1492         }
1493
1494         memset(&cfg, 0, sizeof(cfg));
1495         cfg.direction = dir;
1496         if (dir == DMA_MEM_TO_DEV) {
1497                 cfg.dst_addr = port->mapbase +
1498                         (sci_getreg(port, SCxTDR)->offset << port->regshift);
1499                 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1500         } else {
1501                 cfg.src_addr = port->mapbase +
1502                         (sci_getreg(port, SCxRDR)->offset << port->regshift);
1503                 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1504         }
1505
1506         ret = dmaengine_slave_config(chan, &cfg);
1507         if (ret) {
1508                 dev_warn(port->dev, "dmaengine_slave_config failed %d\n", ret);
1509                 dma_release_channel(chan);
1510                 return NULL;
1511         }
1512
1513         return chan;
1514 }
1515
1516 static void sci_request_dma(struct uart_port *port)
1517 {
1518         struct sci_port *s = to_sci_port(port);
1519         struct dma_chan *chan;
1520
1521         dev_dbg(port->dev, "%s: port %d\n", __func__, port->line);
1522
1523         if (!port->dev->of_node)
1524                 return;
1525
1526         s->cookie_tx = -EINVAL;
1527
1528         /*
1529          * Don't request a dma channel if no channel was specified
1530          * in the device tree.
1531          */
1532         if (!of_find_property(port->dev->of_node, "dmas", NULL))
1533                 return;
1534
1535         chan = sci_request_dma_chan(port, DMA_MEM_TO_DEV);
1536         dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1537         if (chan) {
1538                 /* UART circular tx buffer is an aligned page. */
1539                 s->tx_dma_addr = dma_map_single(chan->device->dev,
1540                                                 port->state->xmit.buf,
1541                                                 UART_XMIT_SIZE,
1542                                                 DMA_TO_DEVICE);
1543                 if (dma_mapping_error(chan->device->dev, s->tx_dma_addr)) {
1544                         dev_warn(port->dev, "Failed mapping Tx DMA descriptor\n");
1545                         dma_release_channel(chan);
1546                         chan = NULL;
1547                 } else {
1548                         dev_dbg(port->dev, "%s: mapped %lu@%p to %pad\n",
1549                                 __func__, UART_XMIT_SIZE,
1550                                 port->state->xmit.buf, &s->tx_dma_addr);
1551
1552                         INIT_WORK(&s->work_tx, work_fn_tx);
1553                         s->chan_tx_saved = s->chan_tx = chan;
1554                 }
1555         }
1556
1557         chan = sci_request_dma_chan(port, DMA_DEV_TO_MEM);
1558         dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1559         if (chan) {
1560                 unsigned int i;
1561                 dma_addr_t dma;
1562                 void *buf;
1563
1564                 s->buf_len_rx = 2 * max_t(size_t, 16, port->fifosize);
1565                 buf = dma_alloc_coherent(chan->device->dev, s->buf_len_rx * 2,
1566                                          &dma, GFP_KERNEL);
1567                 if (!buf) {
1568                         dev_warn(port->dev,
1569                                  "Failed to allocate Rx dma buffer, using PIO\n");
1570                         dma_release_channel(chan);
1571                         return;
1572                 }
1573
1574                 for (i = 0; i < 2; i++) {
1575                         struct scatterlist *sg = &s->sg_rx[i];
1576
1577                         sg_init_table(sg, 1);
1578                         s->rx_buf[i] = buf;
1579                         sg_dma_address(sg) = dma;
1580                         sg_dma_len(sg) = s->buf_len_rx;
1581
1582                         buf += s->buf_len_rx;
1583                         dma += s->buf_len_rx;
1584                 }
1585
1586                 hrtimer_init(&s->rx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1587                 s->rx_timer.function = rx_timer_fn;
1588
1589                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1590                         sci_submit_rx(s);
1591
1592                 s->chan_rx_saved = s->chan_rx = chan;
1593         }
1594 }
1595
1596 static void sci_free_dma(struct uart_port *port)
1597 {
1598         struct sci_port *s = to_sci_port(port);
1599
1600         if (s->chan_tx_saved)
1601                 sci_tx_dma_release(s);
1602         if (s->chan_rx_saved)
1603                 sci_rx_dma_release(s);
1604 }
1605
1606 static void sci_flush_buffer(struct uart_port *port)
1607 {
1608         /*
1609          * In uart_flush_buffer(), the xmit circular buffer has just been
1610          * cleared, so we have to reset tx_dma_len accordingly.
1611          */
1612         to_sci_port(port)->tx_dma_len = 0;
1613 }
1614 #else /* !CONFIG_SERIAL_SH_SCI_DMA */
1615 static inline void sci_request_dma(struct uart_port *port)
1616 {
1617 }
1618
1619 static inline void sci_free_dma(struct uart_port *port)
1620 {
1621 }
1622
1623 #define sci_flush_buffer        NULL
1624 #endif /* !CONFIG_SERIAL_SH_SCI_DMA */
1625
1626 static irqreturn_t sci_rx_interrupt(int irq, void *ptr)
1627 {
1628         struct uart_port *port = ptr;
1629         struct sci_port *s = to_sci_port(port);
1630
1631 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1632         if (s->chan_rx) {
1633                 u16 scr = serial_port_in(port, SCSCR);
1634                 u16 ssr = serial_port_in(port, SCxSR);
1635
1636                 /* Disable future Rx interrupts */
1637                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1638                         disable_irq_nosync(irq);
1639                         scr |= SCSCR_RDRQE;
1640                 } else {
1641                         scr &= ~SCSCR_RIE;
1642                         sci_submit_rx(s);
1643                 }
1644                 serial_port_out(port, SCSCR, scr);
1645                 /* Clear current interrupt */
1646                 serial_port_out(port, SCxSR,
1647                                 ssr & ~(SCIF_DR | SCxSR_RDxF(port)));
1648                 dev_dbg(port->dev, "Rx IRQ %lu: setup t-out in %u us\n",
1649                         jiffies, s->rx_timeout);
1650                 start_hrtimer_us(&s->rx_timer, s->rx_timeout);
1651
1652                 return IRQ_HANDLED;
1653         }
1654 #endif
1655
1656         if (s->rx_trigger > 1 && s->rx_fifo_timeout > 0) {
1657                 if (!scif_rtrg_enabled(port))
1658                         scif_set_rtrg(port, s->rx_trigger);
1659
1660                 mod_timer(&s->rx_fifo_timer, jiffies + DIV_ROUND_UP(
1661                           s->rx_frame * HZ * s->rx_fifo_timeout, 1000000));
1662         }
1663
1664         /* I think sci_receive_chars has to be called irrespective
1665          * of whether the I_IXOFF is set, otherwise, how is the interrupt
1666          * to be disabled?
1667          */
1668         sci_receive_chars(ptr);
1669
1670         return IRQ_HANDLED;
1671 }
1672
1673 static irqreturn_t sci_tx_interrupt(int irq, void *ptr)
1674 {
1675         struct uart_port *port = ptr;
1676         unsigned long flags;
1677
1678         spin_lock_irqsave(&port->lock, flags);
1679         sci_transmit_chars(port);
1680         spin_unlock_irqrestore(&port->lock, flags);
1681
1682         return IRQ_HANDLED;
1683 }
1684
1685 static irqreturn_t sci_er_interrupt(int irq, void *ptr)
1686 {
1687         struct uart_port *port = ptr;
1688         struct sci_port *s = to_sci_port(port);
1689
1690         /* Handle errors */
1691         if (port->type == PORT_SCI) {
1692                 if (sci_handle_errors(port)) {
1693                         /* discard character in rx buffer */
1694                         serial_port_in(port, SCxSR);
1695                         sci_clear_SCxSR(port, SCxSR_RDxF_CLEAR(port));
1696                 }
1697         } else {
1698                 sci_handle_fifo_overrun(port);
1699                 if (!s->chan_rx)
1700                         sci_receive_chars(ptr);
1701         }
1702
1703         sci_clear_SCxSR(port, SCxSR_ERROR_CLEAR(port));
1704
1705         /* Kick the transmission */
1706         if (!s->chan_tx)
1707                 sci_tx_interrupt(irq, ptr);
1708
1709         return IRQ_HANDLED;
1710 }
1711
1712 static irqreturn_t sci_br_interrupt(int irq, void *ptr)
1713 {
1714         struct uart_port *port = ptr;
1715
1716         /* Handle BREAKs */
1717         sci_handle_breaks(port);
1718         sci_clear_SCxSR(port, SCxSR_BREAK_CLEAR(port));
1719
1720         return IRQ_HANDLED;
1721 }
1722
1723 static irqreturn_t sci_mpxed_interrupt(int irq, void *ptr)
1724 {
1725         unsigned short ssr_status, scr_status, err_enabled, orer_status = 0;
1726         struct uart_port *port = ptr;
1727         struct sci_port *s = to_sci_port(port);
1728         irqreturn_t ret = IRQ_NONE;
1729
1730         ssr_status = serial_port_in(port, SCxSR);
1731         scr_status = serial_port_in(port, SCSCR);
1732         if (s->params->overrun_reg == SCxSR)
1733                 orer_status = ssr_status;
1734         else if (sci_getreg(port, s->params->overrun_reg)->size)
1735                 orer_status = serial_port_in(port, s->params->overrun_reg);
1736
1737         err_enabled = scr_status & port_rx_irq_mask(port);
1738
1739         /* Tx Interrupt */
1740         if ((ssr_status & SCxSR_TDxE(port)) && (scr_status & SCSCR_TIE) &&
1741             !s->chan_tx)
1742                 ret = sci_tx_interrupt(irq, ptr);
1743
1744         /*
1745          * Rx Interrupt: if we're using DMA, the DMA controller clears RDF /
1746          * DR flags
1747          */
1748         if (((ssr_status & SCxSR_RDxF(port)) || s->chan_rx) &&
1749             (scr_status & SCSCR_RIE))
1750                 ret = sci_rx_interrupt(irq, ptr);
1751
1752         /* Error Interrupt */
1753         if ((ssr_status & SCxSR_ERRORS(port)) && err_enabled)
1754                 ret = sci_er_interrupt(irq, ptr);
1755
1756         /* Break Interrupt */
1757         if ((ssr_status & SCxSR_BRK(port)) && err_enabled)
1758                 ret = sci_br_interrupt(irq, ptr);
1759
1760         /* Overrun Interrupt */
1761         if (orer_status & s->params->overrun_mask) {
1762                 sci_handle_fifo_overrun(port);
1763                 ret = IRQ_HANDLED;
1764         }
1765
1766         return ret;
1767 }
1768
1769 static const struct sci_irq_desc {
1770         const char      *desc;
1771         irq_handler_t   handler;
1772 } sci_irq_desc[] = {
1773         /*
1774          * Split out handlers, the default case.
1775          */
1776         [SCIx_ERI_IRQ] = {
1777                 .desc = "rx err",
1778                 .handler = sci_er_interrupt,
1779         },
1780
1781         [SCIx_RXI_IRQ] = {
1782                 .desc = "rx full",
1783                 .handler = sci_rx_interrupt,
1784         },
1785
1786         [SCIx_TXI_IRQ] = {
1787                 .desc = "tx empty",
1788                 .handler = sci_tx_interrupt,
1789         },
1790
1791         [SCIx_BRI_IRQ] = {
1792                 .desc = "break",
1793                 .handler = sci_br_interrupt,
1794         },
1795
1796         /*
1797          * Special muxed handler.
1798          */
1799         [SCIx_MUX_IRQ] = {
1800                 .desc = "mux",
1801                 .handler = sci_mpxed_interrupt,
1802         },
1803 };
1804
1805 static int sci_request_irq(struct sci_port *port)
1806 {
1807         struct uart_port *up = &port->port;
1808         int i, j, ret = 0;
1809
1810         for (i = j = 0; i < SCIx_NR_IRQS; i++, j++) {
1811                 const struct sci_irq_desc *desc;
1812                 int irq;
1813
1814                 if (SCIx_IRQ_IS_MUXED(port)) {
1815                         i = SCIx_MUX_IRQ;
1816                         irq = up->irq;
1817                 } else {
1818                         irq = port->irqs[i];
1819
1820                         /*
1821                          * Certain port types won't support all of the
1822                          * available interrupt sources.
1823                          */
1824                         if (unlikely(irq < 0))
1825                                 continue;
1826                 }
1827
1828                 desc = sci_irq_desc + i;
1829                 port->irqstr[j] = kasprintf(GFP_KERNEL, "%s:%s",
1830                                             dev_name(up->dev), desc->desc);
1831                 if (!port->irqstr[j]) {
1832                         ret = -ENOMEM;
1833                         goto out_nomem;
1834                 }
1835
1836                 ret = request_irq(irq, desc->handler, up->irqflags,
1837                                   port->irqstr[j], port);
1838                 if (unlikely(ret)) {
1839                         dev_err(up->dev, "Can't allocate %s IRQ\n", desc->desc);
1840                         goto out_noirq;
1841                 }
1842         }
1843
1844         return 0;
1845
1846 out_noirq:
1847         while (--i >= 0)
1848                 free_irq(port->irqs[i], port);
1849
1850 out_nomem:
1851         while (--j >= 0)
1852                 kfree(port->irqstr[j]);
1853
1854         return ret;
1855 }
1856
1857 static void sci_free_irq(struct sci_port *port)
1858 {
1859         int i;
1860
1861         /*
1862          * Intentionally in reverse order so we iterate over the muxed
1863          * IRQ first.
1864          */
1865         for (i = 0; i < SCIx_NR_IRQS; i++) {
1866                 int irq = port->irqs[i];
1867
1868                 /*
1869                  * Certain port types won't support all of the available
1870                  * interrupt sources.
1871                  */
1872                 if (unlikely(irq < 0))
1873                         continue;
1874
1875                 free_irq(port->irqs[i], port);
1876                 kfree(port->irqstr[i]);
1877
1878                 if (SCIx_IRQ_IS_MUXED(port)) {
1879                         /* If there's only one IRQ, we're done. */
1880                         return;
1881                 }
1882         }
1883 }
1884
1885 static unsigned int sci_tx_empty(struct uart_port *port)
1886 {
1887         unsigned short status = serial_port_in(port, SCxSR);
1888         unsigned short in_tx_fifo = sci_txfill(port);
1889
1890         return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
1891 }
1892
1893 static void sci_set_rts(struct uart_port *port, bool state)
1894 {
1895         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1896                 u16 data = serial_port_in(port, SCPDR);
1897
1898                 /* Active low */
1899                 if (state)
1900                         data &= ~SCPDR_RTSD;
1901                 else
1902                         data |= SCPDR_RTSD;
1903                 serial_port_out(port, SCPDR, data);
1904
1905                 /* RTS# is output */
1906                 serial_port_out(port, SCPCR,
1907                                 serial_port_in(port, SCPCR) | SCPCR_RTSC);
1908         } else if (sci_getreg(port, SCSPTR)->size) {
1909                 u16 ctrl = serial_port_in(port, SCSPTR);
1910
1911                 /* Active low */
1912                 if (state)
1913                         ctrl &= ~SCSPTR_RTSDT;
1914                 else
1915                         ctrl |= SCSPTR_RTSDT;
1916                 serial_port_out(port, SCSPTR, ctrl);
1917         }
1918 }
1919
1920 static bool sci_get_cts(struct uart_port *port)
1921 {
1922         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1923                 /* Active low */
1924                 return !(serial_port_in(port, SCPDR) & SCPDR_CTSD);
1925         } else if (sci_getreg(port, SCSPTR)->size) {
1926                 /* Active low */
1927                 return !(serial_port_in(port, SCSPTR) & SCSPTR_CTSDT);
1928         }
1929
1930         return true;
1931 }
1932
1933 /*
1934  * Modem control is a bit of a mixed bag for SCI(F) ports. Generally
1935  * CTS/RTS is supported in hardware by at least one port and controlled
1936  * via SCSPTR (SCxPCR for SCIFA/B parts), or external pins (presently
1937  * handled via the ->init_pins() op, which is a bit of a one-way street,
1938  * lacking any ability to defer pin control -- this will later be
1939  * converted over to the GPIO framework).
1940  *
1941  * Other modes (such as loopback) are supported generically on certain
1942  * port types, but not others. For these it's sufficient to test for the
1943  * existence of the support register and simply ignore the port type.
1944  */
1945 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
1946 {
1947         struct sci_port *s = to_sci_port(port);
1948
1949         if (mctrl & TIOCM_LOOP) {
1950                 const struct plat_sci_reg *reg;
1951
1952                 /*
1953                  * Standard loopback mode for SCFCR ports.
1954                  */
1955                 reg = sci_getreg(port, SCFCR);
1956                 if (reg->size)
1957                         serial_port_out(port, SCFCR,
1958                                         serial_port_in(port, SCFCR) |
1959                                         SCFCR_LOOP);
1960         }
1961
1962         mctrl_gpio_set(s->gpios, mctrl);
1963
1964         if (!s->has_rtscts)
1965                 return;
1966
1967         if (!(mctrl & TIOCM_RTS)) {
1968                 /* Disable Auto RTS */
1969                 serial_port_out(port, SCFCR,
1970                                 serial_port_in(port, SCFCR) & ~SCFCR_MCE);
1971
1972                 /* Clear RTS */
1973                 sci_set_rts(port, 0);
1974         } else if (s->autorts) {
1975                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1976                         /* Enable RTS# pin function */
1977                         serial_port_out(port, SCPCR,
1978                                 serial_port_in(port, SCPCR) & ~SCPCR_RTSC);
1979                 }
1980
1981                 /* Enable Auto RTS */
1982                 serial_port_out(port, SCFCR,
1983                                 serial_port_in(port, SCFCR) | SCFCR_MCE);
1984         } else {
1985                 /* Set RTS */
1986                 sci_set_rts(port, 1);
1987         }
1988 }
1989
1990 static unsigned int sci_get_mctrl(struct uart_port *port)
1991 {
1992         struct sci_port *s = to_sci_port(port);
1993         struct mctrl_gpios *gpios = s->gpios;
1994         unsigned int mctrl = 0;
1995
1996         mctrl_gpio_get(gpios, &mctrl);
1997
1998         /*
1999          * CTS/RTS is handled in hardware when supported, while nothing
2000          * else is wired up.
2001          */
2002         if (s->autorts) {
2003                 if (sci_get_cts(port))
2004                         mctrl |= TIOCM_CTS;
2005         } else if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_CTS))) {
2006                 mctrl |= TIOCM_CTS;
2007         }
2008         if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_DSR)))
2009                 mctrl |= TIOCM_DSR;
2010         if (IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(gpios, UART_GPIO_DCD)))
2011                 mctrl |= TIOCM_CAR;
2012
2013         return mctrl;
2014 }
2015
2016 static void sci_enable_ms(struct uart_port *port)
2017 {
2018         mctrl_gpio_enable_ms(to_sci_port(port)->gpios);
2019 }
2020
2021 static void sci_break_ctl(struct uart_port *port, int break_state)
2022 {
2023         unsigned short scscr, scsptr;
2024         unsigned long flags;
2025
2026         /* check wheter the port has SCSPTR */
2027         if (!sci_getreg(port, SCSPTR)->size) {
2028                 /*
2029                  * Not supported by hardware. Most parts couple break and rx
2030                  * interrupts together, with break detection always enabled.
2031                  */
2032                 return;
2033         }
2034
2035         spin_lock_irqsave(&port->lock, flags);
2036         scsptr = serial_port_in(port, SCSPTR);
2037         scscr = serial_port_in(port, SCSCR);
2038
2039         if (break_state == -1) {
2040                 scsptr = (scsptr | SCSPTR_SPB2IO) & ~SCSPTR_SPB2DT;
2041                 scscr &= ~SCSCR_TE;
2042         } else {
2043                 scsptr = (scsptr | SCSPTR_SPB2DT) & ~SCSPTR_SPB2IO;
2044                 scscr |= SCSCR_TE;
2045         }
2046
2047         serial_port_out(port, SCSPTR, scsptr);
2048         serial_port_out(port, SCSCR, scscr);
2049         spin_unlock_irqrestore(&port->lock, flags);
2050 }
2051
2052 static int sci_startup(struct uart_port *port)
2053 {
2054         struct sci_port *s = to_sci_port(port);
2055         int ret;
2056
2057         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
2058
2059         sci_request_dma(port);
2060
2061         ret = sci_request_irq(s);
2062         if (unlikely(ret < 0)) {
2063                 sci_free_dma(port);
2064                 return ret;
2065         }
2066
2067         return 0;
2068 }
2069
2070 static void sci_shutdown(struct uart_port *port)
2071 {
2072         struct sci_port *s = to_sci_port(port);
2073         unsigned long flags;
2074         u16 scr;
2075
2076         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
2077
2078         s->autorts = false;
2079         mctrl_gpio_disable_ms(to_sci_port(port)->gpios);
2080
2081         spin_lock_irqsave(&port->lock, flags);
2082         sci_stop_rx(port);
2083         sci_stop_tx(port);
2084         /*
2085          * Stop RX and TX, disable related interrupts, keep clock source
2086          * and HSCIF TOT bits
2087          */
2088         scr = serial_port_in(port, SCSCR);
2089         serial_port_out(port, SCSCR, scr &
2090                         (SCSCR_CKE1 | SCSCR_CKE0 | s->hscif_tot));
2091         spin_unlock_irqrestore(&port->lock, flags);
2092
2093 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2094         if (s->chan_rx_saved) {
2095                 dev_dbg(port->dev, "%s(%d) deleting rx_timer\n", __func__,
2096                         port->line);
2097                 hrtimer_cancel(&s->rx_timer);
2098         }
2099 #endif
2100
2101         if (s->rx_trigger > 1 && s->rx_fifo_timeout > 0)
2102                 del_timer_sync(&s->rx_fifo_timer);
2103         sci_free_irq(s);
2104         sci_free_dma(port);
2105 }
2106
2107 static int sci_sck_calc(struct sci_port *s, unsigned int bps,
2108                         unsigned int *srr)
2109 {
2110         unsigned long freq = s->clk_rates[SCI_SCK];
2111         int err, min_err = INT_MAX;
2112         unsigned int sr;
2113
2114         if (s->port.type != PORT_HSCIF)
2115                 freq *= 2;
2116
2117         for_each_sr(sr, s) {
2118                 err = DIV_ROUND_CLOSEST(freq, sr) - bps;
2119                 if (abs(err) >= abs(min_err))
2120                         continue;
2121
2122                 min_err = err;
2123                 *srr = sr - 1;
2124
2125                 if (!err)
2126                         break;
2127         }
2128
2129         dev_dbg(s->port.dev, "SCK: %u%+d bps using SR %u\n", bps, min_err,
2130                 *srr + 1);
2131         return min_err;
2132 }
2133
2134 static int sci_brg_calc(struct sci_port *s, unsigned int bps,
2135                         unsigned long freq, unsigned int *dlr,
2136                         unsigned int *srr)
2137 {
2138         int err, min_err = INT_MAX;
2139         unsigned int sr, dl;
2140
2141         if (s->port.type != PORT_HSCIF)
2142                 freq *= 2;
2143
2144         for_each_sr(sr, s) {
2145                 dl = DIV_ROUND_CLOSEST(freq, sr * bps);
2146                 dl = clamp(dl, 1U, 65535U);
2147
2148                 err = DIV_ROUND_CLOSEST(freq, sr * dl) - bps;
2149                 if (abs(err) >= abs(min_err))
2150                         continue;
2151
2152                 min_err = err;
2153                 *dlr = dl;
2154                 *srr = sr - 1;
2155
2156                 if (!err)
2157                         break;
2158         }
2159
2160         dev_dbg(s->port.dev, "BRG: %u%+d bps using DL %u SR %u\n", bps,
2161                 min_err, *dlr, *srr + 1);
2162         return min_err;
2163 }
2164
2165 /* calculate sample rate, BRR, and clock select */
2166 static int sci_scbrr_calc(struct sci_port *s, unsigned int bps,
2167                           unsigned int *brr, unsigned int *srr,
2168                           unsigned int *cks)
2169 {
2170         unsigned long freq = s->clk_rates[SCI_FCK];
2171         unsigned int sr, br, prediv, scrate, c;
2172         int err, min_err = INT_MAX;
2173
2174         if (s->port.type != PORT_HSCIF)
2175                 freq *= 2;
2176
2177         /*
2178          * Find the combination of sample rate and clock select with the
2179          * smallest deviation from the desired baud rate.
2180          * Prefer high sample rates to maximise the receive margin.
2181          *
2182          * M: Receive margin (%)
2183          * N: Ratio of bit rate to clock (N = sampling rate)
2184          * D: Clock duty (D = 0 to 1.0)
2185          * L: Frame length (L = 9 to 12)
2186          * F: Absolute value of clock frequency deviation
2187          *
2188          *  M = |(0.5 - 1 / 2 * N) - ((L - 0.5) * F) -
2189          *      (|D - 0.5| / N * (1 + F))|
2190          *  NOTE: Usually, treat D for 0.5, F is 0 by this calculation.
2191          */
2192         for_each_sr(sr, s) {
2193                 for (c = 0; c <= 3; c++) {
2194                         /* integerized formulas from HSCIF documentation */
2195                         prediv = sr * (1 << (2 * c + 1));
2196
2197                         /*
2198                          * We need to calculate:
2199                          *
2200                          *     br = freq / (prediv * bps) clamped to [1..256]
2201                          *     err = freq / (br * prediv) - bps
2202                          *
2203                          * Watch out for overflow when calculating the desired
2204                          * sampling clock rate!
2205                          */
2206                         if (bps > UINT_MAX / prediv)
2207                                 break;
2208
2209                         scrate = prediv * bps;
2210                         br = DIV_ROUND_CLOSEST(freq, scrate);
2211                         br = clamp(br, 1U, 256U);
2212
2213                         err = DIV_ROUND_CLOSEST(freq, br * prediv) - bps;
2214                         if (abs(err) >= abs(min_err))
2215                                 continue;
2216
2217                         min_err = err;
2218                         *brr = br - 1;
2219                         *srr = sr - 1;
2220                         *cks = c;
2221
2222                         if (!err)
2223                                 goto found;
2224                 }
2225         }
2226
2227 found:
2228         dev_dbg(s->port.dev, "BRR: %u%+d bps using N %u SR %u cks %u\n", bps,
2229                 min_err, *brr, *srr + 1, *cks);
2230         return min_err;
2231 }
2232
2233 static void sci_reset(struct uart_port *port)
2234 {
2235         const struct plat_sci_reg *reg;
2236         unsigned int status;
2237         struct sci_port *s = to_sci_port(port);
2238
2239         serial_port_out(port, SCSCR, s->hscif_tot);     /* TE=0, RE=0, CKE1=0 */
2240
2241         reg = sci_getreg(port, SCFCR);
2242         if (reg->size)
2243                 serial_port_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
2244
2245         sci_clear_SCxSR(port,
2246                         SCxSR_RDxF_CLEAR(port) & SCxSR_ERROR_CLEAR(port) &
2247                         SCxSR_BREAK_CLEAR(port));
2248         if (sci_getreg(port, SCLSR)->size) {
2249                 status = serial_port_in(port, SCLSR);
2250                 status &= ~(SCLSR_TO | SCLSR_ORER);
2251                 serial_port_out(port, SCLSR, status);
2252         }
2253
2254         if (s->rx_trigger > 1) {
2255                 if (s->rx_fifo_timeout) {
2256                         scif_set_rtrg(port, 1);
2257                         timer_setup(&s->rx_fifo_timer, rx_fifo_timer_fn, 0);
2258                 } else {
2259                         if (port->type == PORT_SCIFA ||
2260                             port->type == PORT_SCIFB)
2261                                 scif_set_rtrg(port, 1);
2262                         else
2263                                 scif_set_rtrg(port, s->rx_trigger);
2264                 }
2265         }
2266 }
2267
2268 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
2269                             struct ktermios *old)
2270 {
2271         unsigned int baud, smr_val = SCSMR_ASYNC, scr_val = 0, i, bits;
2272         unsigned int brr = 255, cks = 0, srr = 15, dl = 0, sccks = 0;
2273         unsigned int brr1 = 255, cks1 = 0, srr1 = 15, dl1 = 0;
2274         struct sci_port *s = to_sci_port(port);
2275         const struct plat_sci_reg *reg;
2276         int min_err = INT_MAX, err;
2277         unsigned long max_freq = 0;
2278         int best_clk = -1;
2279         unsigned long flags;
2280
2281         if ((termios->c_cflag & CSIZE) == CS7)
2282                 smr_val |= SCSMR_CHR;
2283         if (termios->c_cflag & PARENB)
2284                 smr_val |= SCSMR_PE;
2285         if (termios->c_cflag & PARODD)
2286                 smr_val |= SCSMR_PE | SCSMR_ODD;
2287         if (termios->c_cflag & CSTOPB)
2288                 smr_val |= SCSMR_STOP;
2289
2290         /*
2291          * earlyprintk comes here early on with port->uartclk set to zero.
2292          * the clock framework is not up and running at this point so here
2293          * we assume that 115200 is the maximum baud rate. please note that
2294          * the baud rate is not programmed during earlyprintk - it is assumed
2295          * that the previous boot loader has enabled required clocks and
2296          * setup the baud rate generator hardware for us already.
2297          */
2298         if (!port->uartclk) {
2299                 baud = uart_get_baud_rate(port, termios, old, 0, 115200);
2300                 goto done;
2301         }
2302
2303         for (i = 0; i < SCI_NUM_CLKS; i++)
2304                 max_freq = max(max_freq, s->clk_rates[i]);
2305
2306         baud = uart_get_baud_rate(port, termios, old, 0, max_freq / min_sr(s));
2307         if (!baud)
2308                 goto done;
2309
2310         /*
2311          * There can be multiple sources for the sampling clock.  Find the one
2312          * that gives us the smallest deviation from the desired baud rate.
2313          */
2314
2315         /* Optional Undivided External Clock */
2316         if (s->clk_rates[SCI_SCK] && port->type != PORT_SCIFA &&
2317             port->type != PORT_SCIFB) {
2318                 err = sci_sck_calc(s, baud, &srr1);
2319                 if (abs(err) < abs(min_err)) {
2320                         best_clk = SCI_SCK;
2321                         scr_val = SCSCR_CKE1;
2322                         sccks = SCCKS_CKS;
2323                         min_err = err;
2324                         srr = srr1;
2325                         if (!err)
2326                                 goto done;
2327                 }
2328         }
2329
2330         /* Optional BRG Frequency Divided External Clock */
2331         if (s->clk_rates[SCI_SCIF_CLK] && sci_getreg(port, SCDL)->size) {
2332                 err = sci_brg_calc(s, baud, s->clk_rates[SCI_SCIF_CLK], &dl1,
2333                                    &srr1);
2334                 if (abs(err) < abs(min_err)) {
2335                         best_clk = SCI_SCIF_CLK;
2336                         scr_val = SCSCR_CKE1;
2337                         sccks = 0;
2338                         min_err = err;
2339                         dl = dl1;
2340                         srr = srr1;
2341                         if (!err)
2342                                 goto done;
2343                 }
2344         }
2345
2346         /* Optional BRG Frequency Divided Internal Clock */
2347         if (s->clk_rates[SCI_BRG_INT] && sci_getreg(port, SCDL)->size) {
2348                 err = sci_brg_calc(s, baud, s->clk_rates[SCI_BRG_INT], &dl1,
2349                                    &srr1);
2350                 if (abs(err) < abs(min_err)) {
2351                         best_clk = SCI_BRG_INT;
2352                         scr_val = SCSCR_CKE1;
2353                         sccks = SCCKS_XIN;
2354                         min_err = err;
2355                         dl = dl1;
2356                         srr = srr1;
2357                         if (!min_err)
2358                                 goto done;
2359                 }
2360         }
2361
2362         /* Divided Functional Clock using standard Bit Rate Register */
2363         err = sci_scbrr_calc(s, baud, &brr1, &srr1, &cks1);
2364         if (abs(err) < abs(min_err)) {
2365                 best_clk = SCI_FCK;
2366                 scr_val = 0;
2367                 min_err = err;
2368                 brr = brr1;
2369                 srr = srr1;
2370                 cks = cks1;
2371         }
2372
2373 done:
2374         if (best_clk >= 0)
2375                 dev_dbg(port->dev, "Using clk %pC for %u%+d bps\n",
2376                         s->clks[best_clk], baud, min_err);
2377
2378         sci_port_enable(s);
2379
2380         /*
2381          * Program the optional External Baud Rate Generator (BRG) first.
2382          * It controls the mux to select (H)SCK or frequency divided clock.
2383          */
2384         if (best_clk >= 0 && sci_getreg(port, SCCKS)->size) {
2385                 serial_port_out(port, SCDL, dl);
2386                 serial_port_out(port, SCCKS, sccks);
2387         }
2388
2389         spin_lock_irqsave(&port->lock, flags);
2390
2391         sci_reset(port);
2392
2393         uart_update_timeout(port, termios->c_cflag, baud);
2394
2395         /* byte size and parity */
2396         switch (termios->c_cflag & CSIZE) {
2397         case CS5:
2398                 bits = 7;
2399                 break;
2400         case CS6:
2401                 bits = 8;
2402                 break;
2403         case CS7:
2404                 bits = 9;
2405                 break;
2406         default:
2407                 bits = 10;
2408                 break;
2409         }
2410
2411         if (termios->c_cflag & CSTOPB)
2412                 bits++;
2413         if (termios->c_cflag & PARENB)
2414                 bits++;
2415
2416         if (best_clk >= 0) {
2417                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
2418                         switch (srr + 1) {
2419                         case 5:  smr_val |= SCSMR_SRC_5;  break;
2420                         case 7:  smr_val |= SCSMR_SRC_7;  break;
2421                         case 11: smr_val |= SCSMR_SRC_11; break;
2422                         case 13: smr_val |= SCSMR_SRC_13; break;
2423                         case 16: smr_val |= SCSMR_SRC_16; break;
2424                         case 17: smr_val |= SCSMR_SRC_17; break;
2425                         case 19: smr_val |= SCSMR_SRC_19; break;
2426                         case 27: smr_val |= SCSMR_SRC_27; break;
2427                         }
2428                 smr_val |= cks;
2429                 serial_port_out(port, SCSCR, scr_val | s->hscif_tot);
2430                 serial_port_out(port, SCSMR, smr_val);
2431                 serial_port_out(port, SCBRR, brr);
2432                 if (sci_getreg(port, HSSRR)->size) {
2433                         unsigned int hssrr = srr | HSCIF_SRE;
2434                         /* Calculate deviation from intended rate at the
2435                          * center of the last stop bit in sampling clocks.
2436                          */
2437                         int last_stop = bits * 2 - 1;
2438                         int deviation = min_err * srr * last_stop / 2 / baud;
2439
2440                         if (abs(deviation) >= 2) {
2441                                 /* At least two sampling clocks off at the
2442                                  * last stop bit; we can increase the error
2443                                  * margin by shifting the sampling point.
2444                                  */
2445                                 int shift = min(-8, max(7, deviation / 2));
2446
2447                                 hssrr |= (shift << HSCIF_SRHP_SHIFT) &
2448                                          HSCIF_SRHP_MASK;
2449                                 hssrr |= HSCIF_SRDE;
2450                         }
2451                         serial_port_out(port, HSSRR, hssrr);
2452                 }
2453
2454                 /* Wait one bit interval */
2455                 udelay((1000000 + (baud - 1)) / baud);
2456         } else {
2457                 /* Don't touch the bit rate configuration */
2458                 scr_val = s->cfg->scscr & (SCSCR_CKE1 | SCSCR_CKE0);
2459                 smr_val |= serial_port_in(port, SCSMR) &
2460                            (SCSMR_CKEDG | SCSMR_SRC_MASK | SCSMR_CKS);
2461                 serial_port_out(port, SCSCR, scr_val | s->hscif_tot);
2462                 serial_port_out(port, SCSMR, smr_val);
2463         }
2464
2465         sci_init_pins(port, termios->c_cflag);
2466
2467         port->status &= ~UPSTAT_AUTOCTS;
2468         s->autorts = false;
2469         reg = sci_getreg(port, SCFCR);
2470         if (reg->size) {
2471                 unsigned short ctrl = serial_port_in(port, SCFCR);
2472
2473                 if ((port->flags & UPF_HARD_FLOW) &&
2474                     (termios->c_cflag & CRTSCTS)) {
2475                         /* There is no CTS interrupt to restart the hardware */
2476                         port->status |= UPSTAT_AUTOCTS;
2477                         /* MCE is enabled when RTS is raised */
2478                         s->autorts = true;
2479                 }
2480
2481                 /*
2482                  * As we've done a sci_reset() above, ensure we don't
2483                  * interfere with the FIFOs while toggling MCE. As the
2484                  * reset values could still be set, simply mask them out.
2485                  */
2486                 ctrl &= ~(SCFCR_RFRST | SCFCR_TFRST);
2487
2488                 serial_port_out(port, SCFCR, ctrl);
2489         }
2490         if (port->flags & UPF_HARD_FLOW) {
2491                 /* Refresh (Auto) RTS */
2492                 sci_set_mctrl(port, port->mctrl);
2493         }
2494
2495         scr_val |= SCSCR_RE | SCSCR_TE |
2496                    (s->cfg->scscr & ~(SCSCR_CKE1 | SCSCR_CKE0));
2497         serial_port_out(port, SCSCR, scr_val | s->hscif_tot);
2498         if ((srr + 1 == 5) &&
2499             (port->type == PORT_SCIFA || port->type == PORT_SCIFB)) {
2500                 /*
2501                  * In asynchronous mode, when the sampling rate is 1/5, first
2502                  * received data may become invalid on some SCIFA and SCIFB.
2503                  * To avoid this problem wait more than 1 serial data time (1
2504                  * bit time x serial data number) after setting SCSCR.RE = 1.
2505                  */
2506                 udelay(DIV_ROUND_UP(10 * 1000000, baud));
2507         }
2508
2509         /*
2510          * Calculate delay for 2 DMA buffers (4 FIFO).
2511          * See serial_core.c::uart_update_timeout().
2512          * With 10 bits (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above
2513          * function calculates 1 jiffie for the data plus 5 jiffies for the
2514          * "slop(e)." Then below we calculate 5 jiffies (20ms) for 2 DMA
2515          * buffers (4 FIFO sizes), but when performing a faster transfer, the
2516          * value obtained by this formula is too small. Therefore, if the value
2517          * is smaller than 20ms, use 20ms as the timeout value for DMA.
2518          */
2519         s->rx_frame = (10000 * bits) / (baud / 100);
2520 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2521         s->rx_timeout = s->buf_len_rx * 2 * s->rx_frame;
2522         if (s->rx_timeout < 20)
2523                 s->rx_timeout = 20;
2524 #endif
2525
2526         if ((termios->c_cflag & CREAD) != 0)
2527                 sci_start_rx(port);
2528
2529         spin_unlock_irqrestore(&port->lock, flags);
2530
2531         sci_port_disable(s);
2532
2533         if (UART_ENABLE_MS(port, termios->c_cflag))
2534                 sci_enable_ms(port);
2535 }
2536
2537 static void sci_pm(struct uart_port *port, unsigned int state,
2538                    unsigned int oldstate)
2539 {
2540         struct sci_port *sci_port = to_sci_port(port);
2541
2542         switch (state) {
2543         case UART_PM_STATE_OFF:
2544                 sci_port_disable(sci_port);
2545                 break;
2546         default:
2547                 sci_port_enable(sci_port);
2548                 break;
2549         }
2550 }
2551
2552 static const char *sci_type(struct uart_port *port)
2553 {
2554         switch (port->type) {
2555         case PORT_IRDA:
2556                 return "irda";
2557         case PORT_SCI:
2558                 return "sci";
2559         case PORT_SCIF:
2560                 return "scif";
2561         case PORT_SCIFA:
2562                 return "scifa";
2563         case PORT_SCIFB:
2564                 return "scifb";
2565         case PORT_HSCIF:
2566                 return "hscif";
2567         }
2568
2569         return NULL;
2570 }
2571
2572 static int sci_remap_port(struct uart_port *port)
2573 {
2574         struct sci_port *sport = to_sci_port(port);
2575
2576         /*
2577          * Nothing to do if there's already an established membase.
2578          */
2579         if (port->membase)
2580                 return 0;
2581
2582         if (port->dev->of_node || (port->flags & UPF_IOREMAP)) {
2583                 port->membase = ioremap_nocache(port->mapbase, sport->reg_size);
2584                 if (unlikely(!port->membase)) {
2585                         dev_err(port->dev, "can't remap port#%d\n", port->line);
2586                         return -ENXIO;
2587                 }
2588         } else {
2589                 /*
2590                  * For the simple (and majority of) cases where we don't
2591                  * need to do any remapping, just cast the cookie
2592                  * directly.
2593                  */
2594                 port->membase = (void __iomem *)(uintptr_t)port->mapbase;
2595         }
2596
2597         return 0;
2598 }
2599
2600 static void sci_release_port(struct uart_port *port)
2601 {
2602         struct sci_port *sport = to_sci_port(port);
2603
2604         if (port->dev->of_node || (port->flags & UPF_IOREMAP)) {
2605                 iounmap(port->membase);
2606                 port->membase = NULL;
2607         }
2608
2609         release_mem_region(port->mapbase, sport->reg_size);
2610 }
2611
2612 static int sci_request_port(struct uart_port *port)
2613 {
2614         struct resource *res;
2615         struct sci_port *sport = to_sci_port(port);
2616         int ret;
2617
2618         res = request_mem_region(port->mapbase, sport->reg_size,
2619                                  dev_name(port->dev));
2620         if (unlikely(res == NULL)) {
2621                 dev_err(port->dev, "request_mem_region failed.");
2622                 return -EBUSY;
2623         }
2624
2625         ret = sci_remap_port(port);
2626         if (unlikely(ret != 0)) {
2627                 release_resource(res);
2628                 return ret;
2629         }
2630
2631         return 0;
2632 }
2633
2634 static void sci_config_port(struct uart_port *port, int flags)
2635 {
2636         if (flags & UART_CONFIG_TYPE) {
2637                 struct sci_port *sport = to_sci_port(port);
2638
2639                 port->type = sport->cfg->type;
2640                 sci_request_port(port);
2641         }
2642 }
2643
2644 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
2645 {
2646         if (ser->baud_base < 2400)
2647                 /* No paper tape reader for Mitch.. */
2648                 return -EINVAL;
2649
2650         return 0;
2651 }
2652
2653 static const struct uart_ops sci_uart_ops = {
2654         .tx_empty       = sci_tx_empty,
2655         .set_mctrl      = sci_set_mctrl,
2656         .get_mctrl      = sci_get_mctrl,
2657         .start_tx       = sci_start_tx,
2658         .stop_tx        = sci_stop_tx,
2659         .stop_rx        = sci_stop_rx,
2660         .enable_ms      = sci_enable_ms,
2661         .break_ctl      = sci_break_ctl,
2662         .startup        = sci_startup,
2663         .shutdown       = sci_shutdown,
2664         .flush_buffer   = sci_flush_buffer,
2665         .set_termios    = sci_set_termios,
2666         .pm             = sci_pm,
2667         .type           = sci_type,
2668         .release_port   = sci_release_port,
2669         .request_port   = sci_request_port,
2670         .config_port    = sci_config_port,
2671         .verify_port    = sci_verify_port,
2672 #ifdef CONFIG_CONSOLE_POLL
2673         .poll_get_char  = sci_poll_get_char,
2674         .poll_put_char  = sci_poll_put_char,
2675 #endif
2676 };
2677
2678 static int sci_init_clocks(struct sci_port *sci_port, struct device *dev)
2679 {
2680         const char *clk_names[] = {
2681                 [SCI_FCK] = "fck",
2682                 [SCI_SCK] = "sck",
2683                 [SCI_BRG_INT] = "brg_int",
2684                 [SCI_SCIF_CLK] = "scif_clk",
2685         };
2686         struct clk *clk;
2687         unsigned int i;
2688
2689         if (sci_port->cfg->type == PORT_HSCIF)
2690                 clk_names[SCI_SCK] = "hsck";
2691
2692         for (i = 0; i < SCI_NUM_CLKS; i++) {
2693                 clk = devm_clk_get(dev, clk_names[i]);
2694                 if (PTR_ERR(clk) == -EPROBE_DEFER)
2695                         return -EPROBE_DEFER;
2696
2697                 if (IS_ERR(clk) && i == SCI_FCK) {
2698                         /*
2699                          * "fck" used to be called "sci_ick", and we need to
2700                          * maintain DT backward compatibility.
2701                          */
2702                         clk = devm_clk_get(dev, "sci_ick");
2703                         if (PTR_ERR(clk) == -EPROBE_DEFER)
2704                                 return -EPROBE_DEFER;
2705
2706                         if (!IS_ERR(clk))
2707                                 goto found;
2708
2709                         /*
2710                          * Not all SH platforms declare a clock lookup entry
2711                          * for SCI devices, in which case we need to get the
2712                          * global "peripheral_clk" clock.
2713                          */
2714                         clk = devm_clk_get(dev, "peripheral_clk");
2715                         if (!IS_ERR(clk))
2716                                 goto found;
2717
2718                         dev_err(dev, "failed to get %s (%ld)\n", clk_names[i],
2719                                 PTR_ERR(clk));
2720                         return PTR_ERR(clk);
2721                 }
2722
2723 found:
2724                 if (IS_ERR(clk))
2725                         dev_dbg(dev, "failed to get %s (%ld)\n", clk_names[i],
2726                                 PTR_ERR(clk));
2727                 else
2728                         dev_dbg(dev, "clk %s is %pC rate %lu\n", clk_names[i],
2729                                 clk, clk_get_rate(clk));
2730                 sci_port->clks[i] = IS_ERR(clk) ? NULL : clk;
2731         }
2732         return 0;
2733 }
2734
2735 static const struct sci_port_params *
2736 sci_probe_regmap(const struct plat_sci_port *cfg)
2737 {
2738         unsigned int regtype;
2739
2740         if (cfg->regtype != SCIx_PROBE_REGTYPE)
2741                 return &sci_port_params[cfg->regtype];
2742
2743         switch (cfg->type) {
2744         case PORT_SCI:
2745                 regtype = SCIx_SCI_REGTYPE;
2746                 break;
2747         case PORT_IRDA:
2748                 regtype = SCIx_IRDA_REGTYPE;
2749                 break;
2750         case PORT_SCIFA:
2751                 regtype = SCIx_SCIFA_REGTYPE;
2752                 break;
2753         case PORT_SCIFB:
2754                 regtype = SCIx_SCIFB_REGTYPE;
2755                 break;
2756         case PORT_SCIF:
2757                 /*
2758                  * The SH-4 is a bit of a misnomer here, although that's
2759                  * where this particular port layout originated. This
2760                  * configuration (or some slight variation thereof)
2761                  * remains the dominant model for all SCIFs.
2762                  */
2763                 regtype = SCIx_SH4_SCIF_REGTYPE;
2764                 break;
2765         case PORT_HSCIF:
2766                 regtype = SCIx_HSCIF_REGTYPE;
2767                 break;
2768         default:
2769                 pr_err("Can't probe register map for given port\n");
2770                 return NULL;
2771         }
2772
2773         return &sci_port_params[regtype];
2774 }
2775
2776 static int sci_init_single(struct platform_device *dev,
2777                            struct sci_port *sci_port, unsigned int index,
2778                            const struct plat_sci_port *p, bool early)
2779 {
2780         struct uart_port *port = &sci_port->port;
2781         const struct resource *res;
2782         unsigned int i;
2783         int ret;
2784
2785         sci_port->cfg   = p;
2786
2787         port->ops       = &sci_uart_ops;
2788         port->iotype    = UPIO_MEM;
2789         port->line      = index;
2790
2791         res = platform_get_resource(dev, IORESOURCE_MEM, 0);
2792         if (res == NULL)
2793                 return -ENOMEM;
2794
2795         port->mapbase = res->start;
2796         sci_port->reg_size = resource_size(res);
2797
2798         for (i = 0; i < ARRAY_SIZE(sci_port->irqs); ++i)
2799                 sci_port->irqs[i] = platform_get_irq(dev, i);
2800
2801         /* The SCI generates several interrupts. They can be muxed together or
2802          * connected to different interrupt lines. In the muxed case only one
2803          * interrupt resource is specified. In the non-muxed case three or four
2804          * interrupt resources are specified, as the BRI interrupt is optional.
2805          */
2806         if (sci_port->irqs[0] < 0)
2807                 return -ENXIO;
2808
2809         if (sci_port->irqs[1] < 0) {
2810                 sci_port->irqs[1] = sci_port->irqs[0];
2811                 sci_port->irqs[2] = sci_port->irqs[0];
2812                 sci_port->irqs[3] = sci_port->irqs[0];
2813         }
2814
2815         sci_port->params = sci_probe_regmap(p);
2816         if (unlikely(sci_port->params == NULL))
2817                 return -EINVAL;
2818
2819         switch (p->type) {
2820         case PORT_SCIFB:
2821                 sci_port->rx_trigger = 48;
2822                 break;
2823         case PORT_HSCIF:
2824                 sci_port->rx_trigger = 64;
2825                 break;
2826         case PORT_SCIFA:
2827                 sci_port->rx_trigger = 32;
2828                 break;
2829         case PORT_SCIF:
2830                 if (p->regtype == SCIx_SH7705_SCIF_REGTYPE)
2831                         /* RX triggering not implemented for this IP */
2832                         sci_port->rx_trigger = 1;
2833                 else
2834                         sci_port->rx_trigger = 8;
2835                 break;
2836         default:
2837                 sci_port->rx_trigger = 1;
2838                 break;
2839         }
2840
2841         sci_port->rx_fifo_timeout = 0;
2842         sci_port->hscif_tot = 0;
2843
2844         /* SCIFA on sh7723 and sh7724 need a custom sampling rate that doesn't
2845          * match the SoC datasheet, this should be investigated. Let platform
2846          * data override the sampling rate for now.
2847          */
2848         sci_port->sampling_rate_mask = p->sampling_rate
2849                                      ? SCI_SR(p->sampling_rate)
2850                                      : sci_port->params->sampling_rate_mask;
2851
2852         if (!early) {
2853                 ret = sci_init_clocks(sci_port, &dev->dev);
2854                 if (ret < 0)
2855                         return ret;
2856
2857                 port->dev = &dev->dev;
2858
2859                 pm_runtime_enable(&dev->dev);
2860         }
2861
2862         port->type              = p->type;
2863         port->flags             = UPF_FIXED_PORT | UPF_BOOT_AUTOCONF | p->flags;
2864         port->fifosize          = sci_port->params->fifosize;
2865
2866         if (port->type == PORT_SCI) {
2867                 if (sci_port->reg_size >= 0x20)
2868                         port->regshift = 2;
2869                 else
2870                         port->regshift = 1;
2871         }
2872
2873         /*
2874          * The UART port needs an IRQ value, so we peg this to the RX IRQ
2875          * for the multi-IRQ ports, which is where we are primarily
2876          * concerned with the shutdown path synchronization.
2877          *
2878          * For the muxed case there's nothing more to do.
2879          */
2880         port->irq               = sci_port->irqs[SCIx_RXI_IRQ];
2881         port->irqflags          = 0;
2882
2883         port->serial_in         = sci_serial_in;
2884         port->serial_out        = sci_serial_out;
2885
2886         return 0;
2887 }
2888
2889 static void sci_cleanup_single(struct sci_port *port)
2890 {
2891         pm_runtime_disable(port->port.dev);
2892 }
2893
2894 #if defined(CONFIG_SERIAL_SH_SCI_CONSOLE) || \
2895     defined(CONFIG_SERIAL_SH_SCI_EARLYCON)
2896 static void serial_console_putchar(struct uart_port *port, int ch)
2897 {
2898         sci_poll_put_char(port, ch);
2899 }
2900
2901 /*
2902  *      Print a string to the serial port trying not to disturb
2903  *      any possible real use of the port...
2904  */
2905 static void serial_console_write(struct console *co, const char *s,
2906                                  unsigned count)
2907 {
2908         struct sci_port *sci_port = &sci_ports[co->index];
2909         struct uart_port *port = &sci_port->port;
2910         unsigned short bits, ctrl, ctrl_temp;
2911         unsigned long flags;
2912         int locked = 1;
2913
2914 #if defined(SUPPORT_SYSRQ)
2915         if (port->sysrq)
2916                 locked = 0;
2917         else
2918 #endif
2919         if (oops_in_progress)
2920                 locked = spin_trylock_irqsave(&port->lock, flags);
2921         else
2922                 spin_lock_irqsave(&port->lock, flags);
2923
2924         /* first save SCSCR then disable interrupts, keep clock source */
2925         ctrl = serial_port_in(port, SCSCR);
2926         ctrl_temp = SCSCR_RE | SCSCR_TE |
2927                     (sci_port->cfg->scscr & ~(SCSCR_CKE1 | SCSCR_CKE0)) |
2928                     (ctrl & (SCSCR_CKE1 | SCSCR_CKE0));
2929         serial_port_out(port, SCSCR, ctrl_temp | sci_port->hscif_tot);
2930
2931         uart_console_write(port, s, count, serial_console_putchar);
2932
2933         /* wait until fifo is empty and last bit has been transmitted */
2934         bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
2935         while ((serial_port_in(port, SCxSR) & bits) != bits)
2936                 cpu_relax();
2937
2938         /* restore the SCSCR */
2939         serial_port_out(port, SCSCR, ctrl);
2940
2941         if (locked)
2942                 spin_unlock_irqrestore(&port->lock, flags);
2943 }
2944
2945 static int serial_console_setup(struct console *co, char *options)
2946 {
2947         struct sci_port *sci_port;
2948         struct uart_port *port;
2949         int baud = 115200;
2950         int bits = 8;
2951         int parity = 'n';
2952         int flow = 'n';
2953         int ret;
2954
2955         /*
2956          * Refuse to handle any bogus ports.
2957          */
2958         if (co->index < 0 || co->index >= SCI_NPORTS)
2959                 return -ENODEV;
2960
2961         sci_port = &sci_ports[co->index];
2962         port = &sci_port->port;
2963
2964         /*
2965          * Refuse to handle uninitialized ports.
2966          */
2967         if (!port->ops)
2968                 return -ENODEV;
2969
2970         ret = sci_remap_port(port);
2971         if (unlikely(ret != 0))
2972                 return ret;
2973
2974         if (options)
2975                 uart_parse_options(options, &baud, &parity, &bits, &flow);
2976
2977         return uart_set_options(port, co, baud, parity, bits, flow);
2978 }
2979
2980 static struct console serial_console = {
2981         .name           = "ttySC",
2982         .device         = uart_console_device,
2983         .write          = serial_console_write,
2984         .setup          = serial_console_setup,
2985         .flags          = CON_PRINTBUFFER,
2986         .index          = -1,
2987         .data           = &sci_uart_driver,
2988 };
2989
2990 static struct console early_serial_console = {
2991         .name           = "early_ttySC",
2992         .write          = serial_console_write,
2993         .flags          = CON_PRINTBUFFER,
2994         .index          = -1,
2995 };
2996
2997 static char early_serial_buf[32];
2998
2999 static int sci_probe_earlyprintk(struct platform_device *pdev)
3000 {
3001         const struct plat_sci_port *cfg = dev_get_platdata(&pdev->dev);
3002
3003         if (early_serial_console.data)
3004                 return -EEXIST;
3005
3006         early_serial_console.index = pdev->id;
3007
3008         sci_init_single(pdev, &sci_ports[pdev->id], pdev->id, cfg, true);
3009
3010         serial_console_setup(&early_serial_console, early_serial_buf);
3011
3012         if (!strstr(early_serial_buf, "keep"))
3013                 early_serial_console.flags |= CON_BOOT;
3014
3015         register_console(&early_serial_console);
3016         return 0;
3017 }
3018
3019 #define SCI_CONSOLE     (&serial_console)
3020
3021 #else
3022 static inline int sci_probe_earlyprintk(struct platform_device *pdev)
3023 {
3024         return -EINVAL;
3025 }
3026
3027 #define SCI_CONSOLE     NULL
3028
3029 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE || CONFIG_SERIAL_SH_SCI_EARLYCON */
3030
3031 static const char banner[] __initconst = "SuperH (H)SCI(F) driver initialized";
3032
3033 static DEFINE_MUTEX(sci_uart_registration_lock);
3034 static struct uart_driver sci_uart_driver = {
3035         .owner          = THIS_MODULE,
3036         .driver_name    = "sci",
3037         .dev_name       = "ttySC",
3038         .major          = SCI_MAJOR,
3039         .minor          = SCI_MINOR_START,
3040         .nr             = SCI_NPORTS,
3041         .cons           = SCI_CONSOLE,
3042 };
3043
3044 static int sci_remove(struct platform_device *dev)
3045 {
3046         struct sci_port *port = platform_get_drvdata(dev);
3047
3048         sci_ports_in_use &= ~BIT(port->port.line);
3049         uart_remove_one_port(&sci_uart_driver, &port->port);
3050
3051         sci_cleanup_single(port);
3052
3053         if (port->port.fifosize > 1) {
3054                 sysfs_remove_file(&dev->dev.kobj,
3055                                   &dev_attr_rx_fifo_trigger.attr);
3056         }
3057         if (port->port.type == PORT_SCIFA || port->port.type == PORT_SCIFB ||
3058             port->port.type == PORT_HSCIF) {
3059                 sysfs_remove_file(&dev->dev.kobj,
3060                                   &dev_attr_rx_fifo_timeout.attr);
3061         }
3062
3063         return 0;
3064 }
3065
3066
3067 #define SCI_OF_DATA(type, regtype)      (void *)((type) << 16 | (regtype))
3068 #define SCI_OF_TYPE(data)               ((unsigned long)(data) >> 16)
3069 #define SCI_OF_REGTYPE(data)            ((unsigned long)(data) & 0xffff)
3070
3071 static const struct of_device_id of_sci_match[] = {
3072         /* SoC-specific types */
3073         {
3074                 .compatible = "renesas,scif-r7s72100",
3075                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH2_SCIF_FIFODATA_REGTYPE),
3076         },
3077         /* Family-specific types */
3078         {
3079                 .compatible = "renesas,rcar-gen1-scif",
3080                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3081         }, {
3082                 .compatible = "renesas,rcar-gen2-scif",
3083                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3084         }, {
3085                 .compatible = "renesas,rcar-gen3-scif",
3086                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_BRG_REGTYPE),
3087         },
3088         /* Generic types */
3089         {
3090                 .compatible = "renesas,scif",
3091                 .data = SCI_OF_DATA(PORT_SCIF, SCIx_SH4_SCIF_REGTYPE),
3092         }, {
3093                 .compatible = "renesas,scifa",
3094                 .data = SCI_OF_DATA(PORT_SCIFA, SCIx_SCIFA_REGTYPE),
3095         }, {
3096                 .compatible = "renesas,scifb",
3097                 .data = SCI_OF_DATA(PORT_SCIFB, SCIx_SCIFB_REGTYPE),
3098         }, {
3099                 .compatible = "renesas,hscif",
3100                 .data = SCI_OF_DATA(PORT_HSCIF, SCIx_HSCIF_REGTYPE),
3101         }, {
3102                 .compatible = "renesas,sci",
3103                 .data = SCI_OF_DATA(PORT_SCI, SCIx_SCI_REGTYPE),
3104         }, {
3105                 /* Terminator */
3106         },
3107 };
3108 MODULE_DEVICE_TABLE(of, of_sci_match);
3109
3110 static struct plat_sci_port *sci_parse_dt(struct platform_device *pdev,
3111                                           unsigned int *dev_id)
3112 {
3113         struct device_node *np = pdev->dev.of_node;
3114         struct plat_sci_port *p;
3115         struct sci_port *sp;
3116         const void *data;
3117         int id;
3118
3119         if (!IS_ENABLED(CONFIG_OF) || !np)
3120                 return NULL;
3121
3122         data = of_device_get_match_data(&pdev->dev);
3123
3124         p = devm_kzalloc(&pdev->dev, sizeof(struct plat_sci_port), GFP_KERNEL);
3125         if (!p)
3126                 return NULL;
3127
3128         /* Get the line number from the aliases node. */
3129         id = of_alias_get_id(np, "serial");
3130         if (id < 0 && ~sci_ports_in_use)
3131                 id = ffz(sci_ports_in_use);
3132         if (id < 0) {
3133                 dev_err(&pdev->dev, "failed to get alias id (%d)\n", id);
3134                 return NULL;
3135         }
3136         if (id >= ARRAY_SIZE(sci_ports)) {
3137                 dev_err(&pdev->dev, "serial%d out of range\n", id);
3138                 return NULL;
3139         }
3140
3141         sp = &sci_ports[id];
3142         *dev_id = id;
3143
3144         p->type = SCI_OF_TYPE(data);
3145         p->regtype = SCI_OF_REGTYPE(data);
3146
3147         sp->has_rtscts = of_property_read_bool(np, "uart-has-rtscts");
3148
3149         return p;
3150 }
3151
3152 static int sci_probe_single(struct platform_device *dev,
3153                                       unsigned int index,
3154                                       struct plat_sci_port *p,
3155                                       struct sci_port *sciport)
3156 {
3157         int ret;
3158
3159         /* Sanity check */
3160         if (unlikely(index >= SCI_NPORTS)) {
3161                 dev_notice(&dev->dev, "Attempting to register port %d when only %d are available\n",
3162                            index+1, SCI_NPORTS);
3163                 dev_notice(&dev->dev, "Consider bumping CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
3164                 return -EINVAL;
3165         }
3166         BUILD_BUG_ON(SCI_NPORTS > sizeof(sci_ports_in_use) * 8);
3167         if (sci_ports_in_use & BIT(index))
3168                 return -EBUSY;
3169
3170         mutex_lock(&sci_uart_registration_lock);
3171         if (!sci_uart_driver.state) {
3172                 ret = uart_register_driver(&sci_uart_driver);
3173                 if (ret) {
3174                         mutex_unlock(&sci_uart_registration_lock);
3175                         return ret;
3176                 }
3177         }
3178         mutex_unlock(&sci_uart_registration_lock);
3179
3180         ret = sci_init_single(dev, sciport, index, p, false);
3181         if (ret)
3182                 return ret;
3183
3184         sciport->gpios = mctrl_gpio_init(&sciport->port, 0);
3185         if (IS_ERR(sciport->gpios) && PTR_ERR(sciport->gpios) != -ENOSYS)
3186                 return PTR_ERR(sciport->gpios);
3187
3188         if (sciport->has_rtscts) {
3189                 if (!IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(sciport->gpios,
3190                                                         UART_GPIO_CTS)) ||
3191                     !IS_ERR_OR_NULL(mctrl_gpio_to_gpiod(sciport->gpios,
3192                                                         UART_GPIO_RTS))) {
3193                         dev_err(&dev->dev, "Conflicting RTS/CTS config\n");
3194                         return -EINVAL;
3195                 }
3196                 sciport->port.flags |= UPF_HARD_FLOW;
3197         }
3198
3199         ret = uart_add_one_port(&sci_uart_driver, &sciport->port);
3200         if (ret) {
3201                 sci_cleanup_single(sciport);
3202                 return ret;
3203         }
3204
3205         return 0;
3206 }
3207
3208 static int sci_probe(struct platform_device *dev)
3209 {
3210         struct plat_sci_port *p;
3211         struct sci_port *sp;
3212         unsigned int dev_id;
3213         int ret;
3214
3215         /*
3216          * If we've come here via earlyprintk initialization, head off to
3217          * the special early probe. We don't have sufficient device state
3218          * to make it beyond this yet.
3219          */
3220         if (is_early_platform_device(dev))
3221                 return sci_probe_earlyprintk(dev);
3222
3223         if (dev->dev.of_node) {
3224                 p = sci_parse_dt(dev, &dev_id);
3225                 if (p == NULL)
3226                         return -EINVAL;
3227         } else {
3228                 p = dev->dev.platform_data;
3229                 if (p == NULL) {
3230                         dev_err(&dev->dev, "no platform data supplied\n");
3231                         return -EINVAL;
3232                 }
3233
3234                 dev_id = dev->id;
3235         }
3236
3237         sp = &sci_ports[dev_id];
3238         platform_set_drvdata(dev, sp);
3239
3240         ret = sci_probe_single(dev, dev_id, p, sp);
3241         if (ret)
3242                 return ret;
3243
3244         if (sp->port.fifosize > 1) {
3245                 ret = sysfs_create_file(&dev->dev.kobj,
3246                                 &dev_attr_rx_fifo_trigger.attr);
3247                 if (ret)
3248                         return ret;
3249         }
3250         if (sp->port.type == PORT_SCIFA || sp->port.type == PORT_SCIFB ||
3251             sp->port.type == PORT_HSCIF) {
3252                 ret = sysfs_create_file(&dev->dev.kobj,
3253                                 &dev_attr_rx_fifo_timeout.attr);
3254                 if (ret) {
3255                         if (sp->port.fifosize > 1) {
3256                                 sysfs_remove_file(&dev->dev.kobj,
3257                                         &dev_attr_rx_fifo_trigger.attr);
3258                         }
3259                         return ret;
3260                 }
3261         }
3262
3263 #ifdef CONFIG_SH_STANDARD_BIOS
3264         sh_bios_gdb_detach();
3265 #endif
3266
3267         sci_ports_in_use |= BIT(dev_id);
3268         return 0;
3269 }
3270
3271 static __maybe_unused int sci_suspend(struct device *dev)
3272 {
3273         struct sci_port *sport = dev_get_drvdata(dev);
3274
3275         if (sport)
3276                 uart_suspend_port(&sci_uart_driver, &sport->port);
3277
3278         return 0;
3279 }
3280
3281 static __maybe_unused int sci_resume(struct device *dev)
3282 {
3283         struct sci_port *sport = dev_get_drvdata(dev);
3284
3285         if (sport)
3286                 uart_resume_port(&sci_uart_driver, &sport->port);
3287
3288         return 0;
3289 }
3290
3291 static SIMPLE_DEV_PM_OPS(sci_dev_pm_ops, sci_suspend, sci_resume);
3292
3293 static struct platform_driver sci_driver = {
3294         .probe          = sci_probe,
3295         .remove         = sci_remove,
3296         .driver         = {
3297                 .name   = "sh-sci",
3298                 .pm     = &sci_dev_pm_ops,
3299                 .of_match_table = of_match_ptr(of_sci_match),
3300         },
3301 };
3302
3303 static int __init sci_init(void)
3304 {
3305         pr_info("%s\n", banner);
3306
3307         return platform_driver_register(&sci_driver);
3308 }
3309
3310 static void __exit sci_exit(void)
3311 {
3312         platform_driver_unregister(&sci_driver);
3313
3314         if (sci_uart_driver.state)
3315                 uart_unregister_driver(&sci_uart_driver);
3316 }
3317
3318 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
3319 early_platform_init_buffer("earlyprintk", &sci_driver,
3320                            early_serial_buf, ARRAY_SIZE(early_serial_buf));
3321 #endif
3322 #ifdef CONFIG_SERIAL_SH_SCI_EARLYCON
3323 static struct plat_sci_port port_cfg __initdata;
3324
3325 static int __init early_console_setup(struct earlycon_device *device,
3326                                       int type)
3327 {
3328         if (!device->port.membase)
3329                 return -ENODEV;
3330
3331         device->port.serial_in = sci_serial_in;
3332         device->port.serial_out = sci_serial_out;
3333         device->port.type = type;
3334         memcpy(&sci_ports[0].port, &device->port, sizeof(struct uart_port));
3335         port_cfg.type = type;
3336         sci_ports[0].cfg = &port_cfg;
3337         sci_ports[0].params = sci_probe_regmap(&port_cfg);
3338         port_cfg.scscr = sci_serial_in(&sci_ports[0].port, SCSCR);
3339         sci_serial_out(&sci_ports[0].port, SCSCR,
3340                        SCSCR_RE | SCSCR_TE | port_cfg.scscr);
3341
3342         device->con->write = serial_console_write;
3343         return 0;
3344 }
3345 static int __init sci_early_console_setup(struct earlycon_device *device,
3346                                           const char *opt)
3347 {
3348         return early_console_setup(device, PORT_SCI);
3349 }
3350 static int __init scif_early_console_setup(struct earlycon_device *device,
3351                                           const char *opt)
3352 {
3353         return early_console_setup(device, PORT_SCIF);
3354 }
3355 static int __init scifa_early_console_setup(struct earlycon_device *device,
3356                                           const char *opt)
3357 {
3358         return early_console_setup(device, PORT_SCIFA);
3359 }
3360 static int __init scifb_early_console_setup(struct earlycon_device *device,
3361                                           const char *opt)
3362 {
3363         return early_console_setup(device, PORT_SCIFB);
3364 }
3365 static int __init hscif_early_console_setup(struct earlycon_device *device,
3366                                           const char *opt)
3367 {
3368         return early_console_setup(device, PORT_HSCIF);
3369 }
3370
3371 OF_EARLYCON_DECLARE(sci, "renesas,sci", sci_early_console_setup);
3372 OF_EARLYCON_DECLARE(scif, "renesas,scif", scif_early_console_setup);
3373 OF_EARLYCON_DECLARE(scifa, "renesas,scifa", scifa_early_console_setup);
3374 OF_EARLYCON_DECLARE(scifb, "renesas,scifb", scifb_early_console_setup);
3375 OF_EARLYCON_DECLARE(hscif, "renesas,hscif", hscif_early_console_setup);
3376 #endif /* CONFIG_SERIAL_SH_SCI_EARLYCON */
3377
3378 module_init(sci_init);
3379 module_exit(sci_exit);
3380
3381 MODULE_LICENSE("GPL");
3382 MODULE_ALIAS("platform:sh-sci");
3383 MODULE_AUTHOR("Paul Mundt");
3384 MODULE_DESCRIPTION("SuperH (H)SCI(F) serial driver");