1 // SPDX-License-Identifier: GPL-2.0+
5 * Michael Kurz, <michi.kurz@gmail.com>
17 #include <spi_flash.h>
19 #include <asm/arch/stm32.h>
20 #include <linux/ioport.h>
22 struct stm32_qspi_regs {
39 * QUADSPI control register
41 #define STM32_QSPI_CR_EN BIT(0)
42 #define STM32_QSPI_CR_ABORT BIT(1)
43 #define STM32_QSPI_CR_DMAEN BIT(2)
44 #define STM32_QSPI_CR_TCEN BIT(3)
45 #define STM32_QSPI_CR_SSHIFT BIT(4)
46 #define STM32_QSPI_CR_DFM BIT(6)
47 #define STM32_QSPI_CR_FSEL BIT(7)
48 #define STM32_QSPI_CR_FTHRES_MASK GENMASK(4, 0)
49 #define STM32_QSPI_CR_FTHRES_SHIFT (8)
50 #define STM32_QSPI_CR_TEIE BIT(16)
51 #define STM32_QSPI_CR_TCIE BIT(17)
52 #define STM32_QSPI_CR_FTIE BIT(18)
53 #define STM32_QSPI_CR_SMIE BIT(19)
54 #define STM32_QSPI_CR_TOIE BIT(20)
55 #define STM32_QSPI_CR_APMS BIT(22)
56 #define STM32_QSPI_CR_PMM BIT(23)
57 #define STM32_QSPI_CR_PRESCALER_MASK GENMASK(7, 0)
58 #define STM32_QSPI_CR_PRESCALER_SHIFT (24)
61 * QUADSPI device configuration register
63 #define STM32_QSPI_DCR_CKMODE BIT(0)
64 #define STM32_QSPI_DCR_CSHT_MASK GENMASK(2, 0)
65 #define STM32_QSPI_DCR_CSHT_SHIFT (8)
66 #define STM32_QSPI_DCR_FSIZE_MASK GENMASK(4, 0)
67 #define STM32_QSPI_DCR_FSIZE_SHIFT (16)
70 * QUADSPI status register
72 #define STM32_QSPI_SR_TEF BIT(0)
73 #define STM32_QSPI_SR_TCF BIT(1)
74 #define STM32_QSPI_SR_FTF BIT(2)
75 #define STM32_QSPI_SR_SMF BIT(3)
76 #define STM32_QSPI_SR_TOF BIT(4)
77 #define STM32_QSPI_SR_BUSY BIT(5)
78 #define STM32_QSPI_SR_FLEVEL_MASK GENMASK(5, 0)
79 #define STM32_QSPI_SR_FLEVEL_SHIFT (8)
82 * QUADSPI flag clear register
84 #define STM32_QSPI_FCR_CTEF BIT(0)
85 #define STM32_QSPI_FCR_CTCF BIT(1)
86 #define STM32_QSPI_FCR_CSMF BIT(3)
87 #define STM32_QSPI_FCR_CTOF BIT(4)
90 * QUADSPI communication configuration register
92 #define STM32_QSPI_CCR_DDRM BIT(31)
93 #define STM32_QSPI_CCR_DHHC BIT(30)
94 #define STM32_QSPI_CCR_SIOO BIT(28)
95 #define STM32_QSPI_CCR_FMODE_SHIFT (26)
96 #define STM32_QSPI_CCR_DMODE_SHIFT (24)
97 #define STM32_QSPI_CCR_DCYC_SHIFT (18)
98 #define STM32_QSPI_CCR_DCYC_MASK GENMASK(4, 0)
99 #define STM32_QSPI_CCR_ABSIZE_SHIFT (16)
100 #define STM32_QSPI_CCR_ABMODE_SHIFT (14)
101 #define STM32_QSPI_CCR_ADSIZE_SHIFT (12)
102 #define STM32_QSPI_CCR_ADMODE_SHIFT (10)
103 #define STM32_QSPI_CCR_IMODE_SHIFT (8)
104 #define STM32_QSPI_CCR_INSTRUCTION_MASK GENMASK(7, 0)
106 enum STM32_QSPI_CCR_IMODE {
107 STM32_QSPI_CCR_IMODE_NONE = 0,
108 STM32_QSPI_CCR_IMODE_ONE_LINE = 1,
109 STM32_QSPI_CCR_IMODE_TWO_LINE = 2,
110 STM32_QSPI_CCR_IMODE_FOUR_LINE = 3,
113 enum STM32_QSPI_CCR_ADMODE {
114 STM32_QSPI_CCR_ADMODE_NONE = 0,
115 STM32_QSPI_CCR_ADMODE_ONE_LINE = 1,
116 STM32_QSPI_CCR_ADMODE_TWO_LINE = 2,
117 STM32_QSPI_CCR_ADMODE_FOUR_LINE = 3,
120 enum STM32_QSPI_CCR_ADSIZE {
121 STM32_QSPI_CCR_ADSIZE_8BIT = 0,
122 STM32_QSPI_CCR_ADSIZE_16BIT = 1,
123 STM32_QSPI_CCR_ADSIZE_24BIT = 2,
124 STM32_QSPI_CCR_ADSIZE_32BIT = 3,
127 enum STM32_QSPI_CCR_ABMODE {
128 STM32_QSPI_CCR_ABMODE_NONE = 0,
129 STM32_QSPI_CCR_ABMODE_ONE_LINE = 1,
130 STM32_QSPI_CCR_ABMODE_TWO_LINE = 2,
131 STM32_QSPI_CCR_ABMODE_FOUR_LINE = 3,
134 enum STM32_QSPI_CCR_ABSIZE {
135 STM32_QSPI_CCR_ABSIZE_8BIT = 0,
136 STM32_QSPI_CCR_ABSIZE_16BIT = 1,
137 STM32_QSPI_CCR_ABSIZE_24BIT = 2,
138 STM32_QSPI_CCR_ABSIZE_32BIT = 3,
141 enum STM32_QSPI_CCR_DMODE {
142 STM32_QSPI_CCR_DMODE_NONE = 0,
143 STM32_QSPI_CCR_DMODE_ONE_LINE = 1,
144 STM32_QSPI_CCR_DMODE_TWO_LINE = 2,
145 STM32_QSPI_CCR_DMODE_FOUR_LINE = 3,
148 enum STM32_QSPI_CCR_FMODE {
149 STM32_QSPI_CCR_IND_WRITE = 0,
150 STM32_QSPI_CCR_IND_READ = 1,
151 STM32_QSPI_CCR_AUTO_POLL = 2,
152 STM32_QSPI_CCR_MEM_MAP = 3,
155 /* default SCK frequency, unit: HZ */
156 #define STM32_QSPI_DEFAULT_SCK_FREQ 108000000
158 #define STM32_MAX_NORCHIP 2
160 struct stm32_qspi_platdata {
166 struct stm32_qspi_priv {
167 struct stm32_qspi_regs *regs;
175 #define CMD_HAS_ADR BIT(24)
176 #define CMD_HAS_DUMMY BIT(25)
177 #define CMD_HAS_DATA BIT(26)
180 static void _stm32_qspi_disable(struct stm32_qspi_priv *priv)
182 clrbits_le32(&priv->regs->cr, STM32_QSPI_CR_EN);
185 static void _stm32_qspi_enable(struct stm32_qspi_priv *priv)
187 setbits_le32(&priv->regs->cr, STM32_QSPI_CR_EN);
190 static void _stm32_qspi_wait_for_not_busy(struct stm32_qspi_priv *priv)
192 while (readl(&priv->regs->sr) & STM32_QSPI_SR_BUSY)
196 static void _stm32_qspi_wait_for_complete(struct stm32_qspi_priv *priv)
198 while (!(readl(&priv->regs->sr) & STM32_QSPI_SR_TCF))
202 static void _stm32_qspi_wait_for_ftf(struct stm32_qspi_priv *priv)
204 while (!(readl(&priv->regs->sr) & STM32_QSPI_SR_FTF))
208 static void _stm32_qspi_set_flash_size(struct stm32_qspi_priv *priv, u32 size)
210 u32 fsize = fls(size) - 1;
212 clrsetbits_le32(&priv->regs->dcr,
213 STM32_QSPI_DCR_FSIZE_MASK << STM32_QSPI_DCR_FSIZE_SHIFT,
214 fsize << STM32_QSPI_DCR_FSIZE_SHIFT);
217 static void _stm32_qspi_set_cs(struct stm32_qspi_priv *priv, unsigned int cs)
219 clrsetbits_le32(&priv->regs->cr, STM32_QSPI_CR_FSEL,
220 cs ? STM32_QSPI_CR_FSEL : 0);
223 static unsigned int _stm32_qspi_gen_ccr(struct stm32_qspi_priv *priv, u8 fmode)
225 unsigned int ccr_reg = 0;
226 u8 imode, admode, dmode;
227 u32 mode = priv->mode;
228 u32 cmd = (priv->command & STM32_QSPI_CCR_INSTRUCTION_MASK);
230 imode = STM32_QSPI_CCR_IMODE_ONE_LINE;
231 admode = STM32_QSPI_CCR_ADMODE_ONE_LINE;
232 dmode = STM32_QSPI_CCR_DMODE_ONE_LINE;
234 if ((priv->command & CMD_HAS_ADR) && (priv->command & CMD_HAS_DATA)) {
235 if (fmode == STM32_QSPI_CCR_IND_WRITE) {
236 if (mode & SPI_TX_QUAD)
237 dmode = STM32_QSPI_CCR_DMODE_FOUR_LINE;
238 else if (mode & SPI_TX_DUAL)
239 dmode = STM32_QSPI_CCR_DMODE_TWO_LINE;
240 } else if ((fmode == STM32_QSPI_CCR_MEM_MAP) ||
241 (fmode == STM32_QSPI_CCR_IND_READ)) {
242 if (mode & SPI_RX_QUAD)
243 dmode = STM32_QSPI_CCR_DMODE_FOUR_LINE;
244 else if (mode & SPI_RX_DUAL)
245 dmode = STM32_QSPI_CCR_DMODE_TWO_LINE;
249 if (priv->command & CMD_HAS_DATA)
250 ccr_reg |= (dmode << STM32_QSPI_CCR_DMODE_SHIFT);
252 if (priv->command & CMD_HAS_DUMMY)
253 ccr_reg |= ((priv->dummycycles & STM32_QSPI_CCR_DCYC_MASK)
254 << STM32_QSPI_CCR_DCYC_SHIFT);
256 if (priv->command & CMD_HAS_ADR) {
257 ccr_reg |= (STM32_QSPI_CCR_ADSIZE_24BIT
258 << STM32_QSPI_CCR_ADSIZE_SHIFT);
259 ccr_reg |= (admode << STM32_QSPI_CCR_ADMODE_SHIFT);
262 ccr_reg |= (fmode << STM32_QSPI_CCR_FMODE_SHIFT);
263 ccr_reg |= (imode << STM32_QSPI_CCR_IMODE_SHIFT);
269 static void _stm32_qspi_enable_mmap(struct stm32_qspi_priv *priv,
270 struct spi_flash *flash)
272 unsigned int ccr_reg;
274 priv->command = flash->read_cmd | CMD_HAS_ADR | CMD_HAS_DATA
276 priv->dummycycles = flash->dummy_byte * 8;
278 ccr_reg = _stm32_qspi_gen_ccr(priv, STM32_QSPI_CCR_MEM_MAP);
280 _stm32_qspi_wait_for_not_busy(priv);
282 writel(ccr_reg, &priv->regs->ccr);
284 priv->dummycycles = 0;
287 static void _stm32_qspi_disable_mmap(struct stm32_qspi_priv *priv)
289 setbits_le32(&priv->regs->cr, STM32_QSPI_CR_ABORT);
292 static void _stm32_qspi_set_xfer_length(struct stm32_qspi_priv *priv,
295 writel(length - 1, &priv->regs->dlr);
298 static void _stm32_qspi_start_xfer(struct stm32_qspi_priv *priv, u32 cr_reg)
300 writel(cr_reg, &priv->regs->ccr);
302 if (priv->command & CMD_HAS_ADR)
303 writel(priv->address, &priv->regs->ar);
306 static int _stm32_qspi_xfer(struct stm32_qspi_priv *priv,
307 struct spi_flash *flash, unsigned int bitlen,
308 const u8 *dout, u8 *din, unsigned long flags)
310 unsigned int words = bitlen / 8;
314 if (flags & SPI_XFER_MMAP) {
315 _stm32_qspi_enable_mmap(priv, flash);
317 } else if (flags & SPI_XFER_MMAP_END) {
318 _stm32_qspi_disable_mmap(priv);
326 debug("spi_xfer: Non byte aligned SPI transfer\n");
331 debug("spi_xfer: QSPI cannot have data in and data out set\n");
335 if (!dout && (flags & SPI_XFER_BEGIN)) {
336 debug("spi_xfer: QSPI transfer must begin with command\n");
341 if (flags & SPI_XFER_BEGIN) {
342 /* data is command */
343 priv->command = dout[0] | CMD_HAS_DATA;
345 /* address is here too */
346 priv->address = (dout[1] << 16) |
347 (dout[2] << 8) | dout[3];
348 priv->command |= CMD_HAS_ADR;
352 /* rest is dummy bytes */
353 priv->dummycycles = (words - 4) * 8;
354 priv->command |= CMD_HAS_DUMMY;
357 if (flags & SPI_XFER_END) {
358 /* command without data */
359 priv->command &= ~(CMD_HAS_DATA);
363 if (flags & SPI_XFER_END) {
364 ccr_reg = _stm32_qspi_gen_ccr(priv,
365 STM32_QSPI_CCR_IND_WRITE);
367 _stm32_qspi_wait_for_not_busy(priv);
369 if (priv->command & CMD_HAS_DATA)
370 _stm32_qspi_set_xfer_length(priv, words);
372 _stm32_qspi_start_xfer(priv, ccr_reg);
374 debug("%s: write: ccr:0x%08x adr:0x%08x\n",
375 __func__, priv->regs->ccr, priv->regs->ar);
377 if (priv->command & CMD_HAS_DATA) {
378 _stm32_qspi_wait_for_ftf(priv);
380 debug("%s: words:%d data:", __func__, words);
384 writeb(dout[i], &priv->regs->dr);
385 debug("%02x ", dout[i]);
390 _stm32_qspi_wait_for_complete(priv);
392 _stm32_qspi_wait_for_not_busy(priv);
396 ccr_reg = _stm32_qspi_gen_ccr(priv, STM32_QSPI_CCR_IND_READ);
398 _stm32_qspi_wait_for_not_busy(priv);
400 _stm32_qspi_set_xfer_length(priv, words);
402 _stm32_qspi_start_xfer(priv, ccr_reg);
404 debug("%s: read: ccr:0x%08x adr:0x%08x len:%d\n", __func__,
405 priv->regs->ccr, priv->regs->ar, priv->regs->dlr);
407 debug("%s: data:", __func__);
411 din[i] = readb(&priv->regs->dr);
412 debug("%02x ", din[i]);
421 static int stm32_qspi_ofdata_to_platdata(struct udevice *bus)
423 struct resource res_regs, res_mem;
424 struct stm32_qspi_platdata *plat = bus->platdata;
427 ret = dev_read_resource_byname(bus, "qspi", &res_regs);
429 debug("Error: can't get regs base addresses(ret = %d)!\n", ret);
432 ret = dev_read_resource_byname(bus, "qspi_mm", &res_mem);
434 debug("Error: can't get mmap base address(ret = %d)!\n", ret);
438 plat->max_hz = dev_read_u32_default(bus, "spi-max-frequency",
439 STM32_QSPI_DEFAULT_SCK_FREQ);
441 plat->base = res_regs.start;
442 plat->memory_map = res_mem.start;
444 debug("%s: regs=<0x%x> mapped=<0x%x>, max-frequency=%d\n",
454 static int stm32_qspi_probe(struct udevice *bus)
456 struct stm32_qspi_platdata *plat = dev_get_platdata(bus);
457 struct stm32_qspi_priv *priv = dev_get_priv(bus);
458 struct dm_spi_bus *dm_spi_bus;
460 struct reset_ctl reset_ctl;
463 dm_spi_bus = bus->uclass_priv;
465 dm_spi_bus->max_hz = plat->max_hz;
467 priv->regs = (struct stm32_qspi_regs *)(uintptr_t)plat->base;
469 priv->max_hz = plat->max_hz;
471 ret = clk_get_by_index(bus, 0, &clk);
475 ret = clk_enable(&clk);
478 dev_err(bus, "failed to enable clock\n");
482 priv->clock_rate = clk_get_rate(&clk);
483 if (priv->clock_rate < 0) {
485 return priv->clock_rate;
488 ret = reset_get_by_index(bus, 0, &reset_ctl);
490 if (ret != -ENOENT) {
491 dev_err(bus, "failed to get reset\n");
496 /* Reset QSPI controller */
497 reset_assert(&reset_ctl);
499 reset_deassert(&reset_ctl);
502 setbits_le32(&priv->regs->cr, STM32_QSPI_CR_SSHIFT);
507 static int stm32_qspi_remove(struct udevice *bus)
512 static int stm32_qspi_claim_bus(struct udevice *dev)
514 struct stm32_qspi_priv *priv;
516 struct spi_flash *flash;
517 struct dm_spi_slave_platdata *slave_plat;
520 priv = dev_get_priv(bus);
521 flash = dev_get_uclass_priv(dev);
522 slave_plat = dev_get_parent_platdata(dev);
524 if (slave_plat->cs >= STM32_MAX_NORCHIP)
527 _stm32_qspi_set_cs(priv, slave_plat->cs);
529 _stm32_qspi_set_flash_size(priv, flash->size);
531 _stm32_qspi_enable(priv);
536 static int stm32_qspi_release_bus(struct udevice *dev)
538 struct stm32_qspi_priv *priv;
542 priv = dev_get_priv(bus);
544 _stm32_qspi_disable(priv);
549 static int stm32_qspi_xfer(struct udevice *dev, unsigned int bitlen,
550 const void *dout, void *din, unsigned long flags)
552 struct stm32_qspi_priv *priv;
554 struct spi_flash *flash;
557 priv = dev_get_priv(bus);
558 flash = dev_get_uclass_priv(dev);
560 return _stm32_qspi_xfer(priv, flash, bitlen, (const u8 *)dout,
564 static int stm32_qspi_set_speed(struct udevice *bus, uint speed)
566 struct stm32_qspi_platdata *plat = bus->platdata;
567 struct stm32_qspi_priv *priv = dev_get_priv(bus);
568 u32 qspi_clk = priv->clock_rate;
572 if (speed > plat->max_hz)
573 speed = plat->max_hz;
576 prescaler = DIV_ROUND_UP(qspi_clk, speed) - 1;
579 else if (prescaler < 0)
583 csht = DIV_ROUND_UP((5 * qspi_clk) / (prescaler + 1), 100000000);
584 csht = (csht - 1) & STM32_QSPI_DCR_CSHT_MASK;
586 _stm32_qspi_wait_for_not_busy(priv);
588 clrsetbits_le32(&priv->regs->cr,
589 STM32_QSPI_CR_PRESCALER_MASK <<
590 STM32_QSPI_CR_PRESCALER_SHIFT,
591 prescaler << STM32_QSPI_CR_PRESCALER_SHIFT);
593 clrsetbits_le32(&priv->regs->dcr,
594 STM32_QSPI_DCR_CSHT_MASK << STM32_QSPI_DCR_CSHT_SHIFT,
595 csht << STM32_QSPI_DCR_CSHT_SHIFT);
597 debug("%s: regs=%p, speed=%d\n", __func__, priv->regs,
598 (qspi_clk / (prescaler + 1)));
603 static int stm32_qspi_set_mode(struct udevice *bus, uint mode)
605 struct stm32_qspi_priv *priv = dev_get_priv(bus);
607 _stm32_qspi_wait_for_not_busy(priv);
609 if ((mode & SPI_CPHA) && (mode & SPI_CPOL))
610 setbits_le32(&priv->regs->dcr, STM32_QSPI_DCR_CKMODE);
611 else if (!(mode & SPI_CPHA) && !(mode & SPI_CPOL))
612 clrbits_le32(&priv->regs->dcr, STM32_QSPI_DCR_CKMODE);
616 if (mode & SPI_CS_HIGH)
619 if (mode & SPI_RX_QUAD)
620 priv->mode |= SPI_RX_QUAD;
621 else if (mode & SPI_RX_DUAL)
622 priv->mode |= SPI_RX_DUAL;
624 priv->mode &= ~(SPI_RX_QUAD | SPI_RX_DUAL);
626 if (mode & SPI_TX_QUAD)
627 priv->mode |= SPI_TX_QUAD;
628 else if (mode & SPI_TX_DUAL)
629 priv->mode |= SPI_TX_DUAL;
631 priv->mode &= ~(SPI_TX_QUAD | SPI_TX_DUAL);
633 debug("%s: regs=%p, mode=%d rx: ", __func__, priv->regs, mode);
635 if (mode & SPI_RX_QUAD)
637 else if (mode & SPI_RX_DUAL)
640 debug("single, tx: ");
642 if (mode & SPI_TX_QUAD)
644 else if (mode & SPI_TX_DUAL)
652 static const struct dm_spi_ops stm32_qspi_ops = {
653 .claim_bus = stm32_qspi_claim_bus,
654 .release_bus = stm32_qspi_release_bus,
655 .xfer = stm32_qspi_xfer,
656 .set_speed = stm32_qspi_set_speed,
657 .set_mode = stm32_qspi_set_mode,
660 static const struct udevice_id stm32_qspi_ids[] = {
661 { .compatible = "st,stm32-qspi" },
662 { .compatible = "st,stm32f469-qspi" },
666 U_BOOT_DRIVER(stm32_qspi) = {
667 .name = "stm32_qspi",
669 .of_match = stm32_qspi_ids,
670 .ops = &stm32_qspi_ops,
671 .ofdata_to_platdata = stm32_qspi_ofdata_to_platdata,
672 .platdata_auto_alloc_size = sizeof(struct stm32_qspi_platdata),
673 .priv_auto_alloc_size = sizeof(struct stm32_qspi_priv),
674 .probe = stm32_qspi_probe,
675 .remove = stm32_qspi_remove,