10 #include <linux/mtd/spi-nor.h>
48 /* Cypress SPI NOR flash operations. */
78  * @nor:	pointer to 'struct spi_nor'.
80 static void spansion_nor_clear_sr(struct spi_nor *nor)  in spansion_nor_clear_sr()  argument
82 	const struct spansion_nor_params *priv_params = nor->params->priv;  in spansion_nor_clear_sr()
85 	if (nor->spimem) {  in spansion_nor_clear_sr()
88 		spi_nor_spimem_setup_op(nor, &op, nor->reg_proto);  in spansion_nor_clear_sr()
90 		ret = spi_mem_exec_op(nor->spimem, &op);  in spansion_nor_clear_sr()
92 		ret = spi_nor_controller_ops_write_reg(nor, SPINOR_OP_CLSR,  in spansion_nor_clear_sr()
97 		dev_dbg(nor->dev, "error %d clearing SR\n", ret);  in spansion_nor_clear_sr()
100 static int cypress_nor_sr_ready_and_clear_reg(struct spi_nor *nor, u64 addr)  in cypress_nor_sr_ready_and_clear_reg()  argument
102 	struct spi_nor_flash_parameter *params = nor->params;  in cypress_nor_sr_ready_and_clear_reg()
105 					  0, nor->bouncebuf);  in cypress_nor_sr_ready_and_clear_reg()
108 	if (nor->reg_proto == SNOR_PROTO_8_8_8_DTR) {  in cypress_nor_sr_ready_and_clear_reg()
109 		op.addr.nbytes = nor->addr_nbytes;  in cypress_nor_sr_ready_and_clear_reg()
114 	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in cypress_nor_sr_ready_and_clear_reg()
118 	if (nor->bouncebuf[0] & (SR_E_ERR | SR_P_ERR)) {  in cypress_nor_sr_ready_and_clear_reg()
119 		if (nor->bouncebuf[0] & SR_E_ERR)  in cypress_nor_sr_ready_and_clear_reg()
120 			dev_err(nor->dev, "Erase Error occurred\n");  in cypress_nor_sr_ready_and_clear_reg()
122 			dev_err(nor->dev, "Programming Error occurred\n");  in cypress_nor_sr_ready_and_clear_reg()
124 		spansion_nor_clear_sr(nor);  in cypress_nor_sr_ready_and_clear_reg()
126 		ret = spi_nor_write_disable(nor);  in cypress_nor_sr_ready_and_clear_reg()
133 	return !(nor->bouncebuf[0] & SR_WIP);  in cypress_nor_sr_ready_and_clear_reg()
139  * @nor:	pointer to 'struct spi_nor'.
143 static int cypress_nor_sr_ready_and_clear(struct spi_nor *nor)  in cypress_nor_sr_ready_and_clear()  argument
145 	struct spi_nor_flash_parameter *params = nor->params;  in cypress_nor_sr_ready_and_clear()
152 		ret = cypress_nor_sr_ready_and_clear_reg(nor, addr);  in cypress_nor_sr_ready_and_clear()
162 static int cypress_nor_set_memlat(struct spi_nor *nor, u64 addr)  in cypress_nor_set_memlat()  argument
165 	u8 *buf = nor->bouncebuf;  in cypress_nor_set_memlat()
167 	u8 addr_mode_nbytes = nor->params->addr_mode_nbytes;  in cypress_nor_set_memlat()
172 	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in cypress_nor_set_memlat()
183 	ret = spi_nor_write_any_volatile_reg(nor, &op, nor->reg_proto);  in cypress_nor_set_memlat()
187 	nor->read_dummy = 24;  in cypress_nor_set_memlat()
192 static int cypress_nor_set_octal_dtr_bits(struct spi_nor *nor, u64 addr)  in cypress_nor_set_octal_dtr_bits()  argument
195 	u8 *buf = nor->bouncebuf;  in cypress_nor_set_octal_dtr_bits()
200 		CYPRESS_NOR_WR_ANY_REG_OP(nor->params->addr_mode_nbytes,  in cypress_nor_set_octal_dtr_bits()
203 	return spi_nor_write_any_volatile_reg(nor, &op, nor->reg_proto);  in cypress_nor_set_octal_dtr_bits()
206 static int cypress_nor_octal_dtr_en(struct spi_nor *nor)  in cypress_nor_octal_dtr_en()  argument
208 	const struct spi_nor_flash_parameter *params = nor->params;  in cypress_nor_octal_dtr_en()
209 	u8 *buf = nor->bouncebuf;  in cypress_nor_octal_dtr_en()
215 		ret = cypress_nor_set_memlat(nor, addr);  in cypress_nor_octal_dtr_en()
220 		ret = cypress_nor_set_octal_dtr_bits(nor, addr);  in cypress_nor_octal_dtr_en()
226 	ret = spi_nor_read_id(nor, nor->addr_nbytes, 3, buf,  in cypress_nor_octal_dtr_en()
229 		dev_dbg(nor->dev, "error %d reading JEDEC ID after enabling 8D-8D-8D mode\n", ret);  in cypress_nor_octal_dtr_en()
233 	if (memcmp(buf, nor->info->id->bytes, nor->info->id->len))  in cypress_nor_octal_dtr_en()
239 static int cypress_nor_set_single_spi_bits(struct spi_nor *nor, u64 addr)  in cypress_nor_set_single_spi_bits()  argument
242 	u8 *buf = nor->bouncebuf;  in cypress_nor_set_single_spi_bits()
252 		CYPRESS_NOR_WR_ANY_REG_OP(nor->addr_nbytes, addr, 2, buf);  in cypress_nor_set_single_spi_bits()
253 	return spi_nor_write_any_volatile_reg(nor, &op, SNOR_PROTO_8_8_8_DTR);  in cypress_nor_set_single_spi_bits()
256 static int cypress_nor_octal_dtr_dis(struct spi_nor *nor)  in cypress_nor_octal_dtr_dis()  argument
258 	const struct spi_nor_flash_parameter *params = nor->params;  in cypress_nor_octal_dtr_dis()
259 	u8 *buf = nor->bouncebuf;  in cypress_nor_octal_dtr_dis()
265 		ret = cypress_nor_set_single_spi_bits(nor, addr);  in cypress_nor_octal_dtr_dis()
271 	ret = spi_nor_read_id(nor, 0, 0, buf, SNOR_PROTO_1_1_1);  in cypress_nor_octal_dtr_dis()
273 		dev_dbg(nor->dev, "error %d reading JEDEC ID after disabling 8D-8D-8D mode\n", ret);  in cypress_nor_octal_dtr_dis()
277 	if (memcmp(buf, nor->info->id->bytes, nor->info->id->len))  in cypress_nor_octal_dtr_dis()
283 static int cypress_nor_quad_enable_volatile_reg(struct spi_nor *nor, u64 addr)  in cypress_nor_quad_enable_volatile_reg()  argument
286 	u8 addr_mode_nbytes = nor->params->addr_mode_nbytes;  in cypress_nor_quad_enable_volatile_reg()
292 					  nor->bouncebuf);  in cypress_nor_quad_enable_volatile_reg()
294 	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in cypress_nor_quad_enable_volatile_reg()
298 	if (nor->bouncebuf[0] & SPINOR_REG_CYPRESS_CFR1_QUAD_EN)  in cypress_nor_quad_enable_volatile_reg()
302 	nor->bouncebuf[0] |= SPINOR_REG_CYPRESS_CFR1_QUAD_EN;  in cypress_nor_quad_enable_volatile_reg()
305 					  nor->bouncebuf);  in cypress_nor_quad_enable_volatile_reg()
306 	ret = spi_nor_write_any_volatile_reg(nor, &op, nor->reg_proto);  in cypress_nor_quad_enable_volatile_reg()
310 	cfr1v_written = nor->bouncebuf[0];  in cypress_nor_quad_enable_volatile_reg()
315 					  nor->bouncebuf);  in cypress_nor_quad_enable_volatile_reg()
316 	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in cypress_nor_quad_enable_volatile_reg()
320 	if (nor->bouncebuf[0] != cfr1v_written) {  in cypress_nor_quad_enable_volatile_reg()
321 		dev_err(nor->dev, "CFR1: Read back test failed\n");  in cypress_nor_quad_enable_volatile_reg()
331  * @nor:	pointer to a 'struct spi_nor'
342 static int cypress_nor_quad_enable_volatile(struct spi_nor *nor)  in cypress_nor_quad_enable_volatile()  argument
344 	struct spi_nor_flash_parameter *params = nor->params;  in cypress_nor_quad_enable_volatile()
351 		ret = cypress_nor_quad_enable_volatile_reg(nor, addr);  in cypress_nor_quad_enable_volatile()
363  * @nor:		pointer to a 'struct spi_nor'
372 static int cypress_nor_determine_addr_mode_by_sr1(struct spi_nor *nor,  in cypress_nor_determine_addr_mode_by_sr1()  argument
377 					  nor->bouncebuf);  in cypress_nor_determine_addr_mode_by_sr1()
381 	ret = spi_nor_read_sr(nor, &nor->bouncebuf[1]);  in cypress_nor_determine_addr_mode_by_sr1()
385 	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in cypress_nor_determine_addr_mode_by_sr1()
389 	is3byte = (nor->bouncebuf[0] == nor->bouncebuf[1]);  in cypress_nor_determine_addr_mode_by_sr1()
393 					  nor->bouncebuf);  in cypress_nor_determine_addr_mode_by_sr1()
394 	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in cypress_nor_determine_addr_mode_by_sr1()
398 	is4byte = (nor->bouncebuf[0] == nor->bouncebuf[1]);  in cypress_nor_determine_addr_mode_by_sr1()
413  * @nor:		pointer to a 'struct spi_nor'
421 static int cypress_nor_set_addr_mode_nbytes(struct spi_nor *nor)  in cypress_nor_set_addr_mode_nbytes()  argument
431 	ret = spi_nor_write_enable(nor);  in cypress_nor_set_addr_mode_nbytes()
434 	ret = cypress_nor_determine_addr_mode_by_sr1(nor, &addr_mode);  in cypress_nor_set_addr_mode_nbytes()
436 		ret = spi_nor_set_4byte_addr_mode(nor, true);  in cypress_nor_set_addr_mode_nbytes()
439 		return spi_nor_write_disable(nor);  in cypress_nor_set_addr_mode_nbytes()
441 	ret = spi_nor_write_disable(nor);  in cypress_nor_set_addr_mode_nbytes()
451 					  0, nor->bouncebuf);  in cypress_nor_set_addr_mode_nbytes()
452 	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in cypress_nor_set_addr_mode_nbytes()
456 	if (nor->bouncebuf[0] & SPINOR_REG_CYPRESS_CFR2_ADRBYT) {  in cypress_nor_set_addr_mode_nbytes()
458 			return spi_nor_set_4byte_addr_mode(nor, true);  in cypress_nor_set_addr_mode_nbytes()
461 			return spi_nor_set_4byte_addr_mode(nor, true);  in cypress_nor_set_addr_mode_nbytes()
464 	nor->params->addr_nbytes = addr_mode;  in cypress_nor_set_addr_mode_nbytes()
465 	nor->params->addr_mode_nbytes = addr_mode;  in cypress_nor_set_addr_mode_nbytes()
472  * @nor:	pointer to a 'struct spi_nor'
480 static int cypress_nor_get_page_size(struct spi_nor *nor)  in cypress_nor_get_page_size()  argument
483 		CYPRESS_NOR_RD_ANY_REG_OP(nor->params->addr_mode_nbytes,  in cypress_nor_get_page_size()
484 					  0, 0, nor->bouncebuf);  in cypress_nor_get_page_size()
485 	struct spi_nor_flash_parameter *params = nor->params;  in cypress_nor_get_page_size()
497 		ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in cypress_nor_get_page_size()
501 		if (!(nor->bouncebuf[0] & SPINOR_REG_CYPRESS_CFR3_PGSZ))  in cypress_nor_get_page_size()
510 static void cypress_nor_ecc_init(struct spi_nor *nor)  in cypress_nor_ecc_init()  argument
517 	nor->params->writesize = 16;  in cypress_nor_ecc_init()
518 	nor->flags |= SNOR_F_ECC;  in cypress_nor_ecc_init()
522 s25fs256t_post_bfpt_fixup(struct spi_nor *nor,  in s25fs256t_post_bfpt_fixup()  argument
529 	ret = cypress_nor_set_addr_mode_nbytes(nor);  in s25fs256t_post_bfpt_fixup()
535 		CYPRESS_NOR_RD_ANY_REG_OP(nor->params->addr_mode_nbytes,  in s25fs256t_post_bfpt_fixup()
537 					  nor->bouncebuf);  in s25fs256t_post_bfpt_fixup()
538 	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);  in s25fs256t_post_bfpt_fixup()
543 	if (nor->bouncebuf[0])  in s25fs256t_post_bfpt_fixup()
549 static int s25fs256t_post_sfdp_fixup(struct spi_nor *nor)  in s25fs256t_post_sfdp_fixup()  argument
551 	struct spi_nor_flash_parameter *params = nor->params;  in s25fs256t_post_sfdp_fixup()
558 	params->vreg_offset = devm_kmalloc(nor->dev, sizeof(u32), GFP_KERNEL);  in s25fs256t_post_sfdp_fixup()
571 	return cypress_nor_get_page_size(nor);  in s25fs256t_post_sfdp_fixup()
574 static int s25fs256t_late_init(struct spi_nor *nor)  in s25fs256t_late_init()  argument
576 	cypress_nor_ecc_init(nor);  in s25fs256t_late_init()
588 s25hx_t_post_bfpt_fixup(struct spi_nor *nor,  in s25hx_t_post_bfpt_fixup()  argument
594 	ret = cypress_nor_set_addr_mode_nbytes(nor);  in s25hx_t_post_bfpt_fixup()
599 	nor->params->quad_enable = cypress_nor_quad_enable_volatile;  in s25hx_t_post_bfpt_fixup()
604 static int s25hx_t_post_sfdp_fixup(struct spi_nor *nor)  in s25hx_t_post_sfdp_fixup()  argument
606 	struct spi_nor_flash_parameter *params = nor->params;  in s25hx_t_post_sfdp_fixup()
611 		dev_err(nor->dev, "%s failed. The volatile register offset could not be retrieved from SFDP.\n",  in s25hx_t_post_sfdp_fixup()
637 	return cypress_nor_get_page_size(nor);  in s25hx_t_post_sfdp_fixup()
640 static int s25hx_t_late_init(struct spi_nor *nor)  in s25hx_t_late_init()  argument
642 	struct spi_nor_flash_parameter *params = nor->params;  in s25hx_t_late_init()
647 	cypress_nor_ecc_init(nor);  in s25hx_t_late_init()
661  * @nor:		pointer to a 'struct spi_nor'
669 static int cypress_nor_set_octal_dtr(struct spi_nor *nor, bool enable)  in cypress_nor_set_octal_dtr()  argument
671 	return enable ? cypress_nor_octal_dtr_en(nor) :  in cypress_nor_set_octal_dtr()
672 			cypress_nor_octal_dtr_dis(nor);  in cypress_nor_set_octal_dtr()
675 static int s28hx_t_post_sfdp_fixup(struct spi_nor *nor)  in s28hx_t_post_sfdp_fixup()  argument
677 	struct spi_nor_flash_parameter *params = nor->params;  in s28hx_t_post_sfdp_fixup()
680 		dev_err(nor->dev, "%s failed. The volatile register offset could not be retrieved from SFDP.\n",  in s28hx_t_post_sfdp_fixup()
714 	return cypress_nor_get_page_size(nor);  in s28hx_t_post_sfdp_fixup()
717 static int s28hx_t_post_bfpt_fixup(struct spi_nor *nor,  in s28hx_t_post_bfpt_fixup()  argument
721 	return cypress_nor_set_addr_mode_nbytes(nor);  in s28hx_t_post_bfpt_fixup()
724 static int s28hx_t_late_init(struct spi_nor *nor)  in s28hx_t_late_init()  argument
726 	struct spi_nor_flash_parameter *params = nor->params;  in s28hx_t_late_init()
730 	cypress_nor_ecc_init(nor);  in s28hx_t_late_init()
742 s25fs_s_nor_post_bfpt_fixups(struct spi_nor *nor,  in s25fs_s_nor_post_bfpt_fixups()  argument
752 	nor->params->page_size = 256;  in s25fs_s_nor_post_bfpt_fixups()
1025  * @nor:	pointer to 'struct spi_nor'.
1029 static int spansion_nor_sr_ready_and_clear(struct spi_nor *nor)  in spansion_nor_sr_ready_and_clear()  argument
1033 	ret = spi_nor_read_sr(nor, nor->bouncebuf);  in spansion_nor_sr_ready_and_clear()
1037 	if (nor->bouncebuf[0] & (SR_E_ERR | SR_P_ERR)) {  in spansion_nor_sr_ready_and_clear()
1038 		if (nor->bouncebuf[0] & SR_E_ERR)  in spansion_nor_sr_ready_and_clear()
1039 			dev_err(nor->dev, "Erase Error occurred\n");  in spansion_nor_sr_ready_and_clear()
1041 			dev_err(nor->dev, "Programming Error occurred\n");  in spansion_nor_sr_ready_and_clear()
1043 		spansion_nor_clear_sr(nor);  in spansion_nor_sr_ready_and_clear()
1051 		ret = spi_nor_write_disable(nor);  in spansion_nor_sr_ready_and_clear()
1058 	return !(nor->bouncebuf[0] & SR_WIP);  in spansion_nor_sr_ready_and_clear()
1061 static int spansion_nor_late_init(struct spi_nor *nor)  in spansion_nor_late_init()  argument
1063 	struct spi_nor_flash_parameter *params = nor->params;  in spansion_nor_late_init()
1065 	u8 mfr_flags = nor->info->mfr_flags;  in spansion_nor_late_init()
1068 		nor->flags |= SNOR_F_4B_OPCODES;  in spansion_nor_late_init()
1070 		nor->erase_opcode = SPINOR_OP_SE;  in spansion_nor_late_init()
1071 		nor->mtd.erasesize = nor->info->sector_size ?:  in spansion_nor_late_init()
1076 		priv_params = devm_kmalloc(nor->dev, sizeof(*priv_params),  in spansion_nor_late_init()