refresh_hw_hbm - 2022.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2022.1 English

Refresh the status of the current hardware object. Inputs can be HBM or device hardware object. At least one object is required. If properties are specified that do not exist in the object, that property will not be refreshed.


refresh_hw_hbm [‑regexp] [‑properties <args>] [‑quiet] [‑verbose]


Name Description
[-regexp] Properties list contains full regular expressions
[-properties] List of properties to refresh Default: All properties in object
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<hw_objects> hardware objects




Refreshes the in-memory view of all of the properties, or specified properties, of the specified HBM controller objects with values read from the current hardware device.

The refresh command takes the values from the HBM controller implemented on the hardware device, and populates them into the appropriate properties of the hw_hbm object in the Vivado® hardware manager. If only certain properties are specified, then those properties are updated from the hw device.

At least one object is required. If properties are specified that do not exist in the object, that property will not be refreshed.

This command updates the properties on the hw_hbm object, but otherwise returns nothing if successful. The command returns an error if it fails.


-regexp - (Optional) The list of properties to refresh is defined using regular expression.

-properties <args> - (Optional) Refresh the specified property or properties of the hw_hbm object. As a default behavior, if no properties are specified, all properties of the specified object or objects will be refreshed from the current values on the hardware device.
Tip: If a non-existent property is specified, that property is ignored.
-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_objects> - (Required) Specifies the specific HBM activity monitor objects (hw_hbms) to run.


The following example refreshes all of the properties of the HBM controller in the Vivado hardware manager with the properties from the current hw_device:
refresh_hw_hbm [lindex [get_hw_hbms] 1]
The following example refreshes the specified property of the HBM controller from the current hw_device:
refresh_hw_hbm -properties {MC2.INIT.AM_REPEAT_EN} [get_hw_hbms *HBM_2]