run_hw_hbm_amon - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Enable Activity Monitor runs for the specified hardware HBM(s)

Syntax

run_hw_hbm_amon [‑quiet] [‑verbose] <hw_objects>

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<hw_objects> hardware objects

Categories

Hardware

Description

The HBM activity monitor (amon) can be used to gain real-time access to performance monitoring and temperature sensors certain AMD UltraScale+™ devices that include an integrated High-Bandwidth Memory (HBM) controller. Refer to the AXI High Bandwidth Memory 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. The HBM activity monitor 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 run_hw_hbm_amon command runs an HBM activity monitor in the Vivado hardware manager that has been previously configured using the add_hw_hbm_pc command.

This command returns the file path and name of a CSV file the collected data will be written to, or returns an error if it fails.

Arguments

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

Examples

The following example runs the HBM activity monitor for the associated HBM core:

run_hw_hbm_amon [get_hw_hbms *HBM_2]