report_hw_pcie - 2021.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2021.2 English

Formatted report for PCIe core.


report_hw_pcie [‑file <arg>] [‑append] [‑return_string] [‑quiet] [‑verbose]


Name Description
[-file] File name (including full path) to output the report results to
[-append] Append the report results to a file
[-return_string] Return report results as a string
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<hw_pcie> Hardware PCIe object




Generate a report for the Peripheral Component Interconnect Express (PCIe) debug core object, hw_pcie, defined on the current hardware device.

The customizable LogiCORE IP PCIe core for Xilinx ACAPs is designed for evaluating and monitoring the PCIe Link Training and Status State Machine (LTSSM) running on the Gigabit Transceivers (GTs). In the Vivado Hardware Manager, Versal PCIe soft cores implemented in the design, are represented as hw_pcie objects. You can use these PCIe debug cores to solve a range of debug and validation problems; from viewing the PCIe link info to the LTSSM state transition diagram.

This command generates a report with general information about the PCIe core, the LTSSM state visitation status and the trace data for the LTSSM transition graph.


-file <arg> - (Optional) Write the report into the specified file.
Note: If the path is not specified as part of the file name, the file will be written into the current working directory, or the directory from which the tool was launched.
-append - (Optional) Append the output of the command to the specified file rather than overwriting it.
Note: The -append option can only be used with the -file option.
-return_string - (Optional) Directs the output to a Tcl string rather than to the standard output. The Tcl string can be captured by a variable definition and parsed or otherwise processed.
Note: This argument cannot be used with the -file option.
-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_pcie> - (Required) List of HW PCIe objects. If not provided, report is generated for all available PCIe cores.


The following example generates a report for the PCIe core at index 0

report_hw_pcie [lindex [get_hw_pcies] 0]

The following example generates the report for the hw_pcie objects and outputs them to the text file specified

report_hw_pcie -file C:/data/pcie_report.txt [get_hw_pcies]