report_logic_depth (::quartus::sta)

Tcl Package and Version

Syntax

report_logic_depth [-h | -help] [-long_help] [-append] [-asynch_clock] [-detail <histogram|path> ] [-fall_from <names> ] [-fall_from_clock <names> ] [-fall_through <names> ] [-fall_to <names> ] [-fall_to_clock <names> ] [-file <name> ] [-from <names> ] [-from_clock <names> ] [-hold] [-inter_clock] [-intra_clock] [-less_than_slack <slack limit> ] [-npaths <number> ] [-nworst <number> ] [-pairs_only] [-panel_name <name> ] [-recovery] [-removal] [-rise_from <names> ] [-rise_from_clock <names> ] [-rise_through <names> ] [-rise_to <names> ] [-rise_to_clock <names> ] [-setup] [-stdout] [-through <names> ] [-to <names> ] [-to_clock <names> ] [-topology]

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 is overwritten. This option is not supported for HTML files.

-asynch_clock

Only report paths whose launch and latch clock do not share a common ancestor clock, or were explicitly marked as asynchronous via clock groups

-detail <histogram|path>

Option to determine how much detail should be shown in the report

-fall_from <names>

Valid sources (string patterns are matched using Tcl string matching)

-fall_from_clock <names>

Valid source clocks (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)

-fall_to_clock <names>

Valid destination clocks (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)

-from_clock <names>

Valid source clocks (string patterns are matched using Tcl string matching)

-hold

Option to report clock hold paths

-inter_clock

Only report paths whose launch and latch clock are different

-intra_clock

Only report paths whose launch and latch clock are the same

-less_than_slack <slack limit>

Limit the paths reported to those with slack values less than the specified limit.

-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 value as nworst

-pairs_only

When set, paths with the same start and end points are considered equivalent. Only the worst case path for each unique combination is displayed.

-panel_name <name>

Sends the results to the panel and specifies the name of the new panel

-recovery

Option to report recovery paths

-removal

Option to report removal paths

-rise_from <names>

Valid sources (string patterns are matched using Tcl string matching)

-rise_from_clock <names>

Valid source clocks (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)

-rise_to_clock <names>

Valid destination clocks (string patterns are matched using Tcl string matching)

-setup

Option to report clock setup paths

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

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

-to_clock <names>

Valid destination clocks (string patterns are matched using Tcl string matching)

-topology

Topology Analysis (using arbitrary path analysis)

Description

Reports a summary showing the distribution of logic depth among the critical
paths. Logic depth typically corresponds to the number of look-up tables (LUTs)
that a path passes through. If a path passes through non-LUT elements such
as RAM or DSP blocks, special rules may apply.

Use the "-setup", "-hold", "-recovery", "-removal", or "-topology" options to
specify which kind of analysis should be performed. In topology analysis,
paths are ordered by logic depth as opposed to slack.

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. Use the
"-rise_from" and "-fall_from" options to limit the analysis to
endpoints with established high or low starting states. Use the
"rise_to" and "fall_to" options to limit the analysis to
destination points with high or low ending states.

The analysis can be further limited to clocks using the "-from_clock"
and "-to_clock"	options, or to specific edges of the clock using the
"-rise_from_clock", "-fall_from_clock", "-rise_to_clock", and
"-fall_to_clock" options.

Additionally, the "-through" option can be used to restrict analysis
to paths which go through specified pins or nets. Use the "rise_through"
and "fall_through" options to limit the analysis to intermediate points
with high or low ending states.

Use "-npaths" to limit the number of paths to report.  If you do not
specify this option, 1000 paths with the worst slack are included in
the report. Use the "-less_than_slack" option to limit output to all
paths with slack less than the specified value, up to the number specified
by "-npaths".

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" defaults 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 "-detail" option to specify the desired level of report
detail. Specifiying "histogram" generates a summary showing the
distibution of logic depth among the critical paths. A row is
provided for each clock and a column for each logic depth.
Specifying "path" generates a table of paths as rows with a column
coresponding the paths' logic depths similar to the tables
reported by "report_timing" and "report_path".
The default behavior is to report a histogram.

The values of the "-from", "-to", and "-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.

The following options are not supported for this command:
--ccpp, --summary_view, --show_routing, --show_xtalk, --detail, --false_path

If any of the following filters are provided, then the logic depth distribution
occurs over "n critical paths" rather than "n critical paths per clock"
-from, -to, -through, -from_clock, -to_clock, -rise_from, -fall_from,
-rise_to, -fall_to, -rise_from_clock, -fall_from_clock, -rise_to_clock,
-fall_to_clock, -rise_through, -fall_through

Example Usage

project_open my_project

# Always create the netlist first
create_timing_netlist
read_sdc my_project.sdc
update_timing_netlist

report_logic_depth -npaths 1000 -file "logic_depth.txt"

project_close

Return Value

Code Name

Code

String Return

TCL_OK

0

INFO: Operation successful

TCL_ERROR

1

ERROR: Option <string> has illegal value: <string>. Specify a legal option value.

TCL_ERROR

1

ERROR: Collection type '<string>' is not a valid type for a through collection. Valid collection types are 'pin' and 'net'

TCL_ERROR

1

ERROR: Timing netlist does not exist. Use create_timing_netlist to create a timing netlist.

TCL_ERROR

1

ERROR: Report database is not open

