2022-03-09 15:04:25

by Tudor Ambarus

[permalink] [raw]
Subject: [PATCH v2 2/4] mtd: spi-nor: Update name and description of the set_4byte_addr_mode BFPT methods

BFPT defines some standard methods to enter and exit the 4-Byte Address
Mode. Use generic names for these methods and update their description.

Signed-off-by: Tudor Ambarus <[email protected]>
---
drivers/mtd/spi-nor/core.c | 2 +-
drivers/mtd/spi-nor/macronix.c | 3 ++-
drivers/mtd/spi-nor/micron-st.c | 3 ++-
drivers/mtd/spi-nor/sfdp.c | 32 ++++++++++++++++++++------------
drivers/mtd/spi-nor/sfdp.h | 7 ++++---
drivers/mtd/spi-nor/winbond.c | 2 +-
6 files changed, 30 insertions(+), 19 deletions(-)

diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c
index 452d0f91a8df..91d3754baa59 100644
--- a/drivers/mtd/spi-nor/core.c
+++ b/drivers/mtd/spi-nor/core.c
@@ -2492,7 +2492,7 @@ static void spi_nor_init_default_params(struct spi_nor *nor)
struct device_node *np = spi_nor_get_flash_node(nor);

params->quad_enable = spi_nor_sr2_bit1_quad_enable;
- params->set_4byte_addr_mode = spansion_set_4byte_addr_mode;
+ params->set_4byte_addr_mode = spi_nor_set_4byte_addr_mode_brwr;
params->otp.org = &info->otp_org;

/* Default to 16-bit Write Status (01h) Command */
diff --git a/drivers/mtd/spi-nor/macronix.c b/drivers/mtd/spi-nor/macronix.c
index d81a4cb2812b..85e8655d362c 100644
--- a/drivers/mtd/spi-nor/macronix.c
+++ b/drivers/mtd/spi-nor/macronix.c
@@ -105,7 +105,8 @@ static const struct flash_info macronix_nor_parts[] = {
static void macronix_nor_default_init(struct spi_nor *nor)
{
nor->params->quad_enable = spi_nor_sr1_bit6_quad_enable;
- nor->params->set_4byte_addr_mode = spi_nor_set_4byte_addr_mode;
+ nor->params->set_4byte_addr_mode =
+ spi_nor_set_4byte_addr_mode_en4b_ex4b;
}

static const struct spi_nor_fixups macronix_nor_fixups = {
diff --git a/drivers/mtd/spi-nor/micron-st.c b/drivers/mtd/spi-nor/micron-st.c
index c348419d24a0..4baa9dce04f9 100644
--- a/drivers/mtd/spi-nor/micron-st.c
+++ b/drivers/mtd/spi-nor/micron-st.c
@@ -410,7 +410,8 @@ static void micron_st_nor_default_init(struct spi_nor *nor)
nor->flags |= SNOR_F_HAS_LOCK;
nor->flags &= ~SNOR_F_HAS_16BIT_SR;
nor->params->quad_enable = NULL;
- nor->params->set_4byte_addr_mode = micron_st_nor_set_4byte_addr_mode;
+ nor->params->set_4byte_addr_mode =
+ spi_nor_set_4byte_addr_mode_wren_en4b_ex4b;
}

static void micron_st_nor_late_init(struct spi_nor *nor)
diff --git a/drivers/mtd/spi-nor/sfdp.c b/drivers/mtd/spi-nor/sfdp.c
index 108a74ce38e0..01e35354db3e 100644
--- a/drivers/mtd/spi-nor/sfdp.c
+++ b/drivers/mtd/spi-nor/sfdp.c
@@ -402,15 +402,20 @@ static void spi_nor_regions_sort_erase_types(struct spi_nor_erase_map *map)
}

/**
- * spansion_set_4byte_addr_mode() - Set 4-byte address mode for Spansion
- * flashes.
+ * spi_nor_set_4byte_addr_mode_brwr() - Set 4-byte address mode using
+ * SPINOR_OP_BRWR.
* @nor: pointer to 'struct spi_nor'.
* @enable: true to enter the 4-byte address mode, false to exit the 4-byte
* address mode.
*
+ * 8-bit volatile bank register used to define A[30:A24] bits. MSB (bit[7]) is
+ * used to enable/disable 4-byte address mode. When MSB is set to ‘1’, 4-byte
+ * address mode is active and A[30:24] bits are don’t care. Write instruction is
+ * SPINOR_OP_BRWR(17h) with 1 byte of data.
+ *
* Return: 0 on success, -errno otherwise.
*/
-int spansion_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
+int spi_nor_set_4byte_addr_mode_brwr(struct spi_nor *nor, bool enable)
{
int ret;

@@ -434,14 +439,15 @@ int spansion_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
}

