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

25 lines
519 B
ReStructuredText
Raw Normal View History

doc: Add retained memory API and mark as experimental Adds the the retained memory API to the list and marks it as experimental. Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-02-27 16:21:17 +08:00
.. _retained_mem_api:
doc: peripherals: unify title strings Unify the peripheral documentation title strings to the format "<class> [(acronym)] [Bus]". Including both the full name of the peripheral class and an acronym makes the documentation more user friendly as some of the acronyms are less well-known than others. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-03-28 22:10:21 +08:00
Retained Memory
doc: Add retained memory API and mark as experimental Adds the the retained memory API to the list and marks it as experimental. Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-02-27 16:21:17 +08:00
###############
Overview
********
The retained memory driver API provides a way of reading from/writing to memory
areas whereby the contents of the memory is retained whilst the device is
powered (data may be lost in low power modes).
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_RETAINED_MEM`
* :kconfig:option:`CONFIG_RETAINED_MEM_INIT_PRIORITY`
API Reference
*************
.. doxygengroup:: retained_mem_interface