doc: nrf-bm: libraries: add bm_storage documentation #426
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
changelog-entry-required
|
You can find the documentation preview for this PR here. |
MirkoCovizzi
force-pushed
the
storage-docs
branch
4 times, most recently
from
386377e to
d998081
Compare
Contributor
eivindj-nordic
left a comment
eivindj-nordic
left a comment
There was a problem hiding this comment.
As discussed offline I also wonder if the storage init API should take a configuration structure instead of setting parameters in bm_storage strut before calling init.
MirkoCovizzi
force-pushed
the
storage-docs
branch
4 times, most recently
from
ba80825 to
d314076
Compare
MirkoCovizzi
removed
the
changelog-entry-required
eivindj-nordic
approved these changes
Oct 10, 2025
anhmolt
reviewed
Oct 13, 2025
eivindj-nordic
force-pushed
the
storage-docs
branch
from
d314076 to
bc6d392
Compare
github-actions
bot
added
the
changelog-entry-required
anhmolt
approved these changes
Oct 15, 2025
| ==== | ||
|
|
||
| Use the :c:func:`bm_storage_read` function to copy data from NVM into RAM. | ||
| The data length must be a multiple of the backend’s program unit and within the configured region. |
There was a problem hiding this comment.
"must be a multiple of the backend’s program unit"
This leavs me with the question, what is the backend's program unit
Contributor
There was a problem hiding this comment.
In the sample we have the comment
Write buffer size must be a multiple of the program unit.
To support both RRAM (16 bytes) and SoftDevice (4 bytes) backends, that is 16 bytes.
Could probably be added to the documentation.
bjorn-tore-taraldsen
left a comment
bjorn-tore-taraldsen
left a comment
There was a problem hiding this comment.
"multiple of the erase unit"
Definition of erase units, where is this defined
Contributor
|
Adding a commit with a bit of review, to be squashed before merging. @MirkoCovizzi , can you add the following:
|
MirkoCovizzi
force-pushed
the
storage-docs
branch
2 times, most recently
from
4841ac6 to
1793ab7
Compare
b-gent
approved these changes
Nov 7, 2025
bjorn-tore-taraldsen
requested changes
Nov 7, 2025
| Use the :c:func:`bm_storage_write` function to write data to NVM. | ||
| Writes are validated against alignment and range, and completion is reported through :c:member:`bm_storage.evt_handler`. | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
- You don't need repeat of the same note, delete one of them, and there is no NO mention of "Program units" in "Write", but talks about "alignment".
doc/nrf-bm/libraries/bm_storage.rst
Outdated
|
|
||
| .. note:: | ||
|
|
||
| The program unit is the smallest block of data that can be written at once. |
There was a problem hiding this comment.
I would like to see a reference to where the the program unit is defined.
doc/nrf-bm/libraries/bm_storage.rst
Outdated
|
|
||
| .. note:: | ||
|
|
||
| The erase unit is the minimum erasable block in NVM, and the erase length must be a multiple of this size. |
There was a problem hiding this comment.
Same as for Program unit, reference to where it is defined
MirkoCovizzi
force-pushed
the
storage-docs
branch
3 times, most recently
from
1018302 to
f4baf9a
Compare
Adds `bm_storage` library documentation. Signed-off-by: Mirko Covizzi <[email protected]> Co-authored-by: Bartosz Gentkowski <[email protected]>
MirkoCovizzi
force-pushed
the
storage-docs
branch
2 times, most recently
from
11c29c7 to
339c706
Compare
* Adds some missing Doxygen for some input parameters. * Make some fields visible by Doxygen. Signed-off-by: Mirko Covizzi <[email protected]>
MirkoCovizzi
force-pushed
the
storage-docs
branch
from
339c706 to
fcae6f7
Compare
Contributor
Author
|
@bjorn-tore-taraldsen Comments addressed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds
bm_storagelibrary documentation.