EEPROM

Interfaces for Electrically Erasable Programmable Read-Only Memory (EEPROM). More...

Files
file	eeprom.h
	Main header file for EEPROM driver API.

Data Structures
struct	eeprom_driver_api
	@driver_ops{EEPROM} More...

Functions
int	eeprom_read (const struct device *dev, off_t offset, void *data, size_t len)
	Read data from EEPROM.
int	eeprom_write (const struct device *dev, off_t offset, const void *data, size_t len)
	Write data to EEPROM.
size_t	eeprom_get_size (const struct device *dev)
	Get the size of the EEPROM in bytes.
typedef int(*	eeprom_api_read) (const struct device *dev, off_t offset, void *data, size_t len)
	@def_driverbackendgroup{EEPROM,eeprom_interface}
typedef int(*	eeprom_api_write) (const struct device *dev, off_t offset, const void *data, size_t len)
	Callback API upon writing to the EEPROM.
typedef size_t(*	eeprom_api_size) (const struct device *dev)
	Callback API upon getting the EEPROM size.

Detailed Description

Interfaces for Electrically Erasable Programmable Read-Only Memory (EEPROM).

Since

2.1

Version

1.0.0

Typedef Documentation

eeprom_api_read

typedef int(* eeprom_api_read) (const struct device *dev, off_t offset, void *data, size_t len)

#include <eeprom.h>

@def_driverbackendgroup{EEPROM,eeprom_interface}

Callback API upon reading from the EEPROM. See eeprom_read() for argument description

eeprom_api_size

typedef size_t(* eeprom_api_size) (const struct device *dev)

#include <eeprom.h>

Callback API upon getting the EEPROM size.

See eeprom_get_size() for argument description

eeprom_api_write

typedef int(* eeprom_api_write) (const struct device *dev, off_t offset, const void *data, size_t len)

#include <eeprom.h>

Callback API upon writing to the EEPROM.

See eeprom_write() for argument description

Function Documentation

eeprom_get_size()

size_t eeprom_get_size

(

const struct device *

dev

)

#include <eeprom.h>

Get the size of the EEPROM in bytes.

Parameters

dev	EEPROM device.

Returns

EEPROM size in bytes.

eeprom_read()

int eeprom_read	(	const struct device *	dev,
		off_t	offset,
		void *	data,
		size_t	len )

#include <eeprom.h>

Read data from EEPROM.

Parameters

dev	EEPROM device
offset	Address offset to read from.
data	Buffer to store read data.
len	Number of bytes to read.

Returns

0 on success, negative errno code on failure.

eeprom_write()

int eeprom_write	(	const struct device *	dev,
		off_t	offset,
		const void *	data,
		size_t	len )

#include <eeprom.h>

Write data to EEPROM.

Parameters

dev	EEPROM device
offset	Address offset to write data to.
data	Buffer with data to write.
len	Number of bytes to write.

Returns

0 on success, negative errno code on failure.