OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

nvs: add documentation about the crc in nvs 

fixed nvs part of #68699

Signed-off-by: Laczen JMS <laczenjms@gmail.com>
Co-authored-by: Benjamin Cabé <kartben@gmail.com>
This commit is contained in:
Laczen JMS 2024-02-08 12:26:29 +01:00 committed by Maureen Helm
parent 66a4fe32ce
commit c0a72cfb11
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/services/storage/nvs/nvs.rst
View File

@ -19,7 +19,11 @@ combination of these.
Each element is stored in flash as metadata (8 byte) and data. The metadata is
written in a table starting from the end of a nvs sector, the data is
written one after the other from the start of the sector. The metadata consists
of: id, data offset in sector, data length, part (unused) and a crc.
of: id, data offset in sector, data length, part (unused), and a CRC. The CRC is
only calculated over the metadata and only ensures that a write has been
completed. The actual data of the element is not protected by a CRC. It is
encouraged to include a CRC as part of the data and to take appropriate
corrective actions when the data CRC does not match its expected value.
A write of data to nvs always starts with writing the data, followed by a write
of the metadata. Data that is written in flash without metadata is ignored