get_hw_devices - 2022.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID

UG835

Release Date

2022-05-05

Version

2022.1 English

Get a list of hardware devices.

Syntax

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

Returns

Hardware devices

Usage

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

Description

Returns the hardware devices on the open target of a connected hardware server.

Each hardware target can have one or more Xilinx® devices to program, or to use for debugging purposes. The current device is specified or returned by the current_hw_device command.

This command returns a list of available hardware device objects, or returns an error if it fails.

Arguments

-of_objects <arg> - (Optional) Return the hardware devices of the specified hardware targets. The targets must be specified as objects using the get_hw_targets or the current_hw_target commands.

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

-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 http://perldoc.perl.org/perlre.html 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 http://www.tcl.tk/man/tcl8.5/TclCmd/regexp.htm.

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

-filter <args> - (Optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_hw_devices based on property values on the hardware device objects. You can find the properties on an object with the report_property or list_property commands. In the case of the "hw_device" object, "NAME" and "PART" are two of the properties 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 ||). The following gets input pins that do NOT contain the “RESET” substring within their name:

get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}

Boolean (bool) type properties can be directly evaluated in filter expressions as true or not true:

-filter {IS_PRIMITIVE && !IS_LOC_FIXED}

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

<patterns> - (Optional) Match hw_devices against the specified patterns. The default pattern is the wildcard '*' which gets a list of all hw_devices available on the connected hardware server.

Example

The following example gets the list of available hardware device objects on the current hardware target:

get_hw_devices -of_objects [current_hw_target]