Flash_driver

callback type used for pflash block

Definition at line 389 of file fsl_flash.h.

Flash driver state information.

An instance of this structure is allocated by the user of the flash driver and passed into each of the driver APIs.

Flash execute-in-ram function information.

Enumeration for the three possible flash execute access levels.

Enumeration for the two possilbe options of set flexram function command.

Enumeration for supported flash margin levels.

Active flash information for current operation.

Enumeration for FlexRAM load during reset option.

Enumeration for various flash properties.

Enumeration for the three possible flash protection levels.

Enumeration for the two possible options of flash read resource command.

Enumeration for the three possible flash security states.

Enumeration for the possible flash swap block status

Enumeration for the possible options of Swap Control commands.

Enumeration for the possible options of Swap function.

Flash Swap IFR fileds.

Flash Swap information.

Enumeration for the possible flash swap status.

Enumeration for flash driver API keys.

Note:

The resulting value is built with a byte order such that the string being readable in expected order when viewed in a hex editor, if the value is treated as a 32-bit little endian value.

Enumerator:

kFLASH_apiEraseKey

Key value used to validate all flash erase APIs.

Definition at line 181 of file fsl_flash.h.

FLASH driver version for ROM.

Enumerator:

kFLASH_driverVersionName	Flash driver version name.
kFLASH_driverVersionMajor	Major flash driver version.
kFLASH_driverVersionMinor	Minor flash driver version.
kFLASH_driverVersionBugfix	Bugfix for flash driver version.

Definition at line 65 of file fsl_flash.h.

Constants for execute-in-ram flash function.

Enumerator:

kFLASH_executeInRamFunctionMaxSize	Max size of execute-in-ram function.
kFLASH_executeInRamFunctionTotalNum	Total number of execute-in-ram functions.

Definition at line 254 of file fsl_flash.h.

Enumeration for the three possible flash execute access levels.

Enumerator:

kFLASH_accessStateUnLimited	Flash region is unLimited.
kFLASH_accessStateExecuteOnly	Flash region is execute only.
kFLASH_accessStateMixed	Flash is mixed with unLimited and execute only region.

Definition at line 221 of file fsl_flash.h.

Enumeration for the two possilbe options of set flexram function command.

Enumerator:

kFLASH_flexramFunctionOptionAvailableAsRam	Option used to make FlexRAM available as RAM
kFLASH_flexramFunctionOptionAvailableForEeprom	Option used to make FlexRAM available for EEPROM

Definition at line 305 of file fsl_flash.h.

Enumeration for supported flash margin levels.

Enumerator:

kFLASH_marginValueNormal	Use the 'normal' read level for 1s.
kFLASH_marginValueUser	Apply the 'User' margin to the normal read-1 level.
kFLASH_marginValueFactory	Apply the 'Factory' margin to the normal read-1 level.
kFLASH_marginValueInvalid	Not real margin level, Used to determine the range of valid margin level.

Definition at line 190 of file fsl_flash.h.

Enumeration for FlexRAM load during reset option.

Enumerator:

kFLASH_partitionFlexramLoadOptionLoadedWithValidEepromData	FlexRAM is loaded with valid EEPROM data during reset sequence.
kFLASH_partitionFlexramLoadOptionNotLoaded	FlexRAM is not loaded during reset sequence.

Definition at line 381 of file fsl_flash.h.

Enumeration for various flash properties.

Enumerator:

kFLASH_propertyPflashSectorSize	Pflash sector size property.
kFLASH_propertyPflashTotalSize	Pflash total size property.
kFLASH_propertyPflashBlockSize	Pflash block size property.
kFLASH_propertyPflashBlockCount	Pflash block count property.
kFLASH_propertyPflashBlockBaseAddr	Pflash block base address property.
kFLASH_propertyPflashFacSupport	Pflash fac support property.
kFLASH_propertyPflashAccessSegmentSize	Pflash access segment size property.
kFLASH_propertyPflashAccessSegmentCount	Pflash access segment count property.
kFLASH_propertyFlexRamBlockBaseAddr	FlexRam block base address property.
kFLASH_propertyFlexRamTotalSize	FlexRam total size property.
kFLASH_propertyDflashSectorSize	Dflash sector size property.
kFLASH_propertyDflashTotalSize	Dflash total size property.
kFLASH_propertyDflashBlockSize	Dflash block count property.
kFLASH_propertyDflashBlockCount	Dflash block base address property.
kFLASH_propertyDflashBlockBaseAddr	Eeprom total size property.

