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

79 lines
2.4 KiB
Plaintext
Raw 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.
# 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
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
kconfig: drivers: flash: Remove redundant FLASH dependencies These are from source'ing a file within an 'if FLASH', and then adding another 'depends on FLASH' within it. 'if FOO' is just shorthand for adding 'depends on FOO' to each item within the 'if'. There are no "conditional includes" in Kconfig, so 'if FOO' has no special meaning around a 'source'. Conditional includes wouldn't be possible, because an 'if' condition could include (directly or indirectly) forward references to symbols not defined yet. Tip: When adding a symbol, check its dependencies in the menuconfig ('ninja menuconfig', then / to jump to the symbol). The menuconfig also shows how the file with the symbol got included, so if you see duplicated dependencies, it's easy to hunt down where they come from. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-03-07 12:45:23 +08:00
depends on 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
Synthesize a minimal configuration assuming 256 By page size and
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
int
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
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
drivers: spi_nor: support deep-power-down mode Add internal API to enter and exit deep power-down mode. Add Kconfig option to return to DPD whenever device is not active. When device power management becomes more mature it should be possible to implement it, which would allow use of DPD without having to enter and exit DPD between consecutive transactions. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-10-28 01:57:09 +08:00
config SPI_NOR_IDLE_IN_DPD
bool "Use Deep Power-Down mode when flash is not being accessed."
help
Where supported deep power-down mode can reduce current draw
to as little as 0.1% of standby current. However it takes
some milliseconds to enter and exit from this mode.
Select this option for applications where device power
management is not enabled, the flash remains inactive for
long periods, and when used the impact of waiting for mode
enter and exit delays is acceptable.
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