Skip to content

Commit 3f1405c

Browse files
kkasperczyk-nonordicjm
authored andcommitted
doc: matter: Added ZMS mentions to the Matter docs
Matter docs describe settings storage referring to the NVS module. It was fixed to mention also ZMS module and explain when to select the specific backend implementation. Signed-off-by: Kamil Kasperczyk <[email protected]>
1 parent 784823a commit 3f1405c

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

doc/nrf/protocols/matter/end_product/bootloader.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,19 @@ The nRF Connect platform in Matter uses Zephyr's :ref:`zephyr:settings_api` API
6666
This requires that you define the ``settings_storage`` partition in the flash.
6767
The recommended minimum size of the partition is 32 kB, but you can reserve even more space if your application uses the storage extensively.
6868

69-
The Zephyr settings storage is implemented by the Zephyr NVS (Non-Volatile Storage) module.
70-
The NVS uses multiple sectors of 4 kB each and it has to use the appropriate number of sectors to cover all settings partition area.
71-
To configure the number of sectors used by the NVS, set the :kconfig:option:`CONFIG_SETTINGS_NVS_SECTOR_COUNT` Kconfig option to the desired value.
69+
The Zephyr settings storage is implemented by the :ref:`Zephyr NVS (Non-Volatile Storage) <zephyr:nvs_api>` or :ref:`ZMS (Zephyr Memory Storage) <zephyr:zms_api>` backends.
70+
You can select either backend, and the selection affects several factors, such as the operational performance or memory lifetime.
71+
To achieve the optimal experience, it is recommended to use:
72+
73+
* NVS backend for the flash-based nRF52 and nRF53 SoC families.
74+
* ZMS backend for the RRAM- and MRAM-based nRF54 SoC families.
75+
76+
The settings backend uses multiple sectors of 4 kB each, and it must use the appropriate number of sectors to cover the entire settings partition area.
77+
To configure the number of sectors used by the backend, set the corresponding Kconfig option to the desired value:
78+
79+
* :kconfig:option:`CONFIG_SETTINGS_NVS_SECTOR_COUNT` for the NVS
80+
* :kconfig:option:`CONFIG_SETTINGS_ZMS_SECTOR_COUNT` for the ZMS
81+
7282
For example, to cover a settings partition of 32 kB in size, you require 8 sectors.
7383

7484
As you can see in :ref:`ug_matter_hw_requirements_layouts`, Matter samples in the |NCS| reserve exactly 32 kB for the ``settings_storage`` partition.

doc/nrf/protocols/matter/getting_started/advanced_kconfigs.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ See :doc:`matter:nrfconnect_examples_cli` in the Matter documentation for the li
9898
Matter Settings shell commands
9999
------------------------------
100100

101-
You can enable the Matter Settings shell commands to monitor the current usage of the Zephyr Settings NVS.
101+
You can enable the Matter Settings shell commands to monitor the current usage of the Zephyr Settings using :ref:`NVS (Non-Volatile Storage) <zephyr:nvs_api>` or :ref:`ZMS (Zephyr Memory Storage) <zephyr:zms_api>` backends.
102102
These commands are useful for verifying that the ``settings`` partition has the proper size and meets the application requirements.
103103

104104
To enable the Matter Settings shell module, set the :kconfig:option:`CONFIG_NCS_SAMPLE_MATTER_SETTINGS_SHELL` Kconfig option to ``y``.
@@ -111,10 +111,6 @@ You can use the following shell commands:
111111
* ``matter_settings current`` - Get the size of the current settings usage.
112112
* ``matter_settings free`` - Get the size of the current free settings space.
113113

114-
.. note::
115-
116-
The Matter Settings shell module is available only for the NVS Zephyr Settings backend.
117-
118114
.. _ug_matter_configuring_device_identification:
119115

120116
Matter device identification

0 commit comments

Comments
 (0)