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
1084         return ret;
1085 }
1086
1087 /*
1088  * Here we define a transition notifier so that we can update all of our
1089  * ports' baud rate when the peripheral clock changes.
1090  */
1091 static int sci_notifier(struct notifier_block *self,
1092                         unsigned long phase, void *p)
1093 {
1094         struct sci_port *sci_port;
1095         unsigned long flags;
1096
1097         sci_port = container_of(self, struct sci_port, freq_transition);
1098
1099         if (phase == CPUFREQ_POSTCHANGE) {
1100                 struct uart_port *port = &sci_port->port;
1101
1102                 spin_lock_irqsave(&port->lock, flags);
1103                 port->uartclk = clk_get_rate(sci_port->iclk);
1104                 spin_unlock_irqrestore(&port->lock, flags);
1105         }
1106
1107         return NOTIFY_OK;
1108 }
1109
1110 static const struct sci_irq_desc {
1111         const char      *desc;
1112         irq_handler_t   handler;
1113 } sci_irq_desc[] = {
1114         /*
1115          * Split out handlers, the default case.
1116          */
1117         [SCIx_ERI_IRQ] = {
1118                 .desc = "rx err",
1119                 .handler = sci_er_interrupt,
1120         },
1121
1122         [SCIx_RXI_IRQ] = {
1123                 .desc = "rx full",
1124                 .handler = sci_rx_interrupt,
1125         },
1126
1127         [SCIx_TXI_IRQ] = {
1128                 .desc = "tx empty",
1129                 .handler = sci_tx_interrupt,
1130         },
1131
1132         [SCIx_BRI_IRQ] = {
1133                 .desc = "break",
1134                 .handler = sci_br_interrupt,
1135         },
1136
1137         /*
1138          * Special muxed handler.
1139          */
1140         [SCIx_MUX_IRQ] = {
1141                 .desc = "mux",
1142                 .handler = sci_mpxed_interrupt,
1143         },
1144 };
1145
1146 static int sci_request_irq(struct sci_port *port)
1147 {
1148         struct uart_port *up = &port->port;
1149         int i, j, ret = 0;
1150
1151         for (i = j = 0; i < SCIx_NR_IRQS; i++, j++) {
1152                 const struct sci_irq_desc *desc;
1153                 int irq;
1154
1155                 if (SCIx_IRQ_IS_MUXED(port)) {
1156                         i = SCIx_MUX_IRQ;
1157                         irq = up->irq;
1158                 } else {
1159                         irq = port->irqs[i];
1160
1161                         /*
1162                          * Certain port types won't support all of the
1163                          * available interrupt sources.
1164                          */
1165                         if (unlikely(irq < 0))
1166                                 continue;
1167                 }
1168
1169                 desc = sci_irq_desc + i;
1170                 port->irqstr[j] = kasprintf(GFP_KERNEL, "%s:%s",
1171                                             dev_name(up->dev), desc->desc);
1172                 if (!port->irqstr[j])
1173                         goto out_nomem;
1174
1175                 ret = request_irq(irq, desc->handler, up->irqflags,
1176                                   port->irqstr[j], port);
1177                 if (unlikely(ret)) {
1178                         dev_err(up->dev, "Can't allocate %s IRQ\n", desc->desc);
1179                         goto out_noirq;
1180                 }
1181         }
1182
1183         return 0;
1184
1185 out_noirq:
1186         while (--i >= 0)
1187                 free_irq(port->irqs[i], port);
1188
1189 out_nomem:
1190         while (--j >= 0)
1191                 kfree(port->irqstr[j]);
1192
1193         return ret;
1194 }
1195
1196 static void sci_free_irq(struct sci_port *port)
1197 {
1198         int i;
1199
1200         /*
1201          * Intentionally in reverse order so we iterate over the muxed
1202          * IRQ first.
1203          */
1204         for (i = 0; i < SCIx_NR_IRQS; i++) {
1205                 int irq = port->irqs[i];
1206
1207                 /*
1208                  * Certain port types won't support all of the available
1209                  * interrupt sources.
1210                  */
1211                 if (unlikely(irq < 0))
1212                         continue;
1213
1214                 free_irq(port->irqs[i], port);
1215                 kfree(port->irqstr[i]);
1216
1217                 if (SCIx_IRQ_IS_MUXED(port)) {
1218                         /* If there's only one IRQ, we're done. */
1219                         return;
1220                 }
1221         }
1222 }
1223
1224 static unsigned int sci_tx_empty(struct uart_port *port)
1225 {
1226         unsigned short status = serial_port_in(port, SCxSR);
1227         unsigned short in_tx_fifo = sci_txfill(port);
1228
1229         return (status & SCxSR_TEND(port)) && !in_tx_fifo ? TIOCSER_TEMT : 0;
1230 }
1231
1232 /*
1233  * Modem control is a bit of a mixed bag for SCI(F) ports. Generally
1234  * CTS/RTS is supported in hardware by at least one port and controlled
1235  * via SCSPTR (SCxPCR for SCIFA/B parts), or external pins (presently
1236  * handled via the ->init_pins() op, which is a bit of a one-way street,
1237  * lacking any ability to defer pin control -- this will later be
1238  * converted over to the GPIO framework).
1239  *
1240  * Other modes (such as loopback) are supported generically on certain
1241  * port types, but not others. For these it's sufficient to test for the
1242  * existence of the support register and simply ignore the port type.
1243  */
1244 static void sci_set_mctrl(struct uart_port *port, unsigned int mctrl)
1245 {
1246         if (mctrl & TIOCM_LOOP) {
1247                 const struct plat_sci_reg *reg;
1248
1249                 /*
1250                  * Standard loopback mode for SCFCR ports.
1251                  */
1252                 reg = sci_getreg(port, SCFCR);
1253                 if (reg->size)
1254                         serial_port_out(port, SCFCR,
1255                                         serial_port_in(port, SCFCR) |
1256                                         SCFCR_LOOP);
1257         }
1258 }
1259
1260 static unsigned int sci_get_mctrl(struct uart_port *port)
1261 {
1262         /*
1263          * CTS/RTS is handled in hardware when supported, while nothing
1264          * else is wired up. Keep it simple and simply assert DSR/CAR.
1265          */
1266         return TIOCM_DSR | TIOCM_CAR;
1267 }
1268
1269 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1270 static void sci_dma_tx_complete(void *arg)
1271 {
1272         struct sci_port *s = arg;
1273         struct uart_port *port = &s->port;
1274         struct circ_buf *xmit = &port->state->xmit;
1275         unsigned long flags;
1276
1277         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1278
1279         spin_lock_irqsave(&port->lock, flags);
1280
1281         xmit->tail += sg_dma_len(&s->sg_tx);
1282         xmit->tail &= UART_XMIT_SIZE - 1;
1283
1284         port->icount.tx += sg_dma_len(&s->sg_tx);
1285
1286         async_tx_ack(s->desc_tx);
1287         s->desc_tx = NULL;
1288
1289         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1290                 uart_write_wakeup(port);
1291
1292         if (!uart_circ_empty(xmit)) {
1293                 s->cookie_tx = 0;
1294                 schedule_work(&s->work_tx);
1295         } else {
1296                 s->cookie_tx = -EINVAL;
1297                 if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1298                         u16 ctrl = serial_port_in(port, SCSCR);
1299                         serial_port_out(port, SCSCR, ctrl & ~SCSCR_TIE);
1300                 }
1301         }
1302
1303         spin_unlock_irqrestore(&port->lock, flags);
1304 }
1305
1306 /* Locking: called with port lock held */
1307 static int sci_dma_rx_push(struct sci_port *s, size_t count)
1308 {
1309         struct uart_port *port = &s->port;
1310         struct tty_port *tport = &port->state->port;
1311         int i, active, room;
1312
1313         room = tty_buffer_request_room(tport, count);
1314
1315         if (s->active_rx == s->cookie_rx[0]) {
1316                 active = 0;
1317         } else if (s->active_rx == s->cookie_rx[1]) {
1318                 active = 1;
1319         } else {
1320                 dev_err(port->dev, "cookie %d not found!\n", s->active_rx);
1321                 return 0;
1322         }
1323
1324         if (room < count)
1325                 dev_warn(port->dev, "Rx overrun: dropping %zu bytes\n",
1326                          count - room);
1327         if (!room)
1328                 return room;
1329
1330         for (i = 0; i < room; i++)
1331                 tty_insert_flip_char(tport, ((u8 *)sg_virt(&s->sg_rx[active]))[i],
1332                                      TTY_NORMAL);
1333
1334         port->icount.rx += room;
1335
1336         return room;
1337 }
1338
1339 static void sci_dma_rx_complete(void *arg)
1340 {
1341         struct sci_port *s = arg;
1342         struct uart_port *port = &s->port;
1343         unsigned long flags;
1344         int count;
1345
1346         dev_dbg(port->dev, "%s(%d) active #%d\n",
1347                 __func__, port->line, s->active_rx);
1348
1349         spin_lock_irqsave(&port->lock, flags);
1350
1351         count = sci_dma_rx_push(s, s->buf_len_rx);
1352
1353         mod_timer(&s->rx_timer, jiffies + s->rx_timeout);
1354
1355         spin_unlock_irqrestore(&port->lock, flags);
1356
1357         if (count)
1358                 tty_flip_buffer_push(&port->state->port);
1359
1360         schedule_work(&s->work_rx);
1361 }
1362
1363 static void sci_rx_dma_release(struct sci_port *s, bool enable_pio)
1364 {
1365         struct dma_chan *chan = s->chan_rx;
1366         struct uart_port *port = &s->port;
1367
1368         s->chan_rx = NULL;
1369         s->cookie_rx[0] = s->cookie_rx[1] = -EINVAL;
1370         dma_release_channel(chan);
1371         if (sg_dma_address(&s->sg_rx[0]))
1372                 dma_free_coherent(port->dev, s->buf_len_rx * 2,
1373                                   sg_virt(&s->sg_rx[0]), sg_dma_address(&s->sg_rx[0]));
1374         if (enable_pio)
1375                 sci_start_rx(port);
1376 }
1377
1378 static void sci_tx_dma_release(struct sci_port *s, bool enable_pio)
1379 {
1380         struct dma_chan *chan = s->chan_tx;
1381         struct uart_port *port = &s->port;
1382
1383         s->chan_tx = NULL;
1384         s->cookie_tx = -EINVAL;
1385         dma_release_channel(chan);
1386         if (enable_pio)
1387                 sci_start_tx(port);
1388 }
1389
1390 static void sci_submit_rx(struct sci_port *s)
1391 {
1392         struct dma_chan *chan = s->chan_rx;
1393         int i;
1394
1395         for (i = 0; i < 2; i++) {
1396                 struct scatterlist *sg = &s->sg_rx[i];
1397                 struct dma_async_tx_descriptor *desc;
1398
1399                 desc = dmaengine_prep_slave_sg(chan,
1400                         sg, 1, DMA_DEV_TO_MEM, DMA_PREP_INTERRUPT);
1401
1402                 if (desc) {
1403                         s->desc_rx[i] = desc;
1404                         desc->callback = sci_dma_rx_complete;
1405                         desc->callback_param = s;
1406                         s->cookie_rx[i] = desc->tx_submit(desc);
1407                 }
1408
1409                 if (!desc || s->cookie_rx[i] < 0) {
1410                         if (i) {
1411                                 async_tx_ack(s->desc_rx[0]);
1412                                 s->cookie_rx[0] = -EINVAL;
1413                         }
1414                         if (desc) {
1415                                 async_tx_ack(desc);
1416                                 s->cookie_rx[i] = -EINVAL;
1417                         }
1418                         dev_warn(s->port.dev,
1419                                  "failed to re-start DMA, using PIO\n");
1420                         sci_rx_dma_release(s, true);
1421                         return;
1422                 }
1423                 dev_dbg(s->port.dev, "%s(): cookie %d to #%d\n",
1424                         __func__, s->cookie_rx[i], i);
1425         }
1426
1427         s->active_rx = s->cookie_rx[0];
1428
1429         dma_async_issue_pending(chan);
1430 }
1431
1432 static void work_fn_rx(struct work_struct *work)
1433 {
1434         struct sci_port *s = container_of(work, struct sci_port, work_rx);
1435         struct uart_port *port = &s->port;
1436         struct dma_async_tx_descriptor *desc;
1437         int new;
1438
1439         if (s->active_rx == s->cookie_rx[0]) {
1440                 new = 0;
1441         } else if (s->active_rx == s->cookie_rx[1]) {
1442                 new = 1;
1443         } else {
1444                 dev_err(port->dev, "cookie %d not found!\n", s->active_rx);
1445                 return;
1446         }
1447         desc = s->desc_rx[new];
1448
1449         if (dma_async_is_tx_complete(s->chan_rx, s->active_rx, NULL, NULL) !=
1450             DMA_COMPLETE) {
1451                 /* Handle incomplete DMA receive */
1452                 struct dma_chan *chan = s->chan_rx;
1453                 struct shdma_desc *sh_desc = container_of(desc,
1454                                         struct shdma_desc, async_tx);
1455                 unsigned long flags;
1456                 int count;
1457
1458                 dmaengine_terminate_all(chan);
1459                 dev_dbg(port->dev, "Read %zu bytes with cookie %d\n",
1460                         sh_desc->partial, sh_desc->cookie);
1461
1462                 spin_lock_irqsave(&port->lock, flags);
1463                 count = sci_dma_rx_push(s, sh_desc->partial);
1464                 spin_unlock_irqrestore(&port->lock, flags);
1465
1466                 if (count)
1467                         tty_flip_buffer_push(&port->state->port);
1468
1469                 sci_submit_rx(s);
1470
1471                 return;
1472         }
1473
1474         s->cookie_rx[new] = desc->tx_submit(desc);
1475         if (s->cookie_rx[new] < 0) {
1476                 dev_warn(port->dev, "Failed submitting Rx DMA descriptor\n");
1477                 sci_rx_dma_release(s, true);
1478                 return;
1479         }
1480
1481         s->active_rx = s->cookie_rx[!new];
1482
1483         dev_dbg(port->dev, "%s: cookie %d #%d, new active #%d\n",
1484                 __func__, s->cookie_rx[new], new, s->active_rx);
1485 }
1486
1487 static void work_fn_tx(struct work_struct *work)
1488 {
1489         struct sci_port *s = container_of(work, struct sci_port, work_tx);
1490         struct dma_async_tx_descriptor *desc;
1491         struct dma_chan *chan = s->chan_tx;
1492         struct uart_port *port = &s->port;
1493         struct circ_buf *xmit = &port->state->xmit;
1494         struct scatterlist *sg = &s->sg_tx;
1495
1496         /*
1497          * DMA is idle now.
1498          * Port xmit buffer is already mapped, and it is one page... Just adjust
1499          * offsets and lengths. Since it is a circular buffer, we have to
1500          * transmit till the end, and then the rest. Take the port lock to get a
1501          * consistent xmit buffer state.
1502          */
1503         spin_lock_irq(&port->lock);
1504         sg->offset = xmit->tail & (UART_XMIT_SIZE - 1);
1505         sg_dma_address(sg) = (sg_dma_address(sg) & ~(UART_XMIT_SIZE - 1)) +
1506                 sg->offset;
1507         sg_dma_len(sg) = min((int)CIRC_CNT(xmit->head, xmit->tail, UART_XMIT_SIZE),
1508                 CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE));
1509         spin_unlock_irq(&port->lock);
1510
1511         BUG_ON(!sg_dma_len(sg));
1512
1513         desc = dmaengine_prep_slave_sg(chan,
1514                         sg, s->sg_len_tx, DMA_MEM_TO_DEV,
1515                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1516         if (!desc) {
1517                 /* switch to PIO */
1518                 sci_tx_dma_release(s, true);
1519                 return;
1520         }
1521
1522         dma_sync_sg_for_device(port->dev, sg, 1, DMA_TO_DEVICE);
1523
1524         spin_lock_irq(&port->lock);
1525         s->desc_tx = desc;
1526         desc->callback = sci_dma_tx_complete;
1527         desc->callback_param = s;
1528         spin_unlock_irq(&port->lock);
1529         s->cookie_tx = desc->tx_submit(desc);
1530         if (s->cookie_tx < 0) {
1531                 dev_warn(port->dev, "Failed submitting Tx DMA descriptor\n");
1532                 /* switch to PIO */
1533                 sci_tx_dma_release(s, true);
1534                 return;
1535         }
1536
1537         dev_dbg(port->dev, "%s: %p: %d...%d, cookie %d\n",
1538                 __func__, xmit->buf, xmit->tail, xmit->head, s->cookie_tx);
1539
1540         dma_async_issue_pending(chan);
1541 }
1542 #endif
1543
1544 static void sci_start_tx(struct uart_port *port)
1545 {
1546         struct sci_port *s = to_sci_port(port);
1547         unsigned short ctrl;
1548
1549 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1550         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1551                 u16 new, scr = serial_port_in(port, SCSCR);
1552                 if (s->chan_tx)
1553                         new = scr | SCSCR_TDRQE;
1554                 else
1555                         new = scr & ~SCSCR_TDRQE;
1556                 if (new != scr)
1557                         serial_port_out(port, SCSCR, new);
1558         }
1559
1560         if (s->chan_tx && !uart_circ_empty(&s->port.state->xmit) &&
1561             s->cookie_tx < 0) {
1562                 s->cookie_tx = 0;
1563                 schedule_work(&s->work_tx);
1564         }
1565 #endif
1566
1567         if (!s->chan_tx || port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1568                 /* Set TIE (Transmit Interrupt Enable) bit in SCSCR */
1569                 ctrl = serial_port_in(port, SCSCR);
1570                 serial_port_out(port, SCSCR, ctrl | SCSCR_TIE);
1571         }
1572 }
1573
1574 static void sci_stop_tx(struct uart_port *port)
1575 {
1576         unsigned short ctrl;
1577
1578         /* Clear TIE (Transmit Interrupt Enable) bit in SCSCR */
1579         ctrl = serial_port_in(port, SCSCR);
1580
1581         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1582                 ctrl &= ~SCSCR_TDRQE;
1583
1584         ctrl &= ~SCSCR_TIE;
1585
1586         serial_port_out(port, SCSCR, ctrl);
1587 }
1588
1589 static void sci_start_rx(struct uart_port *port)
1590 {
1591         unsigned short ctrl;
1592
1593         ctrl = serial_port_in(port, SCSCR) | port_rx_irq_mask(port);
1594
1595         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1596                 ctrl &= ~SCSCR_RDRQE;
1597
1598         serial_port_out(port, SCSCR, ctrl);
1599 }
1600
1601 static void sci_stop_rx(struct uart_port *port)
1602 {
1603         unsigned short ctrl;
1604
1605         ctrl = serial_port_in(port, SCSCR);
1606
1607         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB)
1608                 ctrl &= ~SCSCR_RDRQE;
1609
1610         ctrl &= ~port_rx_irq_mask(port);
1611
1612         serial_port_out(port, SCSCR, ctrl);
1613 }
1614
1615 static void sci_break_ctl(struct uart_port *port, int break_state)
1616 {
1617         struct sci_port *s = to_sci_port(port);
1618         const struct plat_sci_reg *reg = sci_regmap[s->cfg->regtype] + SCSPTR;
1619         unsigned short scscr, scsptr;
1620
1621         /* check wheter the port has SCSPTR */
1622         if (!reg->size) {
1623                 /*
1624                  * Not supported by hardware. Most parts couple break and rx
1625                  * interrupts together, with break detection always enabled.
1626                  */
1627                 return;
1628         }
1629
1630         scsptr = serial_port_in(port, SCSPTR);
1631         scscr = serial_port_in(port, SCSCR);
1632
1633         if (break_state == -1) {
1634                 scsptr = (scsptr | SCSPTR_SPB2IO) & ~SCSPTR_SPB2DT;
1635                 scscr &= ~SCSCR_TE;
1636         } else {
1637                 scsptr = (scsptr | SCSPTR_SPB2DT) & ~SCSPTR_SPB2IO;
1638                 scscr |= SCSCR_TE;
1639         }
1640
1641         serial_port_out(port, SCSPTR, scsptr);
1642         serial_port_out(port, SCSCR, scscr);
1643 }
1644
1645 #ifdef CONFIG_SERIAL_SH_SCI_DMA
1646 static bool filter(struct dma_chan *chan, void *slave)
1647 {
1648         struct sh_dmae_slave *param = slave;
1649
1650         dev_dbg(chan->device->dev, "%s: slave ID %d\n",
1651                 __func__, param->shdma_slave.slave_id);
1652
1653         chan->private = &param->shdma_slave;
1654         return true;
1655 }
1656
1657 static void rx_timer_fn(unsigned long arg)
1658 {
1659         struct sci_port *s = (struct sci_port *)arg;
1660         struct uart_port *port = &s->port;
1661         u16 scr = serial_port_in(port, SCSCR);
1662
1663         if (port->type == PORT_SCIFA || port->type == PORT_SCIFB) {
1664                 scr &= ~SCSCR_RDRQE;
1665                 enable_irq(s->irqs[SCIx_RXI_IRQ]);
1666         }
1667         serial_port_out(port, SCSCR, scr | SCSCR_RIE);
1668         dev_dbg(port->dev, "DMA Rx timed out\n");
1669         schedule_work(&s->work_rx);
1670 }
1671
1672 static void sci_request_dma(struct uart_port *port)
1673 {
1674         struct sci_port *s = to_sci_port(port);
1675         struct sh_dmae_slave *param;
1676         struct dma_chan *chan;
1677         dma_cap_mask_t mask;
1678         int nent;
1679
1680         dev_dbg(port->dev, "%s: port %d\n", __func__, port->line);
1681
1682         if (s->cfg->dma_slave_tx <= 0 || s->cfg->dma_slave_rx <= 0)
1683                 return;
1684
1685         dma_cap_zero(mask);
1686         dma_cap_set(DMA_SLAVE, mask);
1687
1688         param = &s->param_tx;
1689
1690         /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_TX */
1691         param->shdma_slave.slave_id = s->cfg->dma_slave_tx;
1692
1693         s->cookie_tx = -EINVAL;
1694         chan = dma_request_channel(mask, filter, param);
1695         dev_dbg(port->dev, "%s: TX: got channel %p\n", __func__, chan);
1696         if (chan) {
1697                 s->chan_tx = chan;
1698                 sg_init_table(&s->sg_tx, 1);
1699                 /* UART circular tx buffer is an aligned page. */
1700                 BUG_ON((uintptr_t)port->state->xmit.buf & ~PAGE_MASK);
1701                 sg_set_page(&s->sg_tx, virt_to_page(port->state->xmit.buf),
1702                             UART_XMIT_SIZE,
1703                             (uintptr_t)port->state->xmit.buf & ~PAGE_MASK);
1704                 nent = dma_map_sg(port->dev, &s->sg_tx, 1, DMA_TO_DEVICE);
1705                 if (!nent)
1706                         sci_tx_dma_release(s, false);
1707                 else
1708                         dev_dbg(port->dev, "%s: mapped %d@%p to %pad\n",
1709                                 __func__,
1710                                 sg_dma_len(&s->sg_tx), port->state->xmit.buf,
1711                                 &sg_dma_address(&s->sg_tx));
1712
1713                 s->sg_len_tx = nent;
1714
1715                 INIT_WORK(&s->work_tx, work_fn_tx);
1716         }
1717
1718         param = &s->param_rx;
1719
1720         /* Slave ID, e.g., SHDMA_SLAVE_SCIF0_RX */
1721         param->shdma_slave.slave_id = s->cfg->dma_slave_rx;
1722
1723         chan = dma_request_channel(mask, filter, param);
1724         dev_dbg(port->dev, "%s: RX: got channel %p\n", __func__, chan);
1725         if (chan) {
1726                 dma_addr_t dma[2];
1727                 void *buf[2];
1728                 int i;
1729
1730                 s->chan_rx = chan;
1731
1732                 s->buf_len_rx = 2 * max(16, (int)port->fifosize);
1733                 buf[0] = dma_alloc_coherent(port->dev, s->buf_len_rx * 2,
1734                                             &dma[0], GFP_KERNEL);
1735
1736                 if (!buf[0]) {
1737                         dev_warn(port->dev,
1738                                  "failed to allocate dma buffer, using PIO\n");
1739                         sci_rx_dma_release(s, true);
1740                         return;
1741                 }
1742
1743                 buf[1] = buf[0] + s->buf_len_rx;
1744                 dma[1] = dma[0] + s->buf_len_rx;
1745
1746                 for (i = 0; i < 2; i++) {
1747                         struct scatterlist *sg = &s->sg_rx[i];
1748
1749                         sg_init_table(sg, 1);
1750                         sg_set_page(sg, virt_to_page(buf[i]), s->buf_len_rx,
1751                                     (uintptr_t)buf[i] & ~PAGE_MASK);
1752                         sg_dma_address(sg) = dma[i];
1753                 }
1754
1755                 INIT_WORK(&s->work_rx, work_fn_rx);
1756                 setup_timer(&s->rx_timer, rx_timer_fn, (unsigned long)s);
1757
1758                 sci_submit_rx(s);
1759         }
1760 }
1761
1762 static void sci_free_dma(struct uart_port *port)
1763 {
1764         struct sci_port *s = to_sci_port(port);
1765
1766         if (s->chan_tx)
1767                 sci_tx_dma_release(s, false);
1768         if (s->chan_rx)
1769                 sci_rx_dma_release(s, false);
1770 }
1771 #else
1772 static inline void sci_request_dma(struct uart_port *port)
1773 {
1774 }
1775
1776 static inline void sci_free_dma(struct uart_port *port)
1777 {
1778 }
1779 #endif
1780
1781 static int sci_startup(struct uart_port *port)
1782 {
1783         struct sci_port *s = to_sci_port(port);
1784         unsigned long flags;
1785         int ret;
1786
1787         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1788
1789         ret = sci_request_irq(s);
1790         if (unlikely(ret < 0))
1791                 return ret;
1792
1793         sci_request_dma(port);
1794
1795         spin_lock_irqsave(&port->lock, flags);
1796         sci_start_tx(port);
1797         sci_start_rx(port);
1798         spin_unlock_irqrestore(&port->lock, flags);
1799
1800         return 0;
1801 }
1802
1803 static void sci_shutdown(struct uart_port *port)
1804 {
1805         struct sci_port *s = to_sci_port(port);
1806         unsigned long flags;
1807
1808         dev_dbg(port->dev, "%s(%d)\n", __func__, port->line);
1809
1810         spin_lock_irqsave(&port->lock, flags);
1811         sci_stop_rx(port);
1812         sci_stop_tx(port);
1813         spin_unlock_irqrestore(&port->lock, flags);
1814
1815         sci_free_dma(port);
1816         sci_free_irq(s);
1817 }
1818
1819 static unsigned int sci_scbrr_calc(struct sci_port *s, unsigned int bps,
1820                                    unsigned long freq)
1821 {
1822         if (s->sampling_rate)
1823                 return DIV_ROUND_CLOSEST(freq, s->sampling_rate * bps) - 1;
1824
1825         /* Warn, but use a safe default */
1826         WARN_ON(1);
1827
1828         return ((freq + 16 * bps) / (32 * bps) - 1);
1829 }
1830
1831 /* calculate frame length from SMR */
1832 static int sci_baud_calc_frame_len(unsigned int smr_val)
1833 {
1834         int len = 10;
1835
1836         if (smr_val & SCSMR_CHR)
1837                 len--;
1838         if (smr_val & SCSMR_PE)
1839                 len++;
1840         if (smr_val & SCSMR_STOP)
1841                 len++;
1842
1843         return len;
1844 }
1845
1846
1847 /* calculate sample rate, BRR, and clock select for HSCIF */
1848 static void sci_baud_calc_hscif(unsigned int bps, unsigned long freq,
1849                                 int *brr, unsigned int *srr,
1850                                 unsigned int *cks, int frame_len)
1851 {
1852         int sr, c, br, err, recv_margin;
1853         int min_err = 1000; /* 100% */
1854         int recv_max_margin = 0;
1855
1856         /* Find the combination of sample rate and clock select with the
1857            smallest deviation from the desired baud rate. */
1858         for (sr = 8; sr <= 32; sr++) {
1859                 for (c = 0; c <= 3; c++) {
1860                         /* integerized formulas from HSCIF documentation */
1861                         br = DIV_ROUND_CLOSEST(freq, (sr *
1862                                               (1 << (2 * c + 1)) * bps)) - 1;
1863                         br = clamp(br, 0, 255);
1864                         err = DIV_ROUND_CLOSEST(freq, ((br + 1) * bps * sr *
1865                                                (1 << (2 * c + 1)) / 1000)) -
1866                                                1000;
1867                         /* Calc recv margin
1868                          * M: Receive margin (%)
1869                          * N: Ratio of bit rate to clock (N = sampling rate)
1870                          * D: Clock duty (D = 0 to 1.0)
1871                          * L: Frame length (L = 9 to 12)
1872                          * F: Absolute value of clock frequency deviation
1873                          *
1874                          *  M = |(0.5 - 1 / 2 * N) - ((L - 0.5) * F) -
1875                          *      (|D - 0.5| / N * (1 + F))|
1876                          *  NOTE: Usually, treat D for 0.5, F is 0 by this
1877                          *        calculation.
1878                          */
1879                         recv_margin = abs((500 -
1880                                         DIV_ROUND_CLOSEST(1000, sr << 1)) / 10);
1881                         if (abs(min_err) > abs(err)) {
1882                                 min_err = err;
1883                                 recv_max_margin = recv_margin;
1884                         } else if ((min_err == err) &&
1885                                    (recv_margin > recv_max_margin))
1886                                 recv_max_margin = recv_margin;
1887                         else
1888                                 continue;
1889
1890                         *brr = br;
1891                         *srr = sr - 1;
1892                         *cks = c;
1893                 }
1894         }
1895
1896         if (min_err == 1000) {
1897                 WARN_ON(1);
1898                 /* use defaults */
1899                 *brr = 255;
1900                 *srr = 15;
1901                 *cks = 0;
1902         }
1903 }
1904
1905 static void sci_reset(struct uart_port *port)
1906 {
1907         const struct plat_sci_reg *reg;
1908         unsigned int status;
1909
1910         do {
1911                 status = serial_port_in(port, SCxSR);
1912         } while (!(status & SCxSR_TEND(port)));
1913
1914         serial_port_out(port, SCSCR, 0x00);     /* TE=0, RE=0, CKE1=0 */
1915
1916         reg = sci_getreg(port, SCFCR);
1917         if (reg->size)
1918                 serial_port_out(port, SCFCR, SCFCR_RFRST | SCFCR_TFRST);
1919 }
1920
1921 static void sci_set_termios(struct uart_port *port, struct ktermios *termios,
1922                             struct ktermios *old)
1923 {
1924         struct sci_port *s = to_sci_port(port);
1925         const struct plat_sci_reg *reg;
1926         unsigned int baud, smr_val = 0, max_baud, cks = 0;
1927         int t = -1;
1928         unsigned int srr = 15;
1929
1930         if ((termios->c_cflag & CSIZE) == CS7)
1931                 smr_val |= SCSMR_CHR;
1932         if (termios->c_cflag & PARENB)
1933                 smr_val |= SCSMR_PE;
1934         if (termios->c_cflag & PARODD)
1935                 smr_val |= SCSMR_PE | SCSMR_ODD;
1936         if (termios->c_cflag & CSTOPB)
1937                 smr_val |= SCSMR_STOP;
1938
1939         /*
1940          * earlyprintk comes here early on with port->uartclk set to zero.
1941          * the clock framework is not up and running at this point so here
1942          * we assume that 115200 is the maximum baud rate. please note that
1943          * the baud rate is not programmed during earlyprintk - it is assumed
1944          * that the previous boot loader has enabled required clocks and
1945          * setup the baud rate generator hardware for us already.
1946          */
1947         max_baud = port->uartclk ? port->uartclk / 16 : 115200;
1948
1949         baud = uart_get_baud_rate(port, termios, old, 0, max_baud);
1950         if (likely(baud && port->uartclk)) {
1951                 if (s->cfg->type == PORT_HSCIF) {
1952                         int frame_len = sci_baud_calc_frame_len(smr_val);
1953                         sci_baud_calc_hscif(baud, port->uartclk, &t, &srr,
1954                                             &cks, frame_len);
1955                 } else {
1956                         t = sci_scbrr_calc(s, baud, port->uartclk);
1957                         for (cks = 0; t >= 256 && cks <= 3; cks++)
1958                                 t >>= 2;
1959                 }
1960         }
1961
1962         sci_port_enable(s);
1963
1964         sci_reset(port);
1965
1966         smr_val |= serial_port_in(port, SCSMR) & SCSMR_CKS;
1967
1968         uart_update_timeout(port, termios->c_cflag, baud);
1969
1970         dev_dbg(port->dev, "%s: SMR %x, cks %x, t %x, SCSCR %x\n",
1971                 __func__, smr_val, cks, t, s->cfg->scscr);
1972
1973         if (t >= 0) {
1974                 serial_port_out(port, SCSMR, (smr_val & ~SCSMR_CKS) | cks);
1975                 serial_port_out(port, SCBRR, t);
1976                 reg = sci_getreg(port, HSSRR);
1977                 if (reg->size)
1978                         serial_port_out(port, HSSRR, srr | HSCIF_SRE);
1979                 udelay((1000000+(baud-1)) / baud); /* Wait one bit interval */
1980         } else
1981                 serial_port_out(port, SCSMR, smr_val);
1982
1983         sci_init_pins(port, termios->c_cflag);
1984
1985         reg = sci_getreg(port, SCFCR);
1986         if (reg->size) {
1987                 unsigned short ctrl = serial_port_in(port, SCFCR);
1988
1989                 if (s->cfg->capabilities & SCIx_HAVE_RTSCTS) {
1990                         if (termios->c_cflag & CRTSCTS)
1991                                 ctrl |= SCFCR_MCE;
1992                         else
1993                                 ctrl &= ~SCFCR_MCE;
1994                 }
1995
1996                 /*
1997                  * As we've done a sci_reset() above, ensure we don't
1998                  * interfere with the FIFOs while toggling MCE. As the
1999                  * reset values could still be set, simply mask them out.
2000                  */
2001                 ctrl &= ~(SCFCR_RFRST | SCFCR_TFRST);
2002
2003                 serial_port_out(port, SCFCR, ctrl);
2004         }
2005
2006         serial_port_out(port, SCSCR, s->cfg->scscr);
2007
2008 #ifdef CONFIG_SERIAL_SH_SCI_DMA
2009         /*
2010          * Calculate delay for 2 DMA buffers (4 FIFO).
2011          * See serial_core.c::uart_update_timeout(). With 10
2012          * bits (CS8), 250Hz, 115200 baud and 64 bytes FIFO, the above function
2013          * calculates 1 jiffie for the data plus 5 jiffies for the "slop(e)."
2014          * Then below we calculate 5 jiffies (20ms) for 2 DMA buffers (4 FIFO
2015          * sizes), but when performing a faster transfer, value obtained by
2016          * this formula is may not enough. Therefore, if value is smaller than
2017          * 20msec, this sets 20msec as timeout of DMA.
2018          */
2019         if (s->chan_rx) {
2020                 unsigned int bits;
2021
2022                 /* byte size and parity */
2023                 switch (termios->c_cflag & CSIZE) {
2024                 case CS5:
2025                         bits = 7;
2026                         break;
2027                 case CS6:
2028                         bits = 8;
2029                         break;
2030                 case CS7:
2031                         bits = 9;
2032                         break;
2033                 default:
2034                         bits = 10;
2035                         break;
2036                 }
2037
2038                 if (termios->c_cflag & CSTOPB)
2039                         bits++;
2040                 if (termios->c_cflag & PARENB)
2041                         bits++;
2042                 s->rx_timeout = DIV_ROUND_UP((s->buf_len_rx * 2 * bits * HZ) /
2043                                              (baud / 10), 10);
2044                 dev_dbg(port->dev, "DMA Rx t-out %ums, tty t-out %u jiffies\n",
2045                         s->rx_timeout * 1000 / HZ, port->timeout);
2046                 if (s->rx_timeout < msecs_to_jiffies(20))
2047                         s->rx_timeout = msecs_to_jiffies(20);
2048         }
2049 #endif
2050
2051         if ((termios->c_cflag & CREAD) != 0)
2052                 sci_start_rx(port);
2053
2054         sci_port_disable(s);
2055 }
2056
2057 static void sci_pm(struct uart_port *port, unsigned int state,
2058                    unsigned int oldstate)
2059 {
2060         struct sci_port *sci_port = to_sci_port(port);
2061
2062         switch (state) {
2063         case UART_PM_STATE_OFF:
2064                 sci_port_disable(sci_port);
2065                 break;
2066         default:
2067                 sci_port_enable(sci_port);
2068                 break;
2069         }
2070 }
2071
2072 static const char *sci_type(struct uart_port *port)
2073 {
2074         switch (port->type) {
2075         case PORT_IRDA:
2076                 return "irda";
2077         case PORT_SCI:
2078                 return "sci";
2079         case PORT_SCIF:
2080                 return "scif";
2081         case PORT_SCIFA:
2082                 return "scifa";
2083         case PORT_SCIFB:
2084                 return "scifb";
2085         case PORT_HSCIF:
2086                 return "hscif";
2087         }
2088
2089         return NULL;
2090 }
2091
2092 static int sci_remap_port(struct uart_port *port)
2093 {
2094         struct sci_port *sport = to_sci_port(port);
2095
2096         /*
2097          * Nothing to do if there's already an established membase.
2098          */
2099         if (port->membase)
2100                 return 0;
2101
2102         if (port->flags & UPF_IOREMAP) {
2103                 port->membase = ioremap_nocache(port->mapbase, sport->reg_size);
2104                 if (unlikely(!port->membase)) {
2105                         dev_err(port->dev, "can't remap port#%d\n", port->line);
2106                         return -ENXIO;
2107                 }
2108         } else {
2109                 /*
2110                  * For the simple (and majority of) cases where we don't
2111                  * need to do any remapping, just cast the cookie
2112                  * directly.
2113                  */
2114                 port->membase = (void __iomem *)(uintptr_t)port->mapbase;
2115         }
2116
2117         return 0;
2118 }
2119
2120 static void sci_release_port(struct uart_port *port)
2121 {
2122         struct sci_port *sport = to_sci_port(port);
2123
2124         if (port->flags & UPF_IOREMAP) {
2125                 iounmap(port->membase);
2126                 port->membase = NULL;
2127         }
2128
2129         release_mem_region(port->mapbase, sport->reg_size);
2130 }
2131
2132 static int sci_request_port(struct uart_port *port)
2133 {
2134         struct resource *res;
2135         struct sci_port *sport = to_sci_port(port);
2136         int ret;
2137
2138         res = request_mem_region(port->mapbase, sport->reg_size,
2139                                  dev_name(port->dev));
2140         if (unlikely(res == NULL)) {
2141                 dev_err(port->dev, "request_mem_region failed.");
2142                 return -EBUSY;
2143         }
2144
2145         ret = sci_remap_port(port);
2146         if (unlikely(ret != 0)) {
2147                 release_resource(res);
2148                 return ret;
2149         }
2150
2151         return 0;
2152 }
2153
2154 static void sci_config_port(struct uart_port *port, int flags)
2155 {
2156         if (flags & UART_CONFIG_TYPE) {
2157                 struct sci_port *sport = to_sci_port(port);
2158
2159                 port->type = sport->cfg->type;
2160                 sci_request_port(port);
2161         }
2162 }
2163
2164 static int sci_verify_port(struct uart_port *port, struct serial_struct *ser)
2165 {
2166         if (ser->baud_base < 2400)
2167                 /* No paper tape reader for Mitch.. */
2168                 return -EINVAL;
2169
2170         return 0;
2171 }
2172
2173 static struct uart_ops sci_uart_ops = {
2174         .tx_empty       = sci_tx_empty,
2175         .set_mctrl      = sci_set_mctrl,
2176         .get_mctrl      = sci_get_mctrl,
2177         .start_tx       = sci_start_tx,
2178         .stop_tx        = sci_stop_tx,
2179         .stop_rx        = sci_stop_rx,
2180         .break_ctl      = sci_break_ctl,
2181         .startup        = sci_startup,
2182         .shutdown       = sci_shutdown,
2183         .set_termios    = sci_set_termios,
2184         .pm             = sci_pm,
2185         .type           = sci_type,
2186         .release_port   = sci_release_port,
2187         .request_port   = sci_request_port,
2188         .config_port    = sci_config_port,
2189         .verify_port    = sci_verify_port,
2190 #ifdef CONFIG_CONSOLE_POLL
2191         .poll_get_char  = sci_poll_get_char,
2192         .poll_put_char  = sci_poll_put_char,
2193 #endif
2194 };
2195
2196 static int sci_init_single(struct platform_device *dev,
2197                            struct sci_port *sci_port, unsigned int index,
2198                            struct plat_sci_port *p, bool early)
2199 {
2200         struct uart_port *port = &sci_port->port;
2201         const struct resource *res;
2202         unsigned int i;
2203         int ret;
2204
2205         sci_port->cfg   = p;
2206
2207         port->ops       = &sci_uart_ops;
2208         port->iotype    = UPIO_MEM;
2209         port->line      = index;
2210
2211         res = platform_get_resource(dev, IORESOURCE_MEM, 0);
2212         if (res == NULL)
2213                 return -ENOMEM;
2214
2215         port->mapbase = res->start;
2216         sci_port->reg_size = resource_size(res);
2217
2218         for (i = 0; i < ARRAY_SIZE(sci_port->irqs); ++i)
2219                 sci_port->irqs[i] = platform_get_irq(dev, i);
2220
2221         /* The SCI generates several interrupts. They can be muxed together or
2222          * connected to different interrupt lines. In the muxed case only one
2223          * interrupt resource is specified. In the non-muxed case three or four
2224          * interrupt resources are specified, as the BRI interrupt is optional.
2225          */
2226         if (sci_port->irqs[0] < 0)
2227                 return -ENXIO;
2228
2229         if (sci_port->irqs[1] < 0) {
2230                 sci_port->irqs[1] = sci_port->irqs[0];
2231                 sci_port->irqs[2] = sci_port->irqs[0];
2232                 sci_port->irqs[3] = sci_port->irqs[0];
2233         }
2234
2235         if (p->regtype == SCIx_PROBE_REGTYPE) {
2236                 ret = sci_probe_regmap(p);
2237                 if (unlikely(ret))
2238                         return ret;
2239         }
2240
2241         switch (p->type) {
2242         case PORT_SCIFB:
2243                 port->fifosize = 256;
2244                 sci_port->overrun_reg = SCxSR;
2245                 sci_port->overrun_mask = SCIFA_ORER;
2246                 sci_port->sampling_rate = 16;
2247                 break;
2248         case PORT_HSCIF:
2249                 port->fifosize = 128;
2250                 sci_port->overrun_reg = SCLSR;
2251                 sci_port->overrun_mask = SCLSR_ORER;
2252                 sci_port->sampling_rate = 0;
2253                 break;
2254         case PORT_SCIFA:
2255                 port->fifosize = 64;
2256                 sci_port->overrun_reg = SCxSR;
2257                 sci_port->overrun_mask = SCIFA_ORER;
2258                 sci_port->sampling_rate = 16;
2259                 break;
2260         case PORT_SCIF:
2261                 port->fifosize = 16;
2262                 if (p->regtype == SCIx_SH7705_SCIF_REGTYPE) {
2263                         sci_port->overrun_reg = SCxSR;
2264                         sci_port->overrun_mask = SCIFA_ORER;
2265                         sci_port->sampling_rate = 16;
2266                 } else {
2267                         sci_port->overrun_reg = SCLSR;
2268                         sci_port->overrun_mask = SCLSR_ORER;
2269                         sci_port->sampling_rate = 32;
2270                 }
2271                 break;
2272         default:
2273                 port->fifosize = 1;
2274                 sci_port->overrun_reg = SCxSR;
2275                 sci_port->overrun_mask = SCI_ORER;
2276                 sci_port->sampling_rate = 32;
2277                 break;
2278         }
2279
2280         /* SCIFA on sh7723 and sh7724 need a custom sampling rate that doesn't
2281          * match the SoC datasheet, this should be investigated. Let platform
2282          * data override the sampling rate for now.
2283          */
2284         if (p->sampling_rate)
2285                 sci_port->sampling_rate = p->sampling_rate;
2286
2287         if (!early) {
2288                 sci_port->iclk = clk_get(&dev->dev, "sci_ick");
2289                 if (IS_ERR(sci_port->iclk)) {
2290                         sci_port->iclk = clk_get(&dev->dev, "peripheral_clk");
2291                         if (IS_ERR(sci_port->iclk)) {
2292                                 dev_err(&dev->dev, "can't get iclk\n");
2293                                 return PTR_ERR(sci_port->iclk);
2294                         }
2295                 }
2296
2297                 /*
2298                  * The function clock is optional, ignore it if we can't
2299                  * find it.
2300                  */
2301                 sci_port->fclk = clk_get(&dev->dev, "sci_fck");
2302                 if (IS_ERR(sci_port->fclk))
2303                         sci_port->fclk = NULL;
2304
2305                 port->dev = &dev->dev;
2306
2307                 pm_runtime_enable(&dev->dev);
2308         }
2309
2310         sci_port->break_timer.data = (unsigned long)sci_port;
2311         sci_port->break_timer.function = sci_break_timer;
2312         init_timer(&sci_port->break_timer);
2313
2314         /*
2315          * Establish some sensible defaults for the error detection.
2316          */
2317         if (p->type == PORT_SCI) {
2318                 sci_port->error_mask = SCI_DEFAULT_ERROR_MASK;
2319                 sci_port->error_clear = SCI_ERROR_CLEAR;
2320         } else {
2321                 sci_port->error_mask = SCIF_DEFAULT_ERROR_MASK;
2322                 sci_port->error_clear = SCIF_ERROR_CLEAR;
2323         }
2324
2325         /*
2326          * Make the error mask inclusive of overrun detection, if
2327          * supported.
2328          */
2329         if (sci_port->overrun_reg == SCxSR) {
2330                 sci_port->error_mask |= sci_port->overrun_mask;
2331                 sci_port->error_clear &= ~sci_port->overrun_mask;
2332         }
2333
2334         port->type              = p->type;
2335         port->flags             = UPF_FIXED_PORT | p->flags;
2336         port->regshift          = p->regshift;
2337
2338         /*
2339          * The UART port needs an IRQ value, so we peg this to the RX IRQ
2340          * for the multi-IRQ ports, which is where we are primarily
2341          * concerned with the shutdown path synchronization.
2342          *
2343          * For the muxed case there's nothing more to do.
2344          */
2345         port->irq               = sci_port->irqs[SCIx_RXI_IRQ];
2346         port->irqflags          = 0;
2347
2348         port->serial_in         = sci_serial_in;
2349         port->serial_out        = sci_serial_out;
2350
2351         if (p->dma_slave_tx > 0 && p->dma_slave_rx > 0)
2352                 dev_dbg(port->dev, "DMA tx %d, rx %d\n",
2353                         p->dma_slave_tx, p->dma_slave_rx);
2354
2355         return 0;
2356 }
2357
2358 static void sci_cleanup_single(struct sci_port *port)
2359 {
2360         clk_put(port->iclk);
2361         clk_put(port->fclk);
2362
2363         pm_runtime_disable(port->port.dev);
2364 }
2365
2366 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
2367 static void serial_console_putchar(struct uart_port *port, int ch)
2368 {
2369         sci_poll_put_char(port, ch);
2370 }
2371
2372 /*
2373  *      Print a string to the serial port trying not to disturb
2374  *      any possible real use of the port...
2375  */
2376 static void serial_console_write(struct console *co, const char *s,
2377                                  unsigned count)
2378 {
2379         struct sci_port *sci_port = &sci_ports[co->index];
2380         struct uart_port *port = &sci_port->port;
2381         unsigned short bits, ctrl;
2382         unsigned long flags;
2383         int locked = 1;
2384
2385         local_irq_save(flags);
2386         if (port->sysrq)
2387                 locked = 0;
2388         else if (oops_in_progress)
2389                 locked = spin_trylock(&port->lock);
2390         else
2391                 spin_lock(&port->lock);
2392
2393         /* first save the SCSCR then disable the interrupts */
2394         ctrl = serial_port_in(port, SCSCR);
2395         serial_port_out(port, SCSCR, sci_port->cfg->scscr);
2396
2397         uart_console_write(port, s, count, serial_console_putchar);
2398
2399         /* wait until fifo is empty and last bit has been transmitted */
2400         bits = SCxSR_TDxE(port) | SCxSR_TEND(port);
2401         while ((serial_port_in(port, SCxSR) & bits) != bits)
2402                 cpu_relax();
2403
2404         /* restore the SCSCR */
2405         serial_port_out(port, SCSCR, ctrl);
2406
2407         if (locked)
2408                 spin_unlock(&port->lock);
2409         local_irq_restore(flags);
2410 }
2411
2412 static int serial_console_setup(struct console *co, char *options)
2413 {
2414         struct sci_port *sci_port;
2415         struct uart_port *port;
2416         int baud = 115200;
2417         int bits = 8;
2418         int parity = 'n';
2419         int flow = 'n';
2420         int ret;
2421
2422         /*
2423          * Refuse to handle any bogus ports.
2424          */
2425         if (co->index < 0 || co->index >= SCI_NPORTS)
2426                 return -ENODEV;
2427
2428         sci_port = &sci_ports[co->index];
2429         port = &sci_port->port;
2430
2431         /*
2432          * Refuse to handle uninitialized ports.
2433          */
2434         if (!port->ops)
2435                 return -ENODEV;
2436
2437         ret = sci_remap_port(port);
2438         if (unlikely(ret != 0))
2439                 return ret;
2440
2441         if (options)
2442                 uart_parse_options(options, &baud, &parity, &bits, &flow);
2443
2444         return uart_set_options(port, co, baud, parity, bits, flow);
2445 }
2446
2447 static struct console serial_console = {
2448         .name           = "ttySC",
2449         .device         = uart_console_device,
2450         .write          = serial_console_write,
2451         .setup          = serial_console_setup,
2452         .flags          = CON_PRINTBUFFER,
2453         .index          = -1,
2454         .data           = &sci_uart_driver,
2455 };
2456
2457 static struct console early_serial_console = {
2458         .name           = "early_ttySC",
2459         .write          = serial_console_write,
2460         .flags          = CON_PRINTBUFFER,
2461         .index          = -1,
2462 };
2463
2464 static char early_serial_buf[32];
2465
2466 static int sci_probe_earlyprintk(struct platform_device *pdev)
2467 {
2468         struct plat_sci_port *cfg = dev_get_platdata(&pdev->dev);
2469
2470         if (early_serial_console.data)
2471                 return -EEXIST;
2472
2473         early_serial_console.index = pdev->id;
2474
2475         sci_init_single(pdev, &sci_ports[pdev->id], pdev->id, cfg, true);
2476
2477         serial_console_setup(&early_serial_console, early_serial_buf);
2478
2479         if (!strstr(early_serial_buf, "keep"))
2480                 early_serial_console.flags |= CON_BOOT;
2481
2482         register_console(&early_serial_console);
2483         return 0;
2484 }
2485
2486 #define SCI_CONSOLE     (&serial_console)
2487
2488 #else
2489 static inline int sci_probe_earlyprintk(struct platform_device *pdev)
2490 {
2491         return -EINVAL;
2492 }
2493
2494 #define SCI_CONSOLE     NULL
2495
2496 #endif /* CONFIG_SERIAL_SH_SCI_CONSOLE */
2497
2498 static const char banner[] __initconst = "SuperH (H)SCI(F) driver initialized";
2499
2500 static struct uart_driver sci_uart_driver = {
2501         .owner          = THIS_MODULE,
2502         .driver_name    = "sci",
2503         .dev_name       = "ttySC",
2504         .major          = SCI_MAJOR,
2505         .minor          = SCI_MINOR_START,
2506         .nr             = SCI_NPORTS,
2507         .cons           = SCI_CONSOLE,
2508 };
2509
2510 static int sci_remove(struct platform_device *dev)
2511 {
2512         struct sci_port *port = platform_get_drvdata(dev);
2513
2514         cpufreq_unregister_notifier(&port->freq_transition,
2515                                     CPUFREQ_TRANSITION_NOTIFIER);
2516
2517         uart_remove_one_port(&sci_uart_driver, &port->port);
2518
2519         sci_cleanup_single(port);
2520
2521         return 0;
2522 }
2523
2524 struct sci_port_info {
2525         unsigned int type;
2526         unsigned int regtype;
2527 };
2528
2529 static const struct of_device_id of_sci_match[] = {
2530         {
2531                 .compatible = "renesas,scif",
2532                 .data = &(const struct sci_port_info) {
2533                         .type = PORT_SCIF,
2534                         .regtype = SCIx_SH4_SCIF_REGTYPE,
2535                 },
2536         }, {
2537                 .compatible = "renesas,scifa",
2538                 .data = &(const struct sci_port_info) {
2539                         .type = PORT_SCIFA,
2540                         .regtype = SCIx_SCIFA_REGTYPE,
2541                 },
2542         }, {
2543                 .compatible = "renesas,scifb",
2544                 .data = &(const struct sci_port_info) {
2545                         .type = PORT_SCIFB,
2546                         .regtype = SCIx_SCIFB_REGTYPE,
2547                 },
2548         }, {
2549                 .compatible = "renesas,hscif",
2550                 .data = &(const struct sci_port_info) {
2551                         .type = PORT_HSCIF,
2552                         .regtype = SCIx_HSCIF_REGTYPE,
2553                 },
2554         }, {
2555                 .compatible = "renesas,sci",
2556                 .data = &(const struct sci_port_info) {
2557                         .type = PORT_SCI,
2558                         .regtype = SCIx_SCI_REGTYPE,
2559                 },
2560         }, {
2561                 /* Terminator */
2562         },
2563 };
2564 MODULE_DEVICE_TABLE(of, of_sci_match);
2565
2566 static struct plat_sci_port *
2567 sci_parse_dt(struct platform_device *pdev, unsigned int *dev_id)
2568 {
2569         struct device_node *np = pdev->dev.of_node;
2570         const struct of_device_id *match;
2571         const struct sci_port_info *info;
2572         struct plat_sci_port *p;
2573         int id;
2574
2575         if (!IS_ENABLED(CONFIG_OF) || !np)
2576                 return NULL;
2577
2578         match = of_match_node(of_sci_match, pdev->dev.of_node);
2579         if (!match)
2580                 return NULL;
2581
2582         info = match->data;
2583
2584         p = devm_kzalloc(&pdev->dev, sizeof(struct plat_sci_port), GFP_KERNEL);
2585         if (!p)
2586                 return NULL;
2587
2588         /* Get the line number for the aliases node. */
2589         id = of_alias_get_id(np, "serial");
2590         if (id < 0) {
2591                 dev_err(&pdev->dev, "failed to get alias id (%d)\n", id);
2592                 return NULL;
2593         }
2594
2595         *dev_id = id;
2596
2597         p->flags = UPF_IOREMAP | UPF_BOOT_AUTOCONF;
2598         p->type = info->type;
2599         p->regtype = info->regtype;
2600         p->scscr = SCSCR_RE | SCSCR_TE;
2601
2602         return p;
2603 }
2604
2605 static int sci_probe_single(struct platform_device *dev,
2606                                       unsigned int index,
2607                                       struct plat_sci_port *p,
2608                                       struct sci_port *sciport)
2609 {
2610         int ret;
2611
2612         /* Sanity check */
2613         if (unlikely(index >= SCI_NPORTS)) {
2614                 dev_notice(&dev->dev, "Attempting to register port %d when only %d are available\n",
2615                            index+1, SCI_NPORTS);
2616                 dev_notice(&dev->dev, "Consider bumping CONFIG_SERIAL_SH_SCI_NR_UARTS!\n");
2617                 return -EINVAL;
2618         }
2619
2620         ret = sci_init_single(dev, sciport, index, p, false);
2621         if (ret)
2622                 return ret;
2623
2624         ret = uart_add_one_port(&sci_uart_driver, &sciport->port);
2625         if (ret) {
2626                 sci_cleanup_single(sciport);
2627                 return ret;
2628         }
2629
2630         return 0;
2631 }
2632
2633 static int sci_probe(struct platform_device *dev)
2634 {
2635         struct plat_sci_port *p;
2636         struct sci_port *sp;
2637         unsigned int dev_id;
2638         int ret;
2639
2640         /*
2641          * If we've come here via earlyprintk initialization, head off to
2642          * the special early probe. We don't have sufficient device state
2643          * to make it beyond this yet.
2644          */
2645         if (is_early_platform_device(dev))
2646                 return sci_probe_earlyprintk(dev);
2647
2648         if (dev->dev.of_node) {
2649                 p = sci_parse_dt(dev, &dev_id);
2650                 if (p == NULL)
2651                         return -EINVAL;
2652         } else {
2653                 p = dev->dev.platform_data;
2654                 if (p == NULL) {
2655                         dev_err(&dev->dev, "no platform data supplied\n");
2656                         return -EINVAL;
2657                 }
2658
2659                 dev_id = dev->id;
2660         }
2661
2662         sp = &sci_ports[dev_id];
2663         platform_set_drvdata(dev, sp);
2664
2665         ret = sci_probe_single(dev, dev_id, p, sp);
2666         if (ret)
2667                 return ret;
2668
2669         sp->freq_transition.notifier_call = sci_notifier;
2670
2671         ret = cpufreq_register_notifier(&sp->freq_transition,
2672                                         CPUFREQ_TRANSITION_NOTIFIER);
2673         if (unlikely(ret < 0)) {
2674                 uart_remove_one_port(&sci_uart_driver, &sp->port);
2675                 sci_cleanup_single(sp);
2676                 return ret;
2677         }
2678
2679 #ifdef CONFIG_SH_STANDARD_BIOS
2680         sh_bios_gdb_detach();
2681 #endif
2682
2683         return 0;
2684 }
2685
2686 static __maybe_unused int sci_suspend(struct device *dev)
2687 {
2688         struct sci_port *sport = dev_get_drvdata(dev);
2689
2690         if (sport)
2691                 uart_suspend_port(&sci_uart_driver, &sport->port);
2692
2693         return 0;
2694 }
2695
2696 static __maybe_unused int sci_resume(struct device *dev)
2697 {
2698         struct sci_port *sport = dev_get_drvdata(dev);
2699
2700         if (sport)
2701                 uart_resume_port(&sci_uart_driver, &sport->port);
2702
2703         return 0;
2704 }
2705
2706 static SIMPLE_DEV_PM_OPS(sci_dev_pm_ops, sci_suspend, sci_resume);
2707
2708 static struct platform_driver sci_driver = {
2709         .probe          = sci_probe,
2710         .remove         = sci_remove,
2711         .driver         = {
2712                 .name   = "sh-sci",
2713                 .pm     = &sci_dev_pm_ops,
2714                 .of_match_table = of_match_ptr(of_sci_match),
2715         },
2716 };
2717
2718 static int __init sci_init(void)
2719 {
2720         int ret;
2721
2722         pr_info("%s\n", banner);
2723
2724         ret = uart_register_driver(&sci_uart_driver);
2725         if (likely(ret == 0)) {
2726                 ret = platform_driver_register(&sci_driver);
2727                 if (unlikely(ret))
2728                         uart_unregister_driver(&sci_uart_driver);
2729         }
2730
2731         return ret;
2732 }
2733
2734 static void __exit sci_exit(void)
2735 {
2736         platform_driver_unregister(&sci_driver);
2737         uart_unregister_driver(&sci_uart_driver);
2738 }
2739
2740 #ifdef CONFIG_SERIAL_SH_SCI_CONSOLE
2741 early_platform_init_buffer("earlyprintk", &sci_driver,
2742                            early_serial_buf, ARRAY_SIZE(early_serial_buf));
2743 #endif
2744 module_init(sci_init);
2745 module_exit(sci_exit);
2746
2747 MODULE_LICENSE("GPL");
2748 MODULE_ALIAS("platform:sh-sci");
2749 MODULE_AUTHOR("Paul Mundt");
2750 MODULE_DESCRIPTION("SuperH (H)SCI(F) serial driver");