1.. _flash_api:
2
3Flash
4#####
5
6Overview
7********
8
9**Flash offset concept**
10
11Offsets used by the user API are expressed in relation to
12the flash memory beginning address. This rule shall be applied to
13all flash controller regular memory that layout is accessible via
14API for retrieving the layout of pages (see :kconfig:option:`CONFIG_FLASH_PAGE_LAYOUT`).
15
16An exception from the rule may be applied to a vendor-specific flash
17dedicated-purpose region (such a region obviously can't be covered under
18API for retrieving the layout of pages).
19
20
21
22User API Reference
23******************
24.. doxygengroup:: flash_interface
25
26Implementation interface API Reference
27**************************************
28.. doxygengroup:: flash_internal_interface
29