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