21.6.15 PROGRAM_SPI_FLASH_IMAGE

Description

"PROGRAM_SPI_FLASH_IMAGE" is a command tool used in configure_tool and run_tool to program SPI Flash Image with configured parameters.

Important: If the Device ID does not match when running any action, the action will fail.
configure_tool -name {PROGRAM_SPI_FLASH_IMAGE} \
               -params {spi_flash_prog_action:procedure}
run_tool -name {PROGRAM_SPI_FLASH_IMAGE}

Arguments

ParameterTypeDescription
spi_flash_prog_actionstringThe acceptable values for this argument are the following:
  • ERASE_SPI_FLASH - This action erases the entire SPI Flash. Mandatory procedures are: VERIFY_DEVICE_ID and ERASE_DIE.
    Note: Partial programming of the SPI flash is supported when using PolarFire / PolarFire SoC FPGAs and the FlashPro6 programmer. In that case, the ERASE_SPI_FLASH action allows you to erase only selected clients.
  • PROGRAM_SPI_IMAGE - This action will erase the entire SPI flash then program the SPI image. Mandatory procedures are: VERIFY_DEVICE_ID, ERASE_DIE and PROGRAM_IMAGE.
  • READ_SPI_IMAGE - This action reads the SPI Image from the SPI Flash. Mandatory procedures are: VERIFY_DEVICE_ID and READ_IMAGE.
  • VERIFY_SPI_IMAGE - This action verifies the SPI Image on the SPI Flash. Mandatory procedures are: VERIFY_DEVICE_ID and VERIFY_IMAGE.
Return TypeDescription
NoneNone

Error Codes

Error CodeDescription
NoneIllegal SPI Flash programming action: action_name.

Supported Families

PolarFire®
PolarFire SoC

Example

The following example configures "PROGRAM_SPI_FLASH_IMAGE" tool and runs:

configure_tool -name {PROGRAM_SPI_FLASH_IMAGE} \
               -params {spi_flash_prog_action: PROGRAM_SPI_FLASH}
run_tool -name {PROGRAM_SPI_FLASH_IMAGE}