Ftfx_flexnvm_driver

Data Structures
struct	_flexnvm_config
	Flexnvm driver state information. More...

Variables
ftfx_config_t	_flexnvm_config::ftfxConfig

Flexnvm version
enum	_flexnvm_property_tag {   kFLEXNVM_PropertyDflashSectorSize = 0x00U , kFLEXNVM_PropertyDflashTotalSize = 0x01U , kFLEXNVM_PropertyDflashBlockSize = 0x02U , kFLEXNVM_PropertyDflashBlockCount = 0x03U ,   kFLEXNVM_PropertyDflashBlockBaseAddr = 0x04U , kFLEXNVM_PropertyFlexRamBlockBaseAddr = 0x05U , kFLEXNVM_PropertyFlexRamTotalSize = 0x06U , kFLEXNVM_PropertyEepromTotalSize = 0x07U }
	Enumeration for various flexnvm properties. More...
typedef enum _flexnvm_property_tag	flexnvm_property_tag_t
	Enumeration for various flexnvm properties.
typedef struct _flexnvm_config	flexnvm_config_t
	Flexnvm driver state information.

Initialization
status_t	FLEXNVM_Init (flexnvm_config_t *config)
	Initializes the global flash properties structure members.

Erasing
status_t	FLEXNVM_DflashErase (flexnvm_config_t *config, uint32_t start, uint32_t lengthInBytes, uint32_t key)
	Erases the Dflash sectors encompassed by parameters passed into function.
status_t	FLEXNVM_EraseAll (flexnvm_config_t *config, uint32_t key)
	Erases entire flexnvm.
status_t	FLEXNVM_EraseAllUnsecure (flexnvm_config_t *config, uint32_t key)
	Erases the entire flexnvm, including protected sectors.

Programming
status_t	FLEXNVM_DflashProgram (flexnvm_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes)
	Programs flash with data at locations passed in through parameters.
