get_hw_pcies - 2022.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2022.1 English

Get list of soft PCIe core(s).


get_hw_pcies [‑of_objects <args>] [‑regexp] [‑nocase] [‑patterns <arg>]
    [‑filter <arg>] [‑quiet] [‑verbose]


PCIe core(s)


Name Description
[-of_objects] Get 'hw_pcie' objects of these types: 'hw_server hw_target hw_device'.
[-regexp] Patterns are full regular expressions
[-nocase] Perform case-insensitive matching. (valid only when -regexp specified)
[-patterns] Match the 'hw_pcie' objects against patterns. Default: *
[-filter] Filter list with expression
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution


Hardware, Object


Get all the Peripheral Component Interconnect Express (PCIe) debug core objects, hw_pcie's, 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 returns a list of PCIe debug core objects on the device, or returns an error if it fails.


-of_objects - (Optional) Return the PCIe debug cores of the specified hw_server, hw_target or hw_device objects. The objects must be specified by an appropriate get_hw_* command.

Note: The -of_objects option requires objects to be specified using the get_* commands, such as get_cells or get_pins, rather than specifying objects by name. In addition, -of_objects cannot be used with a search.

-filter <args> - (Optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_hw_pcies based on property values on the PCIe debug core objects. You can find the properties on an object with the report_property or list_property commands. In the case of the hw_pcie object, NAME is the only property that can be used to filter results.

The filter search pattern should be quoted to avoid having to escape special characters. String matching is case-sensitive and is always anchored to the start and to the end of the search string. The wildcard “*” character can be used at the beginning or at the end of a search string to widen the search to include a substring of the property value.
Note: The filter returns an object if a specified property exists on the object, and the specified pattern matches the property value on the object. In the case of the "*" wildcard character, this will match a property with a defined value of "".

For string comparison, the specific operators that can be used in filter expressions are "equal" (==), "not-equal" (!=), "match" (=~), and "not-match" (!~). Numeric comparison operators <, >, <=, and >= can also be used. Multiple filter expressions can be joined by AND and OR (&& and ||).

<patterns> - (Optional) Match hw_pcies against the specified patterns. The default pattern is the wildcard * which gets a list of all hw_pcies available on the current hardware device.

-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.
-regexp - (Optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter expressions must be written as regular expressions when this argument is used. Xilinx® regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See for help with regular expression syntax.
Note: The Tcl built-in command regexp is not anchored, and works as a standard Tcl command. For more information refer to

-nocase - (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp only.


The following example returns all the available PCIe cores


The following example returns PCIe core with the specified DISPLAY_NAME

get_hw_pcies -filter {NAME == "PCIe_0"}