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>
19 DECLARE_GLOBAL_DATA_PTR;
21 #define RX_BUFFER_SIZE 0x80
22 #if defined(CONFIG_MX6SX) || defined(CONFIG_MX6UL) || \
23 defined(CONFIG_MX6ULL) || defined(CONFIG_MX7D)
24 #define TX_BUFFER_SIZE 0x200
26 #define TX_BUFFER_SIZE 0x40
29 #define OFFSET_BITS_MASK GENMASK(23, 0)
31 #define FLASH_STATUS_WEL 0x02
35 #define SEQID_FAST_READ 2
38 #define SEQID_CHIP_ERASE 5
42 #ifdef CONFIG_SPI_FLASH_BAR
45 #define SEQID_RDEAR 11
46 #define SEQID_WREAR 12
52 #define QSPI_CMD_PP 0x02 /* Page program (up to 256 bytes) */
53 #define QSPI_CMD_RDSR 0x05 /* Read status register */
54 #define QSPI_CMD_WREN 0x06 /* Write enable */
55 #define QSPI_CMD_FAST_READ 0x0b /* Read data bytes (high frequency) */
56 #define QSPI_CMD_BE_4K 0x20 /* 4K erase */
57 #define QSPI_CMD_CHIP_ERASE 0xc7 /* Erase whole flash chip */
58 #define QSPI_CMD_SE 0xd8 /* Sector erase (usually 64KiB) */
59 #define QSPI_CMD_RDID 0x9f /* Read JEDEC ID */
61 /* Used for Micron, winbond and Macronix flashes */
62 #define QSPI_CMD_WREAR 0xc5 /* EAR register write */
63 #define QSPI_CMD_RDEAR 0xc8 /* EAR reigster read */
65 /* Used for Spansion flashes only. */
66 #define QSPI_CMD_BRRD 0x16 /* Bank register read */
67 #define QSPI_CMD_BRWR 0x17 /* Bank register write */
69 /* Used for Spansion S25FS-S family flash only. */
70 #define QSPI_CMD_RDAR 0x65 /* Read any device register */
71 #define QSPI_CMD_WRAR 0x71 /* Write any device register */
73 /* 4-byte address QSPI CMD - used on Spansion and some Macronix flashes */
74 #define QSPI_CMD_FAST_READ_4B 0x0c /* Read data bytes (high frequency) */
75 #define QSPI_CMD_PP_4B 0x12 /* Page program (up to 256 bytes) */
76 #define QSPI_CMD_SE_4B 0xdc /* Sector erase (usually 64KiB) */
78 /* fsl_qspi_platdata flags */
79 #define QSPI_FLAG_REGMAP_ENDIAN_BIG BIT(0)
81 /* default SCK frequency, unit: HZ */
82 #define FSL_QSPI_DEFAULT_SCK_FREQ 50000000
84 /* QSPI max chipselect signals number */
85 #define FSL_QSPI_MAX_CHIPSELECT_NUM 4
88 * struct fsl_qspi_platdata - platform data for Freescale QSPI
90 * @flags: Flags for QSPI QSPI_FLAG_...
91 * @speed_hz: Default SCK frequency
92 * @reg_base: Base address of QSPI registers
93 * @amba_base: Base address of QSPI memory mapping
94 * @amba_total_size: size of QSPI memory mapping
95 * @flash_num: Number of active slave devices
96 * @num_chipselect: Number of QSPI chipselect signals
98 struct fsl_qspi_platdata {
102 fdt_addr_t amba_base;
103 fdt_size_t amba_total_size;
109 * struct fsl_qspi_priv - private data for Freescale QSPI
111 * @flags: Flags for QSPI QSPI_FLAG_...
112 * @bus_clk: QSPI input clk frequency
113 * @speed_hz: Default SCK frequency
114 * @cur_seqid: current LUT table sequence id
115 * @sf_addr: flash access offset
116 * @amba_base: Base address of QSPI memory mapping of every CS
117 * @amba_total_size: size of QSPI memory mapping
118 * @cur_amba_base: Base address of QSPI memory mapping of current CS
119 * @flash_num: Number of active slave devices
120 * @num_chipselect: Number of QSPI chipselect signals
121 * @regs: Point to QSPI register structure for I/O access
123 struct fsl_qspi_priv {
129 u32 amba_base[FSL_QSPI_MAX_CHIPSELECT_NUM];
134 struct fsl_qspi_regs *regs;
138 static u32 qspi_read32(u32 flags, u32 *addr)
140 return flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ?
141 in_be32(addr) : in_le32(addr);
144 static void qspi_write32(u32 flags, u32 *addr, u32 val)
146 flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ?
147 out_be32(addr, val) : out_le32(addr, val);
150 static inline int is_controller_busy(const struct fsl_qspi_priv *priv)
153 const u32 mask = QSPI_SR_BUSY_MASK | QSPI_SR_AHB_ACC_MASK |
155 unsigned int retry = 5;
158 val = qspi_read32(priv->flags, &priv->regs->sr);
160 if ((~val & mask) == mask)
169 /* QSPI support swapping the flash read/write data
170 * in hardware for LS102xA, but not for VF610 */
171 static inline u32 qspi_endian_xchg(u32 data)
180 static void qspi_set_lut(struct fsl_qspi_priv *priv)
182 struct fsl_qspi_regs *regs = priv->regs;
186 qspi_write32(priv->flags, ®s->lutkey, LUT_KEY_VALUE);
187 qspi_write32(priv->flags, ®s->lckcr, QSPI_LCKCR_UNLOCK);
190 lut_base = SEQID_WREN * 4;
191 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_WREN) |
192 PAD0(LUT_PAD1) | INSTR0(LUT_CMD));
193 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
194 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
195 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
198 lut_base = SEQID_FAST_READ * 4;
199 #ifdef CONFIG_SPI_FLASH_BAR
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 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
206 qspi_write32(priv->flags, ®s->lut[lut_base],
207 OPRND0(QSPI_CMD_FAST_READ) | PAD0(LUT_PAD1) |
208 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
209 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
211 qspi_write32(priv->flags, ®s->lut[lut_base],
212 OPRND0(QSPI_CMD_FAST_READ_4B) |
213 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) |
214 OPRND1(ADDR32BIT) | PAD1(LUT_PAD1) |
217 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
218 OPRND0(8) | PAD0(LUT_PAD1) | INSTR0(LUT_DUMMY) |
219 OPRND1(RX_BUFFER_SIZE) | PAD1(LUT_PAD1) |
221 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
222 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
225 lut_base = SEQID_RDSR * 4;
226 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDSR) |
227 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
228 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
229 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
230 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
231 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
234 lut_base = SEQID_SE * 4;
235 #ifdef CONFIG_SPI_FLASH_BAR
236 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_SE) |
237 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
238 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
240 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
241 qspi_write32(priv->flags, ®s->lut[lut_base],
242 OPRND0(QSPI_CMD_SE) | PAD0(LUT_PAD1) |
243 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
244 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
246 qspi_write32(priv->flags, ®s->lut[lut_base],
247 OPRND0(QSPI_CMD_SE_4B) | PAD0(LUT_PAD1) |
248 INSTR0(LUT_CMD) | OPRND1(ADDR32BIT) |
249 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
251 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
252 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
253 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
255 /* Erase the whole chip */
256 lut_base = SEQID_CHIP_ERASE * 4;
257 qspi_write32(priv->flags, ®s->lut[lut_base],
258 OPRND0(QSPI_CMD_CHIP_ERASE) |
259 PAD0(LUT_PAD1) | INSTR0(LUT_CMD));
260 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
261 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
262 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
265 lut_base = SEQID_PP * 4;
266 #ifdef CONFIG_SPI_FLASH_BAR
267 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_PP) |
268 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
269 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
271 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
272 qspi_write32(priv->flags, ®s->lut[lut_base],
273 OPRND0(QSPI_CMD_PP) | PAD0(LUT_PAD1) |
274 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
275 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
277 qspi_write32(priv->flags, ®s->lut[lut_base],
278 OPRND0(QSPI_CMD_PP_4B) | PAD0(LUT_PAD1) |
279 INSTR0(LUT_CMD) | OPRND1(ADDR32BIT) |
280 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
282 #if defined(CONFIG_MX6SX) || defined(CONFIG_MX6UL) || \
283 defined(CONFIG_MX6ULL) || defined(CONFIG_MX7D)
285 * To MX6SX, OPRND0(TX_BUFFER_SIZE) can not work correctly.
286 * So, Use IDATSZ in IPCR to determine the size and here set 0.
288 qspi_write32(priv->flags, ®s->lut[lut_base + 1], OPRND0(0) |
289 PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
291 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
292 OPRND0(TX_BUFFER_SIZE) |
293 PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
295 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
296 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
299 lut_base = SEQID_RDID * 4;
300 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDID) |
301 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(8) |
302 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
303 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
304 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
305 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
307 /* SUB SECTOR 4K ERASE */
308 lut_base = SEQID_BE_4K * 4;
309 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BE_4K) |
310 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
311 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
313 #ifdef CONFIG_SPI_FLASH_BAR
315 * BRRD BRWR RDEAR WREAR are all supported, because it is hard to
316 * dynamically check whether to set BRRD BRWR or RDEAR WREAR during
319 lut_base = SEQID_BRRD * 4;
320 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BRRD) |
321 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
322 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
324 lut_base = SEQID_BRWR * 4;
325 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BRWR) |
326 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
327 PAD1(LUT_PAD1) | INSTR1(LUT_WRITE));
329 lut_base = SEQID_RDEAR * 4;
330 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDEAR) |
331 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
332 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
334 lut_base = SEQID_WREAR * 4;
335 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_WREAR) |
336 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
337 PAD1(LUT_PAD1) | INSTR1(LUT_WRITE));
341 * Read any device register.
342 * Used for Spansion S25FS-S family flash only.
344 lut_base = SEQID_RDAR * 4;
345 qspi_write32(priv->flags, ®s->lut[lut_base],
346 OPRND0(QSPI_CMD_RDAR) | PAD0(LUT_PAD1) |
347 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
348 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
349 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
350 OPRND0(8) | PAD0(LUT_PAD1) | INSTR0(LUT_DUMMY) |
351 OPRND1(1) | PAD1(LUT_PAD1) |
355 * Write any device register.
356 * Used for Spansion S25FS-S family flash only.
358 lut_base = SEQID_WRAR * 4;
359 qspi_write32(priv->flags, ®s->lut[lut_base],
360 OPRND0(QSPI_CMD_WRAR) | PAD0(LUT_PAD1) |
361 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
362 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
363 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
364 OPRND0(1) | PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
367 qspi_write32(priv->flags, ®s->lutkey, LUT_KEY_VALUE);
368 qspi_write32(priv->flags, ®s->lckcr, QSPI_LCKCR_LOCK);
371 #if defined(CONFIG_SYS_FSL_QSPI_AHB)
373 * If we have changed the content of the flash by writing or erasing,
374 * we need to invalidate the AHB buffer. If we do not do so, we may read out
375 * the wrong data. The spec tells us reset the AHB domain and Serial Flash
376 * domain at the same time.
378 static inline void qspi_ahb_invalid(struct fsl_qspi_priv *priv)
380 struct fsl_qspi_regs *regs = priv->regs;
383 reg = qspi_read32(priv->flags, ®s->mcr);
384 reg |= QSPI_MCR_SWRSTHD_MASK | QSPI_MCR_SWRSTSD_MASK;
385 qspi_write32(priv->flags, ®s->mcr, reg);
388 * The minimum delay : 1 AHB + 2 SFCK clocks.
389 * Delay 1 us is enough.
393 reg &= ~(QSPI_MCR_SWRSTHD_MASK | QSPI_MCR_SWRSTSD_MASK);
394 qspi_write32(priv->flags, ®s->mcr, reg);
397 /* Read out the data from the AHB buffer. */
398 static inline void qspi_ahb_read(struct fsl_qspi_priv *priv, u8 *rxbuf, int len)
400 struct fsl_qspi_regs *regs = priv->regs;
404 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
406 qspi_write32(priv->flags, ®s->mcr,
407 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
408 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
410 rx_addr = (void *)(uintptr_t)(priv->cur_amba_base + priv->sf_addr);
411 /* Read out the data directly from the AHB buffer. */
412 memcpy(rxbuf, rx_addr, len);
414 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
417 static void qspi_enable_ddr_mode(struct fsl_qspi_priv *priv)
420 struct fsl_qspi_regs *regs = priv->regs;
422 reg = qspi_read32(priv->flags, ®s->mcr);
423 /* Disable the module */
424 qspi_write32(priv->flags, ®s->mcr, reg | QSPI_MCR_MDIS_MASK);
426 /* Set the Sampling Register for DDR */
427 reg2 = qspi_read32(priv->flags, ®s->smpr);
428 reg2 &= ~QSPI_SMPR_DDRSMP_MASK;
429 reg2 |= (2 << QSPI_SMPR_DDRSMP_SHIFT);
430 qspi_write32(priv->flags, ®s->smpr, reg2);
432 /* Enable the module again (enable the DDR too) */
433 reg |= QSPI_MCR_DDR_EN_MASK;
434 /* Enable bit 29 for imx6sx */
437 qspi_write32(priv->flags, ®s->mcr, reg);
441 * There are two different ways to read out the data from the flash:
442 * the "IP Command Read" and the "AHB Command Read".
444 * The IC guy suggests we use the "AHB Command Read" which is faster
445 * then the "IP Command Read". (What's more is that there is a bug in
446 * the "IP Command Read" in the Vybrid.)
448 * After we set up the registers for the "AHB Command Read", we can use
449 * the memcpy to read the data directly. A "missed" access to the buffer
450 * causes the controller to clear the buffer, and use the sequence pointed
451 * by the QUADSPI_BFGENCR[SEQID] to initiate a read from the flash.
453 static void qspi_init_ahb_read(struct fsl_qspi_priv *priv)
455 struct fsl_qspi_regs *regs = priv->regs;
457 /* AHB configuration for access buffer 0/1/2 .*/
458 qspi_write32(priv->flags, ®s->buf0cr, QSPI_BUFXCR_INVALID_MSTRID);
459 qspi_write32(priv->flags, ®s->buf1cr, QSPI_BUFXCR_INVALID_MSTRID);
460 qspi_write32(priv->flags, ®s->buf2cr, QSPI_BUFXCR_INVALID_MSTRID);
461 qspi_write32(priv->flags, ®s->buf3cr, QSPI_BUF3CR_ALLMST_MASK |
462 (0x80 << QSPI_BUF3CR_ADATSZ_SHIFT));
464 /* We only use the buffer3 */
465 qspi_write32(priv->flags, ®s->buf0ind, 0);
466 qspi_write32(priv->flags, ®s->buf1ind, 0);
467 qspi_write32(priv->flags, ®s->buf2ind, 0);
470 * Set the default lut sequence for AHB Read.
471 * Parallel mode is disabled.
473 qspi_write32(priv->flags, ®s->bfgencr,
474 SEQID_FAST_READ << QSPI_BFGENCR_SEQID_SHIFT);
477 qspi_enable_ddr_mode(priv);
481 #ifdef CONFIG_SPI_FLASH_BAR
482 /* Bank register read/write, EAR register read/write */
483 static void qspi_op_rdbank(struct fsl_qspi_priv *priv, u8 *rxbuf, u32 len)
485 struct fsl_qspi_regs *regs = priv->regs;
486 u32 reg, mcr_reg, data, seqid;
488 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
489 qspi_write32(priv->flags, ®s->mcr,
490 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
491 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
492 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
494 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
496 if (priv->cur_seqid == QSPI_CMD_BRRD)
501 qspi_write32(priv->flags, ®s->ipcr,
502 (seqid << QSPI_IPCR_SEQID_SHIFT) | len);
504 /* Wait previous command complete */
505 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
511 reg = qspi_read32(priv->flags, ®s->rbsr);
512 if (reg & QSPI_RBSR_RDBFL_MASK) {
513 data = qspi_read32(priv->flags, ®s->rbdr[0]);
514 data = qspi_endian_xchg(data);
515 memcpy(rxbuf, &data, len);
516 qspi_write32(priv->flags, ®s->mcr,
517 qspi_read32(priv->flags, ®s->mcr) |
518 QSPI_MCR_CLR_RXF_MASK);
523 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
527 static void qspi_op_rdid(struct fsl_qspi_priv *priv, u32 *rxbuf, u32 len)
529 struct fsl_qspi_regs *regs = priv->regs;
530 u32 mcr_reg, rbsr_reg, data, size;
533 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
534 qspi_write32(priv->flags, ®s->mcr,
535 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
536 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
537 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
539 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
541 qspi_write32(priv->flags, ®s->ipcr,
542 (SEQID_RDID << QSPI_IPCR_SEQID_SHIFT) | 0);
543 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
547 while ((RX_BUFFER_SIZE >= len) && (len > 0)) {
550 rbsr_reg = qspi_read32(priv->flags, ®s->rbsr);
551 if (rbsr_reg & QSPI_RBSR_RDBFL_MASK) {
552 data = qspi_read32(priv->flags, ®s->rbdr[i]);
553 data = qspi_endian_xchg(data);
554 size = (len < 4) ? len : 4;
555 memcpy(rxbuf, &data, size);
562 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
565 /* If not use AHB read, read data from ip interface */
566 static void qspi_op_read(struct fsl_qspi_priv *priv, u32 *rxbuf, u32 len)
568 struct fsl_qspi_regs *regs = priv->regs;
574 if (priv->cur_seqid == QSPI_CMD_RDAR)
577 seqid = SEQID_FAST_READ;
579 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
580 qspi_write32(priv->flags, ®s->mcr,
581 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
582 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
583 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
585 to_or_from = priv->sf_addr + priv->cur_amba_base;
590 qspi_write32(priv->flags, ®s->sfar, to_or_from);
592 size = (len > RX_BUFFER_SIZE) ?
593 RX_BUFFER_SIZE : len;
595 qspi_write32(priv->flags, ®s->ipcr,
596 (seqid << QSPI_IPCR_SEQID_SHIFT) |
598 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
605 while ((RX_BUFFER_SIZE >= size) && (size > 0)) {
606 data = qspi_read32(priv->flags, ®s->rbdr[i]);
607 data = qspi_endian_xchg(data);
609 memcpy(rxbuf, &data, size);
611 memcpy(rxbuf, &data, 4);
616 qspi_write32(priv->flags, ®s->mcr,
617 qspi_read32(priv->flags, ®s->mcr) |
618 QSPI_MCR_CLR_RXF_MASK);
621 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
624 static void qspi_op_write(struct fsl_qspi_priv *priv, u8 *txbuf, u32 len)
626 struct fsl_qspi_regs *regs = priv->regs;
627 u32 mcr_reg, data, reg, status_reg, seqid;
628 int i, size, tx_size;
631 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
632 qspi_write32(priv->flags, ®s->mcr,
633 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
634 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
635 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
638 while ((status_reg & FLASH_STATUS_WEL) != FLASH_STATUS_WEL) {
641 qspi_write32(priv->flags, ®s->ipcr,
642 (SEQID_WREN << QSPI_IPCR_SEQID_SHIFT) | 0);
643 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
646 qspi_write32(priv->flags, ®s->ipcr,
647 (SEQID_RDSR << QSPI_IPCR_SEQID_SHIFT) | 1);
648 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
651 reg = qspi_read32(priv->flags, ®s->rbsr);
652 if (reg & QSPI_RBSR_RDBFL_MASK) {
653 status_reg = qspi_read32(priv->flags, ®s->rbdr[0]);
654 status_reg = qspi_endian_xchg(status_reg);
656 qspi_write32(priv->flags, ®s->mcr,
657 qspi_read32(priv->flags, ®s->mcr) |
658 QSPI_MCR_CLR_RXF_MASK);
661 /* Default is page programming */
663 if (priv->cur_seqid == QSPI_CMD_WRAR)
665 #ifdef CONFIG_SPI_FLASH_BAR
666 if (priv->cur_seqid == QSPI_CMD_BRWR)
668 else if (priv->cur_seqid == QSPI_CMD_WREAR)
672 to_or_from = priv->sf_addr + priv->cur_amba_base;
674 qspi_write32(priv->flags, ®s->sfar, to_or_from);
676 tx_size = (len > TX_BUFFER_SIZE) ?
677 TX_BUFFER_SIZE : len;
681 * There must be atleast 128bit data
682 * available in TX FIFO for any pop operation
686 for (i = 0; i < size * 4; i++) {
687 memcpy(&data, txbuf, 4);
688 data = qspi_endian_xchg(data);
689 qspi_write32(priv->flags, ®s->tbdr, data);
693 qspi_write32(priv->flags, ®s->ipcr,
694 (seqid << QSPI_IPCR_SEQID_SHIFT) | tx_size);
695 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
698 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
701 static void qspi_op_rdsr(struct fsl_qspi_priv *priv, void *rxbuf, u32 len)
703 struct fsl_qspi_regs *regs = priv->regs;
704 u32 mcr_reg, reg, data;
706 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
707 qspi_write32(priv->flags, ®s->mcr,
708 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
709 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
710 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
712 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
714 qspi_write32(priv->flags, ®s->ipcr,
715 (SEQID_RDSR << QSPI_IPCR_SEQID_SHIFT) | 0);
716 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
722 reg = qspi_read32(priv->flags, ®s->rbsr);
723 if (reg & QSPI_RBSR_RDBFL_MASK) {
724 data = qspi_read32(priv->flags, ®s->rbdr[0]);
725 data = qspi_endian_xchg(data);
726 memcpy(rxbuf, &data, len);
727 qspi_write32(priv->flags, ®s->mcr,
728 qspi_read32(priv->flags, ®s->mcr) |
729 QSPI_MCR_CLR_RXF_MASK);
734 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
737 static void qspi_op_erase(struct fsl_qspi_priv *priv)
739 struct fsl_qspi_regs *regs = priv->regs;
743 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
744 qspi_write32(priv->flags, ®s->mcr,
745 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
746 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
747 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
749 to_or_from = priv->sf_addr + priv->cur_amba_base;
750 qspi_write32(priv->flags, ®s->sfar, to_or_from);
752 qspi_write32(priv->flags, ®s->ipcr,
753 (SEQID_WREN << QSPI_IPCR_SEQID_SHIFT) | 0);
754 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
757 if (priv->cur_seqid == QSPI_CMD_SE) {
758 qspi_write32(priv->flags, ®s->ipcr,
759 (SEQID_SE << QSPI_IPCR_SEQID_SHIFT) | 0);
760 } else if (priv->cur_seqid == QSPI_CMD_BE_4K) {
761 qspi_write32(priv->flags, ®s->ipcr,
762 (SEQID_BE_4K << QSPI_IPCR_SEQID_SHIFT) | 0);
764 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
767 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
770 int qspi_xfer(struct fsl_qspi_priv *priv, unsigned int bitlen,
771 const void *dout, void *din, unsigned long flags)
773 u32 bytes = DIV_ROUND_UP(bitlen, 8);
774 static u32 wr_sfaddr;
780 if (flags & SPI_XFER_BEGIN) {
781 priv->cur_seqid = *(u8 *)dout;
782 memcpy(&txbuf, dout, 4);
785 if (flags == SPI_XFER_END) {
786 priv->sf_addr = wr_sfaddr;
787 qspi_op_write(priv, (u8 *)dout, bytes);
791 if (priv->cur_seqid == QSPI_CMD_FAST_READ ||
792 priv->cur_seqid == QSPI_CMD_RDAR) {
793 priv->sf_addr = swab32(txbuf) & OFFSET_BITS_MASK;
794 } else if ((priv->cur_seqid == QSPI_CMD_SE) ||
795 (priv->cur_seqid == QSPI_CMD_BE_4K)) {
796 priv->sf_addr = swab32(txbuf) & OFFSET_BITS_MASK;
798 } else if (priv->cur_seqid == QSPI_CMD_PP ||
799 priv->cur_seqid == QSPI_CMD_WRAR) {
800 wr_sfaddr = swab32(txbuf) & OFFSET_BITS_MASK;
801 } else if ((priv->cur_seqid == QSPI_CMD_BRWR) ||
802 (priv->cur_seqid == QSPI_CMD_WREAR)) {
803 #ifdef CONFIG_SPI_FLASH_BAR
810 if (priv->cur_seqid == QSPI_CMD_FAST_READ) {
811 #ifdef CONFIG_SYS_FSL_QSPI_AHB
812 qspi_ahb_read(priv, din, bytes);
814 qspi_op_read(priv, din, bytes);
816 } else if (priv->cur_seqid == QSPI_CMD_RDAR) {
817 qspi_op_read(priv, din, bytes);
818 } else if (priv->cur_seqid == QSPI_CMD_RDID)
819 qspi_op_rdid(priv, din, bytes);
820 else if (priv->cur_seqid == QSPI_CMD_RDSR)
821 qspi_op_rdsr(priv, din, bytes);
822 #ifdef CONFIG_SPI_FLASH_BAR
823 else if ((priv->cur_seqid == QSPI_CMD_BRRD) ||
824 (priv->cur_seqid == QSPI_CMD_RDEAR)) {
826 qspi_op_rdbank(priv, din, bytes);
831 #ifdef CONFIG_SYS_FSL_QSPI_AHB
832 if ((priv->cur_seqid == QSPI_CMD_SE) ||
833 (priv->cur_seqid == QSPI_CMD_PP) ||
834 (priv->cur_seqid == QSPI_CMD_BE_4K) ||
835 (priv->cur_seqid == QSPI_CMD_WREAR) ||
836 (priv->cur_seqid == QSPI_CMD_BRWR))
837 qspi_ahb_invalid(priv);
843 void qspi_module_disable(struct fsl_qspi_priv *priv, u8 disable)
847 mcr_val = qspi_read32(priv->flags, &priv->regs->mcr);
849 mcr_val |= QSPI_MCR_MDIS_MASK;
851 mcr_val &= ~QSPI_MCR_MDIS_MASK;
852 qspi_write32(priv->flags, &priv->regs->mcr, mcr_val);
855 void qspi_cfg_smpr(struct fsl_qspi_priv *priv, u32 clear_bits, u32 set_bits)
859 smpr_val = qspi_read32(priv->flags, &priv->regs->smpr);
860 smpr_val &= ~clear_bits;
861 smpr_val |= set_bits;
862 qspi_write32(priv->flags, &priv->regs->smpr, smpr_val);
865 static int fsl_qspi_child_pre_probe(struct udevice *dev)
867 struct spi_slave *slave = dev_get_parent_priv(dev);
869 slave->max_write_size = TX_BUFFER_SIZE;
874 static int fsl_qspi_probe(struct udevice *bus)
877 u32 amba_size_per_chip;
878 struct fsl_qspi_platdata *plat = dev_get_platdata(bus);
879 struct fsl_qspi_priv *priv = dev_get_priv(bus);
880 struct dm_spi_bus *dm_spi_bus;
883 dm_spi_bus = bus->uclass_priv;
885 dm_spi_bus->max_hz = plat->speed_hz;
887 priv->regs = (struct fsl_qspi_regs *)(uintptr_t)plat->reg_base;
888 priv->flags = plat->flags;
890 priv->speed_hz = plat->speed_hz;
892 * QSPI SFADR width is 32bits, the max dest addr is 4GB-1.
893 * AMBA memory zone should be located on the 0~4GB space
894 * even on a 64bits cpu.
896 priv->amba_base[0] = (u32)plat->amba_base;
897 priv->amba_total_size = (u32)plat->amba_total_size;
898 priv->flash_num = plat->flash_num;
899 priv->num_chipselect = plat->num_chipselect;
901 /* make sure controller is not busy anywhere */
902 ret = is_controller_busy(priv);
905 debug("ERROR : The controller is busy\n");
909 mcr_val = qspi_read32(priv->flags, &priv->regs->mcr);
911 /* Set endianness to LE for i.mx */
912 if (IS_ENABLED(CONFIG_MX6) || IS_ENABLED(CONFIG_MX7))
913 mcr_val = QSPI_MCR_END_CFD_LE;
915 qspi_write32(priv->flags, &priv->regs->mcr,
916 QSPI_MCR_RESERVED_MASK | QSPI_MCR_MDIS_MASK |
917 (mcr_val & QSPI_MCR_END_CFD_MASK));
919 qspi_cfg_smpr(priv, ~(QSPI_SMPR_FSDLY_MASK | QSPI_SMPR_DDRSMP_MASK |
920 QSPI_SMPR_FSPHS_MASK | QSPI_SMPR_HSENA_MASK), 0);
923 * Assign AMBA memory zone for every chipselect
924 * QuadSPI has two channels, every channel has two chipselects.
925 * If the property 'num-cs' in dts is 2, the AMBA memory will be divided
926 * into two parts and assign to every channel. This indicate that every
927 * channel only has one valid chipselect.
928 * If the property 'num-cs' in dts is 4, the AMBA memory will be divided
929 * into four parts and assign to every chipselect.
930 * Every channel will has two valid chipselects.
932 amba_size_per_chip = priv->amba_total_size >>
933 (priv->num_chipselect >> 1);
934 for (i = 1 ; i < priv->num_chipselect ; i++)
936 amba_size_per_chip + priv->amba_base[i - 1];
939 * Any read access to non-implemented addresses will provide
942 * In case single die flash devices, TOP_ADDR_MEMA2 and
943 * TOP_ADDR_MEMB2 should be initialized/programmed to
944 * TOP_ADDR_MEMA1 and TOP_ADDR_MEMB1 respectively - in effect,
945 * setting the size of these devices to 0. This would ensure
946 * that the complete memory map is assigned to only one flash device.
948 qspi_write32(priv->flags, &priv->regs->sfa1ad,
949 priv->amba_base[0] + amba_size_per_chip);
950 switch (priv->num_chipselect) {
954 qspi_write32(priv->flags, &priv->regs->sfa2ad,
956 qspi_write32(priv->flags, &priv->regs->sfb1ad,
957 priv->amba_base[1] + amba_size_per_chip);
958 qspi_write32(priv->flags, &priv->regs->sfb2ad,
959 priv->amba_base[1] + amba_size_per_chip);
962 qspi_write32(priv->flags, &priv->regs->sfa2ad,
964 qspi_write32(priv->flags, &priv->regs->sfb1ad,
966 qspi_write32(priv->flags, &priv->regs->sfb2ad,
967 priv->amba_base[3] + amba_size_per_chip);
970 debug("Error: Unsupported chipselect number %u!\n",
971 priv->num_chipselect);
972 qspi_module_disable(priv, 1);
978 #ifdef CONFIG_SYS_FSL_QSPI_AHB
979 qspi_init_ahb_read(priv);
982 qspi_module_disable(priv, 0);
987 static int fsl_qspi_ofdata_to_platdata(struct udevice *bus)
989 struct fdt_resource res_regs, res_mem;
990 struct fsl_qspi_platdata *plat = bus->platdata;
991 const void *blob = gd->fdt_blob;
992 int node = dev_of_offset(bus);
993 int ret, flash_num = 0, subnode;
995 if (fdtdec_get_bool(blob, node, "big-endian"))
996 plat->flags |= QSPI_FLAG_REGMAP_ENDIAN_BIG;
998 ret = fdt_get_named_resource(blob, node, "reg", "reg-names",
999 "QuadSPI", &res_regs);
1001 debug("Error: can't get regs base addresses(ret = %d)!\n", ret);
1004 ret = fdt_get_named_resource(blob, node, "reg", "reg-names",
1005 "QuadSPI-memory", &res_mem);
1007 debug("Error: can't get AMBA base addresses(ret = %d)!\n", ret);
1011 /* Count flash numbers */
1012 fdt_for_each_subnode(subnode, blob, node)
1015 if (flash_num == 0) {
1016 debug("Error: Missing flashes!\n");
1020 plat->speed_hz = fdtdec_get_int(blob, node, "spi-max-frequency",
1021 FSL_QSPI_DEFAULT_SCK_FREQ);
1022 plat->num_chipselect = fdtdec_get_int(blob, node, "num-cs",
1023 FSL_QSPI_MAX_CHIPSELECT_NUM);
1025 plat->reg_base = res_regs.start;
1026 plat->amba_base = res_mem.start;
1027 plat->amba_total_size = res_mem.end - res_mem.start + 1;
1028 plat->flash_num = flash_num;
1030 debug("%s: regs=<0x%llx> <0x%llx, 0x%llx>, max-frequency=%d, endianess=%s\n",
1032 (u64)plat->reg_base,
1033 (u64)plat->amba_base,
1034 (u64)plat->amba_total_size,
1036 plat->flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ? "be" : "le"
1042 static int fsl_qspi_xfer(struct udevice *dev, unsigned int bitlen,
1043 const void *dout, void *din, unsigned long flags)
1045 struct fsl_qspi_priv *priv;
1046 struct udevice *bus;
1049 priv = dev_get_priv(bus);
1051 return qspi_xfer(priv, bitlen, dout, din, flags);
1054 static int fsl_qspi_claim_bus(struct udevice *dev)
1056 struct fsl_qspi_priv *priv;
1057 struct udevice *bus;
1058 struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
1062 priv = dev_get_priv(bus);
1064 /* make sure controller is not busy anywhere */
1065 ret = is_controller_busy(priv);
1068 debug("ERROR : The controller is busy\n");
1072 priv->cur_amba_base = priv->amba_base[slave_plat->cs];
1074 qspi_module_disable(priv, 0);
1079 static int fsl_qspi_release_bus(struct udevice *dev)
1081 struct fsl_qspi_priv *priv;
1082 struct udevice *bus;
1085 priv = dev_get_priv(bus);
1087 qspi_module_disable(priv, 1);
1092 static int fsl_qspi_set_speed(struct udevice *bus, uint speed)
1098 static int fsl_qspi_set_mode(struct udevice *bus, uint mode)
1104 static const struct dm_spi_ops fsl_qspi_ops = {
1105 .claim_bus = fsl_qspi_claim_bus,
1106 .release_bus = fsl_qspi_release_bus,
1107 .xfer = fsl_qspi_xfer,
1108 .set_speed = fsl_qspi_set_speed,
1109 .set_mode = fsl_qspi_set_mode,
1112 static const struct udevice_id fsl_qspi_ids[] = {
1113 { .compatible = "fsl,vf610-qspi" },
1114 { .compatible = "fsl,imx6sx-qspi" },
1115 { .compatible = "fsl,imx6ul-qspi" },
1116 { .compatible = "fsl,imx7d-qspi" },
1120 U_BOOT_DRIVER(fsl_qspi) = {
1123 .of_match = fsl_qspi_ids,
1124 .ops = &fsl_qspi_ops,
1125 .ofdata_to_platdata = fsl_qspi_ofdata_to_platdata,
1126 .platdata_auto_alloc_size = sizeof(struct fsl_qspi_platdata),
1127 .priv_auto_alloc_size = sizeof(struct fsl_qspi_priv),
1128 .probe = fsl_qspi_probe,
1129 .child_pre_probe = fsl_qspi_child_pre_probe,