Overview

The flash provides the C90TFS Flash driver of Kinetis devices with the C90TFS Flash module inside. The flash driver 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 fields. More...

union	flash_swap_ifr_field_data_t
	Flash Swap IFR field data. 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

Enumerations
enum	flash_margin_value_t { kFLASH_MarginValueNormal, kFLASH_MarginValueUser, kFLASH_MarginValueFactory, kFLASH_MarginValueInvalid }
	Enumeration for supported flash margin levels. More...

enum	flash_security_state_t { kFLASH_SecurityStateNotSecure, kFLASH_SecurityStateBackdoorEnabled, kFLASH_SecurityStateBackdoorDisabled }
	Enumeration for the three possible flash security states. More...

enum	flash_protection_state_t { kFLASH_ProtectionStateUnprotected, kFLASH_ProtectionStateProtected, kFLASH_ProtectionStateMixed }
	Enumeration for the three possible flash protection levels. More...

enum	flash_execute_only_access_state_t { kFLASH_AccessStateUnLimited, kFLASH_AccessStateExecuteOnly, kFLASH_AccessStateMixed }
	Enumeration for the three possible flash execute access levels. More...

enum	flash_property_tag_t { kFLASH_PropertyPflashSectorSize = 0x00U, kFLASH_PropertyPflashTotalSize = 0x01U, kFLASH_PropertyPflashBlockSize = 0x02U, kFLASH_PropertyPflashBlockCount = 0x03U, kFLASH_PropertyPflashBlockBaseAddr = 0x04U, kFLASH_PropertyPflashFacSupport = 0x05U, kFLASH_PropertyPflashAccessSegmentSize = 0x06U, kFLASH_PropertyPflashAccessSegmentCount = 0x07U, kFLASH_PropertyFlexRamBlockBaseAddr = 0x08U, kFLASH_PropertyFlexRamTotalSize = 0x09U, kFLASH_PropertyDflashSectorSize = 0x10U, kFLASH_PropertyDflashTotalSize = 0x11U, kFLASH_PropertyDflashBlockSize = 0x12U, kFLASH_PropertyDflashBlockCount = 0x13U, kFLASH_PropertyDflashBlockBaseAddr = 0x14U }
	Enumeration for various flash properties. More...

enum	_flash_execute_in_ram_function_constants { kFLASH_ExecuteInRamFunctionMaxSizeInWords = 16U, kFLASH_ExecuteInRamFunctionTotalNum = 2U }
	Constants for execute-in-RAM flash function. More...

enum	flash_read_resource_option_t { kFLASH_ResourceOptionFlashIfr, kFLASH_ResourceOptionVersionId = 0x01U }
	Enumeration for the two possible options of flash read resource command. More...

enum	_flash_read_resource_range { kFLASH_ResourceRangePflashIfrSizeInBytes = 256U, kFLASH_ResourceRangeVersionIdSizeInBytes = 8U, kFLASH_ResourceRangeVersionIdStart = 0x00U, kFLASH_ResourceRangeVersionIdEnd = 0x07U , kFLASH_ResourceRangePflashSwapIfrEnd, kFLASH_ResourceRangeDflashIfrStart = 0x800000U, kFLASH_ResourceRangeDflashIfrEnd = 0x8003FFU }
	Enumeration for the range of special-purpose flash resource. More...

enum	flash_flexram_function_option_t { kFLASH_FlexramFunctionOptionAvailableAsRam = 0xFFU, kFLASH_FlexramFunctionOptionAvailableForEeprom = 0x00U }
	Enumeration for the two possilbe options of set flexram function command. More...

enum	_flash_acceleration_ram_property
	Enumeration for acceleration RAM property.

enum	flash_swap_function_option_t { kFLASH_SwapFunctionOptionEnable = 0x00U, kFLASH_SwapFunctionOptionDisable = 0x01U }
	Enumeration for the possible options of Swap function. More...

