Launching Run or Debug of the System Project - 2023.2 English

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

Document ID
Release Date
2023.2 English

Once the System project has been built, you can launch run or debug with the following steps.

  1. Open the Launch Configuration editor (launch.json) for the System project by either selecting it from the Settings folder of the project in the Component Explorer, or select Open Settings next to Run or Debug in the Flow Navigator.
    Tip: The Open Settings command is a hidden icon that appears when you place your cursor in the Flow Navigator next to either Run or Debug.

  2. Edit an existing launch configuration, or create a new one to modify to establish the specific requirements for the run or debug session you are about to start. You can define separate launch configurations for the three types of targets supported for the System project. The build targets include Software Emulation (sw_emu), Hardware Emulation (hw_emu), and Hardware (hw) as described in Build Targets in Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393).

    Figure 1. Launch Configurations

    The preceding figure shows the System project Launch Configuration editor with the options available to configure the System project for Run or Debug.

    The preceding figure shows the System project hardware emulation launch configuration which includes the following settings:

    • Name: The name of the launch configuration.
    • Host Executable: the name of the host application contained in the Application component.
    • Cmd Line Args: arguments to be passed to the host application, including the binary container (.xclbin) if the code requires it.
    • Target: The build target that launch configuration should be used with.
    • Working Directory: This is the working directory that the host application is run from.
    • XRT Config File: This is the location of the xrt.ini file to be used when running the application. Refer to xrt.ini File for details on the available options.
    • Stop at main: Enable checkbox to add a breakpoint at the entry point to the main application for debugging.
    • Stop at program entry: Enable checkbox to add a breakpoint at the entry point to AI Engine program.

After configuring the launch configuration, you can select Run or Debug commands in the Launch Configuration editor, or by selecting Run or Debug from the Flow Navigator. If multiple launch configurations are available for the build target you are running, the Vitis IDE will prompt you to select a launch configuration to use.

Important: For embedded platforms running the QEMU environment you must launch the emulator prior to running or debugging the system.

For hardware emulation of embedded devices or embedded platforms you must start the QEMU environment by selecting the Emulator command from the Flow Navigator prior to selecting Run or Debug. The QEMU environment takes a few minutes to launch. You should wait to launch Run or Debug until the QEMU is up and running. Refer to Running Emulation on an Embedded Processor Platform for more information.

When launching hardware emulation, you can specify options for the AI Engine simulator that runs the graph application, as described in Reusing AI Engine Simulator Options in AI Engine Tools and Flows User Guide (UG1076). The options can be specified in the Emulator Arguments field by specifying the following command.

-aie-sim-options ${FULL_PATH}/aiesim_options.txt