Description
This Tcl command edits a custom mode. You should specify at least one of the following optional parameters: new name and description.
smartpower_edit_custom_mode -name {old mode name} \
[-new_name {new mode name}] \
[-description {mode description}]
Arguments
| Parameter | Type | Description |
|---|
| name | string | Specifies the name of the custom mode you want to edit. This parameter is mandatory. |
| new_name | string | Specifies the new name of the custom mode. This parameter is optional. |
| description | string | Specifies the description of the new custom mode. This parameter is mandatory. |
| Return Type | Description |
|---|
| None | None |
Error Codes
| Error Code | Description |
|---|
| None | Required parameter 'name' is missing. |
| None | Parameter 'name' has illegal value. |
| None | Parameter 'new_name' has illegal value. |
| None | Parameter 'description' has illegal value. |
| None | Parameter 'param_name' is not defined. Valid command formatting is 'smartpower_edit_custom_mode -name "name" [-description "description"] [-new_name "new mode name"]'. |
| None | A custom mode with name "mode_name" does not exist. |
Supported Families
| PolarFire® |
| SmartFusion® 2 |
| RTG4™ |
| IGLOO® 2 |
| PolarFire SoC |
Example
This example edits custom mode "CustomMode" and renames it "CustomMode2":
smartpower_edit_custom_mode -name {CustomMode} \
-new_name {CustomMode2} \
-description {frequency 10 MHz}
