mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-15 04:31:55 +00:00
508c0356ab
Divided doxygen API documentation into zephyr-internal API and user API. This make sense as user shall not use zephyr-internal API. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
31 lines
765 B
ReStructuredText
31 lines
765 B
ReStructuredText
.. _flash_api:
|
|
|
|
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).
|
|
|
|
|
|
|
|
User API Reference
|
|
******************
|
|
.. doxygengroup:: flash_interface
|
|
:project: Zephyr
|
|
|
|
Implementation interface API Reference
|
|
**************************************
|
|
.. doxygengroup:: flash_internal_interface
|
|
:project: Zephyr
|