You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/nrf-bm/subsys/bm_zms.rst
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
Bare Metal Zephyr Memory Storage (BM_ZMS)
4
4
#########################################
5
5
6
-
Bare Metal Zephyr Memory Storage is a key-value storage system that is designed to work with all types of non-volatile storage technologies.
6
+
Bare Metal Zephyr Memory Storage is a key-value storage subsystem that is designed to work with all types of non-volatile storage technologies.
7
7
8
8
The Bare Metal version is designed to work with asynchronous and synchronous storage APIs.
9
9
@@ -20,9 +20,9 @@ The key-value pair is divided into two parts:
20
20
Additionally, each sector includes header ATEs at the last positions.
21
21
These ATEs are essential for describing the sector's status (whether it is 'closed' or 'open') and for indicating the current version of BM_ZMS.
22
22
23
-
When the current sector is full, the library verifies first that the following sector is empty.
23
+
When the current sector is full, the subsystem verifies first that the following sector is empty.
24
24
It then garbage collects the sector N+2, where N is the current sector number, by moving the valid ATEs to the N+1 empty sector.
25
-
The library then erases the garbage-collected sector and closes the current sector by writing a ``garbage_collect_done`` ATE and the ``close`` ATE (one of the header entries).
25
+
The subsystem then erases the garbage-collected sector and closes the current sector by writing a ``garbage_collect_done`` ATE and the ``close`` ATE (one of the header entries).
26
26
27
27
Afterwards, it moves forward to the next sector and starts writing entries again.
28
28
@@ -94,7 +94,7 @@ This ATE can appear at any position of the sector.
94
94
BM_ZMS workflow
95
95
***************
96
96
97
-
The following sections describe in detail the operations performed by this library.
97
+
The following sections describe in detail the operations performed by this subsystem.
98
98
99
99
Registering the user callback handler
100
100
=====================================
@@ -135,7 +135,7 @@ To do this, it looks for a closed sector followed by an open one.
135
135
Then, within the open sector, it finds (recovers) the last written ATE.
136
136
After that, it checks that the sector after this one is empty, or it will erase it.
137
137
138
-
If this initialization is successful, the library sets the flag ``bm_zms_fs.init_flags.initialized`` to true.
138
+
If this initialization is successful, the subsystem sets the flag ``bm_zms_fs.init_flags.initialized`` to true.
139
139
For asynchronous storage backends, you must wait for the initialization to finish before triggering a write or read operation.
140
140
141
141
BM_ZMS ID/data write
@@ -299,7 +299,7 @@ Where:
299
299
Features
300
300
********
301
301
302
-
The current version of this library offers the following features:
302
+
The current version of this subsystem offers the following features:
Copy file name to clipboardExpand all lines: samples/subsys/fs/bm_zms/README.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Bare Metal Zephyr Memory Storage (BM_ZMS)
7
7
:local:
8
8
:depth: 2
9
9
10
-
The BM_ZMS sample demonstrates how to use the Bare Metal ZMS (Zephyr Memory Storage) library to manage key-value pairs, counters, and long arrays in a storage system.
10
+
The BM_ZMS sample demonstrates how to use the Bare Metal ZMS (Zephyr Memory Storage) subsystem to manage key-value pairs, counters, and long arrays in a storage system.
11
11
It shows how to add, read, and delete items in the storage.
12
12
13
13
Refer to the `Kconfig fragments`_ section for more information on configuration.
0 commit comments