write_hw_sio_sweep - 2023.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.2 English

Write sweep data to a directory.


write_hw_sio_sweep [‑force] [‑quiet] [‑verbose] <directory> <hw_sio_sweep>


Name of the output directory.


Name Description
[-force] Overwrite existing directory
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<directory> hardware SIO_sweep directory path
<hw_sio_sweep> hardware SIO sweep data object




Write the populated hw_sio_sweep object after run_hw_sio_sweep completes.

To analyze the margin of a given link, it is often helpful to run a scan of the link using the specialized features of 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 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 saves the specified link sweep object to disk after it has been populated by the run_hw_sio_sweep command.

This command returns the name of the directory created, or returns an error if the command fails.


-force - (Optional) Overwrite the specified directory if it already exists.

-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.

<directory> - (Required) The name of a directory to write multiple scan files as a result of the run_hw_sio_sweep command.

<hw_sio_sweep> - (Required) Specify a hw_sio_sweep object to write to disk. The hw_sio_sweep must be specified as an object as returned by the get_hw_sio_sweeps command.


The following example writes the specified hw_sio_sweep object to disk:

write_hw_sio_sweep sweep_results [get_hw_sio_sweeps {SWEEP_1}]