Definition at line 231 of file fsl_flash.h.

Enumeration for the three possible flash protection levels.

Enumerator:

kFLASH_protectionStateUnprotected	Flash region is not protected.
kFLASH_protectionStateProtected	Flash region is protected.
kFLASH_protectionStateMixed	Flash is mixed with protected and unprotected region.

Definition at line 211 of file fsl_flash.h.

Enumeration for the two possible options of flash read resource command.

Enumerator:

kFLASH_resourceOptionFlashIfr	Select code for Program flash 0 IFR, Program flash swap 0 IFR, Data flash 0 IFR
kFLASH_resourceOptionVersionId	Select code for Version ID

Definition at line 273 of file fsl_flash.h.

Enumeration for the range of special-purpose flash resource.

Enumerator:

kFLASH_resourceRangePflashIfrSizeInBytes	Pflash IFR size in byte.
kFLASH_resourceRangeVersionIdSizeInBytes	Version ID IFR size in byte.
kFLASH_resourceRangeVersionIdStart	Version ID IFR start address.
kFLASH_resourceRangeVersionIdEnd	Version ID IFR end address.
kFLASH_resourceRangePflashIfrSizeInBytes	Pflash IFR size in byte.
kFLASH_resourceRangeVersionIdSizeInBytes	Version ID IFR size in byte.
kFLASH_resourceRangeVersionIdStart	Version ID IFR start address.
kFLASH_resourceRangeVersionIdEnd	Version ID IFR end address.
kFLASH_resourceRangePflashSwapIfrStart	Pflash swap IFR start address.
kFLASH_resourceRangePflashSwapIfrEnd	Pflash swap IFR end address.
kFLASH_resourceRangeDflashIfrStart	Dflash IFR start address.
kFLASH_resourceRangeDflashIfrEnd	Dflash IFR end address.

Definition at line 283 of file fsl_flash.h.

Enumeration for the three possible flash security states.

Enumerator:

kFLASH_securityStateNotSecure	Flash is not secure.
kFLASH_securityStateBackdoorEnabled	Flash backdoor is enabled.
kFLASH_securityStateBackdoorDisabled	Flash backdoor is disabled.

Definition at line 201 of file fsl_flash.h.

Flash driver status codes.

Enumerator:

kStatus_FLASH_Success	Api is executed successfully
kStatus_FLASH_InvalidArgument	Invalid argument
kStatus_FLASH_SizeError	Error size
kStatus_FLASH_AlignmentError	Parameter is not aligned with specified baseline
kStatus_FLASH_AddressError	Address is out of range
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_UnknownProperty	Unknown property.
kStatus_FLASH_EraseKeyError	Api erase key is invalid.
kStatus_FLASH_RegionExecuteOnly	Current region is execute only.
kStatus_FLASH_ExecuteInRamFunctionNotReady	Execute-in-ram function is not available.
kStatus_FLASH_PartitionStatusUpdateFailure	Failed to update partition status.
kStatus_FLASH_SetFlexramAsEepromError	Failed to set flexram as eeprom.
kStatus_FLASH_RecoverFlexramAsRamError	Failed to recover flexram as ram.
kStatus_FLASH_SetFlexramAsRamError	Failed to set flexram as ram.
kStatus_FLASH_RecoverFlexramAsEepromError	Failed to recover flexram as eeprom.
kStatus_FLASH_CommandNotSupported	Flash api is not supported.
kStatus_FLASH_SwapSystemNotInUninitialized	Swap system is not in uninitialzed state.
kStatus_FLASH_SwapIndicatorAddressError	Swap indicator address is invalid.

Definition at line 129 of file fsl_flash.h.

Enumeration for the possible flash swap block status

Enumerator:

kFLASH_swapBlockStatusLowerHalfProgramBlocksAtZero	Swap block status is that lower half program block at zero.
kFLASH_swapBlockStatusUpperHalfProgramBlocksAtZero	Swap block status is that upper half program block at zero.

Definition at line 348 of file fsl_flash.h.

Enumeration for the possible options of Swap Control commands.

Enumerator:

kFLASH_swapControlOptionIntializeSystem	Option used to Intialize Swap System
kFLASH_swapControlOptionSetInUpdateState	Option used to Set Swap in Update State
kFLASH_swapControlOptionSetInCompleteState	Option used to Set Swap in Complete State
kFLASH_swapControlOptionReportStatus	Option used to Report Swap Status
kFLASH_swapControlOptionDisableSystem	Option used to Disable Swap Status