enum	flash_swap_control_option_t { kFLASH_SwapControlOptionIntializeSystem = 0x01U, kFLASH_SwapControlOptionSetInUpdateState = 0x02U, kFLASH_SwapControlOptionSetInCompleteState = 0x04U, kFLASH_SwapControlOptionReportStatus = 0x08U, kFLASH_SwapControlOptionDisableSystem = 0x10U }
	Enumeration for the possible options of Swap Control commands. More...

enum	flash_swap_state_t { kFLASH_SwapStateUninitialized = 0x00U, kFLASH_SwapStateReady = 0x01U, kFLASH_SwapStateUpdate = 0x02U, kFLASH_SwapStateUpdateErased = 0x03U, kFLASH_SwapStateComplete = 0x04U, kFLASH_SwapStateDisabled = 0x05U }
	Enumeration for the possible flash swap status. More...

enum	flash_swap_block_status_t { kFLASH_SwapBlockStatusLowerHalfProgramBlocksAtZero, kFLASH_SwapBlockStatusUpperHalfProgramBlocksAtZero }
	Enumeration for the possible flash swap block status More...

enum	flash_partition_flexram_load_option_t { kFLASH_PartitionFlexramLoadOptionLoadedWithValidEepromData, kFLASH_PartitionFlexramLoadOptionNotLoaded = 0x01U }
	Enumeration for FlexRAM load during reset option. More...

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 status
enum	_flash_status { kStatus_FLASH_Success = MAKE_STATUS(kStatusGroupGeneric, 0), kStatus_FLASH_InvalidArgument = MAKE_STATUS(kStatusGroupGeneric, 4), kStatus_FLASH_SizeError = MAKE_STATUS(kStatusGroupFlashDriver, 0), kStatus_FLASH_AlignmentError, kStatus_FLASH_AddressError = MAKE_STATUS(kStatusGroupFlashDriver, 2), kStatus_FLASH_AccessError, kStatus_FLASH_ProtectionViolation, kStatus_FLASH_CommandFailure, kStatus_FLASH_UnknownProperty = MAKE_STATUS(kStatusGroupFlashDriver, 6), kStatus_FLASH_EraseKeyError = MAKE_STATUS(kStatusGroupFlashDriver, 7), kStatus_FLASH_RegionExecuteOnly = MAKE_STATUS(kStatusGroupFlashDriver, 8), kStatus_FLASH_ExecuteInRamFunctionNotReady, kStatus_FLASH_PartitionStatusUpdateFailure, kStatus_FLASH_SetFlexramAsEepromError, kStatus_FLASH_RecoverFlexramAsRamError, kStatus_FLASH_SetFlexramAsRamError = MAKE_STATUS(kStatusGroupFlashDriver, 13), kStatus_FLASH_RecoverFlexramAsEepromError, kStatus_FLASH_CommandNotSupported = MAKE_STATUS(kStatusGroupFlashDriver, 15), kStatus_FLASH_SwapSystemNotInUninitialized, kStatus_FLASH_SwapIndicatorAddressError }
	Flash driver status codes. More...

#define	kStatusGroupGeneric 0
	Flash driver status group. More...

#define	kStatusGroupFlashDriver 1

#define	MAKE_STATUS(group, code) ((((group)*100) + (code)))
	Construct a status code value from a group and code number. 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.

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

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

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.

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.

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...

Data Structure Documentation

struct flash_execute_in_ram_function_config_t

Data Fields
uint32_t	activeFunctionCount
	Number of available execute-in-RAM functions. More...

uint32_t *	flashRunCommand
	execute-in-RAM function: flash_run_command. More...

uint32_t *	flashCacheClearCommand
	execute-in-RAM function: flash_cache_clear_command. More...

Field Documentation

uint32_t flash_execute_in_ram_function_config_t::activeFunctionCount

uint32_t* flash_execute_in_ram_function_config_t::flashRunCommand

uint32_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...

Field Documentation

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 [4]
	Reserved field. More...

Field Documentation

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[4]

union flash_swap_ifr_field_data_t

Data Fields
uint32_t	flashSwapIfrData [2]
	Flash Swap IFR field data . More...

flash_swap_ifr_field_config_t	flashSwapIfrField
	Flash Swap IFR field struct. More...

