drivers/spi/spi-stm32-qspi.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) STMicroelectronics 2018 - All Rights Reserved
   4  * Author: Ludovic Barre <ludovic.barre@st.com> for STMicroelectronics.
   5  */
   6 #include <linux/bitfield.h>
   7 #include <linux/clk.h>
   8 #include <linux/dmaengine.h>
   9 #include <linux/dma-mapping.h>
  10 #include <linux/errno.h>
  11 #include <linux/io.h>
  12 #include <linux/iopoll.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/module.h>
  15 #include <linux/mutex.h>
  16 #include <linux/of.h>
  17 #include <linux/of_device.h>
  18 #include <linux/pinctrl/consumer.h>
  19 #include <linux/pm_runtime.h>
  20 #include <linux/platform_device.h>
  21 #include <linux/reset.h>
  22 #include <linux/sizes.h>
  23 #include <linux/spi/spi-mem.h>
  24
  25 #define QSPI_CR                 0x00
  26 #define CR_EN                   BIT(0)
  27 #define CR_ABORT                BIT(1)
  28 #define CR_DMAEN                BIT(2)
  29 #define CR_TCEN                 BIT(3)
  30 #define CR_SSHIFT               BIT(4)
  31 #define CR_DFM                  BIT(6)
  32 #define CR_FSEL                 BIT(7)
  33 #define CR_FTHRES_SHIFT         8
  34 #define CR_TEIE                 BIT(16)
  35 #define CR_TCIE                 BIT(17)
  36 #define CR_FTIE                 BIT(18)
  37 #define CR_SMIE                 BIT(19)
  38 #define CR_TOIE                 BIT(20)
  39 #define CR_APMS                 BIT(22)
  40 #define CR_PRESC_MASK           GENMASK(31, 24)
  41
  42 #define QSPI_DCR                0x04
  43 #define DCR_FSIZE_MASK          GENMASK(20, 16)
  44
  45 #define QSPI_SR                 0x08
  46 #define SR_TEF                  BIT(0)
  47 #define SR_TCF                  BIT(1)
  48 #define SR_FTF                  BIT(2)
  49 #define SR_SMF                  BIT(3)
  50 #define SR_TOF                  BIT(4)
  51 #define SR_BUSY                 BIT(5)
  52 #define SR_FLEVEL_MASK          GENMASK(13, 8)
  53
  54 #define QSPI_FCR                0x0c
  55 #define FCR_CTEF                BIT(0)
  56 #define FCR_CTCF                BIT(1)
  57 #define FCR_CSMF                BIT(3)
  58
  59 #define QSPI_DLR                0x10
  60
  61 #define QSPI_CCR                0x14
  62 #define CCR_INST_MASK           GENMASK(7, 0)
  63 #define CCR_IMODE_MASK          GENMASK(9, 8)
  64 #define CCR_ADMODE_MASK         GENMASK(11, 10)
  65 #define CCR_ADSIZE_MASK         GENMASK(13, 12)
  66 #define CCR_DCYC_MASK           GENMASK(22, 18)
  67 #define CCR_DMODE_MASK          GENMASK(25, 24)
  68 #define CCR_FMODE_MASK          GENMASK(27, 26)
  69 #define CCR_FMODE_INDW          (0U << 26)
  70 #define CCR_FMODE_INDR          (1U << 26)
  71 #define CCR_FMODE_APM           (2U << 26)
  72 #define CCR_FMODE_MM            (3U << 26)
  73 #define CCR_BUSWIDTH_0          0x0
  74 #define CCR_BUSWIDTH_1          0x1
  75 #define CCR_BUSWIDTH_2          0x2
  76 #define CCR_BUSWIDTH_4          0x3
  77
  78 #define QSPI_AR                 0x18
  79 #define QSPI_ABR                0x1c
  80 #define QSPI_DR                 0x20
  81 #define QSPI_PSMKR              0x24
  82 #define QSPI_PSMAR              0x28
  83 #define QSPI_PIR                0x2c
  84 #define QSPI_LPTR               0x30
  85
  86 #define STM32_QSPI_MAX_MMAP_SZ  SZ_256M
  87 #define STM32_QSPI_MAX_NORCHIP  2
  88
  89 #define STM32_FIFO_TIMEOUT_US 30000
  90 #define STM32_BUSY_TIMEOUT_US 100000
  91 #define STM32_ABT_TIMEOUT_US 100000
  92 #define STM32_COMP_TIMEOUT_MS 1000
  93 #define STM32_AUTOSUSPEND_DELAY -1
  94
  95 struct stm32_qspi_flash {
  96         u32 cs;
  97         u32 presc;
  98 };
  99
 100 struct stm32_qspi {
 101         struct device *dev;
 102         struct spi_controller *ctrl;
 103         phys_addr_t phys_base;
 104         void __iomem *io_base;
 105         void __iomem *mm_base;
 106         resource_size_t mm_size;
 107         struct clk *clk;
 108         u32 clk_rate;
 109         struct stm32_qspi_flash flash[STM32_QSPI_MAX_NORCHIP];
 110         struct completion data_completion;
 111         struct completion match_completion;
 112         u32 fmode;
 113
 114         struct dma_chan *dma_chtx;
 115         struct dma_chan *dma_chrx;
 116         struct completion dma_completion;
 117
 118         u32 cr_reg;
 119         u32 dcr_reg;
 120         unsigned long status_timeout;
 121
 122         /*
 123          * to protect device configuration, could be different between
 124          * 2 flash access (bk1, bk2)
 125          */
 126         struct mutex lock;
 127 };
 128
 129 static irqreturn_t stm32_qspi_irq(int irq, void *dev_id)
 130 {
 131         struct stm32_qspi *qspi = (struct stm32_qspi *)dev_id;
 132         u32 cr, sr;
 133
 134         cr = readl_relaxed(qspi->io_base + QSPI_CR);
 135         sr = readl_relaxed(qspi->io_base + QSPI_SR);
 136
 137         if (cr & CR_SMIE && sr & SR_SMF) {
 138                 /* disable irq */
 139                 cr &= ~CR_SMIE;
 140                 writel_relaxed(cr, qspi->io_base + QSPI_CR);
 141                 complete(&qspi->match_completion);
 142
 143                 return IRQ_HANDLED;
 144         }
 145
 146         if (sr & (SR_TEF | SR_TCF)) {
 147                 /* disable irq */
 148                 cr &= ~CR_TCIE & ~CR_TEIE;
 149                 writel_relaxed(cr, qspi->io_base + QSPI_CR);
 150                 complete(&qspi->data_completion);
 151         }
 152
 153         return IRQ_HANDLED;
 154 }
 155
 156 static void stm32_qspi_read_fifo(u8 *val, void __iomem *addr)
 157 {
 158         *val = readb_relaxed(addr);
 159 }
 160
 161 static void stm32_qspi_write_fifo(u8 *val, void __iomem *addr)
 162 {
 163         writeb_relaxed(*val, addr);
 164 }
 165
 166 static int stm32_qspi_tx_poll(struct stm32_qspi *qspi,
 167                               const struct spi_mem_op *op)
 168 {
 169         void (*tx_fifo)(u8 *val, void __iomem *addr);
 170         u32 len = op->data.nbytes, sr;
 171         u8 *buf;
 172         int ret;
 173
 174         if (op->data.dir == SPI_MEM_DATA_IN) {
 175                 tx_fifo = stm32_qspi_read_fifo;
 176                 buf = op->data.buf.in;
 177
 178         } else {
 179                 tx_fifo = stm32_qspi_write_fifo;
 180                 buf = (u8 *)op->data.buf.out;
 181         }
 182
 183         while (len--) {
 184                 ret = readl_relaxed_poll_timeout_atomic(qspi->io_base + QSPI_SR,
 185                                                         sr, (sr & SR_FTF), 1,
 186                                                         STM32_FIFO_TIMEOUT_US);
 187                 if (ret) {
 188                         dev_err(qspi->dev, "fifo timeout (len:%d stat:%#x)\n",
 189                                 len, sr);
 190                         return ret;
 191                 }
 192                 tx_fifo(buf++, qspi->io_base + QSPI_DR);
 193         }
 194
 195         return 0;
 196 }
 197
 198 static int stm32_qspi_tx_mm(struct stm32_qspi *qspi,
 199                             const struct spi_mem_op *op)
 200 {
 201         memcpy_fromio(op->data.buf.in, qspi->mm_base + op->addr.val,
 202                       op->data.nbytes);
 203         return 0;
 204 }
 205
 206 static void stm32_qspi_dma_callback(void *arg)
 207 {
 208         struct completion *dma_completion = arg;
 209
 210         complete(dma_completion);
 211 }
 212
 213 static int stm32_qspi_tx_dma(struct stm32_qspi *qspi,
 214                              const struct spi_mem_op *op)
 215 {
 216         struct dma_async_tx_descriptor *desc;
 217         enum dma_transfer_direction dma_dir;
 218         struct dma_chan *dma_ch;
 219         struct sg_table sgt;
 220         dma_cookie_t cookie;
 221         u32 cr, t_out;
 222         int err;
 223
 224         if (op->data.dir == SPI_MEM_DATA_IN) {
 225                 dma_dir = DMA_DEV_TO_MEM;
 226                 dma_ch = qspi->dma_chrx;
 227         } else {
 228                 dma_dir = DMA_MEM_TO_DEV;
 229                 dma_ch = qspi->dma_chtx;
 230         }
 231
 232         /*
 233          * spi_map_buf return -EINVAL if the buffer is not DMA-able
 234          * (DMA-able: in vmalloc | kmap | virt_addr_valid)
 235          */
 236         err = spi_controller_dma_map_mem_op_data(qspi->ctrl, op, &sgt);
 237         if (err)
 238                 return err;
 239
 240         desc = dmaengine_prep_slave_sg(dma_ch, sgt.sgl, sgt.nents,
 241                                        dma_dir, DMA_PREP_INTERRUPT);
 242         if (!desc) {
 243                 err = -ENOMEM;
 244                 goto out_unmap;
 245         }
 246
 247         cr = readl_relaxed(qspi->io_base + QSPI_CR);
 248
 249         reinit_completion(&qspi->dma_completion);
 250         desc->callback = stm32_qspi_dma_callback;
 251         desc->callback_param = &qspi->dma_completion;
 252         cookie = dmaengine_submit(desc);
 253         err = dma_submit_error(cookie);
 254         if (err)
 255                 goto out;
 256
 257         dma_async_issue_pending(dma_ch);
 258
 259         writel_relaxed(cr | CR_DMAEN, qspi->io_base + QSPI_CR);
 260
 261         t_out = sgt.nents * STM32_COMP_TIMEOUT_MS;
 262         if (!wait_for_completion_timeout(&qspi->dma_completion,
 263                                          msecs_to_jiffies(t_out)))
 264                 err = -ETIMEDOUT;
 265
 266         if (err)
 267                 dmaengine_terminate_all(dma_ch);
 268
 269 out:
 270         writel_relaxed(cr & ~CR_DMAEN, qspi->io_base + QSPI_CR);
 271 out_unmap:
 272         spi_controller_dma_unmap_mem_op_data(qspi->ctrl, op, &sgt);
 273
 274         return err;
 275 }
 276
 277 static int stm32_qspi_tx(struct stm32_qspi *qspi, const struct spi_mem_op *op)
 278 {
 279         if (!op->data.nbytes)
 280                 return 0;
 281
 282         if (qspi->fmode == CCR_FMODE_MM)
 283                 return stm32_qspi_tx_mm(qspi, op);
 284         else if (((op->data.dir == SPI_MEM_DATA_IN && qspi->dma_chrx) ||
 285                  (op->data.dir == SPI_MEM_DATA_OUT && qspi->dma_chtx)) &&
 286                   op->data.nbytes > 4)
 287                 if (!stm32_qspi_tx_dma(qspi, op))
 288                         return 0;
 289
 290         return stm32_qspi_tx_poll(qspi, op);
 291 }
 292
 293 static int stm32_qspi_wait_nobusy(struct stm32_qspi *qspi)
 294 {
 295         u32 sr;
 296
 297         return readl_relaxed_poll_timeout_atomic(qspi->io_base + QSPI_SR, sr,
 298                                                  !(sr & SR_BUSY), 1,
 299                                                  STM32_BUSY_TIMEOUT_US);
 300 }
 301
 302 static int stm32_qspi_wait_cmd(struct stm32_qspi *qspi,
 303                                const struct spi_mem_op *op)
 304 {
 305         u32 cr, sr;
 306         int err = 0;
 307
 308         if (!op->data.nbytes)
 309                 goto wait_nobusy;
 310
 311         if ((readl_relaxed(qspi->io_base + QSPI_SR) & SR_TCF) ||
 312             qspi->fmode == CCR_FMODE_APM)
 313                 goto out;
 314
 315         reinit_completion(&qspi->data_completion);
 316         cr = readl_relaxed(qspi->io_base + QSPI_CR);
 317         writel_relaxed(cr | CR_TCIE | CR_TEIE, qspi->io_base + QSPI_CR);
 318
 319         if (!wait_for_completion_timeout(&qspi->data_completion,
 320                                 msecs_to_jiffies(STM32_COMP_TIMEOUT_MS))) {
 321                 err = -ETIMEDOUT;
 322         } else {
 323                 sr = readl_relaxed(qspi->io_base + QSPI_SR);
 324                 if (sr & SR_TEF)
 325                         err = -EIO;
 326         }
 327
 328 out:
 329         /* clear flags */
 330         writel_relaxed(FCR_CTCF | FCR_CTEF, qspi->io_base + QSPI_FCR);
 331 wait_nobusy:
 332         if (!err)
 333                 err = stm32_qspi_wait_nobusy(qspi);
 334
 335         return err;
 336 }
 337
 338 static int stm32_qspi_wait_poll_status(struct stm32_qspi *qspi,
 339                                        const struct spi_mem_op *op)
 340 {
 341         u32 cr;
 342
 343         reinit_completion(&qspi->match_completion);
 344         cr = readl_relaxed(qspi->io_base + QSPI_CR);
 345         writel_relaxed(cr | CR_SMIE, qspi->io_base + QSPI_CR);
 346
 347         if (!wait_for_completion_timeout(&qspi->match_completion,
 348                                 msecs_to_jiffies(qspi->status_timeout)))
 349                 return -ETIMEDOUT;
 350
 351         writel_relaxed(FCR_CSMF, qspi->io_base + QSPI_FCR);
 352
 353         return 0;
 354 }
 355
 356 static int stm32_qspi_get_mode(struct stm32_qspi *qspi, u8 buswidth)
 357 {
 358         if (buswidth == 4)
 359                 return CCR_BUSWIDTH_4;
 360
 361         return buswidth;
 362 }
 363
 364 static int stm32_qspi_send(struct spi_mem *mem, const struct spi_mem_op *op)
 365 {
 366         struct stm32_qspi *qspi = spi_controller_get_devdata(mem->spi->master);
 367         struct stm32_qspi_flash *flash = &qspi->flash[mem->spi->chip_select];
 368         u32 ccr, cr;
 369         int timeout, err = 0, err_poll_status = 0;
 370
 371         dev_dbg(qspi->dev, "cmd:%#x mode:%d.%d.%d.%d addr:%#llx len:%#x\n",
 372                 op->cmd.opcode, op->cmd.buswidth, op->addr.buswidth,
 373                 op->dummy.buswidth, op->data.buswidth,
 374                 op->addr.val, op->data.nbytes);
 375
 376         err = stm32_qspi_wait_nobusy(qspi);
 377         if (err)
 378                 goto abort;
 379
 380         cr = readl_relaxed(qspi->io_base + QSPI_CR);
 381         cr &= ~CR_PRESC_MASK & ~CR_FSEL;
 382         cr |= FIELD_PREP(CR_PRESC_MASK, flash->presc);
 383         cr |= FIELD_PREP(CR_FSEL, flash->cs);
 384         writel_relaxed(cr, qspi->io_base + QSPI_CR);
 385
 386         if (op->data.nbytes)
 387                 writel_relaxed(op->data.nbytes - 1,
 388                                qspi->io_base + QSPI_DLR);
 389
 390         ccr = qspi->fmode;
 391         ccr |= FIELD_PREP(CCR_INST_MASK, op->cmd.opcode);
 392         ccr |= FIELD_PREP(CCR_IMODE_MASK,
 393                           stm32_qspi_get_mode(qspi, op->cmd.buswidth));
 394
 395         if (op->addr.nbytes) {
 396                 ccr |= FIELD_PREP(CCR_ADMODE_MASK,
 397                                   stm32_qspi_get_mode(qspi, op->addr.buswidth));
 398                 ccr |= FIELD_PREP(CCR_ADSIZE_MASK, op->addr.nbytes - 1);
 399         }
 400
 401         if (op->dummy.nbytes)
 402                 ccr |= FIELD_PREP(CCR_DCYC_MASK,
 403                                   op->dummy.nbytes * 8 / op->dummy.buswidth);
 404
 405         if (op->data.nbytes) {
 406                 ccr |= FIELD_PREP(CCR_DMODE_MASK,
 407                                   stm32_qspi_get_mode(qspi, op->data.buswidth));
 408         }
 409
 410         writel_relaxed(ccr, qspi->io_base + QSPI_CCR);
 411
 412         if (op->addr.nbytes && qspi->fmode != CCR_FMODE_MM)
 413                 writel_relaxed(op->addr.val, qspi->io_base + QSPI_AR);
 414
 415         if (qspi->fmode == CCR_FMODE_APM)
 416                 err_poll_status = stm32_qspi_wait_poll_status(qspi, op);
 417
 418         err = stm32_qspi_tx(qspi, op);
 419
 420         /*
 421          * Abort in:
 422          * -error case
 423          * -read memory map: prefetching must be stopped if we read the last
 424          *  byte of device (device size - fifo size). like device size is not
 425          *  knows, the prefetching is always stop.
 426          */
 427         if (err || err_poll_status || qspi->fmode == CCR_FMODE_MM)
 428                 goto abort;
 429
 430         /* wait end of tx in indirect mode */
 431         err = stm32_qspi_wait_cmd(qspi, op);
 432         if (err)
 433                 goto abort;
 434
 435         return 0;
 436
 437 abort:
 438         cr = readl_relaxed(qspi->io_base + QSPI_CR) | CR_ABORT;
 439         writel_relaxed(cr, qspi->io_base + QSPI_CR);
 440
 441         /* wait clear of abort bit by hw */
 442         timeout = readl_relaxed_poll_timeout_atomic(qspi->io_base + QSPI_CR,
 443                                                     cr, !(cr & CR_ABORT), 1,
 444                                                     STM32_ABT_TIMEOUT_US);
 445
 446         writel_relaxed(FCR_CTCF | FCR_CSMF, qspi->io_base + QSPI_FCR);
 447
 448         if (err || err_poll_status || timeout)
 449                 dev_err(qspi->dev, "%s err:%d err_poll_status:%d abort timeout:%d\n",
 450                         __func__, err, err_poll_status, timeout);
 451
 452         return err;
 453 }
 454
 455 static int stm32_qspi_poll_status(struct spi_mem *mem, const struct spi_mem_op *op,
 456                                   u16 mask, u16 match,
 457                                   unsigned long initial_delay_us,
 458                                   unsigned long polling_rate_us,
 459                                   unsigned long timeout_ms)
 460 {
 461         struct stm32_qspi *qspi = spi_controller_get_devdata(mem->spi->master);
 462         int ret;
 463
 464         if (!spi_mem_supports_op(mem, op))
 465                 return -EOPNOTSUPP;
 466
 467         ret = pm_runtime_get_sync(qspi->dev);
 468         if (ret < 0) {
 469                 pm_runtime_put_noidle(qspi->dev);
 470                 return ret;
 471         }
 472
 473         mutex_lock(&qspi->lock);
 474
 475         writel_relaxed(mask, qspi->io_base + QSPI_PSMKR);
 476         writel_relaxed(match, qspi->io_base + QSPI_PSMAR);
 477         qspi->fmode = CCR_FMODE_APM;
 478         qspi->status_timeout = timeout_ms;
 479
 480         ret = stm32_qspi_send(mem, op);
 481         mutex_unlock(&qspi->lock);
 482
 483         pm_runtime_mark_last_busy(qspi->dev);
 484         pm_runtime_put_autosuspend(qspi->dev);
 485
 486         return ret;
 487 }
 488
 489 static int stm32_qspi_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)
 490 {
 491         struct stm32_qspi *qspi = spi_controller_get_devdata(mem->spi->master);
 492         int ret;
 493
 494         ret = pm_runtime_get_sync(qspi->dev);
 495         if (ret < 0) {
 496                 pm_runtime_put_noidle(qspi->dev);
 497                 return ret;
 498         }
 499
 500         mutex_lock(&qspi->lock);
 501         if (op->data.dir == SPI_MEM_DATA_IN && op->data.nbytes)
 502                 qspi->fmode = CCR_FMODE_INDR;
 503         else
 504                 qspi->fmode = CCR_FMODE_INDW;
 505
 506         ret = stm32_qspi_send(mem, op);
 507         mutex_unlock(&qspi->lock);
 508
 509         pm_runtime_mark_last_busy(qspi->dev);
 510         pm_runtime_put_autosuspend(qspi->dev);
 511
 512         return ret;
 513 }
 514
 515 static int stm32_qspi_dirmap_create(struct spi_mem_dirmap_desc *desc)
 516 {
 517         struct stm32_qspi *qspi = spi_controller_get_devdata(desc->mem->spi->master);
 518
 519         if (desc->info.op_tmpl.data.dir == SPI_MEM_DATA_OUT)
 520                 return -EOPNOTSUPP;
 521
 522         /* should never happen, as mm_base == null is an error probe exit condition */
 523         if (!qspi->mm_base && desc->info.op_tmpl.data.dir == SPI_MEM_DATA_IN)
 524                 return -EOPNOTSUPP;
 525
 526         if (!qspi->mm_size)
 527                 return -EOPNOTSUPP;
 528
 529         return 0;
 530 }
 531
 532 static ssize_t stm32_qspi_dirmap_read(struct spi_mem_dirmap_desc *desc,
 533                                       u64 offs, size_t len, void *buf)
 534 {
 535         struct stm32_qspi *qspi = spi_controller_get_devdata(desc->mem->spi->master);
 536         struct spi_mem_op op;
 537         u32 addr_max;
 538         int ret;
 539
 540         ret = pm_runtime_get_sync(qspi->dev);
 541         if (ret < 0) {
 542                 pm_runtime_put_noidle(qspi->dev);
 543                 return ret;
 544         }
 545
 546         mutex_lock(&qspi->lock);
 547         /* make a local copy of desc op_tmpl and complete dirmap rdesc
 548          * spi_mem_op template with offs, len and *buf in  order to get
 549          * all needed transfer information into struct spi_mem_op
 550          */
 551         memcpy(&op, &desc->info.op_tmpl, sizeof(struct spi_mem_op));
 552         dev_dbg(qspi->dev, "%s len = 0x%zx offs = 0x%llx buf = 0x%p\n", __func__, len, offs, buf);
 553
 554         op.data.nbytes = len;
 555         op.addr.val = desc->info.offset + offs;
 556         op.data.buf.in = buf;
 557
 558         addr_max = op.addr.val + op.data.nbytes + 1;
 559         if (addr_max < qspi->mm_size && op.addr.buswidth)
 560                 qspi->fmode = CCR_FMODE_MM;
 561         else
 562                 qspi->fmode = CCR_FMODE_INDR;
 563
 564         ret = stm32_qspi_send(desc->mem, &op);
 565         mutex_unlock(&qspi->lock);
 566
 567         pm_runtime_mark_last_busy(qspi->dev);
 568         pm_runtime_put_autosuspend(qspi->dev);
 569
 570         return ret ?: len;
 571 }
 572
 573 static int stm32_qspi_setup(struct spi_device *spi)
 574 {
 575         struct spi_controller *ctrl = spi->master;
 576         struct stm32_qspi *qspi = spi_controller_get_devdata(ctrl);
 577         struct stm32_qspi_flash *flash;
 578         u32 presc;
 579         int ret;
 580
 581         if (ctrl->busy)
 582                 return -EBUSY;
 583
 584         if (!spi->max_speed_hz)
 585                 return -EINVAL;
 586
 587         ret = pm_runtime_get_sync(qspi->dev);
 588         if (ret < 0) {
 589                 pm_runtime_put_noidle(qspi->dev);
 590                 return ret;
 591         }
 592
 593         presc = DIV_ROUND_UP(qspi->clk_rate, spi->max_speed_hz) - 1;
 594
 595         flash = &qspi->flash[spi->chip_select];
 596         flash->cs = spi->chip_select;
 597         flash->presc = presc;
 598
 599         mutex_lock(&qspi->lock);
 600         qspi->cr_reg = CR_APMS | 3 << CR_FTHRES_SHIFT | CR_SSHIFT | CR_EN;
 601         writel_relaxed(qspi->cr_reg, qspi->io_base + QSPI_CR);
 602
 603         /* set dcr fsize to max address */
 604         qspi->dcr_reg = DCR_FSIZE_MASK;
 605         writel_relaxed(qspi->dcr_reg, qspi->io_base + QSPI_DCR);
 606         mutex_unlock(&qspi->lock);
 607
 608         pm_runtime_mark_last_busy(qspi->dev);
 609         pm_runtime_put_autosuspend(qspi->dev);
 610
 611         return 0;
 612 }
 613
 614 static int stm32_qspi_dma_setup(struct stm32_qspi *qspi)
 615 {
 616         struct dma_slave_config dma_cfg;
 617         struct device *dev = qspi->dev;
 618         int ret = 0;
 619
 620         memset(&dma_cfg, 0, sizeof(dma_cfg));
 621
 622         dma_cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
 623         dma_cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
 624         dma_cfg.src_addr = qspi->phys_base + QSPI_DR;
 625         dma_cfg.dst_addr = qspi->phys_base + QSPI_DR;
 626         dma_cfg.src_maxburst = 4;
 627         dma_cfg.dst_maxburst = 4;
 628
 629         qspi->dma_chrx = dma_request_chan(dev, "rx");
 630         if (IS_ERR(qspi->dma_chrx)) {
 631                 ret = PTR_ERR(qspi->dma_chrx);
 632                 qspi->dma_chrx = NULL;
 633                 if (ret == -EPROBE_DEFER)
 634                         goto out;
 635         } else {
 636                 if (dmaengine_slave_config(qspi->dma_chrx, &dma_cfg)) {
 637                         dev_err(dev, "dma rx config failed\n");
 638                         dma_release_channel(qspi->dma_chrx);
 639                         qspi->dma_chrx = NULL;
 640                 }
 641         }
 642
 643         qspi->dma_chtx = dma_request_chan(dev, "tx");
 644         if (IS_ERR(qspi->dma_chtx)) {
 645                 ret = PTR_ERR(qspi->dma_chtx);
 646                 qspi->dma_chtx = NULL;
 647         } else {
 648                 if (dmaengine_slave_config(qspi->dma_chtx, &dma_cfg)) {
 649                         dev_err(dev, "dma tx config failed\n");
 650                         dma_release_channel(qspi->dma_chtx);
 651                         qspi->dma_chtx = NULL;
 652                 }
 653         }
 654
 655 out:
 656         init_completion(&qspi->dma_completion);
 657
 658         if (ret != -EPROBE_DEFER)
 659                 ret = 0;
 660
 661         return ret;
 662 }
 663
 664 static void stm32_qspi_dma_free(struct stm32_qspi *qspi)
 665 {
 666         if (qspi->dma_chtx)
 667                 dma_release_channel(qspi->dma_chtx);
 668         if (qspi->dma_chrx)
 669                 dma_release_channel(qspi->dma_chrx);
 670 }
 671
 672 /*
 673  * no special host constraint, so use default spi_mem_default_supports_op
 674  * to check supported mode.
 675  */
 676 static const struct spi_controller_mem_ops stm32_qspi_mem_ops = {
 677         .exec_op        = stm32_qspi_exec_op,
 678         .dirmap_create  = stm32_qspi_dirmap_create,
 679         .dirmap_read    = stm32_qspi_dirmap_read,
 680         .poll_status    = stm32_qspi_poll_status,
 681 };
 682
 683 static int stm32_qspi_probe(struct platform_device *pdev)
 684 {
 685         struct device *dev = &pdev->dev;
 686         struct spi_controller *ctrl;
 687         struct reset_control *rstc;
 688         struct stm32_qspi *qspi;
 689         struct resource *res;
 690         int ret, irq;
 691
 692         ctrl = devm_spi_alloc_master(dev, sizeof(*qspi));
 693         if (!ctrl)
 694                 return -ENOMEM;
 695
 696         qspi = spi_controller_get_devdata(ctrl);
 697         qspi->ctrl = ctrl;
 698
 699         res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qspi");
 700         qspi->io_base = devm_ioremap_resource(dev, res);
 701         if (IS_ERR(qspi->io_base))
 702                 return PTR_ERR(qspi->io_base);
 703
 704         qspi->phys_base = res->start;
 705
 706         res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qspi_mm");
 707         qspi->mm_base = devm_ioremap_resource(dev, res);
 708         if (IS_ERR(qspi->mm_base))
 709                 return PTR_ERR(qspi->mm_base);
 710
 711         qspi->mm_size = resource_size(res);
 712         if (qspi->mm_size > STM32_QSPI_MAX_MMAP_SZ)
 713                 return -EINVAL;
 714
 715         irq = platform_get_irq(pdev, 0);
 716         if (irq < 0)
 717                 return irq;
 718
 719         ret = devm_request_irq(dev, irq, stm32_qspi_irq, 0,
 720                                dev_name(dev), qspi);
 721         if (ret) {
 722                 dev_err(dev, "failed to request irq\n");
 723                 return ret;
 724         }
 725
 726         init_completion(&qspi->data_completion);
 727         init_completion(&qspi->match_completion);
 728
 729         qspi->clk = devm_clk_get(dev, NULL);
 730         if (IS_ERR(qspi->clk))
 731                 return PTR_ERR(qspi->clk);
 732
 733         qspi->clk_rate = clk_get_rate(qspi->clk);
 734         if (!qspi->clk_rate)
 735                 return -EINVAL;
 736
 737         ret = clk_prepare_enable(qspi->clk);
 738         if (ret) {
 739                 dev_err(dev, "can not enable the clock\n");
 740                 return ret;
 741         }
 742
 743         rstc = devm_reset_control_get_exclusive(dev, NULL);
 744         if (IS_ERR(rstc)) {
 745                 ret = PTR_ERR(rstc);
 746                 if (ret == -EPROBE_DEFER)
 747                         goto err_clk_disable;
 748         } else {
 749                 reset_control_assert(rstc);
 750                 udelay(2);
 751                 reset_control_deassert(rstc);
 752         }
 753
 754         qspi->dev = dev;
 755         platform_set_drvdata(pdev, qspi);
 756         ret = stm32_qspi_dma_setup(qspi);
 757         if (ret)
 758                 goto err_dma_free;
 759
 760         mutex_init(&qspi->lock);
 761
 762         ctrl->mode_bits = SPI_RX_DUAL | SPI_RX_QUAD
 763                 | SPI_TX_DUAL | SPI_TX_QUAD;
 764         ctrl->setup = stm32_qspi_setup;
 765         ctrl->bus_num = -1;
 766         ctrl->mem_ops = &stm32_qspi_mem_ops;
 767         ctrl->num_chipselect = STM32_QSPI_MAX_NORCHIP;
 768         ctrl->dev.of_node = dev->of_node;
 769
 770         pm_runtime_set_autosuspend_delay(dev, STM32_AUTOSUSPEND_DELAY);
 771         pm_runtime_use_autosuspend(dev);
 772         pm_runtime_set_active(dev);
 773         pm_runtime_enable(dev);
 774         pm_runtime_get_noresume(dev);
 775
 776         ret = spi_register_master(ctrl);
 777         if (ret)
 778                 goto err_pm_runtime_free;
 779
 780         pm_runtime_mark_last_busy(dev);
 781         pm_runtime_put_autosuspend(dev);
 782
 783         return 0;
 784
 785 err_pm_runtime_free:
 786         pm_runtime_get_sync(qspi->dev);
 787         /* disable qspi */
 788         writel_relaxed(0, qspi->io_base + QSPI_CR);
 789         mutex_destroy(&qspi->lock);
 790         pm_runtime_put_noidle(qspi->dev);
 791         pm_runtime_disable(qspi->dev);
 792         pm_runtime_set_suspended(qspi->dev);
 793         pm_runtime_dont_use_autosuspend(qspi->dev);
 794 err_dma_free:
 795         stm32_qspi_dma_free(qspi);
 796 err_clk_disable:
 797         clk_disable_unprepare(qspi->clk);
 798
 799         return ret;
 800 }
 801
 802 static int stm32_qspi_remove(struct platform_device *pdev)
 803 {
 804         struct stm32_qspi *qspi = platform_get_drvdata(pdev);
 805
 806         pm_runtime_get_sync(qspi->dev);
 807         spi_unregister_master(qspi->ctrl);
 808         /* disable qspi */
 809         writel_relaxed(0, qspi->io_base + QSPI_CR);
 810         stm32_qspi_dma_free(qspi);
 811         mutex_destroy(&qspi->lock);
 812         pm_runtime_put_noidle(qspi->dev);
 813         pm_runtime_disable(qspi->dev);
 814         pm_runtime_set_suspended(qspi->dev);
 815         pm_runtime_dont_use_autosuspend(qspi->dev);
 816         clk_disable_unprepare(qspi->clk);
 817
 818         return 0;
 819 }
 820
 821 static int __maybe_unused stm32_qspi_runtime_suspend(struct device *dev)
 822 {
 823         struct stm32_qspi *qspi = dev_get_drvdata(dev);
 824
 825         clk_disable_unprepare(qspi->clk);
 826
 827         return 0;
 828 }
 829
 830 static int __maybe_unused stm32_qspi_runtime_resume(struct device *dev)
 831 {
 832         struct stm32_qspi *qspi = dev_get_drvdata(dev);
 833
 834         return clk_prepare_enable(qspi->clk);
 835 }
 836
 837 static int __maybe_unused stm32_qspi_suspend(struct device *dev)
 838 {
 839         pinctrl_pm_select_sleep_state(dev);
 840
 841         return pm_runtime_force_suspend(dev);
 842 }
 843
 844 static int __maybe_unused stm32_qspi_resume(struct device *dev)
 845 {
 846         struct stm32_qspi *qspi = dev_get_drvdata(dev);
 847         int ret;
 848
 849         ret = pm_runtime_force_resume(dev);
 850         if (ret < 0)
 851                 return ret;
 852
 853         pinctrl_pm_select_default_state(dev);
 854
 855         ret = pm_runtime_get_sync(dev);
 856         if (ret < 0) {
 857                 pm_runtime_put_noidle(dev);
 858                 return ret;
 859         }
 860
 861         writel_relaxed(qspi->cr_reg, qspi->io_base + QSPI_CR);
 862         writel_relaxed(qspi->dcr_reg, qspi->io_base + QSPI_DCR);
 863
 864         pm_runtime_mark_last_busy(dev);
 865         pm_runtime_put_autosuspend(dev);
 866
 867         return 0;
 868 }
 869
 870 static const struct dev_pm_ops stm32_qspi_pm_ops = {
 871         SET_RUNTIME_PM_OPS(stm32_qspi_runtime_suspend,
 872                            stm32_qspi_runtime_resume, NULL)
 873         SET_SYSTEM_SLEEP_PM_OPS(stm32_qspi_suspend, stm32_qspi_resume)
 874 };
 875
 876 static const struct of_device_id stm32_qspi_match[] = {
 877         {.compatible = "st,stm32f469-qspi"},
 878         {}
 879 };
 880 MODULE_DEVICE_TABLE(of, stm32_qspi_match);
 881
 882 static struct platform_driver stm32_qspi_driver = {
 883         .probe  = stm32_qspi_probe,
 884         .remove = stm32_qspi_remove,
 885         .driver = {
 886                 .name = "stm32-qspi",
 887                 .of_match_table = stm32_qspi_match,
 888                 .pm = &stm32_qspi_pm_ops,
 889         },
 890 };
 891 module_platform_driver(stm32_qspi_driver);
 892
 893 MODULE_AUTHOR("Ludovic Barre <ludovic.barre@st.com>");
 894 MODULE_DESCRIPTION("STMicroelectronics STM32 quad spi driver");
 895 MODULE_LICENSE("GPL v2");