21.9.38 smartpower_report_power_sequencer
(Ask a Question)Description
This Tcl command creates a scenario power report for a previously defined scenario. It includes information about the global device and SmartPower preferences selection, and the average power consumption and the excepted battery life for this sequence.
Note:
- Flash*Freeze is available only for certain families and devices(RTG4, SmartFusion 2, and IGLOO 2).
- Worst and Best are available only for certain families and devices.
smartpower_report_power_sequencer \
[-powerunit "W | mW | uW"] \
[-frequnit "Hz | KHz | MHz"] \
[-opcond "Best | Typical | Worst"] \
[-toggle "TRUE | FALSE"] \
[-scenario ""] \
[-style "Text | CSV | XML"] \
[-battery_life "TRUE | FALSE"] \
[-battery_capacity "decimal value"] \
[-rail_breakdown "TRUE | FALSE"] \
[-type_breakdown "TRUE | FALSE"] \
[-mode_breakdown "TRUE | FALSE"] \
[-opcond_summary "TRUE | FALSE"] \
{filename}Arguments
| Parameter | Type | Description |
|---|---|---|
| powerunit | string | Specifies the unit in which power is set. The acceptable values for this argument are the following:
|
| frequnit | string | Specifies the unit in which frequency is set. The acceptable values for this argument are the following:
|
| opcond | string | Specifies the operating condition. The following acceptable values for this argument are the following:
|
| toggle | boolean | Specifies the toggle. The acceptable values for this argument are thr following:
|
| scenario | string | Specifies a scenario that the report is generated from. |
| style | string | Specifies the format in which the report will be exported. The acceptable values for this argument are the following:
|
| battery_life | boolean | Specifies whether to include the battery life summary in the report. The acceptable values for this argument are the following:
|
| battery_capacity | decimal value | Specifies the battery capacity(decimal positive value) in A*H. |
| rail_breakdown | boolean | Specifies whether to include the breakdown by rail summary in the report. The acceptable values for this argument are the following:
|
| type_breakdown | boolean | Specifies whether to include the breakdown by type summary in the report. The acceptable values for this argument are thr following:
|
| mode_breakdown | boolean | Specifies whether to include the breakdown by mode in the report. The acceptable values for this argument are thr following:
|
| opcond_summary | boolean | Specifies whether to include the operating conditions summary in the report. The acceptable values for this argument are the following:
|
| 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 | There are no scenarios in this design, create a scenario in SmartPower, and then generate the scenario report. |
| None | powerunit: Invalid argument value: 'value' (expecting W, mW or uW). |
| None | frequnit: Invalid argument value: 'value' (expecting Hz, KHz or MHz). |
| None | opcond: Invalid argument value: 'value' (expecting Best, Typical or Worst). |
| None | toggle: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false). |
| None | style: Invalid argument value: 'value' (expecting Text, CSV or XML). |
| None | battery_life: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false). |
| None | battery_capacity: Invalid argument value: 'value' (expecting decimal value). |
| None | Parameter 'battery_capacity' must be a positive decimal value. |
| None | rail_breakdown: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false). |
| None | type_breakdown: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false). |
| None | mode_breakdown: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false). |
| None | opcond_summary: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false). |
| None | — |
| None | — |
Supported Families
| PolarFire® |
| SmartFusion® 2 |
| RTG4™ |
| IGLOO® 2 |
| PolarFire SoC |
Example
The following example generates a scenario power report named report.txt for "my_scenario":
smartpower_report_power_sequencer -scenario my_scenario \
-rail_breakdown true \
-type_breakdown true \
-mode_breakdown true \
-style text \
-battery_capacity 10 \
report.txt