Definition at line 323 of file fsl_flash.h.

Enumeration for the possible options of Swap function.

Enumerator:

kFLASH_swapFunctionOptionEnable	Option used to enable Swap function
kFLASH_swapFunctionOptionDisable	Option used to Disable Swap function

Definition at line 314 of file fsl_flash.h.

Enumeration for the possible flash swap status.

Enumerator:

kFLASH_swapStateUninitialized	Flash swap system is in uninitialized state.
kFLASH_swapStateReady	Flash swap system is in ready state.
kFLASH_swapStateUpdate	Flash swap system is in update state.
kFLASH_swapStateUpdateErased	Flash swap system is in updateErased state.
kFLASH_swapStateComplete	Flash swap system is in complete state.
kFLASH_swapStateDisabled	Flash swap system is in disabled state.

Definition at line 335 of file fsl_flash.h.

Get DFLASH Protection Status.

Parameters:

config	Pointer to storage for the driver runtime state.
protectStatus	DFlash Protect status returned by PFlash IP. Each bit is corresponding to protection of 1/8 of the total DFlash. The least significant bit is corresponding to the lowest address area of DFlash. The most significant bit is corresponding to the highest address area of DFlash and so on. There are two possible cases as below: 0: this area is protected. 1: this area is unprotected.

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.
kStatus_FLASH_CommandNotSupported	Flash api is not supported

Set DFLASH Protection to the intended protection status.

Parameters:

config

Pointer to storage for the driver runtime state.

protectStatus

The expected protect status user wants to set to DFlash protection register. Each bit is corresponding to protection of 1/8 of the total DFlash. The least significant bit is corresponding to the lowest address area of DFlash. The most significant bit is corresponding to the highest address area of DFlash. There are two possible cases as shown below: 0: this area is protected. 1: this area is unprotected.

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.
kStatus_FLASH_CommandNotSupported	Flash api is not supported
kStatus_FLASH_CommandFailure	Run-time error during command execution.

Get DFLASH Protection Status.

Parameters:

config	Pointer to storage for the driver runtime state.
protectStatus	DFlash Protect status returned by PFlash IP. Each bit is corresponding to protection of 1/8 of the total EEPROM. The least significant bit is corresponding to the lowest address area of EEPROM. The most significant bit is corresponding to the highest address area of EEPROM. There are two possible cases as below: 0: this area is protected. 1: this area is unprotected.

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.
kStatus_FLASH_CommandNotSupported	Flash api is not supported.

Set EEPROM Protection to the intended protection status.

Parameters:

config

Pointer to storage for the driver runtime state.

protectStatus

The expected protect status user wants to set to EEPROM protection register. Each bit is corresponding to protection of 1/8 of the total EEPROM. The least significant bit is corresponding to the lowest address area of EEPROM. The most significant bit is corresponding to the highest address area of EEPROM, and so on. There are two possible cases as shown below: 0: this area is protected. 1: this area is unprotected.

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.
kStatus_FLASH_CommandNotSupported	Flash api is not supported
kStatus_FLASH_CommandFailure	Run-time error during command execution.

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.

Parameters:

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.

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.
kStatus_FLASH_AddressError	Address is out of range.
kStatus_FLASH_SetFlexramAsEepromError	Failed to set flexram as eeprom.
kStatus_FLASH_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FLASH_RecoverFlexramAsRamError	Failed to recover flexram as ram

Erases flash sectors encompassed by parameters passed into function.

This function erases the appropriate number of flash sectors based on the desired start address and length.

Parameters:

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.

Return values:

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.

Definition at line 513 of file fsl_flash.c.

Erases entire flash.

Parameters:

config	Pointer to storage for the driver runtime state.
key	value used to validate all flash erase APIs.

Return values:

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

Definition at line 477 of file fsl_flash.c.

Erases all program flash execute-only segments defined by the FXACC registers.

Parameters:

config	Pointer to storage for the driver runtime state.
key	value used to validate all flash erase APIs.

Return values:

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.

Erases entire flash, including protected sectors.

Parameters:

config	Pointer to storage for the driver runtime state.
key	value used to validate all flash erase APIs.

Return values:

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

Returns the desired flash property.

Parameters:

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

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.
kStatus_FLASH_UnknownProperty	unknown property tag

Returns the security state via the pointer passed into the function.

This function retrieves the current Flash security status, including the security enabling state and the backdoor key enabling state.

Parameters:

config	Pointer to storage for the driver runtime state.
state	Pointer to the value returned for the current security status code:

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.

