Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

drivers/flash: deprecation of flash_write_protection_set() API #33216

Merged
merged 29 commits into from
Mar 29, 2021
Merged

drivers/flash: deprecation of flash_write_protection_set() API #33216

merged 29 commits into from
Mar 29, 2021

Conversation

nvlsianpu
Copy link
Collaborator

@nvlsianpu nvlsianpu commented Mar 10, 2021 •
edited
Loading

The API is deprecated as it was decided to build in the flash protection
service into write and erase procedures.
This is solution chosen for fix following issue:
When two or more threads writes to flash device it is
possible that flash protection will be enabled by one of
threads despite another thread(s) still needs it disabled.

fixes #31217

  • spi_flash_at45 (already ready)
  • soc_flash_nrf (already ready)
  • nrf_qspi_nor
  • spi_nor
  • soc_flash_lpc
  • soc_flash_mcux
  • soc_flash_rv32m1
  • soc_flash_nios2_qspi
  • flash_esp32 (already ready)
  • flash_gecko
  • flash_mcux_flexspi_nor (already ready)
  • flash_sam
  • flash_sam0
  • flash_stm32_qspi
  • flash_stm32
  • flash_stm32h7
  • flash_simulator
  • remove CONFIG_FLASH_SIMULATOR_ERASE_PROTECT (not relevant anymore)
  • align tests
  • removed usage in tests
  • removed usage in samples
  • remove usage in drivers, subsystems and wherever else

Additionally:
fs/nvs:
Removed two unneeded if statements. These statements had not
effect in function results.

Signed-off-by: Andrzej Puzdrowski [email protected]

@nvlsianpu nvlsianpu force-pushed the deprecate_flash_protecton_API branch 4 times, most recently from 111d10e to fd63bfe Compare March 12, 2021 12:52
@github-actions github-actions bot added platform: Silabs Silicon Labs platform: STM32 ST Micro STM32 labels Mar 12, 2021
@nvlsianpu nvlsianpu added the platform: nRF Nordic nRFx label Mar 12, 2021
@nvlsianpu nvlsianpu force-pushed the deprecate_flash_protecton_API branch from ed3f223 to 85f289d Compare March 12, 2021 17:06
@github-actions github-actions bot added the area: API Changes to public APIs label Mar 12, 2021
@nvlsianpu nvlsianpu force-pushed the deprecate_flash_protecton_API branch from 85f289d to b203ca3 Compare March 12, 2021 17:19
@nvlsianpu nvlsianpu changed the title drivers/flash/nrf_qspi_nor: integrate protection service into write/e… drivers/flash: deprecation of flash_write_protection_set() API Mar 12, 2021
@nvlsianpu nvlsianpu added area: Drivers area: Flash area: API Changes to public APIs and removed area: API Changes to public APIs labels Mar 12, 2021
@github-actions github-actions bot added the area: Tests Issues related to a particular existing or missing test label Mar 16, 2021
@nvlsianpu nvlsianpu force-pushed the deprecate_flash_protecton_API branch 3 times, most recently from eda53bf to 5a3c6fc Compare March 16, 2021 14:23
@nvlsianpu nvlsianpu added this to the v2.6.0 milestone Mar 16, 2021
@nvlsianpu nvlsianpu force-pushed the deprecate_flash_protecton_API branch from 5a3c6fc to f74a259 Compare March 16, 2021 14:52
@github-actions github-actions bot added area: Documentation Release Notes To be mentioned in the release notes labels Mar 16, 2021
@nvlsianpu nvlsianpu marked this pull request as ready for review March 16, 2021 14:55
nvlsianpu added 21 commits March 26, 2021 17:22
@nvlsianpu
drivers/flash/flash_gecko: integrate WP service into write/erase
41486b4 
Flash write protection services were integrated into erase and write
procedures. This is step required for fixing following issue:
Multi-threading flash access is not supported by
flash_write_protection_set().

flash_write_protection_set() will be deprecated

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/flash/flash_stm32: integrate WP service into write/erase
ec04395 
Flash write protection services were integrated into erase and write
procedures. This is step required for fixing following issue:
Multi-threading flash access is not supported by
flash_write_protection_set().

