1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2013-2015 Freescale Semiconductor, Inc.
5 * Freescale Quad Serial Peripheral Interface (QSPI) driver
12 #include <linux/sizes.h>
13 #include <linux/iopoll.h>
20 DECLARE_GLOBAL_DATA_PTR;
22 #define RX_BUFFER_SIZE 0x80
23 #if defined(CONFIG_MX6SX) || defined(CONFIG_MX6UL) || \
24 defined(CONFIG_MX6ULL) || defined(CONFIG_MX7D)
25 #define TX_BUFFER_SIZE 0x200
27 #define TX_BUFFER_SIZE 0x40
30 #define OFFSET_BITS_MASK GENMASK(23, 0)
32 #define FLASH_STATUS_WEL 0x02
36 #define SEQID_FAST_READ 2
39 #define SEQID_CHIP_ERASE 5
43 #ifdef CONFIG_SPI_FLASH_BAR
46 #define SEQID_RDEAR 11
47 #define SEQID_WREAR 12
53 #define QSPI_CMD_PP 0x02 /* Page program (up to 256 bytes) */
54 #define QSPI_CMD_RDSR 0x05 /* Read status register */
55 #define QSPI_CMD_WREN 0x06 /* Write enable */
56 #define QSPI_CMD_FAST_READ 0x0b /* Read data bytes (high frequency) */
57 #define QSPI_CMD_BE_4K 0x20 /* 4K erase */
58 #define QSPI_CMD_CHIP_ERASE 0xc7 /* Erase whole flash chip */
59 #define QSPI_CMD_SE 0xd8 /* Sector erase (usually 64KiB) */
60 #define QSPI_CMD_RDID 0x9f /* Read JEDEC ID */
62 /* Used for Micron, winbond and Macronix flashes */
63 #define QSPI_CMD_WREAR 0xc5 /* EAR register write */
64 #define QSPI_CMD_RDEAR 0xc8 /* EAR reigster read */
66 /* Used for Spansion flashes only. */
67 #define QSPI_CMD_BRRD 0x16 /* Bank register read */
68 #define QSPI_CMD_BRWR 0x17 /* Bank register write */
70 /* Used for Spansion S25FS-S family flash only. */
71 #define QSPI_CMD_RDAR 0x65 /* Read any device register */
72 #define QSPI_CMD_WRAR 0x71 /* Write any device register */
74 /* 4-byte address QSPI CMD - used on Spansion and some Macronix flashes */
75 #define QSPI_CMD_FAST_READ_4B 0x0c /* Read data bytes (high frequency) */
76 #define QSPI_CMD_PP_4B 0x12 /* Page program (up to 256 bytes) */
77 #define QSPI_CMD_SE_4B 0xdc /* Sector erase (usually 64KiB) */
79 /* fsl_qspi_platdata flags */
80 #define QSPI_FLAG_REGMAP_ENDIAN_BIG BIT(0)
82 /* default SCK frequency, unit: HZ */
83 #define FSL_QSPI_DEFAULT_SCK_FREQ 50000000
85 /* QSPI max chipselect signals number */
86 #define FSL_QSPI_MAX_CHIPSELECT_NUM 4
89 * struct fsl_qspi_platdata - platform data for Freescale QSPI
91 * @flags: Flags for QSPI QSPI_FLAG_...
92 * @speed_hz: Default SCK frequency
93 * @reg_base: Base address of QSPI registers
94 * @amba_base: Base address of QSPI memory mapping
95 * @amba_total_size: size of QSPI memory mapping
96 * @flash_num: Number of active slave devices
97 * @num_chipselect: Number of QSPI chipselect signals
99 struct fsl_qspi_platdata {
103 fdt_addr_t amba_base;
104 fdt_size_t amba_total_size;
110 * struct fsl_qspi_priv - private data for Freescale QSPI
112 * @flags: Flags for QSPI QSPI_FLAG_...
113 * @bus_clk: QSPI input clk frequency
114 * @speed_hz: Default SCK frequency
115 * @cur_seqid: current LUT table sequence id
116 * @sf_addr: flash access offset
117 * @amba_base: Base address of QSPI memory mapping of every CS
118 * @amba_total_size: size of QSPI memory mapping
119 * @cur_amba_base: Base address of QSPI memory mapping of current CS
120 * @flash_num: Number of active slave devices
121 * @num_chipselect: Number of QSPI chipselect signals
122 * @regs: Point to QSPI register structure for I/O access
124 struct fsl_qspi_priv {
130 u32 amba_base[FSL_QSPI_MAX_CHIPSELECT_NUM];
135 struct fsl_qspi_regs *regs;
139 static u32 qspi_read32(u32 flags, u32 *addr)
141 return flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ?
142 in_be32(addr) : in_le32(addr);
145 static void qspi_write32(u32 flags, u32 *addr, u32 val)
147 flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ?
148 out_be32(addr, val) : out_le32(addr, val);
151 static inline int is_controller_busy(const struct fsl_qspi_priv *priv)
154 u32 mask = QSPI_SR_BUSY_MASK | QSPI_SR_AHB_ACC_MASK |
157 if (priv->flags & QSPI_FLAG_REGMAP_ENDIAN_BIG)
158 mask = (u32)cpu_to_be32(mask);
160 return readl_poll_timeout(&priv->regs->sr, val, !(val & mask), 1000);
163 /* QSPI support swapping the flash read/write data
164 * in hardware for LS102xA, but not for VF610 */
165 static inline u32 qspi_endian_xchg(u32 data)
174 static void qspi_set_lut(struct fsl_qspi_priv *priv)
176 struct fsl_qspi_regs *regs = priv->regs;
180 qspi_write32(priv->flags, ®s->lutkey, LUT_KEY_VALUE);
181 qspi_write32(priv->flags, ®s->lckcr, QSPI_LCKCR_UNLOCK);
184 lut_base = SEQID_WREN * 4;
185 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_WREN) |
186 PAD0(LUT_PAD1) | INSTR0(LUT_CMD));
187 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
188 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
189 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
192 lut_base = SEQID_FAST_READ * 4;
193 #ifdef CONFIG_SPI_FLASH_BAR
194 qspi_write32(priv->flags, ®s->lut[lut_base],
195 OPRND0(QSPI_CMD_FAST_READ) | PAD0(LUT_PAD1) |
196 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
197 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
199 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
200 qspi_write32(priv->flags, ®s->lut[lut_base],
201 OPRND0(QSPI_CMD_FAST_READ) | PAD0(LUT_PAD1) |
202 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
203 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
205 qspi_write32(priv->flags, ®s->lut[lut_base],
206 OPRND0(QSPI_CMD_FAST_READ_4B) |
207 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) |
208 OPRND1(ADDR32BIT) | PAD1(LUT_PAD1) |
211 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
212 OPRND0(8) | PAD0(LUT_PAD1) | INSTR0(LUT_DUMMY) |
213 OPRND1(RX_BUFFER_SIZE) | PAD1(LUT_PAD1) |
215 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
216 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
219 lut_base = SEQID_RDSR * 4;
220 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDSR) |
221 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
222 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
223 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
224 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
225 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
228 lut_base = SEQID_SE * 4;
229 #ifdef CONFIG_SPI_FLASH_BAR
230 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_SE) |
231 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
232 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
234 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
235 qspi_write32(priv->flags, ®s->lut[lut_base],
236 OPRND0(QSPI_CMD_SE) | PAD0(LUT_PAD1) |
237 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
238 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
240 qspi_write32(priv->flags, ®s->lut[lut_base],
241 OPRND0(QSPI_CMD_SE_4B) | PAD0(LUT_PAD1) |
242 INSTR0(LUT_CMD) | OPRND1(ADDR32BIT) |
243 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
245 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
246 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
247 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
249 /* Erase the whole chip */
250 lut_base = SEQID_CHIP_ERASE * 4;
251 qspi_write32(priv->flags, ®s->lut[lut_base],
252 OPRND0(QSPI_CMD_CHIP_ERASE) |
253 PAD0(LUT_PAD1) | INSTR0(LUT_CMD));
254 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
255 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
256 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
259 lut_base = SEQID_PP * 4;
260 #ifdef CONFIG_SPI_FLASH_BAR
261 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_PP) |
262 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
263 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
265 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
266 qspi_write32(priv->flags, ®s->lut[lut_base],
267 OPRND0(QSPI_CMD_PP) | PAD0(LUT_PAD1) |
268 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
269 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
271 qspi_write32(priv->flags, ®s->lut[lut_base],
272 OPRND0(QSPI_CMD_PP_4B) | PAD0(LUT_PAD1) |
273 INSTR0(LUT_CMD) | OPRND1(ADDR32BIT) |
274 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
276 #if defined(CONFIG_MX6SX) || defined(CONFIG_MX6UL) || \
277 defined(CONFIG_MX6ULL) || defined(CONFIG_MX7D)
279 * To MX6SX, OPRND0(TX_BUFFER_SIZE) can not work correctly.
280 * So, Use IDATSZ in IPCR to determine the size and here set 0.
282 qspi_write32(priv->flags, ®s->lut[lut_base + 1], OPRND0(0) |
283 PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
285 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
286 OPRND0(TX_BUFFER_SIZE) |
287 PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
289 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
290 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
293 lut_base = SEQID_RDID * 4;
294 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDID) |
295 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(8) |
296 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
297 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
298 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
299 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
301 /* SUB SECTOR 4K ERASE */
302 lut_base = SEQID_BE_4K * 4;
303 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BE_4K) |
304 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
305 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
307 #ifdef CONFIG_SPI_FLASH_BAR
309 * BRRD BRWR RDEAR WREAR are all supported, because it is hard to
310 * dynamically check whether to set BRRD BRWR or RDEAR WREAR during
313 lut_base = SEQID_BRRD * 4;
314 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BRRD) |
315 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
316 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
318 lut_base = SEQID_BRWR * 4;
319 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BRWR) |
320 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
321 PAD1(LUT_PAD1) | INSTR1(LUT_WRITE));
323 lut_base = SEQID_RDEAR * 4;
324 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDEAR) |
325 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
326 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
328 lut_base = SEQID_WREAR * 4;
329 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_WREAR) |
330 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
331 PAD1(LUT_PAD1) | INSTR1(LUT_WRITE));
335 * Read any device register.
336 * Used for Spansion S25FS-S family flash only.
338 lut_base = SEQID_RDAR * 4;
339 qspi_write32(priv->flags, ®s->lut[lut_base],
340 OPRND0(QSPI_CMD_RDAR) | PAD0(LUT_PAD1) |
341 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
342 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
343 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
344 OPRND0(8) | PAD0(LUT_PAD1) | INSTR0(LUT_DUMMY) |
345 OPRND1(1) | PAD1(LUT_PAD1) |
349 * Write any device register.
350 * Used for Spansion S25FS-S family flash only.
352 lut_base = SEQID_WRAR * 4;
353 qspi_write32(priv->flags, ®s->lut[lut_base],
354 OPRND0(QSPI_CMD_WRAR) | PAD0(LUT_PAD1) |
355 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
356 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
357 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
358 OPRND0(1) | PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
361 qspi_write32(priv->flags, ®s->lutkey, LUT_KEY_VALUE);
362 qspi_write32(priv->flags, ®s->lckcr, QSPI_LCKCR_LOCK);
365 #if defined(CONFIG_SYS_FSL_QSPI_AHB)
367 * If we have changed the content of the flash by writing or erasing,
368 * we need to invalidate the AHB buffer. If we do not do so, we may read out
369 * the wrong data. The spec tells us reset the AHB domain and Serial Flash
370 * domain at the same time.
372 static inline void qspi_ahb_invalid(struct fsl_qspi_priv *priv)
374 struct fsl_qspi_regs *regs = priv->regs;
377 reg = qspi_read32(priv->flags, ®s->mcr);
378 reg |= QSPI_MCR_SWRSTHD_MASK | QSPI_MCR_SWRSTSD_MASK;
379 qspi_write32(priv->flags, ®s->mcr, reg);
382 * The minimum delay : 1 AHB + 2 SFCK clocks.
383 * Delay 1 us is enough.
387 reg &= ~(QSPI_MCR_SWRSTHD_MASK | QSPI_MCR_SWRSTSD_MASK);
388 qspi_write32(priv->flags, ®s->mcr, reg);
391 /* Read out the data from the AHB buffer. */
392 static inline void qspi_ahb_read(struct fsl_qspi_priv *priv, u8 *rxbuf, int len)
394 struct fsl_qspi_regs *regs = priv->regs;
398 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
400 qspi_write32(priv->flags, ®s->mcr,
401 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
402 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
404 rx_addr = (void *)(uintptr_t)(priv->cur_amba_base + priv->sf_addr);
405 /* Read out the data directly from the AHB buffer. */
406 memcpy(rxbuf, rx_addr, len);
408 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
411 static void qspi_enable_ddr_mode(struct fsl_qspi_priv *priv)
414 struct fsl_qspi_regs *regs = priv->regs;
416 reg = qspi_read32(priv->flags, ®s->mcr);
417 /* Disable the module */
418 qspi_write32(priv->flags, ®s->mcr, reg | QSPI_MCR_MDIS_MASK);
420 /* Set the Sampling Register for DDR */
421 reg2 = qspi_read32(priv->flags, ®s->smpr);
422 reg2 &= ~QSPI_SMPR_DDRSMP_MASK;
423 reg2 |= (2 << QSPI_SMPR_DDRSMP_SHIFT);
424 qspi_write32(priv->flags, ®s->smpr, reg2);
426 /* Enable the module again (enable the DDR too) */
427 reg |= QSPI_MCR_DDR_EN_MASK;
428 /* Enable bit 29 for imx6sx */
431 qspi_write32(priv->flags, ®s->mcr, reg);
435 * There are two different ways to read out the data from the flash:
436 * the "IP Command Read" and the "AHB Command Read".
438 * The IC guy suggests we use the "AHB Command Read" which is faster
439 * then the "IP Command Read". (What's more is that there is a bug in
440 * the "IP Command Read" in the Vybrid.)
442 * After we set up the registers for the "AHB Command Read", we can use
443 * the memcpy to read the data directly. A "missed" access to the buffer
444 * causes the controller to clear the buffer, and use the sequence pointed
445 * by the QUADSPI_BFGENCR[SEQID] to initiate a read from the flash.
447 static void qspi_init_ahb_read(struct fsl_qspi_priv *priv)
449 struct fsl_qspi_regs *regs = priv->regs;
451 /* AHB configuration for access buffer 0/1/2 .*/
452 qspi_write32(priv->flags, ®s->buf0cr, QSPI_BUFXCR_INVALID_MSTRID);
453 qspi_write32(priv->flags, ®s->buf1cr, QSPI_BUFXCR_INVALID_MSTRID);
454 qspi_write32(priv->flags, ®s->buf2cr, QSPI_BUFXCR_INVALID_MSTRID);
455 qspi_write32(priv->flags, ®s->buf3cr, QSPI_BUF3CR_ALLMST_MASK |
456 (0x80 << QSPI_BUF3CR_ADATSZ_SHIFT));
458 /* We only use the buffer3 */
459 qspi_write32(priv->flags, ®s->buf0ind, 0);
460 qspi_write32(priv->flags, ®s->buf1ind, 0);
461 qspi_write32(priv->flags, ®s->buf2ind, 0);
464 * Set the default lut sequence for AHB Read.
465 * Parallel mode is disabled.
467 qspi_write32(priv->flags, ®s->bfgencr,
468 SEQID_FAST_READ << QSPI_BFGENCR_SEQID_SHIFT);
471 qspi_enable_ddr_mode(priv);
475 #ifdef CONFIG_SPI_FLASH_BAR
476 /* Bank register read/write, EAR register read/write */
477 static void qspi_op_rdbank(struct fsl_qspi_priv *priv, u8 *rxbuf, u32 len)
479 struct fsl_qspi_regs *regs = priv->regs;
480 u32 reg, mcr_reg, data, seqid;
482 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
483 qspi_write32(priv->flags, ®s->mcr,
484 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
485 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
486 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
488 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
490 if (priv->cur_seqid == QSPI_CMD_BRRD)
495 qspi_write32(priv->flags, ®s->ipcr,
496 (seqid << QSPI_IPCR_SEQID_SHIFT) | len);
498 /* Wait previous command complete */
499 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
505 reg = qspi_read32(priv->flags, ®s->rbsr);
506 if (reg & QSPI_RBSR_RDBFL_MASK) {
507 data = qspi_read32(priv->flags, ®s->rbdr[0]);
508 data = qspi_endian_xchg(data);
509 memcpy(rxbuf, &data, len);
510 qspi_write32(priv->flags, ®s->mcr,
511 qspi_read32(priv->flags, ®s->mcr) |
512 QSPI_MCR_CLR_RXF_MASK);
517 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
521 static void qspi_op_rdid(struct fsl_qspi_priv *priv, u32 *rxbuf, u32 len)
523 struct fsl_qspi_regs *regs = priv->regs;
524 u32 mcr_reg, rbsr_reg, data, size;
527 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
528 qspi_write32(priv->flags, ®s->mcr,
529 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
530 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
531 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
533 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
535 qspi_write32(priv->flags, ®s->ipcr,
536 (SEQID_RDID << QSPI_IPCR_SEQID_SHIFT) | 0);
537 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
541 while ((RX_BUFFER_SIZE >= len) && (len > 0)) {
544 rbsr_reg = qspi_read32(priv->flags, ®s->rbsr);
545 if (rbsr_reg & QSPI_RBSR_RDBFL_MASK) {
546 data = qspi_read32(priv->flags, ®s->rbdr[i]);
547 data = qspi_endian_xchg(data);
548 size = (len < 4) ? len : 4;
549 memcpy(rxbuf, &data, size);
556 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
559 /* If not use AHB read, read data from ip interface */
560 static void qspi_op_read(struct fsl_qspi_priv *priv, u32 *rxbuf, u32 len)
562 struct fsl_qspi_regs *regs = priv->regs;
568 if (priv->cur_seqid == QSPI_CMD_RDAR)
571 seqid = SEQID_FAST_READ;
573 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
574 qspi_write32(priv->flags, ®s->mcr,
575 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
576 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
577 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
579 to_or_from = priv->sf_addr + priv->cur_amba_base;
584 qspi_write32(priv->flags, ®s->sfar, to_or_from);
586 size = (len > RX_BUFFER_SIZE) ?
587 RX_BUFFER_SIZE : len;
589 qspi_write32(priv->flags, ®s->ipcr,
590 (seqid << QSPI_IPCR_SEQID_SHIFT) |
592 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
599 while ((RX_BUFFER_SIZE >= size) && (size > 0)) {
600 data = qspi_read32(priv->flags, ®s->rbdr[i]);
601 data = qspi_endian_xchg(data);
603 memcpy(rxbuf, &data, size);
605 memcpy(rxbuf, &data, 4);
610 qspi_write32(priv->flags, ®s->mcr,
611 qspi_read32(priv->flags, ®s->mcr) |
612 QSPI_MCR_CLR_RXF_MASK);
615 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
618 static void qspi_op_write(struct fsl_qspi_priv *priv, u8 *txbuf, u32 len)
620 struct fsl_qspi_regs *regs = priv->regs;
621 u32 mcr_reg, data, reg, status_reg, seqid;
622 int i, size, tx_size;
625 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
626 qspi_write32(priv->flags, ®s->mcr,
627 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
628 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
629 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
632 while ((status_reg & FLASH_STATUS_WEL) != FLASH_STATUS_WEL) {
635 qspi_write32(priv->flags, ®s->ipcr,
636 (SEQID_WREN << QSPI_IPCR_SEQID_SHIFT) | 0);
637 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
640 qspi_write32(priv->flags, ®s->ipcr,
641 (SEQID_RDSR << QSPI_IPCR_SEQID_SHIFT) | 1);
642 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
645 reg = qspi_read32(priv->flags, ®s->rbsr);
646 if (reg & QSPI_RBSR_RDBFL_MASK) {
647 status_reg = qspi_read32(priv->flags, ®s->rbdr[0]);
648 status_reg = qspi_endian_xchg(status_reg);
650 qspi_write32(priv->flags, ®s->mcr,
651 qspi_read32(priv->flags, ®s->mcr) |
652 QSPI_MCR_CLR_RXF_MASK);
655 /* Default is page programming */
657 if (priv->cur_seqid == QSPI_CMD_WRAR)
659 #ifdef CONFIG_SPI_FLASH_BAR
660 if (priv->cur_seqid == QSPI_CMD_BRWR)
662 else if (priv->cur_seqid == QSPI_CMD_WREAR)
666 to_or_from = priv->sf_addr + priv->cur_amba_base;
668 qspi_write32(priv->flags, ®s->sfar, to_or_from);
670 tx_size = (len > TX_BUFFER_SIZE) ?
671 TX_BUFFER_SIZE : len;
675 * There must be atleast 128bit data
676 * available in TX FIFO for any pop operation
680 for (i = 0; i < size * 4; i++) {
681 memcpy(&data, txbuf, 4);
682 data = qspi_endian_xchg(data);
683 qspi_write32(priv->flags, ®s->tbdr, data);
687 qspi_write32(priv->flags, ®s->ipcr,
688 (seqid << QSPI_IPCR_SEQID_SHIFT) | tx_size);
689 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
692 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
695 static void qspi_op_rdsr(struct fsl_qspi_priv *priv, void *rxbuf, u32 len)
697 struct fsl_qspi_regs *regs = priv->regs;
698 u32 mcr_reg, reg, data;
700 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
701 qspi_write32(priv->flags, ®s->mcr,
702 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
703 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
704 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
706 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
708 qspi_write32(priv->flags, ®s->ipcr,
709 (SEQID_RDSR << QSPI_IPCR_SEQID_SHIFT) | 0);
710 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
716 reg = qspi_read32(priv->flags, ®s->rbsr);
717 if (reg & QSPI_RBSR_RDBFL_MASK) {
718 data = qspi_read32(priv->flags, ®s->rbdr[0]);
719 data = qspi_endian_xchg(data);
720 memcpy(rxbuf, &data, len);
721 qspi_write32(priv->flags, ®s->mcr,
722 qspi_read32(priv->flags, ®s->mcr) |
723 QSPI_MCR_CLR_RXF_MASK);
728 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
731 static void qspi_op_erase(struct fsl_qspi_priv *priv)
733 struct fsl_qspi_regs *regs = priv->regs;
737 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
738 qspi_write32(priv->flags, ®s->mcr,
739 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
740 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
741 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
743 to_or_from = priv->sf_addr + priv->cur_amba_base;
744 qspi_write32(priv->flags, ®s->sfar, to_or_from);
746 qspi_write32(priv->flags, ®s->ipcr,
747 (SEQID_WREN << QSPI_IPCR_SEQID_SHIFT) | 0);
748 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
751 if (priv->cur_seqid == QSPI_CMD_SE) {
752 qspi_write32(priv->flags, ®s->ipcr,
753 (SEQID_SE << QSPI_IPCR_SEQID_SHIFT) | 0);
754 } else if (priv->cur_seqid == QSPI_CMD_BE_4K) {
755 qspi_write32(priv->flags, ®s->ipcr,
756 (SEQID_BE_4K << QSPI_IPCR_SEQID_SHIFT) | 0);
758 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
761 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
764 int qspi_xfer(struct fsl_qspi_priv *priv, unsigned int bitlen,
765 const void *dout, void *din, unsigned long flags)
767 u32 bytes = DIV_ROUND_UP(bitlen, 8);
768 static u32 wr_sfaddr;
774 if (flags & SPI_XFER_BEGIN) {
775 priv->cur_seqid = *(u8 *)dout;
776 memcpy(&txbuf, dout, 4);
779 if (flags == SPI_XFER_END) {
780 priv->sf_addr = wr_sfaddr;
781 qspi_op_write(priv, (u8 *)dout, bytes);
785 if (priv->cur_seqid == QSPI_CMD_FAST_READ ||
786 priv->cur_seqid == QSPI_CMD_RDAR) {
787 priv->sf_addr = swab32(txbuf) & OFFSET_BITS_MASK;
788 } else if ((priv->cur_seqid == QSPI_CMD_SE) ||
789 (priv->cur_seqid == QSPI_CMD_BE_4K)) {
790 priv->sf_addr = swab32(txbuf) & OFFSET_BITS_MASK;
792 } else if (priv->cur_seqid == QSPI_CMD_PP ||
793 priv->cur_seqid == QSPI_CMD_WRAR) {
794 wr_sfaddr = swab32(txbuf) & OFFSET_BITS_MASK;
795 } else if ((priv->cur_seqid == QSPI_CMD_BRWR) ||
796 (priv->cur_seqid == QSPI_CMD_WREAR)) {
797 #ifdef CONFIG_SPI_FLASH_BAR
804 if (priv->cur_seqid == QSPI_CMD_FAST_READ) {
805 #ifdef CONFIG_SYS_FSL_QSPI_AHB
806 qspi_ahb_read(priv, din, bytes);
808 qspi_op_read(priv, din, bytes);
810 } else if (priv->cur_seqid == QSPI_CMD_RDAR) {
811 qspi_op_read(priv, din, bytes);
812 } else if (priv->cur_seqid == QSPI_CMD_RDID)
813 qspi_op_rdid(priv, din, bytes);
814 else if (priv->cur_seqid == QSPI_CMD_RDSR)
815 qspi_op_rdsr(priv, din, bytes);
816 #ifdef CONFIG_SPI_FLASH_BAR
817 else if ((priv->cur_seqid == QSPI_CMD_BRRD) ||
818 (priv->cur_seqid == QSPI_CMD_RDEAR)) {
820 qspi_op_rdbank(priv, din, bytes);
825 #ifdef CONFIG_SYS_FSL_QSPI_AHB
826 if ((priv->cur_seqid == QSPI_CMD_SE) ||
827 (priv->cur_seqid == QSPI_CMD_PP) ||
828 (priv->cur_seqid == QSPI_CMD_BE_4K) ||
829 (priv->cur_seqid == QSPI_CMD_WREAR) ||
830 (priv->cur_seqid == QSPI_CMD_BRWR))
831 qspi_ahb_invalid(priv);
837 void qspi_module_disable(struct fsl_qspi_priv *priv, u8 disable)
841 mcr_val = qspi_read32(priv->flags, &priv->regs->mcr);
843 mcr_val |= QSPI_MCR_MDIS_MASK;
845 mcr_val &= ~QSPI_MCR_MDIS_MASK;
846 qspi_write32(priv->flags, &priv->regs->mcr, mcr_val);
849 void qspi_cfg_smpr(struct fsl_qspi_priv *priv, u32 clear_bits, u32 set_bits)
853 smpr_val = qspi_read32(priv->flags, &priv->regs->smpr);
854 smpr_val &= ~clear_bits;
855 smpr_val |= set_bits;
856 qspi_write32(priv->flags, &priv->regs->smpr, smpr_val);
859 static int fsl_qspi_child_pre_probe(struct udevice *dev)
861 struct spi_slave *slave = dev_get_parent_priv(dev);
863 slave->max_write_size = TX_BUFFER_SIZE;
868 static int fsl_qspi_probe(struct udevice *bus)
871 u32 amba_size_per_chip;
872 struct fsl_qspi_platdata *plat = dev_get_platdata(bus);
873 struct fsl_qspi_priv *priv = dev_get_priv(bus);
874 struct dm_spi_bus *dm_spi_bus;
877 dm_spi_bus = bus->uclass_priv;
879 dm_spi_bus->max_hz = plat->speed_hz;
881 priv->regs = (struct fsl_qspi_regs *)(uintptr_t)plat->reg_base;
882 priv->flags = plat->flags;
884 priv->speed_hz = plat->speed_hz;
886 * QSPI SFADR width is 32bits, the max dest addr is 4GB-1.
887 * AMBA memory zone should be located on the 0~4GB space
888 * even on a 64bits cpu.
890 priv->amba_base[0] = (u32)plat->amba_base;
891 priv->amba_total_size = (u32)plat->amba_total_size;
892 priv->flash_num = plat->flash_num;
893 priv->num_chipselect = plat->num_chipselect;
895 /* make sure controller is not busy anywhere */
896 ret = is_controller_busy(priv);
899 debug("ERROR : The controller is busy\n");
903 mcr_val = qspi_read32(priv->flags, &priv->regs->mcr);
905 /* Set endianness to LE for i.mx */
906 if (IS_ENABLED(CONFIG_MX6) || IS_ENABLED(CONFIG_MX7))
907 mcr_val = QSPI_MCR_END_CFD_LE;
909 qspi_write32(priv->flags, &priv->regs->mcr,
910 QSPI_MCR_RESERVED_MASK | QSPI_MCR_MDIS_MASK |
911 (mcr_val & QSPI_MCR_END_CFD_MASK));
913 qspi_cfg_smpr(priv, ~(QSPI_SMPR_FSDLY_MASK | QSPI_SMPR_DDRSMP_MASK |
914 QSPI_SMPR_FSPHS_MASK | QSPI_SMPR_HSENA_MASK), 0);
917 * Assign AMBA memory zone for every chipselect
918 * QuadSPI has two channels, every channel has two chipselects.
919 * If the property 'num-cs' in dts is 2, the AMBA memory will be divided
920 * into two parts and assign to every channel. This indicate that every
921 * channel only has one valid chipselect.
922 * If the property 'num-cs' in dts is 4, the AMBA memory will be divided
923 * into four parts and assign to every chipselect.
924 * Every channel will has two valid chipselects.
926 amba_size_per_chip = priv->amba_total_size >>
927 (priv->num_chipselect >> 1);
928 for (i = 1 ; i < priv->num_chipselect ; i++)
930 amba_size_per_chip + priv->amba_base[i - 1];
933 * Any read access to non-implemented addresses will provide
936 * In case single die flash devices, TOP_ADDR_MEMA2 and
937 * TOP_ADDR_MEMB2 should be initialized/programmed to
938 * TOP_ADDR_MEMA1 and TOP_ADDR_MEMB1 respectively - in effect,
939 * setting the size of these devices to 0. This would ensure
940 * that the complete memory map is assigned to only one flash device.
942 qspi_write32(priv->flags, &priv->regs->sfa1ad,
943 priv->amba_base[0] + amba_size_per_chip);
944 switch (priv->num_chipselect) {
948 qspi_write32(priv->flags, &priv->regs->sfa2ad,
950 qspi_write32(priv->flags, &priv->regs->sfb1ad,
951 priv->amba_base[1] + amba_size_per_chip);
952 qspi_write32(priv->flags, &priv->regs->sfb2ad,
953 priv->amba_base[1] + amba_size_per_chip);
956 qspi_write32(priv->flags, &priv->regs->sfa2ad,
958 qspi_write32(priv->flags, &priv->regs->sfb1ad,
960 qspi_write32(priv->flags, &priv->regs->sfb2ad,
961 priv->amba_base[3] + amba_size_per_chip);
964 debug("Error: Unsupported chipselect number %u!\n",
965 priv->num_chipselect);
966 qspi_module_disable(priv, 1);
972 #ifdef CONFIG_SYS_FSL_QSPI_AHB
973 qspi_init_ahb_read(priv);
976 qspi_module_disable(priv, 0);
981 static int fsl_qspi_ofdata_to_platdata(struct udevice *bus)
983 struct fdt_resource res_regs, res_mem;
984 struct fsl_qspi_platdata *plat = bus->platdata;
985 const void *blob = gd->fdt_blob;
986 int node = dev_of_offset(bus);
987 int ret, flash_num = 0, subnode;
989 if (fdtdec_get_bool(blob, node, "big-endian"))
990 plat->flags |= QSPI_FLAG_REGMAP_ENDIAN_BIG;
992 ret = fdt_get_named_resource(blob, node, "reg", "reg-names",
993 "QuadSPI", &res_regs);
995 debug("Error: can't get regs base addresses(ret = %d)!\n", ret);
998 ret = fdt_get_named_resource(blob, node, "reg", "reg-names",
999 "QuadSPI-memory", &res_mem);
1001 debug("Error: can't get AMBA base addresses(ret = %d)!\n", ret);
1005 /* Count flash numbers */
1006 fdt_for_each_subnode(subnode, blob, node)
1009 if (flash_num == 0) {
1010 debug("Error: Missing flashes!\n");
1014 plat->speed_hz = fdtdec_get_int(blob, node, "spi-max-frequency",
1015 FSL_QSPI_DEFAULT_SCK_FREQ);
1016 plat->num_chipselect = fdtdec_get_int(blob, node, "num-cs",
1017 FSL_QSPI_MAX_CHIPSELECT_NUM);
1019 plat->reg_base = res_regs.start;
1020 plat->amba_base = res_mem.start;
1021 plat->amba_total_size = res_mem.end - res_mem.start + 1;
1022 plat->flash_num = flash_num;
1024 debug("%s: regs=<0x%llx> <0x%llx, 0x%llx>, max-frequency=%d, endianess=%s\n",
1026 (u64)plat->reg_base,
1027 (u64)plat->amba_base,
1028 (u64)plat->amba_total_size,
1030 plat->flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ? "be" : "le"
1036 static int fsl_qspi_xfer(struct udevice *dev, unsigned int bitlen,
1037 const void *dout, void *din, unsigned long flags)
1039 struct fsl_qspi_priv *priv;
1040 struct udevice *bus;
1043 priv = dev_get_priv(bus);
1045 return qspi_xfer(priv, bitlen, dout, din, flags);
1048 static int fsl_qspi_claim_bus(struct udevice *dev)
1050 struct fsl_qspi_priv *priv;
1051 struct udevice *bus;
1052 struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
1056 priv = dev_get_priv(bus);
1058 /* make sure controller is not busy anywhere */
1059 ret = is_controller_busy(priv);
1062 debug("ERROR : The controller is busy\n");
1066 priv->cur_amba_base = priv->amba_base[slave_plat->cs];
1068 qspi_module_disable(priv, 0);
1073 static int fsl_qspi_release_bus(struct udevice *dev)
1075 struct fsl_qspi_priv *priv;
1076 struct udevice *bus;
1079 priv = dev_get_priv(bus);
1081 qspi_module_disable(priv, 1);
1086 static int fsl_qspi_set_speed(struct udevice *bus, uint speed)
1092 static int fsl_qspi_set_mode(struct udevice *bus, uint mode)
1098 static const struct dm_spi_ops fsl_qspi_ops = {
1099 .claim_bus = fsl_qspi_claim_bus,
1100 .release_bus = fsl_qspi_release_bus,
1101 .xfer = fsl_qspi_xfer,
1102 .set_speed = fsl_qspi_set_speed,
1103 .set_mode = fsl_qspi_set_mode,
1106 static const struct udevice_id fsl_qspi_ids[] = {
1107 { .compatible = "fsl,vf610-qspi" },
1108 { .compatible = "fsl,imx6sx-qspi" },
1109 { .compatible = "fsl,imx6ul-qspi" },
1110 { .compatible = "fsl,imx7d-qspi" },
1114 U_BOOT_DRIVER(fsl_qspi) = {
1117 .of_match = fsl_qspi_ids,
1118 .ops = &fsl_qspi_ops,
1119 .ofdata_to_platdata = fsl_qspi_ofdata_to_platdata,
1120 .platdata_auto_alloc_size = sizeof(struct fsl_qspi_platdata),
1121 .priv_auto_alloc_size = sizeof(struct fsl_qspi_priv),
1122 .probe = fsl_qspi_probe,
1123 .child_pre_probe = fsl_qspi_child_pre_probe,