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.

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

[nrf fromlist] ZMS a new memory storage system #2045

Merged
merged 6 commits into from
Oct 16, 2024

Conversation

rghaddab
Copy link
Contributor

@rghaddab rghaddab commented Sep 24, 2024

This adds a new storage system ZMS and its backend for settings.
It adds as well all the dependencies for this storage fromtree zephyrproject-rtos:main

@de-nordic de-nordic requested review from tomi-font and Damian-Nordic and removed request for Andrewpini October 3, 2024 10:57
@tomi-font tomi-font removed their request for review October 3, 2024 13:04
@rghaddab rghaddab force-pushed the rghaddab/zms-sdk-zephyr branch 3 times, most recently from 277991d to 274a981 Compare October 9, 2024 08:54
@rghaddab rghaddab force-pushed the rghaddab/zms-sdk-zephyr branch 7 times, most recently from ea9c8c6 to 42df08d Compare October 16, 2024 00:13
ZMS is the abreviation of Zephyr Memory Storage.
It is a storage developed to target especially the non erasable devices.

The new memory storage system inherit from the NVS storage multiple
features and introduce new ones :
* Inherited features :
 - light key-value based storage
 - cache for entries
 - Wear Leveling of flash memory
 - Resilience to power failures
* New features :
 - cycle counter for non erasable devices (instead of erase emulation)
 - Keys up to 32-bit
 - Built-in support of CRC32 for data
 - Small size data (<= 8 bytes) integrated within entries

Upstream PR: zephyrproject-rtos/zephyr#77930

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
(cherry picked from commit 7d9d3fddea0a3ff999934c7aad99e54b2a8a864c)
List of added tests :
- zms.test_delete
- zms.test_zms_cache_collission
- zms.test_zms_cache_gc
- zms.test_zms_cache_hash_quality
- zms.test_zms_cache_init
- zms.test_zms_corrupted_sector_close_operation
- zms.test_zms_corrupted_write
- zms.test_zms_full_sector
- zms.test_zms_gc
- zms.test_zms_gc_3sectors
- zms.test_zms_gc_corrupt_ate
- zms.test_zms_gc_corrupt_close_ate
- zms.test_zms_mount
- zms.test_zms_write

Upstream PR: zephyrproject-rtos/zephyr#77930

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
(cherry picked from commit 3f31a7db7fe70ee92a0fe63c07fb7704abbb52b3)
This adds a user application that shows the usage of ZMS
The sample app shows three main functions of ZMS:
- read/write/delete key/value pairs
- fill all storage and delete it
- calculate free remaining space

Upstream PR: zephyrproject-rtos/zephyr#77930

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
(cherry picked from commit 9106be03f65f25e5d32920bf1443f05e43a54731)
This adds the documentation for the Zephyr Memory Storage system.

Upstream PR: zephyrproject-rtos/zephyr#77930

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
(cherry picked from commit 7cc32ad6b45548b7173cbfa7b98d7bdff986f671)
…orage)

This adds the initial backend support for the ZMS storage system.

Upstream PR: zephyrproject-rtos/zephyr#78632

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
(cherry picked from commit b99b214b949d3ae10bf02eb60f4ade4fb42400a1)
Introduce ZMS_LOOKUP_CACHE_FOR_SETTINGS Kconfig option that enables a
dedicated hash function for the ZMS lookup cache that takes advantage
of the ZMS ID allocation scheme used by the ZMS settings backend.
As such, this option should only be used if an application uses ZMS via
the settings layer.

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
@rlubos rlubos merged commit 98662fc into nrfconnect:main Oct 16, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants