Get list of hardware SysMons.
Syntax
get_hw_sysmons [‑of_objects <args>] [‑regexp] [‑nocase] [‑filter <arg>]
[‑quiet] [‑verbose] [<patterns>]
Returns
Hardware sysmons
Usage
Name | Description |
---|---|
[-of_objects]
|
Get 'hw_sysmon' objects of these types: 'hw_server hw_target hw_device'. |
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching. (valid only when -regexp specified) |
[-filter]
|
Filter list with expression |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match the 'hw_sysmon' objects against patterns. Default: * |
Description
Returns the Sysmon debug core objects defined on the current hardware device.
The System Monitor (SYSMON) Analog-to-Digital Converter (ADC) is used to measure die temperature and voltage on the hw_device. The Sysmon monitors the physical environment via on-chip temperature and supply sensors. The ADC provides a high-precision analog interface for a range of applications. The ADC can access up to 17 external analog input channels. Refer to UltraScale Architecture System Monitor User Guide (UG580), or 7 Series FPGAs and Zynq-7000 SoC XADC Dual 12-Bit 1 MSPS Analog-to-Digital Converter User Guide (UG480) for more information on a specific device architecture.
The hw_sysmon data is stored in dedicated registers called status registers accessible through the hw_sysmon_reg object. The values of the system monitor registers can be returned by the get_hw_sysmon_reg
command.
Every device that supports the system monitor will automatically have one or more hw_sysmon objects created when refresh_hw_device
is called. When the hw_sysmon object is created, it is assigned a property for all the temperature and voltage registers, as well as the control registers. On the hw_sysmon object, the values assigned to the temperature and voltage registers are already translated to Celsius/Fahrenheit and Voltage.
get_hw_sysmon_reg
command to access the hex values stored in registers of a system monitor, you can also retrieve values of certain registers as formatted properties of the hw_sysmon object. For example, the following code retrieves the TEMPERATURE property of the specified hw_sysmon object rather than directly accessing the hex value of the register:
set opTemp [get_property TEMPERATURE [get_hw_sysmons]
This command returns a list of hw_sysmon objects on the current or specified hw_device, or returns an error if it fails.
Arguments
-of_objects <arg>
- (Optional) Return the hw_sysmon objects of the specified hw_server, hw_target, or hw_device. The objects must be specified using the appropriate get_hw_*
command .
-of_objects
option requires objects to be specified using the get_*
commands, such as get_cells
or get_pins
, rather than specifying objects by name. In addition, -of_objects
cannot be used with a search <pattern>
.
-regexp
- (Optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter
expressions must be written as regular expressions when this argument is used. Xilinx regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See http://perldoc.perl.org/perlre.html for help with regular expression syntax.
regexp
is not anchored, and works as a standard Tcl command. For more information refer to http://www.tcl.tk/man/tcl8.5/TclCmd/regexp.htm.
-nocase
- (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp
only.
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_hw_sysmons
based on property values on the Sysmon cores. You can find the properties on an object with the report_property
or list_property
commands. In the case of the "hw_sysmon" object, "NAME", "VCCINT", and "VCCAUX" are some of the properties that can be used to filter results.
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
bool
) type properties can be directly evaluated in filter expressions as true or not true: -filter {IS_PRIMITIVE && !IS_LOC_FIXED}
-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.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.<patterns> - (Optional) Match hw_sysmons against the specified patterns. The default pattern is the wildcard '*' which gets a list of all hw_sysmons available on the current hardware device.
Example
get_hw_sysmons -of_objects [current_hw_device]