Field Documentation

uint32_t flash_swap_ifr_field_data_t::flashSwapIfrData[2]

flash_swap_ifr_field_config_t flash_swap_ifr_field_data_t::flashSwapIfrField

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...

Field Documentation

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.

Field Documentation

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

Macro Definition Documentation

#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)))

Enumeration Type Documentation

enum _flash_driver_version_constants

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.

enum _flash_status

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.

enum _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.

enum flash_margin_value_t

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.

enum flash_security_state_t

Enumerator
kFLASH_SecurityStateNotSecure	Flash is not secure.
kFLASH_SecurityStateBackdoorEnabled	Flash backdoor is enabled.
kFLASH_SecurityStateBackdoorDisabled	Flash backdoor is disabled.

enum flash_protection_state_t

Enumerator
kFLASH_ProtectionStateUnprotected	Flash region is not protected.
kFLASH_ProtectionStateProtected	Flash region is protected.
kFLASH_ProtectionStateMixed	Flash is mixed with protected and unprotected region.

enum flash_execute_only_access_state_t

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.

enum flash_property_tag_t

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.

enum _flash_execute_in_ram_function_constants

Enumerator
kFLASH_ExecuteInRamFunctionMaxSizeInWords	Max size of execute-in-RAM function.
kFLASH_ExecuteInRamFunctionTotalNum	Total number of execute-in-RAM functions.

enum flash_read_resource_option_t

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.

enum _flash_read_resource_range

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_ResourceRangePflashSwapIfrEnd	Pflash swap IFR end address.
kFLASH_ResourceRangeDflashIfrStart	Dflash IFR start address.
kFLASH_ResourceRangeDflashIfrEnd	Dflash IFR end address.

enum flash_flexram_function_option_t

Enumerator
kFLASH_FlexramFunctionOptionAvailableAsRam	Option used to make FlexRAM available as RAM.
kFLASH_FlexramFunctionOptionAvailableForEeprom	Option used to make FlexRAM available for EEPROM.

enum flash_swap_function_option_t

Enumerator
kFLASH_SwapFunctionOptionEnable	Option used to enable Swap function.
kFLASH_SwapFunctionOptionDisable	Option used to Disable Swap function.

enum flash_swap_control_option_t

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.

enum flash_swap_state_t

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.

enum flash_swap_block_status_t

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.

enum flash_partition_flexram_load_option_t

Enumerator
kFLASH_PartitionFlexramLoadOptionLoadedWithValidEepromData	FlexRAM is loaded with valid EEPROM data during reset sequence.
kFLASH_PartitionFlexramLoadOptionNotLoaded	FlexRAM is not loaded during reset sequence.

Function Documentation

status_t FLASH_Init ( flash_config_t * config )

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.

status_t FLASH_SetCallback	(	flash_config_t *	config,
		flash_callback_t	callback
	)

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.

status_t FLASH_PrepareExecuteInRamFunctions ( flash_config_t * config )

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.

status_t FLASH_EraseAll	(	flash_config_t *	config,
		uint32_t	key
	)

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

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.

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.

status_t FLASH_EraseAllExecuteOnlySegments	(	flash_config_t *	config,
		uint32_t	key
	)

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

status_t FLASH_VerifyEraseAllExecuteOnlySegments	(	flash_config_t *	config,
		flash_margin_value_t	margin
	)

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.

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.

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.

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.

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.

status_t FLASH_GetProperty	(	flash_config_t *	config,
		flash_property_tag_t	whichProperty,
		uint32_t *	value
	)

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

status_t FLASH_PflashSetProtection	(	flash_config_t *	config,
		uint32_t	protectStatus
	)

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.

status_t FLASH_PflashGetProtection	(	flash_config_t *	config,
		uint32_t *	protectStatus
	)

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.

Overview

Data Structures

Typedefs

Enumerations

Flash version

Flash configuration

Flash status

Flash API key

Initialization

Erasing

Programming

Reading

Security

Verification

Protection

Properties

Flash Protection Utilities

Data Structure Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation