fsl_ftfx_controller.h File Reference

Data Structures
struct	_ftfx_swap_state_config
	Flash Swap information. More...
struct	_ftfx_special_mem
	ftfx special memory access information. More...
struct	_ftfx_mem_descriptor
	Flash memory descriptor. More...
struct	_ftfx_ops_config
	Active FTFx information for the current operation. More...
struct	_ftfx_ifr_descriptor
	Flash IFR memory descriptor. More...
struct	_ftfx_config
	Flash driver state information. More...

Enumerations
FTFx status
enum	_ftfx_status {   kStatus_FTFx_Success = MAKE_STATUS(kStatusGroupGeneric, 0) , kStatus_FTFx_InvalidArgument = MAKE_STATUS(kStatusGroupGeneric, 4) , kStatus_FTFx_SizeError = MAKE_STATUS(kStatusGroupFtfxDriver, 0) , kStatus_FTFx_AlignmentError ,   kStatus_FTFx_AddressError = MAKE_STATUS(kStatusGroupFtfxDriver, 2) , kStatus_FTFx_AccessError , kStatus_FTFx_ProtectionViolation , kStatus_FTFx_CommandFailure ,   kStatus_FTFx_UnknownProperty = MAKE_STATUS(kStatusGroupFtfxDriver, 6) , kStatus_FTFx_EraseKeyError = MAKE_STATUS(kStatusGroupFtfxDriver, 7) , kStatus_FTFx_RegionExecuteOnly , kStatus_FTFx_ExecuteInRamFunctionNotReady ,   kStatus_FTFx_PartitionStatusUpdateFailure , kStatus_FTFx_SetFlexramAsEepromError , kStatus_FTFx_RecoverFlexramAsRamError , kStatus_FTFx_SetFlexramAsRamError = MAKE_STATUS(kStatusGroupFtfxDriver, 13) ,   kStatus_FTFx_RecoverFlexramAsEepromError , kStatus_FTFx_CommandNotSupported = MAKE_STATUS(kStatusGroupFtfxDriver, 15) , kStatus_FTFx_SwapSystemNotInUninitialized , kStatus_FTFx_SwapIndicatorAddressError ,   kStatus_FTFx_ReadOnlyProperty = MAKE_STATUS(kStatusGroupFtfxDriver, 18) , kStatus_FTFx_InvalidPropertyValue , kStatus_FTFx_InvalidSpeculationOption }
	FTFx driver status codes. More...

Functions
Initialization
status_t	FTFx_API_Init (ftfx_config_t *config)
	Initializes the global flash properties structure members.
status_t	FTFx_API_UpdateFlexnvmPartitionStatus (ftfx_config_t *config)
	Updates FlexNVM memory partition status according to data flash 0 IFR.
Erasing
status_t	FTFx_CMD_Erase (ftfx_config_t *config, uint32_t start, uint32_t lengthInBytes, uint32_t key)
	Erases the flash sectors encompassed by parameters passed into function.
status_t	FTFx_CMD_EraseAll (ftfx_config_t *config, uint32_t key)
	Erases entire flash.
status_t	FTFx_CMD_EraseAllUnsecure (ftfx_config_t *config, uint32_t key)
	Erases the entire flash, including protected sectors.
status_t	FTFx_CMD_EraseAllExecuteOnlySegments (ftfx_config_t *config, uint32_t key)
	Erases all program flash execute-only segments defined by the FXACC registers.
Programming
status_t	FTFx_CMD_Program (ftfx_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes)
	Programs flash with data at locations passed in through parameters.
status_t	FTFx_CMD_ProgramOnce (ftfx_config_t *config, uint32_t index, uint8_t *src, uint32_t lengthInBytes)
	Programs Program Once Field through parameters.
status_t	FTFx_CMD_ProgramSection (ftfx_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes)
	Programs flash with data at locations passed in through parameters via the Program Section command.
status_t	FTFx_CMD_ProgramPartition (ftfx_config_t *config, ftfx_partition_flexram_load_opt_t option, uint32_t eepromDataSizeCode, uint32_t flexnvmPartitionCode)
	Prepares the FlexNVM block for use as data flash, EEPROM backup, or a combination of both and initializes the FlexRAM.
Reading
status_t	FTFx_CMD_ReadOnce (ftfx_config_t *config, uint32_t index, uint8_t *dst, uint32_t lengthInBytes)
	Reads the Program Once Field through parameters.
status_t	FTFx_CMD_ReadResource (ftfx_config_t *config, uint32_t start, uint8_t *dst, uint32_t lengthInBytes, ftfx_read_resource_opt_t option)
	Reads the resource with data at locations passed in through parameters.
Verification
status_t	FTFx_CMD_VerifyErase (ftfx_config_t *config, uint32_t start, uint32_t lengthInBytes, ftfx_margin_value_t margin)
	Verifies an erasure of the desired flash area at a specified margin level.
status_t	FTFx_CMD_VerifyEraseAll (ftfx_config_t *config, ftfx_margin_value_t margin)
	Verifies erasure of the entire flash at a specified margin level.
status_t	FTFx_CMD_VerifyEraseAllExecuteOnlySegments (ftfx_config_t *config, ftfx_margin_value_t margin)
	Verifies whether the program flash execute-only segments have been erased to the specified read margin level.
status_t	FTFx_CMD_VerifyProgram (ftfx_config_t *config, uint32_t start, uint32_t lengthInBytes, const uint8_t *expectedData, ftfx_margin_value_t margin, uint32_t *failedAddress, uint32_t *failedData)
	Verifies programming of the desired flash area at a specified margin level.
Security
status_t	FTFx_REG_GetSecurityState (ftfx_config_t *config, ftfx_security_state_t *state)
	Returns the security state via the pointer passed into the function.
status_t	FTFx_CMD_SecurityBypass (ftfx_config_t *config, const uint8_t *backdoorKey)
	Allows users to bypass security with a backdoor key.
FlexRAM
status_t	FTFx_CMD_SetFlexramFunction (ftfx_config_t *config, ftfx_flexram_func_opt_t option)
	Sets the FlexRAM function command.
Swap
status_t	FTFx_CMD_SwapControl (ftfx_config_t *config, uint32_t address, ftfx_swap_control_opt_t option, ftfx_swap_state_config_t *returnInfo)
	Configures the Swap function or checks the swap state of the Flash module.

FTFx API key
enum	_ftfx_driver_api_keys { kFTFx_ApiEraseKey = FOUR_CHAR_CODE('k', 'f', 'e', 'k') }
	Enumeration for FTFx driver API keys. More...
enum	_ftfx_partition_flexram_load_option { kFTFx_PartitionFlexramLoadOptLoadedWithValidEepromData , kFTFx_PartitionFlexramLoadOptNotLoaded = 0x01U }
	Enumeration for the FlexRAM load during reset option. More...
enum	_ftfx_read_resource_opt { kFTFx_ResourceOptionFlashIfr , kFTFx_ResourceOptionVersionId = 0x01U }
	Enumeration for the two possible options of flash read resource command. More...
enum	_ftfx_margin_value { kFTFx_MarginValueNormal , kFTFx_MarginValueUser , kFTFx_MarginValueFactory , kFTFx_MarginValueInvalid }
	Enumeration for supported FTFx margin levels. More...
enum	_ftfx_security_state { kFTFx_SecurityStateNotSecure = 0xc33cc33cU , kFTFx_SecurityStateBackdoorEnabled = 0x5aa55aa5U , kFTFx_SecurityStateBackdoorDisabled = 0x5ac33ca5U }
	Enumeration for the three possible FTFx security states. More...
enum	_ftfx_flexram_function_option { kFTFx_FlexramFuncOptAvailableAsRam = 0xFFU , kFTFx_FlexramFuncOptAvailableForEeprom = 0x00U }
	Enumeration for the two possilbe options of set FlexRAM function command. More...
enum	_ftfx_swap_control_option {   kFTFx_SwapControlOptionIntializeSystem = 0x01U , kFTFx_SwapControlOptionSetInUpdateState = 0x02U , kFTFx_SwapControlOptionSetInCompleteState = 0x04U , kFTFx_SwapControlOptionReportStatus = 0x08U ,   kFTFx_SwapControlOptionDisableSystem = 0x10U }
	Enumeration for the possible options of Swap control commands. More...
enum	_ftfx_swap_state {   kFTFx_SwapStateUninitialized = 0x00U , kFTFx_SwapStateReady = 0x01U , kFTFx_SwapStateUpdate = 0x02U , kFTFx_SwapStateUpdateErased = 0x03U ,   kFTFx_SwapStateComplete = 0x04U , kFTFx_SwapStateDisabled = 0x05U }
	Enumeration for the possible flash Swap status. More...
enum	_ftfx_swap_block_status { kFTFx_SwapBlockStatusLowerHalfProgramBlocksAtZero , kFTFx_SwapBlockStatusUpperHalfProgramBlocksAtZero }
enum	_ftfx_memory_type { kFTFx_MemTypePflash = 0x00U , kFTFx_MemTypeFlexnvm = 0x01U }
	Enumeration for FTFx memory type. More...
typedef enum _ftfx_partition_flexram_load_option	ftfx_partition_flexram_load_opt_t
	Enumeration for the FlexRAM load during reset option.
typedef enum _ftfx_read_resource_opt	ftfx_read_resource_opt_t
	Enumeration for the two possible options of flash read resource command.
typedef enum _ftfx_margin_value	ftfx_margin_value_t
	Enumeration for supported FTFx margin levels.
typedef enum _ftfx_security_state	ftfx_security_state_t
	Enumeration for the three possible FTFx security states.
typedef enum _ftfx_flexram_function_option	ftfx_flexram_func_opt_t
	Enumeration for the two possilbe options of set FlexRAM function command.
typedef enum _ftfx_swap_control_option	ftfx_swap_control_opt_t
	Enumeration for the possible options of Swap control commands.
typedef enum _ftfx_swap_state	ftfx_swap_state_t
	Enumeration for the possible flash Swap status.
typedef enum _ftfx_swap_block_status	ftfx_swap_block_status_t
typedef struct _ftfx_swap_state_config	ftfx_swap_state_config_t
	Flash Swap information.
typedef struct _ftfx_special_mem	ftfx_spec_mem_t
	ftfx special memory access information.
typedef struct _ftfx_mem_descriptor	ftfx_mem_desc_t
	Flash memory descriptor.
typedef struct _ftfx_ops_config	ftfx_ops_config_t
	Active FTFx information for the current operation.
typedef struct _ftfx_ifr_descriptor	ftfx_ifr_desc_t
	Flash IFR memory descriptor.
typedef struct _ftfx_config	ftfx_config_t
	Flash driver state information.

Typedef Documentation

ftfx_config_t

typedef struct _ftfx_config ftfx_config_t

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.

ftfx_flexram_func_opt_t

typedef enum _ftfx_flexram_function_option ftfx_flexram_func_opt_t

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

ftfx_ifr_desc_t

typedef struct _ftfx_ifr_descriptor ftfx_ifr_desc_t

Flash IFR memory descriptor.

ftfx_margin_value_t

typedef enum _ftfx_margin_value ftfx_margin_value_t

Enumeration for supported FTFx margin levels.

ftfx_mem_desc_t

typedef struct _ftfx_mem_descriptor ftfx_mem_desc_t

Flash memory descriptor.

ftfx_ops_config_t

typedef struct _ftfx_ops_config ftfx_ops_config_t

Active FTFx information for the current operation.

ftfx_partition_flexram_load_opt_t

typedef enum _ftfx_partition_flexram_load_option ftfx_partition_flexram_load_opt_t

Enumeration for the FlexRAM load during reset option.

ftfx_read_resource_opt_t

typedef enum _ftfx_read_resource_opt ftfx_read_resource_opt_t

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

ftfx_security_state_t

typedef enum _ftfx_security_state ftfx_security_state_t

Enumeration for the three possible FTFx security states.

ftfx_spec_mem_t

typedef struct _ftfx_special_mem ftfx_spec_mem_t

ftfx special memory access information.

ftfx_swap_block_status_t

typedef enum _ftfx_swap_block_status ftfx_swap_block_status_t

@breif Enumeration for the possible flash Swap block status

ftfx_swap_control_opt_t

typedef enum _ftfx_swap_control_option ftfx_swap_control_opt_t

Enumeration for the possible options of Swap control commands.

ftfx_swap_state_config_t

typedef struct _ftfx_swap_state_config ftfx_swap_state_config_t

Flash Swap information.

ftfx_swap_state_t

typedef enum _ftfx_swap_state ftfx_swap_state_t

Enumeration for the possible flash Swap status.

Enumeration Type Documentation

_ftfx_driver_api_keys

enum _ftfx_driver_api_keys

Enumeration for FTFx 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
kFTFx_ApiEraseKey	Key value used to validate all FTFx erase APIs.

Definition at line 125 of file fsl_ftfx_controller.h.

{
    kFTFx_ApiEraseKey = FOUR_CHAR_CODE('k', 'f', 'e', 'k') /*!< Key value used to validate all FTFx erase APIs.*/
};

_ftfx_flexram_function_option

enum _ftfx_flexram_function_option

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

Enumerator
kFTFx_FlexramFuncOptAvailableAsRam	An option used to make FlexRAM available as RAM
kFTFx_FlexramFuncOptAvailableForEeprom	An option used to make FlexRAM available for EEPROM

Definition at line 175 of file fsl_ftfx_controller.h.

{
    kFTFx_FlexramFuncOptAvailableAsRam = 0xFFU,    /*!< An option used to make FlexRAM available as RAM */
    kFTFx_FlexramFuncOptAvailableForEeprom = 0x00U /*!< An option used to make FlexRAM available for EEPROM */
} ftfx_flexram_func_opt_t;

_ftfx_margin_value

enum _ftfx_margin_value

Enumeration for supported FTFx margin levels.

Enumerator
kFTFx_MarginValueNormal	Use the 'normal' read level for 1s.
kFTFx_MarginValueUser	Apply the 'User' margin to the normal read-1 level.
kFTFx_MarginValueFactory	Apply the 'Factory' margin to the normal read-1 level.
kFTFx_MarginValueInvalid	Not real margin level, Used to determine the range of valid margin level.

Definition at line 154 of file fsl_ftfx_controller.h.

{
    kFTFx_MarginValueNormal,  /*!< Use the 'normal' read level for 1s.*/
    kFTFx_MarginValueUser,    /*!< Apply the 'User' margin to the normal read-1 level.*/
    kFTFx_MarginValueFactory, /*!< Apply the 'Factory' margin to the normal read-1 level.*/
    kFTFx_MarginValueInvalid  /*!< Not real margin level, Used to determine the range of valid margin level. */
} ftfx_margin_value_t;

_ftfx_memory_type

enum _ftfx_memory_type

Enumeration for FTFx memory type.

Enumerator
kFTFx_MemTypePflash
kFTFx_MemTypeFlexnvm

Definition at line 230 of file fsl_ftfx_controller.h.

{
    kFTFx_MemTypePflash = 0x00U,
    kFTFx_MemTypeFlexnvm = 0x01U
} ;

_ftfx_partition_flexram_load_option

enum _ftfx_partition_flexram_load_option

Enumeration for the FlexRAM load during reset option.

Enumerator
kFTFx_PartitionFlexramLoadOptLoadedWithValidEepromData	FlexRAM is loaded with valid EEPROM data during reset sequence.
kFTFx_PartitionFlexramLoadOptNotLoaded	FlexRAM is not loaded during reset sequence.

