xbutil Utility - 2022.1 English

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

Document ID
Release Date
2022.1 English

The Xilinx® Board Utility (xbutil) is a standalone command line utility that is included with the Xilinx Runtime (XRT) installation package. Details of the xbutil command can be found at https://xilinx.github.io/XRT/master/html/xbutil.html.

xbutil includes multiple commands to validate and identify the installed accelerator card(s) along with additional card details including on card memory, host interface, target platform name, and system information. This information can be used for both card administration and application debugging.

Accelerator cards are partitioned into a user function and a management function to provide different levels of card access. The user function lets you load and run applications, while the management function is for system administrators to manage the card. The xbutil utility interacts with the user function. The xbmgmt utility, which requires root privilege, is for interacting with the management function. The reason for splitting the function access between the two utilities is to provide some security for the management features of the tool.

You can use the help command to list the available xbutil commands and options:
xbutil --help

Set up the xbutil command as part of the XRT installation using the following scripts:

  • For csh shell:
    $ source /opt/xilinx/xrt/setup.csh
  • For bash shell:
    $ source /opt/xilinx/xrt/setup.sh