21.9.2 smartpower_add_new_scenario

Description

This Tcl command creates a new custom scenario entering the scenario name, duration (total duration for the sequence must equal to 100%), and selecting previously defined operating modes for this sequence.

smartpower_add_new_scenario -name {New Scenario name} \
                            [-description {description of scenario}] \
                            -mode {Mode_name:duration}

Arguments

ParameterTypeDescription
namestringSpecifies the name of the new scenario.
descriptionstringSpecifies the description of the new scenario. This parameter is optional.
modestringSpecifies the previously defined mode(s) and duration(s) for the specified scenario. This parameter is mandatory. There may be multiple -mode arguments (see example below).
Return TypeDescription
NoneNone

Error Codes

Error CodeDescription
NoneRequired parameter 'name' is missing.
NoneRequired parameter 'mode' is missing.
Nonemode: Invalid argument value: 'mode_name' (expecting Active, Static or Flash*Freeze).
NoneThe sum of the duration must be 100%. Current sum: duration_value.
NoneParameter 'param_name' is not defined. Valid command formatting is 'smartpower_add_new_scenario -name "scenario name" [-description "description"] [-mode "":""]+'

Supported Families

Supported FamiliesSupported Versions
PolarFire®v12.4+
SmartFusion® 2v12.4+
RTG4v12.4+
IGLOO® 2v12.4+
PolarFire SoCv12.6+

Example

This example creates a new scenario called "MyScenario" with the specified modes and durations:

smartpower_add_new_scenario -name "MyScenario" -mode "Custom_1:50.00" \ 
             		    -mode "Custom_2:25.00" -mode "Active:25.00"

See Also