Skip to content

manifest: sdk-zephyr: ZMS a new memory storage system #17502

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

Merged
merged 8 commits into from
Oct 16, 2024
Merged

manifest: sdk-zephyr: ZMS a new memory storage system #17502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d252dcf
manifest: Update sdk-zephyr revision (auto-manifest PR)
NordicBuilder Sep 24, 2024
4ee91f8
flash_map_pm: add support for ZMS storage
rghaddab Sep 26, 2024
22ba60d
partition_manager: add support for the ZMS storage system
rghaddab Oct 3, 2024
566fb1b
trusted_storage: add support of ZMS for the trusted storage
rghaddab Oct 3, 2024
3786de2
samples: bluetooth: Use ZMS settings backed for RRAM devices
pdunaj Oct 9, 2024
e6792f0
samples: bluetooth: Use Kconfig to enable settings and fs
pdunaj Oct 10, 2024
ed6324d
samples: matter: Align Matter samples to ZMS fs backend
ArekBalysNordic Oct 9, 2024
43ceb65
samples: openthread: Enabled ZMS for OpenThread samples
kkasperczyk-no Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/nrf/protocols/matter/getting_started/advanced_kconfigs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,15 +183,15 @@ To enable one of the reactions to the last fabric removal, set the corresponding
* :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT` - Remove all saved network credentials and reboot the device.
This option is selected by default.

When the :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_NVS` Kconfig option is also set to ``y``, the device will also remove all non-volatile data stored on the device, including application-specific entries.
When the :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS` Kconfig option is also set to ``y``, the device will also remove all non-volatile data stored on the device, including application-specific entries.
This means the device is restored to the factory settings.

To create a delay between the chosen reaction and the last fabric being removed, set the :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ACTION_DELAY` Kconfig option to a specific time in milliseconds.
By default this Kconfig option is set to 1 second.

.. note::
The :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_NVS` Kconfig option is set to ``y`` by default.
To disable removing application-specific non-volatile data when the :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT` Kconfig option is selected, set the :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_NVS` Kconfig option to ``n``.
The :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS` Kconfig option is set to ``y`` by default.
To disable removing application-specific non-volatile data when the :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT` Kconfig option is selected, set the :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS` Kconfig option to ``n``.

.. _ug_matter_configuring_read_client:

Expand Down
7 changes: 6 additions & 1 deletion doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,13 @@ Matter

* The :ref:`ug_matter_device_memory_profiling` section to the :ref:`ug_matter_device_optimizing_memory` page.
The section contains useful commands for measuring memory and troubleshooting tips.
* The ZMS file subsystem to all devices that contain RRAM, such as the nRF54L Series devices.

* Changed the default Trusted Storage AEAD key to Hardware Unique Key (HUK) for supported nRF54L Series devices.
* Changed:

