add_hw_hbm_pc - 2023.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.1 English

Select Pseudo Channel to add to Activity Monitor on the specified hardware HBM(s). Must specify the Memory Controller number first, follow by Pseudo Channel number.


add_hw_hbm_pc [‑quiet] [‑verbose] <mc_num> <pc_num> <hw_objects>


Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<mc_num> Memory Controller number to select: 0 to 7
<pc_num> Pseudo Channel number to select: 0 or 1
<hw_objects> hardware objects




The HBM activity monitor (amon) can be used to gain real-time access to performance monitoring and temperature sensors certain Xilinx® UltraScale+™ devices that 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 the HBM activity monitor from within the Xilinx® Vivado® hardware manager. Each HBM stack is split into eight independent memory channels, each of which is further divided into two 64-bit pseudo channels (pc).

After configuring an HBM enabled device with a design that contains instances of the AXI High Bandwidth Memory Controller, the HBM cores will be visible in the Vivado hardware manager. The add_hw_hbm_pc command lets you specify a memory channel (mc)/pseudo channel (pc) to monitor in the HBM activity monitor prior to using the run_hw_hbm_amon command.

Tip: The HBM activity monitor must not be running when adding or removing pseudo channels.

This command returns nothing if successful, or returns an error if it fails.


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

<mc_num> - (Required) Specifies one of the 8 memory channels of the HBM controller, numbered 0 to 7, to add to the HBM activity monitor.

<pc_num> - (Required) Specifies one of the 2 pseudo channels, numbered 0 or 1.

<hw_objects> - (Required) Specifies the HBM controller (hw_hbms) to monitor.


The following example adds the specified memory channels/pseudo channels on the defined HBM controller (hw_hbm) object, and then runs the HBM activity monitor in the Vivado hardware manager:

set hbm_mon [get_hw_hbms *HBM_2]
add_hw_hbm_pc 0 0 $hbm_mon
add_hw_hbm_pc 0 1 $hbm_mon
add_hw_hbm_pc 1 0 $hbm_mon
add_hw_hbm_pc 1 1 $hbm_mon
add_hw_hbm_pc 2 0 $hbm_mon
add_hw_hbm_pc 2 1 $hbm_mon
add_hw_hbm_pc 3 0 $hbm_mon
add_hw_hbm_pc 3 1 $hbm_mon
run_hw_hbm_amon $hbm_mon