/**
- * spi_nor_set_4byte_addr_mode() - Enter/Exit 4-byte address mode.
+ * spi_nor_set_4byte_addr_mode_en4b_ex4b() - Enter/Exit 4-byte address mode
+ * using SPINOR_OP_EN4B/SPINOR_OP_EX4B.
* @nor: pointer to 'struct spi_nor'.
* @enable: true to enter the 4-byte address mode, false to exit the 4-byte
* address mode.
*
* Return: 0 on success, -errno otherwise.
*/
-int spi_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
+int spi_nor_set_4byte_addr_mode_en4b_ex4b(struct spi_nor *nor, bool enable)
{
int ret;

@@ -465,15 +471,15 @@ int spi_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
}

/**
- * micron_st_nor_set_4byte_addr_mode() - Set 4-byte address mode for ST and
- * Micron flashes.
+ * spi_nor_set_4byte_addr_mode_wren_en4b_ex4b() - Set 4-byte address mode usingf
+ * SPINOR_OP_WREN followed by SPINOR_OP_EN4B or SPINOR_OP_EX4B.
* @nor: pointer to 'struct spi_nor'.
* @enable: true to enter the 4-byte address mode, false to exit the 4-byte
* address mode.
*
* Return: 0 on success, -errno otherwise.
*/
-int micron_st_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
+int spi_nor_set_4byte_addr_mode_wren_en4b_ex4b(struct spi_nor *nor, bool enable)
{
int ret;

@@ -481,7 +487,7 @@ int micron_st_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
if (ret)
return ret;

- ret = spi_nor_set_4byte_addr_mode(nor, enable);
+ ret = spi_nor_set_4byte_addr_mode_en4b_ex4b(nor, enable);
if (ret)
return ret;

@@ -729,15 +735,17 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor,

switch (bfpt.dwords[BFPT_DWORD(16)] & BFPT_DWORD16_4B_ADDR_MODE_MASK) {
case BFPT_DWORD16_4B_ADDR_MODE_BRWR:
- params->set_4byte_addr_mode = spansion_set_4byte_addr_mode;
+ params->set_4byte_addr_mode = spi_nor_set_4byte_addr_mode_brwr;
break;

case BFPT_DWORD16_4B_ADDR_MODE_WREN_EN4B_EX4B:
- params->set_4byte_addr_mode = micron_st_nor_set_4byte_addr_mode;
+ params->set_4byte_addr_mode =
+ spi_nor_set_4byte_addr_mode_wren_en4b_ex4b;
break;

case BFPT_DWORD16_4B_ADDR_MODE_EN4B_EX4B:
- params->set_4byte_addr_mode = spi_nor_set_4byte_addr_mode;
+ params->set_4byte_addr_mode =
+ spi_nor_set_4byte_addr_mode_en4b_ex4b;
break;

default:
diff --git a/drivers/mtd/spi-nor/sfdp.h b/drivers/mtd/spi-nor/sfdp.h
index b56849079aea..da2d7ec2e0aa 100644
--- a/drivers/mtd/spi-nor/sfdp.h
+++ b/drivers/mtd/spi-nor/sfdp.h
@@ -107,9 +107,10 @@ struct sfdp_parameter_header {
u8 id_msb;
};

-int spansion_set_4byte_addr_mode(struct spi_nor *nor, bool enable);
-int spi_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable);
-int micron_st_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable);
+int spi_nor_set_4byte_addr_mode_brwr(struct spi_nor *nor, bool enable);
+int spi_nor_set_4byte_addr_mode_en4b_ex4b(struct spi_nor *nor, bool enable);
+int spi_nor_set_4byte_addr_mode_wren_en4b_ex4b(struct spi_nor *nor,
+ bool enable);
int spi_nor_parse_sfdp(struct spi_nor *nor);

