Retention API

Retention API. More...

Modules
	Boot mode interface
	Boot mode interface.
	Bootloader info interface
	Bootloader info interface.

Data Structures
struct	retention_api

Typedefs
typedef ssize_t(*	retention_size_api) (const struct device *dev)
typedef int(*	retention_is_valid_api) (const struct device *dev)
typedef int(*	retention_read_api) (const struct device *dev, off_t offset, uint8_t *buffer, size_t size)
typedef int(*	retention_write_api) (const struct device *dev, off_t offset, const uint8_t *buffer, size_t size)
typedef int(*	retention_clear_api) (const struct device *dev)

Functions
ssize_t	retention_size (const struct device *dev)
	Returns the size of the retention area.
int	retention_is_valid (const struct device *dev)
	Checks if the underlying data in the retention area is valid or not.
int	retention_read (const struct device *dev, off_t offset, uint8_t *buffer, size_t size)
	Reads data from the retention area.
int	retention_write (const struct device *dev, off_t offset, const uint8_t *buffer, size_t size)
	Writes data to the retention area (underlying data does not need to be cleared prior to writing), once function returns with a success code, the data will be classed as valid if queried using retention_is_valid().
int	retention_clear (const struct device *dev)
	Clears all data in the retention area (sets it to 0)

Detailed Description

Retention API.

Since

3.4

Version

0.1.0

Typedef Documentation

retention_clear_api

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

#include <include/zephyr/retention/retention.h>

retention_is_valid_api

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

#include <include/zephyr/retention/retention.h>

retention_read_api

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

#include <include/zephyr/retention/retention.h>

retention_size_api

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

#include <include/zephyr/retention/retention.h>

retention_write_api

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

#include <include/zephyr/retention/retention.h>

Function Documentation

retention_clear()

int retention_clear

(

const struct device *

dev

)

#include <include/zephyr/retention/retention.h>

Clears all data in the retention area (sets it to 0)

Parameters

dev	Retention device to use.

Return values

0	on success else negative errno code.

retention_is_valid()

int retention_is_valid

(

const struct device *

dev

)

#include <include/zephyr/retention/retention.h>

Checks if the underlying data in the retention area is valid or not.

Parameters

dev	Retention device to use.

Return values

1	If successful and data is valid.
0	If data is not valid.
-ENOTSUP	If there is no header/checksum configured for the retention area.
-errno	Error code code.

retention_read()

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

#include <include/zephyr/retention/retention.h>

Reads data from the retention area.

Parameters

dev	Retention device to use.
offset	Offset to read data from.
buffer	Buffer to store read data in.
size	Size of data to read.

Return values

0	If successful.
-errno	Error code code.

retention_size()

ssize_t retention_size

(

const struct device *

dev

)

#include <include/zephyr/retention/retention.h>

Returns the size of the retention area.

Parameters

dev	Retention device to use.

Return values

Positive

value indicating size in bytes on success, else negative errno code.

retention_write()

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

#include <include/zephyr/retention/retention.h>

Writes data to the retention area (underlying data does not need to be cleared prior to writing), once function returns with a success code, the data will be classed as valid if queried using retention_is_valid().

Parameters

dev	Retention device to use.
offset	Offset to write data to.
buffer	Data to write.
size	Size of data to be written.

Return values

0	on success else negative errno code.