1.. _bbram_api:
2
3Battery Backed RAM (BBRAM)
4##########################
5
6The BBRAM APIs allow interfacing with the unique properties of this memory region. The following
7common types of BBRAM properties are easily accessed via this API:
8
9- IBBR (invalid) state - check that the BBRAM is not corrupt.
10- VSBY (voltage standby) state - check if the BBRAM is using standby voltage.
11- VCC (active power) state - check if the BBRAM is on normal power.
12- Size - get the size (in bytes) of the BBRAM region.
13
14Along with these, the API provides a means for reading and writing to the memory region via
15:c:func:`bbram_read` and :c:func:`bbram_write` respectively. Both functions are expected to only
16succeed if the BBRAM is in a valid state and the operation is bounded to the memory region.
17
18API Reference
19*************
20
21.. doxygengroup:: bbram_interface
22