Retained Memory Driver Backend API

Data Structures
struct	retained_mem_driver_api
	Driver Operations Retained Memory driver operations More...

Typedefs
typedef ssize_t(*	retained_mem_size_api) (const struct device *dev)
	Callback API to get size of retained memory area.
typedef int(*	retained_mem_read_api) (const struct device *dev, off_t offset, uint8_t *buffer, size_t size)
	Callback API to read from retained memory area.
typedef int(*	retained_mem_write_api) (const struct device *dev, off_t offset, const uint8_t *buffer, size_t size)
	Callback API to write to retained memory area.
typedef int(*	retained_mem_clear_api) (const struct device *dev)
	Callback API to clear retained memory area (reset all data to 0x00).

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Retained Memory driver.

Typedef Documentation

retained_mem_clear_api

typedef int(* retained_mem_clear_api) (const struct device *dev)

#include <zephyr/drivers/retained_mem.h>

Callback API to clear retained memory area (reset all data to 0x00).

See retained_mem_clear() for argument description.

retained_mem_read_api

typedef int(* retained_mem_read_api) (const struct device *dev, off_t offset, uint8_t *buffer, size_t size)

#include <zephyr/drivers/retained_mem.h>

Callback API to read from retained memory area.

See retained_mem_read() for argument description.

retained_mem_size_api

typedef ssize_t(* retained_mem_size_api) (const struct device *dev)

#include <zephyr/drivers/retained_mem.h>

Callback API to get size of retained memory area.

See retained_mem_size() for argument description.

retained_mem_write_api

typedef int(* retained_mem_write_api) (const struct device *dev, off_t offset, const uint8_t *buffer, size_t size)

#include <zephyr/drivers/retained_mem.h>

Callback API to write to retained memory area.

See retained_mem_write() for argument description.