The latest development version of this page may be more current than this released 4.1.0 version.

Battery Backed RAM (BBRAM)

The BBRAM APIs allow interfacing with the unique properties of this memory region. The following common types of BBRAM properties are easily accessed via this API:

  • IBBR (invalid) state - check that the BBRAM is not corrupt.

  • VSBY (voltage standby) state - check if the BBRAM is using standby voltage.

  • VCC (active power) state - check if the BBRAM is on normal power.

  • Size - get the size (in bytes) of the BBRAM region.

Along with these, the API provides a means for reading and writing to the memory region via bbram_read() and bbram_write() respectively. Both functions are expected to only succeed if the BBRAM is in a valid state and the operation is bounded to the memory region.

API Reference

BBRAM Interface