commit_hw_hbm - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

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

Commit the property changes of the current hardware object. Inputs can be HBM or device hardware object. At least one object is required.

Syntax

commit_hw_hbm [‑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

Commit the current values of properties defined on the specified high-bandwidth memory (HBM) controller in the AMD Vivado™ hardware manager to the current hardware device.

The commit_hw_hbm command takes the current property values defined on a hw_hbm object and commits them to the current hardware device connected to the hardware server.

When you change the property values on the hw_hbm object, they are not written to the hardware device until you use the commit_hw_hbm command.

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.

<hw_objects> - (Required) Specifies the specific HBM activity monitor objects (hw_hbms) to run.

Examples

The following example changes a property of the specified HBM controller object, and then commits the change to the device:

set_property MC2.INIT.AM_REPEAT_EN 1 [get_hw_hbms *HBM_2]
commit_hw_hbm [get_hw_hbm *HBM_2]