Initializes global flash properties structure members.

This function checks and initializes Flash module for the other Flash APIs.

Parameters:

config

Pointer to storage for the driver runtime state.

Return values:

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.

Definition at line 377 of file fsl_flash.c.

Returns the access state of desired flash area via the pointer passed into the function.

This function retrieves the current Flash access status for a given flash area as determined by the start address and length.

Parameters:

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.

Return values:

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.

Returns the protection state of desired flash area via the pointer passed into the function.

This function retrieves the current Flash protect status for a given flash area as determined by the start address and length.

Parameters:

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.

Return values:

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.

Get PFLASH Protection Status.

Parameters:

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.

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.

Set PFLASH Protection to the intended protection status.

Parameters:

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.

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.
kStatus_FLASH_CommandFailure	Run-time error during command execution.

Prepare flash execute-in-ram functions.

Parameters:

config

Pointer to storage for the driver runtime state.

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.

Definition at line 458 of file fsl_flash.c.

Programs flash with data at locations passed in through parameters.

This function programs the flash memory with desired data for a given flash area as determined by the start address and length.

Parameters:

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.

Return values:

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.

Definition at line 650 of file fsl_flash.c.

Programs Program Once Field through parameters.

This function programs the Program Once Field with desired data for a given flash area as determined by the index and length.

Parameters:

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.

Return values:

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.

Prepares the FlexNVM block for use as data flash, EEPROM backup, or a combination of both and initializes the FlexRAM.

Parameters:

config	Pointer to storage for the driver runtime state.
option	The option used to set FlexRAM load behavior during reset.
eepromDataSizeCode	Determines the amount of FlexRAM used in each of the available EEPROM subsystems.
flexnvmPartitionCode	Specifies how to split the FlexNVM block between data flash memory and EEPROM backup memory supporting EEPROM functions.

Return values:

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.

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.

Parameters:

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.

Return values:

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_SetFlexramAsRamError	Failed to set flexram as ram
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_RecoverFlexramAsEepromError	Failed to recover flexram as eeprom

Read Program Once Field through parameters.

This function reads the read once feild with given index and length

Parameters:

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.

Return values:

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.

Read resource with data at locations passed in through parameters.

This function reads the flash memory with desired location for a given flash area as determined by the start address and length.

Parameters:

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.

Return values:

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.

Allows user to bypass security with a backdoor key.

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.

Parameters:

config	Pointer to storage for the driver runtime state.
backdoorKey	Pointer to the user buffer containing the backdoor key.

Return values:

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.

Set the desired flash callback function.

Parameters:

config	Pointer to storage for the driver runtime state.
callback	callback function to be stored in driver

Return values:

kStatus_FLASH_Success	Api was executed successfully.
kStatus_FLASH_InvalidArgument	Invalid argument is provided.

Definition at line 445 of file fsl_flash.c.

Set FlexRAM Function command.

Parameters:

config	Pointer to storage for the driver runtime state.
option	The option used to set work mode of FlexRAM

Return values:

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.

Swap the lower half flash with the higher half flaock.

Parameters:

config	Pointer to storage for the driver runtime state.
address	Address used to configure the flash swap function
option	The possible option used to configure Flash Swap function or check the flash swap status

Return values:

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_SwapIndicatorAddressError	Swap indicator address 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_SwapSystemNotInUninitialized	Swap system is not in uninitialzed state

Configure Swap function or Check the swap state of Flash Module.

Parameters:

config	Pointer to storage for the driver runtime state.
address	Address used to configure the flash swap function
option	The possible option used to configure Flash Swap function or check the flash swap status
returnInfo	Pointer to the data which is used to return the information of flash swap.

Return values:

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_SwapIndicatorAddressError	Swap indicator address 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.

Verifies erasure of desired flash area at specified margin level.

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.

Parameters:

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

Return values:

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.

Definition at line 1145 of file fsl_flash.c.

Verifies erasure of entire flash at specified margin level.

This function will check to see if the flash have been erased to the specified read margin level.

Parameters:

config	Pointer to storage for the driver runtime state.
margin	Read margin choice

Return values:

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.

Definition at line 1131 of file fsl_flash.c.

Verifies if the program flash executeonly segments have been erased to the specified read margin level.

Parameters:

config	Pointer to storage for the driver runtime state.
margin	Read margin choice

Return values:

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.

Verifies programming of desired flash area at specified margin level.

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.

Parameters:

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.

Return values:

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.

Definition at line 1204 of file fsl_flash.c.