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

Parameter Type Description
name string Specifies the name of the new scenario.
description string Specifies the description of the new scenario. This parameter is optional.
mode string Specifies 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 Type Description
None None

Error Codes

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

Supported Families

Supported Families Supported Versions
PolarFire® v12.4+
SmartFusion® 2 v12.4+
RTG4 v12.4+
IGLOO® 2 v12.4+
PolarFire SoC v12.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