create_slack_histogram (::quartus::sta)
The following table displays information for the create_slack_histogram Tcl command:
Tcl Package and Version |
Belongs to ::quartus::sta 1.0 |
|||
Syntax | create_slack_histogram [-h | -help] [-long_help] [-all_edges] [-append] -clock_name <name> [-file <name> ] [-hold] [-max_slack <max_slack> ] [-min_slack <min_slack> ] [-multi_corner] [-num_bins <num_bins> ] [-panel_name <name> ] [-partition] [-recovery] [-removal] [-setup] [-stdout] | |||
Arguments | -h | -help | Short help | ||
-long_help | Long help with examples and possible return values | |||
-all_edges | Consider slacks at all edges, not just at the endpoint nodes (results in increased memory consumption) | |||
-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. | |||
-clock_name <name> | Name of the Clock Domain | |||
-file <name> | Sends the results to an ASCII or HTML file. Depending on the extension | |||
-hold | Hold Analysis | |||
-max_slack <max_slack> | Maximum slack value of the created histogram | |||
-min_slack <min_slack> | Minimum slack value of the created histogram | |||
-multi_corner | When set, running this command with the -panel option will create a folder containing versions of this report for multiple operating conditions. This option has no effect when used with the -stdout or -file options. | |||
-num_bins <num_bins> | Number of bins | |||
-panel_name <name> | Sends the results to the panel and specifies the name of the new panel | |||
-partition | Show slack count for each of the partition | |||
-recovery | Recovery Analysis | |||
-removal | Removal Analysis | |||
-setup | Setup Analysis | |||
-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. | |||
Description |
Creates a slack histogram in the timing report for the specified clock domain "-clock_name," showing the number of timing edges within various ranges of slacks for a clock setup analysis. The histogram can be named using the "-panel_name" option. By default, only slack at the endpoint nodes of the timing netlist are considered. To include slack at all edges in the histogram, use the "-all_edges" option. This option will result in increased memory consumption. Use the "-setup", "-hold", "-recovery", or "-removal" options to specify which kind of analysis should be performed. If none is specified, setup analysis is used by default. Reports can be directed to the Tcl console ("-stdout", default), a file ("-file"), the Timing Analyzer graphical interface ("-panel_name"), or any combination of the three. The range of reported slack values can be controlled by specifying the "-min_slack" and "-max_slack" options. The number of bins (histogram bars) can also be specified using the "-num_bins" option. Use the "-partition" to show more information about each partition. A path is in a partition if it's starting point is in the partition. This option only works for "-panel". |
|||
Example Usage |
project_open top create_timing_netlist read_sdc update_timing_netlist # Create a slack histogram for clk1, defaulting to # the name "Slack Histogram (clk1)" create_slack_histogram -clock_name clk1 # Create a slack histogram for clk2 named "MyHistogram" create_slack_histogram -clock_name clk2 -panel_name MyHistogram delete_timing_netlist project_close |
|||
Return Value | Code Name | Code | String Return | |
TCL_OK | 0 | INFO: Operation successful | ||
TCL_ERROR | 1 | ERROR: Clock node not found or specified. Check valid clocks | ||
TCL_ERROR | 1 | ERROR: Value <string> of option <string> is an invalid slack. Specify a valid slack value. | ||
TCL_ERROR | 1 | ERROR: The max_slack value is less than or equal to the min_slack value. Specify a max_slack value that is greater than the min_slack value. | ||
TCL_ERROR | 1 | ERROR: Timing netlist does not exist. Use create_timing_netlist to create a timing netlist. | ||
TCL_ERROR | 1 | ERROR: Number of bins is 0. Specify a number greater than 0. |