Hardware Debug for Embedded Processors - 2024.1 English

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

Document ID
Release Date
2024.1 English
For hardware builds the setup involves the following steps:
  1. Copy the contents of the <project>/Hardware/sd_card/sd_card folder to a physical SD card. This creates a bootable medium for your target platform.
  2. Insert the SD card into the card reader of your embedded processor platform.
  3. Change the boot-mode settings of the platform to SD boot mode, and power up the board.
  4. After the device is booted, enter the mount command at the command prompt to get a list of mount points. As shown in the following figure, the mount command displays mounting information for the system.
    Tip: Be sure to capture the proper path for the cd command in the next step, and subsequent commands, based on the results of the mount command.

  5. Execute the following commands, for example:
    cd /run/media/mmcblkop1
    source init.sh
    cat /etc/xocl.txt

    The cat command will display the platform name xilinx_vck190_base_202410_1 to let you confirm it is the same as your specified platform and that your setup is correct.

  6. Run ifconfig to get the IP address of the target card. You will use the IP address to set up a TCF agent connection in the Vitis unified IDE to connect to the assigned IP address of the embedded processor platform.
  7. Create a target connection to the remote accelerator card. Use the Vitis > Target Connections menu command to open the Target Connections dialog box.
  8. Right-click the Linux TCF Agent and select the New Target command to open the New Target Connection dialog box.
  9. Specify the Target Name, enable the Set as default target check box, and specify the Host IP address of the accelerator card that you obtained in an earlier step.

  10. Click OK to close and continue.
  11. In the Flow Navigator view, click the Open Settings command to open the Launch Configuration editor to create a new launch configuration for the hardware design

    Set the following fields on the Main tab of the dialog box:

    Specifies a name for your Hardware debug configuration.
    Target Connection
    Select a Linux TCF agent as previously configured
    Host Executable
    Specify the location of the software application to drive the hardware
    Cmd Line Args
    Specify any needed command line arguments for the host application, such as the .xclbin file to load
    Work Directory
    Specifies the location where the system is run and output files will be written
    XRT Config File
    Specifies the xrt.ini file to add to the hardware run as described in Enabling Profiling in Your Application
    Stop at Main
    Puts a breakpoint in the host application to stop at the entry to the main() function to enable debug operations
    Stop At Program Entry
    Places a breakpoint at the entry to the hardware program to enable debug operations
  12. Select Debug from the Flow Navigator to open the Debug view as described in Debug View.

    This opens the Debug view in the Vitis unified IDE, and connects to the PS application on your hardware platform. The application automatically breaks at the main() function to let you set up and configure the debug environment.