yujingyuan
/
NXP_MKV56F512
1
0
Fork 0
Koodi Ongelmat 0 Pull-pyynnöt 0 Julkaisut 0 Wiki Toiminta
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
16 Commitit
1 Haara
1.1 MiB
 
 
 
Puu: 26bad969b1
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '26bad969b1'
${ noResults }
NXP_MKV56F512/drivers/fsl_ftfx_flash.h

664 rivejä
30 KiB
Raaka Blame Historia 

  1. /*

  2.  * Copyright 2013-2016 Freescale Semiconductor, Inc.

  3.  * Copyright 2016-2020 NXP

  4.  * All rights reserved.

  5.  *

  6.  * SPDX-License-Identifier: BSD-3-Clause

  7.  *

  8.  */

  9. 

  10. #ifndef FSL_FTFX_FLASH_H

  11. #define FSL_FTFX_FLASH_H

  12. 

  13. #include "fsl_ftfx_controller.h"

  14. 

  15. /*!

  16.  * @addtogroup ftfx_flash_driver

  17.  * @{

  18.  */

  19. /*******************************************************************************

  20.  * Definitions

  21.  ******************************************************************************/

  22. #define kStatus_FLASH_Success kStatus_FTFx_Success

  23. #define kFLASH_ApiEraseKey kFTFx_ApiEraseKey

  24. 

  25. /*!

  26.  * @name Flash version

  27.  * @{

  28.  */

  29. /*! @brief Flash driver version for SDK*/

  30. #define FSL_FLASH_DRIVER_VERSION (MAKE_VERSION(3U, 0U, 2U)) /*!< Version 3.0.2. */

  31. 

  32. /*! @brief Flash driver version for ROM*/

  33. #define FSL_FLASH_DRIVER_VERSION_ROM (MAKE_VERSION(3U, 0U, 0U)) /*!< Version 3.0.0. */

  34. 

  35. /*@}*/

  36. 

  37. /*!

  38.  * @brief Enumeration for the three possible flash protection levels.

  39.  */

  40. typedef enum _flash_protection_state

  41. {

  42.     kFLASH_ProtectionStateUnprotected, /*!< Flash region is not protected.*/

  43.     kFLASH_ProtectionStateProtected,   /*!< Flash region is protected.*/

  44.     kFLASH_ProtectionStateMixed        /*!< Flash is mixed with protected and unprotected region.*/

  45. } flash_prot_state_t;

  46. 

  47. /*!

  48.  * @brief PFlash protection status

  49.  */

  50. typedef union _pflash_protection_status

  51. {

  52.     uint32_t protl; /*!< PROT[31:0] .*/

  53.     uint32_t proth; /*!< PROT[63:32].*/

  54.     uint8_t protsl; /*!< PROTS[7:0] .*/

  55.     uint8_t protsh; /*!< PROTS[15:8] .*/

  56.     uint8_t reserved[2];

  57. } pflash_prot_status_t;

  58. 

  59. #if defined(FSL_FEATURE_FLASH_HAS_ACCESS_CONTROL) && FSL_FEATURE_FLASH_HAS_ACCESS_CONTROL

  60. /*!

  61.  * @brief Enumeration for the three possible flash execute access levels.

  62.  */

  63. typedef enum _flash_execute_only_access_state

  64. {

  65.     kFLASH_AccessStateUnLimited,   /*!< Flash region is unlimited.*/

  66.     kFLASH_AccessStateExecuteOnly, /*!< Flash region is execute only.*/

  67.     kFLASH_AccessStateMixed        /*!< Flash is mixed with unlimited and execute only region.*/

  68. } flash_xacc_state_t;

  69. #endif /* not define FSL_FEATURE_FLASH_HAS_ACCESS_CONTROL */

  70. 

  71. /*!

  72.  * @brief Enumeration for various flash properties.

  73.  */

  74. typedef enum _flash_property_tag

  75. {

  76.     kFLASH_PropertyPflash0SectorSize         = 0x00U, /*!< Pflash sector size property.*/

  77.     kFLASH_PropertyPflash0TotalSize          = 0x01U, /*!< Pflash total size property.*/

  78.     kFLASH_PropertyPflash0BlockSize          = 0x02U, /*!< Pflash block size property.*/

  79.     kFLASH_PropertyPflash0BlockCount         = 0x03U, /*!< Pflash block count property.*/

  80.     kFLASH_PropertyPflash0BlockBaseAddr      = 0x04U, /*!< Pflash block base address property.*/

  81.     kFLASH_PropertyPflash0FacSupport         = 0x05U, /*!< Pflash fac support property.*/

  82.     kFLASH_PropertyPflash0AccessSegmentSize  = 0x06U, /*!< Pflash access segment size property.*/

  83.     kFLASH_PropertyPflash0AccessSegmentCount = 0x07U, /*!< Pflash access segment count property.*/

  84. 

  85.     kFLASH_PropertyPflash1SectorSize         = 0x10U, /*!< Pflash sector size property.*/

  86.     kFLASH_PropertyPflash1TotalSize          = 0x11U, /*!< Pflash total size property.*/

  87.     kFLASH_PropertyPflash1BlockSize          = 0x12U, /*!< Pflash block size property.*/

  88.     kFLASH_PropertyPflash1BlockCount         = 0x13U, /*!< Pflash block count property.*/

  89.     kFLASH_PropertyPflash1BlockBaseAddr      = 0x14U, /*!< Pflash block base address property.*/

  90.     kFLASH_PropertyPflash1FacSupport         = 0x15U, /*!< Pflash fac support property.*/

  91.     kFLASH_PropertyPflash1AccessSegmentSize  = 0x16U, /*!< Pflash access segment size property.*/

  92.     kFLASH_PropertyPflash1AccessSegmentCount = 0x17U, /*!< Pflash access segment count property.*/

  93. 

  94.     kFLASH_PropertyFlexRamBlockBaseAddr = 0x20U, /*!< FlexRam block base address property.*/

  95.     kFLASH_PropertyFlexRamTotalSize     = 0x21U, /*!< FlexRam total size property.*/

  96. } flash_property_tag_t;

  97. 

  98. /*! @brief Flash driver state information.

  99.  *

  100.  * An instance of this structure is allocated by the user of the flash driver and

  101.  * passed into each of the driver APIs.

  102.  */

  103. typedef struct _flash_config

  104. {

  105.     ftfx_config_t ftfxConfig[FTFx_FLASH_COUNT];

  106. } flash_config_t;

  107. 

  108. /*******************************************************************************

  109.  * API

  110.  ******************************************************************************/

  111. 

  112. #if defined(__cplusplus)

  113. extern "C" {

  114. #endif

  115. 

  116. /*!

  117.  * @name Initialization

  118.  * @{

  119.  */

  120. 

  121. /*!

  122.  * @brief Initializes the global flash properties structure members.

  123.  *

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

  125.  *

  126.  * @param config Pointer to the storage for the driver runtime state.

  127.  *

  128.  * @retval #kStatus_FTFx_Success API was executed successfully.

  129.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  130.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  131.  * @retval #kStatus_FTFx_PartitionStatusUpdateFailure Failed to update the partition status.

  132.  */

  133. status_t FLASH_Init(flash_config_t *config);

  134. 

  135. /*@}*/

  136. 

  137. /*!

  138.  * @name Erasing

  139.  * @{

  140.  */

  141. 

  142. /*!

  143.  * @brief Erases the Dflash sectors encompassed by parameters passed into function.

  144.  *

  145.  * This function erases the appropriate number of flash sectors based on the

  146.  * desired start address and length.

  147.  *

  148.  * @param config The pointer to the storage for the driver runtime state.

  149.  * @param start The start address of the desired flash memory to be erased.

  150.  *              The start address does not need to be sector-aligned but must be word-aligned.

  151.  * @param lengthInBytes The length, given in bytes (not words or long-words)

  152.  *                      to be erased. Must be word-aligned.

  153.  * @param key The value used to validate all flash erase APIs.

  154.  *

  155.  * @retval #kStatus_FTFx_Success API was executed successfully; the appropriate number of flash sectors based on the

  156.  *         desired start address and length were erased successfully.

  157.  *

  158.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  159.  * @retval #kStatus_FTFx_AlignmentError The parameter is not aligned with the specified baseline.

  160.  * @retval #kStatus_FTFx_AddressError The address is out of range.

  161.  * @retval #kStatus_FTFx_EraseKeyError The API erase key is invalid.

  162.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  163.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  164.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  165.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  166.  */

  167. status_t FLASH_Erase(flash_config_t *config, uint32_t start, uint32_t lengthInBytes, uint32_t key);

  168. 

  169. /*!

  170.  * @brief Erases entire flexnvm

  171.  *

  172.  * @param config Pointer to the storage for the driver runtime state.

  173.  * @param key A value used to validate all flash erase APIs.

  174.  *

  175.  * @retval #kStatus_FTFx_Success API was executed successfully; the all pflash and flexnvm were erased successfully,

  176.  *         the swap and eeprom have been reset to unconfigured state.

  177.  *

  178.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  179.  * @retval #kStatus_FTFx_EraseKeyError API erase key is invalid.

  180.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  181.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  182.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  183.  * @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.

  184.  * @retval #kStatus_FTFx_PartitionStatusUpdateFailure Failed to update the partition status.

  185.  */

  186. status_t FLASH_EraseAll(flash_config_t *config, uint32_t key);

  187. 

  188. #if defined(FSL_FEATURE_FLASH_HAS_ERASE_ALL_BLOCKS_UNSECURE_CMD) && FSL_FEATURE_FLASH_HAS_ERASE_ALL_BLOCKS_UNSECURE_CMD

  189. /*!

  190.  * @brief Erases the entire flexnvm, including protected sectors.

  191.  *

  192.  * @param config Pointer to the storage for the driver runtime state.

  193.  * @param key A value used to validate all flash erase APIs.

  194.  *

  195.  * @retval #kStatus_FTFx_Success API was executed successfully;

  196.  *         the protected sectors of flash were reset to unprotected status.

  197.  *

  198.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  199.  * @retval #kStatus_FTFx_EraseKeyError API erase key is invalid.

  200.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  201.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  202.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  203.  * @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.

  204.  * @retval #kStatus_FTFx_PartitionStatusUpdateFailure Failed to update the partition status.

  205.  */

  206. status_t FLASH_EraseAllUnsecure(flash_config_t *config, uint32_t key);

  207. #endif /* FSL_FEATURE_FLASH_HAS_ERASE_ALL_BLOCKS_UNSECURE_CMD */

  208. 

  209. /*@}*/

  210. 

  211. /*!

  212.  * @name Programming

  213.  * @{

  214.  */

  215. 

  216. /*!

  217.  * @brief Programs flash with data at locations passed in through parameters.

  218.  *

  219.  * This function programs the flash memory with the desired data for a given

  220.  * flash area as determined by the start address and the length.

  221.  *

  222.  * @param config A pointer to the storage for the driver runtime state.

  223.  * @param start The start address of the desired flash memory to be programmed. Must be

  224.  *              word-aligned.

  225.  * @param src A pointer to the source buffer of data that is to be programmed

  226.  *            into the flash.

  227.  * @param lengthInBytes The length, given in bytes (not words or long-words),

  228.  *                      to be programmed. Must be word-aligned.

  229.  *

  230.  * @retval #kStatus_FTFx_Success API was executed successfully; the desired data were programed successfully

  231.  *         into flash based on desired start address and length.

  232.  *

  233.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  234.  * @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with the specified baseline.

  235.  * @retval #kStatus_FTFx_AddressError Address is out of range.

  236.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  237.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  238.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  239.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  240.  */

  241. status_t FLASH_Program(flash_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes);

  242. 

  243. /*!

  244.  * @brief Program the Program-Once-Field through parameters.

  245.  *

  246.  * This function Program the Program-once-feild with given index and length.

  247.  *

  248.  * @param config A pointer to the storage for the driver runtime state.

  249.  * @param index The index indicating the area of program once field to be read.

  250.  * @param src A pointer to the source buffer of data that is used to store

  251.  *        data to be write.

  252.  * @param lengthInBytes The length, given in bytes (not words or long-words),

  253.  *        to be programmed. Must be word-aligned.

  254.  *

  255.  * @retval #kStatus_FTFx_Success API was executed successfully; The index indicating the area

  256.  *         of program once field was programed successfully.

  257.  *

  258.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  259.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  260.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  261.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  262.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  263.  */

  264. status_t FLASH_ProgramOnce(flash_config_t *config, uint32_t index, uint8_t *src, uint32_t lengthInBytes);

  265. 

  266. #if defined(FSL_FEATURE_FLASH_HAS_PROGRAM_SECTION_CMD) && FSL_FEATURE_FLASH_HAS_PROGRAM_SECTION_CMD

  267. /*!

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

  269.  *

  270.  * This function programs the flash memory with the desired data for a given

  271.  * flash area as determined by the start address and length.

  272.  *

  273.  * @param config A pointer to the storage for the driver runtime state.

  274.  * @param start The start address of the desired flash memory to be programmed. Must be

  275.  *              word-aligned.

  276.  * @param src A pointer to the source buffer of data that is to be programmed

  277.  *            into the flash.

  278.  * @param lengthInBytes The length, given in bytes (not words or long-words),

  279.  *                      to be programmed. Must be word-aligned.

  280.  *

  281.  * @retval #kStatus_FTFx_Success API was executed successfully; the desired data have been programed successfully into

  282.  *         flash based on start address and length.

  283.  *

  284.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  285.  * @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with specified baseline.

  286.  * @retval #kStatus_FTFx_AddressError Address is out of range.

  287.  * @retval #kStatus_FTFx_SetFlexramAsRamError Failed to set flexram as RAM.

  288.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  289.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  290.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  291.  * @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.

  292.  * @retval #kStatus_FTFx_RecoverFlexramAsEepromError Failed to recover FlexRAM as EEPROM.

  293.  */

  294. status_t FLASH_ProgramSection(flash_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes);

  295. #endif /* FSL_FEATURE_FLASH_HAS_PROGRAM_SECTION_CMD */

  296. 

  297. /*@}*/

  298. 

  299. /*!

  300.  * @name Reading

  301.  * @{

  302.  */

  303. 

  304. #if defined(FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD) && FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD

  305. /*!

  306.  * @brief Reads the resource with data at locations passed in through parameters.

  307.  *

  308.  * This function reads the flash memory with the desired location for a given

  309.  * flash area as determined by the start address and length.

  310.  *

  311.  * @param config A pointer to the storage for the driver runtime state.

  312.  * @param start The start address of the desired flash memory to be programmed. Must be

  313.  *              word-aligned.

  314.  * @param dst A pointer to the destination buffer of data that is used to store

  315.  *        data to be read.

  316.  * @param lengthInBytes The length, given in bytes (not words or long-words),

  317.  *        to be read. Must be word-aligned.

  318.  * @param option The resource option which indicates which area should be read back.

  319.  *

  320.  * @retval #kStatus_FTFx_Success API was executed successfully;  the data have been read successfully from

  321.  *         program flash IFR, data flash IFR space, and the Version ID field.

  322.  *

  323.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  324.  * @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with the specified baseline.

  325.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  326.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  327.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  328.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  329.  */

  330. status_t FLASH_ReadResource(

  331.     flash_config_t *config, uint32_t start, uint8_t *dst, uint32_t lengthInBytes, ftfx_read_resource_opt_t option);

  332. #endif /* FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD */

  333. 

  334. /*!

  335.  * @brief Reads the Program Once Field through parameters.

  336.  *

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

  338.  *

  339.  * @param config A pointer to the storage for the driver runtime state.

  340.  * @param index The index indicating the area of program once field to be read.

  341.  * @param dst A pointer to the destination buffer of data that is used to store

  342.  *        data to be read.

  343.  * @param lengthInBytes The length, given in bytes (not words or long-words),

  344.  *        to be programmed. Must be word-aligned.

  345.  *

  346.  * @retval #kStatus_FTFx_Success API was executed successfully; the data have been successfuly

  347.  *         read form Program flash0 IFR map and Program Once field based on index and length.

  348. 

  349.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  350.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  351.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  352.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  353.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  354.  */

  355. status_t FLASH_ReadOnce(flash_config_t *config, uint32_t index, uint8_t *dst, uint32_t lengthInBytes);

  356. 

  357. /*@}*/

  358. 

  359. /*!

  360.  * @name Verification

  361.  * @{

  362.  */

  363. 

  364. /*!

  365.  * @brief Verifies an erasure of the desired flash area at a specified margin level.

  366.  *

  367.  * This function checks the appropriate number of flash sectors based on

  368.  * the desired start address and length to check whether the flash is erased

  369.  * to the specified read margin level.

  370.  *

  371.  * @param config A pointer to the storage for the driver runtime state.

  372.  * @param start The start address of the desired flash memory to be verified.

  373.  *        The start address does not need to be sector-aligned but must be word-aligned.

  374.  * @param lengthInBytes The length, given in bytes (not words or long-words),

  375.  *        to be verified. Must be word-aligned.

  376.  * @param margin Read margin choice.

  377.  *

  378.  * @retval #kStatus_FTFx_Success API was executed successfully; the specified FLASH region has been erased.

  379.  *

  380.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  381.  * @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with specified baseline.

  382.  * @retval #kStatus_FTFx_AddressError Address is out of range.

  383.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  384.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  385.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  386.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  387.  */

  388. status_t FLASH_VerifyErase(flash_config_t *config, uint32_t start, uint32_t lengthInBytes, ftfx_margin_value_t margin);

  389. 

  390. /*!

  391.  * @brief Verifies erasure of the entire flash at a specified margin level.

  392.  *

  393.  * This function checks whether the flash is erased to the

  394.  * specified read margin level.

  395.  *

  396.  * @param config A pointer to the storage for the driver runtime state.

  397.  * @param margin Read margin choice.

  398.  *

  399.  * @retval #kStatus_FTFx_Success API was executed successfully; all program flash and flexnvm were in erased state.

  400.  *

  401.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  402.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  403.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  404.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  405.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  406.  */

  407. status_t FLASH_VerifyEraseAll(flash_config_t *config, ftfx_margin_value_t margin);

  408. 

  409. /*!

  410.  * @brief Verifies programming of the desired flash area at a specified margin level.

  411.  *

  412.  * This function verifies the data programmed in the flash memory using the

  413.  * Flash Program Check Command and compares it to the expected data for a given

  414.  * flash area as determined by the start address and length.

  415.  *

  416.  * @param config A pointer to the storage for the driver runtime state.

  417.  * @param start The start address of the desired flash memory to be verified. Must be word-aligned.

  418.  * @param lengthInBytes The length, given in bytes (not words or long-words),

  419.  *        to be verified. Must be word-aligned.

  420.  * @param expectedData A pointer to the expected data that is to be

  421.  *        verified against.

  422.  * @param margin Read margin choice.

  423.  * @param failedAddress A pointer to the returned failing address.

  424.  * @param failedData A pointer to the returned failing data.  Some derivatives do

  425.  *        not include failed data as part of the FCCOBx registers.  In this

  426.  *        case, zeros are returned upon failure.

  427.  *

  428.  * @retval #kStatus_FTFx_Success API was executed successfully; the desired data have been successfully programed into

  429.  *         specified FLASH region.

  430.  *

  431.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  432.  * @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with specified baseline.

  433.  * @retval #kStatus_FTFx_AddressError Address is out of range.

  434.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  435.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  436.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  437.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  438.  */

  439. status_t FLASH_VerifyProgram(flash_config_t *config,

  440.                              uint32_t start,

  441.                              uint32_t lengthInBytes,

  442.                              const uint8_t *expectedData,

  443.                              ftfx_margin_value_t margin,

  444.                              uint32_t *failedAddress,

  445.                              uint32_t *failedData);

  446. 

  447. /*@}*/

  448. 

  449. /*!

  450.  * @name Security

  451.  * @{

  452.  */

  453. 

  454. /*!

  455.  * @brief Returns the security state via the pointer passed into the function.

  456.  *

  457.  * This function retrieves the current flash security status, including the

  458.  * security enabling state and the backdoor key enabling state.

  459.  *

  460.  * @param config A pointer to storage for the driver runtime state.

  461.  * @param state A pointer to the value returned for the current security status code:

  462.  *

  463.  * @retval #kStatus_FTFx_Success API was executed successfully; the security state of flash was stored to state.

  464.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  465.  */

  466. status_t FLASH_GetSecurityState(flash_config_t *config, ftfx_security_state_t *state);

  467. 

  468. /*!

  469.  * @brief Allows users to bypass security with a backdoor key.

  470.  *

  471.  * If the MCU is in secured state, this function unsecures the MCU by

  472.  * comparing the provided backdoor key with ones in the flash configuration

  473.  * field.

  474.  *

  475.  * @param config A pointer to the storage for the driver runtime state.

  476.  * @param backdoorKey A pointer to the user buffer containing the backdoor key.

  477.  *

  478.  * @retval #kStatus_FTFx_Success API was executed successfully.

  479.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  480.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  481.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  482.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  483.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  484.  */

  485. status_t FLASH_SecurityBypass(flash_config_t *config, const uint8_t *backdoorKey);

  486. 

  487. /*@}*/

  488. 

  489. /*!

  490.  * @name FlexRAM

  491.  * @{

  492.  */

  493. 

  494. #if defined(FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD) && FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD

  495. /*!

  496.  * @brief Sets the FlexRAM function command.

  497.  *

  498.  * @param config A pointer to the storage for the driver runtime state.

  499.  * @param option The option used to set the work mode of FlexRAM.

  500.  *

  501.  * @retval #kStatus_FTFx_Success API was executed successfully; the FlexRAM has been successfully configured as RAM or

  502.  * EEPROM.

  503.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  504.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  505.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  506.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  507.  * @retval #kStatus_FTFx_CommandFailure Run-time error during the command execution.

  508.  */

  509. status_t FLASH_SetFlexramFunction(flash_config_t *config, ftfx_flexram_func_opt_t option);

  510. #endif /* FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD */

  511. 

  512. /*@}*/

  513. 

  514. /*!

  515.  * @name Swap

  516.  * @{

  517.  */

  518. 

  519. #if defined(FSL_FEATURE_FLASH_HAS_PFLASH_BLOCK_SWAP) && FSL_FEATURE_FLASH_HAS_PFLASH_BLOCK_SWAP

  520. /*!

  521.  * @brief Swaps the lower half flash with the higher half flash.

  522.  *

  523.  * @param config A pointer to the storage for the driver runtime state.

  524.  * @param address Address used to configure the flash swap function

  525.  * @param isSetEnable The possible option used to configure the Flash Swap function or check the flash Swap status.

  526.  *

  527.  * @retval #kStatus_FTFx_Success API was executed successfully; the lower half flash and higher half flash have been

  528.  * swaped.

  529.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  530.  * @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with specified baseline.

  531.  * @retval #kStatus_FTFx_SwapIndicatorAddressError Swap indicator address is invalid.

  532.  * @retval #kStatus_FTFx_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.

  533.  * @retval #kStatus_FTFx_AccessError Invalid instruction codes and out-of bounds addresses.

  534.  * @retval #kStatus_FTFx_ProtectionViolation The program/erase operation is requested to execute on protected areas.

  535.  * @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.

  536.  * @retval #kStatus_FTFx_SwapSystemNotInUninitialized Swap system is not in an uninitialized state.

  537.  */

  538. status_t FLASH_Swap(flash_config_t *config, uint32_t address, bool isSetEnable);

  539. #endif /* FSL_FEATURE_FLASH_HAS_PFLASH_BLOCK_SWAP */

  540. 

  541. /*@}*/

  542. 

  543. /*!

  544.  * @name Protection

  545.  * @{

  546.  */

  547. 

  548. /*!

  549.  * @brief Returns the protection state of the desired flash area via the pointer passed into the function.

  550.  *

  551.  * This function retrieves the current flash protect status for a given

  552.  * flash area as determined by the start address and length.

  553.  *

  554.  * @param config A pointer to the storage for the driver runtime state.

  555.  * @param start The start address of the desired flash memory to be checked. Must be word-aligned.

  556.  * @param lengthInBytes The length, given in bytes (not words or long-words)

  557.  *        to be checked.  Must be word-aligned.

  558.  * @param protection_state A pointer to the value returned for the current

  559.  *        protection status code for the desired flash area.

  560.  *

  561.  * @retval #kStatus_FTFx_Success API was executed successfully; the protection state of specified FLASH region was

  562.  * stored to protection_state.

  563.  *

  564.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  565.  * @retval #kStatus_FTFx_AlignmentError Parameter is not aligned with specified baseline.

  566.  * @retval #kStatus_FTFx_AddressError The address is out of range.

  567.  */

  568. status_t FLASH_IsProtected(flash_config_t *config,

  569.                            uint32_t start,

  570.                            uint32_t lengthInBytes,

  571.                            flash_prot_state_t *protection_state);

  572. 

  573. #if defined(FSL_FEATURE_FLASH_HAS_ACCESS_CONTROL) && FSL_FEATURE_FLASH_HAS_ACCESS_CONTROL

  574. /*!

  575.  * @brief Returns the access state of the desired flash area via the pointer passed into the function.

  576.  *

  577.  * This function retrieves the current flash access status for a given

  578.  * flash area as determined by the start address and length.

  579.  *

  580.  * @param config A pointer to the storage for the driver runtime state.

  581.  * @param start The start address of the desired flash memory to be checked. Must be word-aligned.

  582.  * @param lengthInBytes The length, given in bytes (not words or long-words),

  583.  *        to be checked.  Must be word-aligned.

  584.  * @param access_state A pointer to the value returned for the current

  585.  *        access status code for the desired flash area.

  586.  *

  587.  * @retval #kStatus_FTFx_Success API was executed successfully; the executeOnly state of specified FLASH region was

  588.  * stored to access_state.

  589.  *

  590.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  591.  * @retval #kStatus_FTFx_AlignmentError The parameter is not aligned to the specified baseline.

  592.  * @retval #kStatus_FTFx_AddressError The address is out of range.

  593.  */

  594. status_t FLASH_IsExecuteOnly(flash_config_t *config,

  595.                              uint32_t start,

  596.                              uint32_t lengthInBytes,

  597.                              flash_xacc_state_t *access_state);

  598. #endif /* FSL_FEATURE_FLASH_HAS_ACCESS_CONTROL */

  599. 

  600. /*!

  601.  * @brief Sets the PFlash Protection to the intended protection status.

  602.  *

  603.  * @param config A pointer to storage for the driver runtime state.

  604.  * @param protectStatus The expected protect status to set to the PFlash protection register. Each bit is

  605.  * corresponding to protection of 1/32(64) of the total PFlash. The least significant bit is corresponding to the lowest

  606.  * address area of PFlash. The most significant bit is corresponding to the highest address area of PFlash. There are

  607.  * two possible cases as shown below:

  608.  *       0: this area is protected.

  609.  *       1: this area is unprotected.

  610.  *

  611.  * @retval #kStatus_FTFx_Success API was executed successfully; the specified FLASH region is protected.

  612.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  613.  * @retval #kStatus_FTFx_CommandFailure Run-time error during command execution.

  614.  */

  615. status_t FLASH_PflashSetProtection(flash_config_t *config, pflash_prot_status_t *protectStatus);

  616. 

  617. /*!

  618.  * @brief Gets the PFlash protection status.

  619.  *

  620.  * @param config A pointer to the storage for the driver runtime state.

  621.  * @param protectStatus  Protect status returned by the PFlash IP. Each bit is corresponding to the protection of

  622.  * 1/32(64)

  623.  * of the

  624.  * total PFlash. The least significant bit corresponds to the lowest address area of the PFlash. The most significant

  625.  * bit corresponds to the highest address area of PFlash. There are two possible cases as shown below:

  626.  *       0: this area is protected.

  627.  *       1: this area is unprotected.

  628.  *

  629.  * @retval #kStatus_FTFx_Success API was executed successfully; the Protection state was stored to protectStatus;

  630.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  631.  */

  632. status_t FLASH_PflashGetProtection(flash_config_t *config, pflash_prot_status_t *protectStatus);

  633. 

  634. /*@}*/

  635. 

  636. /*!

  637.  * @name Properties

  638.  * @{

  639.  */

  640. 

  641. /*!

  642.  * @brief Returns the desired flash property.

  643.  *

  644.  * @param config A pointer to the storage for the driver runtime state.

  645.  * @param whichProperty The desired property from the list of properties in

  646.  *        enum flash_property_tag_t

  647.  * @param value A pointer to the value returned for the desired flash property.

  648.  *

  649.  * @retval #kStatus_FTFx_Success API was executed successfully; the flash property was stored to value.

  650.  * @retval #kStatus_FTFx_InvalidArgument An invalid argument is provided.

  651.  * @retval #kStatus_FTFx_UnknownProperty An unknown property tag.

  652.  */

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

  654. 

  655. /*@}*/

  656. 

  657. #if defined(__cplusplus)

  658. }

  659. #endif

  660. 

  661. /*! @}*/

  662. 

  663. #endif /* FSL_FTFX_FLASH_H */