flash_write_protection_set() will be deprecated

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/flash/flash_stm32h7x: integrate WP service into write/erase
d98dfe1 
Flash write protection services were integrated into erase and write
procedures. This is step required for fixing following issue:
Multi-threading flash access is not supported by
flash_write_protection_set().

flash_write_protection_set() will be deprecated

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/flash/flash_stm32_qspi: integrate WP service into write/erase
3769736 
Flash write protection services were integrated into erase and write
procedures. This is step required for fixing following issue:
Multi-threading flash access is not supported by
flash_write_protection_set().

flash_write_protection_set() will be deprecated

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/flash/soc_flash_nios2_qspi: integrate WP service into write/e…
fdcd317 
…rase

Flash write protection services were integrated into erase and write
procedures. This is step required for fixing following issue:
Multi-threading flash access is not supported by
flash_write_protection_set().

flash_write_protection_set() will be deprecated

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/flash/flash_simulator: integrate WP service into write/erase
56d7ee2 
Flash write protection services were integrated into erase and write
procedures. This is step required for fixing following issue:
Multi-threading flash access is not supported by
flash_write_protection_set().

flash_write_protection_set() will be deprecated

As CONFIG_FLASH_SIMULATOR_ERASE_PROTECT become a dead option.
this commit removes it as well.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
include/drivers/flash: make write_protection handler optional
f421d07 
Made write_protection handler not mandatory.
flash_write_protection_set() becomes no-operation.
If write_protection handler is provided by the driver implementation
it will be called within flash_writ() and flash_erase().

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/flash: removed write protection API implementations
800671e 
flash_write_protection_set() API was deprecated so driver
implementation interface is left behind as well.

This patch removes all implementation pointed by the interface
'struct flash_driver_api.write_protection'.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
tests/drivers/flash_simulator: remove flash_write_protection_set() usage
f993cb9 
flash_write_protection_set() was deprecated.
This patch removes usage of it and the test case which was
testing deprecated API behaviors.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
tests/boards/altera_max10/qspi: remove flash_write_protection_set() u…
76b85b6 
…sage

This patch removes scenario which was testing deprecated
API behaviors. Needed as As flash_write_protection_set() was
deprecated and became no-operation.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
tests/tree-wide: remove flash_write_protection_set() usage
6188464 
flash_write_protection_set() was deprecated.
This patch removes usage of it.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
fs/nvs: remove flash_write_protect_set() usage
aa92147 
flash_write_protection_set() was deprecated.
This patch removes usage of it and the test case which was
testing deprecated API behaviors.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
fs/nvs: removed unneeded if statements
8c5c64b 
Removed two unneeded `if` statements. These statements had not
effect in function results.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
storage: remove flash_write_protection_set() usage
e32fcec 
This patch removes scenario which was testing deprecated
API behaviors. Needed as As flash_write_protection_set() was
deprecated and became no-operation.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
disk/disk_acces_flash: remove flash_write_protection_set() usage
d965b31 
This patch removes scenario which was testing deprecated
API behaviors. Needed as As flash_write_protection_set() was
deprecated and became no-operation.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/flash/flash_shell: remove flash_write_protection_set() usage
77ac0fa 
This patch removes scenario which was testing deprecated
API behaviors. Needed as As flash_write_protection_set() was
deprecated and became no-operation.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/eeprom/eeprom_emulator: remove flash_write_protection_set() u…
ebb697e 
…sage

This patch removes scenario which was testing deprecated
API behaviors. Needed as As flash_write_protection_set() was
deprecated and became no-operation.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
samples/tree-wide: remove flash_write_protection_set() usage
bd490f5 
This patch removes scenario which was testing deprecated
API behaviors. Needed as As flash_write_protection_set() was
deprecated and became no-operation.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
include/drivers/flash: deprecation of flash_write_protection_set()
fa9ffa6 
The API is deprecated as it was decided to build in the flash protection
service into write and erase procedures.
This is solution chosen for fix following issue:
  When two or more threads writes to flash device it is
  possible that flash protection will be enabled by one of
  threads despite another thread(s) still needs it disabled.

