BBRAM PL APIs - 2023.1 English

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

Document ID
UG643
Release Date
2023-05-16
Version
2023.1 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 should contain the xilskey_bbram_example.c and xilskey_input.h files.
    • You should provide user configurable parameters in the xilskey_input.h file. For more information, refer .
  • UltraScale BBRAM example usage:
    • The UltraScale BBRAM example application should contain the xilskey_bbram_ultrascale_input.h and xilskey_bbram_ultrascale_example.c files.
    • You should 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 you have set up your hardware 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