Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 10/04/2021

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

Document Table of Contents report_clocks (::quartus::sta)

The following table displays information for the report_clocks Tcl command:

Tcl Package and Version

Belongs to ::quartus::sta

Syntax report_clocks [-h | -help] [-long_help] [-append] [-desc] [-file <name> ] [-hierarchy] [-panel_name <name> ] [-stdout] [-summary] [-tree] [-waveform]
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.
-desc Sort the clocks by name in descending order (ascending order is default)
-file <name> Sends the results to an ASCII or HTML file. Depending on the extension
-hierarchy Display a tree view of the clocks
-panel_name <name> Sends the results to the panel and specifies the name of the new panel
-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 clock
-tree alias for hierarchy
-waveform Display the clocks graphically as waveforms

Report 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. For stdout/file output, the clock details are reported in two sections. The first section shows all clocks, their period, and their waveform. This includes generated clocks after an update_timing_netlist. The second section shows details for all generated clocks. For the panel report, both sections are combined into a single report.

Example Usage
project_open top


Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful