stop_hw_sio_sweep - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Stop hardware SIO sweeps.

Syntax

stop_hw_sio_sweep [‑quiet] [‑verbose] <hw_sio_sweeps>

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<hw_sio_sweeps> hardware SIO sweeps

Categories

Hardware

Description

Stop the specified sweep scan.

To analyze the margin of a given link, it is often helpful to run a scan of the link using the specialized features of AMD UltraScale™ devices or 7 series FPGAs. It can also be helpful to run multiple scans on a the link with different configuration settings for the GTs. This can help you determine which settings are best for your design. The AMD Vivado™ serial I/O analyzer feature enables you to define, run, and save link sweeps, or collections of link scans run across a range of values.

This command lets you stop a sweep scan that is in progress as started with the run_hw_sio_sweep command.

You can remove the created sweep scan object using remove_hw_sio_sweep.

This command returns nothing if successful, or returns an error if the command fails.

Arguments

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<hw_sio_sweeps> - (Required) Specify one or more hw_sio_sweep objects to stop. The hw_sio_sweep must be specified as an object as returned by the get_hw_sio_sweeps command.

Example

The following example stops the specified running sweep scan:

stop_hw_sio_sweep [lindex [get_hw_sio_sweeps {SWEEP_0}] 0]