BBRAM PL APIs - BBRAM PL APIs - 2025.2 English - UG643

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2025-11-20
Version
2025.2 English

This section provides a linked summary and detailed descriptions of the battery-backed RAM (BBRAM) APIs of Zynq PL and UltraScale devices.

Example Usage

  • Zynq BBRAM PL example usage:
    • The Zynq BBRAM PL example application contains the xilskey_bbram_example.c and xilskey_input.h files.
    • Provide user-configurable parameters in the xilskey_input.h file.
  • UltraScale BBRAM example usage:
    • The UltraScale BBRAM example application contains the xilskey_bbram_ultrascale_input.h and xilskey_bbram_ultrascale_example.c files.
    • Provide user configurable parameters in the xilskey_bbram_ultrascale_input.h file. For more information, refer UltraScale or UltraScale+ User Configurable BBRAM PL Parameters.
Note: It is assumed that the hardware set-up is complete prior to working on the example application. For more information, refer Hardware Setup.
Table 1. Quick Function Reference
Type Member Arguments
int XilSKey_Bbram_Program
  • XilSKey_Bbram * InstancePtr
int XilSKey_Bbram_JTAGServerInit
  • XilSKey_Bbram * InstancePtr