BBRAM Driver Backend API

Data Structures
struct	bbram_driver_api
	Driver Operations BBRAM driver operations More...

Typedefs
typedef int(*	bbram_api_check_invalid_t) (const struct device *dev)
	Callback API to check if the BBRAM is invalid See bbram_check_invalid() for argument description.
typedef int(*	bbram_api_check_standby_power_t) (const struct device *dev)
	Callback API to check for standby power failure See bbram_check_standby_power() for argument description.
typedef int(*	bbram_api_check_power_t) (const struct device *dev)
	Callback API to check for V CC1 power failure See bbram_check_power() for argument description.
typedef int(*	bbram_api_get_size_t) (const struct device *dev, size_t *size)
	Callback API to get the size of the BBRAM See bbram_get_size() for argument description.
typedef int(*	bbram_api_read_t) (const struct device *dev, size_t offset, size_t size, uint8_t *data)
	Callback API to read from BBRAM See bbram_read() for argument description.
typedef int(*	bbram_api_write_t) (const struct device *dev, size_t offset, size_t size, const uint8_t *data)
	Callback API to write to BBRAM.

Detailed Description

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

Typedef Documentation

bbram_api_check_invalid_t

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

#include <zephyr/drivers/bbram.h>

Callback API to check if the BBRAM is invalid See bbram_check_invalid() for argument description.

bbram_api_check_power_t

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

#include <zephyr/drivers/bbram.h>

Callback API to check for V CC1 power failure See bbram_check_power() for argument description.

bbram_api_check_standby_power_t

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

#include <zephyr/drivers/bbram.h>

Callback API to check for standby power failure See bbram_check_standby_power() for argument description.

bbram_api_get_size_t

typedef int(* bbram_api_get_size_t) (const struct device *dev, size_t *size)

#include <zephyr/drivers/bbram.h>

Callback API to get the size of the BBRAM See bbram_get_size() for argument description.

bbram_api_read_t

typedef int(* bbram_api_read_t) (const struct device *dev, size_t offset, size_t size, uint8_t *data)

#include <zephyr/drivers/bbram.h>

Callback API to read from BBRAM See bbram_read() for argument description.

bbram_api_write_t

typedef int(* bbram_api_write_t) (const struct device *dev, size_t offset, size_t size, const uint8_t *data)

#include <zephyr/drivers/bbram.h>

Callback API to write to BBRAM.

See bbram_write() for argument description