-
Notifications
You must be signed in to change notification settings - Fork 21
doc: nrf-bm: libraries: add bm_storage documentation #426
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
You can find the documentation preview for this PR here. |
386377e
to
d998081
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
ba80825
to
d314076
Compare
Adds `bm_storage` library documentation. Signed-off-by: Mirko Covizzi <[email protected]>
d314076
to
bc6d392
Compare
==== | ||
|
||
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"must be a multiple of the backend’s program unit"
This leavs me with the question, what is the backend's program unit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"multiple of the erase unit"
Definition of erase units, where is this defined
pls squash Signed-off-by: Bartosz Gentkowski <[email protected]>
Adding a commit with a bit of review, to be squashed before merging. @MirkoCovizzi , can you add the following:
|
Adds
bm_storage
library documentation.