Executing STAPL Files - 2023.2 English

Vivado Design Suite User Guide: Programming and Debugging (UG908)

Document ID
UG908
Release Date
2023-10-19
Version
2023.2 English

Once the STAPL file is created, you can optionally execute the STAPL file through the stapl_player application executable, which is part of the Vivado installation. STAPL Player can execute STAPL files generated through the STAPL generation feature and is intended as the validation test tool. The stapl_player application is not intended as a general-purpose STAPL execution command; only use STAPL files created through Vivado IDE.

To run a STAPL file, you can run the application using the command on a live target as follows:

stapl_player run --help
Usage: stapl_player run [OPTIONS]
 
Options:
  -i, --input-file FILE  STAPL file to play  [required]
  -h, --hw-server TEXT   Hardware server URL  [default: TCP:localhost:3121]
  -a, --action TEXT      STAPL action to perform  [required]
  --cable-serial TEXT    Serial number of JTAG cable. This option can be used
                         to choose a specific JTAG cable amongst multiple
                         cables connected to the hardware server. [optional]
 
  --help                 Show this message and exit.

Example

$stapl_player run --input-file my_vc1902.stapl --hw-server TCP:192.168.0.100:3121 --action PROGRAM
 
******** AMD stapl-player v2023.2.0
  ****** Build date   : Aug 18 2023-16:35:08
    **** Build number : 2023.2.1692398108
      ** Copyright 2021-2022 Xilinx, Inc. All Rights Reserved.
	** Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.

In this example, the PROGRAM action from my_vc1902.stapl file is executed on the hardware server running on host 192.168.0.100.

If the host machine running the hardware server has multiple JTAG cables, you can use the list_cables command of the STAPL player to list the serial numbers of available cables. You can specify the target serial number using the --cable-serial option of the run command.

Example

$ stapl_player list_cables -h 192.168.0.200:3121


******** Xilinx stapl-player v2023.2.0
  ****** Build date   : Aug 18 2023-16:35:08
    **** Build number : 2023.2.1692398108
      ** Copyright 2021-2022 Xilinx, Inc. All Rights Reserved.
      ** Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.


Connecting to the hardware server at 192.168.0.200:3121

Serial numbers of JTAG cables connected to the hardware server on 192.168.0.200:3121 are -
    Cable #1 - 492218147875A
    Cable #2 - 0000180fe3cf01

In this example, the STAPL player lists the serial numbers of two cables available on 192.168.0.200.