Setting Up the Vitis Tool Environment - 2024.1 English

AI Engine Tools and Flows User Guide (UG1076)

Document ID
UG1076
Release Date
2024-06-27
Version
2024.1 English

The AI Engine tools are delivered and installed as part of the Vitis unified software platform. Therefore, when preparing to run the AI Engine tools, for example, the AI Engine compiler and AI Engine simulator, you must set up the Vitis unified software platform. The AMD Vitis™ unified software includes embedded base platforms targeting select boards like the VCK190 and the VEK280. You can also download the Common Images for Embedded AMD Vitis™ Platforms from https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/embedded-platforms.html. The common image package contains a prebuilt Linux kernel and root file system that can be used with the AMD Versal™ board for embedded design development together with the appropriate Vitis base platform.

For more information, see Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393).

After the Vitis unified software platform is installed, run the following script to set all the necessary environment variables, such as XILINX_VITIS and XILINX_HLS.

source <Vitis_install_path>/Vitis/<version>/settings64.csh
Tip: The settings64.sh for the Bash shell is also provided in the same directory.

Set up your PLATFORM_REPO_PATHS environment variable to $XILINX_VITIS/base_platforms

setenv PLATFORM_REPO_PATHS $XILINX_VITIS/base_platforms
Tip: The PLATFORM_REPO_PATHS environment variable points to directories containing platform files (XPFM). This lets you specify platforms using only the folder name for the platform.

The AI Engine tools require a license which can be generated for free from any eligible AMD licensing account. The path to the license must be set in one of the following environment variables: XILINXD_LICENSE_FILE or LM_LICENSE_FILE.

You can validate the installation and setup of the tools by using one of the following commands.

vitis --help