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_storage.rst
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,25 @@
1
1
.. _lib_storage:
2
2
3
-
Storage Library
4
-
###############
3
+
Bare Metal Storage
4
+
##################
5
5
6
6
.. contents::
7
7
:local:
8
8
:depth: 2
9
9
10
-
The Storage library provides abstractions for reading, writing, and erasing non-volatile memory (NVM).
10
+
The Bare Metal Storage subsystem provides abstractions for reading, writing, and erasing non-volatile memory (NVM).
11
11
12
12
Overview
13
13
********
14
14
15
-
The library supports multiple storage instances, each bound to a specific memory region, and reports operation results through user-defined event handlers.
15
+
The subsystem supports multiple storage instances, each bound to a specific memory region, and reports operation results through user-defined event handlers.
16
16
Depending on the backend and runtime state, operations may be synchronous or asynchronous.
17
17
18
18
Configuration
19
19
*************
20
20
21
-
The library is enabled and configured entirely using the Kconfig system.
22
-
Set the :kconfig:option:`CONFIG_BM_STORAGE` Kconfig option to enable the library.
21
+
The subsystem is enabled and configured entirely using the Kconfig system.
22
+
Set the :kconfig:option:`CONFIG_BM_STORAGE` Kconfig option to enable the subsystem.
23
23
24
24
Select a storage backend by enabling one of the following Kconfig options:
25
25
@@ -46,7 +46,7 @@ You can uninitialize a storage instance with the :c:func:`bm_storage_uninit` fun
46
46
Usage
47
47
*****
48
48
49
-
The following is a list of operations you can perform with this library.
49
+
The following is a list of operations you can perform with this subsystem.
50
50
51
51
Read
52
52
====
@@ -103,7 +103,7 @@ Each event includes the result code, information about the address range of the
103
103
Sample
104
104
******
105
105
106
-
The usage of this library is demonstrated in the :ref:`bm_storage_sample` sample.
106
+
The usage of this subsystem is demonstrated in the :ref:`bm_storage_sample` sample.
107
107
108
108
Dependencies
109
109
************
@@ -128,4 +128,4 @@ API documentation
128
128
|Header file: :file:`include/bm_storage.h`
129
129
|Source files: :file:`lib/bm_storage/`
130
130
131
-
:ref:`Storage library API reference <api_storage>`
131
+
:ref:`Bare Metal Storage subsystem API reference <api_storage>`
0 commit comments