Definition at line 134 of file fsl_ftfx_controller.h.

{
    kFTFx_PartitionFlexramLoadOptLoadedWithValidEepromData =
        0x00U, /*!< FlexRAM is loaded with valid EEPROM data during reset sequence.*/
    kFTFx_PartitionFlexramLoadOptNotLoaded = 0x01U /*!< FlexRAM is not loaded during reset sequence.*/
} ftfx_partition_flexram_load_opt_t;

_ftfx_read_resource_opt

enum _ftfx_read_resource_opt

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

Enumerator
kFTFx_ResourceOptionFlashIfr	Select code for Program flash 0 IFR, Program flash swap 0 IFR, Data flash 0 IFR
kFTFx_ResourceOptionVersionId	Select code for the version ID

Definition at line 144 of file fsl_ftfx_controller.h.

{
    kFTFx_ResourceOptionFlashIfr =
        0x00U, /*!< Select code for Program flash 0 IFR, Program flash swap 0 IFR, Data flash 0 IFR */
    kFTFx_ResourceOptionVersionId = 0x01U /*!< Select code for the version ID*/
} ftfx_read_resource_opt_t;

_ftfx_security_state

enum _ftfx_security_state

Enumeration for the three possible FTFx security states.

Enumerator
kFTFx_SecurityStateNotSecure	Flash is not secure.
kFTFx_SecurityStateBackdoorEnabled	Flash backdoor is enabled.
kFTFx_SecurityStateBackdoorDisabled	Flash backdoor is disabled.

Definition at line 165 of file fsl_ftfx_controller.h.

{
    kFTFx_SecurityStateNotSecure = 0xc33cc33cU,       /*!< Flash is not secure.*/
    kFTFx_SecurityStateBackdoorEnabled = 0x5aa55aa5U, /*!< Flash backdoor is enabled.*/
    kFTFx_SecurityStateBackdoorDisabled = 0x5ac33ca5U /*!< Flash backdoor is disabled.*/
} ftfx_security_state_t;

_ftfx_status

enum _ftfx_status

FTFx driver status codes.

Enumerator
kStatus_FTFx_Success	API is executed successfully
kStatus_FTFx_InvalidArgument	Invalid argument
kStatus_FTFx_SizeError	Error size
kStatus_FTFx_AlignmentError	Parameter is not aligned with the specified baseline
kStatus_FTFx_AddressError	Address is out of range
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bound addresses
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas
kStatus_FTFx_CommandFailure	Run-time error during command execution.
kStatus_FTFx_UnknownProperty	Unknown property.
kStatus_FTFx_EraseKeyError	API erase key is invalid.
kStatus_FTFx_RegionExecuteOnly	The current region is execute-only.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_PartitionStatusUpdateFailure	Failed to update partition status.
kStatus_FTFx_SetFlexramAsEepromError	Failed to set FlexRAM as EEPROM.
kStatus_FTFx_RecoverFlexramAsRamError	Failed to recover FlexRAM as RAM.
kStatus_FTFx_SetFlexramAsRamError	Failed to set FlexRAM as RAM.
kStatus_FTFx_RecoverFlexramAsEepromError	Failed to recover FlexRAM as EEPROM.
kStatus_FTFx_CommandNotSupported	Flash API is not supported.
kStatus_FTFx_SwapSystemNotInUninitialized	Swap system is not in an uninitialzed state.
kStatus_FTFx_SwapIndicatorAddressError	The swap indicator address is invalid.
kStatus_FTFx_ReadOnlyProperty	The flash property is read-only.
kStatus_FTFx_InvalidPropertyValue	The flash property value is out of range.
kStatus_FTFx_InvalidSpeculationOption	The option of flash prefetch speculation is invalid.

Definition at line 72 of file fsl_ftfx_controller.h.

{
    kStatus_FTFx_Success = MAKE_STATUS(kStatusGroupGeneric, 0),         /*!< API is executed successfully*/
    kStatus_FTFx_InvalidArgument = MAKE_STATUS(kStatusGroupGeneric, 4), /*!< Invalid argument*/
    kStatus_FTFx_SizeError = MAKE_STATUS(kStatusGroupFtfxDriver, 0),   /*!< Error size*/
    kStatus_FTFx_AlignmentError =
        MAKE_STATUS(kStatusGroupFtfxDriver, 1), /*!< Parameter is not aligned with the specified baseline*/
    kStatus_FTFx_AddressError = MAKE_STATUS(kStatusGroupFtfxDriver, 2), /*!< Address is out of range */
    kStatus_FTFx_AccessError =
        MAKE_STATUS(kStatusGroupFtfxDriver, 3), /*!< Invalid instruction codes and out-of bound addresses */
    kStatus_FTFx_ProtectionViolation = MAKE_STATUS(
        kStatusGroupFtfxDriver, 4), /*!< The program/erase operation is requested to execute on protected areas */
    kStatus_FTFx_CommandFailure =
        MAKE_STATUS(kStatusGroupFtfxDriver, 5), /*!< Run-time error during command execution. */
    kStatus_FTFx_UnknownProperty = MAKE_STATUS(kStatusGroupFtfxDriver, 6), /*!< Unknown property.*/
    kStatus_FTFx_EraseKeyError = MAKE_STATUS(kStatusGroupFtfxDriver, 7),   /*!< API erase key is invalid.*/
    kStatus_FTFx_RegionExecuteOnly =
        MAKE_STATUS(kStatusGroupFtfxDriver, 8), /*!< The current region is execute-only.*/
    kStatus_FTFx_ExecuteInRamFunctionNotReady =
        MAKE_STATUS(kStatusGroupFtfxDriver, 9), /*!< Execute-in-RAM function is not available.*/
    kStatus_FTFx_PartitionStatusUpdateFailure =
        MAKE_STATUS(kStatusGroupFtfxDriver, 10), /*!< Failed to update partition status.*/
    kStatus_FTFx_SetFlexramAsEepromError =
        MAKE_STATUS(kStatusGroupFtfxDriver, 11), /*!< Failed to set FlexRAM as EEPROM.*/
    kStatus_FTFx_RecoverFlexramAsRamError =
        MAKE_STATUS(kStatusGroupFtfxDriver, 12), /*!< Failed to recover FlexRAM as RAM.*/
    kStatus_FTFx_SetFlexramAsRamError = MAKE_STATUS(kStatusGroupFtfxDriver, 13), /*!< Failed to set FlexRAM as RAM.*/
    kStatus_FTFx_RecoverFlexramAsEepromError =
        MAKE_STATUS(kStatusGroupFtfxDriver, 14), /*!< Failed to recover FlexRAM as EEPROM.*/
    kStatus_FTFx_CommandNotSupported = MAKE_STATUS(kStatusGroupFtfxDriver, 15), /*!< Flash API is not supported.*/
    kStatus_FTFx_SwapSystemNotInUninitialized =
        MAKE_STATUS(kStatusGroupFtfxDriver, 16), /*!< Swap system is not in an uninitialzed state.*/
    kStatus_FTFx_SwapIndicatorAddressError =
        MAKE_STATUS(kStatusGroupFtfxDriver, 17), /*!< The swap indicator address is invalid.*/
    kStatus_FTFx_ReadOnlyProperty = MAKE_STATUS(kStatusGroupFtfxDriver, 18), /*!< The flash property is read-only.*/
    kStatus_FTFx_InvalidPropertyValue =
        MAKE_STATUS(kStatusGroupFtfxDriver, 19), /*!< The flash property value is out of range.*/
    kStatus_FTFx_InvalidSpeculationOption =
        MAKE_STATUS(kStatusGroupFtfxDriver, 20), /*!< The option of flash prefetch speculation is invalid.*/
};

