Kinetis SDK v.2.0 API Reference Manual
Rev. 0
Freescale Semiconductor, Inc.
|
The flash provides the C90TFS Flash driver of Kinetis devices with the C90TFS Flash module inside. The flash provides general APIs to handle specific operations on C90TFS/FTFx Flash module. The user can use those APIs directly in the application. In addition, it provides internal functions called by the driver. Although these functions are not meant to be called from the user's application directly, the APIs can still be used.
Data Structures | |
struct | flash_execute_in_ram_function_config_t |
Flash execute-in-ram function information. More... | |
struct | flash_swap_state_config_t |
Flash Swap information. More... | |
struct | flash_swap_ifr_field_config_t |
Flash Swap IFR fileds. More... | |
struct | flash_operation_config_t |
Active flash information for current operation. More... | |
struct | flash_config_t |
Flash driver state information. More... | |
Typedefs | |
typedef void(* | flash_callback_t )(void) |
callback type used for pflash block | |
Flash version | |
enum | _flash_driver_version_constants { kFLASH_driverVersionName = 'F', kFLASH_driverVersionMajor = 2, kFLASH_driverVersionMinor = 1, kFLASH_driverVersionBugfix = 0 } |
FLASH driver version for ROM. More... | |
#define | MAKE_VERSION(major, minor, bugfix) (((major) << 16) | ((minor) << 8) | (bugfix)) |
Construct the version number for drivers. More... | |
#define | FSL_FLASH_DRIVER_VERSION (MAKE_VERSION(2, 1, 0)) |
FLASH driver version for SDK. More... | |
Flash configuration | |
#define | FLASH_SSD_CONFIG_ENABLE_FLEXNVM_SUPPORT 1 |
Whether to support FlexNVM in flash driver. More... | |
#define | FLASH_SSD_IS_FLEXNVM_ENABLED (FLASH_SSD_CONFIG_ENABLE_FLEXNVM_SUPPORT && FSL_FEATURE_FLASH_HAS_FLEX_NVM) |
Whether the FlexNVM is enabled in flash driver. | |
#define | FLASH_DRIVER_IS_FLASH_RESIDENT 1 |
Flash driver location. More... | |
#define | FLASH_DRIVER_IS_EXPORTED 0 |
Flash Driver Export option. More... | |
Flash API key | |
enum | _flash_driver_api_keys { kFLASH_apiEraseKey = FOUR_CHAR_CODE('k', 'f', 'e', 'k') } |
Enumeration for flash driver API keys. More... | |
#define | FOUR_CHAR_CODE(a, b, c, d) (((d) << 24) | ((c) << 16) | ((b) << 8) | ((a))) |
Construct the four char code for flash driver API key. More... | |
Initialization | |
status_t | FLASH_Init (flash_config_t *config) |
Initializes global flash properties structure members. More... | |
status_t | FLASH_SetCallback (flash_config_t *config, flash_callback_t callback) |
Set the desired flash callback function. More... | |
status_t | FLASH_PrepareExecuteInRamFunctions (flash_config_t *config) |
Prepare flash execute-in-ram functions. More... | |
Erasing | |
status_t | FLASH_EraseAll (flash_config_t *config, uint32_t key) |
Erases entire flash. More... | |
status_t | FLASH_Erase (flash_config_t *config, uint32_t start, uint32_t lengthInBytes, uint32_t key) |
Erases flash sectors encompassed by parameters passed into function. More... | |
status_t | FLASH_EraseAllExecuteOnlySegments (flash_config_t *config, uint32_t key) |
Erases entire flash, including protected sectors. More... | |
Programming | |
status_t | FLASH_Program (flash_config_t *config, uint32_t start, uint32_t *src, uint32_t lengthInBytes) |
Programs flash with data at locations passed in through parameters. More... | |
status_t | FLASH_ProgramOnce (flash_config_t *config, uint32_t index, uint32_t *src, uint32_t lengthInBytes) |
Programs Program Once Field through parameters. More... | |
Reading | |||||||||||||||||||||||||||||||||||||||||||||||||
Programs flash with data at locations passed in through parameters via Program Section command This function programs the flash memory with desired data for a given flash area as determined by the start address and length.
Programs EEPROM with data at locations passed in through parameters This function programs the Emulated EEPROM with desired data for a given flash area as determined by the start address and length.
| |||||||||||||||||||||||||||||||||||||||||||||||||
status_t | FLASH_ReadOnce (flash_config_t *config, uint32_t index, uint32_t *dst, uint32_t lengthInBytes) | ||||||||||||||||||||||||||||||||||||||||||||||||
Read resource with data at locations passed in through parameters. More... | |||||||||||||||||||||||||||||||||||||||||||||||||
Security | |
status_t | FLASH_GetSecurityState (flash_config_t *config, flash_security_state_t *state) |
Returns the security state via the pointer passed into the function. More... | |
status_t | FLASH_SecurityBypass (flash_config_t *config, const uint8_t *backdoorKey) |
Allows user to bypass security with a backdoor key. More... | |
Verification | |
status_t | FLASH_VerifyEraseAll (flash_config_t *config, flash_margin_value_t margin) |
Verifies erasure of entire flash at specified margin level. More... | |
status_t | FLASH_VerifyErase (flash_config_t *config, uint32_t start, uint32_t lengthInBytes, flash_margin_value_t margin) |
Verifies erasure of desired flash area at specified margin level. More... | |
status_t | FLASH_VerifyProgram (flash_config_t *config, uint32_t start, uint32_t lengthInBytes, const uint32_t *expectedData, flash_margin_value_t margin, uint32_t *failedAddress, uint32_t *failedData) |
Verifies programming of desired flash area at specified margin level. More... | |
status_t | FLASH_VerifyEraseAllExecuteOnlySegments (flash_config_t *config, flash_margin_value_t margin) |
Verifies if the program flash executeonly segments have been erased to the specified read margin level. More... | |
Protection | |
status_t | FLASH_IsProtected (flash_config_t *config, uint32_t start, uint32_t lengthInBytes, flash_protection_state_t *protection_state) |
Returns the protection state of desired flash area via the pointer passed into the function. More... | |
status_t | FLASH_IsExecuteOnly (flash_config_t *config, uint32_t start, uint32_t lengthInBytes, flash_execute_only_access_state_t *access_state) |
Returns the access state of desired flash area via the pointer passed into the function. More... | |
Properties | |
status_t | FLASH_GetProperty (flash_config_t *config, flash_property_tag_t whichProperty, uint32_t *value) |
Returns the desired flash property. More... | |
Flash Protection Utilities | |||||||||||||||||||||
Prepares the FlexNVM block for use as data flash, EEPROM backup, or a combination of both and initializes the FlexRAM.
| |||||||||||||||||||||
status_t | FLASH_PflashSetProtection (flash_config_t *config, uint32_t protectStatus) | ||||||||||||||||||||
Set PFLASH Protection to the intended protection status. More... | |||||||||||||||||||||
status_t | FLASH_PflashGetProtection (flash_config_t *config, uint32_t *protectStatus) | ||||||||||||||||||||
Get PFLASH Protection Status. More... | |||||||||||||||||||||
struct flash_execute_in_ram_function_config_t |
Data Fields | |
uint32_t | activeFunctionCount |
Number of available execute-in-ram functions. More... | |
uint8_t * | flashRunCommand |
execute-in-ram function: flash_run_command. More... | |
uint8_t * | flashCacheClearCommand |
execute-in-ram function: flash_cache_clear_command. More... | |
uint32_t flash_execute_in_ram_function_config_t::activeFunctionCount |
uint8_t* flash_execute_in_ram_function_config_t::flashRunCommand |
uint8_t* flash_execute_in_ram_function_config_t::flashCacheClearCommand |
struct flash_swap_state_config_t |
Data Fields | |
flash_swap_state_t | flashSwapState |
Current swap system status. More... | |
flash_swap_block_status_t | currentSwapBlockStatus |
Current swap block status. More... | |
flash_swap_block_status_t | nextSwapBlockStatus |
Next swap block status. More... | |
flash_swap_state_t flash_swap_state_config_t::flashSwapState |
flash_swap_block_status_t flash_swap_state_config_t::currentSwapBlockStatus |
flash_swap_block_status_t flash_swap_state_config_t::nextSwapBlockStatus |
struct flash_swap_ifr_field_config_t |
Data Fields | |
uint16_t | swapIndicatorAddress |
Swap indicator address field. More... | |
uint16_t | swapEnableWord |
Swap enable word field. More... | |
uint8_t | reserved0 [6] |
Reserved field. More... | |
uint16_t | swapDisableWord |
Swap disable word field. More... | |
uint8_t | reserved1 [4] |
Reserved field. More... | |
uint16_t flash_swap_ifr_field_config_t::swapIndicatorAddress |
uint16_t flash_swap_ifr_field_config_t::swapEnableWord |
uint8_t flash_swap_ifr_field_config_t::reserved0[6] |
uint16_t flash_swap_ifr_field_config_t::swapDisableWord |
uint8_t flash_swap_ifr_field_config_t::reserved1[4] |
struct flash_operation_config_t |
Data Fields | |
uint32_t | convertedAddress |
Converted address for current flash type. More... | |
uint32_t | activeSectorSize |
Sector size of current flash type. More... | |
uint32_t | activeBlockSize |
Block size of current flash type. More... | |
uint32_t | blockWriteUnitSize |
write unit size. More... | |
uint32_t | sectorCmdAddressAligment |
Erase sector command address alignment. More... | |
uint32_t | sectionCmdAddressAligment |
Program/Verify section command address alignment. More... | |
uint32_t | resourceCmdAddressAligment |
Read resource command address alignment. More... | |
uint32_t | checkCmdAddressAligment |
Program check command address alignment. More... | |
uint32_t flash_operation_config_t::convertedAddress |
uint32_t flash_operation_config_t::activeSectorSize |
uint32_t flash_operation_config_t::activeBlockSize |
uint32_t flash_operation_config_t::blockWriteUnitSize |
uint32_t flash_operation_config_t::sectorCmdAddressAligment |
uint32_t flash_operation_config_t::sectionCmdAddressAligment |
uint32_t flash_operation_config_t::resourceCmdAddressAligment |
uint32_t flash_operation_config_t::checkCmdAddressAligment |
struct flash_config_t |
An instance of this structure is allocated by the user of the flash driver and passed into each of the driver APIs.
Data Fields | |
uint32_t | PFlashBlockBase |
Base address of the first PFlash block. | |
uint32_t | PFlashTotalSize |
Size of all combined PFlash block. More... | |
uint32_t | PFlashBlockCount |
Number of PFlash blocks. More... | |
uint32_t | PFlashSectorSize |
Size in bytes of a sector of PFlash. More... | |
flash_callback_t | PFlashCallback |
Callback function for flash API. More... | |
uint32_t | PFlashAccessSegmentSize |
Size in bytes of a access segment of PFlash. More... | |
uint32_t | PFlashAccessSegmentCount |
Number of PFlash access segments. More... | |
uint32_t * | flashExecuteInRamFunctionInfo |
Info struct of flash execute-in-ram function. More... | |
uint32_t | FlexRAMBlockBase |
For FlexNVM device, this is the base address of FlexRAM For non-FlexNVM device, this is the base address of acceleration RAM memory. | |
uint32_t | FlexRAMTotalSize |
For FlexNVM device, this is the size of FlexRAM For non-FlexNVM device, this is the size of acceleration RAM memory. | |
uint32_t | DFlashBlockBase |
For FlexNVM device, this is the base address of D-Flash memory (FlexNVM memory); For non-FlexNVM device, this field is unused. | |
uint32_t | DFlashTotalSize |
For FlexNVM device, this is total size of the FlexNVM memory; For non-FlexNVM device, this field is unused. | |
uint32_t | EEpromTotalSize |
For FlexNVM device, this is the size in byte of EEPROM area which was partitioned from FlexRAM; For non-FlexNVM device, this field is unused. | |
uint32_t flash_config_t::PFlashTotalSize |
uint32_t flash_config_t::PFlashBlockCount |
uint32_t flash_config_t::PFlashSectorSize |
flash_callback_t flash_config_t::PFlashCallback |
uint32_t flash_config_t::PFlashAccessSegmentSize |
uint32_t flash_config_t::PFlashAccessSegmentCount |
uint32_t* flash_config_t::flashExecuteInRamFunctionInfo |
#define MAKE_VERSION | ( | major, | |
minor, | |||
bugfix | |||
) | (((major) << 16) | ((minor) << 8) | (bugfix)) |
#define FSL_FLASH_DRIVER_VERSION (MAKE_VERSION(2, 1, 0)) |
Version 2.1.0.
#define FLASH_SSD_CONFIG_ENABLE_FLEXNVM_SUPPORT 1 |
Enable FlexNVM support by default.
#define FLASH_DRIVER_IS_FLASH_RESIDENT 1 |
Used for flash resident application.
#define FLASH_DRIVER_IS_EXPORTED 0 |
Used for SDK application.
#define kStatusGroupGeneric 0 |
#define MAKE_STATUS | ( | group, | |
code | |||
) | ((((group)*100) + (code))) |
#define FOUR_CHAR_CODE | ( | a, | |
b, | |||
c, | |||
d | |||
) | (((d) << 24) | ((c) << 16) | ((b) << 8) | ((a))) |
enum _flash_status |
enum flash_margin_value_t |
enum flash_property_tag_t |
enum flash_swap_state_t |
status_t FLASH_Init | ( | flash_config_t * | config | ) |
This function checks and initializes Flash module for the other Flash APIs.
config | Pointer to storage for the driver runtime state. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_PartitionStatusUpdateFailure | Failed to update partition status. |
status_t FLASH_SetCallback | ( | flash_config_t * | config, |
flash_callback_t | callback | ||
) |
config | Pointer to storage for the driver runtime state. |
callback | callback function to be stored in driver |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
status_t FLASH_PrepareExecuteInRamFunctions | ( | flash_config_t * | config | ) |
config | Pointer to storage for the driver runtime state. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
status_t FLASH_EraseAll | ( | flash_config_t * | config, |
uint32_t | key | ||
) |
config | Pointer to storage for the driver runtime state. |
key | value used to validate all flash erase APIs. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_EraseKeyError | Api erase key is invalid. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
kStatus_FLASH_PartitionStatusUpdateFailure | Failed to update partition status |
status_t FLASH_Erase | ( | flash_config_t * | config, |
uint32_t | start, | ||
uint32_t | lengthInBytes, | ||
uint32_t | key | ||
) |
This function erases the appropriate number of flash sectors based on the desired start address and length.
config | Pointer to storage for the driver runtime state. |
start | The start address of the desired flash memory to be erased. The start address does not need to be sector aligned but must be word-aligned. |
lengthInBytes | The length, given in bytes (not words or long-words) to be erased. Must be word aligned. |
key | value used to validate all flash erase APIs. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_AlignmentError | Parameter is not aligned with specified baseline. |
kStatus_FLASH_AddressError | Address is out of range. |
kStatus_FLASH_EraseKeyError | Api erase key is invalid. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_EraseAllExecuteOnlySegments | ( | flash_config_t * | config, |
uint32_t | key | ||
) |
config | Pointer to storage for the driver runtime state. |
key | value used to validate all flash erase APIs. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_EraseKeyError | Api erase key is invalid. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
kStatus_FLASH_PartitionStatusUpdateFailure | Failed to update partition status |
Erases all program flash execute-only segments defined by the FXACC registers.
config | Pointer to storage for the driver runtime state. |
key | value used to validate all flash erase APIs. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_EraseKeyError | Api erase key is invalid. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_Program | ( | flash_config_t * | config, |
uint32_t | start, | ||
uint32_t * | src, | ||
uint32_t | lengthInBytes | ||
) |
This function programs the flash memory with desired data for a given flash area as determined by the start address and length.
config | Pointer to storage for the driver runtime state. |
start | The start address of the desired flash memory to be programmed. Must be word-aligned. |
src | Pointer to the source buffer of data that is to be programmed into the flash. |
lengthInBytes | The length, given in bytes (not words or long-words) to be programmed. Must be word-aligned. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_AlignmentError | Parameter is not aligned with specified baseline. |
kStatus_FLASH_AddressError | Address is out of range. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_ProgramOnce | ( | flash_config_t * | config, |
uint32_t | index, | ||
uint32_t * | src, | ||
uint32_t | lengthInBytes | ||
) |
This function programs the Program Once Field with desired data for a given flash area as determined by the index and length.
config | Pointer to storage for the driver runtime state. |
index | The index indicating which area of Program Once Field to be programmed. |
src | Pointer to the source buffer of data that is to be programmed into the Program Once Field. |
lengthInBytes | The length, given in bytes (not words or long-words) to be programmed. Must be word-aligned. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_ReadOnce | ( | flash_config_t * | config, |
uint32_t | index, | ||
uint32_t * | dst, | ||
uint32_t | lengthInBytes | ||
) |
This function reads the flash memory with desired location for a given flash area as determined by the start address and length.
config | Pointer to storage for the driver runtime state. |
start | The start address of the desired flash memory to be programmed. Must be word-aligned. |
dst | Pointer to the destination buffer of data that is used to store data to be read. |
lengthInBytes | The length, given in bytes (not words or long-words) to be read. Must be word-aligned. |
option | The resource option which indicates which area should be read back. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_AlignmentError | Parameter is not aligned with specified baseline. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
Read Program Once Field through parameters
This function reads the read once feild with given index and length
config | Pointer to storage for the driver runtime state. |
index | The index indicating the area of program once field to be read. |
dst | Pointer to the destination buffer of data that is used to store data to be read. |
lengthInBytes | The length, given in bytes (not words or long-words) to be programmed. Must be word-aligned. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_GetSecurityState | ( | flash_config_t * | config, |
flash_security_state_t * | state | ||
) |
This function retrieves the current Flash security status, including the security enabling state and the backdoor key enabling state.
config | Pointer to storage for the driver runtime state. |
state | Pointer to the value returned for the current security status code: |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
status_t FLASH_SecurityBypass | ( | flash_config_t * | config, |
const uint8_t * | backdoorKey | ||
) |
If the MCU is in secured state, this function will unsecure the MCU by comparing the provided backdoor key with ones in the Flash Configuration Field.
config | Pointer to storage for the driver runtime state. |
backdoorKey | Pointer to the user buffer containing the backdoor key. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_VerifyEraseAll | ( | flash_config_t * | config, |
flash_margin_value_t | margin | ||
) |
This function will check to see if the flash have been erased to the specified read margin level.
config | Pointer to storage for the driver runtime state. |
margin | Read margin choice |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_VerifyErase | ( | flash_config_t * | config, |
uint32_t | start, | ||
uint32_t | lengthInBytes, | ||
flash_margin_value_t | margin | ||
) |
This function will check the appropriate number of flash sectors based on the desired start address and length to see if the flash have been erased to the specified read margin level.
config | Pointer to storage for the driver runtime state. |
start | The start address of the desired flash memory to be verified. The start address does not need to be sector aligned but must be word-aligned. |
lengthInBytes | The length, given in bytes (not words or long-words) to be verified. Must be word-aligned. |
margin | Read margin choice |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_AlignmentError | Parameter is not aligned with specified baseline. |
kStatus_FLASH_AddressError | Address is out of range. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_VerifyProgram | ( | flash_config_t * | config, |
uint32_t | start, | ||
uint32_t | lengthInBytes, | ||
const uint32_t * | expectedData, | ||
flash_margin_value_t | margin, | ||
uint32_t * | failedAddress, | ||
uint32_t * | failedData | ||
) |
This function verifies the data programed in the flash memory using the Flash Program Check Command and compares it with expected data for a given flash area as determined by the start address and length.
config | Pointer to storage for the driver runtime state. |
start | The start address of the desired flash memory to be verified. Must be word-aligned. |
lengthInBytes | The length, given in bytes (not words or long-words) to be verified. Must be word-aligned. |
expectedData | Pointer to the expected data that is to be verified against. |
margin | Read margin choice |
failedAddress | Pointer to returned failing address. |
failedData | Pointer to returned failing data. Some derivitives do not included failed data as part of the FCCOBx registers. In this case, zeros are returned upon failure. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_AlignmentError | Parameter is not aligned with specified baseline. |
kStatus_FLASH_AddressError | Address is out of range. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_VerifyEraseAllExecuteOnlySegments | ( | flash_config_t * | config, |
flash_margin_value_t | margin | ||
) |
config | Pointer to storage for the driver runtime state. |
margin | Read margin choice |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_ExecuteInRamFunctionNotReady | Execute-in-ram function is not available. |
kStatus_FLASH_AccessError | Invalid instruction codes and out-of bounds addresses. |
kStatus_FLASH_ProtectionViolation | The program/erase operation is requested to execute on protected areas. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_IsProtected | ( | flash_config_t * | config, |
uint32_t | start, | ||
uint32_t | lengthInBytes, | ||
flash_protection_state_t * | protection_state | ||
) |
This function retrieves the current Flash protect status for a given flash area as determined by the start address and length.
config | Pointer to storage for the driver runtime state. |
start | The start address of the desired flash memory to be checked. Must be word-aligned. |
lengthInBytes | The length, given in bytes (not words or long-words) to be checked. Must be word-aligned. |
protection_state | Pointer to the value returned for the current protection status code for the desired flash area. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_AlignmentError | Parameter is not aligned with specified baseline. |
kStatus_FLASH_AddressError | Address is out of range. |
status_t FLASH_IsExecuteOnly | ( | flash_config_t * | config, |
uint32_t | start, | ||
uint32_t | lengthInBytes, | ||
flash_execute_only_access_state_t * | access_state | ||
) |
This function retrieves the current Flash access status for a given flash area as determined by the start address and length.
config | Pointer to storage for the driver runtime state. |
start | The start address of the desired flash memory to be checked. Must be word-aligned. |
lengthInBytes | The length, given in bytes (not words or long-words) to be checked. Must be word-aligned. |
access_state | Pointer to the value returned for the current access status code for the desired flash area. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_AlignmentError | Parameter is not aligned with specified baseline. |
kStatus_FLASH_AddressError | Address is out of range. |
status_t FLASH_GetProperty | ( | flash_config_t * | config, |
flash_property_tag_t | whichProperty, | ||
uint32_t * | value | ||
) |
config | Pointer to storage for the driver runtime state. |
whichProperty | The desired property from the list of properties in enum flash_property_tag_t |
value | Pointer to the value returned for the desired flash property |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_UnknownProperty | unknown property tag |
status_t FLASH_PflashSetProtection | ( | flash_config_t * | config, |
uint32_t | protectStatus | ||
) |
config | Pointer to storage for the driver runtime state. |
protectStatus | The expected protect status user wants to set to PFlash protection register. Each bit is corresponding to protection of 1/32 of the total PFlash. The least significant bit is corresponding to the lowest address area of P-Flash. The most significant bit is corresponding to the highest address area of PFlash. There are two possible cases as shown below: 0: this area is protected. 1: this area is unprotected. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |
kStatus_FLASH_CommandFailure | Run-time error during command execution. |
status_t FLASH_PflashGetProtection | ( | flash_config_t * | config, |
uint32_t * | protectStatus | ||
) |
config | Pointer to storage for the driver runtime state. |
protectStatus | Protect status returned by PFlash IP. Each bit is corresponding to protection of 1/32 of the total PFlash. The least significant bit is corresponding to the lowest address area of PFlash. The most significant bit is corresponding to the highest address area of PFlash. Thee are two possible cases as below: 0: this area is protected. 1: this area is unprotected. |
kStatus_FLASH_Success | Api was executed successfully. |
kStatus_FLASH_InvalidArgument | Invalid argument is provided. |