Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 10/04/2021
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

3.1.29.64. report_path (::quartus::sta)

The following table displays information for the report_path Tcl command:

Tcl Package and Version

Belongs to ::quartus::sta

Syntax report_path [-h | -help] [-long_help] [-append] [-fall_from <names> ] [-fall_through <names> ] [-fall_to <names> ] [-file <name> ] [-from <names> ] [-list_clocks] [-logic_depth] [-min_path] [-npaths <number> ] [-nworst <number> ] [-pairs_only] [-panel_name <name> ] [-rise_from <names> ] [-rise_through <names> ] [-rise_to <names> ] [-show_routing] [-split_by_corner] [-stdout] [-summary] [-through <names> ] [-to <names> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-append If output is sent to a file, this option appends the result to that file. Otherwise, the file will be overwritten. This option is not supported for HTML files.
-fall_from <names> Valid sources (string patterns are matched using Tcl string matching)
-fall_through <names> Valid through nodes (string patterns are matched using Tcl string matching)
-fall_to <names> Valid destinations (string patterns are matched using Tcl string matching)
-file <name> Sends the results to an ASCII or HTML file. Depending on the extension
-from <names> Valid sources (string patterns are matched using Tcl string matching)
-list_clocks Includes the driving clocks associated with the from and to nodes of each path in the Path Summary table
-logic_depth Option to display the logic depth instead of path delay
-min_path Find the minimum delay path(s)
-npaths <number> Specifies the number of paths to report (default=1, or the same value as nworst, if nworst is specified. Value of 0 causes all paths to be reported but be wary that this may be slow)
-nworst <number> Specifies the maximum number of paths to report for each endpoint. If unspecified, there is no limit. If nworst is specified, but npaths is not, npaths defaults to the same as nworst
-pairs_only When set, paths with the same start and end points will be considered to be equivalent. Only the longest delay path for each unique combination will be displayed.
-panel_name <name> Sends the results to the panel and specifies the name of the new panel
-rise_from <names> Valid sources (string patterns are matched using Tcl string matching)
-rise_through <names> Valid through nodes (string patterns are matched using Tcl string matching)
-rise_to <names> Valid destinations (string patterns are matched using Tcl string matching)
-show_routing Option to display detailed routing in the path
-split_by_corner When set, running this command with the -panel option will create a folder containing versions of this report for selected multiple operating conditions. This option has no effect when used with the -stdout or -file options.
-stdout Send output to stdout, via messages. You only need to use this option if you have selected another output format, such as a file, and would also like to receive messages.
-summary Create a single table with a summary of each path found
-through <names> Valid through nodes (string patterns are matched using Tcl string matching)
-to <names> Valid destinations (string patterns are matched using Tcl string matching)
Description

Reports the longest delay paths and the corresponding delay value. The report can be directed to the Tcl console ("-stdout", default), a file ("-file"), the Timing Analyzer graphical user interface ("-panel_name"), or any combination of the three. You can limit the analysis performed by this command to specific start and end points, using the "-from" and "-to" options. Any node or cell in the design is considered a valid endpoint. Additionally, the "-through" option can be used to restrict analysis to paths which go through specified pins or nets. Paths that are reported can not start before or go beyond a keeper node (register or port); this restriction considers register pins as combinational nodes in the design. Use "-npaths" to limit the number of paths to report. If this option is not specified, only the single longest delay path is provided. Use "-nworst" to limit the number of paths reported for each unique endpoint. If you do not specify this option, the number of paths reported for each destination node is bounded only by the "-npaths" option. If this option is used, but "-npaths" is not specified, then "-npaths" will default to the same value specified for "-nworst". Use the "-pairs_only" option to filter the output further, restricting the results to only unique combinations of start and end points. Use the "-summary" option to generate a single table listing only the highlights of each path. The "-min_path" option will find the minimum delay path(s) rather than the maximum delay paths which is the default behavior. The "-show_routing" option will display detailed routing information in the path. Lines that were marked as "IC" without the option will still be shown, but only as a placeholder. The routing elements for that line will be broken out individually and listed before the line. The return value of this command is a two-element list. The first number is the number of paths found in the analysis. The second is the longest delay, in terms of the current default time unit. The values of the "-from", "-to", "-through" options are either collections or a Tcl list of wildcards used to create collections of appropriate types. The values used must follow standard Tcl or Timing Analyzer-extension substitution rules. See the help for use_timing_analyzer_style_escaping for details.

Example Usage