Tcl Package and Version	Belongs to ::quartus::sta 1.0
Syntax	`report_logic_depth [-h \| -help] [-long_help]` `[-append]` `[-asynch_clock]` `[-detail` <histogram\|path> `]` `[-fall_from` <names> `]` `[-fall_from_clock` <names> `]` `[-fall_through` <names> `]` `[-fall_to` <names> `]` `[-fall_to_clock` <names> `]` `[-file` <name> `]` `[-from` <names> `]` `[-from_clock` <names> `]` `[-hold]` `[-inter_clock]` `[-intra_clock]` `[-less_than_slack` <slack limit> `]` `[-npaths` <number> `]` `[-nworst` <number> `]` `[-pairs_only]` `[-panel_name` <name> `]` `[-recovery]` `[-removal]` `[-rise_from` <names> `]` `[-rise_from_clock` <names> `]` `[-rise_through` <names> `]` `[-rise_to` <names> `]` `[-rise_to_clock` <names> `]` `[-setup]` `[-stdout]` `[-through` <names> `]` `[-to` <names> `]` `[-to_clock` <names> `]` `[-topology]`
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 is overwritten. This option is not supported for HTML files.
	`-asynch_clock`		Only report paths whose launch and latch clock do not share a common ancestor clock, or were explicitly marked as asynchronous via clock groups
	`-detail` <histogram\|path>		Option to determine how much detail should be shown in the report
	`-fall_from` <names>		Valid sources (string patterns are matched using Tcl string matching)
	`-fall_from_clock` <names>		Valid source clocks (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)
	`-fall_to_clock` <names>		Valid destination clocks (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)
	`-from_clock` <names>		Valid source clocks (string patterns are matched using Tcl string matching)
	`-hold`		Option to report clock hold paths
	`-inter_clock`		Only report paths whose launch and latch clock are different
	`-intra_clock`		Only report paths whose launch and latch clock are the same
	`-less_than_slack` <slack limit>		Limit the paths reported to those with slack values less than the specified limit.
	`-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 value as nworst
	`-pairs_only`		When set, paths with the same start and end points are considered equivalent. Only the worst case path for each unique combination is displayed.
	`-panel_name` <name>		Sends the results to the panel and specifies the name of the new panel
	`-recovery`		Option to report recovery paths
	`-removal`		Option to report removal paths
	`-rise_from` <names>		Valid sources (string patterns are matched using Tcl string matching)
	`-rise_from_clock` <names>		Valid source clocks (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)
	`-rise_to_clock` <names>		Valid destination clocks (string patterns are matched using Tcl string matching)
	`-setup`		Option to report clock setup paths
	`-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.
	`-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)
	`-to_clock` <names>		Valid destination clocks (string patterns are matched using Tcl string matching)
	`-topology`		Topology Analysis (using arbitrary path analysis)
Description	Reports a summary showing the distribution of logic depth among the critical paths. Logic depth typically corresponds to the number of look-up tables (LUTs) that a path passes through. If a path passes through non-LUT elements such as RAM or DSP blocks, special rules may apply. Use the "-setup", "-hold", "-recovery", "-removal", or "-topology" options to specify which kind of analysis should be performed. In topology analysis, paths are ordered by logic depth as opposed to slack. 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. Use the "-rise_from" and "-fall_from" options to limit the analysis to endpoints with established high or low starting states. Use the "rise_to" and "fall_to" options to limit the analysis to destination points with high or low ending states. The analysis can be further limited to clocks using the "-from_clock" and "-to_clock" options, or to specific edges of the clock using the "-rise_from_clock", "-fall_from_clock", "-rise_to_clock", and "-fall_to_clock" options. Additionally, the "-through" option can be used to restrict analysis to paths which go through specified pins or nets. Use the "rise_through" and "fall_through" options to limit the analysis to intermediate points with high or low ending states. Use "-npaths" to limit the number of paths to report. If you do not specify this option, 1000 paths with the worst slack are included in the report. Use the "-less_than_slack" option to limit output to all paths with slack less than the specified value, up to the number specified by "-npaths". 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" defaults 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 "-detail" option to specify the desired level of report detail. Specifiying "histogram" generates a summary showing the distibution of logic depth among the critical paths. A row is provided for each clock and a column for each logic depth. Specifying "path" generates a table of paths as rows with a column coresponding the paths' logic depths similar to the tables reported by "report_timing" and "report_path". The default behavior is to report a histogram. The values of the "-from", "-to", and "-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. The following options are not supported for this command: --ccpp, --summary_view, --show_routing, --show_xtalk, --detail, --false_path If any of the following filters are provided, then the logic depth distribution occurs over "n critical paths" rather than "n critical paths per clock" -from, -to, -through, -from_clock, -to_clock, -rise_from, -fall_from, -rise_to, -fall_to, -rise_from_clock, -fall_from_clock, -rise_to_clock, -fall_to_clock, -rise_through, -fall_through
Example Usage	project_open my_project # Always create the netlist first create_timing_netlist read_sdc my_project.sdc update_timing_netlist report_logic_depth -npaths 1000 -file "logic_depth.txt" project_close
Return Value	Code Name	Code	String Return
	TCL_OK	0	INFO: Operation successful
	TCL_ERROR	1	ERROR: Option <string> has illegal value: <string>. Specify a legal option value.
	TCL_ERROR	1	ERROR: Collection type '<string>' is not a valid type for a through collection. Valid collection types are 'pin' and 'net'
	TCL_ERROR	1	ERROR: Timing netlist does not exist. Use create_timing_netlist to create a timing netlist.
	TCL_ERROR	1	ERROR: Report database is not open