zephyr/doc/hardware/peripherals/retained_mem.rst

25 lines
519 B
ReStructuredText
Raw Normal View History

.. _retained_mem_api:
Retained memory
###############
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