status_t	FLEXNVM_DflashProgramSection (flexnvm_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	FLEXNVM_ProgramPartition (flexnvm_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	FLEXNVM_ReadResource (flexnvm_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	FLEXNVM_DflashVerifyErase (flexnvm_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	FLEXNVM_VerifyEraseAll (flexnvm_config_t *config, ftfx_margin_value_t margin)
	Verifies erasure of the entire flash at a specified margin level.
status_t	FLEXNVM_DflashVerifyProgram (flexnvm_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	FLEXNVM_GetSecurityState (flexnvm_config_t *config, ftfx_security_state_t *state)
	Returns the security state via the pointer passed into the function.
status_t	FLEXNVM_SecurityBypass (flexnvm_config_t *config, const uint8_t *backdoorKey)
	Allows users to bypass security with a backdoor key.

FlexRAM
status_t	FLEXNVM_SetFlexramFunction (flexnvm_config_t *config, ftfx_flexram_func_opt_t option)
	Sets the FlexRAM function command.
status_t	FLEXNVM_EepromWrite (flexnvm_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes)
	Programs the EEPROM with data at locations passed in through parameters.

Flash Protection Utilities
status_t	FLEXNVM_DflashSetProtection (flexnvm_config_t *config, uint8_t protectStatus)
	Sets the DFlash protection to the intended protection status.
status_t	FLEXNVM_DflashGetProtection (flexnvm_config_t *config, uint8_t *protectStatus)
	Gets the DFlash protection status.
status_t	FLEXNVM_EepromSetProtection (flexnvm_config_t *config, uint8_t protectStatus)
	Sets the EEPROM protection to the intended protection status.
status_t	FLEXNVM_EepromGetProtection (flexnvm_config_t *config, uint8_t *protectStatus)
	Gets the EEPROM protection status.

Properties
status_t	FLEXNVM_GetProperty (flexnvm_config_t *config, flexnvm_property_tag_t whichProperty, uint32_t *value)
	Returns the desired flexnvm property.

Detailed Description

Typedef Documentation

flexnvm_config_t

typedef struct _flexnvm_config flexnvm_config_t

Flexnvm driver state information.

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

flexnvm_property_tag_t

typedef enum _flexnvm_property_tag flexnvm_property_tag_t

Enumeration for various flexnvm properties.

Enumeration Type Documentation

_flexnvm_property_tag

enum _flexnvm_property_tag

Enumeration for various flexnvm properties.

Enumerator
kFLEXNVM_PropertyDflashSectorSize	Dflash sector size property.
kFLEXNVM_PropertyDflashTotalSize	Dflash total size property.
kFLEXNVM_PropertyDflashBlockSize	Dflash block size property.
kFLEXNVM_PropertyDflashBlockCount	Dflash block count property.
kFLEXNVM_PropertyDflashBlockBaseAddr	Dflash block base address property.
kFLEXNVM_PropertyFlexRamBlockBaseAddr	FlexRam block base address property.
kFLEXNVM_PropertyFlexRamTotalSize	FlexRam total size property.
kFLEXNVM_PropertyEepromTotalSize	EEPROM total size property.

Definition at line 62 of file fsl_ftfx_flexnvm.h.

{
    kFLEXNVM_PropertyDflashSectorSize = 0x00U,         /*!< Dflash sector size property.*/
    kFLEXNVM_PropertyDflashTotalSize = 0x01U,          /*!< Dflash total size property.*/
    kFLEXNVM_PropertyDflashBlockSize = 0x02U,          /*!< Dflash block size property.*/
    kFLEXNVM_PropertyDflashBlockCount = 0x03U,         /*!< Dflash block count property.*/
    kFLEXNVM_PropertyDflashBlockBaseAddr = 0x04U,      /*!< Dflash block base address property.*/
    kFLEXNVM_PropertyFlexRamBlockBaseAddr = 0x05U,     /*!< FlexRam block base address property.*/
    kFLEXNVM_PropertyFlexRamTotalSize = 0x06U,         /*!< FlexRam total size property.*/
    kFLEXNVM_PropertyEepromTotalSize = 0x07U,          /*!< EEPROM total size property.*/
} flexnvm_property_tag_t;

Function Documentation

FLEXNVM_DflashErase()

status_t FLEXNVM_DflashErase	(	flexnvm_config_t *	config,
		uint32_t	start,
		uint32_t	lengthInBytes,
		uint32_t	key
	)

Erases the Dflash 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 104 of file fsl_ftfx_flexnvm.c.

{
    status_t returnCode;
    returnCode = flexnvm_convert_start_address(config, start);
    if (returnCode != kStatus_FTFx_Success)
    {
        return returnCode;
    }
 
    return FTFx_CMD_Erase(&config->ftfxConfig, start, lengthInBytes, key);
}

Referenced by intFlashErase().

Here is the call graph for this function:

Here is the caller graph for this function:

FLEXNVM_DflashGetProtection()

status_t FLEXNVM_DflashGetProtection	(	flexnvm_config_t *	config,
		uint8_t *	protectStatus
	)

Gets the DFlash protection status.

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_CommandNotSupported	Flash API is not supported.

Definition at line 327 of file fsl_ftfx_flexnvm.c.

{
    if ((config == NULL) || (protectStatus == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    if ((config->ftfxConfig.flashDesc.totalSize == 0) || (config->ftfxConfig.flashDesc.totalSize == 0xFFFFFFFFU))
    {
        return kStatus_FTFx_CommandNotSupported;
    }
 
    *protectStatus = FTFx->FDPROT;
 
    return kStatus_FTFx_Success;
}

Referenced by flashInit().

Here is the caller graph for this function:

FLEXNVM_DflashProgram()

status_t FLEXNVM_DflashProgram	(	flexnvm_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 128 of file fsl_ftfx_flexnvm.c.

{
    status_t returnCode;
    returnCode = flexnvm_convert_start_address(config, start);
    if (returnCode != kStatus_FTFx_Success)
    {
        return returnCode;
    }
 
    return FTFx_CMD_Program(&config->ftfxConfig, start, src, lengthInBytes);
}

Referenced by intFlashWrite().

Here is the call graph for this function:

Here is the caller graph for this function:

FLEXNVM_DflashProgramSection()

status_t FLEXNVM_DflashProgramSection	(	flexnvm_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 141 of file fsl_ftfx_flexnvm.c.

{
    status_t returnCode;
    returnCode = flexnvm_convert_start_address(config, start);
    if (returnCode != kStatus_FTFx_Success)
    {
        return returnCode;
    }
 
    return FTFx_CMD_ProgramSection(&config->ftfxConfig, start, src, lengthInBytes);
}

Here is the call graph for this function:

FLEXNVM_DflashSetProtection()

status_t FLEXNVM_DflashSetProtection	(	flexnvm_config_t *	config,
		uint8_t	protectStatus
	)

Sets the DFlash protection to the intended protection status.

Parameters

config

A pointer to the storage for the driver runtime state.

protectStatus

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_CommandNotSupported	Flash API is not supported.
kStatus_FTFx_CommandFailure	Run-time error during command execution.

Definition at line 305 of file fsl_ftfx_flexnvm.c.

{
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    if ((config->ftfxConfig.flashDesc.totalSize == 0) || (config->ftfxConfig.flashDesc.totalSize == 0xFFFFFFFFU))
    {
        return kStatus_FTFx_CommandNotSupported;
    }
 
    FTFx->FDPROT = protectStatus;
 
    if (FTFx->FDPROT != protectStatus)
    {
        return kStatus_FTFx_CommandFailure;
    }
 
    return kStatus_FTFx_Success;
}

FLEXNVM_DflashVerifyErase()

status_t FLEXNVM_DflashVerifyErase	(	flexnvm_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 173 of file fsl_ftfx_flexnvm.c.

{
    status_t returnCode;
    returnCode = flexnvm_convert_start_address(config, start);
    if (returnCode != kStatus_FTFx_Success)
    {
        return returnCode;
    }
 
    return FTFx_CMD_VerifyErase(&config->ftfxConfig, start, lengthInBytes, margin);
}

Here is the call graph for this function:

FLEXNVM_DflashVerifyProgram()

status_t FLEXNVM_DflashVerifyProgram	(	flexnvm_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 190 of file fsl_ftfx_flexnvm.c.

{
    status_t returnCode;
    returnCode = flexnvm_convert_start_address(config, start);
    if (returnCode != kStatus_FTFx_Success)
    {
        return returnCode;
    }
 
    return FTFx_CMD_VerifyProgram(&config->ftfxConfig, start, lengthInBytes, expectedData, margin, failedAddress, failedData);
}

Referenced by intFlashCompare().

Here is the call graph for this function:

Here is the caller graph for this function:

FLEXNVM_EepromGetProtection()

status_t FLEXNVM_EepromGetProtection	(	flexnvm_config_t *	config,
		uint8_t *	protectStatus
	)

Gets the EEPROM protection status.

Parameters

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_CommandNotSupported	Flash API is not supported.

Definition at line 366 of file fsl_ftfx_flexnvm.c.

{
    if ((config == NULL) || (protectStatus == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    if ((config->ftfxConfig.eepromTotalSize == 0) || (config->ftfxConfig.eepromTotalSize == 0xFFFFU))
    {
        return kStatus_FTFx_CommandNotSupported;
    }
 
    *protectStatus = FTFx->FEPROT;
 
    return kStatus_FTFx_Success;
}

FLEXNVM_EepromSetProtection()

status_t FLEXNVM_EepromSetProtection	(	flexnvm_config_t *	config,
		uint8_t	protectStatus
	)

Sets the EEPROM protection to the intended protection status.

Parameters

config

A pointer to the storage for the driver runtime state.

protectStatus

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

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_CommandNotSupported	Flash API is not supported.
kStatus_FTFx_CommandFailure	Run-time error during command execution.

Definition at line 344 of file fsl_ftfx_flexnvm.c.

{
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    if ((config->ftfxConfig.eepromTotalSize == 0) || (config->ftfxConfig.eepromTotalSize == 0xFFFFU))
    {
        return kStatus_FTFx_CommandNotSupported;
    }
 
    FTFx->FEPROT = protectStatus;
 
    if (FTFx->FEPROT != protectStatus)
    {
        return kStatus_FTFx_CommandFailure;
    }
 
    return kStatus_FTFx_Success;
}

FLEXNVM_EepromWrite()

status_t FLEXNVM_EepromWrite	(	flexnvm_config_t *	config,
		uint32_t	start,
		uint8_t *	src,
		uint32_t	lengthInBytes
	)

Programs the EEPROM with data at locations passed in through parameters.

This function programs the emulated EEPROM 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_AddressError	Address is out of range.
kStatus_FTFx_SetFlexramAsEepromError	Failed to set flexram as eeprom.
kStatus_FTFx_ProtectionViolation	The program/erase operation is requested to execute on protected areas.
kStatus_FTFx_RecoverFlexramAsRamError	Failed to recover the FlexRAM as RAM.

Definition at line 225 of file fsl_ftfx_flexnvm.c.

{
    status_t returnCode;
    bool needSwitchFlexRamMode = false;
 
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    /* Validates the range of the given address */
    if ((start < config->ftfxConfig.flexramBlockBase) ||
        ((start + lengthInBytes) > (config->ftfxConfig.flexramBlockBase + config->ftfxConfig.eepromTotalSize)))
    {
        return kStatus_FTFx_AddressError;
    }
 
    returnCode = kStatus_FTFx_Success;
 
    /* Switch function of FlexRAM if needed */
    if (!(FTFx->FCNFG & FTFx_FCNFG_EEERDY_MASK))
    {
        needSwitchFlexRamMode = true;
 
        returnCode = FTFx_CMD_SetFlexramFunction(&config->ftfxConfig, kFTFx_FlexramFuncOptAvailableForEeprom);
        if (returnCode != kStatus_FTFx_Success)
        {
            return kStatus_FTFx_SetFlexramAsEepromError;
        }
    }
 
    /* Write data to FlexRAM when it is used as EEPROM emulator */
    while (lengthInBytes > 0)
    {
        if ((!(start & 0x3U)) && (lengthInBytes >= 4))
        {
            *(uint32_t *)start = *(uint32_t *)src;
            start += 4;
            src += 4;
            lengthInBytes -= 4;
        }
        else if ((!(start & 0x1U)) && (lengthInBytes >= 2))
        {
            *(uint16_t *)start = *(uint16_t *)src;
            start += 2;
            src += 2;
            lengthInBytes -= 2;
        }
        else
        {
            *(uint8_t *)start = *src;
            start += 1;
            src += 1;
            lengthInBytes -= 1;
        }
        /* Wait till EEERDY bit is set */
        while (!(FTFx->FCNFG & FTFx_FCNFG_EEERDY_MASK))
        {
        }
 
        /* Check for protection violation error */
        if (FTFx->FSTAT & FTFx_FSTAT_FPVIOL_MASK)
        {
            return kStatus_FTFx_ProtectionViolation;
        }
    }
 
    /* Switch function of FlexRAM if needed */
    if (needSwitchFlexRamMode)
    {
        returnCode = FTFx_CMD_SetFlexramFunction(&config->ftfxConfig, kFTFx_FlexramFuncOptAvailableAsRam);
        if (returnCode != kStatus_FTFx_Success)
        {
            return kStatus_FTFx_RecoverFlexramAsRamError;
        }
    }
 
    return returnCode;
}

Here is the call graph for this function:

FLEXNVM_EraseAll()

status_t FLEXNVM_EraseAll	(	flexnvm_config_t *	config,
		uint32_t	key
	)

Erases entire flexnvm.

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 116 of file fsl_ftfx_flexnvm.c.

{
    return FTFx_CMD_EraseAll(&config->ftfxConfig, key);
}

Here is the call graph for this function:

FLEXNVM_EraseAllUnsecure()

status_t FLEXNVM_EraseAllUnsecure	(	flexnvm_config_t *	config,
		uint32_t	key
	)

Erases the entire flexnvm, 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 122 of file fsl_ftfx_flexnvm.c.

{
    return FTFx_CMD_EraseAllUnsecure(&config->ftfxConfig, key);
}

Here is the call graph for this function:

FLEXNVM_GetProperty()

status_t FLEXNVM_GetProperty	(	flexnvm_config_t *	config,
		flexnvm_property_tag_t	whichProperty,
		uint32_t *	value
	)

Returns the desired flexnvm property.

Parameters

config	A pointer to the storage for the driver runtime state.
whichProperty	The desired property from the list of properties in enum flexnvm_property_tag_t
value	A pointer to the value returned for the desired flexnvm property.

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_UnknownProperty	An unknown property tag.

Definition at line 383 of file fsl_ftfx_flexnvm.c.

{
    if ((config == NULL) || (value == NULL))
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    switch (whichProperty)
    {
        case kFLEXNVM_PropertyDflashSectorSize:
            *value = config->ftfxConfig.flashDesc.sectorSize;
            break;
        case kFLEXNVM_PropertyDflashTotalSize:
            *value = config->ftfxConfig.flashDesc.totalSize;
            break;
        case kFLEXNVM_PropertyDflashBlockSize:
            *value = config->ftfxConfig.flashDesc.totalSize / config->ftfxConfig.flashDesc.blockCount;
            break;
        case kFLEXNVM_PropertyDflashBlockCount:
            *value = config->ftfxConfig.flashDesc.blockCount;
            break;
        case kFLEXNVM_PropertyDflashBlockBaseAddr:
            *value = config->ftfxConfig.flashDesc.blockBase;
            break;
        case kFLEXNVM_PropertyFlexRamBlockBaseAddr:
            *value = config->ftfxConfig.flexramBlockBase;
            break;
        case kFLEXNVM_PropertyFlexRamTotalSize:
            *value = config->ftfxConfig.flexramTotalSize;
            break;
        case kFLEXNVM_PropertyEepromTotalSize:
            *value = config->ftfxConfig.eepromTotalSize;
            break;
 
        default: /* catch inputs that are not recognized */
            return kStatus_FTFx_UnknownProperty;
    }
 
    return kStatus_FTFx_Success;
}

Referenced by flashPrintStatus().

Here is the caller graph for this function:

FLEXNVM_GetSecurityState()

status_t FLEXNVM_GetSecurityState	(	flexnvm_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 208 of file fsl_ftfx_flexnvm.c.

{
    return FTFx_REG_GetSecurityState(&config->ftfxConfig, state);
}

Referenced by flashInit().

Here is the call graph for this function:

Here is the caller graph for this function:

FLEXNVM_Init()

status_t FLEXNVM_Init

(

flexnvm_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.
kStatus_FTFx_PartitionStatusUpdateFailure	Failed to update the partition status.

Definition at line 64 of file fsl_ftfx_flexnvm.c.

{
    status_t returnCode;
 
    if (config == NULL)
    {
        return kStatus_FTFx_InvalidArgument;
    }
 
    config->ftfxConfig.flashDesc.type = kFTFx_MemTypeFlexnvm;
    config->ftfxConfig.flashDesc.index = 0;
 
    /* Set Flexnvm memory operation parameters */
    config->ftfxConfig.opsConfig.addrAligment.blockWriteUnitSize = FSL_FEATURE_FLASH_FLEX_NVM_BLOCK_WRITE_UNIT_SIZE;
    config->ftfxConfig.opsConfig.addrAligment.sectorCmd = FSL_FEATURE_FLASH_FLEX_NVM_SECTOR_CMD_ADDRESS_ALIGMENT;
    config->ftfxConfig.opsConfig.addrAligment.sectionCmd = FSL_FEATURE_FLASH_FLEX_NVM_SECTION_CMD_ADDRESS_ALIGMENT;
    config->ftfxConfig.opsConfig.addrAligment.resourceCmd = FSL_FEATURE_FLASH_FLEX_NVM_RESOURCE_CMD_ADDRESS_ALIGMENT;
    config->ftfxConfig.opsConfig.addrAligment.checkCmd = FSL_FEATURE_FLASH_FLEX_NVM_CHECK_CMD_ADDRESS_ALIGMENT;
 
    /* Set Flexnvm memory properties */
    config->ftfxConfig.flashDesc.blockBase = FSL_FEATURE_FLASH_FLEX_NVM_START_ADDRESS;
    config->ftfxConfig.flashDesc.sectorSize = FSL_FEATURE_FLASH_FLEX_NVM_BLOCK_SECTOR_SIZE;
    config->ftfxConfig.flashDesc.blockCount = FSL_FEATURE_FLASH_FLEX_NVM_BLOCK_COUNT;
 
    /* Init FTFx Kernel */
    returnCode = FTFx_API_Init(&config->ftfxConfig);
    if (returnCode != kStatus_FTFx_Success)
    {
        return returnCode;
    }
 
    returnCode = FTFx_API_UpdateFlexnvmPartitionStatus(&config->ftfxConfig);
    if (returnCode != kStatus_FTFx_Success)
    {
        return returnCode;
    }
 
    return kStatus_FTFx_Success;
}

Referenced by flashInit().

Here is the call graph for this function:

Here is the caller graph for this function:

FLEXNVM_ProgramPartition()

status_t FLEXNVM_ProgramPartition	(	flexnvm_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 154 of file fsl_ftfx_flexnvm.c.

{
    return FTFx_CMD_ProgramPartition(&config->ftfxConfig, option, eepromDataSizeCode, flexnvmPartitionCode);
}

Here is the call graph for this function:

FLEXNVM_ReadResource()

status_t FLEXNVM_ReadResource	(	flexnvm_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 163 of file fsl_ftfx_flexnvm.c.

{
    return FTFx_CMD_ReadResource(&config->ftfxConfig, start, dst, lengthInBytes, option);
}

Here is the call graph for this function:

FLEXNVM_SecurityBypass()

status_t FLEXNVM_SecurityBypass	(	flexnvm_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 213 of file fsl_ftfx_flexnvm.c.

{
    return FTFx_CMD_SecurityBypass(&config->ftfxConfig, backdoorKey);
}

Here is the call graph for this function:

FLEXNVM_SetFlexramFunction()

status_t FLEXNVM_SetFlexramFunction	(	flexnvm_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 219 of file fsl_ftfx_flexnvm.c.

{
    return FTFx_CMD_SetFlexramFunction(&config->ftfxConfig, option);
}

Here is the call graph for this function:

FLEXNVM_VerifyEraseAll()

status_t FLEXNVM_VerifyEraseAll	(	flexnvm_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 185 of file fsl_ftfx_flexnvm.c.

{
    return FTFx_CMD_VerifyEraseAll(&config->ftfxConfig, margin);
}

Here is the call graph for this function:

Variable Documentation

ftfxConfig

ftfx_config_t _flexnvm_config::ftfxConfig

Definition at line 81 of file fsl_ftfx_flexnvm.h.