fixes zephyrproject-rtos#3127

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
release-note: flash_api_write_protection() deprecation record
fa5b2b8 
Added note on deprecation of the API and description of flash
drivers changes.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
tests/drivers/flash: allow CI using nrf52840dk_nrf52840
b9af114 
Added integration_platforms with nrf52840dk_nrf52840.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nvlsianpu
drivers/flash/flash_stm32g4x: fixed build issue
d7a8334 
This driver file couldn't be compiled due the syntax error.

Signed-off-by: Andrzej Puzdrowski <[email protected]>
@nashif nashif merged commit 6acc4a2 into zephyrproject-rtos:master Mar 29, 2021
@pabigot pabigot mentioned this pull request Apr 10, 2021
Merged
trond-snekvik added a commit to trond-snekvik/fw-nrfconnect-nrf that referenced this pull request Apr 28, 2021
@trond-snekvik
treewide: Remove calls to deprecated flash_write_protection_set
f98bd82 
Flash write protection is now handled automatically inside the flash
write and erase functions, and flash_write_protection_set is deprecated.
See zephyrproject-rtos/zephyr#33216 for details.

Signed-off-by: Trond Einar Snekvik <[email protected]>
trond-snekvik added a commit to trond-snekvik/fw-nrfconnect-nrf that referenced this pull request Apr 30, 2021
@trond-snekvik
treewide: Remove calls to deprecated flash_write_protection_set
c0c78fb 
Flash write protection is now handled automatically inside the flash
write and erase functions, and flash_write_protection_set is deprecated.
See zephyrproject-rtos/zephyr#33216 for details.

Signed-off-by: Trond Einar Snekvik <[email protected]>
carlescufi pushed a commit to nrfconnect/sdk-nrf that referenced this pull request Apr 30, 2021
@trond-snekvik @carlescufi
treewide: Remove calls to deprecated flash_write_protection_set
15593e0 
Flash write protection is now handled automatically inside the flash
write and erase functions, and flash_write_protection_set is deprecated.
See zephyrproject-rtos/zephyr#33216 for details.

Signed-off-by: Trond Einar Snekvik <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@de-nordic de-nordic de-nordic approved these changes

@sylvioalves sylvioalves sylvioalves approved these changes

@henrikbrixandersen henrikbrixandersen henrikbrixandersen approved these changes

@chrta chrta chrta approved these changes

@pabigot pabigot pabigot approved these changes

@Laczen Laczen Laczen approved these changes

@carlescufi carlescufi Awaiting requested review from carlescufi

@dcpleung dcpleung Awaiting requested review from dcpleung

@galak galak Awaiting requested review from galak

@jakub-uC jakub-uC Awaiting requested review from jakub-uC

@MaureenHelm MaureenHelm Awaiting requested review from MaureenHelm

@nashif nashif Awaiting requested review from nashif

@nordic-krch nordic-krch Awaiting requested review from nordic-krch

@sathishkuttan sathishkuttan Awaiting requested review from sathishkuttan

@erwango erwango Awaiting requested review from erwango

@vanwinkeljan vanwinkeljan Awaiting requested review from vanwinkeljan

@jfischer-no jfischer-no Awaiting requested review from jfischer-no

Assignees

@nvlsianpu nvlsianpu

Labels
area: API Changes to public APIs area: Disk Access area: Documentation area: Drivers area: EEPROM area: File System area: Flash area: Samples Samples area: Settings Settings subsystem area: Shell Shell subsystem area: Storage Storage subsystem area: Tests Issues related to a particular existing or missing test platform: ESP32 Espressif ESP32 platform: nRF Nordic nRFx platform: NXP NXP platform: Silabs Silicon Labs platform: STM32 ST Micro STM32 Release Notes To be mentioned in the release notes
Projects
None yet
Milestone
v2.6.0
Development

Successfully merging this pull request may close these issues.

Multi-threading flash access is not supported by flash_write_protection_set()
9 participants
@nvlsianpu @Laczen @de-nordic @pabigot @chrta @henrikbrixandersen @sylvioalves @nashif @zephyrbot