[PATCH] mtd: spi-nor: core: Update documentation for info->fixup_flags

[PATCH] mtd: spi-nor: core: Update documentation for info->fixup_flags

[Tudor Ambarus]

From: Tudor Ambarus <tudor.ambarus@gmail.com>

fixup_flags should be used when the flash defines the mandatory BFPT
table, but doesn't define an optional SFDP table from which a
particular flash parameters is discovered.

Reported-by: Sudip Mukherjee <sudip.mukherjee@sifive.com>
Signed-off-by: Tudor Ambarus <tudor.ambarus@gmail.com>
---
 drivers/mtd/spi-nor/core.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/mtd/spi-nor/core.h b/drivers/mtd/spi-nor/core.h
index 3f841ec36e56..b87d61a105f7 100644
--- a/drivers/mtd/spi-nor/core.h
+++ b/drivers/mtd/spi-nor/core.h
@@ -466,10 +466,10 @@ struct spi_nor_fixups {
  *
  * @fixup_flags:    flags that indicate support that can be discovered via SFDP
  *                  ideally, but can not be discovered for this particular flash
- *                  because the SFDP table that indicates this support is not
- *                  defined by the flash. In case the table for this support is
- *                  defined but has wrong values, one should instead use a
- *                  post_sfdp() hook to set the SNOR_F equivalent flag.
+ *                  because the optional SFDP table that indicates this support
+ *                  is not defined by the flash. In case the table for this
+ *                  support is defined but has wrong values, one should instead
+ *                  use a post_sfdp() hook to set the SNOR_F equivalent flag.
  *
  *   SPI_NOR_4B_OPCODES:      use dedicated 4byte address op codes to support
  *                            memory size above 128Mib.
-- 
2.25.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

Re: [PATCH] mtd: spi-nor: core: Update documentation for info->fixup_flags

[Michael Walle]

Am 2022-08-10 17:59, schrieb Tudor Ambarus:
> From: Tudor Ambarus <tudor.ambarus@gmail.com>
> 
> fixup_flags should be used when the flash defines the mandatory BFPT
> table, but doesn't define an optional SFDP table from which a
> particular flash parameters is discovered.
> 
> Reported-by: Sudip Mukherjee <sudip.mukherjee@sifive.com>
> Signed-off-by: Tudor Ambarus <tudor.ambarus@gmail.com>

Reviewed-by: Michael Walle <michael@walle.cc>

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

Re: [PATCH] mtd: spi-nor: core: Update documentation for info->fixup_flags

[Pratyush Yadav]

Hi,

On 10/08/22 06:59PM, Tudor Ambarus wrote:
> From: Tudor Ambarus <tudor.ambarus@gmail.com>
> 
> fixup_flags should be used when the flash defines the mandatory BFPT
> table, but doesn't define an optional SFDP table from which a
> particular flash parameters is discovered.
> 
> Reported-by: Sudip Mukherjee <sudip.mukherjee@sifive.com>
> Signed-off-by: Tudor Ambarus <tudor.ambarus@gmail.com>
> ---
>  drivers/mtd/spi-nor/core.h | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/mtd/spi-nor/core.h b/drivers/mtd/spi-nor/core.h
> index 3f841ec36e56..b87d61a105f7 100644
> --- a/drivers/mtd/spi-nor/core.h
> +++ b/drivers/mtd/spi-nor/core.h
> @@ -466,10 +466,10 @@ struct spi_nor_fixups {
>   *
>   * @fixup_flags:    flags that indicate support that can be discovered via SFDP
>   *                  ideally, but can not be discovered for this particular flash
> - *                  because the SFDP table that indicates this support is not
> - *                  defined by the flash. In case the table for this support is
> - *                  defined but has wrong values, one should instead use a
> - *                  post_sfdp() hook to set the SNOR_F equivalent flag.
> + *                  because the optional SFDP table that indicates this support
> + *                  is not defined by the flash. In case the table for this
> + *                  support is defined but has wrong values, one should instead
> + *                  use a post_sfdp() hook to set the SNOR_F equivalent flag.

Not sure if it makes much of a difference adding just the word 
"optional". It might be better to explicitly state that it is used when 
the flash defines the mandatory tables but not the optional ones, like 
you do in the commit message.

Anyway, I don't think we should spend too many cycles on this relatively 
trivial patch, so either way is fine by me.

>   *
>   *   SPI_NOR_4B_OPCODES:      use dedicated 4byte address op codes to support
>   *                            memory size above 128Mib.
> -- 
> 2.25.1
> 

-- 
Regards,
Pratyush Yadav

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/