adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

doc/reference: Added clarification on flash offset relation

Browse source 
Added information about that offsets are expressed in relation to
the flash memory beginning address.

This info was missing which cause misunderstanding of the concept
while contributing.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
This commit is contained in:
Andrzej Puzdrowski 2020-10-22 09:57:01 +02:00 committed by Carles Cufí
parent 1b3abc096c
commit 0b50839c7d
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/reference/peripherals/flash.rst
View file

@ -6,6 +6,17 @@ Flash
Overview
********
**Flash offset concept**
Offsets used by the user API are expressed in relation to
the flash memory beginning address. This rule shall be applied to
all flash controller regular memory that layout is accessible via
API for retrieving the layout of pages (see option:`CONFIG_FLASH_PAGE_LAYOUT`).
An exception from the rule may be applied to a vendor-specific flash
dedicated-purpose region (such a region obviously can't be covered under
API for retrieving the layout of pages).
API Reference
*************

3
doc/reference/storage/flash_map/flash_map.rst
View file

@ -47,6 +47,9 @@ both MCUboot and a storage partition. Some details were left out for clarity.
:language: DTS
:start-after: start-after-here
Rule for offsets is that each partition offset shall be expressed in relation to
the flash memory beginning address to which the partition belong.
The ``boot_partition``, ``slot0_partition``, ``slot1_partition``, and
``scratch_partition`` nodes are defined for MCUboot, though not all MCUboot
configurations require all of them to be defined. See the `MCUboot