Retained memory

Interfaces for retained memory. More...

Topics
	Retained Memory Driver Backend API

Files
file	retained_mem.h
	Main header file for retained memory driver API.

Functions
ssize_t	retained_mem_size (const struct device *dev)
	Returns the size of the retained memory area.
int	retained_mem_read (const struct device *dev, off_t offset, uint8_t *buffer, size_t size)
	Reads data from the Retained memory area.
int	retained_mem_write (const struct device *dev, off_t offset, const uint8_t *buffer, size_t size)
	Writes data to the Retained memory area - underlying data does not need to be cleared prior to writing.
int	retained_mem_clear (const struct device *dev)
	Clears data in the retained memory area by setting it to 0x00.

Detailed Description

Interfaces for retained memory.

Since

3.4

Version

1.0.0

Function Documentation

retained_mem_clear()

int retained_mem_clear

(

const struct device *

dev

)

#include <zephyr/drivers/retained_mem.h>

Clears data in the retained memory area by setting it to 0x00.

Parameters

dev	Retained memory device to use.

Returns

0 on success else negative errno code.

retained_mem_read()

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

#include <zephyr/drivers/retained_mem.h>

Reads data from the Retained memory area.

Parameters

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

Returns

0 on success else negative errno code.

retained_mem_size()

ssize_t retained_mem_size

(

const struct device *

dev

)

#include <zephyr/drivers/retained_mem.h>

Returns the size of the retained memory area.

Parameters

dev	Retained memory device to use.

Returns

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

retained_mem_write()

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

#include <zephyr/drivers/retained_mem.h>

Writes data to the Retained memory area - underlying data does not need to be cleared prior to writing.

Parameters

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

Returns

0 on success else negative errno code.