21.9.29 smartpower_remove_file

Description

This Tcl command removes the VCD file from the specified mode or all operating mode. Frequency and probability information of signals annotated by the VCD are set back to the default value.

remove file -file {the name of the VCD file} \
            -format {the type of the removed file} \
            -opmode {mode name}

Arguments

ParameterTypeDescription
filestringSpecifies the VCD file to be removed. This is mandatory.
formatstringSpecifies that the type to be removed is a VCD file. This is mandatory.
opmodestringSpecifies the operating mode. This is optional. Below shows the acceptable values for this argument:
  • Active(PolarFire®, SmartFusion® 2, IGLOO® 2, RTG4™, PolarFire SoC) - the operating mode is set to Active.
  • Flash*Freeze(SmartFusion 2, IGLOO 2) - the operating mode is set to Flash*Freeze.
  • Custom mode name - the operating mode is custom cerated mode.
Return TypeDescription
NoneNone

Error Codes

Error CodeDescription
NoneParameter 'format' has illegal value.
NoneRequired parameter 'format' is missing.
NoneParameter 'file' has illegal value.
NoneRequired parameter 'file' is missing.
Noneopmode: Invalid argument value: 'mode_name' (expecting Active, Static, Flash*Freeze, Shutdown, Sleep or CustomMode).
NoneParameter 'param_name' is not defined. Valid command formatting is 'smartpower_remove_file -file "file name" -format "vcd" [-opmode "Active | Static"]'.

Supported Families

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

Example

This example removes the file test.vcd from the Active mode:

smartpower_remove_file -file "test.vcd" -format VCD -opmode "Active"

This example removes the VCD file power1.vcd from all operating modes:

smartpower_remove_file -file “power1.vcd” -format VCD

See Also