/*
* Copyright 2013-2016 Freescale Semiconductor, Inc.
* Copyright 2016-2020 NXP
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*
*/
#ifndef FSL_FTFX_FLEXNVM_H
#define FSL_FTFX_FLEXNVM_H
#include "fsl_ftfx_controller.h"
/*!
* @addtogroup ftfx_flexnvm_driver
* @{
*/
/*******************************************************************************
* Definitions
******************************************************************************/
/*!
* @name Flexnvm version
* @{
*/
/*! @brief Flexnvm driver version for SDK*/
#define FSL_FLEXNVM_DRIVER_VERSION (MAKE_VERSION(3, 0, 2)) /*!< Version 3.0.2. */
/*@}*/
/*!
* @brief Enumeration for various flexnvm properties.
*/
typedef enum _flexnvm_property_tag
{
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_PropertyAliasDflashBlockBaseAddr = 0x05U, /*!< Dflash block base address Alias property.*/
kFLEXNVM_PropertyFlexRamBlockBaseAddr = 0x06U, /*!< FlexRam block base address property.*/
kFLEXNVM_PropertyFlexRamTotalSize = 0x07U, /*!< FlexRam total size property.*/
kFLEXNVM_PropertyEepromTotalSize = 0x08U, /*!< EEPROM total size property.*/
} flexnvm_property_tag_t;
/*! @brief 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.
*/
typedef struct _flexnvm_config
{
ftfx_config_t ftfxConfig;
} flexnvm_config_t;
/*******************************************************************************
* API
******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
/*!
* @name Initialization
* @{
*/
/*!
* @brief Initializes the global flash properties structure members.
*
* This function checks and initializes the Flash module for the other Flash APIs.
*
* @param config Pointer to the storage for the driver runtime state.
*
* @retval #kStatus_FTFx_Success API was executed successfully.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_PartitionStatusUpdateFailure Failed to update the partition status.
*/
status_t FLEXNVM_Init(flexnvm_config_t *config);
/*@}*/
/*!
* @name Erasing
* @{
*/
/*!
* @brief 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.
*
* @param config The pointer to the storage for the driver runtime state.
* @param 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.
* @param lengthInBytes The length, given in bytes (not words or long-words)
* to be erased. Must be word-aligned.
* @param key The value used to validate all flash erase APIs.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the appropriate number of date flash sectors based on
* the desired start address and length were erased successfully.
*
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_AlignmentError The parameter is not aligned with the specified baseline.
* @retval #kStatus_FTFx_AddressError The address is out of range.
* @retval #kStatus_FTFx_EraseKeyError The API erase key is invalid.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.
*/
status_t FLEXNVM_DflashErase(flexnvm_config_t *config, uint32_t start, uint32_t lengthInBytes, uint32_t key);
/*!
* @brief Erases entire flexnvm
*
* @param config Pointer to the storage for the driver runtime state.
* @param key A value used to validate all flash erase APIs.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the entire flexnvm has been erased successfully.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_EraseKeyError API erase key is invalid.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.
* @retval #kStatus_FTFx_PartitionStatusUpdateFailure Failed to update the partition status.
*/
status_t FLEXNVM_EraseAll(flexnvm_config_t *config, uint32_t key);
#if defined(FSL_FEATURE_FLASH_HAS_ERASE_ALL_BLOCKS_UNSECURE_CMD) && FSL_FEATURE_FLASH_HAS_ERASE_ALL_BLOCKS_UNSECURE_CMD
/*!
* @brief Erases the entire flexnvm, including protected sectors.
*
* @param config Pointer to the storage for the driver runtime state.
* @param key A value used to validate all flash erase APIs.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the flexnvm is not in securityi state.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_EraseKeyError API erase key is invalid.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.
* @retval #kStatus_FTFx_PartitionStatusUpdateFailure Failed to update the partition status.
*/
status_t FLEXNVM_EraseAllUnsecure(flexnvm_config_t *config, uint32_t key);
#endif /* FSL_FEATURE_FLASH_HAS_ERASE_ALL_BLOCKS_UNSECURE_CMD */
/*@}*/
/*!
* @name Programming
* @{
*/
/*!
* @brief 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.
*
* @param config A pointer to the storage for the driver runtime state.
* @param start The start address of the desired flash memory to be programmed. Must be
* word-aligned.
* @param src A pointer to the source buffer of data that is to be programmed
* into the flash.
* @param lengthInBytes The length, given in bytes (not words or long-words),
* to be programmed. Must be word-aligned.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the desired date have been successfully
* programed into specified date flash region.
*
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with the specified baseline.
* @retval #kStatus_FTFx_AddressError Address is out of range.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.
*/
status_t FLEXNVM_DflashProgram(flexnvm_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes);
#if defined(FSL_FEATURE_FLASH_HAS_PROGRAM_SECTION_CMD) && FSL_FEATURE_FLASH_HAS_PROGRAM_SECTION_CMD
/*!
* @brief 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.
*
* @param config A pointer to the storage for the driver runtime state.
* @param start The start address of the desired flash memory to be programmed. Must be
* word-aligned.
* @param src A pointer to the source buffer of data that is to be programmed
* into the flash.
* @param lengthInBytes The length, given in bytes (not words or long-words),
* to be programmed. Must be word-aligned.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the desired date have been successfully
* programed into specified date flash area.
*
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with specified baseline.
* @retval #kStatus_FTFx_AddressError Address is out of range.
* @retval #kStatus_FTFx_SetFlexramAsRamError Failed to set flexram as RAM.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.
* @retval #kStatus_FTFx_RecoverFlexramAsEepromError Failed to recover FlexRAM as EEPROM.
*/
status_t FLEXNVM_DflashProgramSection(flexnvm_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes);
#endif /* FSL_FEATURE_FLASH_HAS_PROGRAM_SECTION_CMD */
/*!
* @brief Prepares the FlexNVM block for use as data flash, EEPROM backup, or a combination of both and initializes the
* FlexRAM.
*
* @param config Pointer to storage for the driver runtime state.
* @param option The option used to set FlexRAM load behavior during reset.
* @param eepromDataSizeCode Determines the amount of FlexRAM used in each of the available EEPROM subsystems.
* @param flexnvmPartitionCode Specifies how to split the FlexNVM block between data flash memory and EEPROM backup
* memory supporting EEPROM functions.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the FlexNVM block for use as data flash, EEPROM backup,
* or a combination of both have been Prepared.
*
* @retval #kStatus_FTFx_InvalidArgument Invalid argument is provided.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.
*/
status_t FLEXNVM_ProgramPartition(flexnvm_config_t *config,
ftfx_partition_flexram_load_opt_t option,
uint32_t eepromDataSizeCode,
uint32_t flexnvmPartitionCode);
/*@}*/
/*!
* @name Reading
* @{
*/
#if defined(FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD) && FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD
/*!
* @brief 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.
*
* @param config A pointer to the storage for the driver runtime state.
* @param start The start address of the desired flash memory to be programmed. Must be
* word-aligned.
* @param dst A pointer to the destination buffer of data that is used to store
* data to be read.
* @param lengthInBytes The length, given in bytes (not words or long-words),
* to be read. Must be word-aligned.
* @param option The resource option which indicates which area should be read back.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the data have been read successfully from
* program flash IFR, data flash IFR space, and the Version ID field
*
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with the specified baseline.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.
*/
status_t FLEXNVM_ReadResource(
flexnvm_config_t *config, uint32_t start, uint8_t *dst, uint32_t lengthInBytes, ftfx_read_resource_opt_t option);
#endif /* FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD */
/*@}*/
/*!
* @name Verification
* @{
*/
/*!
* @brief 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.
*
* @param config A pointer to the storage for the driver runtime state.
* @param 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.
* @param lengthInBytes The length, given in bytes (not words or long-words),
* to be verified. Must be word-aligned.
* @param margin Read margin choice.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the specified data flash region is in erased state.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with specified baseline.
* @retval #kStatus_FTFx_AddressError Address is out of range.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.
*/
status_t FLEXNVM_DflashVerifyErase(flexnvm_config_t *config,
uint32_t start,
uint32_t lengthInBytes,
ftfx_margin_value_t margin);
/*!
* @brief 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.
*
* @param config A pointer to the storage for the driver runtime state.
* @param margin Read margin choice.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the entire flexnvm region is in erased state.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.
*/
status_t FLEXNVM_VerifyEraseAll(flexnvm_config_t *config, ftfx_margin_value_t margin);
/*!
* @brief Verifies programming of the desired flash area at a specified margin level.
*
* This function verifies the data programmed 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.
*
* @param config A pointer to the storage for the driver runtime state.
* @param start The start address of the desired flash memory to be verified. Must be word-aligned.
* @param lengthInBytes The length, given in bytes (not words or long-words),
* to be verified. Must be word-aligned.
* @param expectedData A pointer to the expected data that is to be
* verified against.
* @param margin Read margin choice.
* @param failedAddress A pointer to the returned failing address.
* @param 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.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the desired data hve been programed successfully into
* specified data flash region.
*
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with specified baseline.
* @retval #kStatus_FTFx_AddressError Address is out of range.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.
*/
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);
/*@}*/
/*!
* @name Security
* @{
*/
/*!
* @brief 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.
*
* @param config A pointer to storage for the driver runtime state.
* @param state A pointer to the value returned for the current security status code:
*
* @retval #kStatus_FTFx_Success API was executed successfully;
* the security state of flexnvm was stored to state.
*
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
*/
status_t FLEXNVM_GetSecurityState(flexnvm_config_t *config, ftfx_security_state_t *state);
/*!
* @brief 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.
*
* @param config A pointer to the storage for the driver runtime state.
* @param backdoorKey A pointer to the user buffer containing the backdoor key.
*
* @retval #kStatus_FTFx_Success API was executed successfully.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.
*/
status_t FLEXNVM_SecurityBypass(flexnvm_config_t *config, const uint8_t *backdoorKey);
/*@}*/
/*!
* @name FlexRAM
* @{
*/
#if defined(FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD) && FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD
/*!
* @brief Sets the FlexRAM function command.
*
* @param config A pointer to the storage for the driver runtime state.
* @param option The option used to set the work mode of FlexRAM.
*
* @retval #kStatus_FTFx_Success API was executed successfully;
* the FlexRAM has been successfully configured as RAM or EEPROM
*
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
* @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.
*/
status_t FLEXNVM_SetFlexramFunction(flexnvm_config_t *config, ftfx_flexram_func_opt_t option);
#endif /* FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD */
/*@}*/
/*!
* @brief 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.
*
* @param config A pointer to the storage for the driver runtime state.
* @param start The start address of the desired flash memory to be programmed. Must be
* word-aligned.
* @param src A pointer to the source buffer of data that is to be programmed
* into the flash.
* @param lengthInBytes The length, given in bytes (not words or long-words),
* to be programmed. Must be word-aligned.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the desires data have been successfully programed
* into specified eeprom region.
*
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_AddressError Address is out of range.
* @retval #kStatus_FTFx_SetFlexramAsEepromError Failed to set flexram as eeprom.
* @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.
* @retval #kStatus_FTFx_RecoverFlexramAsRamError Failed to recover the FlexRAM as RAM.
*/
status_t FLEXNVM_EepromWrite(flexnvm_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes);
/*!
* @name Flash Protection Utilities
* @{
*/
/*!
* @brief Sets the DFlash protection to the intended protection status.
*
* @param config A pointer to the storage for the driver runtime state.
* @param 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.
*
* @retval #kStatus_FTFx_Success API was executed successfully; the specified DFlash region is protected.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_CommandNotSupported Flash API is not supported.
* @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.
*/
status_t FLEXNVM_DflashSetProtection(flexnvm_config_t *config, uint8_t protectStatus);
/*!
* @brief Gets the DFlash protection status.
*
* @param config A pointer to the storage for the driver runtime state.
* @param 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.
*
* @retval #kStatus_FTFx_Success API was executed successfully.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_CommandNotSupported Flash API is not supported.
*/
status_t FLEXNVM_DflashGetProtection(flexnvm_config_t *config, uint8_t *protectStatus);
/*!
* @brief Sets the EEPROM protection to the intended protection status.
*
* @param config A pointer to the storage for the driver runtime state.
* @param 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.
*
* @retval #kStatus_FTFx_Success API was executed successfully.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_CommandNotSupported Flash API is not supported.
* @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.
*/
status_t FLEXNVM_EepromSetProtection(flexnvm_config_t *config, uint8_t protectStatus);
/*!
* @brief Gets the EEPROM protection status.
*
* @param config A pointer to the storage for the driver runtime state.
* @param 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.
*
* @retval #kStatus_FTFx_Success API was executed successfully.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_CommandNotSupported Flash API is not supported.
*/
status_t FLEXNVM_EepromGetProtection(flexnvm_config_t *config, uint8_t *protectStatus);
/*@}*/
/*!
* @name Properties
* @{
*/
/*!
* @brief Returns the desired flexnvm property.
*
* @param config A pointer to the storage for the driver runtime state.
* @param whichProperty The desired property from the list of properties in
* enum flexnvm_property_tag_t
* @param value A pointer to the value returned for the desired flexnvm property.
*
* @retval #kStatus_FTFx_Success API was executed successfully.
* @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.
* @retval #kStatus_FTFx_UnknownProperty An unknown property tag.
*/
status_t FLEXNVM_GetProperty(flexnvm_config_t *config, flexnvm_property_tag_t whichProperty, uint32_t *value);
/*@}*/
#if defined(__cplusplus)
}
#endif
/*! @}*/
#endif /* FSL_FTFX_FLEXNVM_H */