_ftfx_swap_block_status

enum _ftfx_swap_block_status

@breif Enumeration for the possible flash Swap block status

Enumerator
kFTFx_SwapBlockStatusLowerHalfProgramBlocksAtZero	Swap block status is that lower half program block at zero.
kFTFx_SwapBlockStatusUpperHalfProgramBlocksAtZero	Swap block status is that upper half program block at zero.

Definition at line 209 of file fsl_ftfx_controller.h.

{
    kFTFx_SwapBlockStatusLowerHalfProgramBlocksAtZero =
        0x00U, /*!< Swap block status is that lower half program block at zero.*/
    kFTFx_SwapBlockStatusUpperHalfProgramBlocksAtZero =
        0x01U, /*!< Swap block status is that upper half program block at zero.*/
} ftfx_swap_block_status_t;

_ftfx_swap_control_option

enum _ftfx_swap_control_option

Enumeration for the possible options of Swap control commands.

Enumerator
kFTFx_SwapControlOptionIntializeSystem	An option used to initialize the Swap system
kFTFx_SwapControlOptionSetInUpdateState	An option used to set the Swap in an update state
kFTFx_SwapControlOptionSetInCompleteState	An option used to set the Swap in a complete state
kFTFx_SwapControlOptionReportStatus	An option used to report the Swap status
kFTFx_SwapControlOptionDisableSystem	An option used to disable the Swap status

Definition at line 184 of file fsl_ftfx_controller.h.

{
    kFTFx_SwapControlOptionIntializeSystem = 0x01U,    /*!< An option used to initialize the Swap system */
    kFTFx_SwapControlOptionSetInUpdateState = 0x02U,   /*!< An option used to set the Swap in an update state */
    kFTFx_SwapControlOptionSetInCompleteState = 0x04U, /*!< An option used to set the Swap in a complete state */
    kFTFx_SwapControlOptionReportStatus = 0x08U,       /*!< An option used to report the Swap status */
    kFTFx_SwapControlOptionDisableSystem = 0x10U       /*!< An option used to disable the Swap status */
} ftfx_swap_control_opt_t;

_ftfx_swap_state

enum _ftfx_swap_state

Enumeration for the possible flash Swap status.

Enumerator
kFTFx_SwapStateUninitialized	Flash Swap system is in an uninitialized state.
kFTFx_SwapStateReady	Flash Swap system is in a ready state.
kFTFx_SwapStateUpdate	Flash Swap system is in an update state.
kFTFx_SwapStateUpdateErased	Flash Swap system is in an updateErased state.
kFTFx_SwapStateComplete	Flash Swap system is in a complete state.
kFTFx_SwapStateDisabled	Flash Swap system is in a disabled state.

Definition at line 196 of file fsl_ftfx_controller.h.

{
    kFTFx_SwapStateUninitialized = 0x00U, /*!< Flash Swap system is in an uninitialized state.*/
    kFTFx_SwapStateReady = 0x01U,         /*!< Flash Swap system is in a ready state.*/
    kFTFx_SwapStateUpdate = 0x02U,        /*!< Flash Swap system is in an update state.*/
    kFTFx_SwapStateUpdateErased = 0x03U,  /*!< Flash Swap system is in an updateErased state.*/
    kFTFx_SwapStateComplete = 0x04U,      /*!< Flash Swap system is in a complete state.*/
    kFTFx_SwapStateDisabled = 0x05U       /*!< Flash Swap system is in a disabled state.*/
} ftfx_swap_state_t;

Function Documentation

FTFx_API_Init()

status_t FTFx_API_Init

(

ftfx_config_t *

config

)

Initializes the global flash properties structure members.

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

Parameters

config

Pointer to the storage for the driver runtime state.

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.

Definition at line 240 of file fsl_ftfx_controller.c.

{
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    config->flexramBlockBase = FSL_FEATURE_FLASH_FLEX_RAM_START_ADDRESS;
    config->flexramTotalSize = FSL_FEATURE_FLASH_FLEX_RAM_SIZE;
 
    /* copy required flash command to RAM */
#if FTFx_DRIVER_IS_FLASH_RESIDENT
    if (NULL == config->runCmdFuncAddr)
    {
#if FTFx_DRIVER_IS_EXPORTED
        return kStatus_FTFx_ExecuteInRamFunctionNotReady;
#else
        config->runCmdFuncAddr = s_ftfxRunCommand;
#endif /* FTFx_DRIVER_IS_EXPORTED */
    }
    ftfx_copy_run_command_to_ram(config->runCmdFuncAddr);
#endif /* FTFx_DRIVER_IS_FLASH_RESIDENT */
 
    ftfx_init_ifr(config);
 
    return kStatus_FTFx_Success;
}

Referenced by FLEXNVM_Init().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_API_UpdateFlexnvmPartitionStatus()

status_t FTFx_API_UpdateFlexnvmPartitionStatus

(

ftfx_config_t *

config

)

Updates FlexNVM memory partition status according to data flash 0 IFR.

This function updates FlexNVM memory partition status.

Parameters

config

Pointer to the storage for the driver runtime state.

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_PartitionStatusUpdateFailure	Failed to update the partition status.

Definition at line 269 of file fsl_ftfx_controller.c.

{
    struct _dflash_ifr_field_config
    {
        uint32_t reserved0;
        uint8_t FlexNVMPartitionCode;
        uint8_t EEPROMDataSetSize;
        uint16_t reserved1;
    } dataIFRReadOut;
    uint32_t flexnvmInfoIfrAddr;
    status_t returnCode;
 
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    flexnvmInfoIfrAddr = config->ifrDesc.resRange.dflashIfrStart + config->ifrDesc.resRange.ifrMemSize - sizeof(dataIFRReadOut);
 
#if defined(FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD) && FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD
    /* Get FlexNVM memory partition info from data flash IFR */
    returnCode = FTFx_CMD_ReadResource(config, flexnvmInfoIfrAddr, (uint8_t *)&dataIFRReadOut,
                                       sizeof(dataIFRReadOut), kFTFx_ResourceOptionFlashIfr);
    if (returnCode != kStatus_FTFx_Success)
    {
        return kStatus_FTFx_PartitionStatusUpdateFailure;
    }
#else
#error "Cannot get FlexNVM memory partition info"
#endif
 
    /* Fill out partitioned EEPROM size */
    dataIFRReadOut.EEPROMDataSetSize &= 0x0FU;
    config->eepromTotalSize = kEepromDensities[dataIFRReadOut.EEPROMDataSetSize];
 
    /* Fill out partitioned DFlash size */
    dataIFRReadOut.FlexNVMPartitionCode &= 0x0FU;
    config->flashDesc.totalSize = kDflashDensities[dataIFRReadOut.FlexNVMPartitionCode];
 
    return kStatus_FTFx_Success;
}

Referenced by FLEXNVM_Init(), FTFx_CMD_EraseAll(), and FTFx_CMD_EraseAllUnsecure().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_Erase()

status_t FTFx_CMD_Erase	(	ftfx_config_t *	config,
		uint32_t	start,
		uint32_t	lengthInBytes,
		uint32_t	key
	)

Erases the 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	The pointer to the 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	The value used to validate all flash erase APIs.

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_AlignmentError	The parameter is not aligned with the specified baseline.
kStatus_FTFx_AddressError	The address is out of range.
kStatus_FTFx_EraseKeyError	The API erase key is invalid.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 312 of file fsl_ftfx_controller.c.

