michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: reference: settings: list non-volatile storage backend

Browse source 
List the non-volatile storage (NVS) backend in the settings API
reference documentation.

Signed-off-by: Henrik Brix Andersen <henrik@brixandersen.dk>
This commit is contained in:
Henrik Brix Andersen 2019-09-16 20:19:58 +02:00 • committed by Maureen Helm
commit c2869c7e78
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/reference/storage/settings/settings.rst
View file

@ -69,9 +69,10 @@ backend.
Zephyr Storage Backends
***********************
Zephyr has two existing backend storages which can be a Flash Circular Buffer
(:option:`CONFIG_SETTINGS_FCB`) or a file in the filesystem
(:option:`CONFIG_SETTINGS_FS`).
Zephyr has three storage backends: a Flash Circular Buffer
(:option:`CONFIG_SETTINGS_FCB`), a file in the filesystem
(:option:`CONFIG_SETTINGS_FS`), or non-volatile storage
(:option:`CONFIG_SETTINGS_NVS`).
You can declare multiple sources for settings; settings from
all of these are restored when ``settings_load()`` is called.
@ -84,6 +85,9 @@ using ``settings_fcb_dst()``. As a side-effect, ``settings_fcb_src()``
initializes the FCB area, so it must be called before calling
``settings_fcb_dst()``. File read target is registered using
``settings_file_src()``, and write target by using ``settings_file_dst()``.
Non-volatile storage read target is registered using
``settings_nvs_src()``, and write target by using
``settings_nvs_dst()``.
Loading data from persisted storage
***********************************