drivers/tty/serial/sh-sci.c

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