{
    uint32_t sectorSize;
    uint32_t endAddress;      /* storing end address */
    uint32_t numberOfSectors; /* number of sectors calculated by endAddress */
    status_t returnCode;
 
    /* Check the supplied address range. */
    returnCode = ftfx_check_mem_range(config, start, lengthInBytes, config->opsConfig.addrAligment.sectorCmd);
    if (returnCode)
    {
        return returnCode;
    }
 
    /* Validate the user key */
    returnCode = ftfx_check_user_key(key);
    if (returnCode)
    {
        return returnCode;
    }
 
    start = config->opsConfig.convertedAddress;
    sectorSize = config->flashDesc.sectorSize;
 
    /* calculating Flash end address */
    endAddress = start + lengthInBytes - 1;
 
    /* re-calculate the endAddress and align it to the start of the next sector
     * which will be used in the comparison below */
    if (endAddress % sectorSize)
    {
        numberOfSectors = endAddress / sectorSize + 1;
        endAddress = numberOfSectors * sectorSize - 1;
    }
 
    /* the start address will increment to the next sector address
     * until it reaches the endAdddress */
    while (start <= endAddress)
    {
        /* preparing passing parameter to erase a flash block */
        kFCCOBx[0] = BYTE2WORD_1_3(FTFx_ERASE_SECTOR, start);
 
        /* calling flash command sequence function to execute the command */
        returnCode = ftfx_command_sequence(config);
 
        /* checking the success of command execution */
        if (kStatus_FTFx_Success != returnCode)
        {
            break;
        }
        else
        {
            /* Increment to the next sector */
            start += sectorSize;
        }
    }
 
    return (returnCode);
}

Referenced by FLEXNVM_DflashErase().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_EraseAll()

status_t FTFx_CMD_EraseAll	(	ftfx_config_t *	config,
		uint32_t	key
	)

Erases entire flash.

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_EraseKeyError	API erase key is invalid.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during command execution.
kStatus_FTFx_PartitionStatusUpdateFailure	Failed to update the partition status.

Definition at line 375 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
 
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* preparing passing parameter to erase all flash blocks */
    kFCCOBx[0] = BYTE2WORD_1_3(FTFx_ERASE_ALL_BLOCK, 0xFFFFFFU);
 
    /* Validate the user key */
    returnCode = ftfx_check_user_key(key);
    if (returnCode)
    {
        return returnCode;
    }
 
    /* calling flash command sequence function to execute the command */
    returnCode = ftfx_command_sequence(config);
 
#if FSL_FEATURE_FLASH_HAS_FLEX_NVM
    /* Data flash IFR will be erased by erase all command, so we need to
     *  update FlexNVM memory partition status synchronously */
    if (returnCode == kStatus_FTFx_Success)
    {
        returnCode = FTFx_API_UpdateFlexnvmPartitionStatus(config);
    }
#endif
 
    return returnCode;
}

Referenced by FLEXNVM_EraseAll().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_EraseAllExecuteOnlySegments()

status_t FTFx_CMD_EraseAllExecuteOnlySegments	(	ftfx_config_t *	config,
		uint32_t	key
	)

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

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_EraseKeyError	API erase key is invalid.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 445 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
 
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* preparing passing parameter to erase all execute-only segments
     * 1st element for the FCCOB register */
    kFCCOBx[0] = BYTE2WORD_1_3(FTFx_ERASE_ALL_EXECUTE_ONLY_SEGMENT, 0xFFFFFFU);
 
    /* Validate the user key */
    returnCode = ftfx_check_user_key(key);
    if (returnCode)
    {
        return returnCode;
    }
 
    /* calling flash command sequence function to execute the command */
    returnCode = ftfx_command_sequence(config);
 
    return returnCode;
}

Here is the call graph for this function:

FTFx_CMD_EraseAllUnsecure()

status_t FTFx_CMD_EraseAllUnsecure	(	ftfx_config_t *	config,
		uint32_t	key
	)

Erases the entire flash, including protected sectors.

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_EraseKeyError	API erase key is invalid.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during command execution.
kStatus_FTFx_PartitionStatusUpdateFailure	Failed to update the partition status.

Definition at line 410 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
 
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* Prepare passing parameter to erase all flash blocks (unsecure). */
    kFCCOBx[0] = BYTE2WORD_1_3(FTFx_ERASE_ALL_BLOCK_UNSECURE, 0xFFFFFFU);
 
    /* Validate the user key */
    returnCode = ftfx_check_user_key(key);
    if (returnCode)
    {
        return returnCode;
    }
 
    /* calling flash command sequence function to execute the command */
    returnCode = ftfx_command_sequence(config);
 
#if FSL_FEATURE_FLASH_HAS_FLEX_NVM
    /* Data flash IFR will be erased by erase all unsecure command, so we need to
     *  update FlexNVM memory partition status synchronously */
    if (returnCode == kStatus_FTFx_Success)
    {
        returnCode = FTFx_API_UpdateFlexnvmPartitionStatus(config);
    }
#endif
 
    return returnCode;
}

Referenced by FLEXNVM_EraseAllUnsecure().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_Program()

status_t FTFx_CMD_Program	(	ftfx_config_t *	config,
		uint32_t	start,
		uint8_t *	src,
		uint32_t	lengthInBytes
	)

Programs flash with data at locations passed in through parameters.

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

Parameters

config	A pointer to the storage for the driver runtime state.
start	The start address of the desired flash memory to be programmed. Must be word-aligned.
src	A 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_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_AlignmentError	Parameter is not aligned with the specified baseline.
kStatus_FTFx_AddressError	Address is out of range.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 471 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
    uint8_t blockWriteUnitSize = config->opsConfig.addrAligment.blockWriteUnitSize;
 
    if (src == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* Check the supplied address range. */
    returnCode = ftfx_check_mem_range(config, start, lengthInBytes, blockWriteUnitSize);
    if (returnCode)
    {
        return returnCode;
    }
 
    start = config->opsConfig.convertedAddress;
 
    while (lengthInBytes > 0)
    {
        /* preparing passing parameter to program the flash block */
        kFCCOBx[1] = ftfx_read_word_from_byte_address((const uint8_t*)src);
        src += 4;
 
        if (4 == blockWriteUnitSize)
        {
            kFCCOBx[0] = BYTE2WORD_1_3(FTFx_PROGRAM_LONGWORD, start);
        }
        else if (8 == blockWriteUnitSize)
        {
            kFCCOBx[2] = ftfx_read_word_from_byte_address((const uint8_t*)src);
            src += 4;
            kFCCOBx[0] = BYTE2WORD_1_3(FTFx_PROGRAM_PHRASE, start);
        }
        else
        {
        }
 
        /* calling flash command sequence function to execute the command */
        returnCode = ftfx_command_sequence(config);
 
        /* checking for the success of command execution */
        if (kStatus_FTFx_Success != returnCode)
        {
            break;
        }
        else
        {
            /* update start address for next iteration */
            start += blockWriteUnitSize;
 
            /* update lengthInBytes for next iteration */
            lengthInBytes -= blockWriteUnitSize;
        }
    }
 
    return (returnCode);
}

Referenced by FLEXNVM_DflashProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_ProgramOnce()

status_t FTFx_CMD_ProgramOnce	(	ftfx_config_t *	config,
		uint32_t	index,
		uint8_t *	src,
		uint32_t	lengthInBytes
	)

Programs Program Once Field through parameters.

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

Parameters

