get_hw_hbms - 2023.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.1 English

Get list of hardware HBM cores.


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


Hardware HBM cores.


Name Description
[-of_objects] Get 'hw_hbm' 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)
[-filter] Filter list with expression
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match the 'hw_hbm' objects against patterns. Default: *


Hardware, Object


Certain Xilinx® UltraScale+™ devices include an integrated High-Bandwidth Memory (HBM) controller. Refer to the AXI High Bandwidth Controller LogiCORE IP Product Guide (PG276) for more information on this core. The HBM controller and memory stacks contain both performance counters and temperature sensors that can be accessed through an HBM activity monitor (amon) from within the Xilinx Vivado hardware manager. The HBM activity monitor can be used to gain real-time access to performance monitoring and temperature sensors on the physical device. The Vivado hardware manager displays read, write, and overall throughput of data, as well as the device temperature. The activity monitor displays, captures, and exports data to a CSV file when it is running.

The get_hw_hbms command returns a list of HBM cores on the current hardware target.


-of_objects <arg> - (Optional) Return the High Bandwidth Memory controller (hbm) objects of the specified hw_server, hw_target, or hw_device objects.
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 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.

-filter <args> - (Optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_hw_hbms based on property values on the objects. You can find the properties on an object with the report_property or list_property commands. In the case of the hw_hbm object, "DISPLAY_NAME" and "HBM_STACK_NUM", are a couple 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:
-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_hbm objects against the specified patterns. The default pattern is the wildcard '*' which gets a list of all hw_hbms available on the current hardware device.


The following example returns the HBM with the specified DISPLAY_NAME:

get_hw_hbms -filter {DISPLAY_NAME == HBM_2}

This example returns all the HBM objects in the current device: