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