Using the Command Line - 2025.1 English - UG908

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

Document ID
UG908
Release Date
2025-05-29
Version
2025.1 English

Following are the steps needed to create an STAPL target after initially launching Vivado or Vivado Lab Edition:

open_hw_manager
connect_hw_server
create_hw_target -stapl my_stapl_target
if {[string length [get_hw_targets -quiet -filter
{IS_OPENED == TRUE}]] > 0} \
{close_hw_target [get_hw_targets * -filter {IS_OPENED == TRUE}
] }; \
open_hw_target [get_hw_targets -regexp .*my_stapl_target]
current_hw_target

The first two commands can be omitted if already connected to a server. When executed, the create_hw_target command defines the my_stapl_target.

Note: You cannot have two targets with the same name in a session.

Finally, after closing any open target and opening the STAPL target, the create_hw_target command is run. As a result, the final command shows the full hardware target handle name of the created my_stapl_target.

All standard operations on the target, such as get_hw_targets and open_hw_target commands, are supported. You can use the IS_STAPL hardware target property to distinguish between a live target and an STAPL target. For instance, the following is a sample command line that reads the IS_STAPL property from a target named "my_stapl_target."

get_property IS_STAPL [get_hw_targets -regexp .*my_stapl_target]

Additionally, all the STAPL hw_targets created in this session can be displayed by issuing the following command:

get_hw_targets -filter {IS_STAPL}

To delete the created target, use the delete_hw_target command. For instance, by issuing the following command, the my_stapl_target is deleted:

delete_hw_target [get_hw_targets -regexp .*my_stapl_target]
Important: When a target is deleted, all the devices created for the target are also deleted. Moreover, a deleted target is also closed if it was previously opened.