1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) STMicroelectronics 2018 - All Rights Reserved
4 * Author: Ludovic Barre <ludovic.barre@st.com> for STMicroelectronics.
6 #include <linux/bitfield.h>
8 #include <linux/dmaengine.h>
9 #include <linux/dma-mapping.h>
10 #include <linux/errno.h>
12 #include <linux/iopoll.h>
13 #include <linux/interrupt.h>
14 #include <linux/module.h>
15 #include <linux/mutex.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>
27 #define CR_ABORT BIT(1)
28 #define CR_DMAEN BIT(2)
29 #define CR_TCEN BIT(3)
30 #define CR_SSHIFT BIT(4)
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_PRESC_MASK GENMASK(31, 24)
42 #define DCR_FSIZE_MASK GENMASK(20, 16)
50 #define SR_BUSY BIT(5)
51 #define SR_FLEVEL_MASK GENMASK(13, 8)
54 #define FCR_CTEF BIT(0)
55 #define FCR_CTCF BIT(1)
60 #define CCR_INST_MASK GENMASK(7, 0)
61 #define CCR_IMODE_MASK GENMASK(9, 8)
62 #define CCR_ADMODE_MASK GENMASK(11, 10)
63 #define CCR_ADSIZE_MASK GENMASK(13, 12)
64 #define CCR_DCYC_MASK GENMASK(22, 18)
65 #define CCR_DMODE_MASK GENMASK(25, 24)
66 #define CCR_FMODE_MASK GENMASK(27, 26)
67 #define CCR_FMODE_INDW (0U << 26)
68 #define CCR_FMODE_INDR (1U << 26)
69 #define CCR_FMODE_APM (2U << 26)
70 #define CCR_FMODE_MM (3U << 26)
71 #define CCR_BUSWIDTH_0 0x0
72 #define CCR_BUSWIDTH_1 0x1
73 #define CCR_BUSWIDTH_2 0x2
74 #define CCR_BUSWIDTH_4 0x3
79 #define QSPI_PSMKR 0x24
80 #define QSPI_PSMAR 0x28
82 #define QSPI_LPTR 0x30
84 #define STM32_QSPI_MAX_MMAP_SZ SZ_256M
85 #define STM32_QSPI_MAX_NORCHIP 2
87 #define STM32_FIFO_TIMEOUT_US 30000
88 #define STM32_BUSY_TIMEOUT_US 100000
89 #define STM32_ABT_TIMEOUT_US 100000
90 #define STM32_COMP_TIMEOUT_MS 1000
91 #define STM32_AUTOSUSPEND_DELAY -1
93 struct stm32_qspi_flash {
94 struct stm32_qspi *qspi;
101 struct spi_controller *ctrl;
102 phys_addr_t phys_base;
103 void __iomem *io_base;
104 void __iomem *mm_base;
105 resource_size_t mm_size;
108 struct stm32_qspi_flash flash[STM32_QSPI_MAX_NORCHIP];
109 struct completion data_completion;
112 struct dma_chan *dma_chtx;
113 struct dma_chan *dma_chrx;
114 struct completion dma_completion;
120 * to protect device configuration, could be different between
121 * 2 flash access (bk1, bk2)
126 static irqreturn_t stm32_qspi_irq(int irq, void *dev_id)
128 struct stm32_qspi *qspi = (struct stm32_qspi *)dev_id;
131 sr = readl_relaxed(qspi->io_base + QSPI_SR);
133 if (sr & (SR_TEF | SR_TCF)) {
135 cr = readl_relaxed(qspi->io_base + QSPI_CR);
136 cr &= ~CR_TCIE & ~CR_TEIE;
137 writel_relaxed(cr, qspi->io_base + QSPI_CR);
138 complete(&qspi->data_completion);
144 static void stm32_qspi_read_fifo(u8 *val, void __iomem *addr)
146 *val = readb_relaxed(addr);
149 static void stm32_qspi_write_fifo(u8 *val, void __iomem *addr)
151 writeb_relaxed(*val, addr);
154 static int stm32_qspi_tx_poll(struct stm32_qspi *qspi,
155 const struct spi_mem_op *op)
157 void (*tx_fifo)(u8 *val, void __iomem *addr);
158 u32 len = op->data.nbytes, sr;
162 if (op->data.dir == SPI_MEM_DATA_IN) {
163 tx_fifo = stm32_qspi_read_fifo;
164 buf = op->data.buf.in;
167 tx_fifo = stm32_qspi_write_fifo;
168 buf = (u8 *)op->data.buf.out;
172 ret = readl_relaxed_poll_timeout_atomic(qspi->io_base + QSPI_SR,
173 sr, (sr & SR_FTF), 1,
174 STM32_FIFO_TIMEOUT_US);
176 dev_err(qspi->dev, "fifo timeout (len:%d stat:%#x)\n",
180 tx_fifo(buf++, qspi->io_base + QSPI_DR);
186 static int stm32_qspi_tx_mm(struct stm32_qspi *qspi,
187 const struct spi_mem_op *op)
189 memcpy_fromio(op->data.buf.in, qspi->mm_base + op->addr.val,
194 static void stm32_qspi_dma_callback(void *arg)
196 struct completion *dma_completion = arg;
198 complete(dma_completion);
201 static int stm32_qspi_tx_dma(struct stm32_qspi *qspi,
202 const struct spi_mem_op *op)
204 struct dma_async_tx_descriptor *desc;
205 enum dma_transfer_direction dma_dir;
206 struct dma_chan *dma_ch;
212 if (op->data.dir == SPI_MEM_DATA_IN) {
213 dma_dir = DMA_DEV_TO_MEM;
214 dma_ch = qspi->dma_chrx;
216 dma_dir = DMA_MEM_TO_DEV;
217 dma_ch = qspi->dma_chtx;
221 * spi_map_buf return -EINVAL if the buffer is not DMA-able
222 * (DMA-able: in vmalloc | kmap | virt_addr_valid)
224 err = spi_controller_dma_map_mem_op_data(qspi->ctrl, op, &sgt);
228 desc = dmaengine_prep_slave_sg(dma_ch, sgt.sgl, sgt.nents,
229 dma_dir, DMA_PREP_INTERRUPT);
235 cr = readl_relaxed(qspi->io_base + QSPI_CR);
237 reinit_completion(&qspi->dma_completion);
238 desc->callback = stm32_qspi_dma_callback;
239 desc->callback_param = &qspi->dma_completion;
240 cookie = dmaengine_submit(desc);
241 err = dma_submit_error(cookie);
245 dma_async_issue_pending(dma_ch);
247 writel_relaxed(cr | CR_DMAEN, qspi->io_base + QSPI_CR);
249 t_out = sgt.nents * STM32_COMP_TIMEOUT_MS;
250 if (!wait_for_completion_timeout(&qspi->dma_completion,
251 msecs_to_jiffies(t_out)))
255 dmaengine_terminate_all(dma_ch);
258 writel_relaxed(cr & ~CR_DMAEN, qspi->io_base + QSPI_CR);
260 spi_controller_dma_unmap_mem_op_data(qspi->ctrl, op, &sgt);
265 static int stm32_qspi_tx(struct stm32_qspi *qspi, const struct spi_mem_op *op)
267 if (!op->data.nbytes)
270 if (qspi->fmode == CCR_FMODE_MM)
271 return stm32_qspi_tx_mm(qspi, op);
272 else if ((op->data.dir == SPI_MEM_DATA_IN && qspi->dma_chrx) ||
273 (op->data.dir == SPI_MEM_DATA_OUT && qspi->dma_chtx))
274 if (!stm32_qspi_tx_dma(qspi, op))
277 return stm32_qspi_tx_poll(qspi, op);
280 static int stm32_qspi_wait_nobusy(struct stm32_qspi *qspi)
284 return readl_relaxed_poll_timeout_atomic(qspi->io_base + QSPI_SR, sr,
286 STM32_BUSY_TIMEOUT_US);
289 static int stm32_qspi_wait_cmd(struct stm32_qspi *qspi,
290 const struct spi_mem_op *op)
295 if (!op->data.nbytes)
298 if ((readl_relaxed(qspi->io_base + QSPI_SR) & SR_TCF) ||
299 qspi->fmode == CCR_FMODE_APM)
302 reinit_completion(&qspi->data_completion);
303 cr = readl_relaxed(qspi->io_base + QSPI_CR);
304 writel_relaxed(cr | CR_TCIE | CR_TEIE, qspi->io_base + QSPI_CR);
306 if (!wait_for_completion_timeout(&qspi->data_completion,
307 msecs_to_jiffies(STM32_COMP_TIMEOUT_MS))) {
310 sr = readl_relaxed(qspi->io_base + QSPI_SR);
317 writel_relaxed(FCR_CTCF | FCR_CTEF, qspi->io_base + QSPI_FCR);
320 err = stm32_qspi_wait_nobusy(qspi);
325 static int stm32_qspi_get_mode(struct stm32_qspi *qspi, u8 buswidth)
328 return CCR_BUSWIDTH_4;
333 static int stm32_qspi_send(struct spi_mem *mem, const struct spi_mem_op *op)
335 struct stm32_qspi *qspi = spi_controller_get_devdata(mem->spi->master);
336 struct stm32_qspi_flash *flash = &qspi->flash[mem->spi->chip_select];
337 u32 ccr, cr, addr_max;
338 int timeout, err = 0;
340 dev_dbg(qspi->dev, "cmd:%#x mode:%d.%d.%d.%d addr:%#llx len:%#x\n",
341 op->cmd.opcode, op->cmd.buswidth, op->addr.buswidth,
342 op->dummy.buswidth, op->data.buswidth,
343 op->addr.val, op->data.nbytes);
345 err = stm32_qspi_wait_nobusy(qspi);
349 addr_max = op->addr.val + op->data.nbytes + 1;
351 if (op->data.dir == SPI_MEM_DATA_IN) {
352 if (addr_max < qspi->mm_size &&
354 qspi->fmode = CCR_FMODE_MM;
356 qspi->fmode = CCR_FMODE_INDR;
358 qspi->fmode = CCR_FMODE_INDW;
361 cr = readl_relaxed(qspi->io_base + QSPI_CR);
362 cr &= ~CR_PRESC_MASK & ~CR_FSEL;
363 cr |= FIELD_PREP(CR_PRESC_MASK, flash->presc);
364 cr |= FIELD_PREP(CR_FSEL, flash->cs);
365 writel_relaxed(cr, qspi->io_base + QSPI_CR);
368 writel_relaxed(op->data.nbytes - 1,
369 qspi->io_base + QSPI_DLR);
371 qspi->fmode = CCR_FMODE_INDW;
374 ccr |= FIELD_PREP(CCR_INST_MASK, op->cmd.opcode);
375 ccr |= FIELD_PREP(CCR_IMODE_MASK,
376 stm32_qspi_get_mode(qspi, op->cmd.buswidth));
378 if (op->addr.nbytes) {
379 ccr |= FIELD_PREP(CCR_ADMODE_MASK,
380 stm32_qspi_get_mode(qspi, op->addr.buswidth));
381 ccr |= FIELD_PREP(CCR_ADSIZE_MASK, op->addr.nbytes - 1);
384 if (op->dummy.buswidth && op->dummy.nbytes)
385 ccr |= FIELD_PREP(CCR_DCYC_MASK,
386 op->dummy.nbytes * 8 / op->dummy.buswidth);
388 if (op->data.nbytes) {
389 ccr |= FIELD_PREP(CCR_DMODE_MASK,
390 stm32_qspi_get_mode(qspi, op->data.buswidth));
393 writel_relaxed(ccr, qspi->io_base + QSPI_CCR);
395 if (op->addr.nbytes && qspi->fmode != CCR_FMODE_MM)
396 writel_relaxed(op->addr.val, qspi->io_base + QSPI_AR);
398 err = stm32_qspi_tx(qspi, op);
403 * -read memory map: prefetching must be stopped if we read the last
404 * byte of device (device size - fifo size). like device size is not
405 * knows, the prefetching is always stop.
407 if (err || qspi->fmode == CCR_FMODE_MM)
410 /* wait end of tx in indirect mode */
411 err = stm32_qspi_wait_cmd(qspi, op);
418 cr = readl_relaxed(qspi->io_base + QSPI_CR) | CR_ABORT;
419 writel_relaxed(cr, qspi->io_base + QSPI_CR);
421 /* wait clear of abort bit by hw */
422 timeout = readl_relaxed_poll_timeout_atomic(qspi->io_base + QSPI_CR,
423 cr, !(cr & CR_ABORT), 1,
424 STM32_ABT_TIMEOUT_US);
426 writel_relaxed(FCR_CTCF, qspi->io_base + QSPI_FCR);
429 dev_err(qspi->dev, "%s err:%d abort timeout:%d\n",
430 __func__, err, timeout);
435 static int stm32_qspi_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)
437 struct stm32_qspi *qspi = spi_controller_get_devdata(mem->spi->master);
440 ret = pm_runtime_get_sync(qspi->dev);
442 pm_runtime_put_noidle(qspi->dev);
446 mutex_lock(&qspi->lock);
447 ret = stm32_qspi_send(mem, op);
448 mutex_unlock(&qspi->lock);
450 pm_runtime_mark_last_busy(qspi->dev);
451 pm_runtime_put_autosuspend(qspi->dev);
456 static int stm32_qspi_setup(struct spi_device *spi)
458 struct spi_controller *ctrl = spi->master;
459 struct stm32_qspi *qspi = spi_controller_get_devdata(ctrl);
460 struct stm32_qspi_flash *flash;
467 if (!spi->max_speed_hz)
470 ret = pm_runtime_get_sync(qspi->dev);
472 pm_runtime_put_noidle(qspi->dev);
476 presc = DIV_ROUND_UP(qspi->clk_rate, spi->max_speed_hz) - 1;
478 flash = &qspi->flash[spi->chip_select];
480 flash->cs = spi->chip_select;
481 flash->presc = presc;
483 mutex_lock(&qspi->lock);
484 qspi->cr_reg = 3 << CR_FTHRES_SHIFT | CR_SSHIFT | CR_EN;
485 writel_relaxed(qspi->cr_reg, qspi->io_base + QSPI_CR);
487 /* set dcr fsize to max address */
488 qspi->dcr_reg = DCR_FSIZE_MASK;
489 writel_relaxed(qspi->dcr_reg, qspi->io_base + QSPI_DCR);
490 mutex_unlock(&qspi->lock);
492 pm_runtime_mark_last_busy(qspi->dev);
493 pm_runtime_put_autosuspend(qspi->dev);
498 static int stm32_qspi_dma_setup(struct stm32_qspi *qspi)
500 struct dma_slave_config dma_cfg;
501 struct device *dev = qspi->dev;
504 memset(&dma_cfg, 0, sizeof(dma_cfg));
506 dma_cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
507 dma_cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
508 dma_cfg.src_addr = qspi->phys_base + QSPI_DR;
509 dma_cfg.dst_addr = qspi->phys_base + QSPI_DR;
510 dma_cfg.src_maxburst = 4;
511 dma_cfg.dst_maxburst = 4;
513 qspi->dma_chrx = dma_request_chan(dev, "rx");
514 if (IS_ERR(qspi->dma_chrx)) {
515 ret = PTR_ERR(qspi->dma_chrx);
516 qspi->dma_chrx = NULL;
517 if (ret == -EPROBE_DEFER)
520 if (dmaengine_slave_config(qspi->dma_chrx, &dma_cfg)) {
521 dev_err(dev, "dma rx config failed\n");
522 dma_release_channel(qspi->dma_chrx);
523 qspi->dma_chrx = NULL;
527 qspi->dma_chtx = dma_request_chan(dev, "tx");
528 if (IS_ERR(qspi->dma_chtx)) {
529 ret = PTR_ERR(qspi->dma_chtx);
530 qspi->dma_chtx = NULL;
532 if (dmaengine_slave_config(qspi->dma_chtx, &dma_cfg)) {
533 dev_err(dev, "dma tx config failed\n");
534 dma_release_channel(qspi->dma_chtx);
535 qspi->dma_chtx = NULL;
540 init_completion(&qspi->dma_completion);
542 if (ret != -EPROBE_DEFER)
548 static void stm32_qspi_dma_free(struct stm32_qspi *qspi)
551 dma_release_channel(qspi->dma_chtx);
553 dma_release_channel(qspi->dma_chrx);
557 * no special host constraint, so use default spi_mem_default_supports_op
558 * to check supported mode.
560 static const struct spi_controller_mem_ops stm32_qspi_mem_ops = {
561 .exec_op = stm32_qspi_exec_op,
564 static int stm32_qspi_probe(struct platform_device *pdev)
566 struct device *dev = &pdev->dev;
567 struct spi_controller *ctrl;
568 struct reset_control *rstc;
569 struct stm32_qspi *qspi;
570 struct resource *res;
573 ctrl = spi_alloc_master(dev, sizeof(*qspi));
577 qspi = spi_controller_get_devdata(ctrl);
580 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qspi");
581 qspi->io_base = devm_ioremap_resource(dev, res);
582 if (IS_ERR(qspi->io_base)) {
583 ret = PTR_ERR(qspi->io_base);
587 qspi->phys_base = res->start;
589 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qspi_mm");
590 qspi->mm_base = devm_ioremap_resource(dev, res);
591 if (IS_ERR(qspi->mm_base)) {
592 ret = PTR_ERR(qspi->mm_base);
596 qspi->mm_size = resource_size(res);
597 if (qspi->mm_size > STM32_QSPI_MAX_MMAP_SZ) {
602 irq = platform_get_irq(pdev, 0);
608 ret = devm_request_irq(dev, irq, stm32_qspi_irq, 0,
609 dev_name(dev), qspi);
611 dev_err(dev, "failed to request irq\n");
615 init_completion(&qspi->data_completion);
617 qspi->clk = devm_clk_get(dev, NULL);
618 if (IS_ERR(qspi->clk)) {
619 ret = PTR_ERR(qspi->clk);
623 qspi->clk_rate = clk_get_rate(qspi->clk);
624 if (!qspi->clk_rate) {
629 ret = clk_prepare_enable(qspi->clk);
631 dev_err(dev, "can not enable the clock\n");
635 rstc = devm_reset_control_get_exclusive(dev, NULL);
638 if (ret == -EPROBE_DEFER)
639 goto err_clk_disable;
641 reset_control_assert(rstc);
643 reset_control_deassert(rstc);
647 platform_set_drvdata(pdev, qspi);
648 ret = stm32_qspi_dma_setup(qspi);
652 mutex_init(&qspi->lock);
654 ctrl->mode_bits = SPI_RX_DUAL | SPI_RX_QUAD
655 | SPI_TX_DUAL | SPI_TX_QUAD;
656 ctrl->setup = stm32_qspi_setup;
658 ctrl->mem_ops = &stm32_qspi_mem_ops;
659 ctrl->num_chipselect = STM32_QSPI_MAX_NORCHIP;
660 ctrl->dev.of_node = dev->of_node;
662 pm_runtime_set_autosuspend_delay(dev, STM32_AUTOSUSPEND_DELAY);
663 pm_runtime_use_autosuspend(dev);
664 pm_runtime_set_active(dev);
665 pm_runtime_enable(dev);
666 pm_runtime_get_noresume(dev);
668 ret = devm_spi_register_master(dev, ctrl);
670 goto err_pm_runtime_free;
672 pm_runtime_mark_last_busy(dev);
673 pm_runtime_put_autosuspend(dev);
678 pm_runtime_get_sync(qspi->dev);
680 writel_relaxed(0, qspi->io_base + QSPI_CR);
681 mutex_destroy(&qspi->lock);
682 pm_runtime_put_noidle(qspi->dev);
683 pm_runtime_disable(qspi->dev);
684 pm_runtime_set_suspended(qspi->dev);
685 pm_runtime_dont_use_autosuspend(qspi->dev);
687 stm32_qspi_dma_free(qspi);
689 clk_disable_unprepare(qspi->clk);
691 spi_master_put(qspi->ctrl);
696 static int stm32_qspi_remove(struct platform_device *pdev)
698 struct stm32_qspi *qspi = platform_get_drvdata(pdev);
700 pm_runtime_get_sync(qspi->dev);
702 writel_relaxed(0, qspi->io_base + QSPI_CR);
703 stm32_qspi_dma_free(qspi);
704 mutex_destroy(&qspi->lock);
705 pm_runtime_put_noidle(qspi->dev);
706 pm_runtime_disable(qspi->dev);
707 pm_runtime_set_suspended(qspi->dev);
708 pm_runtime_dont_use_autosuspend(qspi->dev);
709 clk_disable_unprepare(qspi->clk);
714 static int __maybe_unused stm32_qspi_runtime_suspend(struct device *dev)
716 struct stm32_qspi *qspi = dev_get_drvdata(dev);
718 clk_disable_unprepare(qspi->clk);
723 static int __maybe_unused stm32_qspi_runtime_resume(struct device *dev)
725 struct stm32_qspi *qspi = dev_get_drvdata(dev);
727 return clk_prepare_enable(qspi->clk);
730 static int __maybe_unused stm32_qspi_suspend(struct device *dev)
732 pinctrl_pm_select_sleep_state(dev);
734 return pm_runtime_force_suspend(dev);
737 static int __maybe_unused stm32_qspi_resume(struct device *dev)
739 struct stm32_qspi *qspi = dev_get_drvdata(dev);
742 ret = pm_runtime_force_resume(dev);
746 pinctrl_pm_select_default_state(dev);
748 ret = pm_runtime_get_sync(dev);
750 pm_runtime_put_noidle(dev);
754 writel_relaxed(qspi->cr_reg, qspi->io_base + QSPI_CR);
755 writel_relaxed(qspi->dcr_reg, qspi->io_base + QSPI_DCR);
757 pm_runtime_mark_last_busy(dev);
758 pm_runtime_put_autosuspend(dev);
763 static const struct dev_pm_ops stm32_qspi_pm_ops = {
764 SET_RUNTIME_PM_OPS(stm32_qspi_runtime_suspend,
765 stm32_qspi_runtime_resume, NULL)
766 SET_SYSTEM_SLEEP_PM_OPS(stm32_qspi_suspend, stm32_qspi_resume)
769 static const struct of_device_id stm32_qspi_match[] = {
770 {.compatible = "st,stm32f469-qspi"},
773 MODULE_DEVICE_TABLE(of, stm32_qspi_match);
775 static struct platform_driver stm32_qspi_driver = {
776 .probe = stm32_qspi_probe,
777 .remove = stm32_qspi_remove,
779 .name = "stm32-qspi",
780 .of_match_table = stm32_qspi_match,
781 .pm = &stm32_qspi_pm_ops,
784 module_platform_driver(stm32_qspi_driver);
786 MODULE_AUTHOR("Ludovic Barre <ludovic.barre@st.com>");
787 MODULE_DESCRIPTION("STMicroelectronics STM32 quad spi driver");
788 MODULE_LICENSE("GPL v2");