drivers/spi/spi-rspi.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * SH RSPI driver
   4  *
   5  * Copyright (C) 2012, 2013  Renesas Solutions Corp.
   6  * Copyright (C) 2014 Glider bvba
   7  *
   8  * Based on spi-sh.c:
   9  * Copyright (C) 2011 Renesas Solutions Corp.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/kernel.h>
  14 #include <linux/sched.h>
  15 #include <linux/errno.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/io.h>
  19 #include <linux/clk.h>
  20 #include <linux/dmaengine.h>
  21 #include <linux/dma-mapping.h>
  22 #include <linux/of_device.h>
  23 #include <linux/pm_runtime.h>
  24 #include <linux/sh_dma.h>
  25 #include <linux/spi/spi.h>
  26 #include <linux/spi/rspi.h>
  27 #include <linux/spinlock.h>
  28
  29 #define RSPI_SPCR               0x00    /* Control Register */
  30 #define RSPI_SSLP               0x01    /* Slave Select Polarity Register */
  31 #define RSPI_SPPCR              0x02    /* Pin Control Register */
  32 #define RSPI_SPSR               0x03    /* Status Register */
  33 #define RSPI_SPDR               0x04    /* Data Register */
  34 #define RSPI_SPSCR              0x08    /* Sequence Control Register */
  35 #define RSPI_SPSSR              0x09    /* Sequence Status Register */
  36 #define RSPI_SPBR               0x0a    /* Bit Rate Register */
  37 #define RSPI_SPDCR              0x0b    /* Data Control Register */
  38 #define RSPI_SPCKD              0x0c    /* Clock Delay Register */
  39 #define RSPI_SSLND              0x0d    /* Slave Select Negation Delay Register */
  40 #define RSPI_SPND               0x0e    /* Next-Access Delay Register */
  41 #define RSPI_SPCR2              0x0f    /* Control Register 2 (SH only) */
  42 #define RSPI_SPCMD0             0x10    /* Command Register 0 */
  43 #define RSPI_SPCMD1             0x12    /* Command Register 1 */
  44 #define RSPI_SPCMD2             0x14    /* Command Register 2 */
  45 #define RSPI_SPCMD3             0x16    /* Command Register 3 */
  46 #define RSPI_SPCMD4             0x18    /* Command Register 4 */
  47 #define RSPI_SPCMD5             0x1a    /* Command Register 5 */
  48 #define RSPI_SPCMD6             0x1c    /* Command Register 6 */
  49 #define RSPI_SPCMD7             0x1e    /* Command Register 7 */
  50 #define RSPI_SPCMD(i)           (RSPI_SPCMD0 + (i) * 2)
  51 #define RSPI_NUM_SPCMD          8
  52 #define RSPI_RZ_NUM_SPCMD       4
  53 #define QSPI_NUM_SPCMD          4
  54
  55 /* RSPI on RZ only */
  56 #define RSPI_SPBFCR             0x20    /* Buffer Control Register */
  57 #define RSPI_SPBFDR             0x22    /* Buffer Data Count Setting Register */
  58
  59 /* QSPI only */
  60 #define QSPI_SPBFCR             0x18    /* Buffer Control Register */
  61 #define QSPI_SPBDCR             0x1a    /* Buffer Data Count Register */
  62 #define QSPI_SPBMUL0            0x1c    /* Transfer Data Length Multiplier Setting Register 0 */
  63 #define QSPI_SPBMUL1            0x20    /* Transfer Data Length Multiplier Setting Register 1 */
  64 #define QSPI_SPBMUL2            0x24    /* Transfer Data Length Multiplier Setting Register 2 */
  65 #define QSPI_SPBMUL3            0x28    /* Transfer Data Length Multiplier Setting Register 3 */
  66 #define QSPI_SPBMUL(i)          (QSPI_SPBMUL0 + (i) * 4)
  67
  68 /* SPCR - Control Register */
  69 #define SPCR_SPRIE              0x80    /* Receive Interrupt Enable */
  70 #define SPCR_SPE                0x40    /* Function Enable */
  71 #define SPCR_SPTIE              0x20    /* Transmit Interrupt Enable */
  72 #define SPCR_SPEIE              0x10    /* Error Interrupt Enable */
  73 #define SPCR_MSTR               0x08    /* Master/Slave Mode Select */
  74 #define SPCR_MODFEN             0x04    /* Mode Fault Error Detection Enable */
  75 /* RSPI on SH only */
  76 #define SPCR_TXMD               0x02    /* TX Only Mode (vs. Full Duplex) */
  77 #define SPCR_SPMS               0x01    /* 3-wire Mode (vs. 4-wire) */
  78 /* QSPI on R-Car Gen2 only */
  79 #define SPCR_WSWAP              0x02    /* Word Swap of read-data for DMAC */
  80 #define SPCR_BSWAP              0x01    /* Byte Swap of read-data for DMAC */
  81
  82 /* SSLP - Slave Select Polarity Register */
  83 #define SSLP_SSLP(i)            BIT(i)  /* SSLi Signal Polarity Setting */
  84
  85 /* SPPCR - Pin Control Register */
  86 #define SPPCR_MOIFE             0x20    /* MOSI Idle Value Fixing Enable */
  87 #define SPPCR_MOIFV             0x10    /* MOSI Idle Fixed Value */
  88 #define SPPCR_SPOM              0x04
  89 #define SPPCR_SPLP2             0x02    /* Loopback Mode 2 (non-inverting) */
  90 #define SPPCR_SPLP              0x01    /* Loopback Mode (inverting) */
  91
  92 #define SPPCR_IO3FV             0x04    /* Single-/Dual-SPI Mode IO3 Output Fixed Value */
  93 #define SPPCR_IO2FV             0x04    /* Single-/Dual-SPI Mode IO2 Output Fixed Value */
  94
  95 /* SPSR - Status Register */
  96 #define SPSR_SPRF               0x80    /* Receive Buffer Full Flag */
  97 #define SPSR_TEND               0x40    /* Transmit End */
  98 #define SPSR_SPTEF              0x20    /* Transmit Buffer Empty Flag */
  99 #define SPSR_PERF               0x08    /* Parity Error Flag */
 100 #define SPSR_MODF               0x04    /* Mode Fault Error Flag */
 101 #define SPSR_IDLNF              0x02    /* RSPI Idle Flag */
 102 #define SPSR_OVRF               0x01    /* Overrun Error Flag (RSPI only) */
 103
 104 /* SPSCR - Sequence Control Register */
 105 #define SPSCR_SPSLN_MASK        0x07    /* Sequence Length Specification */
 106
 107 /* SPSSR - Sequence Status Register */
 108 #define SPSSR_SPECM_MASK        0x70    /* Command Error Mask */
 109 #define SPSSR_SPCP_MASK         0x07    /* Command Pointer Mask */
 110
 111 /* SPDCR - Data Control Register */
 112 #define SPDCR_TXDMY             0x80    /* Dummy Data Transmission Enable */
 113 #define SPDCR_SPLW1             0x40    /* Access Width Specification (RZ) */
 114 #define SPDCR_SPLW0             0x20    /* Access Width Specification (RZ) */
 115 #define SPDCR_SPLLWORD          (SPDCR_SPLW1 | SPDCR_SPLW0)
 116 #define SPDCR_SPLWORD           SPDCR_SPLW1
 117 #define SPDCR_SPLBYTE           SPDCR_SPLW0
 118 #define SPDCR_SPLW              0x20    /* Access Width Specification (SH) */
 119 #define SPDCR_SPRDTD            0x10    /* Receive Transmit Data Select (SH) */
 120 #define SPDCR_SLSEL1            0x08
 121 #define SPDCR_SLSEL0            0x04
 122 #define SPDCR_SLSEL_MASK        0x0c    /* SSL1 Output Select (SH) */
 123 #define SPDCR_SPFC1             0x02
 124 #define SPDCR_SPFC0             0x01
 125 #define SPDCR_SPFC_MASK         0x03    /* Frame Count Setting (1-4) (SH) */
 126
 127 /* SPCKD - Clock Delay Register */
 128 #define SPCKD_SCKDL_MASK        0x07    /* Clock Delay Setting (1-8) */
 129
 130 /* SSLND - Slave Select Negation Delay Register */
 131 #define SSLND_SLNDL_MASK        0x07    /* SSL Negation Delay Setting (1-8) */
 132
 133 /* SPND - Next-Access Delay Register */
 134 #define SPND_SPNDL_MASK         0x07    /* Next-Access Delay Setting (1-8) */
 135
 136 /* SPCR2 - Control Register 2 */
 137 #define SPCR2_PTE               0x08    /* Parity Self-Test Enable */
 138 #define SPCR2_SPIE              0x04    /* Idle Interrupt Enable */
 139 #define SPCR2_SPOE              0x02    /* Odd Parity Enable (vs. Even) */
 140 #define SPCR2_SPPE              0x01    /* Parity Enable */
 141
 142 /* SPCMDn - Command Registers */
 143 #define SPCMD_SCKDEN            0x8000  /* Clock Delay Setting Enable */
 144 #define SPCMD_SLNDEN            0x4000  /* SSL Negation Delay Setting Enable */
 145 #define SPCMD_SPNDEN            0x2000  /* Next-Access Delay Enable */
 146 #define SPCMD_LSBF              0x1000  /* LSB First */
 147 #define SPCMD_SPB_MASK          0x0f00  /* Data Length Setting */
 148 #define SPCMD_SPB_8_TO_16(bit)  (((bit - 1) << 8) & SPCMD_SPB_MASK)
 149 #define SPCMD_SPB_8BIT          0x0000  /* QSPI only */
 150 #define SPCMD_SPB_16BIT         0x0100
 151 #define SPCMD_SPB_20BIT         0x0000
 152 #define SPCMD_SPB_24BIT         0x0100
 153 #define SPCMD_SPB_32BIT         0x0200
 154 #define SPCMD_SSLKP             0x0080  /* SSL Signal Level Keeping */
 155 #define SPCMD_SPIMOD_MASK       0x0060  /* SPI Operating Mode (QSPI only) */
 156 #define SPCMD_SPIMOD1           0x0040
 157 #define SPCMD_SPIMOD0           0x0020
 158 #define SPCMD_SPIMOD_SINGLE     0
 159 #define SPCMD_SPIMOD_DUAL       SPCMD_SPIMOD0
 160 #define SPCMD_SPIMOD_QUAD       SPCMD_SPIMOD1
 161 #define SPCMD_SPRW              0x0010  /* SPI Read/Write Access (Dual/Quad) */
 162 #define SPCMD_SSLA(i)           ((i) << 4)      /* SSL Assert Signal Setting */
 163 #define SPCMD_BRDV_MASK         0x000c  /* Bit Rate Division Setting */
 164 #define SPCMD_BRDV(brdv)        ((brdv) << 2)
 165 #define SPCMD_CPOL              0x0002  /* Clock Polarity Setting */
 166 #define SPCMD_CPHA              0x0001  /* Clock Phase Setting */
 167
 168 /* SPBFCR - Buffer Control Register */
 169 #define SPBFCR_TXRST            0x80    /* Transmit Buffer Data Reset */
 170 #define SPBFCR_RXRST            0x40    /* Receive Buffer Data Reset */
 171 #define SPBFCR_TXTRG_MASK       0x30    /* Transmit Buffer Data Triggering Number */
 172 #define SPBFCR_RXTRG_MASK       0x07    /* Receive Buffer Data Triggering Number */
 173 /* QSPI on R-Car Gen2 */
 174 #define SPBFCR_TXTRG_1B         0x00    /* 31 bytes (1 byte available) */
 175 #define SPBFCR_TXTRG_32B        0x30    /* 0 byte (32 bytes available) */
 176 #define SPBFCR_RXTRG_1B         0x00    /* 1 byte (31 bytes available) */
 177 #define SPBFCR_RXTRG_32B        0x07    /* 32 bytes (0 byte available) */
 178
 179 #define QSPI_BUFFER_SIZE        32u
 180
 181 struct rspi_data {
 182         void __iomem *addr;
 183         u32 speed_hz;
 184         struct spi_controller *ctlr;
 185         struct platform_device *pdev;
 186         wait_queue_head_t wait;
 187         spinlock_t lock;                /* Protects RMW-access to RSPI_SSLP */
 188         struct clk *clk;
 189         u16 spcmd;
 190         u8 spsr;
 191         u8 sppcr;
 192         int rx_irq, tx_irq;
 193         const struct spi_ops *ops;
 194
 195         unsigned dma_callbacked:1;
 196         unsigned byte_access:1;
 197 };
 198
 199 static void rspi_write8(const struct rspi_data *rspi, u8 data, u16 offset)
 200 {
 201         iowrite8(data, rspi->addr + offset);
 202 }
 203
 204 static void rspi_write16(const struct rspi_data *rspi, u16 data, u16 offset)
 205 {
 206         iowrite16(data, rspi->addr + offset);
 207 }
 208
 209 static void rspi_write32(const struct rspi_data *rspi, u32 data, u16 offset)
 210 {
 211         iowrite32(data, rspi->addr + offset);
 212 }
 213
 214 static u8 rspi_read8(const struct rspi_data *rspi, u16 offset)
 215 {
 216         return ioread8(rspi->addr + offset);
 217 }
 218
 219 static u16 rspi_read16(const struct rspi_data *rspi, u16 offset)
 220 {
 221         return ioread16(rspi->addr + offset);
 222 }
 223
 224 static void rspi_write_data(const struct rspi_data *rspi, u16 data)
 225 {
 226         if (rspi->byte_access)
 227                 rspi_write8(rspi, data, RSPI_SPDR);
 228         else /* 16 bit */
 229                 rspi_write16(rspi, data, RSPI_SPDR);
 230 }
 231
 232 static u16 rspi_read_data(const struct rspi_data *rspi)
 233 {
 234         if (rspi->byte_access)
 235                 return rspi_read8(rspi, RSPI_SPDR);
 236         else /* 16 bit */
 237                 return rspi_read16(rspi, RSPI_SPDR);
 238 }
 239
 240 /* optional functions */
 241 struct spi_ops {
 242         int (*set_config_register)(struct rspi_data *rspi, int access_size);
 243         int (*transfer_one)(struct spi_controller *ctlr,
 244                             struct spi_device *spi, struct spi_transfer *xfer);
 245         u16 extra_mode_bits;
 246         u16 flags;
 247         u16 fifo_size;
 248         u8 num_hw_ss;
 249 };
 250
 251 /*
 252  * functions for RSPI on legacy SH
 253  */
 254 static int rspi_set_config_register(struct rspi_data *rspi, int access_size)
 255 {
 256         int spbr;
 257
 258         /* Sets output mode, MOSI signal, and (optionally) loopback */
 259         rspi_write8(rspi, rspi->sppcr, RSPI_SPPCR);
 260
 261         /* Sets transfer bit rate */
 262         spbr = DIV_ROUND_UP(clk_get_rate(rspi->clk), 2 * rspi->speed_hz) - 1;
 263         rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
 264
 265         /* Disable dummy transmission, set 16-bit word access, 1 frame */
 266         rspi_write8(rspi, 0, RSPI_SPDCR);
 267         rspi->byte_access = 0;
 268
 269         /* Sets RSPCK, SSL, next-access delay value */
 270         rspi_write8(rspi, 0x00, RSPI_SPCKD);
 271         rspi_write8(rspi, 0x00, RSPI_SSLND);
 272         rspi_write8(rspi, 0x00, RSPI_SPND);
 273
 274         /* Sets parity, interrupt mask */
 275         rspi_write8(rspi, 0x00, RSPI_SPCR2);
 276
 277         /* Resets sequencer */
 278         rspi_write8(rspi, 0, RSPI_SPSCR);
 279         rspi->spcmd |= SPCMD_SPB_8_TO_16(access_size);
 280         rspi_write16(rspi, rspi->spcmd, RSPI_SPCMD0);
 281
 282         /* Sets RSPI mode */
 283         rspi_write8(rspi, SPCR_MSTR, RSPI_SPCR);
 284
 285         return 0;
 286 }
 287
 288 /*
 289  * functions for RSPI on RZ
 290  */
 291 static int rspi_rz_set_config_register(struct rspi_data *rspi, int access_size)
 292 {
 293         int spbr;
 294         int brdv = 0;
 295         unsigned long clksrc;
 296
 297         /* Sets output mode, MOSI signal, and (optionally) loopback */
 298         rspi_write8(rspi, rspi->sppcr, RSPI_SPPCR);
 299
 300         clksrc = clk_get_rate(rspi->clk);
 301         spbr = DIV_ROUND_UP(clksrc, 2 * rspi->speed_hz) - 1;
 302         while (spbr > 255 && brdv < 3) {
 303                 brdv++;
 304                 spbr = DIV_ROUND_UP(spbr + 1, 2) - 1;
 305         }
 306
 307         /* Sets transfer bit rate */
 308         rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
 309         rspi->spcmd |= SPCMD_BRDV(brdv);
 310
 311         /* Disable dummy transmission, set byte access */
 312         rspi_write8(rspi, SPDCR_SPLBYTE, RSPI_SPDCR);
 313         rspi->byte_access = 1;
 314
 315         /* Sets RSPCK, SSL, next-access delay value */
 316         rspi_write8(rspi, 0x00, RSPI_SPCKD);
 317         rspi_write8(rspi, 0x00, RSPI_SSLND);
 318         rspi_write8(rspi, 0x00, RSPI_SPND);
 319
 320         /* Resets sequencer */
 321         rspi_write8(rspi, 0, RSPI_SPSCR);
 322         rspi->spcmd |= SPCMD_SPB_8_TO_16(access_size);
 323         rspi_write16(rspi, rspi->spcmd, RSPI_SPCMD0);
 324
 325         /* Sets RSPI mode */
 326         rspi_write8(rspi, SPCR_MSTR, RSPI_SPCR);
 327
 328         return 0;
 329 }
 330
 331 /*
 332  * functions for QSPI
 333  */
 334 static int qspi_set_config_register(struct rspi_data *rspi, int access_size)
 335 {
 336         int spbr;
 337
 338         /* Sets output mode, MOSI signal, and (optionally) loopback */
 339         rspi_write8(rspi, rspi->sppcr, RSPI_SPPCR);
 340
 341         /* Sets transfer bit rate */
 342         spbr = DIV_ROUND_UP(clk_get_rate(rspi->clk), 2 * rspi->speed_hz);
 343         rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
 344
 345         /* Disable dummy transmission, set byte access */
 346         rspi_write8(rspi, 0, RSPI_SPDCR);
 347         rspi->byte_access = 1;
 348
 349         /* Sets RSPCK, SSL, next-access delay value */
 350         rspi_write8(rspi, 0x00, RSPI_SPCKD);
 351         rspi_write8(rspi, 0x00, RSPI_SSLND);
 352         rspi_write8(rspi, 0x00, RSPI_SPND);
 353
 354         /* Data Length Setting */
 355         if (access_size == 8)
 356                 rspi->spcmd |= SPCMD_SPB_8BIT;
 357         else if (access_size == 16)
 358                 rspi->spcmd |= SPCMD_SPB_16BIT;
 359         else
 360                 rspi->spcmd |= SPCMD_SPB_32BIT;
 361
 362         rspi->spcmd |= SPCMD_SCKDEN | SPCMD_SLNDEN | SPCMD_SPNDEN;
 363
 364         /* Resets transfer data length */
 365         rspi_write32(rspi, 0, QSPI_SPBMUL0);
 366
 367         /* Resets transmit and receive buffer */
 368         rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, QSPI_SPBFCR);
 369         /* Sets buffer to allow normal operation */
 370         rspi_write8(rspi, 0x00, QSPI_SPBFCR);
 371
 372         /* Resets sequencer */
 373         rspi_write8(rspi, 0, RSPI_SPSCR);
 374         rspi_write16(rspi, rspi->spcmd, RSPI_SPCMD0);
 375
 376         /* Sets RSPI mode */
 377         rspi_write8(rspi, SPCR_MSTR, RSPI_SPCR);
 378
 379         return 0;
 380 }
 381
 382 static void qspi_update(const struct rspi_data *rspi, u8 mask, u8 val, u8 reg)
 383 {
 384         u8 data;
 385
 386         data = rspi_read8(rspi, reg);
 387         data &= ~mask;
 388         data |= (val & mask);
 389         rspi_write8(rspi, data, reg);
 390 }
 391
 392 static unsigned int qspi_set_send_trigger(struct rspi_data *rspi,
 393                                           unsigned int len)
 394 {
 395         unsigned int n;
 396
 397         n = min(len, QSPI_BUFFER_SIZE);
 398
 399         if (len >= QSPI_BUFFER_SIZE) {
 400                 /* sets triggering number to 32 bytes */
 401                 qspi_update(rspi, SPBFCR_TXTRG_MASK,
 402                              SPBFCR_TXTRG_32B, QSPI_SPBFCR);
 403         } else {
 404                 /* sets triggering number to 1 byte */
 405                 qspi_update(rspi, SPBFCR_TXTRG_MASK,
 406                              SPBFCR_TXTRG_1B, QSPI_SPBFCR);
 407         }
 408
 409         return n;
 410 }
 411
 412 static int qspi_set_receive_trigger(struct rspi_data *rspi, unsigned int len)
 413 {
 414         unsigned int n;
 415
 416         n = min(len, QSPI_BUFFER_SIZE);
 417
 418         if (len >= QSPI_BUFFER_SIZE) {
 419                 /* sets triggering number to 32 bytes */
 420                 qspi_update(rspi, SPBFCR_RXTRG_MASK,
 421                              SPBFCR_RXTRG_32B, QSPI_SPBFCR);
 422         } else {
 423                 /* sets triggering number to 1 byte */
 424                 qspi_update(rspi, SPBFCR_RXTRG_MASK,
 425                              SPBFCR_RXTRG_1B, QSPI_SPBFCR);
 426         }
 427         return n;
 428 }
 429
 430 static void rspi_enable_irq(const struct rspi_data *rspi, u8 enable)
 431 {
 432         rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) | enable, RSPI_SPCR);
 433 }
 434
 435 static void rspi_disable_irq(const struct rspi_data *rspi, u8 disable)
 436 {
 437         rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) & ~disable, RSPI_SPCR);
 438 }
 439
 440 static int rspi_wait_for_interrupt(struct rspi_data *rspi, u8 wait_mask,
 441                                    u8 enable_bit)
 442 {
 443         int ret;
 444
 445         rspi->spsr = rspi_read8(rspi, RSPI_SPSR);
 446         if (rspi->spsr & wait_mask)
 447                 return 0;
 448
 449         rspi_enable_irq(rspi, enable_bit);
 450         ret = wait_event_timeout(rspi->wait, rspi->spsr & wait_mask, HZ);
 451         if (ret == 0 && !(rspi->spsr & wait_mask))
 452                 return -ETIMEDOUT;
 453
 454         return 0;
 455 }
 456
 457 static inline int rspi_wait_for_tx_empty(struct rspi_data *rspi)
 458 {
 459         return rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE);
 460 }
 461
 462 static inline int rspi_wait_for_rx_full(struct rspi_data *rspi)
 463 {
 464         return rspi_wait_for_interrupt(rspi, SPSR_SPRF, SPCR_SPRIE);
 465 }
 466
 467 static int rspi_data_out(struct rspi_data *rspi, u8 data)
 468 {
 469         int error = rspi_wait_for_tx_empty(rspi);
 470         if (error < 0) {
 471                 dev_err(&rspi->ctlr->dev, "transmit timeout\n");
 472                 return error;
 473         }
 474         rspi_write_data(rspi, data);
 475         return 0;
 476 }
 477
 478 static int rspi_data_in(struct rspi_data *rspi)
 479 {
 480         int error;
 481         u8 data;
 482
 483         error = rspi_wait_for_rx_full(rspi);
 484         if (error < 0) {
 485                 dev_err(&rspi->ctlr->dev, "receive timeout\n");
 486                 return error;
 487         }
 488         data = rspi_read_data(rspi);
 489         return data;
 490 }
 491
 492 static int rspi_pio_transfer(struct rspi_data *rspi, const u8 *tx, u8 *rx,
 493                              unsigned int n)
 494 {
 495         while (n-- > 0) {
 496                 if (tx) {
 497                         int ret = rspi_data_out(rspi, *tx++);
 498                         if (ret < 0)
 499                                 return ret;
 500                 }
 501                 if (rx) {
 502                         int ret = rspi_data_in(rspi);
 503                         if (ret < 0)
 504                                 return ret;
 505                         *rx++ = ret;
 506                 }
 507         }
 508
 509         return 0;
 510 }
 511
 512 static void rspi_dma_complete(void *arg)
 513 {
 514         struct rspi_data *rspi = arg;
 515
 516         rspi->dma_callbacked = 1;
 517         wake_up_interruptible(&rspi->wait);
 518 }
 519
 520 static int rspi_dma_transfer(struct rspi_data *rspi, struct sg_table *tx,
 521                              struct sg_table *rx)
 522 {
 523         struct dma_async_tx_descriptor *desc_tx = NULL, *desc_rx = NULL;
 524         u8 irq_mask = 0;
 525         unsigned int other_irq = 0;
 526         dma_cookie_t cookie;
 527         int ret;
 528
 529         /* First prepare and submit the DMA request(s), as this may fail */
 530         if (rx) {
 531                 desc_rx = dmaengine_prep_slave_sg(rspi->ctlr->dma_rx, rx->sgl,
 532                                         rx->nents, DMA_DEV_TO_MEM,
 533                                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 534                 if (!desc_rx) {
 535                         ret = -EAGAIN;
 536                         goto no_dma_rx;
 537                 }
 538
 539                 desc_rx->callback = rspi_dma_complete;
 540                 desc_rx->callback_param = rspi;
 541                 cookie = dmaengine_submit(desc_rx);
 542                 if (dma_submit_error(cookie)) {
 543                         ret = cookie;
 544                         goto no_dma_rx;
 545                 }
 546
 547                 irq_mask |= SPCR_SPRIE;
 548         }
 549
 550         if (tx) {
 551                 desc_tx = dmaengine_prep_slave_sg(rspi->ctlr->dma_tx, tx->sgl,
 552                                         tx->nents, DMA_MEM_TO_DEV,
 553                                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 554                 if (!desc_tx) {
 555                         ret = -EAGAIN;
 556                         goto no_dma_tx;
 557                 }
 558
 559                 if (rx) {
 560                         /* No callback */
 561                         desc_tx->callback = NULL;
 562                 } else {
 563                         desc_tx->callback = rspi_dma_complete;
 564                         desc_tx->callback_param = rspi;
 565                 }
 566                 cookie = dmaengine_submit(desc_tx);
 567                 if (dma_submit_error(cookie)) {
 568                         ret = cookie;
 569                         goto no_dma_tx;
 570                 }
 571
 572                 irq_mask |= SPCR_SPTIE;
 573         }
 574
 575         /*
 576          * DMAC needs SPxIE, but if SPxIE is set, the IRQ routine will be
 577          * called. So, this driver disables the IRQ while DMA transfer.
 578          */
 579         if (tx)
 580                 disable_irq(other_irq = rspi->tx_irq);
 581         if (rx && rspi->rx_irq != other_irq)
 582                 disable_irq(rspi->rx_irq);
 583
 584         rspi_enable_irq(rspi, irq_mask);
 585         rspi->dma_callbacked = 0;
 586
 587         /* Now start DMA */
 588         if (rx)
 589                 dma_async_issue_pending(rspi->ctlr->dma_rx);
 590         if (tx)
 591                 dma_async_issue_pending(rspi->ctlr->dma_tx);
 592
 593         ret = wait_event_interruptible_timeout(rspi->wait,
 594                                                rspi->dma_callbacked, HZ);
 595         if (ret > 0 && rspi->dma_callbacked) {
 596                 ret = 0;
 597         } else {
 598                 if (!ret) {
 599                         dev_err(&rspi->ctlr->dev, "DMA timeout\n");
 600                         ret = -ETIMEDOUT;
 601                 }
 602                 if (tx)
 603                         dmaengine_terminate_all(rspi->ctlr->dma_tx);
 604                 if (rx)
 605                         dmaengine_terminate_all(rspi->ctlr->dma_rx);
 606         }
 607
 608         rspi_disable_irq(rspi, irq_mask);
 609
 610         if (tx)
 611                 enable_irq(rspi->tx_irq);
 612         if (rx && rspi->rx_irq != other_irq)
 613                 enable_irq(rspi->rx_irq);
 614
 615         return ret;
 616
 617 no_dma_tx:
 618         if (rx)
 619                 dmaengine_terminate_all(rspi->ctlr->dma_rx);
 620 no_dma_rx:
 621         if (ret == -EAGAIN) {
 622                 dev_warn_once(&rspi->ctlr->dev,
 623                               "DMA not available, falling back to PIO\n");
 624         }
 625         return ret;
 626 }
 627
 628 static void rspi_receive_init(const struct rspi_data *rspi)
 629 {
 630         u8 spsr;
 631
 632         spsr = rspi_read8(rspi, RSPI_SPSR);
 633         if (spsr & SPSR_SPRF)
 634                 rspi_read_data(rspi);   /* dummy read */
 635         if (spsr & SPSR_OVRF)
 636                 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPSR) & ~SPSR_OVRF,
 637                             RSPI_SPSR);
 638 }
 639
 640 static void rspi_rz_receive_init(const struct rspi_data *rspi)
 641 {
 642         rspi_receive_init(rspi);
 643         rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, RSPI_SPBFCR);
 644         rspi_write8(rspi, 0, RSPI_SPBFCR);
 645 }
 646
 647 static void qspi_receive_init(const struct rspi_data *rspi)
 648 {
 649         u8 spsr;
 650
 651         spsr = rspi_read8(rspi, RSPI_SPSR);
 652         if (spsr & SPSR_SPRF)
 653                 rspi_read_data(rspi);   /* dummy read */
 654         rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, QSPI_SPBFCR);
 655         rspi_write8(rspi, 0, QSPI_SPBFCR);
 656 }
 657
 658 static bool __rspi_can_dma(const struct rspi_data *rspi,
 659                            const struct spi_transfer *xfer)
 660 {
 661         return xfer->len > rspi->ops->fifo_size;
 662 }
 663
 664 static bool rspi_can_dma(struct spi_controller *ctlr, struct spi_device *spi,
 665                          struct spi_transfer *xfer)
 666 {
 667         struct rspi_data *rspi = spi_controller_get_devdata(ctlr);
 668
 669         return __rspi_can_dma(rspi, xfer);
 670 }
 671
 672 static int rspi_dma_check_then_transfer(struct rspi_data *rspi,
 673                                          struct spi_transfer *xfer)
 674 {
 675         if (!rspi->ctlr->can_dma || !__rspi_can_dma(rspi, xfer))
 676                 return -EAGAIN;
 677
 678         /* rx_buf can be NULL on RSPI on SH in TX-only Mode */
 679         return rspi_dma_transfer(rspi, &xfer->tx_sg,
 680                                 xfer->rx_buf ? &xfer->rx_sg : NULL);
 681 }
 682
 683 static int rspi_common_transfer(struct rspi_data *rspi,
 684                                 struct spi_transfer *xfer)
 685 {
 686         int ret;
 687
 688         ret = rspi_dma_check_then_transfer(rspi, xfer);
 689         if (ret != -EAGAIN)
 690                 return ret;
 691
 692         ret = rspi_pio_transfer(rspi, xfer->tx_buf, xfer->rx_buf, xfer->len);
 693         if (ret < 0)
 694                 return ret;
 695
 696         /* Wait for the last transmission */
 697         rspi_wait_for_tx_empty(rspi);
 698
 699         return 0;
 700 }
 701
 702 static int rspi_transfer_one(struct spi_controller *ctlr,
 703                              struct spi_device *spi, struct spi_transfer *xfer)
 704 {
 705         struct rspi_data *rspi = spi_controller_get_devdata(ctlr);
 706         u8 spcr;
 707
 708         spcr = rspi_read8(rspi, RSPI_SPCR);
 709         if (xfer->rx_buf) {
 710                 rspi_receive_init(rspi);
 711                 spcr &= ~SPCR_TXMD;
 712         } else {
 713                 spcr |= SPCR_TXMD;
 714         }
 715         rspi_write8(rspi, spcr, RSPI_SPCR);
 716
 717         return rspi_common_transfer(rspi, xfer);
 718 }
 719
 720 static int rspi_rz_transfer_one(struct spi_controller *ctlr,
 721                                 struct spi_device *spi,
 722                                 struct spi_transfer *xfer)
 723 {
 724         struct rspi_data *rspi = spi_controller_get_devdata(ctlr);
 725
 726         rspi_rz_receive_init(rspi);
 727
 728         return rspi_common_transfer(rspi, xfer);
 729 }
 730
 731 static int qspi_trigger_transfer_out_in(struct rspi_data *rspi, const u8 *tx,
 732                                         u8 *rx, unsigned int len)
 733 {
 734         unsigned int i, n;
 735         int ret;
 736
 737         while (len > 0) {
 738                 n = qspi_set_send_trigger(rspi, len);
 739                 qspi_set_receive_trigger(rspi, len);
 740                 ret = rspi_wait_for_tx_empty(rspi);
 741                 if (ret < 0) {
 742                         dev_err(&rspi->ctlr->dev, "transmit timeout\n");
 743                         return ret;
 744                 }
 745                 for (i = 0; i < n; i++)
 746                         rspi_write_data(rspi, *tx++);
 747
 748                 ret = rspi_wait_for_rx_full(rspi);
 749                 if (ret < 0) {
 750                         dev_err(&rspi->ctlr->dev, "receive timeout\n");
 751                         return ret;
 752                 }
 753                 for (i = 0; i < n; i++)
 754                         *rx++ = rspi_read_data(rspi);
 755
 756                 len -= n;
 757         }
 758
 759         return 0;
 760 }
 761
 762 static int qspi_transfer_out_in(struct rspi_data *rspi,
 763                                 struct spi_transfer *xfer)
 764 {
 765         int ret;
 766
 767         qspi_receive_init(rspi);
 768
 769         ret = rspi_dma_check_then_transfer(rspi, xfer);
 770         if (ret != -EAGAIN)
 771                 return ret;
 772
 773         return qspi_trigger_transfer_out_in(rspi, xfer->tx_buf,
 774                                             xfer->rx_buf, xfer->len);
 775 }
 776
 777 static int qspi_transfer_out(struct rspi_data *rspi, struct spi_transfer *xfer)
 778 {
 779         const u8 *tx = xfer->tx_buf;
 780         unsigned int n = xfer->len;
 781         unsigned int i, len;
 782         int ret;
 783
 784         if (rspi->ctlr->can_dma && __rspi_can_dma(rspi, xfer)) {
 785                 ret = rspi_dma_transfer(rspi, &xfer->tx_sg, NULL);
 786                 if (ret != -EAGAIN)
 787                         return ret;
 788         }
 789
 790         while (n > 0) {
 791                 len = qspi_set_send_trigger(rspi, n);
 792                 ret = rspi_wait_for_tx_empty(rspi);
 793                 if (ret < 0) {
 794                         dev_err(&rspi->ctlr->dev, "transmit timeout\n");
 795                         return ret;
 796                 }
 797                 for (i = 0; i < len; i++)
 798                         rspi_write_data(rspi, *tx++);
 799
 800                 n -= len;
 801         }
 802
 803         /* Wait for the last transmission */
 804         rspi_wait_for_tx_empty(rspi);
 805
 806         return 0;
 807 }
 808
 809 static int qspi_transfer_in(struct rspi_data *rspi, struct spi_transfer *xfer)
 810 {
 811         u8 *rx = xfer->rx_buf;
 812         unsigned int n = xfer->len;
 813         unsigned int i, len;
 814         int ret;
 815
 816         if (rspi->ctlr->can_dma && __rspi_can_dma(rspi, xfer)) {
 817                 int ret = rspi_dma_transfer(rspi, NULL, &xfer->rx_sg);
 818                 if (ret != -EAGAIN)
 819                         return ret;
 820         }
 821
 822         while (n > 0) {
 823                 len = qspi_set_receive_trigger(rspi, n);
 824                 ret = rspi_wait_for_rx_full(rspi);
 825                 if (ret < 0) {
 826                         dev_err(&rspi->ctlr->dev, "receive timeout\n");
 827                         return ret;
 828                 }
 829                 for (i = 0; i < len; i++)
 830                         *rx++ = rspi_read_data(rspi);
 831
 832                 n -= len;
 833         }
 834
 835         return 0;
 836 }
 837
 838 static int qspi_transfer_one(struct spi_controller *ctlr,
 839                              struct spi_device *spi, struct spi_transfer *xfer)
 840 {
 841         struct rspi_data *rspi = spi_controller_get_devdata(ctlr);
 842
 843         if (spi->mode & SPI_LOOP) {
 844                 return qspi_transfer_out_in(rspi, xfer);
 845         } else if (xfer->tx_nbits > SPI_NBITS_SINGLE) {
 846                 /* Quad or Dual SPI Write */
 847                 return qspi_transfer_out(rspi, xfer);
 848         } else if (xfer->rx_nbits > SPI_NBITS_SINGLE) {
 849                 /* Quad or Dual SPI Read */
 850                 return qspi_transfer_in(rspi, xfer);
 851         } else {
 852                 /* Single SPI Transfer */
 853                 return qspi_transfer_out_in(rspi, xfer);
 854         }
 855 }
 856
 857 static u16 qspi_transfer_mode(const struct spi_transfer *xfer)
 858 {
 859         if (xfer->tx_buf)
 860                 switch (xfer->tx_nbits) {
 861                 case SPI_NBITS_QUAD:
 862                         return SPCMD_SPIMOD_QUAD;
 863                 case SPI_NBITS_DUAL:
 864                         return SPCMD_SPIMOD_DUAL;
 865                 default:
 866                         return 0;
 867                 }
 868         if (xfer->rx_buf)
 869                 switch (xfer->rx_nbits) {
 870                 case SPI_NBITS_QUAD:
 871                         return SPCMD_SPIMOD_QUAD | SPCMD_SPRW;
 872                 case SPI_NBITS_DUAL:
 873                         return SPCMD_SPIMOD_DUAL | SPCMD_SPRW;
 874                 default:
 875                         return 0;
 876                 }
 877
 878         return 0;
 879 }
 880
 881 static int qspi_setup_sequencer(struct rspi_data *rspi,
 882                                 const struct spi_message *msg)
 883 {
 884         const struct spi_transfer *xfer;
 885         unsigned int i = 0, len = 0;
 886         u16 current_mode = 0xffff, mode;
 887
 888         list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 889                 mode = qspi_transfer_mode(xfer);
 890                 if (mode == current_mode) {
 891                         len += xfer->len;
 892                         continue;
 893                 }
 894
 895                 /* Transfer mode change */
 896                 if (i) {
 897                         /* Set transfer data length of previous transfer */
 898                         rspi_write32(rspi, len, QSPI_SPBMUL(i - 1));
 899                 }
 900
 901                 if (i >= QSPI_NUM_SPCMD) {
 902                         dev_err(&msg->spi->dev,
 903                                 "Too many different transfer modes");
 904                         return -EINVAL;
 905                 }
 906
 907                 /* Program transfer mode for this transfer */
 908                 rspi_write16(rspi, rspi->spcmd | mode, RSPI_SPCMD(i));
 909                 current_mode = mode;
 910                 len = xfer->len;
 911                 i++;
 912         }
 913         if (i) {
 914                 /* Set final transfer data length and sequence length */
 915                 rspi_write32(rspi, len, QSPI_SPBMUL(i - 1));
 916                 rspi_write8(rspi, i - 1, RSPI_SPSCR);
 917         }
 918
 919         return 0;
 920 }
 921
 922 static int rspi_setup(struct spi_device *spi)
 923 {
 924         struct rspi_data *rspi = spi_controller_get_devdata(spi->controller);
 925         u8 sslp;
 926
 927         if (spi->cs_gpiod)
 928                 return 0;
 929
 930         pm_runtime_get_sync(&rspi->pdev->dev);
 931         spin_lock_irq(&rspi->lock);
 932
 933         sslp = rspi_read8(rspi, RSPI_SSLP);
 934         if (spi->mode & SPI_CS_HIGH)
 935                 sslp |= SSLP_SSLP(spi->chip_select);
 936         else
 937                 sslp &= ~SSLP_SSLP(spi->chip_select);
 938         rspi_write8(rspi, sslp, RSPI_SSLP);
 939
 940         spin_unlock_irq(&rspi->lock);
 941         pm_runtime_put(&rspi->pdev->dev);
 942         return 0;
 943 }
 944
 945 static int rspi_prepare_message(struct spi_controller *ctlr,
 946                                 struct spi_message *msg)
 947 {
 948         struct rspi_data *rspi = spi_controller_get_devdata(ctlr);
 949         struct spi_device *spi = msg->spi;
 950         const struct spi_transfer *xfer;
 951         int ret;
 952
 953         /*
 954          * As the Bit Rate Register must not be changed while the device is
 955          * active, all transfers in a message must use the same bit rate.
 956          * In theory, the sequencer could be enabled, and each Command Register
 957          * could divide the base bit rate by a different value.
 958          * However, most RSPI variants do not have Transfer Data Length
 959          * Multiplier Setting Registers, so each sequence step would be limited
 960          * to a single word, making this feature unsuitable for large
 961          * transfers, which would gain most from it.
 962          */
 963         rspi->speed_hz = spi->max_speed_hz;
 964         list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 965                 if (xfer->speed_hz < rspi->speed_hz)
 966                         rspi->speed_hz = xfer->speed_hz;
 967         }
 968
 969         rspi->spcmd = SPCMD_SSLKP;
 970         if (spi->mode & SPI_CPOL)
 971                 rspi->spcmd |= SPCMD_CPOL;
 972         if (spi->mode & SPI_CPHA)
 973                 rspi->spcmd |= SPCMD_CPHA;
 974         if (spi->mode & SPI_LSB_FIRST)
 975                 rspi->spcmd |= SPCMD_LSBF;
 976
 977         /* Configure slave signal to assert */
 978         rspi->spcmd |= SPCMD_SSLA(spi->cs_gpiod ? rspi->ctlr->unused_native_cs
 979                                                 : spi->chip_select);
 980
 981         /* CMOS output mode and MOSI signal from previous transfer */
 982         rspi->sppcr = 0;
 983         if (spi->mode & SPI_LOOP)
 984                 rspi->sppcr |= SPPCR_SPLP;
 985
 986         rspi->ops->set_config_register(rspi, 8);
 987
 988         if (msg->spi->mode &
 989             (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD)) {
 990                 /* Setup sequencer for messages with multiple transfer modes */
 991                 ret = qspi_setup_sequencer(rspi, msg);
 992                 if (ret < 0)
 993                         return ret;
 994         }
 995
 996         /* Enable SPI function in master mode */
 997         rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) | SPCR_SPE, RSPI_SPCR);
 998         return 0;
 999 }
