XFpga_PL_BitStream_Load - 2021.1 English

Xilinx Standalone Library Documentation OS and Libraries Document Collection (UG643)
Document ID
UG643
Release Date
2021-06-16
Version
2021.1 English

The API is used to load the bitstream file into the PL region.

It supports the Vivado-generated bitstream(*.bit, *.bin) and Bootgen-generated bitstream(*.bin) loading, Passing valid bitstream size(Size) information is mandatory for Vivado-generated bitstream, For Bootgen-generated bitstreams bitstream size is taken from the bitstream header.

Note:
  • This API will be deprecated in the 2022.1 release. Use the updated ' XFpga_BitStream_Load() ' API to perform the same functionality.

Prototype

u32 XFpga_PL_BitStream_Load(XFpga *InstancePtr, UINTPTR BitstreamImageAddr, UINTPTR AddrPtr_Size, u32 Flags);

Parameters

The following table lists the XFpga_PL_BitStream_Load function arguments.

Table 1. XFpga_PL_BitStream_Load Arguments
Type Name Description
XFpga * InstancePtr Pointer to the XFpga structure.
UINTPTR BitstreamImageAddr Linear memory bitstream image base address
UINTPTR AddrPtr_Size Aes key address which is used for decryption (or) In none secure bitstream used it is used store size of bitstream image.
u32 Flags Flags are used to specify the type of bitstream file.
  • BIT(0) - Bitstream type
    • 0 - Full bitstream
    • 1 - Partial bitstream
    • 1 - Enable
  • BIT(1) - Authentication using DDR
    • 1 - Enable
    • 0 - Disable
  • BIT(2) - Authentication using OCM
    • 1 - Enable
    • 0 - Disable
  • BIT(3) - User-key Encryption
    • 1 - Enable
    • 0 - Disable
  • BIT(4) - Device-key Encryption
    • 1 - Enable
    • 0 - Disable

Returns

  • XFPGA_SUCCESS on success
  • Error code on failure.
  • XFPGA_VALIDATE_ERROR.
  • XFPGA_PRE_CONFIG_ERROR.
  • XFPGA_WRITE_BITSTREAM_ERROR.
  • XFPGA_POST_CONFIG_ERROR.