* The default Trusted Storage AEAD key to Hardware Unique Key (HUK) for supported nRF54L Series devices.
* Renamed the ``CONFIG_CHIP_FACTORY_RESET_ERASE_NVS`` Kconfig option to :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS`.
The new Kconfig option now works for both NVS and ZMS file system backends.

Matter fork
+++++++++++
Expand Down
6 changes: 5 additions & 1 deletion include/flash_map_pm.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
#define image_scratch mcuboot_scratch
#define image_scratch mcuboot_scratch

#if (CONFIG_SETTINGS_FCB || CONFIG_SETTINGS_NVS || defined(PM_SETTINGS_STORAGE_ID))
#if (CONFIG_SETTINGS_FCB || CONFIG_SETTINGS_NVS || defined(PM_SETTINGS_STORAGE_ID) ||\
CONFIG_SETTINGS_ZMS)
#define storage settings_storage
#define storage_partition settings_storage
#elif CONFIG_FILE_SYSTEM_LITTLEFS
Expand All @@ -38,6 +39,9 @@
#elif CONFIG_NVS
#define storage nvs_storage
#define storage_partition nvs_storage
#elif CONFIG_ZMS
#define storage zms_storage
#define storage_partition zms_storage
#endif

#define PM_ID(label) PM_##label##_ID
Expand Down
16 changes: 16 additions & 0 deletions samples/bluetooth/central_and_peripheral_hr/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y
Comment on lines +9 to +10
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isn't needed


config ZMS
default y if SOC_FLASH_NRF_RRAM
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need to add another config file to every sample? If we always want to use the new storage system for settings if we have RRAM can we not set these defaults in the ZMS/NVS subsystems?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ZMS or NVS subsystems should be board agnostic, it works on all flash technologies (RRAM, MRAM, classical flash, ...)

Copy link
Contributor

@kapi-no kapi-no Oct 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we define these defaults at the board/SoC level?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tried to add this but zephyr does not have good mechanism to do it.
You can enable FS on the board soc/level but if you don't use settings then this FS will likely be a dead code.
You cannot enable it based on settings being enabled as settings backend is set based on fs being used. You have a circular dependency.

I would recommend to change interface to add information about fs in dts.

Copy link
Contributor

@kapi-no kapi-no Oct 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can probably make Setting backends (choice SETTINGS_BACKEND) select their dependency (their target FS - e.g. select ZMS). Now, these choice options use depends on syntax so this requires modification of zephyr/subsys/settings/Kconfig. Then, you would pick the recommended (default) Settings backend in the Kconfig.default file in the SoC directory (e.g. zephyr/soc/nordic/nrf54l/Kconfig.defconfig).

However, this method has its implications and changes how the Settings subsystem is configured. Right now, the enabled FS (e.g. CONFIG_ZMS=y) causes the Settings backend default to change (e.g. CONFIG_SETTINGS_ZMS symbol is picked as the default choice selection).

Copy link
Contributor

@kapi-no kapi-no Oct 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I liked the DTS approach initially that was suggested by Jamie. However, then we realized that relying on the DTS partition node wouldn't probably work for targets that use Partition Manager (nRF52 Series / nRF53 Series / nRF54L Series).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will work for the default, assuming that is the same as what PM is using e.g. if you use nrf54l15dk and storage is internal RRAM in DTS and PM is the same, it will work, it will not work if storage is internal RRAM in DTS but PM is using some external QSPI flash device


config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/central_and_peripheral_hr/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add CONFIG_SETTINGS=y back here


CONFIG_HEAP_MEM_POOL_SIZE=1024

Expand Down
16 changes: 16 additions & 0 deletions samples/bluetooth/central_bas/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/central_bas/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,5 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y

CONFIG_DK_LIBRARY=y
16 changes: 16 additions & 0 deletions samples/bluetooth/central_hids/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/central_hids/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,5 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y

CONFIG_DK_LIBRARY=y
16 changes: 16 additions & 0 deletions samples/bluetooth/central_nfc_pairing/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/central_nfc_pairing/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y

# Config logger
CONFIG_LOG=y
Expand Down
16 changes: 16 additions & 0 deletions samples/bluetooth/central_uart/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/central_uart/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y

# Config logger
CONFIG_LOG=y
Expand Down
16 changes: 16 additions & 0 deletions samples/bluetooth/enocean/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/enocean/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ CONFIG_NCS_SAMPLES_DEFAULTS=y
# General configuration
CONFIG_FLASH=y
CONFIG_FLASH_MAP=y
CONFIG_SETTINGS=y
CONFIG_NVS=y
CONFIG_DK_LIBRARY=y

# Bluetooth configuration
Expand Down
16 changes: 16 additions & 0 deletions samples/bluetooth/fast_pair/input_device/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
3 changes: 0 additions & 3 deletions samples/bluetooth/fast_pair/input_device/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ CONFIG_DK_LIBRARY=y
# Enable settings to store data in non-volatile memory
CONFIG_FLASH=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS_NVS=y
CONFIG_SETTINGS=y
CONFIG_BT_SETTINGS=y

CONFIG_BT=y
Expand Down
9 changes: 9 additions & 0 deletions samples/bluetooth/fast_pair/locator_tag/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ rsource "src/Kconfig.dfu"
rsource "src/ui/Kconfig.ui"
rsource "src/battery/Kconfig.battery"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM

endmenu

source "Kconfig.zephyr"
3 changes: 0 additions & 3 deletions samples/bluetooth/fast_pair/locator_tag/configuration/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ CONFIG_RESET_ON_FATAL_ERROR=n
# Enable settings to store data in non-volatile memory
CONFIG_FLASH=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS_NVS=y
CONFIG_SETTINGS=y
CONFIG_BT_SETTINGS=y

CONFIG_BT=y
Expand Down
3 changes: 0 additions & 3 deletions samples/bluetooth/fast_pair/locator_tag/configuration/prj_release.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ CONFIG_SETTINGS_DYNAMIC_HANDLERS=n
# Enable settings to store data in non-volatile memory
CONFIG_FLASH=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS_NVS=y
CONFIG_SETTINGS=y
CONFIG_BT_SETTINGS=y

CONFIG_BT=y
Expand Down
16 changes: 16 additions & 0 deletions samples/bluetooth/peripheral_ams_client/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/peripheral_ams_client/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y

# Enable DK LED and Buttons library
CONFIG_DK_LIBRARY=y
16 changes: 16 additions & 0 deletions samples/bluetooth/peripheral_ancs_client/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/peripheral_ancs_client/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y

# Enable DK LED and Buttons library
CONFIG_DK_LIBRARY=y
16 changes: 16 additions & 0 deletions samples/bluetooth/peripheral_bms/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/peripheral_bms/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,3 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y
16 changes: 16 additions & 0 deletions samples/bluetooth/peripheral_cgms/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/peripheral_cgms/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ CONFIG_BT_DEVICE_NAME="Nordic Glucose Sensor"
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y
CONFIG_BT_SETTINGS=y

# CGMS Specific options
Expand Down
16 changes: 16 additions & 0 deletions samples/bluetooth/peripheral_cts_client/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

source "Kconfig.zephyr"

config SETTINGS
default y

config ZMS
default y if SOC_FLASH_NRF_RRAM

config NVS
default y if !SOC_FLASH_NRF_RRAM
2 changes: 0 additions & 2 deletions samples/bluetooth/peripheral_cts_client/prj.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ CONFIG_BT_SETTINGS=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_NVS=y
CONFIG_SETTINGS=y

# Enable DK LED and Buttons library
CONFIG_DK_LIBRARY=y
Loading
Loading