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
Parameter |
Type |
Description |
spi_flash_prog_action |
string |
The 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.
- 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 Type |
Description |
None |
None |
Error Codes
Error Code |
Description |
None |
Illegal SPI Flash programming action: action_name. |
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}