1000
1001 static int rspi_unprepare_message(struct spi_controller *ctlr,
1002                                   struct spi_message *msg)
1003 {
1004         struct rspi_data *rspi = spi_controller_get_devdata(ctlr);
1005
1006         /* Disable SPI function */
1007         rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) & ~SPCR_SPE, RSPI_SPCR);
1008
1009         /* Reset sequencer for Single SPI Transfers */
1010         rspi_write16(rspi, rspi->spcmd, RSPI_SPCMD0);
1011         rspi_write8(rspi, 0, RSPI_SPSCR);
1012         return 0;
1013 }
1014
1015 static irqreturn_t rspi_irq_mux(int irq, void *_sr)
1016 {
1017         struct rspi_data *rspi = _sr;
1018         u8 spsr;
1019         irqreturn_t ret = IRQ_NONE;
1020         u8 disable_irq = 0;
1021
1022         rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
1023         if (spsr & SPSR_SPRF)
1024                 disable_irq |= SPCR_SPRIE;
1025         if (spsr & SPSR_SPTEF)
1026                 disable_irq |= SPCR_SPTIE;
1027
1028         if (disable_irq) {
1029                 ret = IRQ_HANDLED;
1030                 rspi_disable_irq(rspi, disable_irq);
1031                 wake_up(&rspi->wait);
1032         }
1033
1034         return ret;
1035 }
1036
1037 static irqreturn_t rspi_irq_rx(int irq, void *_sr)
1038 {
1039         struct rspi_data *rspi = _sr;
1040         u8 spsr;
1041
1042         rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
1043         if (spsr & SPSR_SPRF) {
1044                 rspi_disable_irq(rspi, SPCR_SPRIE);
1045                 wake_up(&rspi->wait);
1046                 return IRQ_HANDLED;
1047         }
1048
1049         return 0;
1050 }
1051
1052 static irqreturn_t rspi_irq_tx(int irq, void *_sr)
1053 {
1054         struct rspi_data *rspi = _sr;
1055         u8 spsr;
1056
1057         rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
1058         if (spsr & SPSR_SPTEF) {
1059                 rspi_disable_irq(rspi, SPCR_SPTIE);
1060                 wake_up(&rspi->wait);
1061                 return IRQ_HANDLED;
1062         }
1063
1064         return 0;
1065 }
1066
1067 static struct dma_chan *rspi_request_dma_chan(struct device *dev,
1068                                               enum dma_transfer_direction dir,
1069                                               unsigned int id,
1070                                               dma_addr_t port_addr)
1071 {
1072         dma_cap_mask_t mask;
1073         struct dma_chan *chan;
1074         struct dma_slave_config cfg;
1075         int ret;
1076
1077         dma_cap_zero(mask);
1078         dma_cap_set(DMA_SLAVE, mask);
1079
1080         chan = dma_request_slave_channel_compat(mask, shdma_chan_filter,
1081                                 (void *)(unsigned long)id, dev,
1082                                 dir == DMA_MEM_TO_DEV ? "tx" : "rx");
1083         if (!chan) {
1084                 dev_warn(dev, "dma_request_slave_channel_compat failed\n");
1085                 return NULL;
1086         }
1087
1088         memset(&cfg, 0, sizeof(cfg));
1089         cfg.direction = dir;
1090         if (dir == DMA_MEM_TO_DEV) {
1091                 cfg.dst_addr = port_addr;
1092                 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1093         } else {
1094                 cfg.src_addr = port_addr;
1095                 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1096         }
1097
1098         ret = dmaengine_slave_config(chan, &cfg);
1099         if (ret) {
1100                 dev_warn(dev, "dmaengine_slave_config failed %d\n", ret);
1101                 dma_release_channel(chan);
1102                 return NULL;
1103         }
1104
1105         return chan;
1106 }
1107
1108 static int rspi_request_dma(struct device *dev, struct spi_controller *ctlr,
1109                             const struct resource *res)
1110 {
1111         const struct rspi_plat_data *rspi_pd = dev_get_platdata(dev);
1112         unsigned int dma_tx_id, dma_rx_id;
1113
1114         if (dev->of_node) {
1115                 /* In the OF case we will get the slave IDs from the DT */
1116                 dma_tx_id = 0;
1117                 dma_rx_id = 0;
1118         } else if (rspi_pd && rspi_pd->dma_tx_id && rspi_pd->dma_rx_id) {
1119                 dma_tx_id = rspi_pd->dma_tx_id;
1120                 dma_rx_id = rspi_pd->dma_rx_id;
1121         } else {
1122                 /* The driver assumes no error. */
1123                 return 0;
1124         }
1125
1126         ctlr->dma_tx = rspi_request_dma_chan(dev, DMA_MEM_TO_DEV, dma_tx_id,
1127                                              res->start + RSPI_SPDR);
1128         if (!ctlr->dma_tx)
1129                 return -ENODEV;
1130
1131         ctlr->dma_rx = rspi_request_dma_chan(dev, DMA_DEV_TO_MEM, dma_rx_id,
1132                                              res->start + RSPI_SPDR);
1133         if (!ctlr->dma_rx) {
1134                 dma_release_channel(ctlr->dma_tx);
1135                 ctlr->dma_tx = NULL;
1136                 return -ENODEV;
1137         }
1138
1139         ctlr->can_dma = rspi_can_dma;
1140         dev_info(dev, "DMA available");
1141         return 0;
1142 }
1143
1144 static void rspi_release_dma(struct spi_controller *ctlr)
1145 {
1146         if (ctlr->dma_tx)
1147                 dma_release_channel(ctlr->dma_tx);
1148         if (ctlr->dma_rx)
1149                 dma_release_channel(ctlr->dma_rx);
1150 }
1151
1152 static int rspi_remove(struct platform_device *pdev)
1153 {
1154         struct rspi_data *rspi = platform_get_drvdata(pdev);
1155
1156         rspi_release_dma(rspi->ctlr);
1157         pm_runtime_disable(&pdev->dev);
1158
1159         return 0;
1160 }
1161
1162 static const struct spi_ops rspi_ops = {
1163         .set_config_register =  rspi_set_config_register,
1164         .transfer_one =         rspi_transfer_one,
1165         .flags =                SPI_CONTROLLER_MUST_TX,
1166         .fifo_size =            8,
1167         .num_hw_ss =            2,
1168 };
1169
1170 static const struct spi_ops rspi_rz_ops = {
1171         .set_config_register =  rspi_rz_set_config_register,
1172         .transfer_one =         rspi_rz_transfer_one,
1173         .flags =                SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX,
1174         .fifo_size =            8,      /* 8 for TX, 32 for RX */
1175         .num_hw_ss =            1,
1176 };
1177
1178 static const struct spi_ops qspi_ops = {
1179         .set_config_register =  qspi_set_config_register,
1180         .transfer_one =         qspi_transfer_one,
1181         .extra_mode_bits =      SPI_TX_DUAL | SPI_TX_QUAD |
1182                                 SPI_RX_DUAL | SPI_RX_QUAD,
1183         .flags =                SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX,
1184         .fifo_size =            32,
1185         .num_hw_ss =            1,
1186 };
1187
1188 #ifdef CONFIG_OF
1189 static const struct of_device_id rspi_of_match[] = {
1190         /* RSPI on legacy SH */
1191         { .compatible = "renesas,rspi", .data = &rspi_ops },
1192         /* RSPI on RZ/A1H */
1193         { .compatible = "renesas,rspi-rz", .data = &rspi_rz_ops },
1194         /* QSPI on R-Car Gen2 */
1195         { .compatible = "renesas,qspi", .data = &qspi_ops },
1196         { /* sentinel */ }
1197 };
1198
1199 MODULE_DEVICE_TABLE(of, rspi_of_match);
1200
1201 static int rspi_parse_dt(struct device *dev, struct spi_controller *ctlr)
1202 {
1203         u32 num_cs;
1204         int error;
1205
1206         /* Parse DT properties */
1207         error = of_property_read_u32(dev->of_node, "num-cs", &num_cs);
1208         if (error) {
1209                 dev_err(dev, "of_property_read_u32 num-cs failed %d\n", error);
1210                 return error;
1211         }
1212
1213         ctlr->num_chipselect = num_cs;
1214         return 0;
1215 }
1216 #else
1217 #define rspi_of_match   NULL
1218 static inline int rspi_parse_dt(struct device *dev, struct spi_controller *ctlr)
1219 {
1220         return -EINVAL;
1221 }
1222 #endif /* CONFIG_OF */
1223
1224 static int rspi_request_irq(struct device *dev, unsigned int irq,
1225                             irq_handler_t handler, const char *suffix,
1226                             void *dev_id)
1227 {
1228         const char *name = devm_kasprintf(dev, GFP_KERNEL, "%s:%s",
1229                                           dev_name(dev), suffix);
1230         if (!name)
1231                 return -ENOMEM;
1232
1233         return devm_request_irq(dev, irq, handler, 0, name, dev_id);
1234 }
1235
1236 static int rspi_probe(struct platform_device *pdev)
1237 {
1238         struct resource *res;
1239         struct spi_controller *ctlr;
1240         struct rspi_data *rspi;
1241         int ret;
1242         const struct rspi_plat_data *rspi_pd;
1243         const struct spi_ops *ops;
1244
1245         ctlr = spi_alloc_master(&pdev->dev, sizeof(struct rspi_data));
1246         if (ctlr == NULL)
1247                 return -ENOMEM;
1248
1249         ops = of_device_get_match_data(&pdev->dev);
1250         if (ops) {
1251                 ret = rspi_parse_dt(&pdev->dev, ctlr);
1252                 if (ret)
1253                         goto error1;
1254         } else {
1255                 ops = (struct spi_ops *)pdev->id_entry->driver_data;
1256                 rspi_pd = dev_get_platdata(&pdev->dev);
1257                 if (rspi_pd && rspi_pd->num_chipselect)
1258                         ctlr->num_chipselect = rspi_pd->num_chipselect;
1259                 else
1260                         ctlr->num_chipselect = 2; /* default */
1261         }
1262
1263         rspi = spi_controller_get_devdata(ctlr);
1264         platform_set_drvdata(pdev, rspi);
1265         rspi->ops = ops;
1266         rspi->ctlr = ctlr;
1267
1268         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1269         rspi->addr = devm_ioremap_resource(&pdev->dev, res);
1270         if (IS_ERR(rspi->addr)) {
1271                 ret = PTR_ERR(rspi->addr);
1272                 goto error1;
1273         }
1274
1275         rspi->clk = devm_clk_get(&pdev->dev, NULL);
1276         if (IS_ERR(rspi->clk)) {
1277                 dev_err(&pdev->dev, "cannot get clock\n");
1278                 ret = PTR_ERR(rspi->clk);
1279                 goto error1;
1280         }
1281
1282         rspi->pdev = pdev;
1283         pm_runtime_enable(&pdev->dev);
1284
1285         init_waitqueue_head(&rspi->wait);
1286         spin_lock_init(&rspi->lock);
1287
1288         ctlr->bus_num = pdev->id;
1289         ctlr->setup = rspi_setup;
1290         ctlr->auto_runtime_pm = true;
1291         ctlr->transfer_one = ops->transfer_one;
1292         ctlr->prepare_message = rspi_prepare_message;
1293         ctlr->unprepare_message = rspi_unprepare_message;
1294         ctlr->mode_bits = SPI_CPHA | SPI_CPOL | SPI_CS_HIGH | SPI_LSB_FIRST |
1295                           SPI_LOOP | ops->extra_mode_bits;
1296         ctlr->flags = ops->flags;
1297         ctlr->dev.of_node = pdev->dev.of_node;
1298         ctlr->use_gpio_descriptors = true;
1299         ctlr->max_native_cs = rspi->ops->num_hw_ss;
1300
1301         ret = platform_get_irq_byname_optional(pdev, "rx");
1302         if (ret < 0) {
1303                 ret = platform_get_irq_byname_optional(pdev, "mux");
1304                 if (ret < 0)
1305                         ret = platform_get_irq(pdev, 0);
1306                 if (ret >= 0)
1307                         rspi->rx_irq = rspi->tx_irq = ret;
1308         } else {
1309                 rspi->rx_irq = ret;
1310                 ret = platform_get_irq_byname(pdev, "tx");
1311                 if (ret >= 0)
1312                         rspi->tx_irq = ret;
1313         }
1314
1315         if (rspi->rx_irq == rspi->tx_irq) {
1316                 /* Single multiplexed interrupt */
1317                 ret = rspi_request_irq(&pdev->dev, rspi->rx_irq, rspi_irq_mux,
1318                                        "mux", rspi);
1319         } else {
1320                 /* Multi-interrupt mode, only SPRI and SPTI are used */
1321                 ret = rspi_request_irq(&pdev->dev, rspi->rx_irq, rspi_irq_rx,
1322                                        "rx", rspi);
1323                 if (!ret)
1324                         ret = rspi_request_irq(&pdev->dev, rspi->tx_irq,
1325                                                rspi_irq_tx, "tx", rspi);
1326         }
1327         if (ret < 0) {
1328                 dev_err(&pdev->dev, "request_irq error\n");
1329                 goto error2;
1330         }
1331
1332         ret = rspi_request_dma(&pdev->dev, ctlr, res);
1333         if (ret < 0)
1334                 dev_warn(&pdev->dev, "DMA not available, using PIO\n");
1335
1336         ret = devm_spi_register_controller(&pdev->dev, ctlr);
1337         if (ret < 0) {
1338                 dev_err(&pdev->dev, "devm_spi_register_controller error.\n");
1339                 goto error3;
1340         }
1341
1342         dev_info(&pdev->dev, "probed\n");
1343
1344         return 0;
1345
1346 error3:
1347         rspi_release_dma(ctlr);
1348 error2:
1349         pm_runtime_disable(&pdev->dev);
1350 error1:
1351         spi_controller_put(ctlr);
1352
1353         return ret;
1354 }
1355
1356 static const struct platform_device_id spi_driver_ids[] = {
1357         { "rspi",       (kernel_ulong_t)&rspi_ops },
1358         {},
1359 };
1360
1361 MODULE_DEVICE_TABLE(platform, spi_driver_ids);
1362
1363 #ifdef CONFIG_PM_SLEEP
1364 static int rspi_suspend(struct device *dev)
1365 {
1366         struct rspi_data *rspi = dev_get_drvdata(dev);
1367
1368         return spi_controller_suspend(rspi->ctlr);
1369 }
1370
1371 static int rspi_resume(struct device *dev)
1372 {
1373         struct rspi_data *rspi = dev_get_drvdata(dev);
1374
1375         return spi_controller_resume(rspi->ctlr);
1376 }
1377
1378 static SIMPLE_DEV_PM_OPS(rspi_pm_ops, rspi_suspend, rspi_resume);
1379 #define DEV_PM_OPS      &rspi_pm_ops
1380 #else
1381 #define DEV_PM_OPS      NULL
1382 #endif /* CONFIG_PM_SLEEP */
1383
1384 static struct platform_driver rspi_driver = {
1385         .probe =        rspi_probe,
1386         .remove =       rspi_remove,
1387         .id_table =     spi_driver_ids,
1388         .driver         = {
1389                 .name = "renesas_spi",
1390                 .pm = DEV_PM_OPS,
1391                 .of_match_table = of_match_ptr(rspi_of_match),
1392         },
1393 };
1394 module_platform_driver(rspi_driver);
1395
1396 MODULE_DESCRIPTION("Renesas RSPI bus driver");
1397 MODULE_LICENSE("GPL v2");
1398 MODULE_AUTHOR("Yoshihiro Shimoda");
1399 MODULE_ALIAS("platform:rspi");