2022-05-13 14:32:53

by Michael Walle

[permalink] [raw]
Subject: [PATCH 5/6] mtd: spi-nor: add generic flash driver

Our SFDP is parsing is everything we need to support all basic
operations of a flash device. If the flash isn't found in our in-kernel
flash database, gracefully fall back to a driver described solely by its
SFDP tables.

It is still recommended to add the flash to the in-kernel database.
First, we get a proper partname and secondly, for all features not
described by the SFDP like OTP we need the entry anyway.

Signed-off-by: Michael Walle <[email protected]>
---
drivers/mtd/spi-nor/core.c | 13 +++++++++++++
drivers/mtd/spi-nor/core.h | 1 +
drivers/mtd/spi-nor/sfdp.c | 27 +++++++++++++++++++++++++++
3 files changed, 41 insertions(+)

diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c
index 65cd8e668579..ee193a61310a 100644
--- a/drivers/mtd/spi-nor/core.c
+++ b/drivers/mtd/spi-nor/core.c
@@ -1632,6 +1632,11 @@ static const struct spi_nor_manufacturer *manufacturers[] = {
&spi_nor_xmc,
};

+static const struct flash_info spi_nor_generic_flash = {
+ .name = "spi-nor-generic",
+ .parse_sfdp = true,
+};
+
static const struct flash_info *spi_nor_match_id(struct spi_nor *nor,
const u8 *id)
{
@@ -1670,6 +1675,14 @@ static const struct flash_info *spi_nor_detect(struct spi_nor *nor)
return ERR_PTR(-ENOMEM);

info = spi_nor_match_id(nor, id);
+
+ /* Fallback to a generic flash described only by its SFDP data. */
+ if (!info) {
+ ret = spi_nor_check_sfdp_signature(nor);
+ if (!ret)
+ info = &spi_nor_generic_flash;
+ }
+
if (!info) {
dev_err(nor->dev, "unrecognized JEDEC id bytes: %*ph\n",
SPI_NOR_MAX_ID_LEN, id);
diff --git a/drivers/mtd/spi-nor/core.h b/drivers/mtd/spi-nor/core.h
index 3a19b8092ab8..aa9f218245a5 100644
--- a/drivers/mtd/spi-nor/core.h
+++ b/drivers/mtd/spi-nor/core.h
@@ -694,6 +694,7 @@ int spi_nor_controller_ops_read_reg(struct spi_nor *nor, u8 opcode,
int spi_nor_controller_ops_write_reg(struct spi_nor *nor, u8 opcode,
const u8 *buf, size_t len);

+int spi_nor_check_sfdp_signature(struct spi_nor *nor);
int spi_nor_parse_sfdp(struct spi_nor *nor);

static inline struct spi_nor *mtd_to_spi_nor(struct mtd_info *mtd)
diff --git a/drivers/mtd/spi-nor/sfdp.c b/drivers/mtd/spi-nor/sfdp.c
index a5211543d30d..9bdb3d5dc7e8 100644
--- a/drivers/mtd/spi-nor/sfdp.c
+++ b/drivers/mtd/spi-nor/sfdp.c
@@ -1247,6 +1247,33 @@ static void spi_nor_post_sfdp_fixups(struct spi_nor *nor)
nor->info->fixups->post_sfdp(nor);
}

+/**
+ * spi_nor_check_sfdp_header() - check for a valid SFDP header
+ * @nor: pointer to a 'struct spi_nor'
+ *
+ * Used to detect if the flash supports the RDSFDP command as well as the
+ * presence of a valid SFDP table.
+ *
+ * Return: 0 on success, -errno otherwise.
+ */
+int spi_nor_check_sfdp_signature(struct spi_nor *nor)
+{
+ u32 signature;
+ int err;
+
+ /* Get the SFDP header. */
+ err = spi_nor_read_sfdp_dma_unsafe(nor, 0, sizeof(signature),
+ &signature);
+ if (err < 0)
+ return err;
+
+ /* Check the SFDP signature. */
+ if (le32_to_cpu(signature) != SFDP_SIGNATURE)
+ return -EINVAL;
+
+ return 0;
+}
+
/**
* spi_nor_parse_sfdp() - parse the Serial Flash Discoverable Parameters.
* @nor: pointer to a 'struct spi_nor'
--
2.30.2



2022-05-14 03:34:26

by kernel test robot

[permalink] [raw]
Subject: Re: [PATCH 5/6] mtd: spi-nor: add generic flash driver

Hi Michael,

I love your patch! Perhaps something to improve:

[auto build test WARNING on mtd/spi-nor/next]
[also build test WARNING on next-20220513]
[cannot apply to linux/master linus/master v5.18-rc6]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url: https://github.com/intel-lab-lkp/linux/commits/Michael-Walle/mtd-spi-nor-generic-flash-driver/20220513-214238
base: https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git spi-nor/next
config: m68k-allyesconfig (https://download.01.org/0day-ci/archive/20220513/[email protected]/config)
compiler: m68k-linux-gcc (GCC) 11.3.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/d38c0ac1528d85bea65fc5a9e7f61a10dbc051fb
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Michael-Walle/mtd-spi-nor-generic-flash-driver/20220513-214238
git checkout d38c0ac1528d85bea65fc5a9e7f61a10dbc051fb
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-11.3.0 make.cross W=1 O=build_dir ARCH=m68k SHELL=/bin/bash drivers/mtd/spi-nor/

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <[email protected]>

All warnings (new ones prefixed by >>):

>> drivers/mtd/spi-nor/sfdp.c:1260: warning: expecting prototype for spi_nor_check_sfdp_header(). Prototype was for spi_nor_check_sfdp_signature() instead


vim +1260 drivers/mtd/spi-nor/sfdp.c

1249
1250 /**
1251 * spi_nor_check_sfdp_header() - check for a valid SFDP header
1252 * @nor: pointer to a 'struct spi_nor'
1253 *
1254 * Used to detect if the flash supports the RDSFDP command as well as the
1255 * presence of a valid SFDP table.
1256 *
1257 * Return: 0 on success, -errno otherwise.
1258 */
1259 int spi_nor_check_sfdp_signature(struct spi_nor *nor)
> 1260 {
1261 u32 signature;
1262 int err;
1263
1264 /* Get the SFDP header. */
1265 err = spi_nor_read_sfdp_dma_unsafe(nor, 0, sizeof(signature),
1266 &signature);
1267 if (err < 0)
1268 return err;
1269
1270 /* Check the SFDP signature. */
1271 if (le32_to_cpu(signature) != SFDP_SIGNATURE)
1272 return -EINVAL;
1273
1274 return 0;
1275 }
1276

--
0-DAY CI Kernel Test Service
https://01.org/lkp

2022-07-21 09:33:36

by Biju Das

[permalink] [raw]
Subject: Re: [PATCH 5/6] mtd: spi-nor: add generic flash driver

> Our SFDP is parsing is everything we need to support all basic operations of
> a flash device. If the flash isn't found in our in-kernel flash database,
> gracefully fall back to a driver described solely by its SFDP tables.
>
> It is still recommended to add the flash to the in-kernel database.
> First, we get a proper partname and secondly, for all features not described
> by the SFDP like OTP we need the entry anyway.
>
> Signed-off-by: Michael Walle <[email protected]>
> ---
> drivers/mtd/spi-nor/core.c | 13 +++++++++++++ drivers/mtd/spi-nor/core.h |
> 1 + drivers/mtd/spi-nor/sfdp.c | 27 +++++++++++++++++++++++++++
> 3 files changed, 41 insertions(+)
>
> diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c index
> 65cd8e668579..ee193a61310a 100644
> --- a/drivers/mtd/spi-nor/core.c
> +++ b/drivers/mtd/spi-nor/core.c
> @@ -1632,6 +1632,11 @@ static const struct spi_nor_manufacturer
> *manufacturers[] = {
> &spi_nor_xmc,
> };
>
> +static const struct flash_info spi_nor_generic_flash = {
> + .name = "spi-nor-generic",
> + .parse_sfdp = true,
> +};
> +
> static const struct flash_info *spi_nor_match_id(struct spi_nor *nor,
> const u8 *id)
> {
> @@ -1670,6 +1675,14 @@ static const struct flash_info *spi_nor_detect(struct
> spi_nor *nor)
> return ERR_PTR(-ENOMEM);
>
> info = spi_nor_match_id(nor, id);
> +
> + /* Fallback to a generic flash described only by its SFDP data. */
> + if (!info) {
> + ret = spi_nor_check_sfdp_signature(nor);
> + if (!ret)
> + info = &spi_nor_generic_flash;
> + }

May be this can be combined as

if (!info && (!spi_nor_check_sfdp_signature(nor)))
info = &spi_nor_generic_flash;

Cheers,
Biju

> if (!info) {
> dev_err(nor->dev, "unrecognized JEDEC id bytes: %*ph\n",
> SPI_NOR_MAX_ID_LEN, id);
> diff --git a/drivers/mtd/spi-nor/core.h b/drivers/mtd/spi-nor/core.h index
> 153cb4b174ee..b084cb6db401 100644
> --- a/drivers/mtd/spi-nor/core.h
> +++ b/drivers/mtd/spi-nor/core.h
> @@ -703,6 +703,7 @@ int spi_nor_controller_ops_read_reg(struct spi_nor *nor,
> u8 opcode, int spi_nor_controller_ops_write_reg(struct spi_nor *nor, u8
> opcode,
> const u8 *buf, size_t len);
>
> +int spi_nor_check_sfdp_signature(struct spi_nor *nor);
> int spi_nor_parse_sfdp(struct spi_nor *nor);
>
> static inline struct spi_nor *mtd_to_spi_nor(struct mtd_info *mtd) diff --
> git a/drivers/mtd/spi-nor/sfdp.c b/drivers/mtd/spi-nor/sfdp.c index
> a5211543d30d..9bdb3d5dc7e8 100644
> --- a/drivers/mtd/spi-nor/sfdp.c
> +++ b/drivers/mtd/spi-nor/sfdp.c
> @@ -1247,6 +1247,33 @@ static void spi_nor_post_sfdp_fixups(struct spi_nor
> *nor)
> nor->info->fixups->post_sfdp(nor);
> }
>
> +/**
> + * spi_nor_check_sfdp_header() - check for a valid SFDP header
> + * @nor: pointer to a 'struct spi_nor'
> + *
> + * Used to detect if the flash supports the RDSFDP command as well as
> +the
> + * presence of a valid SFDP table.
> + *
> + * Return: 0 on success, -errno otherwise.
> + */
> +int spi_nor_check_sfdp_signature(struct spi_nor *nor) {
> + u32 signature;
> + int err;
> +
> + /* Get the SFDP header. */
> + err = spi_nor_read_sfdp_dma_unsafe(nor, 0, sizeof(signature),
> + &signature);
> + if (err < 0)
> + return err;
> +
> + /* Check the SFDP signature. */
> + if (le32_to_cpu(signature) != SFDP_SIGNATURE)
> + return -EINVAL;
> +
> + return 0;
> +}
> +
> /**
> * spi_nor_parse_sfdp() - parse the Serial Flash Discoverable Parameters.
> * @nor: pointer to a 'struct spi_nor'
> --
> 2.25.1


2022-07-21 10:17:42

by Michael Walle

[permalink] [raw]
Subject: Re: [PATCH 5/6] mtd: spi-nor: add generic flash driver

Hi,

>> +
>> + /* Fallback to a generic flash described only by its SFDP data. */
>> + if (!info) {
>> + ret = spi_nor_check_sfdp_signature(nor);
>> + if (!ret)
>> + info = &spi_nor_generic_flash;
>> + }
>
> May be this can be combined as
>
> if (!info && (!spi_nor_check_sfdp_signature(nor)))
> info = &spi_nor_generic_flash;

While this is the behavior, I don't like (1) calling functions
in the condition and (2) rely on the && and || semantics, i.e.
to just call the second part if the first is true/false.

-michael

2022-07-21 10:33:32

by Biju Das

[permalink] [raw]
Subject: RE: [PATCH 5/6] mtd: spi-nor: add generic flash driver

Hi Michael Walle,

> Subject: Re: [PATCH 5/6] mtd: spi-nor: add generic flash driver
>
> Hi,
>
> >> +
> >> + /* Fallback to a generic flash described only by its SFDP data. */
> >> + if (!info) {
> >> + ret = spi_nor_check_sfdp_signature(nor);
> >> + if (!ret)
> >> + info = &spi_nor_generic_flash;
> >> + }
> >
> > May be this can be combined as
> >
> > if (!info && (!spi_nor_check_sfdp_signature(nor)))
> > info = &spi_nor_generic_flash;
>
> While this is the behavior, I don't like (1) calling functions in the
> condition and (2) rely on the && and || semantics, i.e.
> to just call the second part if the first is true/false.

OK fine. I recently got a review comment from mainline for optimizing the number
of lines. That is the reason for suggestion.

Cheers,
biju

2022-07-28 03:46:19

by Tudor Ambarus

[permalink] [raw]
Subject: Re: [PATCH 5/6] mtd: spi-nor: add generic flash driver

On 5/13/22 16:35, Michael Walle wrote:
> It is still recommended to add the flash to the in-kernel database.
> First, we get a proper partname and secondly, for all features not

I wouldn't advertise to add an entry in the flash_info array just for
the sake of a proper name. The name shouldn't matter. If all the flash
caps can be discovered when parsing SFDP let's not add an entry at all.

> described by the SFDP like OTP we need the entry anyway.

Yeah, caps like OTP are not SFDP discoverable, we should add a flash_entry
when things can not be discovered solely by parsing SFDP.

--
Cheers,
ta

2022-07-29 01:41:45

by Takahiro Kuwano

[permalink] [raw]
Subject: Re: [PATCH 5/6] mtd: spi-nor: add generic flash driver

On 5/13/2022 10:35 PM, Michael Walle wrote:
> Our SFDP is parsing is everything we need to support all basic
redundant "is"?

> operations of a flash device. If the flash isn't found in our in-kernel
> flash database, gracefully fall back to a driver described solely by its
> SFDP tables.
>
> It is still recommended to add the flash to the in-kernel database.
> First, we get a proper partname and secondly, for all features not
> described by the SFDP like OTP we need the entry anyway.
>
> Signed-off-by: Michael Walle <[email protected]>
> ---
> drivers/mtd/spi-nor/core.c | 13 +++++++++++++
> drivers/mtd/spi-nor/core.h | 1 +
> drivers/mtd/spi-nor/sfdp.c | 27 +++++++++++++++++++++++++++
> 3 files changed, 41 insertions(+)
>
> diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c
> index 65cd8e668579..ee193a61310a 100644
> --- a/drivers/mtd/spi-nor/core.c
> +++ b/drivers/mtd/spi-nor/core.c
> @@ -1632,6 +1632,11 @@ static const struct spi_nor_manufacturer *manufacturers[] = {
> &spi_nor_xmc,
> };
>
> +static const struct flash_info spi_nor_generic_flash = {
> + .name = "spi-nor-generic",
> + .parse_sfdp = true,
> +};
> +
> static const struct flash_info *spi_nor_match_id(struct spi_nor *nor,
> const u8 *id)
> {
> @@ -1670,6 +1675,14 @@ static const struct flash_info *spi_nor_detect(struct spi_nor *nor)
> return ERR_PTR(-ENOMEM);
>
> info = spi_nor_match_id(nor, id);
> +
> + /* Fallback to a generic flash described only by its SFDP data. */
> + if (!info) {
> + ret = spi_nor_check_sfdp_signature(nor);
> + if (!ret)
> + info = &spi_nor_generic_flash;
> + }
> +
> if (!info) {
> dev_err(nor->dev, "unrecognized JEDEC id bytes: %*ph\n",
> SPI_NOR_MAX_ID_LEN, id);
> diff --git a/drivers/mtd/spi-nor/core.h b/drivers/mtd/spi-nor/core.h
> index 3a19b8092ab8..aa9f218245a5 100644
> --- a/drivers/mtd/spi-nor/core.h
> +++ b/drivers/mtd/spi-nor/core.h
> @@ -694,6 +694,7 @@ int spi_nor_controller_ops_read_reg(struct spi_nor *nor, u8 opcode,
> int spi_nor_controller_ops_write_reg(struct spi_nor *nor, u8 opcode,
> const u8 *buf, size_t len);
>
> +int spi_nor_check_sfdp_signature(struct spi_nor *nor);
> int spi_nor_parse_sfdp(struct spi_nor *nor);
>
> static inline struct spi_nor *mtd_to_spi_nor(struct mtd_info *mtd)
> diff --git a/drivers/mtd/spi-nor/sfdp.c b/drivers/mtd/spi-nor/sfdp.c
> index a5211543d30d..9bdb3d5dc7e8 100644
> --- a/drivers/mtd/spi-nor/sfdp.c
> +++ b/drivers/mtd/spi-nor/sfdp.c
> @@ -1247,6 +1247,33 @@ static void spi_nor_post_sfdp_fixups(struct spi_nor *nor)
> nor->info->fixups->post_sfdp(nor);
> }
>
> +/**
> + * spi_nor_check_sfdp_header() - check for a valid SFDP header
> + * @nor: pointer to a 'struct spi_nor'
> + *
> + * Used to detect if the flash supports the RDSFDP command as well as the
> + * presence of a valid SFDP table.
> + *
> + * Return: 0 on success, -errno otherwise.
> + */
> +int spi_nor_check_sfdp_signature(struct spi_nor *nor)
> +{
> + u32 signature;
> + int err;
> +
> + /* Get the SFDP header. */
> + err = spi_nor_read_sfdp_dma_unsafe(nor, 0, sizeof(signature),
> + &signature);
> + if (err < 0)
> + return err;
> +
> + /* Check the SFDP signature. */
> + if (le32_to_cpu(signature) != SFDP_SIGNATURE)
> + return -EINVAL;
> +
> + return 0;
> +}
> +

Nice to use this function from spi_nor_parse_sfdp() as well, but I found it's
not straightforward...

Reviewed-by: Takahiro Kuwano <[email protected]>

Thanks,
Takahiro

2022-10-28 18:09:08

by Biju Das

[permalink] [raw]
Subject: RE: [PATCH 5/6] mtd: spi-nor: add generic flash driver

Hi All,

Any update on [1]?. As per [2], we need to use generic flash driver as our flash chip
supports sfdp. Anything to be improved on [1]?? Please let us know.

[1] https://lore.kernel.org/lkml/[email protected]/T/#m3ce890b65360f9fbe17b813d692f848b5c6d78e7
[2] https://patchwork.kernel.org/project/linux-renesas-soc/patch/[email protected]/

Cheers,
Biju

> Subject: RE: [PATCH 5/6] mtd: spi-nor: add generic flash driver
>
> Hi Michael Walle,
>
> > Subject: Re: [PATCH 5/6] mtd: spi-nor: add generic flash driver
> >
> > Hi,
> >
> > >> +
> > >> + /* Fallback to a generic flash described only by its SFDP
> data. */
> > >> + if (!info) {
> > >> + ret = spi_nor_check_sfdp_signature(nor);
> > >> + if (!ret)
> > >> + info = &spi_nor_generic_flash;
> > >> + }
> > >
> > > May be this can be combined as
> > >
> > > if (!info && (!spi_nor_check_sfdp_signature(nor)))
> > > info = &spi_nor_generic_flash;
> >
> > While this is the behavior, I don't like (1) calling functions in
> the
> > condition and (2) rely on the && and || semantics, i.e.
> > to just call the second part if the first is true/false.
>
> OK fine. I recently got a review comment from mainline for optimizing
> the number of lines. That is the reason for suggestion.
>
> Cheers,
> biju