Vitis Environment Reference Materials

The reference materials contained here include the following:

  • Vitis Compiler Command: A description of the compiler options (-c), the linking options (-l), options common to both compile and linking, and a discussion of the --config options.
  • The xrt.ini file is used to initialize XRT to produce reports, debug, and profiling data as it transacts business between the host and kernels. This file is used when the application is run, for emulation or hardware builds, and must be created manually when the build process is run from the command line.
  • Various Xilinx utilities are provided for the Vitis tools and Xilinx® Runtime (XRT) to provide detailed information about the platform resources, including SLR and memory resource availability, to help you construct the v++ command line, and manage the build and run process.
    • platforminfo Utility: The platforminfo utility queries the platforms for which Vitis™ installation to use.
    • kernelinfo Utility: The kernelinfo utility prints the function definitions in the given Xilinx object file (O) file.
    • emconfigutil Utility: The emulation configuration utility (emconfigutil) is used to automate the creation of the emulation configuration file.
    • xclbinutil Utility: The xclbinutil utility operates on a xclbin produced by the Vitis Compiler.
    • xbutil Utility: The Xilinx Board Utility (xbutil) is a command line tool used to perform various board installation, administration, and debug tasks.
    • xbmgmt Utility: The Xilinx® Board Management (xbmgmt) utility is a standalone command line tool that is included with the Xilinx Runtime (XRT) installation package. It supports both Alveo Data Center accelerator cards and embedded processor-based platforms.
    TIP: The Xilinx® Runtime (XRT) Architecture reference material is available on the Xilinx Github site at this link: https://xilinx.github.io/XRT/.
  • package_xo Command: The Tcl command used in the Vivado Design Suite to package an RTL IP into an .xo file, as described in RTL Kernels.
  • HLS Pragmas: A description of pragmas used by the Vivado HLS tool in synthesizing C/C++ kernels.
  • OpenCL Attributes: Descriptions of __attributes that can be added to OpenCL™ kernels to direct the results of the kernel build process.