config	A pointer to the storage for the driver runtime state.
index	The index indicating which area of the Program Once Field to be programmed.
src	A 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_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 534 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
 
    if ((config == NULL) || (src == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* pass paramters to FTFx */
    kFCCOBx[0] = BYTE2WORD_1_1_2(FTFx_PROGRAM_ONCE, index, 0xFFFFU);
 
    kFCCOBx[1] = ftfx_read_word_from_byte_address((const uint8_t*)src);
 
    /* Note: Have to seperate the first index from the rest if it equals 0
     * to avoid a pointless comparison of unsigned int to 0 compiler warning */
    if (config->ifrDesc.feature.has8ByteIdxSupport)
    {
        if (config->ifrDesc.feature.has4ByteIdxSupport)
        {
            if (((index == config->ifrDesc.idxInfo.mix8byteIdxStart) ||
                 ((index >= config->ifrDesc.idxInfo.mix8byteIdxStart + 1) && (index <= config->ifrDesc.idxInfo.mix8byteIdxStart))) &&
                  (lengthInBytes == 8))
            {
                kFCCOBx[2] = ftfx_read_word_from_byte_address((const uint8_t*)src + 4);
            }
        }
        else
        {
            kFCCOBx[2] = ftfx_read_word_from_byte_address((const uint8_t*)src + 4);
        }
    }
 
    /* calling flash command sequence function to execute the command */
    returnCode = ftfx_command_sequence(config);
 
    return returnCode;
}

Here is the call graph for this function:

FTFx_CMD_ProgramPartition()

status_t FTFx_CMD_ProgramPartition	(	ftfx_config_t *	config,
		ftfx_partition_flexram_load_opt_t	option,
		uint32_t	eepromDataSizeCode,
		uint32_t	flexnvmPartitionCode
	)

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_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	Invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during command execution.

Definition at line 695 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
 
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* eepromDataSizeCode[7:6], flexnvmPartitionCode[7:4] should be all 1'b0
     *  or it will cause access error. */
    /* eepromDataSizeCode &= 0x3FU;  */
    /* flexnvmPartitionCode &= 0x0FU; */
 
    /* preparing passing parameter to program the flash block */
    kFCCOBx[0] = BYTE2WORD_1_2_1(FTFx_PROGRAM_PARTITION, 0xFFFFU, option);
    kFCCOBx[1] = BYTE2WORD_1_1_2(eepromDataSizeCode, flexnvmPartitionCode, 0xFFFFU);
 
    /* calling flash command sequence function to execute the command */
    returnCode = ftfx_command_sequence(config);
 
#if FSL_FEATURE_FLASH_HAS_FLEX_NVM
    /* Data flash IFR will be updated by program partition command during reset sequence,
     * so we just set reserved values for partitioned FlexNVM size here */
    config->eepromTotalSize = 0xFFFFU;
    config->flashDesc.totalSize = 0xFFFFFFFFU;
#endif
 
    return (returnCode);
}

Referenced by FLEXNVM_ProgramPartition().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_ProgramSection()

status_t FTFx_CMD_ProgramSection	(	ftfx_config_t *	config,
		uint32_t	start,
		uint8_t *	src,
		uint32_t	lengthInBytes
	)

Programs flash with data at locations passed in through parameters via the Program Section command.

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

Parameters

config	A pointer to the storage for the driver runtime state.
start	The start address of the desired flash memory to be programmed. Must be word-aligned.
src	A 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_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_AlignmentError	Parameter is not aligned with specified baseline.
kStatus_FTFx_AddressError	Address is out of range.
kStatus_FTFx_SetFlexramAsRamError	Failed to set flexram as RAM.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during command execution.
kStatus_FTFx_RecoverFlexramAsEepromError	Failed to recover FlexRAM as EEPROM.

Definition at line 574 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
    uint32_t sectorSize;
    uint8_t aligmentInBytes = config->opsConfig.addrAligment.sectionCmd;
#if defined(FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD) && FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD
    bool needSwitchFlexRamMode = false;
#endif /* FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD */
 
    if (src == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* Check the supplied address range. */
    returnCode = ftfx_check_mem_range(config, start, lengthInBytes, aligmentInBytes);
    if (returnCode)
    {
        return returnCode;
    }
 
    start = config->opsConfig.convertedAddress;
    sectorSize = config->flashDesc.sectorSize;
 
#if defined(FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD) && FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD
    /* Switch function of FlexRAM if needed */
    if (!(FTFx->FCNFG & FTFx_FCNFG_RAMRDY_MASK))
    {
        needSwitchFlexRamMode = true;
 
        returnCode = FTFx_CMD_SetFlexramFunction(config, kFTFx_FlexramFuncOptAvailableAsRam);
        if (returnCode != kStatus_FTFx_Success)
        {
            return kStatus_FTFx_SetFlexramAsRamError;
        }
    }
#endif /* FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD */
 
    while (lengthInBytes > 0)
    {
        /* Make sure the write operation doesn't span two sectors */
        uint32_t endAddressOfCurrentSector = ALIGN_UP(start, sectorSize);
        uint32_t lengthTobeProgrammedOfCurrentSector;
        uint32_t currentOffset = 0;
 
        if (endAddressOfCurrentSector == start)
        {
            endAddressOfCurrentSector += sectorSize;
        }
 
        if (lengthInBytes + start > endAddressOfCurrentSector)
        {
            lengthTobeProgrammedOfCurrentSector = endAddressOfCurrentSector - start;
        }
        else
        {
            lengthTobeProgrammedOfCurrentSector = lengthInBytes;
        }
 
        /* Program Current Sector */
        while (lengthTobeProgrammedOfCurrentSector > 0)
        {
            /* Make sure the program size doesn't exceeds Acceleration RAM size */
            uint32_t programSizeOfCurrentPass;
            uint32_t numberOfPhases;
 
            if (lengthTobeProgrammedOfCurrentSector > config->flexramTotalSize)
            {
                programSizeOfCurrentPass = config->flexramTotalSize;
            }
            else
            {
                programSizeOfCurrentPass = lengthTobeProgrammedOfCurrentSector;
            }
 
            /* Copy data to FlexRAM */
            memcpy((void *)config->flexramBlockBase, src + currentOffset, programSizeOfCurrentPass);
            /* Set start address of the data to be programmed */
            kFCCOBx[0] = BYTE2WORD_1_3(FTFx_PROGRAM_SECTION, start + currentOffset);
            /* Set program size in terms of FEATURE_FLASH_SECTION_CMD_ADDRESS_ALIGMENT */
            numberOfPhases = programSizeOfCurrentPass / aligmentInBytes;
 
            kFCCOBx[1] = BYTE2WORD_2_2(numberOfPhases, 0xFFFFU);
 
            /* Peform command sequence */
            returnCode = ftfx_command_sequence(config);
 
            if (returnCode != kStatus_FTFx_Success)
            {
                return returnCode;
            }
 
            lengthTobeProgrammedOfCurrentSector -= programSizeOfCurrentPass;
            currentOffset += programSizeOfCurrentPass;
        }
 
        src += currentOffset;
        start += currentOffset;
        lengthInBytes -= currentOffset;
    }
 
#if defined(FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD) && FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD
    /* Restore function of FlexRAM if needed. */
    if (needSwitchFlexRamMode)
    {
        returnCode = FTFx_CMD_SetFlexramFunction(config, kFTFx_FlexramFuncOptAvailableForEeprom);
        if (returnCode != kStatus_FTFx_Success)
        {
            return kStatus_FTFx_RecoverFlexramAsEepromError;
        }
    }
#endif /* FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD */
 
    return returnCode;
}

Referenced by FLEXNVM_DflashProgramSection().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_ReadOnce()

status_t FTFx_CMD_ReadOnce	(	ftfx_config_t *	config,
		uint32_t	index,
		uint8_t *	dst,
		uint32_t	lengthInBytes
	)

Reads the Program Once Field through parameters.

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

Parameters

