Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
EEPROM Interface

EEPROM Interface. More...

Data Structures

struct  eeprom_driver_api
 

Typedefs

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

Functions

int eeprom_read (const struct device *dev, off_t offset, void *data, size_t len)
 Read data from EEPROM. More...
 
int eeprom_write (const struct device *dev, off_t offset, const void *data, size_t len)
 Write data to EEPROM. More...
 
size_t eeprom_get_size (const struct device *dev)
 Get the size of the EEPROM in bytes. More...
 

Detailed Description

EEPROM Interface.

Typedef Documentation

◆ eeprom_api_read

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

◆ eeprom_api_size

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

◆ eeprom_api_write

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

Function Documentation

◆ eeprom_get_size()

size_t eeprom_get_size ( const struct device dev)

#include <include/drivers/eeprom.h>

Get the size of the EEPROM in bytes.

Parameters
devEEPROM device.
Returns
EEPROM size in bytes.

◆ eeprom_read()

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

#include <include/drivers/eeprom.h>

Read data from EEPROM.

Parameters
devEEPROM device
offsetAddress offset to read from.
dataBuffer to store read data.
lenNumber 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 <include/drivers/eeprom.h>

Write data to EEPROM.

Parameters
devEEPROM device
offsetAddress offset to write data to.
dataBuffer with data to write.
lenNumber of bytes to write.
Returns
0 on success, negative errno code on failure.