Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bbram_driver_api Struct Reference

Driver Operations BBRAM driver operations More...

#include <zephyr/drivers/bbram.h>

Data Fields

bbram_api_check_invalid_t check_invalid
  OPT Check if BBRAM is invalid.
bbram_api_check_standby_power_t check_standby_power
  OPT Check for standby (Volt SBY) power failure.
bbram_api_check_power_t check_power
  OPT Check for V CC1 power failure.
bbram_api_get_size_t get_size
  OPT Get the size of the BBRAM (in bytes).
bbram_api_read_t read
  OPT Read bytes from BBRAM.
bbram_api_write_t write
  OPT Write bytes to BBRAM.

Detailed Description

Driver Operations BBRAM driver operations

This is the driver API structure any BBRAM driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also
DEVICE_DT_INST_DEFINE()
DEVICE_DT_DEFINE()
DEVICE_API()

Field Documentation

◆ check_invalid

bbram_api_check_invalid_t bbram_driver_api::check_invalid

OPT Check if BBRAM is invalid.

◆ check_power

bbram_api_check_power_t bbram_driver_api::check_power

OPT Check for V CC1 power failure.

◆ check_standby_power

bbram_api_check_standby_power_t bbram_driver_api::check_standby_power

OPT Check for standby (Volt SBY) power failure.

◆ get_size

bbram_api_get_size_t bbram_driver_api::get_size

OPT Get the size of the BBRAM (in bytes).

◆ read

bbram_api_read_t bbram_driver_api::read

OPT Read bytes from BBRAM.

◆ write

bbram_api_write_t bbram_driver_api::write

OPT Write bytes to BBRAM.


The documentation for this struct was generated from the following file: