Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/13/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.46. report_clock_fmax_summary (::quartus::sta)

The following table displays information for the report_clock_fmax_summary Tcl command:

Tcl Package and Version

Belongs to ::quartus::sta

Syntax report_clock_fmax_summary [-h | -help] [-long_help] [-append] [-file <name> ] [-panel_name <name> ] [-split_by_corner] [-stdout]
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.
-file <name> Sends the results to an ASCII or HTML file. Depending on the extension
-panel_name <name> Sends the results to the panel and specifies the name of the new panel
-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.
Description

Reports potential fmax for every clock in the design, regardless of
the user-specified clock periods. Fmax is only computed for paths
where the source and destination registers or ports are driven by the
same clock. Paths of different clocks, including generated clocks, are
ignored. For paths between a clock and its inversion, fmax is computed
as if the rising and falling edges of the clock are scaled along with
fmax, such that the duty cycle (in terms of a percentage) is
maintained.

Restricted fmax considers hold timing in addition to setup timing, as
well as minimum pulse and minimum period restrictions. Similar to
unrestricted fmax, the restricted fmax is computed as if the rising
and falling edges of the clock are scaled along with fmax, such that
the duty cycle (in terms of a percentage) is maintained. The "Note"
column reports which analyses restricted fmax.  Refer to hold timing
reports (e.g., report_timing with the -hold option) or minimum pulse
width reports generated by the report_min_pulse_width command for
details of specific paths, registers, or ports.
Example Usage
project_open my_project

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

# Output results in the form of messages
report_clock_fmax_summary
# Create "Fmax" report panel
report_clock_fmax_summary -panel_name Fmax
# Report both with report panel and messages
report_clock_fmax_summary -panel_name Fmax -stdout

# The following command is optional
delete_timing_netlist

project_close
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Timing netlist does not exist. Use create_timing_netlist to create a timing netlist.

Did you find the information on this page useful?