Get switching activity on specified objects
Syntax
report_switching_activity [‑static_probability] [‑signal_rate]
[‑toggle_rate] [‑default_static_probability] [‑default_toggle_rate]
[‑average] [‑file <arg>] [‑return_string] [‑append] [‑hier] [‑all]
[‑type <args>] [‑quiet] [‑verbose] [<objects>...]
Usage
Name | Description |
---|---|
[-static_probability]
|
report static probability |
[-signal_rate]
|
report signal rate |
[-toggle_rate]
|
report toggle rate |
[-default_static_probability]
|
report default static probability |
[-default_toggle_rate]
|
report default toggle rate |
[-average]
|
Report the average switching activity for the specified objects. |
[-file]
|
Filename to output results to. (send output to console if -file is not used) |
[-return_string]
|
return switching activity as string |
[-append]
|
append switching activity to end of file |
[-hier]
|
Hierarchically reports the switching activity on nets within a hierarchical instance provided via <objects> option. |
[-all]
|
Report switching activities for all nets for the design. |
[-type]
|
Specify nodes in a specific category. List of valid type values: io_output, io_bidir_enable, register, lut_ram, lut, dsp, bram_enable, bram_wr_enable, gt_txdata, gt_rxdata. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<objects>]
|
objects |
Categories
Description
This command is used to report different kinds of switching activity on design nets, ports, pins, and cells in the current synthesized or implemented design. These include simple signal rate and simple static probability on nets, ports, and pins; and state dependent static probabilities on cells.
The reported values are defined using the set_switching_activity
command.
By default the report is written to the Tcl console or STD output. However, the results can also be written to a file or returned as a string if desired.
Arguments
-static_probability
- (Optional) Specifies that the command returns static probability as part of the report.
-signal_rate
- (Optional) Specifies that the command returns the signal rate as part of the report.
-toggle_rate
- (Optional) Reports the toggle rate (%) as the switching rate of the output of synchronous logic elements compared to a given clock input.
-average
- (Optional) Reports the average switching activity for the specified objects.
-default_static_probability
- (Optional) Reports the default static probability to be used in power analysis on the current design. The default static probability is set using the set_switching_activity
command.
-default_toggle_rate
- (Optional) Reports the default toggle rate to be used in power analysis on the primary inputs of the current design. You can define the default toggle rate using the set_switching_activity
command.
-file
<filename> - (Optional) Writes the report to the specified path and file.
-append
- (Optional) Appends the output of the command to the specified file rather than overwriting it.
-append
option can only be used with the -file
option.
-return_string
- (Optional) Returns the data as a text string for assignment to a Tcl variable.
-hier
- (Optional) Reports the switching activity hierarchically for signals in the specified hierarchical <objects>
. Without -hier
, the switching activity is applied to the specified <objects>
at the current level of the hierarchy.
-all
- (Optional) Must be used with -type
, report the switching activity on nets within all instances specified by -type
.
-type <arg>
- (Optional) Reports the switching activity for the specified type of logic entity. By default, the command is applied to the top-level of the current design, or to the specified <objects>
. The -type
option applies the command settings to the specified type of logic objects in the top-level of the current design. The -all
option or -hier
option can be used to modify the scope of objects the command applies to. Valid logic types include:
- io_output - Primary outputs.
- io_bidir_enable - Enable pin of Bidir ports.
- register - All register outputs in the design/hierarchy specified.
- lut - All LUT outputs in the design/hierarchy specified.
- lut_ram - All distributed ram outputs in the design/hierarchy specified.
- dsp - All DSP outputs in the design/hierarchy specified.
- bram_enable - Enable pins (ENARDEN/ENBWREN) of Block RAMs.
- bram_wr_enable - Write enables of Block RAMs (WEA/WEBWE).
- gt_txdata - Output TX data pins of all GTs.
- gt_rxdata - Output RX data pins of all GTs.
-quiet
- (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.
<objects>
- (Optional) A list of port, pin, and net objects to report the switching activity of; or a list of cells when specified with -type
to define logic objects.
Examples
report_switching_activity -signal_rate -static_probability [all_outputs]
report_switching_activity -signal_rate -static_probability -type lut -all
report_switching_activity -toggle_rate -average [all_outputs]