#endif /* __LINUX_MTD_SFDP_H */
diff --git a/drivers/mtd/spi-nor/winbond.c b/drivers/mtd/spi-nor/winbond.c
index 374ba82bff49..590e4d2c99d7 100644
--- a/drivers/mtd/spi-nor/winbond.c
+++ b/drivers/mtd/spi-nor/winbond.c
@@ -142,7 +142,7 @@ static int winbond_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
{
int ret;

- ret = spi_nor_set_4byte_addr_mode(nor, enable);
+ ret = spi_nor_set_4byte_addr_mode_en4b_ex4b(nor, enable);
if (ret || enable)
return ret;

--
2.25.1


2022-04-02 13:18:06

by Pratyush Yadav

[permalink] [raw]
Subject: Re: [PATCH v2 2/4] mtd: spi-nor: Update name and description of the set_4byte_addr_mode BFPT methods

On 09/03/22 04:42PM, Tudor Ambarus wrote:
> BFPT defines some standard methods to enter and exit the 4-Byte Address
> Mode. Use generic names for these methods and update their description.
>
> Signed-off-by: Tudor Ambarus <[email protected]>
> ---
> drivers/mtd/spi-nor/core.c | 2 +-
> drivers/mtd/spi-nor/macronix.c | 3 ++-
> drivers/mtd/spi-nor/micron-st.c | 3 ++-
> drivers/mtd/spi-nor/sfdp.c | 32 ++++++++++++++++++++------------
> drivers/mtd/spi-nor/sfdp.h | 7 ++++---
> drivers/mtd/spi-nor/winbond.c | 2 +-
> 6 files changed, 30 insertions(+), 19 deletions(-)
>
> diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c
> index 452d0f91a8df..91d3754baa59 100644
> --- a/drivers/mtd/spi-nor/core.c
> +++ b/drivers/mtd/spi-nor/core.c
> @@ -2492,7 +2492,7 @@ static void spi_nor_init_default_params(struct spi_nor *nor)
> struct device_node *np = spi_nor_get_flash_node(nor);
>
> params->quad_enable = spi_nor_sr2_bit1_quad_enable;
> - params->set_4byte_addr_mode = spansion_set_4byte_addr_mode;
> + params->set_4byte_addr_mode = spi_nor_set_4byte_addr_mode_brwr;
> params->otp.org = &info->otp_org;
>
> /* Default to 16-bit Write Status (01h) Command */
> diff --git a/drivers/mtd/spi-nor/macronix.c b/drivers/mtd/spi-nor/macronix.c
> index d81a4cb2812b..85e8655d362c 100644
> --- a/drivers/mtd/spi-nor/macronix.c
> +++ b/drivers/mtd/spi-nor/macronix.c
> @@ -105,7 +105,8 @@ static const struct flash_info macronix_nor_parts[] = {
> static void macronix_nor_default_init(struct spi_nor *nor)
> {
> nor->params->quad_enable = spi_nor_sr1_bit6_quad_enable;
> - nor->params->set_4byte_addr_mode = spi_nor_set_4byte_addr_mode;
> + nor->params->set_4byte_addr_mode =
> + spi_nor_set_4byte_addr_mode_en4b_ex4b;
> }
>
> static const struct spi_nor_fixups macronix_nor_fixups = {
> diff --git a/drivers/mtd/spi-nor/micron-st.c b/drivers/mtd/spi-nor/micron-st.c
> index c348419d24a0..4baa9dce04f9 100644
> --- a/drivers/mtd/spi-nor/micron-st.c
> +++ b/drivers/mtd/spi-nor/micron-st.c
> @@ -410,7 +410,8 @@ static void micron_st_nor_default_init(struct spi_nor *nor)
> nor->flags |= SNOR_F_HAS_LOCK;
> nor->flags &= ~SNOR_F_HAS_16BIT_SR;
> nor->params->quad_enable = NULL;
> - nor->params->set_4byte_addr_mode = micron_st_nor_set_4byte_addr_mode;
> + nor->params->set_4byte_addr_mode =
> + spi_nor_set_4byte_addr_mode_wren_en4b_ex4b;
> }
>
> static void micron_st_nor_late_init(struct spi_nor *nor)
> diff --git a/drivers/mtd/spi-nor/sfdp.c b/drivers/mtd/spi-nor/sfdp.c
> index 108a74ce38e0..01e35354db3e 100644
> --- a/drivers/mtd/spi-nor/sfdp.c
> +++ b/drivers/mtd/spi-nor/sfdp.c
> @@ -402,15 +402,20 @@ static void spi_nor_regions_sort_erase_types(struct spi_nor_erase_map *map)
> }
>
> /**
> - * spansion_set_4byte_addr_mode() - Set 4-byte address mode for Spansion
> - * flashes.
> + * spi_nor_set_4byte_addr_mode_brwr() - Set 4-byte address mode using
> + * SPINOR_OP_BRWR.
> * @nor: pointer to 'struct spi_nor'.
> * @enable: true to enter the 4-byte address mode, false to exit the 4-byte
> * address mode.
> *
> + * 8-bit volatile bank register used to define A[30:A24] bits. MSB (bit[7]) is

Typo. s/30:A24/30:24/

Other than this,

Reviewed-by: Pratyush Yadav <[email protected]>

> + * used to enable/disable 4-byte address mode. When MSB is set to ‘1’, 4-byte
> + * address mode is active and A[30:24] bits are don’t care. Write instruction is
> + * SPINOR_OP_BRWR(17h) with 1 byte of data.
> + *
> * Return: 0 on success, -errno otherwise.
> */
> -int spansion_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
> +int spi_nor_set_4byte_addr_mode_brwr(struct spi_nor *nor, bool enable)
> {
> int ret;
>
> @@ -434,14 +439,15 @@ int spansion_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
> }
>
> /**
> - * spi_nor_set_4byte_addr_mode() - Enter/Exit 4-byte address mode.
> + * spi_nor_set_4byte_addr_mode_en4b_ex4b() - Enter/Exit 4-byte address mode
> + * using SPINOR_OP_EN4B/SPINOR_OP_EX4B.
> * @nor: pointer to 'struct spi_nor'.
> * @enable: true to enter the 4-byte address mode, false to exit the 4-byte
> * address mode.
> *
> * Return: 0 on success, -errno otherwise.
> */
> -int spi_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
> +int spi_nor_set_4byte_addr_mode_en4b_ex4b(struct spi_nor *nor, bool enable)
> {
> int ret;
>
> @@ -465,15 +471,15 @@ int spi_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
> }
>
> /**
> - * micron_st_nor_set_4byte_addr_mode() - Set 4-byte address mode for ST and
> - * Micron flashes.
> + * spi_nor_set_4byte_addr_mode_wren_en4b_ex4b() - Set 4-byte address mode usingf
> + * SPINOR_OP_WREN followed by SPINOR_OP_EN4B or SPINOR_OP_EX4B.
> * @nor: pointer to 'struct spi_nor'.
> * @enable: true to enter the 4-byte address mode, false to exit the 4-byte
> * address mode.
> *
> * Return: 0 on success, -errno otherwise.
> */
> -int micron_st_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
> +int spi_nor_set_4byte_addr_mode_wren_en4b_ex4b(struct spi_nor *nor, bool enable)
> {
> int ret;
>
> @@ -481,7 +487,7 @@ int micron_st_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
> if (ret)
> return ret;
>
> - ret = spi_nor_set_4byte_addr_mode(nor, enable);
> + ret = spi_nor_set_4byte_addr_mode_en4b_ex4b(nor, enable);
> if (ret)
> return ret;
>
> @@ -729,15 +735,17 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor,
>
> switch (bfpt.dwords[BFPT_DWORD(16)] & BFPT_DWORD16_4B_ADDR_MODE_MASK) {
> case BFPT_DWORD16_4B_ADDR_MODE_BRWR:
> - params->set_4byte_addr_mode = spansion_set_4byte_addr_mode;
> + params->set_4byte_addr_mode = spi_nor_set_4byte_addr_mode_brwr;
> break;
>
> case BFPT_DWORD16_4B_ADDR_MODE_WREN_EN4B_EX4B:
> - params->set_4byte_addr_mode = micron_st_nor_set_4byte_addr_mode;
> + params->set_4byte_addr_mode =
> + spi_nor_set_4byte_addr_mode_wren_en4b_ex4b;
> break;
>
> case BFPT_DWORD16_4B_ADDR_MODE_EN4B_EX4B:
> - params->set_4byte_addr_mode = spi_nor_set_4byte_addr_mode;
> + params->set_4byte_addr_mode =
> + spi_nor_set_4byte_addr_mode_en4b_ex4b;
> break;
>
> default:
> diff --git a/drivers/mtd/spi-nor/sfdp.h b/drivers/mtd/spi-nor/sfdp.h
> index b56849079aea..da2d7ec2e0aa 100644
> --- a/drivers/mtd/spi-nor/sfdp.h
> +++ b/drivers/mtd/spi-nor/sfdp.h
> @@ -107,9 +107,10 @@ struct sfdp_parameter_header {
> u8 id_msb;
> };
>
> -int spansion_set_4byte_addr_mode(struct spi_nor *nor, bool enable);
> -int spi_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable);
> -int micron_st_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable);
> +int spi_nor_set_4byte_addr_mode_brwr(struct spi_nor *nor, bool enable);
> +int spi_nor_set_4byte_addr_mode_en4b_ex4b(struct spi_nor *nor, bool enable);
> +int spi_nor_set_4byte_addr_mode_wren_en4b_ex4b(struct spi_nor *nor,
> + bool enable);
> int spi_nor_parse_sfdp(struct spi_nor *nor);
>
> #endif /* __LINUX_MTD_SFDP_H */
> diff --git a/drivers/mtd/spi-nor/winbond.c b/drivers/mtd/spi-nor/winbond.c
> index 374ba82bff49..590e4d2c99d7 100644
> --- a/drivers/mtd/spi-nor/winbond.c
> +++ b/drivers/mtd/spi-nor/winbond.c
> @@ -142,7 +142,7 @@ static int winbond_nor_set_4byte_addr_mode(struct spi_nor *nor, bool enable)
> {
> int ret;
>
> - ret = spi_nor_set_4byte_addr_mode(nor, enable);
> + ret = spi_nor_set_4byte_addr_mode_en4b_ex4b(nor, enable);
> if (ret || enable)
> return ret;
>
> --
> 2.25.1
>

--
Regards,
Pratyush Yadav
Texas Instruments Inc.