21.9.35 smartpower_report_power_activity_map

Description

This Tcl command the activity and hazards report reads a VCD file and reports transitions and hazards for each clock cycle of the VCD file.

smartpower_report_power_activity_map \
              -vcd_file "VCD file" \
              [-style "Text | CSV"] \
              [-partial_parse "TRUE | FALSE"] \
              [-start_time "decimal value"] \
              [-end_time "decimal value"] \
              [-auto_detect_top_level_name "TRUE | FALSE"] \
              [-top_level_name "top level name"] \
              -report_query "Report by Cycle - summary | Report by Net - summary | Report by Cycle - detailed | Report by Net - detailed"\
              [-report_type "activity and power | activity | power"] \
              [-sortby "functional transitions | total power | spurious transitions | functional power | spurious power"] \
              [-sortorder "ascending | descending"] \
              [-max_cycle "integer value"] \
              [-max_net "integer value"] \
              [-clock_settings "":""] \
              [-glitch_filtering "false | auto | true"] \
              [-glitch_threshold "integer value"] \
              [-auto_construct_clock_domain "TRUE | FALSE"] \
              [-clock_period "decimal value"] \
              [-clock_offset "decimal value"] \
              [-opmode "Active | Static"] \
              [-file "file"]

Arguments


Parameter	Type	Description
vcd_file	string	Specifies the path to the *.vcd file that you want to import.
style	string	Specifies the format in which the report will be exported. The acceptable values for this argument are the following: Text - The report will be exported as Text file. CSV(by default) - The report will be exported as CSV file.
partial_parse	boolean	Specifies whether to partially parse the .vcd file. The acceptable values for this argument are the following: TRUE, true or 1 - Partially parses the .vcd file. FALSE, false or 0 - Does not partially parse the *.vcd file.
start_time	decimal	This option is available only if `-partially_parse` is set to true. Specifies the start time (in ns) to partially parse the *.vcd file.
end_time	decimal	This option is available only if `-partially_parse` is set to true. Specifies the start time (in ns) to partially parse the *.vcd file.
auto_detect_top_level_name	boolean	Specifies whether to automatically detect the top-level name. The acceptable values for this argument are the following: TRUE, true or 1 - Automatically detects the top-level name. FALSE, false or 0 - Does not automatically detect the top-level name.
top_level_name	string	Specifies the top-level name.
report_type	string	Specifies the report query type. The acceptable values for this argument are the following: activity - Includes activity information for each net. power - Includes power information for each net. activity and power - Includes activity and power information for each net.
report_query	string	Specifies the report type. The acceptable values for this argument are the following: Report by Net - summary - Provides a summary report for each net. Report by Net - detailed - Provides a detailed report for each net. Report by Cycle - summary - Provides a summary report for each cycle. Report by Cycle - detailed - Provides a detailed report for each cycle.
sortby	string	Specifies how to sort the values in the report. The acceptable values for this argument are the following: total power - Sorts based on the power values. spurious power - Sorts based on the spurious power. functional power - Sorts based on the functional values. spurious transitions - Sorts based on the spurious transitions. functional transitions - Sorts based on the functional transitions.
sortorder	string	Specifies the sort order of the values in the report. This could be descending or ascending.
max_net	integer	Specifies the maximum number of nets to report. In a net summary or net details report, this argument limits the total number of entries. In a cycle details report, this argument limits the number of nets reported for each cycle.
max_cycle	integer	Specifies the maximum number of cycles to report. In a cycle summary or cycle details report, this argument limits the total number of entries. In a net details report, this argument limits the number of cycles reported for each net.
clock_settings	string	Specifies the settings for the clock. The format is ">clock name<:>active edge {value}<". The acceptable values for this argument are the following: rising - Sets the clock to a rising active edge. falling - Sets the clock to a falling active edge. both - Sets the clock to both rising and falling active edge. not_active - Does not use the signal as a clock.
glitch_filtering	string	Specifies whether to use glitch filtering. The acceptable values for this argument are the following: TRUE, true or 1 - Glitch filtering is on. FALSE, false or 0 - Enables automatic glitch filtering. This option will ignore any value specified in -glitch_threshold. auto - Glitch filtering is off.
glitch_threshold	integer	This option is only available when `-glitch_filtering` is set to true. Specifies the glitch filtering value(in ps).
auto_construct_clock_domain	boolean	Specifies whether to automatically construct the clock domain. The acceptable values for this argument are the following: TRUE, true or 1 - Automatically constructs the clock domain. FALSE, false or 0 - Does not automatically construct the clock domain.
clock_period	decimal	Use this option to specify a virtual clock period (in ps). This should be used if `-auto_construct_clock_domain` is set to false.
clock_offset	decimal	Use this option to specify the time of the first active edge of the virtual clock (in ps). This should be used if `-auto_construct_clock_domain` is set to false.
opmode	string	Use this option to specify the mode from which the operating conditions are extracted to generate the report. Active - The operating mode is set to Active. FlashFreeze - The operating mode is set to FlashFreeze.
filename	string	Specifies the name or path of the file to be exported. This argument is mandatory. Default created under designer/<root_name> dircetory.


Return Type	Description
None	None

Error Codes


Error Code	Description
None	Required parameter 'vcd_file' is missing.
None	Required parameter 'report_query' is missing.
None	VCD: Incorrect VCD file. "enddefinitions" not found.
None	VCD: File ./power.vcd doesn't exist: Failed to generate power report.
None	style: Invalid argument value: 'value' (expecting Text or CSV).
None	partial_parse: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false).
None	start_time: Invalid argument value: 'value' (expecting decimal value).
None	end_time: Invalid argument value: 'value' (expecting decimal value).
None	auto_detect_top_level_name: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false).
None	report_type: Invalid argument value: 'value' (expecting activity and power, activity or power).
None	report_query: Invalid argument value: 'value' (expecting Report by Cycle - summary, Report by Net - summary, Report by Cycle - detailed or Report by Net - detailed).
None	sortby: Invalid argument value: 'value' (expecting functional transitions, total power, spurious transitions, functional power or spurious power).
None	sortorder: Invalid argument value: 'value' (expecting ascending or descending).
None	max_net: Invalid argument value: 'value' (expecting integer value).
None	max_cycle: Invalid argument value: 'value' (expecting integer value).
None	glitch_filtering: Invalid argument value: 'value' (expecting false, auto or true).
None	glitch_threshold: Invalid argument value: 'value' (expecting integer value).
None	auto_construct_clock_domain: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false).
None	clock_period: Invalid argument value: 'value' (expecting decimal value).
None	clock_offset: Invalid argument value: 'value' (expecting decimal value).

Supported Families


PolarFire®
SmartFusion® 2
RTG4™
IGLOO® 2
PolarFire SoC

Example

This example generates an activity and hazards power report named "report_power_activity_map.txt":

smartpower_report_power_activity_map \
                 -partial_parse "TRUE" \
                 -start_time "1.0" \
                 -end_time "3.0" \
                 -auto_detect_top_level_name "TRUE" \
                 -top_level_name "mytopmodule" \
                 -glitch_filtering "auto" \
                 -style "Text" \
                 -opmode "Active" \
                 -vcd_file power.vcd \
                 -report_query "Report by Net - summary" \
                 -clock_period "2000.0" \
                 -clock_offset "10.0" \
                 "report_power_activity_map_partial.txt"