remove_hw_hbm_pc - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

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

De-select Pseudo Channel from Activity Monitor on the specified hardware HBM(s). Must specify the Memory Controller number first, follow by Pseudo Channel number.

Syntax

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

Usage

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

Categories

Hardware

Description

The remove_hw_hbm_pc command removes a memory channel (mc)/pseudo channel (pc) that has been previously added to an HBM activity monitor using the add_hw_hbm_pc 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.

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.

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

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

<hw_objects> - (Required) Specifies the hw_hbms to remove the pseudo channel from.

Examples

The following example removes the previously added pseudo channel from the HBM activity monitor, and then runs the activity monitor:

remove_hw_hbm_pc 2 0 [get_hw_hbms *HBM_2]
run_hw_hbm_amon [get_hw_hbms *HBM_2]