OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/drivers/flash/Kconfig.nor

93 lines
3.0 KiB
Plaintext
Raw Permalink Normal View History

drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
# Copyright (c) 2018 Savoir-Faire Linux.
flash/spi_nor: Mark driver with FLASH_HAS_EXPLICIT_ERASE Sets the Kconfig CONFIG_FLASH_HAS_EXPLICIT_ERASE. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2024-02-06 04:15:30 +08:00
# Copyright (c) 2024 Nordic Semiconductor ASA
#
drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
# SPDX-License-Identifier: Apache-2.0
menuconfig SPI_NOR
kconfig: Use a short consistent prompt style Same change as in commit 8cf8db3a73 ("Kconfig: Use a short, consistent style for prompts"), fixing stuff that got introduced since then. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-02-27 04:12:10 +08:00
bool "SPI NOR Flash"
drivers: flash: Update drivers to use devicetree Kconfig symbol Update flash drivers to use DT_HAS_<compat>_ENABLED Kconfig symbol to expose the driver and enable it by default based on devicetree. We remove 'depend on' Kconfig for symbols that would be implied by the devicetree node existing. Signed-off-by: Kumar Gala <galak@kernel.org>
2022-07-22 14:53:16 +08:00
default y
depends on DT_HAS_JEDEC_SPI_NOR_ENABLED
drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
select FLASH_HAS_DRIVER_ENABLED
flash/spi_nor: Mark driver with FLASH_HAS_EXPLICIT_ERASE Sets the Kconfig CONFIG_FLASH_HAS_EXPLICIT_ERASE. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2024-02-06 04:15:30 +08:00
select FLASH_HAS_EXPLICIT_ERASE
drivers: flash: spi nor: Add missing flash layout conf The at45 and nor spi flash drivers needs flash layout to work. Probably tested were conducted with SoC that already selects the FLASH_HAS_PAGE_LAYOUT for internal flash drivers. This add the missing dependency. Fixes #28094. Signed-off-by: Gerson Fernando Budke <nandojve@gmail.com>
2020-09-06 22:28:31 +08:00
select FLASH_HAS_PAGE_LAYOUT
drivers: flash: spi_nor: read erase support and page size from SFDP Use the new SFDP infrastructure to read the supported erase type sizes and commands from the Basic Flash Parameters block. This removes the need for explicit reference to most block sizes from this driver. We're also seeing devices where the page size is not 256 bytes. Accommodate them. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2020-05-31 06:44:08 +08:00
select FLASH_JESD216
drivers: flash: provide api to reset the flash registers changes enable flash driver to provide api interface to send reset memory spi command to the spi flash. The reset memory command would bring the spi flash to its default power-on state and loose all the volatile register settings. Flash reset is needed when more than one controller access the flash chip in a shared mode. Signed-off-by: Deepti Deshatty <deepti.deshatty@intel.corp-partner.google.com>
2023-08-01 12:14:55 +08:00
select FLASH_HAS_EX_OP
drivers: flash: spi: Move to using select in Kconfig for SPI bus Move to using 'select SPI' instead of 'depends on SPI' (see commit df81fef for more details) Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2022-10-25 17:29:23 +08:00
select SPI
drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
if SPI_NOR
drivers: flash: spi_nor: support multiple config sources This commit reworks the SPI NOR driver to be more flexible in how flash device configuration is obtained. Three alternatives are supported: * MINIMAL takes only the flash size from devicetree. The erase sizes are hard-coded to the traditionally supported instructures. * DEVICETREE requires that the data from the device's JESD216 Basic Flash Parameters table be provided through devicetree. This supports multiple page sizes and erase configurations, and lays a foundation for significant enhancements in the future including 4-byte address, sleeping while waiting for operation completion, and other features that are described by JESD216 parameters. * RUNTIME requires nothing from the devicetree node, instead reading the Basic Flash Parameters from the device at runtime. It extends DEVICETREE by allowing the same firmware to run on boards with different flash chips. For MINIMAL and DEVICETREE the JEDEC ID from the devicetree node is checked against the value read at runtime to confirm that the device configuration is accurate. The default SFDP source is MINIMAL. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2020-06-27 22:24:46 +08:00
choice SPI_NOR_SFDP
prompt "Source for Serial Flash Discoverable Parameters"
default SPI_NOR_SFDP_MINIMAL
config SPI_NOR_SFDP_MINIMAL
bool "Fixed flash configuration"
help
drivers: flash: spi_nor: Allow page-size to be set via devicetree In the CONFIG_SPI_NOR_SFDP_MINIMAL configuration this value is hard coded to 256 bytes. Make it configurable via devicetree. Signed-off-by: Andriy Gelman <andriy.gelman@gmail.com>
2023-07-12 23:02:06 +08:00
Synthesize a minimal configuration assuming 256 By page size (or as
set by the page-size devicetree property) and
drivers: flash: spi_nor: support multiple config sources This commit reworks the SPI NOR driver to be more flexible in how flash device configuration is obtained. Three alternatives are supported: * MINIMAL takes only the flash size from devicetree. The erase sizes are hard-coded to the traditionally supported instructures. * DEVICETREE requires that the data from the device's JESD216 Basic Flash Parameters table be provided through devicetree. This supports multiple page sizes and erase configurations, and lays a foundation for significant enhancements in the future including 4-byte address, sleeping while waiting for operation completion, and other features that are described by JESD216 parameters. * RUNTIME requires nothing from the devicetree node, instead reading the Basic Flash Parameters from the device at runtime. It extends DEVICETREE by allowing the same firmware to run on boards with different flash chips. For MINIMAL and DEVICETREE the JEDEC ID from the devicetree node is checked against the value read at runtime to confirm that the device configuration is accurate. The default SFDP source is MINIMAL. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2020-06-27 22:24:46 +08:00
standard 4 KiBy and 64 KiBy erase instructions. Requires the size and
jedec-id properties in the devicetree jedec,spi-nor node.
config SPI_NOR_SFDP_DEVICETREE
bool "Basic Flash Parameters from devicetree node"
help
The JESD216 Basic Flash Parameters table must be provided in the
sfdp-bfp property in devicetree. The size and jedec-id properties are
also required.
config SPI_NOR_SFDP_RUNTIME
bool "Read flash parameters at runtime"
help
Read all flash device characteristics from the device at runtime.
This option is the most flexible as it should provide functionality
for all supported JESD216-compatible devices.
endchoice
drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
config SPI_NOR_INIT_PRIORITY
drivers: flash: spi nor: Allow the init priority to be configurable Some applications may require the SPI NOR driver to be initialized earlier. This commit enables the user to change the default initialization priority. Signed-off-by: Vidar Berg <vidar.berg@nordicsemi.no>
2024-09-24 17:49:54 +08:00
int "Init priority"
drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
default 80
help
Device driver initialization priority.
Device is connected to SPI bus, it has to
be initialized after SPI driver.
drivers: flash: spi-nor: update towards device-tree support Use the jedec,spi-nor bindings to configure as much of the device as can be expressed by device tree. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-01-29 02:32:26 +08:00
config SPI_NOR_CS_WAIT_DELAY
int "Delay time in us"
drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
default 0
help
kconfig: Global whitespace/consistency cleanup Clean up space errors and use a consistent style throughout the Kconfig files. This makes reading the Kconfig files more distraction-free, helps with grepping, and encourages the same style getting copied around everywhere (meaning another pass hopefully won't be needed). Go for the most common style: - Indent properties with a single tab, including for choices. Properties on choices work exactly the same syntactically as properties on symbols, so not sure how the no-indentation thing happened. - Indent help texts with a tab followed by two spaces - Put a space between 'config' and the symbol name, not a tab. This also helps when grepping for definitions. - Do '# A comment' instead of '#A comment' I tweaked Kconfiglib a bit to find most of the stuff. Some help texts were reflowed to 79 columns with 'gq' in Vim as well, though not all, because I was afraid I'd accidentally mess up formatting. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-01 17:24:07 +08:00
This is the wait delay (in us) to allow for CS switching to take effect
drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
flash: spi_nor: don't hard loop in `wait_until_ready` Don't monopolise the CPU in `spi_nor_wait_until_ready`. For slow flash chips, operations can take minutes (Full chip erase on MX25R is listed as 120s typical, 240s max). Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2024-01-23 11:49:50 +08:00
config SPI_NOR_SLEEP_WHILE_WAITING_UNTIL_READY
bool "Sleep while waiting for flash operations to complete"
default y
help
Flash operations can take anywhere from 1ms to 240 seconds to
complete. Enabling this option adds a delay between polls on the
status register for slow operations. Disabling this option can
result in significant flash savings if this driver is the only user
of "k_sleep". This can be the case when building as a bootloader.
drivers/spi_nor: allow application control of flash layout page size The driver historically used the erase block size (64 KiBy) as the page size. There are other viable "sector" sizes, and for some applications this one may be too large. Allow the application to specify the desired flash page size. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-07-21 07:47:11 +08:00
config SPI_NOR_FLASH_LAYOUT_PAGE_SIZE
int "Page size to use for FLASH_LAYOUT feature"
default 65536
help
When CONFIG_FLASH_PAGE_LAYOUT is used this driver will support
that API. By default the page size corresponds to the block
size (65536). Other options include the 32K-byte erase size
drivers: spi_nor: improve documentation and validation on flash layout size The smallest region that can be erashed is one sector, so setting SPI_NOR_FLASH_LAYOUT_PAGE_SIZE=2048 will fail at runtime when the flash page API is used to erase a single (or misaligned) page. Add a compile-time check that the requested layout page size is erasable. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-10-29 18:18:46 +08:00
(32768), the sector size (4096), or any non-zero multiple of the
sector size.
drivers/spi_nor: allow application control of flash layout page size The driver historically used the erase block size (64 KiBy) as the page size. There are other viable "sector" sizes, and for some applications this one may be too large. Allow the application to specify the desired flash page size. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-07-21 07:47:11 +08:00
flash: spi_nor: automatically run device runtime PM Automatically handle device runtime PM for all flash API calls. Asynchronously release the device after a small delay to minimise power state transitions under multiple sequential API calls (e.g. NVS). Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-05-24 08:36:19 +08:00
config SPI_NOR_ACTIVE_DWELL_MS
int "Dwell period (ms) after last use to stay in active mode"
depends on PM_DEVICE_RUNTIME
default 10
help
Flash accesses commonly occur in bursts, where entering and exiting DPD
mode between each access adds significantly to the total operation time.
This option controls how long to remain in active mode after each API
call, eliminating the active->idle->active transition sequence if another
transaction occurs before the dwell period expires.
drivers: flash: add a generic spi nor flash driver This driver is inspired from the w25qxxdv SPI NOR flash driver which was already implementing the CFI (Common Flash Interface) for its purpose. To handle other NOR flash a flash id table (as Linux do) which contains the geometry for a few SPI NOR flash based on their JEDEC ID has been introduced. We currently support the following flash: - W25Q80 - W25Q16 - W25Q32 - S25FL216K - MX25UM512 The read and write functions are able to handle more then one page at a time and return the number of bytes read or write. Also because every NOR flash expect to disable the write protection before writing or erasing, the write enable command is now part of the write and erase functions. Signed-off-by: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
2018-11-12 23:36:24 +08:00
endif # SPI_NOR