[PATCH v5 10/10] mtd: spi-nor: spansion: Determine current address mode

[Takahiro Kuwano]

On 3/31/2023 4:46 PM, Tudor Ambarus wrote:
> From: Takahiro Kuwano <Takahiro.Kuwano at infineon.com>
> 
> Internal address mode (3- or 4-byte) affects to the address length in
> Read Any Reg op. Read Any Reg op is used in SMPT parse and other setup
> functions. Current driver assumes that address mode is factory default
> but users can change it via volatile and non-volatile registers.
> 
> Current address mode can be checked by CFR2V[7] but Read Any Reg op is
> needed to read CFR2V (chicken-and-egg).
> 
> Introduce a way to determine current address mode by comparing status
> register 1 values read by different address length.
> 
> Suggested-by: Tudor Ambarus <tudor.ambarus at linaro.org>
> Signed-off-by: Takahiro Kuwano <Takahiro.Kuwano at infineon.com>
> Signed-off-by: Tudor Ambarus <tudor.ambarus at linaro.org>
> ---
>  drivers/mtd/spi-nor/spansion.c | 131 ++++++++++++++++++++++++++++++++-
>  1 file changed, 128 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/mtd/spi-nor/spansion.c b/drivers/mtd/spi-nor/spansion.c
> index 1678b7b2e9f7..352c40dd3864 100644
> --- a/drivers/mtd/spi-nor/spansion.c
> +++ b/drivers/mtd/spi-nor/spansion.c
> @@ -14,10 +14,12 @@
>  #define SPINOR_OP_CLSR		0x30	/* Clear status register 1 */
>  #define SPINOR_OP_RD_ANY_REG			0x65	/* Read any register */
>  #define SPINOR_OP_WR_ANY_REG			0x71	/* Write any register */
> +#define SPINOR_REG_CYPRESS_STR1V		0x00800000
>  #define SPINOR_REG_CYPRESS_CFR1V		0x00800002
>  #define SPINOR_REG_CYPRESS_CFR1_QUAD_EN		BIT(1)	/* Quad Enable */
>  #define SPINOR_REG_CYPRESS_CFR2V		0x00800003
>  #define SPINOR_REG_CYPRESS_CFR2_MEMLAT_11_24	0xb
> +#define SPINOR_REG_CYPRESS_CFR2_ADRBYT		BIT(7)
>  #define SPINOR_REG_CYPRESS_CFR3V		0x00800004
>  #define SPINOR_REG_CYPRESS_CFR3_PGSZ		BIT(4) /* Page size. */
>  #define SPINOR_REG_CYPRESS_CFR5V		0x00800006
> @@ -188,6 +190,117 @@ static int cypress_nor_quad_enable_volatile(struct spi_nor *nor)
>  	return 0;
>  }
>  
> +/**
> + * cypress_nor_determine_addr_mode_by_sr1() - Determine current address mode
> + *                                            (3 or 4-byte) by querying status
> + *                                            register 1 (SR1).
> + * @nor:		pointer to a 'struct spi_nor'
> + * @addr_mode:		ponter to a buffer where we return the determined
> + *			address mode.
> + *
> + * This function tries to determine current address mode by comparing SR1 value
> + * from RDSR1(no address), RDAR(3-byte address), and RDAR(4-byte address).
> + *
> + * Return: 0 on success, -errno otherwise.
> + */
> +static int cypress_nor_determine_addr_mode_by_sr1(struct spi_nor *nor,
> +						  u8 *addr_mode)
> +{
> +	struct spi_mem_op op =
> +		CYPRESS_NOR_RD_ANY_REG_OP(3, SPINOR_REG_CYPRESS_STR1V, 0,
> +					  nor->bouncebuf);
> +	bool is3byte, is4byte;
> +	int ret;
> +
> +	ret = spi_nor_read_sr(nor, &nor->bouncebuf[1]);
> +	if (ret)
> +		return ret;
> +
> +	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
> +	if (ret)
> +		return ret;
> +
> +	is3byte = (nor->bouncebuf[0] == nor->bouncebuf[1]);
> +
> +	op = (struct spi_mem_op)
> +		CYPRESS_NOR_RD_ANY_REG_OP(4, SPINOR_REG_CYPRESS_STR1V, 0,
> +					  nor->bouncebuf);
> +	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
> +	if (ret)
> +		return ret;
> +
> +	is4byte = (nor->bouncebuf[0] == nor->bouncebuf[1]);
> +
> +	if (is3byte == is4byte)
> +		return -EIO;
> +	if (is3byte)
> +		*addr_mode = 3;
> +	else
> +		*addr_mode = 4;
> +
> +	return 0;
> +}
> +
> +/**
> + * cypress_nor_set_addr_mode_nbytes() - Set the number of address bytes mode of
> + *                                      current address mode.
> + * @nor:		pointer to a 'struct spi_nor'
> + *
> + * Determine current address mode by reading SR1 with different methods, then
> + * query CFR2V[7] to confirm. If determination is failed, force enter to 4-byte
> + * address mode.
> + *
> + * Return: 0 on success, -errno otherwise.
> + */
> +static int cypress_nor_set_addr_mode_nbytes(struct spi_nor *nor)
> +{
> +	struct spi_mem_op op;
> +	u8 addr_mode;
> +	int ret;
> +
> +	/*
> +	 * Read SR1 by RDSR1 and RDAR(3- AND 4-byte addr). Use write enable
> +	 * that sets bit-1 in SR1.
> +	 */
> +	ret = spi_nor_write_enable(nor);
> +	if (ret)
> +		return ret;
> +	ret = cypress_nor_determine_addr_mode_by_sr1(nor, &addr_mode);
> +	if (ret) {
> +		ret = spi_nor_set_4byte_addr_mode(nor, true);
> +		if (ret)
> +			return ret;
> +		return spi_nor_write_disable(nor);
> +	}
> +	ret = spi_nor_write_disable(nor);
> +	if (ret)
> +		return ret;
> +
> +	/*
> +	 * Query CFR2V and make sure no contradiction between determined address
> +	 * mode and CFR2V[7].
> +	 */
> +	op = (struct spi_mem_op)
> +		CYPRESS_NOR_RD_ANY_REG_OP(addr_mode, SPINOR_REG_CYPRESS_CFR2V,
> +					  0, nor->bouncebuf);
> +	ret = spi_nor_read_any_reg(nor, &op, nor->reg_proto);
> +	if (ret)
> +		return ret;
> +
> +	if (nor->bouncebuf[0] & SPINOR_REG_CYPRESS_CFR2_ADRBYT) {
> +		if (addr_mode != 4)
> +			return spi_nor_set_4byte_addr_mode(nor, true);
> +	} else {
> +		if (addr_mode != 3)
> +			return spi_nor_set_4byte_addr_mode(nor, true);
> +	}
> +
> +	nor->params->addr_nbytes = addr_mode;
> +	nor->params->addr_mode_nbytes = addr_mode;
> +
> +	return 0;
> +}
> +
>  /**
>   * cypress_nor_set_page_size() - Set page size which corresponds to the flash
>   *                               configuration.
> @@ -227,9 +340,9 @@ s25fs256t_post_bfpt_fixup(struct spi_nor *nor,
>  	struct spi_mem_op op;
>  	int ret;
>  
> -	/* 4-byte address mode is enabled by default */
> -	nor->params->addr_nbytes = 4;
> -	nor->params->addr_mode_nbytes = 4;
> +	ret = cypress_nor_set_addr_mode_nbytes(nor);
> +	if (ret)
> +		return ret;
>  
>  	/* Read Architecture Configuration Register (ARCFN) */
>  	op = (struct spi_mem_op)
> @@ -280,6 +393,12 @@ s25hx_t_post_bfpt_fixup(struct spi_nor *nor,
>  			const struct sfdp_parameter_header *bfpt_header,
>  			const struct sfdp_bfpt *bfpt)
>  {
> +	int ret;
> +
> +	ret = cypress_nor_set_addr_mode_nbytes(nor);
> +	if (ret)
> +		return ret;
> +
>  	/* Replace Quad Enable with volatile version */
>  	nor->params->quad_enable = cypress_nor_quad_enable_volatile;
>  
> @@ -375,6 +494,12 @@ static int s28hx_t_post_bfpt_fixup(struct spi_nor *nor,
>  				   const struct sfdp_parameter_header *bfpt_header,
>  				   const struct sfdp_bfpt *bfpt)
>  {
> +	int ret;
> +
> +	ret = cypress_nor_set_addr_mode_nbytes(nor);
> +	if (ret)
> +		return ret;
> +
>  	return cypress_nor_set_page_size(nor);
>  }
>  

Confirmed S25HS(default 3B), S28HS(default 3B), and S25FS256T(default 4B) works
fine on top of this series.

Tested-by: Takahiro Kuwano <Takahiro.Kuwano at infineon.com>