config	A pointer to the storage for the driver runtime state.
index	The index indicating the area of program once field to be read.
dst	A 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_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 730 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
 
    if ((config == NULL) || (dst == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* pass paramters to FTFx */
    kFCCOBx[0] = BYTE2WORD_1_1_2(FTFx_READ_ONCE, index, 0xFFFFU);
 
    /* calling flash command sequence function to execute the command */
    returnCode = ftfx_command_sequence(config);
 
    if (kStatus_FTFx_Success == returnCode)
    {
        ftfx_write_word_to_byte_address(dst, kFCCOBx[1]);
        /* Note: Have to seperate the first index from the rest if it equals 0
         *       to avoid a pointless comparison of unsigned int to 0 compiler warning */
        if (config->ifrDesc.feature.has8ByteIdxSupport)
        {
            if (config->ifrDesc.feature.has4ByteIdxSupport)
            {
                if (((index == config->ifrDesc.idxInfo.mix8byteIdxStart) ||
                     ((index >= config->ifrDesc.idxInfo.mix8byteIdxStart + 1) && (index <= config->ifrDesc.idxInfo.mix8byteIdxStart))) &&
                      (lengthInBytes == 8))
                {
                    ftfx_write_word_to_byte_address(dst + 4, kFCCOBx[2]);
                }
            }
            else
            {
                ftfx_write_word_to_byte_address(dst + 4, kFCCOBx[2]);
            }
        }
    }
 
    return returnCode;
}

Here is the call graph for this function:

FTFx_CMD_ReadResource()

status_t FTFx_CMD_ReadResource	(	ftfx_config_t *	config,
		uint32_t	start,
		uint8_t *	dst,
		uint32_t	lengthInBytes,
		ftfx_read_resource_opt_t	option
	)

Reads the resource with data at locations passed in through parameters.

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

Parameters

config	A pointer to the storage for the driver runtime state.
start	The start address of the desired flash memory to be programmed. Must be word-aligned.
dst	A 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_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_AlignmentError	Parameter is not aligned with the specified baseline.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 772 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
 
    if ((config == NULL) || (dst == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    uint8_t aligmentInBytes = config->opsConfig.addrAligment.resourceCmd;
 
    /* Check the supplied address range. */
    returnCode = ftfx_check_resource_range(config, start, lengthInBytes, aligmentInBytes, option);
    if (returnCode != kStatus_FTFx_Success)
    {
        return returnCode;
    }
 
    while (lengthInBytes > 0)
    {
        /* preparing passing parameter */
        kFCCOBx[0] = BYTE2WORD_1_3(FTFx_READ_RESOURCE, start);
        if (aligmentInBytes == 4)
        {
            kFCCOBx[2] = BYTE2WORD_1_3(option, 0xFFFFFFU);
        }
        else if (aligmentInBytes == 8)
        {
            kFCCOBx[1] = BYTE2WORD_1_3(option, 0xFFFFFFU);
        }
        else
        {
        }
 
        /* calling flash command sequence function to execute the command */
        returnCode = ftfx_command_sequence(config);
 
        if (kStatus_FTFx_Success != returnCode)
        {
            break;
        }
 
        /* fetch data */
        ftfx_write_word_to_byte_address(dst, kFCCOBx[1]);
        dst += 4;
        if (aligmentInBytes == 8)
        {
            ftfx_write_word_to_byte_address(dst, kFCCOBx[2]);
            dst += 4;
        }
        /* update start address for next iteration */
        start += aligmentInBytes;
        /* update lengthInBytes for next iteration */
        lengthInBytes -= aligmentInBytes;
    }
 
    return (returnCode);
}

Referenced by FLEXNVM_ReadResource(), and FTFx_API_UpdateFlexnvmPartitionStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_SecurityBypass()

status_t FTFx_CMD_SecurityBypass	(	ftfx_config_t *	config,
		const uint8_t *	backdoorKey
	)

Allows users to bypass security with a backdoor key.

If the MCU is in secured state, this function unsecures the MCU by comparing the provided backdoor key with ones in the flash configuration field.

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 978 of file fsl_ftfx_controller.c.

{
    uint8_t registerValue; /* registerValue */
    status_t returnCode;   /* return code variable */
 
    if ((config == NULL) || (backdoorKey == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* set the default return code as kStatus_Success */
    returnCode = kStatus_FTFx_Success;
 
    /* Get flash security register value */
    registerValue = FTFx->FSEC;
 
    /* Check to see if flash is in secure state (any state other than 0x2)
     * If not, then skip this since flash is not secure */
    if (0x02 != (registerValue & 0x03))
    {
        /* preparing passing parameter to erase a flash block */
        kFCCOBx[0] = BYTE2WORD_1_3(FTFx_SECURITY_BY_PASS, 0xFFFFFFU);
        kFCCOBx[1] = BYTE2WORD_1_1_1_1(backdoorKey[0], backdoorKey[1], backdoorKey[2], backdoorKey[3]);
        kFCCOBx[2] = BYTE2WORD_1_1_1_1(backdoorKey[4], backdoorKey[5], backdoorKey[6], backdoorKey[7]);
 
        /* calling flash command sequence function to execute the command */
        returnCode = ftfx_command_sequence(config);
    }
 
    return (returnCode);
}

Referenced by FLEXNVM_SecurityBypass().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_SetFlexramFunction()

status_t FTFx_CMD_SetFlexramFunction	(	ftfx_config_t *	config,
		ftfx_flexram_func_opt_t	option
	)

Sets the FlexRAM function command.

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 1049 of file fsl_ftfx_controller.c.

 {
     status_t status;
 
     if (config == NULL)
     {
         return kStatus_FTFx_InvalidArgument;
     }
 
     status = ftfx_check_flexram_function_option(option);
     if (status != kStatus_FTFx_Success)
     {
         return status;
     }
 
     /* preparing passing parameter to verify all block command */
     kFCCOBx[0] = BYTE2WORD_1_1_2(FTFx_SET_FLEXRAM_FUNCTION, option, 0xFFFFU);
 
     /* calling flash command sequence function to execute the command */
     return ftfx_command_sequence(config);
 }

Referenced by FLEXNVM_EepromWrite(), FLEXNVM_SetFlexramFunction(), and FTFx_CMD_ProgramSection().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_SwapControl()

status_t FTFx_CMD_SwapControl	(	ftfx_config_t *	config,
		uint32_t	address,
		ftfx_swap_control_opt_t	option,
		ftfx_swap_state_config_t *	returnInfo
	)

Configures the Swap function or checks the swap state of the Flash module.

Parameters

config	A pointer to the 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	A pointer to the data which is used to return the information of flash Swap.

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_AlignmentError	Parameter is not aligned with specified baseline.
kStatus_FTFx_SwapIndicatorAddressError	Swap indicator address is invalid.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 1073 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
 
    if ((config == NULL) || (returnInfo == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    if (address & (FSL_FEATURE_FLASH_PFLASH_SWAP_CONTROL_CMD_ADDRESS_ALIGMENT - 1))
    {
        return kStatus_FTFx_AlignmentError;
    }
 
    /* Make sure address provided is in the lower half of Program flash but not in the Flash Configuration Field */
    if ((address >= (config->flashDesc.totalSize / 2)) ||
        ((address >= kFTFx_PflashConfigAreaStart) && (address <= kFTFx_PflashConfigAreaEnd)))
    {
        return kStatus_FTFx_SwapIndicatorAddressError;
    }
 
    /* Check the option. */
    returnCode = ftfx_check_swap_control_option(option);
    if (returnCode)
    {
        return returnCode;
    }
 
    kFCCOBx[0] = BYTE2WORD_1_3(FTFx_SWAP_CONTROL, address);
    kFCCOBx[1] = BYTE2WORD_1_3(option, 0xFFFFFFU);
 
    returnCode = ftfx_command_sequence(config);
 
    returnInfo->flashSwapState = (ftfx_swap_state_t)FTFx_FCCOB5_REG;
    returnInfo->currentSwapBlockStatus = (ftfx_swap_block_status_t)FTFx_FCCOB6_REG;
    returnInfo->nextSwapBlockStatus = (ftfx_swap_block_status_t)FTFx_FCCOB7_REG;
 
    return returnCode;
}

Here is the call graph for this function:

FTFx_CMD_VerifyErase()

status_t FTFx_CMD_VerifyErase	(	ftfx_config_t *	config,
		uint32_t	start,
		uint32_t	lengthInBytes,
		ftfx_margin_value_t	margin
	)

Verifies an erasure of the desired flash area at a specified margin level.

This function checks the appropriate number of flash sectors based on the desired start address and length to check whether the flash is erased to the specified read margin level.

Parameters

config	A pointer to the 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_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_AlignmentError	Parameter is not aligned with specified baseline.
kStatus_FTFx_AddressError	Address is out of range.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 836 of file fsl_ftfx_controller.c.

{
    /* Check arguments. */
    uint32_t blockSize;
    uint32_t nextBlockStartAddress;
    uint32_t remainingBytes;
    uint8_t aligmentInBytes = config->opsConfig.addrAligment.sectionCmd;
    status_t returnCode;
 
    returnCode = ftfx_check_mem_range(config, start, lengthInBytes, aligmentInBytes);
    if (returnCode)
    {
        return returnCode;
    }
 
    start = config->opsConfig.convertedAddress;
    blockSize = config->flashDesc.totalSize / config->flashDesc.blockCount;
 
    nextBlockStartAddress = ALIGN_UP(start, blockSize);
    if (nextBlockStartAddress == start)
    {
        nextBlockStartAddress += blockSize;
    }
 
    remainingBytes = lengthInBytes;
 
    while (remainingBytes)
    {
        uint32_t numberOfPhrases;
        uint32_t verifyLength = nextBlockStartAddress - start;
        if (verifyLength > remainingBytes)
        {
            verifyLength = remainingBytes;
        }
 
        numberOfPhrases = verifyLength / aligmentInBytes;
 
        /* Fill in verify section command parameters. */
        kFCCOBx[0] = BYTE2WORD_1_3(FTFx_VERIFY_SECTION, start);
        kFCCOBx[1] = BYTE2WORD_2_1_1(numberOfPhrases, margin, 0xFFU);
 
        /* calling flash command sequence function to execute the command */
        returnCode = ftfx_command_sequence(config);
        if (returnCode)
        {
            return returnCode;
        }
 
        remainingBytes -= verifyLength;
        start += verifyLength;
        nextBlockStartAddress += blockSize;
    }
 
    return kStatus_FTFx_Success;
}

Referenced by FLEXNVM_DflashVerifyErase().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_VerifyEraseAll()

status_t FTFx_CMD_VerifyEraseAll	(	ftfx_config_t *	config,
		ftfx_margin_value_t	margin
	)

Verifies erasure of the entire flash at a specified margin level.

This function checks whether the flash is erased to the specified read margin level.

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 895 of file fsl_ftfx_controller.c.

{
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* preparing passing parameter to verify all block command */
    kFCCOBx[0] = BYTE2WORD_1_1_2(FTFx_VERIFY_ALL_BLOCK, margin, 0xFFFFU);
 
    /* calling flash command sequence function to execute the command */
    return ftfx_command_sequence(config);
}

Referenced by FLEXNVM_VerifyEraseAll().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_CMD_VerifyEraseAllExecuteOnlySegments()

status_t FTFx_CMD_VerifyEraseAllExecuteOnlySegments	(	ftfx_config_t *	config,
		ftfx_margin_value_t	margin
	)

Verifies whether the program flash execute-only segments have been erased to the specified read margin level.

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 909 of file fsl_ftfx_controller.c.

{
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* preparing passing parameter to verify erase all execute-only segments command */
    kFCCOBx[0] = BYTE2WORD_1_1_2(FTFx_VERIFY_ALL_EXECUTE_ONLY_SEGMENT, margin, 0xFFFFU);
 
    /* calling flash command sequence function to execute the command */
    return ftfx_command_sequence(config);
}

Here is the call graph for this function:

FTFx_CMD_VerifyProgram()

status_t FTFx_CMD_VerifyProgram	(	ftfx_config_t *	config,
		uint32_t	start,
		uint32_t	lengthInBytes,
		const uint8_t *	expectedData,
		ftfx_margin_value_t	margin,
		uint32_t *	failedAddress,
		uint32_t *	failedData
	)

Verifies programming of the desired flash area at a specified margin level.

This function verifies the data programed in the flash memory using the Flash Program Check Command and compares it to the expected data for a given flash area as determined by the start address and length.

Parameters

config	A pointer to the 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	A pointer to the expected data that is to be verified against.
margin	Read margin choice.
failedAddress	A pointer to the returned failing address.
failedData	A pointer to the returned failing data. Some derivatives do not include failed data as part of the FCCOBx registers. In this case, zeros are returned upon failure.

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_AlignmentError	Parameter is not aligned with specified baseline.
kStatus_FTFx_AddressError	Address is out of range.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.
kStatus_FTFx_AccessError	Invalid instruction codes and out-of bounds addresses.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_CommandFailure	Run-time error during the command execution.

Definition at line 923 of file fsl_ftfx_controller.c.

{
    status_t returnCode;
    uint8_t aligmentInBytes = config->opsConfig.addrAligment.checkCmd;
    if (expectedData == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    returnCode = ftfx_check_mem_range(config, start, lengthInBytes, aligmentInBytes);
    if (returnCode)
    {
        return returnCode;
    }
 
    start = config->opsConfig.convertedAddress;
 
    while (lengthInBytes)
    {
        /* preparing passing parameter to program check the flash block */
        kFCCOBx[0] = BYTE2WORD_1_3(FTFx_PROGRAM_CHECK, start);
        kFCCOBx[1] = BYTE2WORD_1_3(margin, 0xFFFFFFU);
        kFCCOBx[2] = ftfx_read_word_from_byte_address((const uint8_t*)expectedData);
 
        /* calling flash command sequence function to execute the command */
        returnCode = ftfx_command_sequence(config);
 
        /* checking for the success of command execution */
        if (kStatus_FTFx_Success != returnCode)
        {
            if (failedAddress)
            {
                *failedAddress = start;
            }
            if (failedData)
            {
                *failedData = 0;
            }
            break;
        }
 
        lengthInBytes -= aligmentInBytes;
        expectedData += aligmentInBytes;
        start += aligmentInBytes;
    }
 
    return (returnCode);
}

Referenced by FLEXNVM_DflashVerifyProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

FTFx_REG_GetSecurityState()

status_t FTFx_REG_GetSecurityState	(	ftfx_config_t *	config,
		ftfx_security_state_t *	state
	)

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	A pointer to storage for the driver runtime state.
state	A pointer to the value returned for the current security status code:

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.

Definition at line 1010 of file fsl_ftfx_controller.c.

{
    /* store data read from flash register */
    uint8_t registerValue;
 
    if ((config == NULL) || (state == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* Get flash security register value */
    registerValue = FTFx->FSEC;
 
    /* check the status of the flash security bits in the security register */
    if (kFTFx_FsecRegCode_SEC_Unsecured == (registerValue & FTFx_FSEC_SEC_MASK))
    {
        /* Flash in unsecured state */
        *state = kFTFx_SecurityStateNotSecure;
    }
    else
    {
        /* Flash in secured state
         * check for backdoor key security enable bit */
        if (kFTFx_FsecRegCode_KEYEN_Enabled == (registerValue & FTFx_FSEC_KEYEN_MASK))
        {
            /* Backdoor key security enabled */
            *state = kFTFx_SecurityStateBackdoorEnabled;
        }
        else
        {
            /* Backdoor key security disabled */
            *state = kFTFx_SecurityStateBackdoorDisabled;
        }
    }
 
    return (kStatus_FTFx_Success);
}

Referenced by FLEXNVM_GetSecurityState().

Here is the call graph for this function:

Here is the caller graph for this function:

Go to the source code of this file.