6e57b42758
This is joint work with Kumar Gala (see signed-off-by). Document the changes to the generated node macros in macros.bnf, moving the old file to legacy-macros.bnf and putting it in its own section. The actual generated macros are now a low-level detail, so rewrite the foregoing sections as examples in terms of the new <devicetree.h> APIs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
37 lines
1.1 KiB
ReStructuredText
37 lines
1.1 KiB
ReStructuredText
.. _flash_map_api:
|
|
|
|
Flash map (flash_map)
|
|
##########################
|
|
|
|
Flash map is a way for storing flash partitioning information in one central
|
|
location in flash_area structures array form.
|
|
|
|
Flash map is generated from DTS based on content of :ref:`legacy_flash_partitions`
|
|
nodes.
|
|
The flash_area API provides a way to access data in the flash map.
|
|
The flash_area_open() API is the interface for obtaining the flash partitions
|
|
flash_area from the flash map.
|
|
|
|
|
|
Flash Area API (flash_area)
|
|
###########################
|
|
|
|
The flash_area concept combines methods for operating on a flash chunk
|
|
together with a description of this chunk. Its methods are basically wrappers
|
|
around the flash API, with input parameter range checks. Not all flash
|
|
operation are wrapped so an API call to retrieve the flash area driver is
|
|
included as well. The flash area methods are designed to be used along with
|
|
the flash_area structures of flash_map and user-specific flash_areas, with
|
|
the exception of the area_open API used to fetch a flash_area from
|
|
the flash_map.
|
|
|
|
|
|
API Reference
|
|
*************
|
|
|
|
flash_area API
|
|
==============
|
|
|
|
.. doxygengroup:: flash_area_api
|
|
:project: Zephyr
|