report_dfx_summary - 2025.1 English

report_dfx_summary - 2025.1 English - UG835

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID

UG835

Release Date

2025-06-16

Version

2025.1 English

Report DFX Summary

Syntax

report_dfx_summary [‑file <arg>] [‑return_string] [‑append] [‑name <arg>]
    [‑quiet] [‑verbose]

Usage

Name	Description
`[-file]`	Filename to output results to. (send output to console if -file is not used) Values: A filename with alphanumeric characters.
`[-return_string]`	Return report as string
`[-append]`	Append the results to file, don't overwrite the results file
`[-name]`	Output the results to GUI panel with this name
`[-quiet]`	Ignore command errors
`[-verbose]`	Suspend message limits during command execution

Description

This command reports information for a DFX design on Reconfigurable Pblocks, static, RP utilization, PPLOCs, clock utilization, and a detailed RP table. The detailed RP table also includes prohibit site count, shared tiles count, and overlap tiles count.

You can use this command at any stage of the implementation flow for standard DFX, abstract shell, and Both mode in the designs. Each RP is assigned a unique Partition ID which is used consistently across all report tables. For more information, refer to the Vivado Design Suite User Guide: Dynamic Function eXchange (UG909).

By default, the report is generated in the Tcl console or in the std output. However, you can generate the results to a file or return as a string if required.

Note: The command is supported for Versal adaptive SoC devices only.

Arguments

-file <arg> - (Optional) Writes the report into the specified file instead of writing in the Tcl console.

Note: If the path is not specified as part of the file name, the file is generated into the current working directory, or the directory from which the tool was launched.

-return_string - (Optional) Directs the output to a Tcl string rather than to the standard output. The Tcl string is captured by a variable definition and parsed or otherwise processed.

-append - (Optional) Appends the output of the command to the specified file rather than overwriting it

-force - (Optional) Overwrites the specified file if it already exists.

-name <arg> - (Optional) Specifies the name of the results to output to the GUI.

-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.

Examples

The following example reports the DFX related information of the current design and writes the results to the specified file.

report_dfx_summary -file dfx_summary.txt

The following example returns the DFX related information of the current design, writes report to the specified file, and displays the same report in the DFX Summary window in the Vivado Design Suite:

report_dfx_summary -name dfx_summary_1 -file dfx_summary.txt