drivers/tty/serial/sh-sci.c

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