add spi nand driver #50690

rogeryou · 2022-09-27T09:17:22Z

This PR is updated for #43915.

Add SPI NAND block device driver for using SPI NAND Flash like Macronix Flash MX31LF4GE4BC.
This driver is tested on STM32L562E-DK.

The license of BCH code is updated.

erwango

Thanks for this contribution.
Some clean up required.
My main request would be to remove STM32 mentions, since there is nothing STM32 specific here aside from the board used for test.

samples/drivers/spi_nand/README.rst

samples/drivers/spi_nand/boards/stm32l562e_dk.overlay

drivers/flash/CMakeLists.txt.orig

drivers/flash/Kconfig.orig

drivers/flash/bch.c

drivers/flash/spi_nand.c

carlescufi · 2022-09-27T10:36:30Z

@rogeryou can you please format your commits as described here:
https://docs.zephyrproject.org/latest/contribute/guidelines.html#commit-guidelines

rogeryou · 2022-09-28T03:20:00Z

@rogeryou can you please format your commits as described here: https://docs.zephyrproject.org/latest/contribute/guidelines.html#commit-guidelines

I have formated my commits.

Laczen · 2022-09-29T12:29:23Z

@rogeryou, thank you for this contribution. It would be very nice to have nand flash support in zephyr.

Regarding the PR, I have seen that the ecc is hidden for the user as to be able to use the standard flash interface. This is a good thing, but doesn't this also make any other part of the oob data unavailable ? IMHO it would be good to extend the flash driver for nand flashes with read/write possibilities of the oob data. This would allow adding bad block info to the oob area.

RyKolb · 2022-11-01T03:24:34Z

@rogeryou
It seems as though part of this driver is written for either a 2048 or 4096 page size NAND flash, and yet other parts use the defined page/block offset/mask. Is there reasoning behind this?

drivers/flash/spi_nand.h

samples/drivers/spi_nand/boards/stm32l562e_dk.conf

samples/drivers/spi_nand/prj.conf

samples/drivers/spi_nand/sample.yaml

samples/drivers/spi_nand/src/main.c

rogeryou · 2022-11-23T06:02:40Z

@rogeryou, thank you for this contribution. It would be very nice to have nand flash support in zephyr.

Regarding the PR, I have seen that the ecc is hidden for the user as to be able to use the standard flash interface. This is a good thing, but doesn't this also make any other part of the oob data unavailable ? IMHO it would be good to extend the flash driver for nand flashes with read/write possibilities of the oob data. This would allow adding bad block info to the oob area.

Thank you for your suggestion. We will add APIs that operate OOB later.

rogeryou · 2022-11-23T06:43:05Z

@rogeryou It seems as though part of this driver is written for either a 2048 or 4096 page size NAND flash, and yet other parts use the defined page/block offset/mask. Is there reasoning behind this?

Could you tell me which part of the program you mentioned？

drivers/flash/spi_nand.c

pdgendt · 2025-05-28T06:46:48Z

drivers/flash/spi_nand.c

+DEVICE_DT_INST_DEFINE(0, &spi_nand_init, NULL,
+		 &spi_nand_data_0, &spi_nand_config_0,
+		 POST_KERNEL, CONFIG_SPI_NAND_INIT_PRIORITY,
+		 &spi_nand_api);


If it would be possible to have multiple instances use, DT_INST_FOREACH_STATUS_OKAY

If I may, I think that we can do that later, I would really like to focus on having even one instance driver working at this point.

Sure, but this isn't difficult to do really?

No it is not, it is just few more lines. But these are another few lines to review before we get this thing in. Something we can easily get done later.
I doubt that you will have immediate need to connect N devices, if you have not been able to connect one for so long.

dts/bindings/mtd/jedec,spi-nand.yaml

samples/drivers/spi_nand/prj.conf

pdgendt · 2025-05-28T06:48:33Z

samples/drivers/spi_nand/CMakeLists.txt

Do we want driver specific samples? Can't you re-use the existing flash driver sample?

SPI NAND Flash is a page-program type device and does not support 4-byte data programming. We also plan to add some software ECC test cases later.

drivers/flash/spi_nand.c

pdgendt

The commit should be split in two, one for the driver and another for the sample.

drivers/flash/bch.c

drivers/flash/Kconfig

drivers/flash/spi_nand.c

drivers/flash/bch.c

daniel-0723 · 2025-06-04T08:31:34Z

@de-nordic @pdgendt Please review again.

pdgendt

Please run clang-format on the new .c/.h files.

drivers/flash/spi_nand.c

drivers/flash/bch.c

drivers/flash/spi_nand.c

drivers/flash/Kconfig.nand

drivers/flash/bch.c

drivers/flash/bch.h

drivers/flash/spi_nand.c

drivers/flash/Kconfig.nand

Unblock the PR

Add SPI NAND Flash driver support Signed-off-by: Daniel Zhang <[email protected]>

sonarqubecloud · 2025-06-09T14:15:52Z

Quality Gate passed

Issues
15 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
2.8% Duplication on New Code

See analysis details on SonarQube Cloud

daniel-0723 · 2025-06-09T14:49:49Z

