2 * Copyright 2013-2015 Freescale Semiconductor, Inc.
4 * Freescale Quad Serial Peripheral Interface (QSPI) driver
6 * SPDX-License-Identifier: GPL-2.0+
13 #include <linux/sizes.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
90 * struct fsl_qspi_platdata - platform data for Freescale QSPI
92 * @flags: Flags for QSPI QSPI_FLAG_...
93 * @speed_hz: Default SCK frequency
94 * @reg_base: Base address of QSPI registers
95 * @amba_base: Base address of QSPI memory mapping
96 * @amba_total_size: size of QSPI memory mapping
97 * @flash_num: Number of active slave devices
98 * @num_chipselect: Number of QSPI chipselect signals
100 struct fsl_qspi_platdata {
104 fdt_addr_t amba_base;
105 fdt_size_t amba_total_size;
112 * struct fsl_qspi_priv - private data for Freescale QSPI
114 * @flags: Flags for QSPI QSPI_FLAG_...
115 * @bus_clk: QSPI input clk frequency
116 * @speed_hz: Default SCK frequency
117 * @cur_seqid: current LUT table sequence id
118 * @sf_addr: flash access offset
119 * @amba_base: Base address of QSPI memory mapping of every CS
120 * @amba_total_size: size of QSPI memory mapping
121 * @cur_amba_base: Base address of QSPI memory mapping of current CS
122 * @flash_num: Number of active slave devices
123 * @num_chipselect: Number of QSPI chipselect signals
124 * @regs: Point to QSPI register structure for I/O access
126 struct fsl_qspi_priv {
132 u32 amba_base[FSL_QSPI_MAX_CHIPSELECT_NUM];
137 struct fsl_qspi_regs *regs;
140 #ifndef CONFIG_DM_SPI
142 struct spi_slave slave;
143 struct fsl_qspi_priv priv;
147 static u32 qspi_read32(u32 flags, u32 *addr)
149 return flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ?
150 in_be32(addr) : in_le32(addr);
153 static void qspi_write32(u32 flags, u32 *addr, u32 val)
155 flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ?
156 out_be32(addr, val) : out_le32(addr, val);
159 /* QSPI support swapping the flash read/write data
160 * in hardware for LS102xA, but not for VF610 */
161 static inline u32 qspi_endian_xchg(u32 data)
170 static void qspi_set_lut(struct fsl_qspi_priv *priv)
172 struct fsl_qspi_regs *regs = priv->regs;
176 qspi_write32(priv->flags, ®s->lutkey, LUT_KEY_VALUE);
177 qspi_write32(priv->flags, ®s->lckcr, QSPI_LCKCR_UNLOCK);
180 lut_base = SEQID_WREN * 4;
181 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_WREN) |
182 PAD0(LUT_PAD1) | INSTR0(LUT_CMD));
183 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
184 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
185 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
188 lut_base = SEQID_FAST_READ * 4;
189 #ifdef CONFIG_SPI_FLASH_BAR
190 qspi_write32(priv->flags, ®s->lut[lut_base],
191 OPRND0(QSPI_CMD_FAST_READ) | PAD0(LUT_PAD1) |
192 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
193 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
195 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
196 qspi_write32(priv->flags, ®s->lut[lut_base],
197 OPRND0(QSPI_CMD_FAST_READ) | PAD0(LUT_PAD1) |
198 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
199 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
201 qspi_write32(priv->flags, ®s->lut[lut_base],
202 OPRND0(QSPI_CMD_FAST_READ_4B) |
203 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) |
204 OPRND1(ADDR32BIT) | PAD1(LUT_PAD1) |
207 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
208 OPRND0(8) | PAD0(LUT_PAD1) | INSTR0(LUT_DUMMY) |
209 OPRND1(RX_BUFFER_SIZE) | PAD1(LUT_PAD1) |
211 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
212 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
215 lut_base = SEQID_RDSR * 4;
216 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDSR) |
217 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
218 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
219 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
220 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
221 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
224 lut_base = SEQID_SE * 4;
225 #ifdef CONFIG_SPI_FLASH_BAR
226 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_SE) |
227 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
228 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
230 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
231 qspi_write32(priv->flags, ®s->lut[lut_base],
232 OPRND0(QSPI_CMD_SE) | PAD0(LUT_PAD1) |
233 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
234 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
236 qspi_write32(priv->flags, ®s->lut[lut_base],
237 OPRND0(QSPI_CMD_SE_4B) | PAD0(LUT_PAD1) |
238 INSTR0(LUT_CMD) | OPRND1(ADDR32BIT) |
239 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
241 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
242 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
243 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
245 /* Erase the whole chip */
246 lut_base = SEQID_CHIP_ERASE * 4;
247 qspi_write32(priv->flags, ®s->lut[lut_base],
248 OPRND0(QSPI_CMD_CHIP_ERASE) |
249 PAD0(LUT_PAD1) | INSTR0(LUT_CMD));
250 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
251 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
252 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
255 lut_base = SEQID_PP * 4;
256 #ifdef CONFIG_SPI_FLASH_BAR
257 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_PP) |
258 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
259 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
261 if (FSL_QSPI_FLASH_SIZE <= SZ_16M)
262 qspi_write32(priv->flags, ®s->lut[lut_base],
263 OPRND0(QSPI_CMD_PP) | PAD0(LUT_PAD1) |
264 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
265 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
267 qspi_write32(priv->flags, ®s->lut[lut_base],
268 OPRND0(QSPI_CMD_PP_4B) | PAD0(LUT_PAD1) |
269 INSTR0(LUT_CMD) | OPRND1(ADDR32BIT) |
270 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
272 #if defined(CONFIG_MX6SX) || defined(CONFIG_MX6UL) || \
273 defined(CONFIG_MX6ULL) || defined(CONFIG_MX7D)
275 * To MX6SX, OPRND0(TX_BUFFER_SIZE) can not work correctly.
276 * So, Use IDATSZ in IPCR to determine the size and here set 0.
278 qspi_write32(priv->flags, ®s->lut[lut_base + 1], OPRND0(0) |
279 PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
281 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
282 OPRND0(TX_BUFFER_SIZE) |
283 PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
285 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
286 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
289 lut_base = SEQID_RDID * 4;
290 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDID) |
291 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(8) |
292 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
293 qspi_write32(priv->flags, ®s->lut[lut_base + 1], 0);
294 qspi_write32(priv->flags, ®s->lut[lut_base + 2], 0);
295 qspi_write32(priv->flags, ®s->lut[lut_base + 3], 0);
297 /* SUB SECTOR 4K ERASE */
298 lut_base = SEQID_BE_4K * 4;
299 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BE_4K) |
300 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
301 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
303 #ifdef CONFIG_SPI_FLASH_BAR
305 * BRRD BRWR RDEAR WREAR are all supported, because it is hard to
306 * dynamically check whether to set BRRD BRWR or RDEAR WREAR during
309 lut_base = SEQID_BRRD * 4;
310 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BRRD) |
311 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
312 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
314 lut_base = SEQID_BRWR * 4;
315 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_BRWR) |
316 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
317 PAD1(LUT_PAD1) | INSTR1(LUT_WRITE));
319 lut_base = SEQID_RDEAR * 4;
320 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_RDEAR) |
321 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
322 PAD1(LUT_PAD1) | INSTR1(LUT_READ));
324 lut_base = SEQID_WREAR * 4;
325 qspi_write32(priv->flags, ®s->lut[lut_base], OPRND0(QSPI_CMD_WREAR) |
326 PAD0(LUT_PAD1) | INSTR0(LUT_CMD) | OPRND1(1) |
327 PAD1(LUT_PAD1) | INSTR1(LUT_WRITE));
331 * Read any device register.
332 * Used for Spansion S25FS-S family flash only.
334 lut_base = SEQID_RDAR * 4;
335 qspi_write32(priv->flags, ®s->lut[lut_base],
336 OPRND0(QSPI_CMD_RDAR) | PAD0(LUT_PAD1) |
337 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
338 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
339 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
340 OPRND0(8) | PAD0(LUT_PAD1) | INSTR0(LUT_DUMMY) |
341 OPRND1(1) | PAD1(LUT_PAD1) |
345 * Write any device register.
346 * Used for Spansion S25FS-S family flash only.
348 lut_base = SEQID_WRAR * 4;
349 qspi_write32(priv->flags, ®s->lut[lut_base],
350 OPRND0(QSPI_CMD_WRAR) | PAD0(LUT_PAD1) |
351 INSTR0(LUT_CMD) | OPRND1(ADDR24BIT) |
352 PAD1(LUT_PAD1) | INSTR1(LUT_ADDR));
353 qspi_write32(priv->flags, ®s->lut[lut_base + 1],
354 OPRND0(1) | PAD0(LUT_PAD1) | INSTR0(LUT_WRITE));
357 qspi_write32(priv->flags, ®s->lutkey, LUT_KEY_VALUE);
358 qspi_write32(priv->flags, ®s->lckcr, QSPI_LCKCR_LOCK);
361 #if defined(CONFIG_SYS_FSL_QSPI_AHB)
363 * If we have changed the content of the flash by writing or erasing,
364 * we need to invalidate the AHB buffer. If we do not do so, we may read out
365 * the wrong data. The spec tells us reset the AHB domain and Serial Flash
366 * domain at the same time.
368 static inline void qspi_ahb_invalid(struct fsl_qspi_priv *priv)
370 struct fsl_qspi_regs *regs = priv->regs;
373 reg = qspi_read32(priv->flags, ®s->mcr);
374 reg |= QSPI_MCR_SWRSTHD_MASK | QSPI_MCR_SWRSTSD_MASK;
375 qspi_write32(priv->flags, ®s->mcr, reg);
378 * The minimum delay : 1 AHB + 2 SFCK clocks.
379 * Delay 1 us is enough.
383 reg &= ~(QSPI_MCR_SWRSTHD_MASK | QSPI_MCR_SWRSTSD_MASK);
384 qspi_write32(priv->flags, ®s->mcr, reg);
387 /* Read out the data from the AHB buffer. */
388 static inline void qspi_ahb_read(struct fsl_qspi_priv *priv, u8 *rxbuf, int len)
390 struct fsl_qspi_regs *regs = priv->regs;
392 void *rx_addr = NULL;
394 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
396 qspi_write32(priv->flags, ®s->mcr,
397 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
398 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
400 rx_addr = (void *)(uintptr_t)(priv->cur_amba_base + priv->sf_addr);
401 /* Read out the data directly from the AHB buffer. */
402 memcpy(rxbuf, rx_addr, len);
404 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
407 static void qspi_enable_ddr_mode(struct fsl_qspi_priv *priv)
410 struct fsl_qspi_regs *regs = priv->regs;
412 reg = qspi_read32(priv->flags, ®s->mcr);
413 /* Disable the module */
414 qspi_write32(priv->flags, ®s->mcr, reg | QSPI_MCR_MDIS_MASK);
416 /* Set the Sampling Register for DDR */
417 reg2 = qspi_read32(priv->flags, ®s->smpr);
418 reg2 &= ~QSPI_SMPR_DDRSMP_MASK;
419 reg2 |= (2 << QSPI_SMPR_DDRSMP_SHIFT);
420 qspi_write32(priv->flags, ®s->smpr, reg2);
422 /* Enable the module again (enable the DDR too) */
423 reg |= QSPI_MCR_DDR_EN_MASK;
424 /* Enable bit 29 for imx6sx */
427 qspi_write32(priv->flags, ®s->mcr, reg);
431 * There are two different ways to read out the data from the flash:
432 * the "IP Command Read" and the "AHB Command Read".
434 * The IC guy suggests we use the "AHB Command Read" which is faster
435 * then the "IP Command Read". (What's more is that there is a bug in
436 * the "IP Command Read" in the Vybrid.)
438 * After we set up the registers for the "AHB Command Read", we can use
439 * the memcpy to read the data directly. A "missed" access to the buffer
440 * causes the controller to clear the buffer, and use the sequence pointed
441 * by the QUADSPI_BFGENCR[SEQID] to initiate a read from the flash.
443 static void qspi_init_ahb_read(struct fsl_qspi_priv *priv)
445 struct fsl_qspi_regs *regs = priv->regs;
447 /* AHB configuration for access buffer 0/1/2 .*/
448 qspi_write32(priv->flags, ®s->buf0cr, QSPI_BUFXCR_INVALID_MSTRID);
449 qspi_write32(priv->flags, ®s->buf1cr, QSPI_BUFXCR_INVALID_MSTRID);
450 qspi_write32(priv->flags, ®s->buf2cr, QSPI_BUFXCR_INVALID_MSTRID);
451 qspi_write32(priv->flags, ®s->buf3cr, QSPI_BUF3CR_ALLMST_MASK |
452 (0x80 << QSPI_BUF3CR_ADATSZ_SHIFT));
454 /* We only use the buffer3 */
455 qspi_write32(priv->flags, ®s->buf0ind, 0);
456 qspi_write32(priv->flags, ®s->buf1ind, 0);
457 qspi_write32(priv->flags, ®s->buf2ind, 0);
460 * Set the default lut sequence for AHB Read.
461 * Parallel mode is disabled.
463 qspi_write32(priv->flags, ®s->bfgencr,
464 SEQID_FAST_READ << QSPI_BFGENCR_SEQID_SHIFT);
467 qspi_enable_ddr_mode(priv);
471 #ifdef CONFIG_SPI_FLASH_BAR
472 /* Bank register read/write, EAR register read/write */
473 static void qspi_op_rdbank(struct fsl_qspi_priv *priv, u8 *rxbuf, u32 len)
475 struct fsl_qspi_regs *regs = priv->regs;
476 u32 reg, mcr_reg, data, seqid;
478 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
479 qspi_write32(priv->flags, ®s->mcr,
480 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
481 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
482 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
484 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
486 if (priv->cur_seqid == QSPI_CMD_BRRD)
491 qspi_write32(priv->flags, ®s->ipcr,
492 (seqid << QSPI_IPCR_SEQID_SHIFT) | len);
494 /* Wait previous command complete */
495 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
501 reg = qspi_read32(priv->flags, ®s->rbsr);
502 if (reg & QSPI_RBSR_RDBFL_MASK) {
503 data = qspi_read32(priv->flags, ®s->rbdr[0]);
504 data = qspi_endian_xchg(data);
505 memcpy(rxbuf, &data, len);
506 qspi_write32(priv->flags, ®s->mcr,
507 qspi_read32(priv->flags, ®s->mcr) |
508 QSPI_MCR_CLR_RXF_MASK);
513 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
517 static void qspi_op_rdid(struct fsl_qspi_priv *priv, u32 *rxbuf, u32 len)
519 struct fsl_qspi_regs *regs = priv->regs;
520 u32 mcr_reg, rbsr_reg, data, size;
523 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
524 qspi_write32(priv->flags, ®s->mcr,
525 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
526 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
527 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
529 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
531 qspi_write32(priv->flags, ®s->ipcr,
532 (SEQID_RDID << QSPI_IPCR_SEQID_SHIFT) | 0);
533 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
537 while ((RX_BUFFER_SIZE >= len) && (len > 0)) {
540 rbsr_reg = qspi_read32(priv->flags, ®s->rbsr);
541 if (rbsr_reg & QSPI_RBSR_RDBFL_MASK) {
542 data = qspi_read32(priv->flags, ®s->rbdr[i]);
543 data = qspi_endian_xchg(data);
544 size = (len < 4) ? len : 4;
545 memcpy(rxbuf, &data, size);
552 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
555 /* If not use AHB read, read data from ip interface */
556 static void qspi_op_read(struct fsl_qspi_priv *priv, u32 *rxbuf, u32 len)
558 struct fsl_qspi_regs *regs = priv->regs;
564 if (priv->cur_seqid == QSPI_CMD_RDAR)
567 seqid = SEQID_FAST_READ;
569 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
570 qspi_write32(priv->flags, ®s->mcr,
571 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
572 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
573 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
575 to_or_from = priv->sf_addr + priv->cur_amba_base;
580 qspi_write32(priv->flags, ®s->sfar, to_or_from);
582 size = (len > RX_BUFFER_SIZE) ?
583 RX_BUFFER_SIZE : len;
585 qspi_write32(priv->flags, ®s->ipcr,
586 (seqid << QSPI_IPCR_SEQID_SHIFT) |
588 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
595 while ((RX_BUFFER_SIZE >= size) && (size > 0)) {
596 data = qspi_read32(priv->flags, ®s->rbdr[i]);
597 data = qspi_endian_xchg(data);
599 memcpy(rxbuf, &data, size);
601 memcpy(rxbuf, &data, 4);
606 qspi_write32(priv->flags, ®s->mcr,
607 qspi_read32(priv->flags, ®s->mcr) |
608 QSPI_MCR_CLR_RXF_MASK);
611 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
614 static void qspi_op_write(struct fsl_qspi_priv *priv, u8 *txbuf, u32 len)
616 struct fsl_qspi_regs *regs = priv->regs;
617 u32 mcr_reg, data, reg, status_reg, seqid;
618 int i, size, tx_size;
621 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
622 qspi_write32(priv->flags, ®s->mcr,
623 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
624 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
625 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
628 while ((status_reg & FLASH_STATUS_WEL) != FLASH_STATUS_WEL) {
631 qspi_write32(priv->flags, ®s->ipcr,
632 (SEQID_WREN << QSPI_IPCR_SEQID_SHIFT) | 0);
633 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
636 qspi_write32(priv->flags, ®s->ipcr,
637 (SEQID_RDSR << QSPI_IPCR_SEQID_SHIFT) | 1);
638 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
641 reg = qspi_read32(priv->flags, ®s->rbsr);
642 if (reg & QSPI_RBSR_RDBFL_MASK) {
643 status_reg = qspi_read32(priv->flags, ®s->rbdr[0]);
644 status_reg = qspi_endian_xchg(status_reg);
646 qspi_write32(priv->flags, ®s->mcr,
647 qspi_read32(priv->flags, ®s->mcr) |
648 QSPI_MCR_CLR_RXF_MASK);
651 /* Default is page programming */
653 if (priv->cur_seqid == QSPI_CMD_WRAR)
655 #ifdef CONFIG_SPI_FLASH_BAR
656 if (priv->cur_seqid == QSPI_CMD_BRWR)
658 else if (priv->cur_seqid == QSPI_CMD_WREAR)
662 to_or_from = priv->sf_addr + priv->cur_amba_base;
664 qspi_write32(priv->flags, ®s->sfar, to_or_from);
666 tx_size = (len > TX_BUFFER_SIZE) ?
667 TX_BUFFER_SIZE : len;
671 * There must be atleast 128bit data
672 * available in TX FIFO for any pop operation
676 for (i = 0; i < size * 4; i++) {
677 memcpy(&data, txbuf, 4);
678 data = qspi_endian_xchg(data);
679 qspi_write32(priv->flags, ®s->tbdr, data);
683 qspi_write32(priv->flags, ®s->ipcr,
684 (seqid << QSPI_IPCR_SEQID_SHIFT) | tx_size);
685 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
688 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
691 static void qspi_op_rdsr(struct fsl_qspi_priv *priv, void *rxbuf, u32 len)
693 struct fsl_qspi_regs *regs = priv->regs;
694 u32 mcr_reg, reg, data;
696 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
697 qspi_write32(priv->flags, ®s->mcr,
698 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
699 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
700 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
702 qspi_write32(priv->flags, ®s->sfar, priv->cur_amba_base);
704 qspi_write32(priv->flags, ®s->ipcr,
705 (SEQID_RDSR << QSPI_IPCR_SEQID_SHIFT) | 0);
706 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
712 reg = qspi_read32(priv->flags, ®s->rbsr);
713 if (reg & QSPI_RBSR_RDBFL_MASK) {
714 data = qspi_read32(priv->flags, ®s->rbdr[0]);
715 data = qspi_endian_xchg(data);
716 memcpy(rxbuf, &data, len);
717 qspi_write32(priv->flags, ®s->mcr,
718 qspi_read32(priv->flags, ®s->mcr) |
719 QSPI_MCR_CLR_RXF_MASK);
724 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
727 static void qspi_op_erase(struct fsl_qspi_priv *priv)
729 struct fsl_qspi_regs *regs = priv->regs;
733 mcr_reg = qspi_read32(priv->flags, ®s->mcr);
734 qspi_write32(priv->flags, ®s->mcr,
735 QSPI_MCR_CLR_RXF_MASK | QSPI_MCR_CLR_TXF_MASK |
736 QSPI_MCR_RESERVED_MASK | QSPI_MCR_END_CFD_LE);
737 qspi_write32(priv->flags, ®s->rbct, QSPI_RBCT_RXBRD_USEIPS);
739 to_or_from = priv->sf_addr + priv->cur_amba_base;
740 qspi_write32(priv->flags, ®s->sfar, to_or_from);
742 qspi_write32(priv->flags, ®s->ipcr,
743 (SEQID_WREN << QSPI_IPCR_SEQID_SHIFT) | 0);
744 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
747 if (priv->cur_seqid == QSPI_CMD_SE) {
748 qspi_write32(priv->flags, ®s->ipcr,
749 (SEQID_SE << QSPI_IPCR_SEQID_SHIFT) | 0);
750 } else if (priv->cur_seqid == QSPI_CMD_BE_4K) {
751 qspi_write32(priv->flags, ®s->ipcr,
752 (SEQID_BE_4K << QSPI_IPCR_SEQID_SHIFT) | 0);
754 while (qspi_read32(priv->flags, ®s->sr) & QSPI_SR_BUSY_MASK)
757 qspi_write32(priv->flags, ®s->mcr, mcr_reg);
760 int qspi_xfer(struct fsl_qspi_priv *priv, unsigned int bitlen,
761 const void *dout, void *din, unsigned long flags)
763 u32 bytes = DIV_ROUND_UP(bitlen, 8);
764 static u32 wr_sfaddr;
770 if (flags & SPI_XFER_BEGIN) {
771 priv->cur_seqid = *(u8 *)dout;
772 memcpy(&txbuf, dout, 4);
775 if (flags == SPI_XFER_END) {
776 priv->sf_addr = wr_sfaddr;
777 qspi_op_write(priv, (u8 *)dout, bytes);
781 if (priv->cur_seqid == QSPI_CMD_FAST_READ ||
782 priv->cur_seqid == QSPI_CMD_RDAR) {
783 priv->sf_addr = swab32(txbuf) & OFFSET_BITS_MASK;
784 } else if ((priv->cur_seqid == QSPI_CMD_SE) ||
785 (priv->cur_seqid == QSPI_CMD_BE_4K)) {
786 priv->sf_addr = swab32(txbuf) & OFFSET_BITS_MASK;
788 } else if (priv->cur_seqid == QSPI_CMD_PP ||
789 priv->cur_seqid == QSPI_CMD_WRAR) {
790 wr_sfaddr = swab32(txbuf) & OFFSET_BITS_MASK;
791 } else if ((priv->cur_seqid == QSPI_CMD_BRWR) ||
792 (priv->cur_seqid == QSPI_CMD_WREAR)) {
793 #ifdef CONFIG_SPI_FLASH_BAR
800 if (priv->cur_seqid == QSPI_CMD_FAST_READ) {
801 #ifdef CONFIG_SYS_FSL_QSPI_AHB
802 qspi_ahb_read(priv, din, bytes);
804 qspi_op_read(priv, din, bytes);
806 } else if (priv->cur_seqid == QSPI_CMD_RDAR) {
807 qspi_op_read(priv, din, bytes);
808 } else if (priv->cur_seqid == QSPI_CMD_RDID)
809 qspi_op_rdid(priv, din, bytes);
810 else if (priv->cur_seqid == QSPI_CMD_RDSR)
811 qspi_op_rdsr(priv, din, bytes);
812 #ifdef CONFIG_SPI_FLASH_BAR
813 else if ((priv->cur_seqid == QSPI_CMD_BRRD) ||
814 (priv->cur_seqid == QSPI_CMD_RDEAR)) {
816 qspi_op_rdbank(priv, din, bytes);
821 #ifdef CONFIG_SYS_FSL_QSPI_AHB
822 if ((priv->cur_seqid == QSPI_CMD_SE) ||
823 (priv->cur_seqid == QSPI_CMD_PP) ||
824 (priv->cur_seqid == QSPI_CMD_BE_4K) ||
825 (priv->cur_seqid == QSPI_CMD_WREAR) ||
826 (priv->cur_seqid == QSPI_CMD_BRWR))
827 qspi_ahb_invalid(priv);
833 void qspi_module_disable(struct fsl_qspi_priv *priv, u8 disable)
837 mcr_val = qspi_read32(priv->flags, &priv->regs->mcr);
839 mcr_val |= QSPI_MCR_MDIS_MASK;
841 mcr_val &= ~QSPI_MCR_MDIS_MASK;
842 qspi_write32(priv->flags, &priv->regs->mcr, mcr_val);
845 void qspi_cfg_smpr(struct fsl_qspi_priv *priv, u32 clear_bits, u32 set_bits)
849 smpr_val = qspi_read32(priv->flags, &priv->regs->smpr);
850 smpr_val &= ~clear_bits;
851 smpr_val |= set_bits;
852 qspi_write32(priv->flags, &priv->regs->smpr, smpr_val);
854 #ifndef CONFIG_DM_SPI
855 static unsigned long spi_bases[] = {
862 static unsigned long amba_bases[] = {
869 static inline struct fsl_qspi *to_qspi_spi(struct spi_slave *slave)
871 return container_of(slave, struct fsl_qspi, slave);
874 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
875 unsigned int max_hz, unsigned int mode)
878 struct fsl_qspi *qspi;
879 struct fsl_qspi_regs *regs;
882 if (bus >= ARRAY_SIZE(spi_bases))
885 if (cs >= FSL_QSPI_FLASH_NUM)
888 qspi = spi_alloc_slave(struct fsl_qspi, bus, cs);
892 #ifdef CONFIG_SYS_FSL_QSPI_BE
893 qspi->priv.flags |= QSPI_FLAG_REGMAP_ENDIAN_BIG;
896 regs = (struct fsl_qspi_regs *)spi_bases[bus];
897 qspi->priv.regs = regs;
899 * According cs, use different amba_base to choose the
900 * corresponding flash devices.
902 * If not, only one flash device is used even if passing
903 * different cs using `sf probe`
905 qspi->priv.cur_amba_base = amba_bases[bus] + cs * FSL_QSPI_FLASH_SIZE;
907 qspi->slave.max_write_size = TX_BUFFER_SIZE;
909 mcr_val = qspi_read32(qspi->priv.flags, ®s->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(qspi->priv.flags, ®s->mcr,
916 QSPI_MCR_RESERVED_MASK | QSPI_MCR_MDIS_MASK |
917 (mcr_val & QSPI_MCR_END_CFD_MASK));
919 qspi_cfg_smpr(&qspi->priv,
920 ~(QSPI_SMPR_FSDLY_MASK | QSPI_SMPR_DDRSMP_MASK |
921 QSPI_SMPR_FSPHS_MASK | QSPI_SMPR_HSENA_MASK), 0);
923 total_size = FSL_QSPI_FLASH_SIZE * FSL_QSPI_FLASH_NUM;
925 * Any read access to non-implemented addresses will provide
928 * In case single die flash devices, TOP_ADDR_MEMA2 and
929 * TOP_ADDR_MEMB2 should be initialized/programmed to
930 * TOP_ADDR_MEMA1 and TOP_ADDR_MEMB1 respectively - in effect,
931 * setting the size of these devices to 0. This would ensure
932 * that the complete memory map is assigned to only one flash device.
934 qspi_write32(qspi->priv.flags, ®s->sfa1ad,
935 FSL_QSPI_FLASH_SIZE | amba_bases[bus]);
936 qspi_write32(qspi->priv.flags, ®s->sfa2ad,
937 FSL_QSPI_FLASH_SIZE | amba_bases[bus]);
938 qspi_write32(qspi->priv.flags, ®s->sfb1ad,
939 total_size | amba_bases[bus]);
940 qspi_write32(qspi->priv.flags, ®s->sfb2ad,
941 total_size | amba_bases[bus]);
943 qspi_set_lut(&qspi->priv);
945 #ifdef CONFIG_SYS_FSL_QSPI_AHB
946 qspi_init_ahb_read(&qspi->priv);
949 qspi_module_disable(&qspi->priv, 0);
954 void spi_free_slave(struct spi_slave *slave)
956 struct fsl_qspi *qspi = to_qspi_spi(slave);
961 int spi_claim_bus(struct spi_slave *slave)
966 void spi_release_bus(struct spi_slave *slave)
971 int spi_xfer(struct spi_slave *slave, unsigned int bitlen,
972 const void *dout, void *din, unsigned long flags)
974 struct fsl_qspi *qspi = to_qspi_spi(slave);
976 return qspi_xfer(&qspi->priv, bitlen, dout, din, flags);
984 static int fsl_qspi_child_pre_probe(struct udevice *dev)
986 struct spi_slave *slave = dev_get_parent_priv(dev);
988 slave->max_write_size = TX_BUFFER_SIZE;
993 static int fsl_qspi_probe(struct udevice *bus)
996 u32 amba_size_per_chip;
997 struct fsl_qspi_platdata *plat = dev_get_platdata(bus);
998 struct fsl_qspi_priv *priv = dev_get_priv(bus);
999 struct dm_spi_bus *dm_spi_bus;
1002 dm_spi_bus = bus->uclass_priv;
1004 dm_spi_bus->max_hz = plat->speed_hz;
1006 priv->regs = (struct fsl_qspi_regs *)(uintptr_t)plat->reg_base;
1007 priv->flags = plat->flags;
1009 priv->speed_hz = plat->speed_hz;
1011 * QSPI SFADR width is 32bits, the max dest addr is 4GB-1.
1012 * AMBA memory zone should be located on the 0~4GB space
1013 * even on a 64bits cpu.
1015 priv->amba_base[0] = (u32)plat->amba_base;
1016 priv->amba_total_size = (u32)plat->amba_total_size;
1017 priv->flash_num = plat->flash_num;
1018 priv->num_chipselect = plat->num_chipselect;
1020 /* make sure controller is not busy anywhere */
1021 ret = wait_for_bit(__func__, &priv->regs->sr,
1023 QSPI_SR_AHB_ACC_MASK |
1024 QSPI_SR_IP_ACC_MASK,
1028 debug("ERROR : The controller is busy\n");
1032 mcr_val = qspi_read32(priv->flags, &priv->regs->mcr);
1034 /* Set endianness to LE for i.mx */
1035 if (IS_ENABLED(CONFIG_MX6) || IS_ENABLED(CONFIG_MX7))
1036 mcr_val = QSPI_MCR_END_CFD_LE;
1038 qspi_write32(priv->flags, &priv->regs->mcr,
1039 QSPI_MCR_RESERVED_MASK | QSPI_MCR_MDIS_MASK |
1040 (mcr_val & QSPI_MCR_END_CFD_MASK));
1042 qspi_cfg_smpr(priv, ~(QSPI_SMPR_FSDLY_MASK | QSPI_SMPR_DDRSMP_MASK |
1043 QSPI_SMPR_FSPHS_MASK | QSPI_SMPR_HSENA_MASK), 0);
1046 * Assign AMBA memory zone for every chipselect
1047 * QuadSPI has two channels, every channel has two chipselects.
1048 * If the property 'num-cs' in dts is 2, the AMBA memory will be divided
1049 * into two parts and assign to every channel. This indicate that every
1050 * channel only has one valid chipselect.
1051 * If the property 'num-cs' in dts is 4, the AMBA memory will be divided
1052 * into four parts and assign to every chipselect.
1053 * Every channel will has two valid chipselects.
1055 amba_size_per_chip = priv->amba_total_size >>
1056 (priv->num_chipselect >> 1);
1057 for (i = 1 ; i < priv->num_chipselect ; i++)
1058 priv->amba_base[i] =
1059 amba_size_per_chip + priv->amba_base[i - 1];
1062 * Any read access to non-implemented addresses will provide
1063 * undefined results.
1065 * In case single die flash devices, TOP_ADDR_MEMA2 and
1066 * TOP_ADDR_MEMB2 should be initialized/programmed to
1067 * TOP_ADDR_MEMA1 and TOP_ADDR_MEMB1 respectively - in effect,
1068 * setting the size of these devices to 0. This would ensure
1069 * that the complete memory map is assigned to only one flash device.
1071 qspi_write32(priv->flags, &priv->regs->sfa1ad,
1072 priv->amba_base[0] + amba_size_per_chip);
1073 switch (priv->num_chipselect) {
1077 qspi_write32(priv->flags, &priv->regs->sfa2ad,
1078 priv->amba_base[1]);
1079 qspi_write32(priv->flags, &priv->regs->sfb1ad,
1080 priv->amba_base[1] + amba_size_per_chip);
1081 qspi_write32(priv->flags, &priv->regs->sfb2ad,
1082 priv->amba_base[1] + amba_size_per_chip);
1085 qspi_write32(priv->flags, &priv->regs->sfa2ad,
1086 priv->amba_base[2]);
1087 qspi_write32(priv->flags, &priv->regs->sfb1ad,
1088 priv->amba_base[3]);
1089 qspi_write32(priv->flags, &priv->regs->sfb2ad,
1090 priv->amba_base[3] + amba_size_per_chip);
1093 debug("Error: Unsupported chipselect number %u!\n",
1094 priv->num_chipselect);
1095 qspi_module_disable(priv, 1);
1101 #ifdef CONFIG_SYS_FSL_QSPI_AHB
1102 qspi_init_ahb_read(priv);
1105 qspi_module_disable(priv, 0);
1110 static int fsl_qspi_ofdata_to_platdata(struct udevice *bus)
1112 struct fdt_resource res_regs, res_mem;
1113 struct fsl_qspi_platdata *plat = bus->platdata;
1114 const void *blob = gd->fdt_blob;
1115 int node = dev_of_offset(bus);
1116 int ret, flash_num = 0, subnode;
1118 if (fdtdec_get_bool(blob, node, "big-endian"))
1119 plat->flags |= QSPI_FLAG_REGMAP_ENDIAN_BIG;
1121 ret = fdt_get_named_resource(blob, node, "reg", "reg-names",
1122 "QuadSPI", &res_regs);
1124 debug("Error: can't get regs base addresses(ret = %d)!\n", ret);
1127 ret = fdt_get_named_resource(blob, node, "reg", "reg-names",
1128 "QuadSPI-memory", &res_mem);
1130 debug("Error: can't get AMBA base addresses(ret = %d)!\n", ret);
1134 /* Count flash numbers */
1135 fdt_for_each_subnode(subnode, blob, node)
1138 if (flash_num == 0) {
1139 debug("Error: Missing flashes!\n");
1143 plat->speed_hz = fdtdec_get_int(blob, node, "spi-max-frequency",
1144 FSL_QSPI_DEFAULT_SCK_FREQ);
1145 plat->num_chipselect = fdtdec_get_int(blob, node, "num-cs",
1146 FSL_QSPI_MAX_CHIPSELECT_NUM);
1148 plat->reg_base = res_regs.start;
1149 plat->amba_base = res_mem.start;
1150 plat->amba_total_size = res_mem.end - res_mem.start + 1;
1151 plat->flash_num = flash_num;
1153 debug("%s: regs=<0x%llx> <0x%llx, 0x%llx>, max-frequency=%d, endianess=%s\n",
1155 (u64)plat->reg_base,
1156 (u64)plat->amba_base,
1157 (u64)plat->amba_total_size,
1159 plat->flags & QSPI_FLAG_REGMAP_ENDIAN_BIG ? "be" : "le"
1165 static int fsl_qspi_xfer(struct udevice *dev, unsigned int bitlen,
1166 const void *dout, void *din, unsigned long flags)
1168 struct fsl_qspi_priv *priv;
1169 struct udevice *bus;
1172 priv = dev_get_priv(bus);
1174 return qspi_xfer(priv, bitlen, dout, din, flags);
1177 static int fsl_qspi_claim_bus(struct udevice *dev)
1179 struct fsl_qspi_priv *priv;
1180 struct udevice *bus;
1181 struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
1185 priv = dev_get_priv(bus);
1187 /* make sure controller is not busy anywhere */
1188 ret = wait_for_bit(__func__, &priv->regs->sr,
1190 QSPI_SR_AHB_ACC_MASK |
1191 QSPI_SR_IP_ACC_MASK,
1195 debug("ERROR : The controller is busy\n");
1199 priv->cur_amba_base = priv->amba_base[slave_plat->cs];
1201 qspi_module_disable(priv, 0);
1206 static int fsl_qspi_release_bus(struct udevice *dev)
1208 struct fsl_qspi_priv *priv;
1209 struct udevice *bus;
1212 priv = dev_get_priv(bus);
1214 qspi_module_disable(priv, 1);
1219 static int fsl_qspi_set_speed(struct udevice *bus, uint speed)
1225 static int fsl_qspi_set_mode(struct udevice *bus, uint mode)
1231 static const struct dm_spi_ops fsl_qspi_ops = {
1232 .claim_bus = fsl_qspi_claim_bus,
1233 .release_bus = fsl_qspi_release_bus,
1234 .xfer = fsl_qspi_xfer,
1235 .set_speed = fsl_qspi_set_speed,
1236 .set_mode = fsl_qspi_set_mode,
1239 static const struct udevice_id fsl_qspi_ids[] = {
1240 { .compatible = "fsl,vf610-qspi" },
1241 { .compatible = "fsl,imx6sx-qspi" },
1242 { .compatible = "fsl,imx6ul-qspi" },
1243 { .compatible = "fsl,imx7d-qspi" },
1247 U_BOOT_DRIVER(fsl_qspi) = {
1250 .of_match = fsl_qspi_ids,
1251 .ops = &fsl_qspi_ops,
1252 .ofdata_to_platdata = fsl_qspi_ofdata_to_platdata,
1253 .platdata_auto_alloc_size = sizeof(struct fsl_qspi_platdata),
1254 .priv_auto_alloc_size = sizeof(struct fsl_qspi_priv),
1255 .probe = fsl_qspi_probe,
1256 .child_pre_probe = fsl_qspi_child_pre_probe,