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？

de-nordic · 2024-10-16T12:16:24Z

The offset used in flash_api_write is Flash physical address. This spi_nand driver was originally designed for Macronix MX35/31 series SPI NAND Flash. For example, we test this driver with Flash EPN MX35LF1GE4BC which has 2KB page size and 64 byte OOB area. And this driver will read ONFI parameter table to get the Flash info like page size, oob size in init process.

(@daniel-0723 sorry, I have allowed myself to add empty line above your comment because your response merged with the citation)

OK, so we should consider offset address given to flash API as logical, or rather dependent on whether obb/ecc feature of device is enabled or extra bytes are available for user.

de-nordic · 2025-01-21T09:14:02Z

@rogeryou Can you please fix the compliance and documentation?

daniel-0723 · 2025-01-22T01:14:39Z

@rogeryou Can you please fix the compliance and documentation?
OK, we will do the compliance check in local.

daniel-0723 · 2025-01-28T08:58:21Z

Hi @de-nordic , we have fixed the compliance and documentation, please review again.

de-nordic

There should be configuration for existing flash tests added, as the driver implements the Flash API and should work with these tests and samples we already have.

Some comments left, still reviewing.

de-nordic · 2025-02-05T16:22:17Z

drivers/flash/CMakeLists.txt

@@ -63,6 +63,8 @@ zephyr_library_sources_ifdef(CONFIG_SOC_FLASH_SMARTBOND flash_smartbond.c)
 zephyr_library_sources_ifdef(CONFIG_SOC_FLASH_TELINK_B91 soc_flash_b91.c)
 zephyr_library_sources_ifdef(CONFIG_SOC_FLASH_XMC4XXX soc_flash_xmc4xxx.c)
 zephyr_library_sources_ifdef(CONFIG_SPI_FLASH_AT45 spi_flash_at45.c)
+zephyr_library_sources_ifdef(CONFIG_SPI_NAND bch.c)


Not to be fixed with this PR, but just want to mention that I will propose enhancement where bch implementation gets moved to CRC subsystem.

de-nordic · 2025-02-05T16:22:54Z

drivers/flash/Kconfig.nand

@@ -0,0 +1,38 @@
+# Copyright (c) 2022 Macronix International Co., Ltd.


You probably want to update date in copyrights.

de-nordic · 2025-02-05T16:23:19Z

drivers/flash/Kconfig.nand

+
+menuconfig SPI_NAND
+	bool "SPI NAND Flash"
+	select FLASH_HAS_DRIVER_ENABLED


You are missing FLASH_HAS_EXPLICIT_ERASE

de-nordic · 2025-02-05T16:23:47Z

drivers/flash/Kconfig.nand

+	  Device is connected to SPI bus, it has to
+	  be initialized after SPI driver.
+
+config SPI_NAND_CS_WAIT_DELAY


Shouldn't this be defined in DTS for a device?

de-nordic · 2025-02-05T16:24:03Z

drivers/flash/Kconfig.nand

+	help
+	  This is the wait delay (in us) to allow for CS switching to take effect
+
+config SPI_NAND_IDLE_IN_DPD


Shouldn't this be defined in dts?

de-nordic · 2025-02-05T16:32:30Z

drivers/flash/spi_nand.c

+		LOG_ERR("Enable continuous read failed: %d\n", secur_reg);
+	}
+
+out: release_device(dev);


Labels alone in the line, drop the function call to the next line.

de-nordic · 2025-02-05T16:35:06Z

drivers/flash/spi_nand.c

+	return ret;
+}
+
+static int spi_nand_conti_read_enable(const struct device *dev)


Can we merge the spi_nand_conti_read_enable and spi_nand_conti_read_disable. They are looking very similar.

de-nordic · 2025-02-05T16:36:09Z

drivers/flash/spi_nand.c

+		size -= chunk;
+	}
+
+out: release_device(dev);


Labels get own lines.

de-nordic · 2025-02-05T16:37:53Z

drivers/flash/spi_nand.c

+		offset = addr % data->page_size;
+		chunk = (offset + size < data->page_size) ?
+			size : (data->page_size - offset);
+		read_bytes = chunk;


Do we need read_bytes; it seem that is equivalent of chunk, through the loop, and not used outside.

de-nordic · 2025-02-05T16:38:24Z

drivers/flash/spi_nand.c

+			goto out;
+		}
+
+		ret = spi_nand_wait_until_ready(dev);


unchecked ret, static analysis will not be happy.

embed · 2025-02-25T16:25:00Z

samples/drivers/spi_nand/README.rst

+   :name: JEDEC SPI-NAND flash
+   :relevant-api: flash_interface
+
+   Use the flash API to interact with an SPI NOR serial flash memory device.


Suggested change

Use the flash API to interact with an SPI NOR serial flash memory device.

Use the flash API to interact with an SPI NAND serial flash memory device.

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

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 from c7b00e4 to 51605d4 Compare December 3, 2024 08:26

daniel-0723 force-pushed the macronix_spi_nand_v1 branch from 51605d4 to c167d73 Compare December 10, 2024 09:02

de-nordic requested review from danieldegrasse and removed request for sslupsky, jacoba-at, coran21, diego-v-daq, bbooher, andy3469 and daniel-0723 December 13, 2024 10:05

daniel-0723 force-pushed the macronix_spi_nand_v1 branch 2 times, most recently from e014de8 to c167d73 Compare December 19, 2024 07:23

daniel-0723 force-pushed the macronix_spi_nand_v1 branch 6 times, most recently from 66a06e6 to 9d94e4c Compare January 28, 2025 01:25

de-nordic reviewed Feb 5, 2025

View reviewed changes

embed reviewed Feb 25, 2025

View reviewed changes

daniel-0723 force-pushed the macronix_spi_nand_v1 branch from 9d94e4c to e43cdde Compare February 27, 2025 08:33

de-nordic assigned de-nordic and unassigned nvlsianpu Feb 27, 2025

de-nordic added this to the v4.2.0 milestone Feb 27, 2025

drivers: Flash: Add SPI NAND Flash driver support

04e8854

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

daniel-0723 force-pushed the macronix_spi_nand_v1 branch from e43cdde to 04e8854 Compare February 27, 2025 10:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add spi nand driver #50690

add spi nand driver #50690

rogeryou commented Sep 27, 2022

erwango left a comment

carlescufi commented Sep 27, 2022

rogeryou commented Sep 28, 2022

Laczen commented Sep 29, 2022

RyKolb commented Nov 1, 2022

rogeryou commented Nov 23, 2022

rogeryou commented Nov 23, 2022

de-nordic commented Oct 16, 2024

de-nordic commented Jan 21, 2025

daniel-0723 commented Jan 22, 2025

daniel-0723 commented Jan 28, 2025

de-nordic left a comment

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

de-nordic Feb 5, 2025

embed Feb 25, 2025

		@@ -0,0 +1,38 @@
		# Copyright (c) 2022 Macronix International Co., Ltd.

	Use the flash API to interact with an SPI NOR serial flash memory device.
	Use the flash API to interact with an SPI NAND serial flash memory device.

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

erwango left a comment

Choose a reason for hiding this comment

carlescufi commented Sep 27, 2022

rogeryou commented Sep 28, 2022

Laczen commented Sep 29, 2022

RyKolb commented Nov 1, 2022

rogeryou commented Nov 23, 2022

rogeryou commented Nov 23, 2022

de-nordic commented Oct 16, 2024

de-nordic commented Jan 21, 2025

daniel-0723 commented Jan 22, 2025

daniel-0723 commented Jan 28, 2025

de-nordic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment