1.. _retained_mem_api:
2
3Retained Memory
4###############
5
6Overview
7********
8
9The retained memory driver API provides a way of reading from/writing to memory
10areas whereby the contents of the memory is retained whilst the device is
11powered (data may be lost in low power modes).
12
13Configuration Options
14*********************
15
16Related configuration options:
17
18* :kconfig:option:`CONFIG_RETAINED_MEM`
19* :kconfig:option:`CONFIG_RETAINED_MEM_INIT_PRIORITY`
20* :kconfig:option:`CONFIG_RETAINED_MEM_MUTEX_FORCE_DISABLE`
21
22Mutex protection
23****************
24
25Mutex protection of retained memory drivers is enabled by default when
26applications are compiled with multithreading support. This means that
27different threads can safely call the retained memory functions without
28clashing with other concurrent thread function usage, but means that retained
29memory functions cannot be used from ISRs. It is possible to disable mutex
30protection globally on all retained memory drivers by enabling
31:kconfig:option:`CONFIG_RETAINED_MEM_MUTEX_FORCE_DISABLE` - users are then
32responsible for ensuring that the function calls do not conflict with each
33other.
34
35API Reference
36*************
37
38.. doxygengroup:: retained_mem_interface
39