report_power - 2022.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2022.1 English

Run power estimation and display report


report_power [‑no_propagation] [‑hier <arg>] [‑hierarchical_depth <arg>]
    [‑vid] [‑advisory] [‑file <arg>] [‑name <arg>] [‑format <arg>]
    [‑xpe <arg>] [‑l <arg>] [‑return_string] [‑append] [‑rpx <arg>]
    [‑quiet] [‑verbose]


Name Description
[-no_propagation] Disables the propagation engine to estimate the switching activity of nets.
[-hier] Hierarchy report style (logic, power, or all) Default: power
[-hierarchical_depth] Specifies the depth level for textual hierarchical report Default: 4
[-vid] Voltage ID (VID) of device is used
[-advisory] Dump power advisory text report
[-file] Filename to output results to. (send output to console if -file is not used)
[-name] Output the results to GUI panel with this name
[-format] Format for the power estimation report: text, xml Default: text
[-xpe] Output the results to XML file for importing into XPE
[-l] Maximum number of lines to report in detailed reports (l >= 0) Default: 10
[-return_string] return report as string
[-append] append power report to end of file
[-rpx] Filename to output interactive results to.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution


Report, Power


Run power analysis on the current design, and report details of power consumption based on the current operating conditions of the device, and the switching rates of the design. The operating conditions can be set using the set_operating_conditions command. The switching activity can be defined using the set_switching_activity command.

Switching activity can also be read in from an SAIF file with the read_saif command. The Vivado® tool will annotate the design nodes with activity from the SAIF file and estimate power appropriately.

Power analysis requires an open synthesized design, or implemented design.

Note: By default the report is written to the Tcl console or STD output. However, the results can also be written to a file or returned as a string if desired.


-no_propagation - (Optional) For all undefined nodes power analysis uses a vector-less propagation engine to estimate activity. This argument disables the propagation engine for a faster analysis of the design.

-hier [ power | logic | all ] - (Optional) Displays the summary power consumption for each level of design hierarchy (power), or the power broken-down for different logic elements of the hierarchy (logic), or both the power summary and the different logic elements of the design hierarchy (all). The default is power.

-hierarchical_depth <arg> - (Optional) Specifies the depth of the hierarchy to report in the "By hierarchy" section of the power report. The default depth is 4, which means that it will report the top-level and three hierarchical levels of child instances by default. A depth of 0 will report all levels of hierarchy. This option is only for textual power report and does not impact GUI or rpx reports.

-vid - (Optional) Use the Voltage ID bit of the target device. Voltage identification is a form of adaptive voltage scaling (AVS) that enables certain devices in the Virtex®-7 family to be operated at a reduced voltage of 0.9V while delivering the same specified performance of a device operating at the nominal supply voltage of 1.0V. Voltage identification capable devices consume approximately 30% lower worst case (maximum) static power and correspondingly dissipate less heat.

-advisory - (Optional) Adds the Advisory table to the Power Report checking the design for abnormal switching activity on control signals. This is the same table produced by the Power Constraints Advisor feature in the Vivado IDE.

-file <arg> - (Optional) Write the report into the specified file. The specified file will be overwritten if one already exists, unless -append is also specified.
Note: If the path is not specified as part of the file name, the file will be written into the current working directory, or the directory from which the tool was launched.
-append - (Optional) Append the output of the command to the specified file rather than overwriting it.
Note: The -append option can only be used with the -file option.

-name <arg> - (Optional) Specifies the name of the results set to report the results to.

-format [ text | xml ] - (Optional) The default format of the output report is text. You can also output an XML report. XML output is only valid when -file is specified, and cannot be used with -append.

-xpe <arg> - (Optional) Output the results to an XML file for importing into the Xilinx® Power Estimator spreadsheet tool. Refer to Xilinx Power Estimator User Guide (UG440) for more information.

-l <arg> - (Optional) Maximum number of lines to report in the Detailed Reports section. Valid values are greater than or equal to 0.
Note: This options also triggers additional levels of detail in the Detailed Report section that are not reported when -l is not specified.
-return_string - (Optional) Directs the output to a Tcl string rather than to the standard output. The Tcl string can be captured by a variable definition and parsed or otherwise processed.
Note: This argument cannot be used with the -file option.
-rpx <arg> - (Optional) Specify the file name and path of an Xilinx report file (RPX) to write. This is different from writing the report results to a file using the -file argument. The RPX file is an interactive report that contains all the report information and can be reloaded into memory in the Vivado Design Suite using the open_report command. You should add a .rpx file extension to the specified file name, as the Vivado tool will not automatically assign a file extension.
Note: If the path is not specified as part of the file name, the file will be written into the current working directory, or the directory from which the tool was launched.
-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.


The following example performs power analysis, without net propagation, and writes the results to an XML file for use in XPE:

report_power -no_propagation -xpe C:/Data/design1.xpe