@de-nordic Please review again.

rogeryou requested review from nashif, erwango and nvlsianpu as code owners September 27, 2022 09:17

zephyrbot added area: Devicetree platform: STM32 ST Micro STM32 area: Flash labels Sep 27, 2022

zephyrbot requested review from ABOSTM, FRASTM, galak, GeorgeCGV, gmarull and mbolivar-nordic September 27, 2022 09:17

zephyrbot assigned nvlsianpu Sep 27, 2022

erwango requested changes Sep 27, 2022

View reviewed changes

erwango removed the platform: STM32 ST Micro STM32 label Sep 27, 2022

rogeryou force-pushed the macronix_spi_nand_v1 branch from 9755c14 to 901b863 Compare September 28, 2022 03:16

carlescufi requested review from Laczen and removed request for GeorgeCGV, gmarull and mbolivar-nordic November 2, 2022 14:12

erwango previously requested changes Nov 8, 2022

View reviewed changes

rogeryou closed this Nov 23, 2022

rogeryou reopened this Nov 23, 2022

zephyrbot added the area: Devicetree Binding PR modifies or adds a Device Tree binding label Nov 23, 2022

daniel-0723 force-pushed the macronix_spi_nand_v1 branch 3 times, most recently from 555fd5d to eaf79f9 Compare May 28, 2025 01:57

pdgendt previously requested changes May 28, 2025

View reviewed changes

daniel-0723 force-pushed the macronix_spi_nand_v1 branch 3 times, most recently from 3d4d13d to ad279f4 Compare June 2, 2025 02:07

pdgendt reviewed Jun 2, 2025

View reviewed changes

drivers/flash/bch.c Outdated Show resolved Hide resolved

drivers/flash/Kconfig Outdated Show resolved Hide resolved

drivers/flash/spi_nand.c Outdated Show resolved Hide resolved

drivers/flash/bch.c Outdated Show resolved Hide resolved

daniel-0723 force-pushed the macronix_spi_nand_v1 branch 5 times, most recently from 381b034 to ead3591 Compare June 3, 2025 06:55

pdgendt reviewed Jun 3, 2025

View reviewed changes

drivers/flash/bch.c Outdated Show resolved Hide resolved

drivers/flash/bch.c Outdated Show resolved Hide resolved

drivers/flash/bch.c Outdated Show resolved Hide resolved

drivers/flash/bch.c Outdated Show resolved Hide resolved

daniel-0723 force-pushed the macronix_spi_nand_v1 branch from ead3591 to 4236599 Compare June 4, 2025 06:05

pdgendt reviewed Jun 4, 2025

View reviewed changes

daniel-0723 force-pushed the macronix_spi_nand_v1 branch from 4236599 to 11f2630 Compare June 4, 2025 12:35

pdgendt reviewed Jun 4, 2025

View reviewed changes

drivers/flash/spi_nand.c Outdated Show resolved Hide resolved

drivers/flash/spi_nand.c Outdated Show resolved Hide resolved

drivers/flash/spi_nand.c Outdated Show resolved Hide resolved

daniel-0723 force-pushed the macronix_spi_nand_v1 branch from 11f2630 to d580172 Compare June 9, 2025 02:45

pdgendt reviewed Jun 9, 2025

View reviewed changes

daniel-0723 force-pushed the macronix_spi_nand_v1 branch from d580172 to 90e3228 Compare June 9, 2025 11:48

pdgendt reviewed Jun 9, 2025

View reviewed changes

drivers/flash/Kconfig.nand Outdated Show resolved Hide resolved

drivers/flash/Kconfig.nand Outdated Show resolved Hide resolved

daniel-0723 force-pushed the macronix_spi_nand_v1 branch 2 times, most recently from f5bd58e to e352357 Compare June 9, 2025 12:34

drivers: Flash: Add SPI NAND Flash driver support

84f8da1

Add SPI NAND Flash driver support Signed-off-by: Daniel Zhang <[email protected]>

daniel-0723 force-pushed the macronix_spi_nand_v1 branch from e352357 to 84f8da1 Compare June 9, 2025 13:51

add spi nand driver #50690

Are you sure you want to change the base?

add spi nand driver #50690

Conversation

rogeryou commented Sep 27, 2022

Uh oh!

erwango left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

carlescufi commented Sep 27, 2022

Uh oh!

rogeryou commented Sep 28, 2022

Uh oh!

Laczen commented Sep 29, 2022

Uh oh!

RyKolb commented Nov 1, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rogeryou commented Nov 23, 2022

Uh oh!

rogeryou commented Nov 23, 2022

Uh oh!

Uh oh!

pdgendt May 28, 2025

Choose a reason for hiding this comment

Uh oh!

de-nordic May 29, 2025

Choose a reason for hiding this comment

Uh oh!

pdgendt May 30, 2025

Choose a reason for hiding this comment

Uh oh!

de-nordic May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pdgendt May 28, 2025

Choose a reason for hiding this comment

Uh oh!

daniel-0723 Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pdgendt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daniel-0723 commented Jun 4, 2025

Uh oh!

pdgendt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

de-nordic May 30, 2025 •

edited

Loading