21.6.6 FLASH_FREEZE

Description

"FLASH_FREEZE" is a command tool used in configure_tool. Use the "configure_tool -name {FLASH_FREEZE}" command to specify:
  • The state of the uRAM and LSRAM when the FPGA fabric is in the Flash Freeze state. 
    configure_tool -name {FLASH_FREEZE} \
               -params {name:value} \
               -params {name:value}
  • The MSS clock source when the FPGA fabric is in the Flash Freeze state. 
configure_tool -name {FLASH_FREEZE} -params {parameter:value}

Arguments

ParameterTypeDescription
FF_RAM_STATEstringSpecifies the uRAM and LSRAM state during Flash Freeze. The possible for this argument are:
  • SUSPEND - Sets to Suspend; LSRAM and uSRAM contents are retained. By default is SUSPEND.
  • SLEEP - Sets to Sleep; LSRAM and uSRAM contents are not retained.
FF_MSS_CLOCKstringSpecifies the MSS Clock Source during Flash Freeze. The possible value for this argument are:
  • RCOSC_1MHZ - On-Chip 1 MHz RC Oscillator. By default is RCOSC_1MHZ.
  • RCOSC_50MHZ - On-Chip 50 MHz RC Oscillator.
Return TypeDescription
IntegerReturns 0 on success and 1 on failure.

Error Codes

Error CodeDescription
NoneRequired parameter 'params' is missing.

Supported Families

Supported Families
SmartFusion® 2
IGLOO® 2

Example

The following example sets uRAM and LSRAM state as "SUSPEND" and MSS Clock On-Chip 50 MHz RC Oscillator:

configure_tool -name {FLASH_FREEZE} \
               -params {FF_MSS_CLOCK:RCOSC_50MHZ} \
               -params {FF_RAM_STATE:SLEEP}