1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2005, Intec Automation Inc.
4 * Copyright (C) 2014, Freescale Semiconductor, Inc.
7 #include <linux/bitfield.h>
8 #include <linux/device.h>
9 #include <linux/errno.h>
10 #include <linux/mtd/spi-nor.h>
14 /* flash_info mfr_flag. Used to clear sticky prorietary SR bits. */
15 #define USE_CLSR BIT(0)
16 #define USE_CLPEF BIT(1)
18 #define SPINOR_OP_CLSR 0x30 /* Clear status register 1 */
19 #define SPINOR_OP_CLPEF 0x82 /* Clear program/erase failure flags */
20 #define SPINOR_OP_RD_ANY_REG 0x65 /* Read any register */
21 #define SPINOR_OP_WR_ANY_REG 0x71 /* Write any register */
22 #define SPINOR_REG_CYPRESS_VREG 0x00800000
23 #define SPINOR_REG_CYPRESS_STR1 0x0
24 #define SPINOR_REG_CYPRESS_STR1V \
25 (SPINOR_REG_CYPRESS_VREG + SPINOR_REG_CYPRESS_STR1)
26 #define SPINOR_REG_CYPRESS_CFR1 0x2
27 #define SPINOR_REG_CYPRESS_CFR1_QUAD_EN BIT(1) /* Quad Enable */
28 #define SPINOR_REG_CYPRESS_CFR2 0x3
29 #define SPINOR_REG_CYPRESS_CFR2V \
30 (SPINOR_REG_CYPRESS_VREG + SPINOR_REG_CYPRESS_CFR2)
31 #define SPINOR_REG_CYPRESS_CFR2_MEMLAT_MASK GENMASK(3, 0)
32 #define SPINOR_REG_CYPRESS_CFR2_MEMLAT_11_24 0xb
33 #define SPINOR_REG_CYPRESS_CFR2_ADRBYT BIT(7)
34 #define SPINOR_REG_CYPRESS_CFR3 0x4
35 #define SPINOR_REG_CYPRESS_CFR3_PGSZ BIT(4) /* Page size. */
36 #define SPINOR_REG_CYPRESS_CFR5 0x6
37 #define SPINOR_REG_CYPRESS_CFR5_BIT6 BIT(6)
38 #define SPINOR_REG_CYPRESS_CFR5_DDR BIT(1)
39 #define SPINOR_REG_CYPRESS_CFR5_OPI BIT(0)
40 #define SPINOR_REG_CYPRESS_CFR5_OCT_DTR_EN \
41 (SPINOR_REG_CYPRESS_CFR5_BIT6 | SPINOR_REG_CYPRESS_CFR5_DDR | \
42 SPINOR_REG_CYPRESS_CFR5_OPI)
43 #define SPINOR_REG_CYPRESS_CFR5_OCT_DTR_DS SPINOR_REG_CYPRESS_CFR5_BIT6
44 #define SPINOR_OP_CYPRESS_RD_FAST 0xee
45 #define SPINOR_REG_CYPRESS_ARCFN 0x00000006
47 /* Cypress SPI NOR flash operations. */
48 #define CYPRESS_NOR_WR_ANY_REG_OP(naddr, addr, ndata, buf) \
49 SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_WR_ANY_REG, 0), \
50 SPI_MEM_OP_ADDR(naddr, addr, 0), \
51 SPI_MEM_OP_NO_DUMMY, \
52 SPI_MEM_OP_DATA_OUT(ndata, buf, 0))
54 #define CYPRESS_NOR_RD_ANY_REG_OP(naddr, addr, ndummy, buf) \
55 SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_RD_ANY_REG, 0), \
56 SPI_MEM_OP_ADDR(naddr, addr, 0), \
57 SPI_MEM_OP_DUMMY(ndummy, 0), \
58 SPI_MEM_OP_DATA_IN(1, buf, 0))
60 #define SPANSION_OP(opcode) \
61 SPI_MEM_OP(SPI_MEM_OP_CMD(opcode, 0), \
63 SPI_MEM_OP_NO_DUMMY, \
67 * struct spansion_nor_params - Spansion private parameters.
68 * @clsr: Clear Status Register or Clear Program and Erase Failure Flag
71 struct spansion_nor_params {
76 * spansion_nor_clear_sr() - Clear the Status Register.
77 * @nor: pointer to 'struct spi_nor'.
79 static void spansion_nor_clear_sr(struct spi_nor *nor)
81 const struct spansion_nor_params *priv_params = nor->params->priv;
85 struct spi_mem_op op = SPANSION_OP(priv_params->clsr);
87 spi_nor_spimem_setup_op(nor, &op, nor->reg_proto);
89 ret = spi_mem_exec_op(nor->spimem, &op);
91 ret = spi_nor_controller_ops_write_reg(nor, SPINOR_OP_CLSR,
96 dev_dbg(nor->dev, "error %d clearing SR\n", ret);
99 static int cypress_nor_sr_ready_and_clear_reg(struct spi_nor *nor, u64 addr)
101 struct spi_nor_flash_parameter *params = nor->params;
102 struct spi_mem_op op =
103 CYPRESS_NOR_RD_ANY_REG_OP(params->addr_mode_nbytes, addr,
107 if (nor->reg_proto == SNOR_PROTO_8_8_8_DTR) {
108 op.dummy.nbytes = params->rdsr_dummy;
112 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
116 if (nor->bouncebuf[0] & (SR_E_ERR | SR_P_ERR)) {
117 if (nor->bouncebuf[0] & SR_E_ERR)
118 dev_err(nor->dev, "Erase Error occurred\n");
120 dev_err(nor->dev, "Programming Error occurred\n");
122 spansion_nor_clear_sr(nor);
124 ret = spi_nor_write_disable(nor);
131 return !(nor->bouncebuf[0] & SR_WIP);
134 * cypress_nor_sr_ready_and_clear() - Query the Status Register of each die by
135 * using Read Any Register command to see if the whole flash is ready for new
136 * commands and clear it if there are any errors.
137 * @nor: pointer to 'struct spi_nor'.
139 * Return: 1 if ready, 0 if not ready, -errno on errors.
141 static int cypress_nor_sr_ready_and_clear(struct spi_nor *nor)
143 struct spi_nor_flash_parameter *params = nor->params;
148 for (i = 0; i < params->n_dice; i++) {
149 addr = params->vreg_offset[i] + SPINOR_REG_CYPRESS_STR1;
150 ret = cypress_nor_sr_ready_and_clear_reg(nor, addr);
160 static int cypress_nor_set_memlat(struct spi_nor *nor, u64 addr)
162 struct spi_mem_op op;
163 u8 *buf = nor->bouncebuf;
165 u8 addr_mode_nbytes = nor->params->addr_mode_nbytes;
167 op = (struct spi_mem_op)
168 CYPRESS_NOR_RD_ANY_REG_OP(addr_mode_nbytes, addr, 0, buf);
170 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
174 /* Use 24 dummy cycles for memory array reads. */
175 *buf &= ~SPINOR_REG_CYPRESS_CFR2_MEMLAT_MASK;
176 *buf |= FIELD_PREP(SPINOR_REG_CYPRESS_CFR2_MEMLAT_MASK,
177 SPINOR_REG_CYPRESS_CFR2_MEMLAT_11_24);
178 op = (struct spi_mem_op)
179 CYPRESS_NOR_WR_ANY_REG_OP(addr_mode_nbytes, addr, 1, buf);
181 ret = spi_nor_write_any_volatile_reg(nor, &op, nor->reg_proto);
185 nor->read_dummy = 24;
190 static int cypress_nor_set_octal_dtr_bits(struct spi_nor *nor, u64 addr)
192 struct spi_mem_op op;
193 u8 *buf = nor->bouncebuf;
195 /* Set the octal and DTR enable bits. */
196 buf[0] = SPINOR_REG_CYPRESS_CFR5_OCT_DTR_EN;
197 op = (struct spi_mem_op)
198 CYPRESS_NOR_WR_ANY_REG_OP(nor->params->addr_mode_nbytes,
201 return spi_nor_write_any_volatile_reg(nor, &op, nor->reg_proto);
204 static int cypress_nor_octal_dtr_en(struct spi_nor *nor)
206 const struct spi_nor_flash_parameter *params = nor->params;
207 u8 *buf = nor->bouncebuf;
211 for (i = 0; i < params->n_dice; i++) {
212 addr = params->vreg_offset[i] + SPINOR_REG_CYPRESS_CFR2;
213 ret = cypress_nor_set_memlat(nor, addr);
217 addr = params->vreg_offset[i] + SPINOR_REG_CYPRESS_CFR5;
218 ret = cypress_nor_set_octal_dtr_bits(nor, addr);
223 /* Read flash ID to make sure the switch was successful. */
224 ret = spi_nor_read_id(nor, nor->addr_nbytes, 3, buf,
225 SNOR_PROTO_8_8_8_DTR);
227 dev_dbg(nor->dev, "error %d reading JEDEC ID after enabling 8D-8D-8D mode\n", ret);
231 if (memcmp(buf, nor->info->id->bytes, nor->info->id->len))
237 static int cypress_nor_set_single_spi_bits(struct spi_nor *nor, u64 addr)
239 struct spi_mem_op op;
240 u8 *buf = nor->bouncebuf;
243 * The register is 1-byte wide, but 1-byte transactions are not allowed
244 * in 8D-8D-8D mode. Since there is no register at the next location,
245 * just initialize the value to 0 and let the transaction go on.
247 buf[0] = SPINOR_REG_CYPRESS_CFR5_OCT_DTR_DS;
249 op = (struct spi_mem_op)
250 CYPRESS_NOR_WR_ANY_REG_OP(nor->addr_nbytes, addr, 2, buf);
251 return spi_nor_write_any_volatile_reg(nor, &op, SNOR_PROTO_8_8_8_DTR);
254 static int cypress_nor_octal_dtr_dis(struct spi_nor *nor)
256 const struct spi_nor_flash_parameter *params = nor->params;
257 u8 *buf = nor->bouncebuf;
261 for (i = 0; i < params->n_dice; i++) {
262 addr = params->vreg_offset[i] + SPINOR_REG_CYPRESS_CFR5;
263 ret = cypress_nor_set_single_spi_bits(nor, addr);
268 /* Read flash ID to make sure the switch was successful. */
269 ret = spi_nor_read_id(nor, 0, 0, buf, SNOR_PROTO_1_1_1);
271 dev_dbg(nor->dev, "error %d reading JEDEC ID after disabling 8D-8D-8D mode\n", ret);
275 if (memcmp(buf, nor->info->id->bytes, nor->info->id->len))
281 static int cypress_nor_quad_enable_volatile_reg(struct spi_nor *nor, u64 addr)
283 struct spi_mem_op op;
284 u8 addr_mode_nbytes = nor->params->addr_mode_nbytes;
288 op = (struct spi_mem_op)
289 CYPRESS_NOR_RD_ANY_REG_OP(addr_mode_nbytes, addr, 0,
292 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
296 if (nor->bouncebuf[0] & SPINOR_REG_CYPRESS_CFR1_QUAD_EN)
299 /* Update the Quad Enable bit. */
300 nor->bouncebuf[0] |= SPINOR_REG_CYPRESS_CFR1_QUAD_EN;
301 op = (struct spi_mem_op)
302 CYPRESS_NOR_WR_ANY_REG_OP(addr_mode_nbytes, addr, 1,
304 ret = spi_nor_write_any_volatile_reg(nor, &op, nor->reg_proto);
308 cfr1v_written = nor->bouncebuf[0];
310 /* Read back and check it. */
311 op = (struct spi_mem_op)
312 CYPRESS_NOR_RD_ANY_REG_OP(addr_mode_nbytes, addr, 0,
314 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
318 if (nor->bouncebuf[0] != cfr1v_written) {
319 dev_err(nor->dev, "CFR1: Read back test failed\n");
327 * cypress_nor_quad_enable_volatile() - enable Quad I/O mode in volatile
329 * @nor: pointer to a 'struct spi_nor'
331 * It is recommended to update volatile registers in the field application due
332 * to a risk of the non-volatile registers corruption by power interrupt. This
333 * function sets Quad Enable bit in CFR1 volatile. If users set the Quad Enable
334 * bit in the CFR1 non-volatile in advance (typically by a Flash programmer
335 * before mounting Flash on PCB), the Quad Enable bit in the CFR1 volatile is
336 * also set during Flash power-up.
338 * Return: 0 on success, -errno otherwise.
340 static int cypress_nor_quad_enable_volatile(struct spi_nor *nor)
342 struct spi_nor_flash_parameter *params = nor->params;
347 for (i = 0; i < params->n_dice; i++) {
348 addr = params->vreg_offset[i] + SPINOR_REG_CYPRESS_CFR1;
349 ret = cypress_nor_quad_enable_volatile_reg(nor, addr);
358 * cypress_nor_determine_addr_mode_by_sr1() - Determine current address mode
359 * (3 or 4-byte) by querying status
361 * @nor: pointer to a 'struct spi_nor'
362 * @addr_mode: ponter to a buffer where we return the determined
365 * This function tries to determine current address mode by comparing SR1 value
366 * from RDSR1(no address), RDAR(3-byte address), and RDAR(4-byte address).
368 * Return: 0 on success, -errno otherwise.
370 static int cypress_nor_determine_addr_mode_by_sr1(struct spi_nor *nor,
373 struct spi_mem_op op =
374 CYPRESS_NOR_RD_ANY_REG_OP(3, SPINOR_REG_CYPRESS_STR1V, 0,
376 bool is3byte, is4byte;
379 ret = spi_nor_read_sr(nor, &nor->bouncebuf[1]);
383 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
387 is3byte = (nor->bouncebuf[0] == nor->bouncebuf[1]);
389 op = (struct spi_mem_op)
390 CYPRESS_NOR_RD_ANY_REG_OP(4, SPINOR_REG_CYPRESS_STR1V, 0,
392 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
396 is4byte = (nor->bouncebuf[0] == nor->bouncebuf[1]);
398 if (is3byte == is4byte)
409 * cypress_nor_set_addr_mode_nbytes() - Set the number of address bytes mode of
410 * current address mode.
411 * @nor: pointer to a 'struct spi_nor'
413 * Determine current address mode by reading SR1 with different methods, then
414 * query CFR2V[7] to confirm. If determination is failed, force enter to 4-byte
417 * Return: 0 on success, -errno otherwise.
419 static int cypress_nor_set_addr_mode_nbytes(struct spi_nor *nor)
421 struct spi_mem_op op;
426 * Read SR1 by RDSR1 and RDAR(3- AND 4-byte addr). Use write enable
427 * that sets bit-1 in SR1.
429 ret = spi_nor_write_enable(nor);
432 ret = cypress_nor_determine_addr_mode_by_sr1(nor, &addr_mode);
434 ret = spi_nor_set_4byte_addr_mode(nor, true);
437 return spi_nor_write_disable(nor);
439 ret = spi_nor_write_disable(nor);
444 * Query CFR2V and make sure no contradiction between determined address
447 op = (struct spi_mem_op)
448 CYPRESS_NOR_RD_ANY_REG_OP(addr_mode, SPINOR_REG_CYPRESS_CFR2V,
450 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
454 if (nor->bouncebuf[0] & SPINOR_REG_CYPRESS_CFR2_ADRBYT) {
456 return spi_nor_set_4byte_addr_mode(nor, true);
459 return spi_nor_set_4byte_addr_mode(nor, true);
462 nor->params->addr_nbytes = addr_mode;
463 nor->params->addr_mode_nbytes = addr_mode;
469 * cypress_nor_get_page_size() - Get flash page size configuration.
470 * @nor: pointer to a 'struct spi_nor'
472 * The BFPT table advertises a 512B or 256B page size depending on part but the
473 * page size is actually configurable (with the default being 256B). Read from
474 * CFR3V[4] and set the correct size.
476 * Return: 0 on success, -errno otherwise.
478 static int cypress_nor_get_page_size(struct spi_nor *nor)
480 struct spi_mem_op op =
481 CYPRESS_NOR_RD_ANY_REG_OP(nor->params->addr_mode_nbytes,
482 0, 0, nor->bouncebuf);
483 struct spi_nor_flash_parameter *params = nor->params;
488 * Use the minimum common page size configuration. Programming 256-byte
489 * under 512-byte page size configuration is safe.
491 params->page_size = 256;
492 for (i = 0; i < params->n_dice; i++) {
493 op.addr.val = params->vreg_offset[i] + SPINOR_REG_CYPRESS_CFR3;
495 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
499 if (!(nor->bouncebuf[0] & SPINOR_REG_CYPRESS_CFR3_PGSZ))
503 params->page_size = 512;
508 static void cypress_nor_ecc_init(struct spi_nor *nor)
511 * Programming is supported only in 16-byte ECC data unit granularity.
512 * Byte-programming, bit-walking, or multiple program operations to the
513 * same ECC data unit without an erase are not allowed.
515 nor->params->writesize = 16;
516 nor->flags |= SNOR_F_ECC;
520 s25fs256t_post_bfpt_fixup(struct spi_nor *nor,
521 const struct sfdp_parameter_header *bfpt_header,
522 const struct sfdp_bfpt *bfpt)
524 struct spi_mem_op op;
527 ret = cypress_nor_set_addr_mode_nbytes(nor);
531 /* Read Architecture Configuration Register (ARCFN) */
532 op = (struct spi_mem_op)
533 CYPRESS_NOR_RD_ANY_REG_OP(nor->params->addr_mode_nbytes,
534 SPINOR_REG_CYPRESS_ARCFN, 1,
536 ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
540 /* ARCFN value must be 0 if uniform sector is selected */
541 if (nor->bouncebuf[0])
547 static int s25fs256t_post_sfdp_fixup(struct spi_nor *nor)
549 struct spi_nor_flash_parameter *params = nor->params;
552 * S25FS256T does not define the SCCR map, but we would like to use the
553 * same code base for both single and multi chip package devices, thus
554 * set the vreg_offset and n_dice to be able to do so.
556 params->vreg_offset = devm_kmalloc(nor->dev, sizeof(u32), GFP_KERNEL);
557 if (!params->vreg_offset)
560 params->vreg_offset[0] = SPINOR_REG_CYPRESS_VREG;
563 /* PP_1_1_4_4B is supported but missing in 4BAIT. */
564 params->hwcaps.mask |= SNOR_HWCAPS_PP_1_1_4;
565 spi_nor_set_pp_settings(¶ms->page_programs[SNOR_CMD_PP_1_1_4],
566 SPINOR_OP_PP_1_1_4_4B,
569 return cypress_nor_get_page_size(nor);
572 static int s25fs256t_late_init(struct spi_nor *nor)
574 cypress_nor_ecc_init(nor);
579 static struct spi_nor_fixups s25fs256t_fixups = {
580 .post_bfpt = s25fs256t_post_bfpt_fixup,
581 .post_sfdp = s25fs256t_post_sfdp_fixup,
582 .late_init = s25fs256t_late_init,
586 s25hx_t_post_bfpt_fixup(struct spi_nor *nor,
587 const struct sfdp_parameter_header *bfpt_header,
588 const struct sfdp_bfpt *bfpt)
592 ret = cypress_nor_set_addr_mode_nbytes(nor);
596 /* Replace Quad Enable with volatile version */
597 nor->params->quad_enable = cypress_nor_quad_enable_volatile;
602 static int s25hx_t_post_sfdp_fixup(struct spi_nor *nor)
604 struct spi_nor_flash_parameter *params = nor->params;
605 struct spi_nor_erase_type *erase_type = params->erase_map.erase_type;
608 if (!params->n_dice || !params->vreg_offset) {
609 dev_err(nor->dev, "%s failed. The volatile register offset could not be retrieved from SFDP.\n",
614 /* The 2 Gb parts duplicate info and advertise 4 dice instead of 2. */
615 if (params->size == SZ_256M)
619 * In some parts, 3byte erase opcodes are advertised by 4BAIT.
620 * Convert them to 4byte erase opcodes.
622 for (i = 0; i < SNOR_ERASE_TYPE_MAX; i++) {
623 switch (erase_type[i].opcode) {
625 erase_type[i].opcode = SPINOR_OP_SE_4B;
627 case SPINOR_OP_BE_4K:
628 erase_type[i].opcode = SPINOR_OP_BE_4K_4B;
635 return cypress_nor_get_page_size(nor);
638 static int s25hx_t_late_init(struct spi_nor *nor)
640 struct spi_nor_flash_parameter *params = nor->params;
642 /* Fast Read 4B requires mode cycles */
643 params->reads[SNOR_CMD_READ_FAST].num_mode_clocks = 8;
644 params->ready = cypress_nor_sr_ready_and_clear;
645 cypress_nor_ecc_init(nor);
650 static struct spi_nor_fixups s25hx_t_fixups = {
651 .post_bfpt = s25hx_t_post_bfpt_fixup,
652 .post_sfdp = s25hx_t_post_sfdp_fixup,
653 .late_init = s25hx_t_late_init,
657 * cypress_nor_set_octal_dtr() - Enable or disable octal DTR on Cypress flashes.
658 * @nor: pointer to a 'struct spi_nor'
659 * @enable: whether to enable or disable Octal DTR
661 * This also sets the memory access latency cycles to 24 to allow the flash to
662 * run at up to 200MHz.
664 * Return: 0 on success, -errno otherwise.
666 static int cypress_nor_set_octal_dtr(struct spi_nor *nor, bool enable)
668 return enable ? cypress_nor_octal_dtr_en(nor) :
669 cypress_nor_octal_dtr_dis(nor);
672 static int s28hx_t_post_sfdp_fixup(struct spi_nor *nor)
674 struct spi_nor_flash_parameter *params = nor->params;
676 if (!params->n_dice || !params->vreg_offset) {
677 dev_err(nor->dev, "%s failed. The volatile register offset could not be retrieved from SFDP.\n",
682 /* The 2 Gb parts duplicate info and advertise 4 dice instead of 2. */
683 if (params->size == SZ_256M)
687 * On older versions of the flash the xSPI Profile 1.0 table has the
688 * 8D-8D-8D Fast Read opcode as 0x00. But it actually should be 0xEE.
690 if (params->reads[SNOR_CMD_READ_8_8_8_DTR].opcode == 0)
691 params->reads[SNOR_CMD_READ_8_8_8_DTR].opcode =
692 SPINOR_OP_CYPRESS_RD_FAST;
694 /* This flash is also missing the 4-byte Page Program opcode bit. */
695 spi_nor_set_pp_settings(¶ms->page_programs[SNOR_CMD_PP],
696 SPINOR_OP_PP_4B, SNOR_PROTO_1_1_1);
698 * Since xSPI Page Program opcode is backward compatible with
699 * Legacy SPI, use Legacy SPI opcode there as well.
701 spi_nor_set_pp_settings(¶ms->page_programs[SNOR_CMD_PP_8_8_8_DTR],
702 SPINOR_OP_PP_4B, SNOR_PROTO_8_8_8_DTR);
705 * The xSPI Profile 1.0 table advertises the number of additional
706 * address bytes needed for Read Status Register command as 0 but the
707 * actual value for that is 4.
709 params->rdsr_addr_nbytes = 4;
711 return cypress_nor_get_page_size(nor);
714 static int s28hx_t_post_bfpt_fixup(struct spi_nor *nor,
715 const struct sfdp_parameter_header *bfpt_header,
716 const struct sfdp_bfpt *bfpt)
718 return cypress_nor_set_addr_mode_nbytes(nor);
721 static int s28hx_t_late_init(struct spi_nor *nor)
723 struct spi_nor_flash_parameter *params = nor->params;
725 params->set_octal_dtr = cypress_nor_set_octal_dtr;
726 params->ready = cypress_nor_sr_ready_and_clear;
727 cypress_nor_ecc_init(nor);
732 static const struct spi_nor_fixups s28hx_t_fixups = {
733 .post_sfdp = s28hx_t_post_sfdp_fixup,
734 .post_bfpt = s28hx_t_post_bfpt_fixup,
735 .late_init = s28hx_t_late_init,
739 s25fs_s_nor_post_bfpt_fixups(struct spi_nor *nor,
740 const struct sfdp_parameter_header *bfpt_header,
741 const struct sfdp_bfpt *bfpt)
744 * The S25FS-S chip family reports 512-byte pages in BFPT but
745 * in reality the write buffer still wraps at the safe default
746 * of 256 bytes. Overwrite the page size advertised by BFPT
747 * to get the writes working.
749 nor->params->page_size = 256;
754 static const struct spi_nor_fixups s25fs_s_nor_fixups = {
755 .post_bfpt = s25fs_s_nor_post_bfpt_fixups,
758 static const struct flash_info spansion_nor_parts[] = {
760 .id = SNOR_ID(0x01, 0x02, 0x12),
764 .id = SNOR_ID(0x01, 0x02, 0x13),
768 .id = SNOR_ID(0x01, 0x02, 0x14),
772 .id = SNOR_ID(0x01, 0x02, 0x15, 0x4d, 0x00),
775 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
777 .id = SNOR_ID(0x01, 0x02, 0x15),
781 .id = SNOR_ID(0x01, 0x02, 0x16, 0x4d, 0x00),
784 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
786 .id = SNOR_ID(0x01, 0x02, 0x16),
790 .id = SNOR_ID(0x01, 0x02, 0x19, 0x4d, 0x00, 0x80),
791 .name = "s25fl256s0",
793 .sector_size = SZ_256K,
794 .no_sfdp_flags = SPI_NOR_SKIP_SFDP | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
795 .mfr_flags = USE_CLSR,
797 .id = SNOR_ID(0x01, 0x02, 0x19, 0x4d, 0x00, 0x81),
798 .name = "s25fs256s0",
800 .sector_size = SZ_256K,
801 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
802 .mfr_flags = USE_CLSR,
804 .id = SNOR_ID(0x01, 0x02, 0x19, 0x4d, 0x01, 0x80),
805 .name = "s25fl256s1",
807 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
808 .mfr_flags = USE_CLSR,
810 .id = SNOR_ID(0x01, 0x02, 0x19, 0x4d, 0x01, 0x81),
811 .name = "s25fs256s1",
813 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
814 .mfr_flags = USE_CLSR,
816 .id = SNOR_ID(0x01, 0x02, 0x20, 0x4d, 0x00, 0x80),
819 .sector_size = SZ_256K,
820 .flags = SPI_NOR_HAS_LOCK,
821 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
822 .mfr_flags = USE_CLSR,
824 .id = SNOR_ID(0x01, 0x02, 0x20, 0x4d, 0x00, 0x81),
827 .sector_size = SZ_256K,
828 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
829 .mfr_flags = USE_CLSR,
830 .fixups = &s25fs_s_nor_fixups,
832 .id = SNOR_ID(0x01, 0x20, 0x18, 0x03, 0x00),
833 .name = "s25sl12800",
835 .sector_size = SZ_256K,
837 .id = SNOR_ID(0x01, 0x20, 0x18, 0x03, 0x01),
838 .name = "s25sl12801",
841 .id = SNOR_ID(0x01, 0x20, 0x18, 0x4d, 0x00, 0x80),
842 .name = "s25fl128s0",
844 .sector_size = SZ_256K,
845 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
846 .mfr_flags = USE_CLSR,
848 .id = SNOR_ID(0x01, 0x20, 0x18, 0x4d, 0x00),
849 .name = "s25fl129p0",
851 .sector_size = SZ_256K,
852 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
853 .mfr_flags = USE_CLSR,
855 .id = SNOR_ID(0x01, 0x20, 0x18, 0x4d, 0x01, 0x80),
856 .name = "s25fl128s1",
858 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
859 .mfr_flags = USE_CLSR,
861 .id = SNOR_ID(0x01, 0x20, 0x18, 0x4d, 0x01, 0x81),
862 .name = "s25fs128s1",
864 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
865 .mfr_flags = USE_CLSR,
866 .fixups = &s25fs_s_nor_fixups,
868 .id = SNOR_ID(0x01, 0x20, 0x18, 0x4d, 0x01),
869 .name = "s25fl129p1",
871 .no_sfdp_flags = SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
872 .mfr_flags = USE_CLSR,
874 .id = SNOR_ID(0x01, 0x40, 0x13),
877 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ,
879 .id = SNOR_ID(0x01, 0x40, 0x14),
882 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ,
884 .id = SNOR_ID(0x01, 0x40, 0x15),
887 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
889 .id = SNOR_ID(0x01, 0x40, 0x16),
892 .no_sfdp_flags = SECT_4K,
894 .id = SNOR_ID(0x01, 0x40, 0x17),
897 .no_sfdp_flags = SECT_4K,
899 .id = SNOR_ID(0x01, 0x60, 0x17),
902 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
903 .fixup_flags = SPI_NOR_4B_OPCODES,
905 .id = SNOR_ID(0x01, 0x60, 0x18),
908 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
909 .fixup_flags = SPI_NOR_4B_OPCODES,
911 .id = SNOR_ID(0x01, 0x60, 0x19),
914 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
915 .fixup_flags = SPI_NOR_4B_OPCODES,
917 .id = SNOR_ID(0x04, 0x2c, 0xc2, 0x7f, 0x7f, 0x7f),
920 .sector_size = SZ_512K,
921 .flags = SPI_NOR_NO_ERASE,
923 .id = SNOR_ID(0x34, 0x2a, 0x1a, 0x0f, 0x03, 0x90),
925 .mfr_flags = USE_CLPEF,
926 .fixups = &s25hx_t_fixups
928 .id = SNOR_ID(0x34, 0x2a, 0x1b, 0x0f, 0x03, 0x90),
930 .mfr_flags = USE_CLPEF,
931 .fixups = &s25hx_t_fixups
933 .id = SNOR_ID(0x34, 0x2a, 0x1c, 0x0f, 0x00, 0x90),
935 .mfr_flags = USE_CLPEF,
936 .flags = NO_CHIP_ERASE,
937 .fixups = &s25hx_t_fixups
939 .id = SNOR_ID(0x34, 0x2b, 0x19, 0x0f, 0x08, 0x90),
941 .mfr_flags = USE_CLPEF,
942 .fixups = &s25fs256t_fixups
944 .id = SNOR_ID(0x34, 0x2b, 0x1a, 0x0f, 0x03, 0x90),
946 .mfr_flags = USE_CLPEF,
947 .fixups = &s25hx_t_fixups
949 .id = SNOR_ID(0x34, 0x2b, 0x1b, 0x0f, 0x03, 0x90),
951 .mfr_flags = USE_CLPEF,
952 .fixups = &s25hx_t_fixups
954 .id = SNOR_ID(0x34, 0x2b, 0x1c, 0x0f, 0x00, 0x90),
956 .mfr_flags = USE_CLPEF,
957 .flags = NO_CHIP_ERASE,
958 .fixups = &s25hx_t_fixups
960 .id = SNOR_ID(0x34, 0x5a, 0x1a),
962 .mfr_flags = USE_CLPEF,
963 .fixups = &s28hx_t_fixups,
965 .id = SNOR_ID(0x34, 0x5a, 0x1b),
967 .mfr_flags = USE_CLPEF,
968 .fixups = &s28hx_t_fixups,
970 .id = SNOR_ID(0x34, 0x5b, 0x1a),
972 .mfr_flags = USE_CLPEF,
973 .fixups = &s28hx_t_fixups,
975 .id = SNOR_ID(0x34, 0x5b, 0x1b),
977 .mfr_flags = USE_CLPEF,
978 .fixups = &s28hx_t_fixups,
980 .id = SNOR_ID(0x34, 0x5b, 0x1c),
982 .mfr_flags = USE_CLPEF,
983 .fixups = &s28hx_t_fixups,
985 .id = SNOR_ID(0xef, 0x40, 0x13),
988 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
990 .id = SNOR_ID(0xef, 0x40, 0x14),
993 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
995 .id = SNOR_ID(0xef, 0x40, 0x15),
998 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
1000 .id = SNOR_ID(0xef, 0x40, 0x17),
1001 .name = "s25fl064k",
1003 .no_sfdp_flags = SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ,
1008 * spansion_nor_sr_ready_and_clear() - Query the Status Register to see if the
1009 * flash is ready for new commands and clear it if there are any errors.
1010 * @nor: pointer to 'struct spi_nor'.
1012 * Return: 1 if ready, 0 if not ready, -errno on errors.
1014 static int spansion_nor_sr_ready_and_clear(struct spi_nor *nor)
1018 ret = spi_nor_read_sr(nor, nor->bouncebuf);
1022 if (nor->bouncebuf[0] & (SR_E_ERR | SR_P_ERR)) {
1023 if (nor->bouncebuf[0] & SR_E_ERR)
1024 dev_err(nor->dev, "Erase Error occurred\n");
1026 dev_err(nor->dev, "Programming Error occurred\n");
1028 spansion_nor_clear_sr(nor);
1031 * WEL bit remains set to one when an erase or page program
1032 * error occurs. Issue a Write Disable command to protect
1033 * against inadvertent writes that can possibly corrupt the
1034 * contents of the memory.
1036 ret = spi_nor_write_disable(nor);
1043 return !(nor->bouncebuf[0] & SR_WIP);
1046 static int spansion_nor_late_init(struct spi_nor *nor)
1048 struct spi_nor_flash_parameter *params = nor->params;
1049 struct spansion_nor_params *priv_params;
1050 u8 mfr_flags = nor->info->mfr_flags;
1052 if (params->size > SZ_16M) {
1053 nor->flags |= SNOR_F_4B_OPCODES;
1054 /* No small sector erase for 4-byte command set */
1055 nor->erase_opcode = SPINOR_OP_SE;
1056 nor->mtd.erasesize = nor->info->sector_size ?:
1057 SPI_NOR_DEFAULT_SECTOR_SIZE;
1060 if (mfr_flags & (USE_CLSR | USE_CLPEF)) {
1061 priv_params = devm_kmalloc(nor->dev, sizeof(*priv_params),
1066 if (mfr_flags & USE_CLSR)
1067 priv_params->clsr = SPINOR_OP_CLSR;
1068 else if (mfr_flags & USE_CLPEF)
1069 priv_params->clsr = SPINOR_OP_CLPEF;
1071 params->priv = priv_params;
1072 params->ready = spansion_nor_sr_ready_and_clear;
1078 static const struct spi_nor_fixups spansion_nor_fixups = {
1079 .late_init = spansion_nor_late_init,
1082 const struct spi_nor_manufacturer spi_nor_spansion = {
1084 .parts = spansion_nor_parts,
1085 .nparts = ARRAY_SIZE(spansion_nor_parts),
1086 .fixups = &spansion_nor_fixups,