Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Data Structures | Typedefs | Functions
BBRAM Interface
Device Driver APIs

BBRAM Interface . More...

Data Structures

struct  bbram_driver_api
 

Typedefs

typedef int(* bbram_api_check_invalid_t) (const struct device *dev)
 API template to check if the BBRAM is invalid.
 
typedef int(* bbram_api_check_standby_power_t) (const struct device *dev)
 API template to check for standby power failure.
 
typedef int(* bbram_api_check_power_t) (const struct device *dev)
 API template to check for V CC1 power failure.
 
typedef int(* bbram_api_get_size_t) (const struct device *dev, size_t *size)
 API template to check the size of the BBRAM.
 
typedef int(* bbram_api_read_t) (const struct device *dev, size_t offset, size_t size, uint8_t *data)
 API template to read from BBRAM.
 
typedef int(* bbram_api_write_t) (const struct device *dev, size_t offset, size_t size, const uint8_t *data)
 API template to write to BBRAM.
 

Functions

int bbram_check_invalid (const struct device *dev)
 Check if BBRAM is invalid.
 
int bbram_check_standby_power (const struct device *dev)
 Check for standby (Volt SBY) power failure.
 
int bbram_check_power (const struct device *dev)
 Check for V CC1 power failure.
 
int bbram_get_size (const struct device *dev, size_t *size)
 Get the size of the BBRAM (in bytes).
 
int bbram_read (const struct device *dev, size_t offset, size_t size, uint8_t *data)
 Read bytes from BBRAM.
 
int bbram_write (const struct device *dev, size_t offset, size_t size, const uint8_t *data)
 Write bytes to BBRAM.
 
int bbram_emul_set_invalid (const struct device *dev, bool is_invalid)
 Set the emulated BBRAM driver's invalid state.
 
int bbram_emul_set_standby_power_state (const struct device *dev, bool failure)
 Set the emulated BBRAM driver's standby power state.
 
int bbram_emul_set_power_state (const struct device *dev, bool failure)
 Set the emulated BBRAM driver's power state.
 

Detailed Description

BBRAM Interface .

Typedef Documentation

◆ bbram_api_check_invalid_t

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

#include <zephyr/drivers/bbram.h>

API template to check if the BBRAM is invalid.

See also
bbram_check_invalid

◆ bbram_api_check_power_t

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

#include <zephyr/drivers/bbram.h>

API template to check for V CC1 power failure.

See also
bbram_check_power

◆ bbram_api_check_standby_power_t

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

#include <zephyr/drivers/bbram.h>

API template to check for standby power failure.

See also
bbram_check_standby_power

◆ bbram_api_get_size_t

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

#include <zephyr/drivers/bbram.h>

API template to check the size of the BBRAM.

See also
bbram_get_size

◆ 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>

API template to read from BBRAM.

See also
bbram_read

◆ 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>

API template to write to BBRAM.

See also
bbram_write

Function Documentation

◆ bbram_check_invalid()

int bbram_check_invalid ( const struct device * dev)

#include <zephyr/drivers/bbram.h>

Check if BBRAM is invalid.

Check if "Invalid Battery-Backed RAM" status is set then reset the status bit. This may occur as a result to low voltage at the VBAT pin.

Parameters
[in]devBBRAM device pointer.
Returns
0 if the Battery-Backed RAM data is valid, -EFAULT otherwise.

◆ bbram_check_power()

int bbram_check_power ( const struct device * dev)

#include <zephyr/drivers/bbram.h>

Check for V CC1 power failure.

This will return an error if the V CC1 power domain is turned on after it was off and reset the status bit.

Parameters
[in]devBBRAM device pointer.
Returns
0 if the V CC1 power domain is in normal operation, -EFAULT otherwise.

◆ bbram_check_standby_power()

int bbram_check_standby_power ( const struct device * dev)

#include <zephyr/drivers/bbram.h>

Check for standby (Volt SBY) power failure.

Check if the V standby power domain is turned on after it was off then reset the status bit.

Parameters
[in]devBBRAM device pointer.
Returns
0 if V SBY power domain is in normal operation.

◆ bbram_emul_set_invalid()

int bbram_emul_set_invalid ( const struct device * dev,
bool is_invalid )

#include <zephyr/drivers/bbram.h>

Set the emulated BBRAM driver's invalid state.

Calling this will affect the emulated behavior of bbram_check_invalid().

Parameters
[in]devThe emulated device to modify
[in]is_invalidThe new invalid state
Returns
0 on success, negative values on error.

◆ bbram_emul_set_power_state()

int bbram_emul_set_power_state ( const struct device * dev,
bool failure )

#include <zephyr/drivers/bbram.h>

Set the emulated BBRAM driver's power state.

Calling this will affect the emulated behavior of bbram_check_power().

Parameters
[in]devThe emulated device to modify
[in]failureWhether or not a power failure should be emulated
Returns
0 on success, negative values on error.

◆ bbram_emul_set_standby_power_state()

int bbram_emul_set_standby_power_state ( const struct device * dev,
bool failure )

#include <zephyr/drivers/bbram.h>

Set the emulated BBRAM driver's standby power state.

Calling this will affect the emulated behavior of bbram_check_standby_power().

Parameters
[in]devThe emulated device to modify
[in]failureWhether or not standby power failure should be emulated
Returns
0 on success, negative values on error.

◆ bbram_get_size()

int bbram_get_size ( const struct device * dev,
size_t * size )

#include <zephyr/drivers/bbram.h>

Get the size of the BBRAM (in bytes).

Parameters
[in]devBBRAM device pointer.
[out]sizePointer to write the size to.
Returns
0 for success, -EFAULT otherwise.

◆ bbram_read()

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

#include <zephyr/drivers/bbram.h>

Read bytes from BBRAM.

Parameters
[in]devThe BBRAM device pointer to read from.
[in]offsetThe offset into the RAM address to start reading from.
[in]sizeThe number of bytes to read.
[out]dataThe buffer to load the data into.
Returns
0 on success, -EFAULT if the address range is out of bounds.

◆ bbram_write()

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

#include <zephyr/drivers/bbram.h>

Write bytes to BBRAM.

Parameters
[in]devThe BBRAM device pointer to write to.
[in]offsetThe offset into the RAM address to start writing to.
[in]sizeThe number of bytes to write.
[out]dataPointer to the start of data to write.
Returns
0 on success, -EFAULT if the address range is out of bounds.