report_dfx_summary - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

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

Report DFX Summary

Syntax

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

Usage

Name Description
[-file] report file Values: A filename with alphanumeric characters.
[-return_string] Return report as string
[-append] Append the results to file, don't overwrite the results file
[-force] Overwrite existing file
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

XDC, Methodology

Description

Report information for DFX design includes details 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 both standard DFX and abstract shell designs. Each RP is assigned a unique Partition ID which is used consistent across all report tables. For more information on this command, 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 returned as a string if desired.

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) Append the output of the command to the specified file rather than overwriting it.

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

-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.
-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.
Note: The Tcl built-in command 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.

Examples

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

report_dfx_summary -file dfx_summary.txt