HW_DEVICE - 2024.1 English

Vivado Design Suite Properties Reference Guide (UG912)

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

Description

Within the Hardware Manager feature of the Vivado Design Suite, each hardware target can have one or more AMD FPGA devices to program, or to use for debugging purposes. The hw_device object is the physical part on the hw_target opened through the hw_server. The current device is specified or returned by the current_hw_device command.

Related Objects

Figure 1. Hardware Device Objects

Hardware devices are associated with hardware targets, and can be queried as objects of the hw_target object:

get_hw_devices -of [get_hw_targets]

You can also query the debug cores programmed onto a hardware device object:

get_hw_ilas -of [current_hw_device]

Properties

The properties on the hw_device object might vary depending on the target part you have selected. You can use the report_property command to report the properties assigned to a hw_device object. Refer to the Vivado Design Suite Tcl Command Reference Guide (UG835) for more information.

The properties assigned to the hw_device object include the following, with property type:

Property	Type
CLASS	string
DID	string
IDCODE	string
INDEX	int
IR_LENGTH	int
IS_SYSMON_SUPPORTED	bool
MASK	int
NAME	string
PART	string
PROBES.FILE	string
PROGRAM.FILE	string
PROGRAM.HW_BITSTREAM	hw_bitstream
PROGRAM.HW_CFGMEM	hw_cfgmem
PROGRAM.HW_CFGMEM_BITFILE	string
PROGRAM.HW_CFGMEM_TYPE	string
PROGRAM.IS_SUPPORTED	bool
PROGRAM.OPTIONS	string
REGISTER.BOOT_STATUS	string
REGISTER.BOOT_STATUS.BIT00_0_STATUS_VALID	string
REGISTER.BOOT_STATUS.BIT01_0_FALLBACK	string
REGISTER.BOOT_STATUS.BIT02_0_INTERNAL_PROG	string
REGISTER.BOOT_STATUS.BIT03_0_WATCHDOG_TIMEOUT_ERROR	string
REGISTER.BOOT_STATUS.BIT04_0_ID_ERROR	string
REGISTER.BOOT_STATUS.BIT05_0_CRC_ERROR	string
REGISTER.BOOT_STATUS.BIT06_0_WRAP_ERROR	string
REGISTER.BOOT_STATUS.BIT07_RESERVED	string
REGISTER.BOOT_STATUS.BIT08_1_STATUS_VALID	string
REGISTER.BOOT_STATUS.BIT09_1_FALLBACK	string
REGISTER.BOOT_STATUS.BIT10_1_INTERNAL_PROG	string
REGISTER.BOOT_STATUS.BIT11_1_WATCHDOG_TIMEOUT_ERROR	string
REGISTER.BOOT_STATUS.BIT12_1_ID_ERROR	string
REGISTER.BOOT_STATUS.BIT13_1_CRC_ERROR	string
REGISTER.BOOT_STATUS.BIT14_1_WRAP_ERROR	string
REGISTER.BOOT_STATUS.BIT15_RESERVED	string
REGISTER.CONFIG_STATUS	string
REGISTER.CONFIG_STATUS.BIT00_CRC_ERROR	string
REGISTER.CONFIG_STATUS.BIT01_DECRYPTOR_ENABLE	string
REGISTER.CONFIG_STATUS.BIT02_PLL_LOCK_STATUS	string
REGISTER.CONFIG_STATUS.BIT03_DCI_MATCH_STATUS	string 
REGISTER.CONFIG_STATUS.BIT04_END_OF_STARTUP_(EOS)_STATUS string 
REGISTER.CONFIG_STATUS.BIT05_GTS_CFG_B_STATUS	string
REGISTER.CONFIG_STATUS.BIT06_GWE_STATUS	string
REGISTER.CONFIG_STATUS.BIT07_GHIGH_STATUS	string
REGISTER.CONFIG_STATUS.BIT08_MODE_PIN_M[0]	string
REGISTER.CONFIG_STATUS.BIT09_MODE_PIN_M[1]	string
REGISTER.CONFIG_STATUS.BIT10_MODE_PIN_M[2]	string 
REGISTER.CONFIG_STATUS.BIT11_INIT_B_INTERNAL_SIGNAL_STATUS string 
REGISTER.CONFIG_STATUS.BIT12_INIT_B_PIN	string 
REGISTER.CONFIG_STATUS.BIT13_DONE_INTERNAL_SIGNAL_STATUS string 
REGISTER.CONFIG_STATUS.BIT14_DONE_PIN	string
REGISTER.CONFIG_STATUS.BIT15_IDCODE_ERROR	string
REGISTER.CONFIG_STATUS.BIT16_SECURITY_ERROR	string
REGISTER.CONFIG_STATUS.BIT17_SYSTEM_MONITOR_OVER-TEMP_ALARM_STATUS string 
REGISTER.CONFIG_STATUS.BIT18_CFG_STARTUP_STATE_MACHINE_PHASE string 
REGISTER.CONFIG_STATUS.BIT21_RESERVED	string 
REGISTER.CONFIG_STATUS.BIT25_CFG_BUS_WIDTH_DETECTION	string 
REGISTER.CONFIG_STATUS.BIT27_HMAC_ERROR	string
REGISTER.CONFIG_STATUS.BIT28_PUDC_B_PIN	string
REGISTER.CONFIG_STATUS.BIT29_BAD_PACKET_ERROR	string
REGISTER.CONFIG_STATUS.BIT30_CFGBVS_PIN	string
REGISTER.CONFIG_STATUS.BIT31_RESERVED	string
REGISTER.IR	string
REGISTER.IR.BIT0_ALWAYS_ONE	string
REGISTER.IR.BIT1_ALWAYS_ZERO	string
REGISTER.IR.BIT2_ISC_DONE	string
REGISTER.IR.BIT3_ISC_ENABLED	string
REGISTER.IR.BIT4_INIT_COMPLETE	string
REGISTER.IR.BIT5_DONE	string
REGISTER.USERCODE	string
SET_UNKNOWN_DEVICE	bool
USER_CHAIN_COUNT	string

To report the properties for a hw_device, you can copy and paste the following command into the Vivado Design Suite Tcl shell or Tcl Console:

report_property -all [lindex [get_hw_devices] 0]