program - 2021.2 English

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)

Document ID
UG1393
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English
Important: This option is supported for use with embedded processor DFX platforms.

The program command downloads a specified xclbin binary to the programmable region on the card.

It has the following command line format:

xbutil program [-d card] [-r region] -p <xclbin_filename>

The following table lists the available options.

Table 1. xbutil program Command Options
Option Description Required
-d <card> Specifies the target card. <card> can be specified as either the card_id or Bus:Device:Function (BDF). Defaults to card_id = 0 if not specified.
Note: Use the xbutil scan command to display both the card_id and BDF for installed cards.
N
-r <region> Deprecated and has no effect. Option will be removed in subsequent release. N
-p <xclbin_filename> Specifies the file name of the xclbin binary file to download to the card. Y

When an xclbin is successfully downloaded to the card, the following message is displayed:

INFO: Found total 1 card(s), 1 are usable
INFO: xbutil program succeeded.

If the subsequent use of the xbutil program uses the same xbutil_filename, the xbutil will not be downloaded as it already exists on the card, but the above message will be identical.

If the specified xclbin file does not exist, the following message will be displayed:

ERROR: Cannot open <my_xclbin>.xclbin. Check that it exists and is readable.
ERROR: xbutil program failed.