2 * Driver for stm32 quadspi controller
4 * Copyright (C) 2017, STMicroelectronics - All Rights Reserved
5 * Author(s): Ludovic Barre author <ludovic.barre@st.com>.
7 * License terms: GPL V2.0.
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License version 2 as published by
11 * the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License along with
19 * This program. If not, see <http://www.gnu.org/licenses/>.
21 #include <linux/clk.h>
22 #include <linux/errno.h>
24 #include <linux/iopoll.h>
25 #include <linux/interrupt.h>
26 #include <linux/module.h>
27 #include <linux/mtd/mtd.h>
28 #include <linux/mtd/partitions.h>
29 #include <linux/mtd/spi-nor.h>
30 #include <linux/mutex.h>
32 #include <linux/of_device.h>
33 #include <linux/platform_device.h>
34 #include <linux/reset.h>
35 #include <linux/sizes.h>
37 #define QUADSPI_CR 0x00
39 #define CR_ABORT BIT(1)
40 #define CR_DMAEN BIT(2)
41 #define CR_TCEN BIT(3)
42 #define CR_SSHIFT BIT(4)
44 #define CR_FSEL BIT(7)
45 #define CR_FTHRES_SHIFT 8
46 #define CR_FTHRES_MASK GENMASK(12, 8)
47 #define CR_FTHRES(n) (((n) << CR_FTHRES_SHIFT) & CR_FTHRES_MASK)
48 #define CR_TEIE BIT(16)
49 #define CR_TCIE BIT(17)
50 #define CR_FTIE BIT(18)
51 #define CR_SMIE BIT(19)
52 #define CR_TOIE BIT(20)
53 #define CR_PRESC_SHIFT 24
54 #define CR_PRESC_MASK GENMASK(31, 24)
55 #define CR_PRESC(n) (((n) << CR_PRESC_SHIFT) & CR_PRESC_MASK)
57 #define QUADSPI_DCR 0x04
58 #define DCR_CSHT_SHIFT 8
59 #define DCR_CSHT_MASK GENMASK(10, 8)
60 #define DCR_CSHT(n) (((n) << DCR_CSHT_SHIFT) & DCR_CSHT_MASK)
61 #define DCR_FSIZE_SHIFT 16
62 #define DCR_FSIZE_MASK GENMASK(20, 16)
63 #define DCR_FSIZE(n) (((n) << DCR_FSIZE_SHIFT) & DCR_FSIZE_MASK)
65 #define QUADSPI_SR 0x08
71 #define SR_BUSY BIT(5)
72 #define SR_FLEVEL_SHIFT 8
73 #define SR_FLEVEL_MASK GENMASK(13, 8)
75 #define QUADSPI_FCR 0x0c
76 #define FCR_CTCF BIT(1)
78 #define QUADSPI_DLR 0x10
80 #define QUADSPI_CCR 0x14
81 #define CCR_INST_SHIFT 0
82 #define CCR_INST_MASK GENMASK(7, 0)
83 #define CCR_INST(n) (((n) << CCR_INST_SHIFT) & CCR_INST_MASK)
84 #define CCR_IMODE_NONE (0U << 8)
85 #define CCR_IMODE_1 (1U << 8)
86 #define CCR_IMODE_2 (2U << 8)
87 #define CCR_IMODE_4 (3U << 8)
88 #define CCR_ADMODE_NONE (0U << 10)
89 #define CCR_ADMODE_1 (1U << 10)
90 #define CCR_ADMODE_2 (2U << 10)
91 #define CCR_ADMODE_4 (3U << 10)
92 #define CCR_ADSIZE_SHIFT 12
93 #define CCR_ADSIZE_MASK GENMASK(13, 12)
94 #define CCR_ADSIZE(n) (((n) << CCR_ADSIZE_SHIFT) & CCR_ADSIZE_MASK)
95 #define CCR_ABMODE_NONE (0U << 14)
96 #define CCR_ABMODE_1 (1U << 14)
97 #define CCR_ABMODE_2 (2U << 14)
98 #define CCR_ABMODE_4 (3U << 14)
99 #define CCR_ABSIZE_8 (0U << 16)
100 #define CCR_ABSIZE_16 (1U << 16)
101 #define CCR_ABSIZE_24 (2U << 16)
102 #define CCR_ABSIZE_32 (3U << 16)
103 #define CCR_DCYC_SHIFT 18
104 #define CCR_DCYC_MASK GENMASK(22, 18)
105 #define CCR_DCYC(n) (((n) << CCR_DCYC_SHIFT) & CCR_DCYC_MASK)
106 #define CCR_DMODE_NONE (0U << 24)
107 #define CCR_DMODE_1 (1U << 24)
108 #define CCR_DMODE_2 (2U << 24)
109 #define CCR_DMODE_4 (3U << 24)
110 #define CCR_FMODE_INDW (0U << 26)
111 #define CCR_FMODE_INDR (1U << 26)
112 #define CCR_FMODE_APM (2U << 26)
113 #define CCR_FMODE_MM (3U << 26)
115 #define QUADSPI_AR 0x18
116 #define QUADSPI_ABR 0x1c
117 #define QUADSPI_DR 0x20
118 #define QUADSPI_PSMKR 0x24
119 #define QUADSPI_PSMAR 0x28
120 #define QUADSPI_PIR 0x2c
121 #define QUADSPI_LPTR 0x30
122 #define LPTR_DFT_TIMEOUT 0x10
124 #define FSIZE_VAL(size) (__fls(size) - 1)
126 #define STM32_MAX_MMAP_SZ SZ_256M
127 #define STM32_MAX_NORCHIP 2
129 #define STM32_QSPI_FIFO_SZ 32
130 #define STM32_QSPI_FIFO_TIMEOUT_US 30000
131 #define STM32_QSPI_BUSY_TIMEOUT_US 100000
133 struct stm32_qspi_flash {
135 struct stm32_qspi *qspi;
146 void __iomem *io_base;
147 void __iomem *mm_base;
148 resource_size_t mm_size;
152 struct stm32_qspi_flash flash[STM32_MAX_NORCHIP];
153 struct completion cmd_completion;
156 * to protect device configuration, could be different between
157 * 2 flash access (bk1, bk2)
162 struct stm32_qspi_cmd {
174 static int stm32_qspi_wait_cmd(struct stm32_qspi *qspi)
179 if (readl_relaxed(qspi->io_base + QUADSPI_SR) & SR_TCF)
182 reinit_completion(&qspi->cmd_completion);
183 cr = readl_relaxed(qspi->io_base + QUADSPI_CR);
184 writel_relaxed(cr | CR_TCIE, qspi->io_base + QUADSPI_CR);
186 if (!wait_for_completion_interruptible_timeout(&qspi->cmd_completion,
187 msecs_to_jiffies(1000)))
190 writel_relaxed(cr, qspi->io_base + QUADSPI_CR);
194 static int stm32_qspi_wait_nobusy(struct stm32_qspi *qspi)
198 return readl_relaxed_poll_timeout(qspi->io_base + QUADSPI_SR, sr,
200 STM32_QSPI_BUSY_TIMEOUT_US);
203 static void stm32_qspi_set_framemode(struct spi_nor *nor,
204 struct stm32_qspi_cmd *cmd, bool read)
206 u32 dmode = CCR_DMODE_1;
208 cmd->framemode = CCR_IMODE_1;
211 switch (nor->read_proto) {
213 case SNOR_PROTO_1_1_1:
216 case SNOR_PROTO_1_1_2:
219 case SNOR_PROTO_1_1_4:
225 cmd->framemode |= cmd->tx_data ? dmode : 0;
226 cmd->framemode |= cmd->addr_width ? CCR_ADMODE_1 : 0;
229 static void stm32_qspi_read_fifo(u8 *val, void __iomem *addr)
231 *val = readb_relaxed(addr);
234 static void stm32_qspi_write_fifo(u8 *val, void __iomem *addr)
236 writeb_relaxed(*val, addr);
239 static int stm32_qspi_tx_poll(struct stm32_qspi *qspi,
240 const struct stm32_qspi_cmd *cmd)
242 void (*tx_fifo)(u8 *, void __iomem *);
243 u32 len = cmd->len, sr;
247 if (cmd->qspimode == CCR_FMODE_INDW)
248 tx_fifo = stm32_qspi_write_fifo;
250 tx_fifo = stm32_qspi_read_fifo;
253 ret = readl_relaxed_poll_timeout(qspi->io_base + QUADSPI_SR,
254 sr, (sr & SR_FTF), 10,
255 STM32_QSPI_FIFO_TIMEOUT_US);
257 dev_err(qspi->dev, "fifo timeout (stat:%#x)\n", sr);
260 tx_fifo(buf++, qspi->io_base + QUADSPI_DR);
266 static int stm32_qspi_tx_mm(struct stm32_qspi *qspi,
267 const struct stm32_qspi_cmd *cmd)
269 memcpy_fromio(cmd->buf, qspi->mm_base + cmd->addr, cmd->len);
273 static int stm32_qspi_tx(struct stm32_qspi *qspi,
274 const struct stm32_qspi_cmd *cmd)
279 if (cmd->qspimode == CCR_FMODE_MM)
280 return stm32_qspi_tx_mm(qspi, cmd);
282 return stm32_qspi_tx_poll(qspi, cmd);
285 static int stm32_qspi_send(struct stm32_qspi_flash *flash,
286 const struct stm32_qspi_cmd *cmd)
288 struct stm32_qspi *qspi = flash->qspi;
293 err = stm32_qspi_wait_nobusy(qspi);
297 dcr = readl_relaxed(qspi->io_base + QUADSPI_DCR) & ~DCR_FSIZE_MASK;
298 dcr |= DCR_FSIZE(flash->fsize);
299 writel_relaxed(dcr, qspi->io_base + QUADSPI_DCR);
301 cr = readl_relaxed(qspi->io_base + QUADSPI_CR);
302 cr &= ~CR_PRESC_MASK & ~CR_FSEL;
303 cr |= CR_PRESC(flash->presc);
304 cr |= flash->cs ? CR_FSEL : 0;
305 writel_relaxed(cr, qspi->io_base + QUADSPI_CR);
308 writel_relaxed(cmd->len - 1, qspi->io_base + QUADSPI_DLR);
310 ccr = cmd->framemode | cmd->qspimode;
313 ccr |= CCR_DCYC(cmd->dummy);
316 ccr |= CCR_ADSIZE(cmd->addr_width - 1);
318 ccr |= CCR_INST(cmd->opcode);
319 writel_relaxed(ccr, qspi->io_base + QUADSPI_CCR);
321 if (cmd->addr_width && cmd->qspimode != CCR_FMODE_MM)
322 writel_relaxed(cmd->addr, qspi->io_base + QUADSPI_AR);
324 err = stm32_qspi_tx(qspi, cmd);
328 if (cmd->qspimode != CCR_FMODE_MM) {
329 err = stm32_qspi_wait_cmd(qspi);
332 writel_relaxed(FCR_CTCF, qspi->io_base + QUADSPI_FCR);
334 last_byte = cmd->addr + cmd->len;
335 if (last_byte > flash->prefetch_limit)
342 cr = readl_relaxed(qspi->io_base + QUADSPI_CR) | CR_ABORT;
343 writel_relaxed(cr, qspi->io_base + QUADSPI_CR);
346 dev_err(qspi->dev, "%s abort err:%d\n", __func__, err);
351 static int stm32_qspi_read_reg(struct spi_nor *nor,
352 u8 opcode, u8 *buf, int len)
354 struct stm32_qspi_flash *flash = nor->priv;
355 struct device *dev = flash->qspi->dev;
356 struct stm32_qspi_cmd cmd;
358 dev_dbg(dev, "read_reg: cmd:%#.2x buf:%pK len:%#x\n", opcode, buf, len);
360 memset(&cmd, 0, sizeof(cmd));
365 cmd.qspimode = CCR_FMODE_INDR;
367 stm32_qspi_set_framemode(nor, &cmd, false);
369 return stm32_qspi_send(flash, &cmd);
372 static int stm32_qspi_write_reg(struct spi_nor *nor, u8 opcode,
375 struct stm32_qspi_flash *flash = nor->priv;
376 struct device *dev = flash->qspi->dev;
377 struct stm32_qspi_cmd cmd;
379 dev_dbg(dev, "write_reg: cmd:%#.2x buf:%pK len:%#x\n", opcode, buf, len);
381 memset(&cmd, 0, sizeof(cmd));
383 cmd.tx_data = !!(buf && len > 0);
386 cmd.qspimode = CCR_FMODE_INDW;
388 stm32_qspi_set_framemode(nor, &cmd, false);
390 return stm32_qspi_send(flash, &cmd);
393 static ssize_t stm32_qspi_read(struct spi_nor *nor, loff_t from, size_t len,
396 struct stm32_qspi_flash *flash = nor->priv;
397 struct stm32_qspi *qspi = flash->qspi;
398 struct stm32_qspi_cmd cmd;
401 dev_dbg(qspi->dev, "read(%#.2x): buf:%pK from:%#.8x len:%#zx\n",
402 nor->read_opcode, buf, (u32)from, len);
404 memset(&cmd, 0, sizeof(cmd));
405 cmd.opcode = nor->read_opcode;
406 cmd.addr_width = nor->addr_width;
407 cmd.addr = (u32)from;
409 cmd.dummy = nor->read_dummy;
412 cmd.qspimode = flash->read_mode;
414 stm32_qspi_set_framemode(nor, &cmd, true);
415 err = stm32_qspi_send(flash, &cmd);
417 return err ? err : len;
420 static ssize_t stm32_qspi_write(struct spi_nor *nor, loff_t to, size_t len,
423 struct stm32_qspi_flash *flash = nor->priv;
424 struct device *dev = flash->qspi->dev;
425 struct stm32_qspi_cmd cmd;
428 dev_dbg(dev, "write(%#.2x): buf:%p to:%#.8x len:%#zx\n",
429 nor->program_opcode, buf, (u32)to, len);
431 memset(&cmd, 0, sizeof(cmd));
432 cmd.opcode = nor->program_opcode;
433 cmd.addr_width = nor->addr_width;
437 cmd.buf = (void *)buf;
438 cmd.qspimode = CCR_FMODE_INDW;
440 stm32_qspi_set_framemode(nor, &cmd, false);
441 err = stm32_qspi_send(flash, &cmd);
443 return err ? err : len;
446 static int stm32_qspi_erase(struct spi_nor *nor, loff_t offs)
448 struct stm32_qspi_flash *flash = nor->priv;
449 struct device *dev = flash->qspi->dev;
450 struct stm32_qspi_cmd cmd;
452 dev_dbg(dev, "erase(%#.2x):offs:%#x\n", nor->erase_opcode, (u32)offs);
454 memset(&cmd, 0, sizeof(cmd));
455 cmd.opcode = nor->erase_opcode;
456 cmd.addr_width = nor->addr_width;
457 cmd.addr = (u32)offs;
458 cmd.qspimode = CCR_FMODE_INDW;
460 stm32_qspi_set_framemode(nor, &cmd, false);
462 return stm32_qspi_send(flash, &cmd);
465 static irqreturn_t stm32_qspi_irq(int irq, void *dev_id)
467 struct stm32_qspi *qspi = (struct stm32_qspi *)dev_id;
470 cr = readl_relaxed(qspi->io_base + QUADSPI_CR);
471 sr = readl_relaxed(qspi->io_base + QUADSPI_SR);
473 if ((cr & CR_TCIE) && (sr & SR_TCF)) {
476 complete(&qspi->cmd_completion);
478 dev_info_ratelimited(qspi->dev, "spurious interrupt\n");
481 writel_relaxed(fcr, qspi->io_base + QUADSPI_FCR);
486 static int stm32_qspi_prep(struct spi_nor *nor, enum spi_nor_ops ops)
488 struct stm32_qspi_flash *flash = nor->priv;
489 struct stm32_qspi *qspi = flash->qspi;
491 mutex_lock(&qspi->lock);
495 static void stm32_qspi_unprep(struct spi_nor *nor, enum spi_nor_ops ops)
497 struct stm32_qspi_flash *flash = nor->priv;
498 struct stm32_qspi *qspi = flash->qspi;
500 mutex_unlock(&qspi->lock);
503 static int stm32_qspi_flash_setup(struct stm32_qspi *qspi,
504 struct device_node *np)
506 struct spi_nor_hwcaps hwcaps = {
507 .mask = SNOR_HWCAPS_READ |
508 SNOR_HWCAPS_READ_FAST |
511 u32 width, presc, cs_num, max_rate = 0;
512 struct stm32_qspi_flash *flash;
513 struct mtd_info *mtd;
516 of_property_read_u32(np, "reg", &cs_num);
517 if (cs_num >= STM32_MAX_NORCHIP)
520 of_property_read_u32(np, "spi-max-frequency", &max_rate);
524 presc = DIV_ROUND_UP(qspi->clk_rate, max_rate) - 1;
526 if (of_property_read_u32(np, "spi-rx-bus-width", &width))
530 hwcaps.mask |= SNOR_HWCAPS_READ_1_1_4;
532 hwcaps.mask |= SNOR_HWCAPS_READ_1_1_2;
536 flash = &qspi->flash[cs_num];
539 flash->presc = presc;
541 flash->nor.dev = qspi->dev;
542 spi_nor_set_flash_node(&flash->nor, np);
543 flash->nor.priv = flash;
544 mtd = &flash->nor.mtd;
546 flash->nor.read = stm32_qspi_read;
547 flash->nor.write = stm32_qspi_write;
548 flash->nor.erase = stm32_qspi_erase;
549 flash->nor.read_reg = stm32_qspi_read_reg;
550 flash->nor.write_reg = stm32_qspi_write_reg;
551 flash->nor.prepare = stm32_qspi_prep;
552 flash->nor.unprepare = stm32_qspi_unprep;
554 writel_relaxed(LPTR_DFT_TIMEOUT, qspi->io_base + QUADSPI_LPTR);
556 writel_relaxed(CR_PRESC(presc) | CR_FTHRES(3) | CR_TCEN | CR_SSHIFT
557 | CR_EN, qspi->io_base + QUADSPI_CR);
560 * in stm32 qspi controller, QUADSPI_DCR register has a fsize field
561 * which define the size of nor flash.
562 * if fsize is NULL, the controller can't sent spi-nor command.
563 * set a temporary value just to discover the nor flash with
564 * "spi_nor_scan". After, the right value (mtd->size) can be set.
566 flash->fsize = FSIZE_VAL(SZ_1K);
568 ret = spi_nor_scan(&flash->nor, NULL, &hwcaps);
570 dev_err(qspi->dev, "device scan failed\n");
574 flash->fsize = FSIZE_VAL(mtd->size);
575 flash->prefetch_limit = mtd->size - STM32_QSPI_FIFO_SZ;
577 flash->read_mode = CCR_FMODE_MM;
578 if (mtd->size > qspi->mm_size)
579 flash->read_mode = CCR_FMODE_INDR;
581 writel_relaxed(DCR_CSHT(1), qspi->io_base + QUADSPI_DCR);
583 ret = mtd_device_register(mtd, NULL, 0);
585 dev_err(qspi->dev, "mtd device parse failed\n");
589 flash->registered = true;
591 dev_dbg(qspi->dev, "read mm:%s cs:%d bus:%d\n",
592 flash->read_mode == CCR_FMODE_MM ? "yes" : "no", cs_num, width);
597 static void stm32_qspi_mtd_free(struct stm32_qspi *qspi)
601 for (i = 0; i < STM32_MAX_NORCHIP; i++)
602 if (qspi->flash[i].registered)
603 mtd_device_unregister(&qspi->flash[i].nor.mtd);
606 static int stm32_qspi_probe(struct platform_device *pdev)
608 struct device *dev = &pdev->dev;
609 struct device_node *flash_np;
610 struct reset_control *rstc;
611 struct stm32_qspi *qspi;
612 struct resource *res;
615 qspi = devm_kzalloc(dev, sizeof(*qspi), GFP_KERNEL);
619 qspi->nor_num = of_get_child_count(dev->of_node);
620 if (!qspi->nor_num || qspi->nor_num > STM32_MAX_NORCHIP)
623 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qspi");
624 qspi->io_base = devm_ioremap_resource(dev, res);
625 if (IS_ERR(qspi->io_base))
626 return PTR_ERR(qspi->io_base);
628 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qspi_mm");
629 qspi->mm_base = devm_ioremap_resource(dev, res);
630 if (IS_ERR(qspi->mm_base))
631 return PTR_ERR(qspi->mm_base);
633 qspi->mm_size = resource_size(res);
635 irq = platform_get_irq(pdev, 0);
636 ret = devm_request_irq(dev, irq, stm32_qspi_irq, 0,
637 dev_name(dev), qspi);
639 dev_err(dev, "failed to request irq\n");
643 init_completion(&qspi->cmd_completion);
645 qspi->clk = devm_clk_get(dev, NULL);
646 if (IS_ERR(qspi->clk))
647 return PTR_ERR(qspi->clk);
649 qspi->clk_rate = clk_get_rate(qspi->clk);
653 ret = clk_prepare_enable(qspi->clk);
655 dev_err(dev, "can not enable the clock\n");
659 rstc = devm_reset_control_get_exclusive(dev, NULL);
661 reset_control_assert(rstc);
663 reset_control_deassert(rstc);
667 platform_set_drvdata(pdev, qspi);
668 mutex_init(&qspi->lock);
670 for_each_available_child_of_node(dev->of_node, flash_np) {
671 ret = stm32_qspi_flash_setup(qspi, flash_np);
673 dev_err(dev, "unable to setup flash chip\n");
681 mutex_destroy(&qspi->lock);
682 stm32_qspi_mtd_free(qspi);
684 clk_disable_unprepare(qspi->clk);
688 static int stm32_qspi_remove(struct platform_device *pdev)
690 struct stm32_qspi *qspi = platform_get_drvdata(pdev);
693 writel_relaxed(0, qspi->io_base + QUADSPI_CR);
695 stm32_qspi_mtd_free(qspi);
696 mutex_destroy(&qspi->lock);
698 clk_disable_unprepare(qspi->clk);
702 static const struct of_device_id stm32_qspi_match[] = {
703 {.compatible = "st,stm32f469-qspi"},
706 MODULE_DEVICE_TABLE(of, stm32_qspi_match);
708 static struct platform_driver stm32_qspi_driver = {
709 .probe = stm32_qspi_probe,
710 .remove = stm32_qspi_remove,
712 .name = "stm32-quadspi",
713 .of_match_table = stm32_qspi_match,
716 module_platform_driver(stm32_qspi_driver);
718 MODULE_AUTHOR("Ludovic Barre <ludovic.barre@st.com>");
719 MODULE_DESCRIPTION("STMicroelectronics STM32 quad spi driver");
720 MODULE_LICENSE("GPL v2");