Retained memory driver API API which can be used by a device to store data in a retained memory area. More...

#include <retained_mem.h>

Data Fields
retained_mem_size_api	size

retained_mem_read_api	read

retained_mem_write_api	write

retained_mem_clear_api	clear

Detailed Description

Retained memory driver API API which can be used by a device to store data in a retained memory area.

Retained memory is memory that is retained while the device is powered but is lost when power to the device is lost (note that low power modes in some devices may clear the data also). This may be in a non-initialised RAM region, or in specific registers, but is not reset when a different application begins execution or the device is rebooted (without power loss). It must support byte-level reading and writing without a need to erase data before writing.

Note that drivers must implement all functions, none of the functions are optional.

Field Documentation

◆ clear

retained_mem_clear_api retained_mem_driver_api::clear

◆ read

retained_mem_read_api retained_mem_driver_api::read

◆ size

retained_mem_size_api retained_mem_driver_api::size

◆ write

retained_mem_write_api retained_mem_driver_api::write

The documentation for this struct was generated from the following file: