mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_RAPIDIOT_KW41Z/TOOLCHAIN_IAR/fsl_flash.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 172:65be27845400 1 /*
AnnaBridge 172:65be27845400 2 * Copyright (c) 2013-2016, Freescale Semiconductor, Inc.
AnnaBridge 172:65be27845400 3 * All rights reserved.
AnnaBridge 172:65be27845400 4 *
AnnaBridge 172:65be27845400 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 172:65be27845400 6 * are permitted provided that the following conditions are met:
AnnaBridge 172:65be27845400 7 *
AnnaBridge 172:65be27845400 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 172:65be27845400 9 * of conditions and the following disclaimer.
AnnaBridge 172:65be27845400 10 *
AnnaBridge 172:65be27845400 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 172:65be27845400 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 172:65be27845400 13 * other materials provided with the distribution.
AnnaBridge 172:65be27845400 14 *
AnnaBridge 172:65be27845400 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 172:65be27845400 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 172:65be27845400 17 * software without specific prior written permission.
AnnaBridge 172:65be27845400 18 *
AnnaBridge 172:65be27845400 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 172:65be27845400 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 172:65be27845400 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 172:65be27845400 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 172:65be27845400 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 172:65be27845400 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 172:65be27845400 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 172:65be27845400 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 172:65be27845400 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 172:65be27845400 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 172:65be27845400 29 */
AnnaBridge 172:65be27845400 30
AnnaBridge 172:65be27845400 31 #ifndef _FSL_FLASH_H_
AnnaBridge 172:65be27845400 32 #define _FSL_FLASH_H_
AnnaBridge 172:65be27845400 33
AnnaBridge 172:65be27845400 34 #if (defined(BL_TARGET_FLASH) || defined(BL_TARGET_ROM) || defined(BL_TARGET_RAM))
AnnaBridge 172:65be27845400 35 #include <assert.h>
AnnaBridge 172:65be27845400 36 #include <string.h>
AnnaBridge 172:65be27845400 37 #include "fsl_device_registers.h"
AnnaBridge 172:65be27845400 38 #include "bootloader_common.h"
AnnaBridge 172:65be27845400 39 #else
AnnaBridge 172:65be27845400 40 #include "fsl_common.h"
AnnaBridge 172:65be27845400 41 #endif
AnnaBridge 172:65be27845400 42
AnnaBridge 172:65be27845400 43 /*******************************************************************************
AnnaBridge 172:65be27845400 44 * Definitions
AnnaBridge 172:65be27845400 45 ******************************************************************************/
AnnaBridge 172:65be27845400 46
AnnaBridge 172:65be27845400 47 /*!
AnnaBridge 172:65be27845400 48 * @addtogroup flash_driver
AnnaBridge 172:65be27845400 49 * @{
AnnaBridge 172:65be27845400 50 */
AnnaBridge 172:65be27845400 51
AnnaBridge 172:65be27845400 52 /*!
AnnaBridge 172:65be27845400 53 * @name Flash version
AnnaBridge 172:65be27845400 54 * @{
AnnaBridge 172:65be27845400 55 */
AnnaBridge 172:65be27845400 56 /*! @brief Constructs the version number for drivers. */
AnnaBridge 172:65be27845400 57 #if !defined(MAKE_VERSION)
AnnaBridge 172:65be27845400 58 #define MAKE_VERSION(major, minor, bugfix) (((major) << 16) | ((minor) << 8) | (bugfix))
AnnaBridge 172:65be27845400 59 #endif
AnnaBridge 172:65be27845400 60
AnnaBridge 172:65be27845400 61 /*! @brief Flash driver version for SDK*/
AnnaBridge 172:65be27845400 62 #define FSL_FLASH_DRIVER_VERSION (MAKE_VERSION(2, 2, 0)) /*!< Version 2.2.0. */
AnnaBridge 172:65be27845400 63
AnnaBridge 172:65be27845400 64 /*! @brief Flash driver version for ROM*/
AnnaBridge 172:65be27845400 65 enum _flash_driver_version_constants
AnnaBridge 172:65be27845400 66 {
AnnaBridge 172:65be27845400 67 kFLASH_DriverVersionName = 'F', /*!< Flash driver version name.*/
AnnaBridge 172:65be27845400 68 kFLASH_DriverVersionMajor = 2, /*!< Major flash driver version.*/
AnnaBridge 172:65be27845400 69 kFLASH_DriverVersionMinor = 2, /*!< Minor flash driver version.*/
AnnaBridge 172:65be27845400 70 kFLASH_DriverVersionBugfix = 0 /*!< Bugfix for flash driver version.*/
AnnaBridge 172:65be27845400 71 };
AnnaBridge 172:65be27845400 72 /*@}*/
AnnaBridge 172:65be27845400 73
AnnaBridge 172:65be27845400 74 /*!
AnnaBridge 172:65be27845400 75 * @name Flash configuration
AnnaBridge 172:65be27845400 76 * @{
AnnaBridge 172:65be27845400 77 */
AnnaBridge 172:65be27845400 78 /*! @brief Indicates whether to support FlexNVM in the Flash driver */
AnnaBridge 172:65be27845400 79 #if !defined(FLASH_SSD_CONFIG_ENABLE_FLEXNVM_SUPPORT)
AnnaBridge 172:65be27845400 80 #define FLASH_SSD_CONFIG_ENABLE_FLEXNVM_SUPPORT 1 /*!< Enables the FlexNVM support by default. */
AnnaBridge 172:65be27845400 81 #endif
AnnaBridge 172:65be27845400 82
AnnaBridge 172:65be27845400 83 /*! @brief Indicates whether the FlexNVM is enabled in the Flash driver */
AnnaBridge 172:65be27845400 84 #define FLASH_SSD_IS_FLEXNVM_ENABLED (FLASH_SSD_CONFIG_ENABLE_FLEXNVM_SUPPORT && FSL_FEATURE_FLASH_HAS_FLEX_NVM)
AnnaBridge 172:65be27845400 85
AnnaBridge 172:65be27845400 86 /*! @brief Indicates whether the secondary flash is supported in the Flash driver */
AnnaBridge 172:65be27845400 87 #if defined(FSL_FEATURE_FLASH_HAS_MULTIPLE_FLASH) || defined(FSL_FEATURE_FLASH_PFLASH_1_START_ADDRESS)
AnnaBridge 172:65be27845400 88 #define FLASH_SSD_IS_SECONDARY_FLASH_SUPPORTED (1)
AnnaBridge 172:65be27845400 89 #else
AnnaBridge 172:65be27845400 90 #define FLASH_SSD_IS_SECONDARY_FLASH_SUPPORTED (0)
AnnaBridge 172:65be27845400 91 #endif
AnnaBridge 172:65be27845400 92
AnnaBridge 172:65be27845400 93 /*! @brief Indicates whether the secondary flash has its own protection register in flash module */
AnnaBridge 172:65be27845400 94 #if defined(FSL_FEATURE_FLASH_HAS_MULTIPLE_FLASH) && defined(FTFE_FPROTS_PROTS_MASK)
AnnaBridge 172:65be27845400 95 #define FLASH_SSD_SECONDARY_FLASH_HAS_ITS_OWN_PROTECTION_REGISTER (1)
AnnaBridge 172:65be27845400 96 #else
AnnaBridge 172:65be27845400 97 #define FLASH_SSD_SECONDARY_FLASH_HAS_ITS_OWN_PROTECTION_REGISTER (0)
AnnaBridge 172:65be27845400 98 #endif
AnnaBridge 172:65be27845400 99
AnnaBridge 172:65be27845400 100 /*! @brief Indicates whether the secondary flash has its own Execute-Only access register in flash module */
AnnaBridge 172:65be27845400 101 #if defined(FSL_FEATURE_FLASH_HAS_MULTIPLE_FLASH) && defined(FTFE_FACSSS_SGSIZE_S_MASK)
AnnaBridge 172:65be27845400 102 #define FLASH_SSD_SECONDARY_FLASH_HAS_ITS_OWN_ACCESS_REGISTER (1)
AnnaBridge 172:65be27845400 103 #else
AnnaBridge 172:65be27845400 104 #define FLASH_SSD_SECONDARY_FLASH_HAS_ITS_OWN_ACCESS_REGISTER (0)
AnnaBridge 172:65be27845400 105 #endif
AnnaBridge 172:65be27845400 106
AnnaBridge 172:65be27845400 107 /*! @brief Flash driver location. */
AnnaBridge 172:65be27845400 108 #if !defined(FLASH_DRIVER_IS_FLASH_RESIDENT)
AnnaBridge 172:65be27845400 109 #if (!defined(BL_TARGET_ROM) && !defined(BL_TARGET_RAM))
AnnaBridge 172:65be27845400 110 #define FLASH_DRIVER_IS_FLASH_RESIDENT 1 /*!< Used for the flash resident application. */
AnnaBridge 172:65be27845400 111 #else
AnnaBridge 172:65be27845400 112 #define FLASH_DRIVER_IS_FLASH_RESIDENT 0 /*!< Used for the non-flash resident application. */
AnnaBridge 172:65be27845400 113 #endif
AnnaBridge 172:65be27845400 114 #endif
AnnaBridge 172:65be27845400 115
AnnaBridge 172:65be27845400 116 /*! @brief Flash Driver Export option */
AnnaBridge 172:65be27845400 117 #if !defined(FLASH_DRIVER_IS_EXPORTED)
AnnaBridge 172:65be27845400 118 #if (defined(BL_TARGET_ROM) || defined(BL_TARGET_FLASH))
AnnaBridge 172:65be27845400 119 #define FLASH_DRIVER_IS_EXPORTED 1 /*!< Used for the ROM bootloader. */
AnnaBridge 172:65be27845400 120 #else
AnnaBridge 172:65be27845400 121 #define FLASH_DRIVER_IS_EXPORTED 0 /*!< Used for the KSDK application. */
AnnaBridge 172:65be27845400 122 #endif
AnnaBridge 172:65be27845400 123 #endif
AnnaBridge 172:65be27845400 124 /*@}*/
AnnaBridge 172:65be27845400 125
AnnaBridge 172:65be27845400 126 /*!
AnnaBridge 172:65be27845400 127 * @name Flash status
AnnaBridge 172:65be27845400 128 * @{
AnnaBridge 172:65be27845400 129 */
AnnaBridge 172:65be27845400 130 /*! @brief Flash driver status group. */
AnnaBridge 172:65be27845400 131 #if defined(kStatusGroup_FlashDriver)
AnnaBridge 172:65be27845400 132 #define kStatusGroupGeneric kStatusGroup_Generic
AnnaBridge 172:65be27845400 133 #define kStatusGroupFlashDriver kStatusGroup_FlashDriver
AnnaBridge 172:65be27845400 134 #elif defined(kStatusGroup_FLASH)
AnnaBridge 172:65be27845400 135 #define kStatusGroupGeneric kStatusGroup_Generic
AnnaBridge 172:65be27845400 136 #define kStatusGroupFlashDriver kStatusGroup_FLASH
AnnaBridge 172:65be27845400 137 #else
AnnaBridge 172:65be27845400 138 #define kStatusGroupGeneric 0
AnnaBridge 172:65be27845400 139 #define kStatusGroupFlashDriver 1
AnnaBridge 172:65be27845400 140 #endif
AnnaBridge 172:65be27845400 141
AnnaBridge 172:65be27845400 142 /*! @brief Constructs a status code value from a group and a code number. */
AnnaBridge 172:65be27845400 143 #if !defined(MAKE_STATUS)
AnnaBridge 172:65be27845400 144 #define MAKE_STATUS(group, code) ((((group)*100) + (code)))
AnnaBridge 172:65be27845400 145 #endif
AnnaBridge 172:65be27845400 146
AnnaBridge 172:65be27845400 147 /*!
AnnaBridge 172:65be27845400 148 * @brief Flash driver status codes.
AnnaBridge 172:65be27845400 149 */
AnnaBridge 172:65be27845400 150 enum _flash_status
AnnaBridge 172:65be27845400 151 {
AnnaBridge 172:65be27845400 152 kStatus_FLASH_Success = MAKE_STATUS(kStatusGroupGeneric, 0), /*!< API is executed successfully*/
AnnaBridge 172:65be27845400 153 kStatus_FLASH_InvalidArgument = MAKE_STATUS(kStatusGroupGeneric, 4), /*!< Invalid argument*/
AnnaBridge 172:65be27845400 154 kStatus_FLASH_SizeError = MAKE_STATUS(kStatusGroupFlashDriver, 0), /*!< Error size*/
AnnaBridge 172:65be27845400 155 kStatus_FLASH_AlignmentError =
AnnaBridge 172:65be27845400 156 MAKE_STATUS(kStatusGroupFlashDriver, 1), /*!< Parameter is not aligned with the specified baseline*/
AnnaBridge 172:65be27845400 157 kStatus_FLASH_AddressError = MAKE_STATUS(kStatusGroupFlashDriver, 2), /*!< Address is out of range */
AnnaBridge 172:65be27845400 158 kStatus_FLASH_AccessError =
AnnaBridge 172:65be27845400 159 MAKE_STATUS(kStatusGroupFlashDriver, 3), /*!< Invalid instruction codes and out-of bound addresses */
AnnaBridge 172:65be27845400 160 kStatus_FLASH_ProtectionViolation = MAKE_STATUS(
AnnaBridge 172:65be27845400 161 kStatusGroupFlashDriver, 4), /*!< The program/erase operation is requested to execute on protected areas */
AnnaBridge 172:65be27845400 162 kStatus_FLASH_CommandFailure =
AnnaBridge 172:65be27845400 163 MAKE_STATUS(kStatusGroupFlashDriver, 5), /*!< Run-time error during command execution. */
AnnaBridge 172:65be27845400 164 kStatus_FLASH_UnknownProperty = MAKE_STATUS(kStatusGroupFlashDriver, 6), /*!< Unknown property.*/
AnnaBridge 172:65be27845400 165 kStatus_FLASH_EraseKeyError = MAKE_STATUS(kStatusGroupFlashDriver, 7), /*!< API erase key is invalid.*/
AnnaBridge 172:65be27845400 166 kStatus_FLASH_RegionExecuteOnly =
AnnaBridge 172:65be27845400 167 MAKE_STATUS(kStatusGroupFlashDriver, 8), /*!< The current region is execute-only.*/
AnnaBridge 172:65be27845400 168 kStatus_FLASH_ExecuteInRamFunctionNotReady =
AnnaBridge 172:65be27845400 169 MAKE_STATUS(kStatusGroupFlashDriver, 9), /*!< Execute-in-RAM function is not available.*/
AnnaBridge 172:65be27845400 170 kStatus_FLASH_PartitionStatusUpdateFailure =
AnnaBridge 172:65be27845400 171 MAKE_STATUS(kStatusGroupFlashDriver, 10), /*!< Failed to update partition status.*/
AnnaBridge 172:65be27845400 172 kStatus_FLASH_SetFlexramAsEepromError =
AnnaBridge 172:65be27845400 173 MAKE_STATUS(kStatusGroupFlashDriver, 11), /*!< Failed to set FlexRAM as EEPROM.*/
AnnaBridge 172:65be27845400 174 kStatus_FLASH_RecoverFlexramAsRamError =
AnnaBridge 172:65be27845400 175 MAKE_STATUS(kStatusGroupFlashDriver, 12), /*!< Failed to recover FlexRAM as RAM.*/
AnnaBridge 172:65be27845400 176 kStatus_FLASH_SetFlexramAsRamError = MAKE_STATUS(kStatusGroupFlashDriver, 13), /*!< Failed to set FlexRAM as RAM.*/
AnnaBridge 172:65be27845400 177 kStatus_FLASH_RecoverFlexramAsEepromError =
AnnaBridge 172:65be27845400 178 MAKE_STATUS(kStatusGroupFlashDriver, 14), /*!< Failed to recover FlexRAM as EEPROM.*/
AnnaBridge 172:65be27845400 179 kStatus_FLASH_CommandNotSupported = MAKE_STATUS(kStatusGroupFlashDriver, 15), /*!< Flash API is not supported.*/
AnnaBridge 172:65be27845400 180 kStatus_FLASH_SwapSystemNotInUninitialized =
AnnaBridge 172:65be27845400 181 MAKE_STATUS(kStatusGroupFlashDriver, 16), /*!< Swap system is not in an uninitialzed state.*/
AnnaBridge 172:65be27845400 182 kStatus_FLASH_SwapIndicatorAddressError =
AnnaBridge 172:65be27845400 183 MAKE_STATUS(kStatusGroupFlashDriver, 17), /*!< The swap indicator address is invalid.*/
AnnaBridge 172:65be27845400 184 kStatus_FLASH_ReadOnlyProperty = MAKE_STATUS(kStatusGroupFlashDriver, 18), /*!< The flash property is read-only.*/
AnnaBridge 172:65be27845400 185 kStatus_FLASH_InvalidPropertyValue =
AnnaBridge 172:65be27845400 186 MAKE_STATUS(kStatusGroupFlashDriver, 19), /*!< The flash property value is out of range.*/
AnnaBridge 172:65be27845400 187 kStatus_FLASH_InvalidSpeculationOption =
AnnaBridge 172:65be27845400 188 MAKE_STATUS(kStatusGroupFlashDriver, 20), /*!< The option of flash prefetch speculation is invalid.*/
AnnaBridge 172:65be27845400 189 };
AnnaBridge 172:65be27845400 190 /*@}*/
AnnaBridge 172:65be27845400 191
AnnaBridge 172:65be27845400 192 /*!
AnnaBridge 172:65be27845400 193 * @name Flash API key
AnnaBridge 172:65be27845400 194 * @{
AnnaBridge 172:65be27845400 195 */
AnnaBridge 172:65be27845400 196 /*! @brief Constructs the four character code for the Flash driver API key. */
AnnaBridge 172:65be27845400 197 #if !defined(FOUR_CHAR_CODE)
AnnaBridge 172:65be27845400 198 #define FOUR_CHAR_CODE(a, b, c, d) (((d) << 24) | ((c) << 16) | ((b) << 8) | ((a)))
AnnaBridge 172:65be27845400 199 #endif
AnnaBridge 172:65be27845400 200
AnnaBridge 172:65be27845400 201 /*!
AnnaBridge 172:65be27845400 202 * @brief Enumeration for Flash driver API keys.
AnnaBridge 172:65be27845400 203 *
AnnaBridge 172:65be27845400 204 * @note The resulting value is built with a byte order such that the string
AnnaBridge 172:65be27845400 205 * being readable in expected order when viewed in a hex editor, if the value
AnnaBridge 172:65be27845400 206 * is treated as a 32-bit little endian value.
AnnaBridge 172:65be27845400 207 */
AnnaBridge 172:65be27845400 208 enum _flash_driver_api_keys
AnnaBridge 172:65be27845400 209 {
AnnaBridge 172:65be27845400 210 kFLASH_ApiEraseKey = FOUR_CHAR_CODE('k', 'f', 'e', 'k') /*!< Key value used to validate all flash erase APIs.*/
AnnaBridge 172:65be27845400 211 };
AnnaBridge 172:65be27845400 212 /*@}*/
AnnaBridge 172:65be27845400 213
AnnaBridge 172:65be27845400 214 /*!
AnnaBridge 172:65be27845400 215 * @brief Enumeration for supported flash margin levels.
AnnaBridge 172:65be27845400 216 */
AnnaBridge 172:65be27845400 217 typedef enum _flash_margin_value
AnnaBridge 172:65be27845400 218 {
AnnaBridge 172:65be27845400 219 kFLASH_MarginValueNormal, /*!< Use the 'normal' read level for 1s.*/
AnnaBridge 172:65be27845400 220 kFLASH_MarginValueUser, /*!< Apply the 'User' margin to the normal read-1 level.*/
AnnaBridge 172:65be27845400 221 kFLASH_MarginValueFactory, /*!< Apply the 'Factory' margin to the normal read-1 level.*/
AnnaBridge 172:65be27845400 222 kFLASH_MarginValueInvalid /*!< Not real margin level, Used to determine the range of valid margin level. */
AnnaBridge 172:65be27845400 223 } flash_margin_value_t;
AnnaBridge 172:65be27845400 224
AnnaBridge 172:65be27845400 225 /*!
AnnaBridge 172:65be27845400 226 * @brief Enumeration for the three possible flash security states.
AnnaBridge 172:65be27845400 227 */
AnnaBridge 172:65be27845400 228 typedef enum _flash_security_state
AnnaBridge 172:65be27845400 229 {
AnnaBridge 172:65be27845400 230 kFLASH_SecurityStateNotSecure, /*!< Flash is not secure.*/
AnnaBridge 172:65be27845400 231 kFLASH_SecurityStateBackdoorEnabled, /*!< Flash backdoor is enabled.*/
AnnaBridge 172:65be27845400 232 kFLASH_SecurityStateBackdoorDisabled /*!< Flash backdoor is disabled.*/
AnnaBridge 172:65be27845400 233 } flash_security_state_t;
AnnaBridge 172:65be27845400 234
AnnaBridge 172:65be27845400 235 /*!
AnnaBridge 172:65be27845400 236 * @brief Enumeration for the three possible flash protection levels.
AnnaBridge 172:65be27845400 237 */
AnnaBridge 172:65be27845400 238 typedef enum _flash_protection_state
AnnaBridge 172:65be27845400 239 {
AnnaBridge 172:65be27845400 240 kFLASH_ProtectionStateUnprotected, /*!< Flash region is not protected.*/
AnnaBridge 172:65be27845400 241 kFLASH_ProtectionStateProtected, /*!< Flash region is protected.*/
AnnaBridge 172:65be27845400 242 kFLASH_ProtectionStateMixed /*!< Flash is mixed with protected and unprotected region.*/
AnnaBridge 172:65be27845400 243 } flash_protection_state_t;
AnnaBridge 172:65be27845400 244
AnnaBridge 172:65be27845400 245 /*!
AnnaBridge 172:65be27845400 246 * @brief Enumeration for the three possible flash execute access levels.
AnnaBridge 172:65be27845400 247 */
AnnaBridge 172:65be27845400 248 typedef enum _flash_execute_only_access_state
AnnaBridge 172:65be27845400 249 {
AnnaBridge 172:65be27845400 250 kFLASH_AccessStateUnLimited, /*!< Flash region is unlimited.*/
AnnaBridge 172:65be27845400 251 kFLASH_AccessStateExecuteOnly, /*!< Flash region is execute only.*/
AnnaBridge 172:65be27845400 252 kFLASH_AccessStateMixed /*!< Flash is mixed with unlimited and execute only region.*/
AnnaBridge 172:65be27845400 253 } flash_execute_only_access_state_t;
AnnaBridge 172:65be27845400 254
AnnaBridge 172:65be27845400 255 /*!
AnnaBridge 172:65be27845400 256 * @brief Enumeration for various flash properties.
AnnaBridge 172:65be27845400 257 */
AnnaBridge 172:65be27845400 258 typedef enum _flash_property_tag
AnnaBridge 172:65be27845400 259 {
AnnaBridge 172:65be27845400 260 kFLASH_PropertyPflashSectorSize = 0x00U, /*!< Pflash sector size property.*/
AnnaBridge 172:65be27845400 261 kFLASH_PropertyPflashTotalSize = 0x01U, /*!< Pflash total size property.*/
AnnaBridge 172:65be27845400 262 kFLASH_PropertyPflashBlockSize = 0x02U, /*!< Pflash block size property.*/
AnnaBridge 172:65be27845400 263 kFLASH_PropertyPflashBlockCount = 0x03U, /*!< Pflash block count property.*/
AnnaBridge 172:65be27845400 264 kFLASH_PropertyPflashBlockBaseAddr = 0x04U, /*!< Pflash block base address property.*/
AnnaBridge 172:65be27845400 265 kFLASH_PropertyPflashFacSupport = 0x05U, /*!< Pflash fac support property.*/
AnnaBridge 172:65be27845400 266 kFLASH_PropertyPflashAccessSegmentSize = 0x06U, /*!< Pflash access segment size property.*/
AnnaBridge 172:65be27845400 267 kFLASH_PropertyPflashAccessSegmentCount = 0x07U, /*!< Pflash access segment count property.*/
AnnaBridge 172:65be27845400 268 kFLASH_PropertyFlexRamBlockBaseAddr = 0x08U, /*!< FlexRam block base address property.*/
AnnaBridge 172:65be27845400 269 kFLASH_PropertyFlexRamTotalSize = 0x09U, /*!< FlexRam total size property.*/
AnnaBridge 172:65be27845400 270 kFLASH_PropertyDflashSectorSize = 0x10U, /*!< Dflash sector size property.*/
AnnaBridge 172:65be27845400 271 kFLASH_PropertyDflashTotalSize = 0x11U, /*!< Dflash total size property.*/
AnnaBridge 172:65be27845400 272 kFLASH_PropertyDflashBlockSize = 0x12U, /*!< Dflash block size property.*/
AnnaBridge 172:65be27845400 273 kFLASH_PropertyDflashBlockCount = 0x13U, /*!< Dflash block count property.*/
AnnaBridge 172:65be27845400 274 kFLASH_PropertyDflashBlockBaseAddr = 0x14U, /*!< Dflash block base address property.*/
AnnaBridge 172:65be27845400 275 kFLASH_PropertyEepromTotalSize = 0x15U, /*!< EEPROM total size property.*/
AnnaBridge 172:65be27845400 276 kFLASH_PropertyFlashMemoryIndex = 0x20U /*!< Flash memory index property.*/
AnnaBridge 172:65be27845400 277 } flash_property_tag_t;
AnnaBridge 172:65be27845400 278
AnnaBridge 172:65be27845400 279 /*!
AnnaBridge 172:65be27845400 280 * @brief Constants for execute-in-RAM flash function.
AnnaBridge 172:65be27845400 281 */
AnnaBridge 172:65be27845400 282 enum _flash_execute_in_ram_function_constants
AnnaBridge 172:65be27845400 283 {
AnnaBridge 172:65be27845400 284 kFLASH_ExecuteInRamFunctionMaxSizeInWords = 16U, /*!< The maximum size of execute-in-RAM function.*/
AnnaBridge 172:65be27845400 285 kFLASH_ExecuteInRamFunctionTotalNum = 2U /*!< Total number of execute-in-RAM functions.*/
AnnaBridge 172:65be27845400 286 };
AnnaBridge 172:65be27845400 287
AnnaBridge 172:65be27845400 288 /*!
AnnaBridge 172:65be27845400 289 * @brief Flash execute-in-RAM function information.
AnnaBridge 172:65be27845400 290 */
AnnaBridge 172:65be27845400 291 typedef struct _flash_execute_in_ram_function_config
AnnaBridge 172:65be27845400 292 {
AnnaBridge 172:65be27845400 293 uint32_t activeFunctionCount; /*!< Number of available execute-in-RAM functions.*/
AnnaBridge 172:65be27845400 294 uint32_t *flashRunCommand; /*!< Execute-in-RAM function: flash_run_command.*/
AnnaBridge 172:65be27845400 295 uint32_t *flashCommonBitOperation; /*!< Execute-in-RAM function: flash_common_bit_operation.*/
AnnaBridge 172:65be27845400 296 } flash_execute_in_ram_function_config_t;
AnnaBridge 172:65be27845400 297
AnnaBridge 172:65be27845400 298 /*!
AnnaBridge 172:65be27845400 299 * @brief Enumeration for the two possible options of flash read resource command.
AnnaBridge 172:65be27845400 300 */
AnnaBridge 172:65be27845400 301 typedef enum _flash_read_resource_option
AnnaBridge 172:65be27845400 302 {
AnnaBridge 172:65be27845400 303 kFLASH_ResourceOptionFlashIfr =
AnnaBridge 172:65be27845400 304 0x00U, /*!< Select code for Program flash 0 IFR, Program flash swap 0 IFR, Data flash 0 IFR */
AnnaBridge 172:65be27845400 305 kFLASH_ResourceOptionVersionId = 0x01U /*!< Select code for the version ID*/
AnnaBridge 172:65be27845400 306 } flash_read_resource_option_t;
AnnaBridge 172:65be27845400 307
AnnaBridge 172:65be27845400 308 /*!
AnnaBridge 172:65be27845400 309 * @brief Enumeration for the range of special-purpose flash resource
AnnaBridge 172:65be27845400 310 */
AnnaBridge 172:65be27845400 311 enum _flash_read_resource_range
AnnaBridge 172:65be27845400 312 {
AnnaBridge 172:65be27845400 313 #if (FSL_FEATURE_FLASH_IS_FTFE == 1)
AnnaBridge 172:65be27845400 314 kFLASH_ResourceRangePflashIfrSizeInBytes = 1024U, /*!< Pflash IFR size in byte.*/
AnnaBridge 172:65be27845400 315 kFLASH_ResourceRangeVersionIdSizeInBytes = 8U, /*!< Version ID IFR size in byte.*/
AnnaBridge 172:65be27845400 316 kFLASH_ResourceRangeVersionIdStart = 0x08U, /*!< Version ID IFR start address.*/
AnnaBridge 172:65be27845400 317 kFLASH_ResourceRangeVersionIdEnd = 0x0FU, /*!< Version ID IFR end address.*/
AnnaBridge 172:65be27845400 318 kFLASH_ResourceRangePflashSwapIfrStart = 0x40000U, /*!< Pflash swap IFR start address.*/
AnnaBridge 172:65be27845400 319 kFLASH_ResourceRangePflashSwapIfrEnd =
AnnaBridge 172:65be27845400 320 (kFLASH_ResourceRangePflashSwapIfrStart + 0x3FFU), /*!< Pflash swap IFR end address.*/
AnnaBridge 172:65be27845400 321 #else /* FSL_FEATURE_FLASH_IS_FTFL == 1 or FSL_FEATURE_FLASH_IS_FTFA = =1 */
AnnaBridge 172:65be27845400 322 kFLASH_ResourceRangePflashIfrSizeInBytes = 256U, /*!< Pflash IFR size in byte.*/
AnnaBridge 172:65be27845400 323 kFLASH_ResourceRangeVersionIdSizeInBytes = 8U, /*!< Version ID IFR size in byte.*/
AnnaBridge 172:65be27845400 324 kFLASH_ResourceRangeVersionIdStart = 0x00U, /*!< Version ID IFR start address.*/
AnnaBridge 172:65be27845400 325 kFLASH_ResourceRangeVersionIdEnd = 0x07U, /*!< Version ID IFR end address.*/
AnnaBridge 172:65be27845400 326 #if 0x20000U == (FSL_FEATURE_FLASH_PFLASH_BLOCK_COUNT * FSL_FEATURE_FLASH_PFLASH_BLOCK_SIZE)
AnnaBridge 172:65be27845400 327 kFLASH_ResourceRangePflashSwapIfrStart = 0x8000U, /*!< Pflash swap IFR start address.*/
AnnaBridge 172:65be27845400 328 #elif 0x40000U == (FSL_FEATURE_FLASH_PFLASH_BLOCK_COUNT * FSL_FEATURE_FLASH_PFLASH_BLOCK_SIZE)
AnnaBridge 172:65be27845400 329 kFLASH_ResourceRangePflashSwapIfrStart = 0x10000U, /*!< Pflash swap IFR start address.*/
AnnaBridge 172:65be27845400 330 #elif 0x80000U == (FSL_FEATURE_FLASH_PFLASH_BLOCK_COUNT * FSL_FEATURE_FLASH_PFLASH_BLOCK_SIZE)
AnnaBridge 172:65be27845400 331 kFLASH_ResourceRangePflashSwapIfrStart = 0x20000U, /*!< Pflash swap IFR start address.*/
AnnaBridge 172:65be27845400 332 #else
AnnaBridge 172:65be27845400 333 kFLASH_ResourceRangePflashSwapIfrStart = 0,
AnnaBridge 172:65be27845400 334 #endif
AnnaBridge 172:65be27845400 335 kFLASH_ResourceRangePflashSwapIfrEnd =
AnnaBridge 172:65be27845400 336 (kFLASH_ResourceRangePflashSwapIfrStart + 0xFFU), /*!< Pflash swap IFR end address.*/
AnnaBridge 172:65be27845400 337 #endif
AnnaBridge 172:65be27845400 338 kFLASH_ResourceRangeDflashIfrStart = 0x800000U, /*!< Dflash IFR start address.*/
AnnaBridge 172:65be27845400 339 kFLASH_ResourceRangeDflashIfrEnd = 0x8003FFU, /*!< Dflash IFR end address.*/
AnnaBridge 172:65be27845400 340 };
AnnaBridge 172:65be27845400 341
AnnaBridge 172:65be27845400 342 /*!
AnnaBridge 172:65be27845400 343 * @brief Enumeration for the two possilbe options of set FlexRAM function command.
AnnaBridge 172:65be27845400 344 */
AnnaBridge 172:65be27845400 345 typedef enum _flash_flexram_function_option
AnnaBridge 172:65be27845400 346 {
AnnaBridge 172:65be27845400 347 kFLASH_FlexramFunctionOptionAvailableAsRam = 0xFFU, /*!< An option used to make FlexRAM available as RAM */
AnnaBridge 172:65be27845400 348 kFLASH_FlexramFunctionOptionAvailableForEeprom = 0x00U /*!< An option used to make FlexRAM available for EEPROM */
AnnaBridge 172:65be27845400 349 } flash_flexram_function_option_t;
AnnaBridge 172:65be27845400 350
AnnaBridge 172:65be27845400 351 /*!
AnnaBridge 172:65be27845400 352 * @brief Enumeration for acceleration RAM property.
AnnaBridge 172:65be27845400 353 */
AnnaBridge 172:65be27845400 354 enum _flash_acceleration_ram_property
AnnaBridge 172:65be27845400 355 {
AnnaBridge 172:65be27845400 356 kFLASH_AccelerationRamSize = 0x400U
AnnaBridge 172:65be27845400 357 };
AnnaBridge 172:65be27845400 358
AnnaBridge 172:65be27845400 359 /*!
AnnaBridge 172:65be27845400 360 * @brief Enumeration for the possible options of Swap function
AnnaBridge 172:65be27845400 361 */
AnnaBridge 172:65be27845400 362 typedef enum _flash_swap_function_option
AnnaBridge 172:65be27845400 363 {
AnnaBridge 172:65be27845400 364 kFLASH_SwapFunctionOptionEnable = 0x00U, /*!< An option used to enable the Swap function */
AnnaBridge 172:65be27845400 365 kFLASH_SwapFunctionOptionDisable = 0x01U /*!< An option used to disable the Swap function */
AnnaBridge 172:65be27845400 366 } flash_swap_function_option_t;
AnnaBridge 172:65be27845400 367
AnnaBridge 172:65be27845400 368 /*!
AnnaBridge 172:65be27845400 369 * @brief Enumeration for the possible options of Swap control commands
AnnaBridge 172:65be27845400 370 */
AnnaBridge 172:65be27845400 371 typedef enum _flash_swap_control_option
AnnaBridge 172:65be27845400 372 {
AnnaBridge 172:65be27845400 373 kFLASH_SwapControlOptionIntializeSystem = 0x01U, /*!< An option used to initialize the Swap system */
AnnaBridge 172:65be27845400 374 kFLASH_SwapControlOptionSetInUpdateState = 0x02U, /*!< An option used to set the Swap in an update state */
AnnaBridge 172:65be27845400 375 kFLASH_SwapControlOptionSetInCompleteState = 0x04U, /*!< An option used to set the Swap in a complete state */
AnnaBridge 172:65be27845400 376 kFLASH_SwapControlOptionReportStatus = 0x08U, /*!< An option used to report the Swap status */
AnnaBridge 172:65be27845400 377 kFLASH_SwapControlOptionDisableSystem = 0x10U /*!< An option used to disable the Swap status */
AnnaBridge 172:65be27845400 378 } flash_swap_control_option_t;
AnnaBridge 172:65be27845400 379
AnnaBridge 172:65be27845400 380 /*!
AnnaBridge 172:65be27845400 381 * @brief Enumeration for the possible flash Swap status.
AnnaBridge 172:65be27845400 382 */
AnnaBridge 172:65be27845400 383 typedef enum _flash_swap_state
AnnaBridge 172:65be27845400 384 {
AnnaBridge 172:65be27845400 385 kFLASH_SwapStateUninitialized = 0x00U, /*!< Flash Swap system is in an uninitialized state.*/
AnnaBridge 172:65be27845400 386 kFLASH_SwapStateReady = 0x01U, /*!< Flash Swap system is in a ready state.*/
AnnaBridge 172:65be27845400 387 kFLASH_SwapStateUpdate = 0x02U, /*!< Flash Swap system is in an update state.*/
AnnaBridge 172:65be27845400 388 kFLASH_SwapStateUpdateErased = 0x03U, /*!< Flash Swap system is in an updateErased state.*/
AnnaBridge 172:65be27845400 389 kFLASH_SwapStateComplete = 0x04U, /*!< Flash Swap system is in a complete state.*/
AnnaBridge 172:65be27845400 390 kFLASH_SwapStateDisabled = 0x05U /*!< Flash Swap system is in a disabled state.*/
AnnaBridge 172:65be27845400 391 } flash_swap_state_t;
AnnaBridge 172:65be27845400 392
AnnaBridge 172:65be27845400 393 /*!
AnnaBridge 172:65be27845400 394 * @breif Enumeration for the possible flash Swap block status
AnnaBridge 172:65be27845400 395 */
AnnaBridge 172:65be27845400 396 typedef enum _flash_swap_block_status
AnnaBridge 172:65be27845400 397 {
AnnaBridge 172:65be27845400 398 kFLASH_SwapBlockStatusLowerHalfProgramBlocksAtZero =
AnnaBridge 172:65be27845400 399 0x00U, /*!< Swap block status is that lower half program block at zero.*/
AnnaBridge 172:65be27845400 400 kFLASH_SwapBlockStatusUpperHalfProgramBlocksAtZero =
AnnaBridge 172:65be27845400 401 0x01U, /*!< Swap block status is that upper half program block at zero.*/
AnnaBridge 172:65be27845400 402 } flash_swap_block_status_t;
AnnaBridge 172:65be27845400 403
AnnaBridge 172:65be27845400 404 /*!
AnnaBridge 172:65be27845400 405 * @brief Flash Swap information
AnnaBridge 172:65be27845400 406 */
AnnaBridge 172:65be27845400 407 typedef struct _flash_swap_state_config
AnnaBridge 172:65be27845400 408 {
AnnaBridge 172:65be27845400 409 flash_swap_state_t flashSwapState; /*!<The current Swap system status.*/
AnnaBridge 172:65be27845400 410 flash_swap_block_status_t currentSwapBlockStatus; /*!< The current Swap block status.*/
AnnaBridge 172:65be27845400 411 flash_swap_block_status_t nextSwapBlockStatus; /*!< The next Swap block status.*/
AnnaBridge 172:65be27845400 412 } flash_swap_state_config_t;
AnnaBridge 172:65be27845400 413
AnnaBridge 172:65be27845400 414 /*!
AnnaBridge 172:65be27845400 415 * @brief Flash Swap IFR fields
AnnaBridge 172:65be27845400 416 */
AnnaBridge 172:65be27845400 417 typedef struct _flash_swap_ifr_field_config
AnnaBridge 172:65be27845400 418 {
AnnaBridge 172:65be27845400 419 uint16_t swapIndicatorAddress; /*!< A Swap indicator address field.*/
AnnaBridge 172:65be27845400 420 uint16_t swapEnableWord; /*!< A Swap enable word field.*/
AnnaBridge 172:65be27845400 421 uint8_t reserved0[4]; /*!< A reserved field.*/
AnnaBridge 172:65be27845400 422 #if (FSL_FEATURE_FLASH_IS_FTFE == 1)
AnnaBridge 172:65be27845400 423 uint8_t reserved1[2]; /*!< A reserved field.*/
AnnaBridge 172:65be27845400 424 uint16_t swapDisableWord; /*!< A Swap disable word field.*/
AnnaBridge 172:65be27845400 425 uint8_t reserved2[4]; /*!< A reserved field.*/
AnnaBridge 172:65be27845400 426 #endif
AnnaBridge 172:65be27845400 427 } flash_swap_ifr_field_config_t;
AnnaBridge 172:65be27845400 428
AnnaBridge 172:65be27845400 429 /*!
AnnaBridge 172:65be27845400 430 * @brief Flash Swap IFR field data
AnnaBridge 172:65be27845400 431 */
AnnaBridge 172:65be27845400 432 typedef union _flash_swap_ifr_field_data
AnnaBridge 172:65be27845400 433 {
AnnaBridge 172:65be27845400 434 uint32_t flashSwapIfrData[2]; /*!< A flash Swap IFR field data .*/
AnnaBridge 172:65be27845400 435 flash_swap_ifr_field_config_t flashSwapIfrField; /*!< A flash Swap IFR field structure.*/
AnnaBridge 172:65be27845400 436 } flash_swap_ifr_field_data_t;
AnnaBridge 172:65be27845400 437
AnnaBridge 172:65be27845400 438 /*!
AnnaBridge 172:65be27845400 439 * @brief PFlash protection status - low 32bit
AnnaBridge 172:65be27845400 440 */
AnnaBridge 172:65be27845400 441 typedef union _pflash_protection_status_low
AnnaBridge 172:65be27845400 442 {
AnnaBridge 172:65be27845400 443 uint32_t protl32b; /*!< PROT[31:0] .*/
AnnaBridge 172:65be27845400 444 struct
AnnaBridge 172:65be27845400 445 {
AnnaBridge 172:65be27845400 446 uint8_t protsl; /*!< PROTS[7:0] .*/
AnnaBridge 172:65be27845400 447 uint8_t protsh; /*!< PROTS[15:8] .*/
AnnaBridge 172:65be27845400 448 uint8_t reserved[2];
AnnaBridge 172:65be27845400 449 } prots16b;
AnnaBridge 172:65be27845400 450 } pflash_protection_status_low_t;
AnnaBridge 172:65be27845400 451
AnnaBridge 172:65be27845400 452 /*!
AnnaBridge 172:65be27845400 453 * @brief PFlash protection status - full
AnnaBridge 172:65be27845400 454 */
AnnaBridge 172:65be27845400 455 typedef struct _pflash_protection_status
AnnaBridge 172:65be27845400 456 {
AnnaBridge 172:65be27845400 457 pflash_protection_status_low_t valueLow32b; /*!< PROT[31:0] or PROTS[15:0].*/
AnnaBridge 172:65be27845400 458 #if ((FSL_FEATURE_FLASH_IS_FTFA == 1) && (defined(FTFA_FPROT_PROT_MASK))) || \
AnnaBridge 172:65be27845400 459 ((FSL_FEATURE_FLASH_IS_FTFE == 1) && (defined(FTFE_FPROT_PROT_MASK))) || \
AnnaBridge 172:65be27845400 460 ((FSL_FEATURE_FLASH_IS_FTFL == 1) && (defined(FTFL_FPROT_PROT_MASK)))
AnnaBridge 172:65be27845400 461 // uint32_t protHigh; /*!< PROT[63:32].*/
AnnaBridge 172:65be27845400 462 struct
AnnaBridge 172:65be27845400 463 {
AnnaBridge 172:65be27845400 464 uint32_t proth32b;
AnnaBridge 172:65be27845400 465 } valueHigh32b;
AnnaBridge 172:65be27845400 466 #endif
AnnaBridge 172:65be27845400 467 } pflash_protection_status_t;
AnnaBridge 172:65be27845400 468
AnnaBridge 172:65be27845400 469 /*!
AnnaBridge 172:65be27845400 470 * @brief Enumeration for the FlexRAM load during reset option.
AnnaBridge 172:65be27845400 471 */
AnnaBridge 172:65be27845400 472 typedef enum _flash_partition_flexram_load_option
AnnaBridge 172:65be27845400 473 {
AnnaBridge 172:65be27845400 474 kFLASH_PartitionFlexramLoadOptionLoadedWithValidEepromData =
AnnaBridge 172:65be27845400 475 0x00U, /*!< FlexRAM is loaded with valid EEPROM data during reset sequence.*/
AnnaBridge 172:65be27845400 476 kFLASH_PartitionFlexramLoadOptionNotLoaded = 0x01U /*!< FlexRAM is not loaded during reset sequence.*/
AnnaBridge 172:65be27845400 477 } flash_partition_flexram_load_option_t;
AnnaBridge 172:65be27845400 478
AnnaBridge 172:65be27845400 479 /*!
AnnaBridge 172:65be27845400 480 * @brief Enumeration for the flash memory index.
AnnaBridge 172:65be27845400 481 */
AnnaBridge 172:65be27845400 482 typedef enum _flash_memory_index
AnnaBridge 172:65be27845400 483 {
AnnaBridge 172:65be27845400 484 kFLASH_MemoryIndexPrimaryFlash = 0x00U, /*!< Current flash memory is primary flash.*/
AnnaBridge 172:65be27845400 485 kFLASH_MemoryIndexSecondaryFlash = 0x01U, /*!< Current flash memory is secondary flash.*/
AnnaBridge 172:65be27845400 486 } flash_memory_index_t;
AnnaBridge 172:65be27845400 487
AnnaBridge 172:65be27845400 488 /*! @brief A callback type used for the Pflash block*/
AnnaBridge 172:65be27845400 489 typedef void (*flash_callback_t)(void);
AnnaBridge 172:65be27845400 490
AnnaBridge 172:65be27845400 491 /*!
AnnaBridge 172:65be27845400 492 * @brief Enumeration for the two possible options of flash prefetch speculation.
AnnaBridge 172:65be27845400 493 */
AnnaBridge 172:65be27845400 494 typedef enum _flash_prefetch_speculation_option
AnnaBridge 172:65be27845400 495 {
AnnaBridge 172:65be27845400 496 kFLASH_prefetchSpeculationOptionEnable = 0x00000000U,
AnnaBridge 172:65be27845400 497 kFLASH_prefetchSpeculationOptionDisable = 0xFFFFFFFFU
AnnaBridge 172:65be27845400 498 } flash_prefetch_speculation_option_t;
AnnaBridge 172:65be27845400 499
AnnaBridge 172:65be27845400 500 /*!
AnnaBridge 172:65be27845400 501 * @brief Flash prefetch speculation status.
AnnaBridge 172:65be27845400 502 */
AnnaBridge 172:65be27845400 503 typedef struct _flash_prefetch_speculation_status
AnnaBridge 172:65be27845400 504 {
AnnaBridge 172:65be27845400 505 flash_prefetch_speculation_option_t instructionOption; /*!< Instruction speculation.*/
AnnaBridge 172:65be27845400 506 flash_prefetch_speculation_option_t dataOption; /*!< Data speculation.*/
AnnaBridge 172:65be27845400 507 } flash_prefetch_speculation_status_t;
AnnaBridge 172:65be27845400 508
AnnaBridge 172:65be27845400 509 /*!
AnnaBridge 172:65be27845400 510 * @brief Active flash protection information for the current operation.
AnnaBridge 172:65be27845400 511 */
AnnaBridge 172:65be27845400 512 typedef struct _flash_protection_config
AnnaBridge 172:65be27845400 513 {
AnnaBridge 172:65be27845400 514 uint32_t regionBase; /*!< Base address of flash protection region.*/
AnnaBridge 172:65be27845400 515 uint32_t regionSize; /*!< size of flash protection region.*/
AnnaBridge 172:65be27845400 516 uint32_t regionCount; /*!< flash protection region count.*/
AnnaBridge 172:65be27845400 517 } flash_protection_config_t;
AnnaBridge 172:65be27845400 518
AnnaBridge 172:65be27845400 519 /*!
AnnaBridge 172:65be27845400 520 * @brief Active flash Execute-Only access information for the current operation.
AnnaBridge 172:65be27845400 521 */
AnnaBridge 172:65be27845400 522 typedef struct _flash_access_config
AnnaBridge 172:65be27845400 523 {
AnnaBridge 172:65be27845400 524 uint32_t SegmentBase; /*!< Base address of flash Execute-Only segment.*/
AnnaBridge 172:65be27845400 525 uint32_t SegmentSize; /*!< size of flash Execute-Only segment.*/
AnnaBridge 172:65be27845400 526 uint32_t SegmentCount; /*!< flash Execute-Only segment count.*/
AnnaBridge 172:65be27845400 527 } flash_access_config_t;
AnnaBridge 172:65be27845400 528
AnnaBridge 172:65be27845400 529 /*!
AnnaBridge 172:65be27845400 530 * @brief Active flash information for the current operation.
AnnaBridge 172:65be27845400 531 */
AnnaBridge 172:65be27845400 532 typedef struct _flash_operation_config
AnnaBridge 172:65be27845400 533 {
AnnaBridge 172:65be27845400 534 uint32_t convertedAddress; /*!< A converted address for the current flash type.*/
AnnaBridge 172:65be27845400 535 uint32_t activeSectorSize; /*!< A sector size of the current flash type.*/
AnnaBridge 172:65be27845400 536 uint32_t activeBlockSize; /*!< A block size of the current flash type.*/
AnnaBridge 172:65be27845400 537 uint32_t blockWriteUnitSize; /*!< The write unit size.*/
AnnaBridge 172:65be27845400 538 uint32_t sectorCmdAddressAligment; /*!< An erase sector command address alignment.*/
AnnaBridge 172:65be27845400 539 uint32_t sectionCmdAddressAligment; /*!< A program/verify section command address alignment.*/
AnnaBridge 172:65be27845400 540 uint32_t resourceCmdAddressAligment; /*!< A read resource command address alignment.*/
AnnaBridge 172:65be27845400 541 uint32_t checkCmdAddressAligment; /*!< A program check command address alignment.*/
AnnaBridge 172:65be27845400 542 } flash_operation_config_t;
AnnaBridge 172:65be27845400 543
AnnaBridge 172:65be27845400 544 /*! @brief Flash driver state information.
AnnaBridge 172:65be27845400 545 *
AnnaBridge 172:65be27845400 546 * An instance of this structure is allocated by the user of the flash driver and
AnnaBridge 172:65be27845400 547 * passed into each of the driver APIs.
AnnaBridge 172:65be27845400 548 */
AnnaBridge 172:65be27845400 549 typedef struct _flash_config
AnnaBridge 172:65be27845400 550 {
AnnaBridge 172:65be27845400 551 uint32_t PFlashBlockBase; /*!< A base address of the first PFlash block */
AnnaBridge 172:65be27845400 552 uint32_t PFlashTotalSize; /*!< The size of the combined PFlash block. */
AnnaBridge 172:65be27845400 553 uint32_t PFlashBlockCount; /*!< A number of PFlash blocks. */
AnnaBridge 172:65be27845400 554 uint32_t PFlashSectorSize; /*!< The size in bytes of a sector of PFlash. */
AnnaBridge 172:65be27845400 555 flash_callback_t PFlashCallback; /*!< The callback function for the flash API. */
AnnaBridge 172:65be27845400 556 uint32_t PFlashAccessSegmentSize; /*!< A size in bytes of an access segment of PFlash. */
AnnaBridge 172:65be27845400 557 uint32_t PFlashAccessSegmentCount; /*!< A number of PFlash access segments. */
AnnaBridge 172:65be27845400 558 uint32_t *flashExecuteInRamFunctionInfo; /*!< An information structure of the flash execute-in-RAM function. */
AnnaBridge 172:65be27845400 559 uint32_t
AnnaBridge 172:65be27845400 560 FlexRAMBlockBase; /*!< For the FlexNVM device, this is the base address of the FlexRAM
AnnaBridge 172:65be27845400 561 For the non-FlexNVM device, this is the base address of the acceleration RAM memory */
AnnaBridge 172:65be27845400 562 uint32_t FlexRAMTotalSize; /*!< For the FlexNVM device, this is the size of the FlexRAM
AnnaBridge 172:65be27845400 563 For the non-FlexNVM device, this is the size of the acceleration RAM memory */
AnnaBridge 172:65be27845400 564 uint32_t
AnnaBridge 172:65be27845400 565 DFlashBlockBase; /*!< For the FlexNVM device, this is the base address of the D-Flash memory (FlexNVM memory)
AnnaBridge 172:65be27845400 566 For the non-FlexNVM device, this field is unused */
AnnaBridge 172:65be27845400 567 uint32_t DFlashTotalSize; /*!< For the FlexNVM device, this is the total size of the FlexNVM memory;
AnnaBridge 172:65be27845400 568 For the non-FlexNVM device, this field is unused */
AnnaBridge 172:65be27845400 569 uint32_t
AnnaBridge 172:65be27845400 570 EEpromTotalSize; /*!< For the FlexNVM device, this is the size in bytes of the EEPROM area which was partitioned
AnnaBridge 172:65be27845400 571 from FlexRAM
AnnaBridge 172:65be27845400 572 For the non-FlexNVM device, this field is unused */
AnnaBridge 172:65be27845400 573 uint32_t FlashMemoryIndex; /*!< 0 - primary flash; 1 - secondary flash*/
AnnaBridge 172:65be27845400 574 } flash_config_t;
AnnaBridge 172:65be27845400 575
AnnaBridge 172:65be27845400 576 /*******************************************************************************
AnnaBridge 172:65be27845400 577 * API
AnnaBridge 172:65be27845400 578 ******************************************************************************/
AnnaBridge 172:65be27845400 579
AnnaBridge 172:65be27845400 580 #if defined(__cplusplus)
AnnaBridge 172:65be27845400 581 extern "C" {
AnnaBridge 172:65be27845400 582 #endif
AnnaBridge 172:65be27845400 583
AnnaBridge 172:65be27845400 584 /*!
AnnaBridge 172:65be27845400 585 * @name Initialization
AnnaBridge 172:65be27845400 586 * @{
AnnaBridge 172:65be27845400 587 */
AnnaBridge 172:65be27845400 588
AnnaBridge 172:65be27845400 589 /*!
AnnaBridge 172:65be27845400 590 * @brief Initializes the global flash properties structure members.
AnnaBridge 172:65be27845400 591 *
AnnaBridge 172:65be27845400 592 * This function checks and initializes the Flash module for the other Flash APIs.
AnnaBridge 172:65be27845400 593 *
AnnaBridge 172:65be27845400 594 * @param config Pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 595 *
AnnaBridge 172:65be27845400 596 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 597 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 598 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 599 * @retval #kStatus_FLASH_PartitionStatusUpdateFailure Failed to update the partition status.
AnnaBridge 172:65be27845400 600 */
AnnaBridge 172:65be27845400 601 status_t FLASH_Init(flash_config_t *config);
AnnaBridge 172:65be27845400 602
AnnaBridge 172:65be27845400 603 /*!
AnnaBridge 172:65be27845400 604 * @brief Sets the desired flash callback function.
AnnaBridge 172:65be27845400 605 *
AnnaBridge 172:65be27845400 606 * @param config Pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 607 * @param callback A callback function to be stored in the driver.
AnnaBridge 172:65be27845400 608 *
AnnaBridge 172:65be27845400 609 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 610 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 611 */
AnnaBridge 172:65be27845400 612 status_t FLASH_SetCallback(flash_config_t *config, flash_callback_t callback);
AnnaBridge 172:65be27845400 613
AnnaBridge 172:65be27845400 614 /*!
AnnaBridge 172:65be27845400 615 * @brief Prepares flash execute-in-RAM functions.
AnnaBridge 172:65be27845400 616 *
AnnaBridge 172:65be27845400 617 * @param config Pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 618 *
AnnaBridge 172:65be27845400 619 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 620 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 621 */
AnnaBridge 172:65be27845400 622 #if FLASH_DRIVER_IS_FLASH_RESIDENT
AnnaBridge 172:65be27845400 623 status_t FLASH_PrepareExecuteInRamFunctions(flash_config_t *config);
AnnaBridge 172:65be27845400 624 #endif
AnnaBridge 172:65be27845400 625
AnnaBridge 172:65be27845400 626 /*@}*/
AnnaBridge 172:65be27845400 627
AnnaBridge 172:65be27845400 628 /*!
AnnaBridge 172:65be27845400 629 * @name Erasing
AnnaBridge 172:65be27845400 630 * @{
AnnaBridge 172:65be27845400 631 */
AnnaBridge 172:65be27845400 632
AnnaBridge 172:65be27845400 633 /*!
AnnaBridge 172:65be27845400 634 * @brief Erases entire flash
AnnaBridge 172:65be27845400 635 *
AnnaBridge 172:65be27845400 636 * @param config Pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 637 * @param key A value used to validate all flash erase APIs.
AnnaBridge 172:65be27845400 638 *
AnnaBridge 172:65be27845400 639 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 640 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 641 * @retval #kStatus_FLASH_EraseKeyError API erase key is invalid.
AnnaBridge 172:65be27845400 642 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 643 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 644 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 645 * @retval #kStatus_FLASH_CommandFailure Run-time error during command execution.
AnnaBridge 172:65be27845400 646 * @retval #kStatus_FLASH_PartitionStatusUpdateFailure Failed to update the partition status.
AnnaBridge 172:65be27845400 647 */
AnnaBridge 172:65be27845400 648 status_t FLASH_EraseAll(flash_config_t *config, uint32_t key);
AnnaBridge 172:65be27845400 649
AnnaBridge 172:65be27845400 650 /*!
AnnaBridge 172:65be27845400 651 * @brief Erases the flash sectors encompassed by parameters passed into function.
AnnaBridge 172:65be27845400 652 *
AnnaBridge 172:65be27845400 653 * This function erases the appropriate number of flash sectors based on the
AnnaBridge 172:65be27845400 654 * desired start address and length.
AnnaBridge 172:65be27845400 655 *
AnnaBridge 172:65be27845400 656 * @param config The pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 657 * @param start The start address of the desired flash memory to be erased.
AnnaBridge 172:65be27845400 658 * The start address does not need to be sector-aligned but must be word-aligned.
AnnaBridge 172:65be27845400 659 * @param lengthInBytes The length, given in bytes (not words or long-words)
AnnaBridge 172:65be27845400 660 * to be erased. Must be word-aligned.
AnnaBridge 172:65be27845400 661 * @param key The value used to validate all flash erase APIs.
AnnaBridge 172:65be27845400 662 *
AnnaBridge 172:65be27845400 663 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 664 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 665 * @retval #kStatus_FLASH_AlignmentError The parameter is not aligned with the specified baseline.
AnnaBridge 172:65be27845400 666 * @retval #kStatus_FLASH_AddressError The address is out of range.
AnnaBridge 172:65be27845400 667 * @retval #kStatus_FLASH_EraseKeyError The API erase key is invalid.
AnnaBridge 172:65be27845400 668 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 669 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 670 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 671 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 672 */
AnnaBridge 172:65be27845400 673 status_t FLASH_Erase(flash_config_t *config, uint32_t start, uint32_t lengthInBytes, uint32_t key);
AnnaBridge 172:65be27845400 674
AnnaBridge 172:65be27845400 675 /*!
AnnaBridge 172:65be27845400 676 * @brief Erases the entire flash, including protected sectors.
AnnaBridge 172:65be27845400 677 *
AnnaBridge 172:65be27845400 678 * @param config Pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 679 * @param key A value used to validate all flash erase APIs.
AnnaBridge 172:65be27845400 680 *
AnnaBridge 172:65be27845400 681 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 682 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 683 * @retval #kStatus_FLASH_EraseKeyError API erase key is invalid.
AnnaBridge 172:65be27845400 684 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 685 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 686 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 687 * @retval #kStatus_FLASH_CommandFailure Run-time error during command execution.
AnnaBridge 172:65be27845400 688 * @retval #kStatus_FLASH_PartitionStatusUpdateFailure Failed to update the partition status.
AnnaBridge 172:65be27845400 689 */
AnnaBridge 172:65be27845400 690 #if defined(FSL_FEATURE_FLASH_HAS_ERASE_ALL_BLOCKS_UNSECURE_CMD) && FSL_FEATURE_FLASH_HAS_ERASE_ALL_BLOCKS_UNSECURE_CMD
AnnaBridge 172:65be27845400 691 status_t FLASH_EraseAllUnsecure(flash_config_t *config, uint32_t key);
AnnaBridge 172:65be27845400 692 #endif
AnnaBridge 172:65be27845400 693
AnnaBridge 172:65be27845400 694 /*!
AnnaBridge 172:65be27845400 695 * @brief Erases all program flash execute-only segments defined by the FXACC registers.
AnnaBridge 172:65be27845400 696 *
AnnaBridge 172:65be27845400 697 * @param config Pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 698 * @param key A value used to validate all flash erase APIs.
AnnaBridge 172:65be27845400 699 *
AnnaBridge 172:65be27845400 700 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 701 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 702 * @retval #kStatus_FLASH_EraseKeyError API erase key is invalid.
AnnaBridge 172:65be27845400 703 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 704 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 705 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 706 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 707 */
AnnaBridge 172:65be27845400 708 status_t FLASH_EraseAllExecuteOnlySegments(flash_config_t *config, uint32_t key);
AnnaBridge 172:65be27845400 709
AnnaBridge 172:65be27845400 710 /*@}*/
AnnaBridge 172:65be27845400 711
AnnaBridge 172:65be27845400 712 /*!
AnnaBridge 172:65be27845400 713 * @name Programming
AnnaBridge 172:65be27845400 714 * @{
AnnaBridge 172:65be27845400 715 */
AnnaBridge 172:65be27845400 716
AnnaBridge 172:65be27845400 717 /*!
AnnaBridge 172:65be27845400 718 * @brief Programs flash with data at locations passed in through parameters.
AnnaBridge 172:65be27845400 719 *
AnnaBridge 172:65be27845400 720 * This function programs the flash memory with the desired data for a given
AnnaBridge 172:65be27845400 721 * flash area as determined by the start address and the length.
AnnaBridge 172:65be27845400 722 *
AnnaBridge 172:65be27845400 723 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 724 * @param start The start address of the desired flash memory to be programmed. Must be
AnnaBridge 172:65be27845400 725 * word-aligned.
AnnaBridge 172:65be27845400 726 * @param src A pointer to the source buffer of data that is to be programmed
AnnaBridge 172:65be27845400 727 * into the flash.
AnnaBridge 172:65be27845400 728 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 729 * to be programmed. Must be word-aligned.
AnnaBridge 172:65be27845400 730 *
AnnaBridge 172:65be27845400 731 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 732 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 733 * @retval #kStatus_FLASH_AlignmentError Parameter is not aligned with the specified baseline.
AnnaBridge 172:65be27845400 734 * @retval #kStatus_FLASH_AddressError Address is out of range.
AnnaBridge 172:65be27845400 735 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 736 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 737 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 738 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 739 */
AnnaBridge 172:65be27845400 740 status_t FLASH_Program(flash_config_t *config, uint32_t start, uint32_t *src, uint32_t lengthInBytes);
AnnaBridge 172:65be27845400 741
AnnaBridge 172:65be27845400 742 /*!
AnnaBridge 172:65be27845400 743 * @brief Programs Program Once Field through parameters.
AnnaBridge 172:65be27845400 744 *
AnnaBridge 172:65be27845400 745 * This function programs the Program Once Field with the desired data for a given
AnnaBridge 172:65be27845400 746 * flash area as determined by the index and length.
AnnaBridge 172:65be27845400 747 *
AnnaBridge 172:65be27845400 748 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 749 * @param index The index indicating which area of the Program Once Field to be programmed.
AnnaBridge 172:65be27845400 750 * @param src A pointer to the source buffer of data that is to be programmed
AnnaBridge 172:65be27845400 751 * into the Program Once Field.
AnnaBridge 172:65be27845400 752 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 753 * to be programmed. Must be word-aligned.
AnnaBridge 172:65be27845400 754 *
AnnaBridge 172:65be27845400 755 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 756 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 757 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 758 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 759 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 760 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 761 */
AnnaBridge 172:65be27845400 762 status_t FLASH_ProgramOnce(flash_config_t *config, uint32_t index, uint32_t *src, uint32_t lengthInBytes);
AnnaBridge 172:65be27845400 763
AnnaBridge 172:65be27845400 764 /*!
AnnaBridge 172:65be27845400 765 * @brief Programs flash with data at locations passed in through parameters via the Program Section command.
AnnaBridge 172:65be27845400 766 *
AnnaBridge 172:65be27845400 767 * This function programs the flash memory with the desired data for a given
AnnaBridge 172:65be27845400 768 * flash area as determined by the start address and length.
AnnaBridge 172:65be27845400 769 *
AnnaBridge 172:65be27845400 770 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 771 * @param start The start address of the desired flash memory to be programmed. Must be
AnnaBridge 172:65be27845400 772 * word-aligned.
AnnaBridge 172:65be27845400 773 * @param src A pointer to the source buffer of data that is to be programmed
AnnaBridge 172:65be27845400 774 * into the flash.
AnnaBridge 172:65be27845400 775 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 776 * to be programmed. Must be word-aligned.
AnnaBridge 172:65be27845400 777 *
AnnaBridge 172:65be27845400 778 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 779 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 780 * @retval #kStatus_FLASH_AlignmentError Parameter is not aligned with specified baseline.
AnnaBridge 172:65be27845400 781 * @retval #kStatus_FLASH_AddressError Address is out of range.
AnnaBridge 172:65be27845400 782 * @retval #kStatus_FLASH_SetFlexramAsRamError Failed to set flexram as RAM.
AnnaBridge 172:65be27845400 783 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 784 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 785 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 786 * @retval #kStatus_FLASH_CommandFailure Run-time error during command execution.
AnnaBridge 172:65be27845400 787 * @retval #kStatus_FLASH_RecoverFlexramAsEepromError Failed to recover FlexRAM as EEPROM.
AnnaBridge 172:65be27845400 788 */
AnnaBridge 172:65be27845400 789 #if defined(FSL_FEATURE_FLASH_HAS_PROGRAM_SECTION_CMD) && FSL_FEATURE_FLASH_HAS_PROGRAM_SECTION_CMD
AnnaBridge 172:65be27845400 790 status_t FLASH_ProgramSection(flash_config_t *config, uint32_t start, uint32_t *src, uint32_t lengthInBytes);
AnnaBridge 172:65be27845400 791 #endif
AnnaBridge 172:65be27845400 792
AnnaBridge 172:65be27845400 793 /*!
AnnaBridge 172:65be27845400 794 * @brief Programs the EEPROM with data at locations passed in through parameters.
AnnaBridge 172:65be27845400 795 *
AnnaBridge 172:65be27845400 796 * This function programs the emulated EEPROM with the desired data for a given
AnnaBridge 172:65be27845400 797 * flash area as determined by the start address and length.
AnnaBridge 172:65be27845400 798 *
AnnaBridge 172:65be27845400 799 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 800 * @param start The start address of the desired flash memory to be programmed. Must be
AnnaBridge 172:65be27845400 801 * word-aligned.
AnnaBridge 172:65be27845400 802 * @param src A pointer to the source buffer of data that is to be programmed
AnnaBridge 172:65be27845400 803 * into the flash.
AnnaBridge 172:65be27845400 804 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 805 * to be programmed. Must be word-aligned.
AnnaBridge 172:65be27845400 806 *
AnnaBridge 172:65be27845400 807 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 808 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 809 * @retval #kStatus_FLASH_AddressError Address is out of range.
AnnaBridge 172:65be27845400 810 * @retval #kStatus_FLASH_SetFlexramAsEepromError Failed to set flexram as eeprom.
AnnaBridge 172:65be27845400 811 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 812 * @retval #kStatus_FLASH_RecoverFlexramAsRamError Failed to recover the FlexRAM as RAM.
AnnaBridge 172:65be27845400 813 */
AnnaBridge 172:65be27845400 814 #if FLASH_SSD_IS_FLEXNVM_ENABLED
AnnaBridge 172:65be27845400 815 status_t FLASH_EepromWrite(flash_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes);
AnnaBridge 172:65be27845400 816 #endif
AnnaBridge 172:65be27845400 817
AnnaBridge 172:65be27845400 818 /*@}*/
AnnaBridge 172:65be27845400 819
AnnaBridge 172:65be27845400 820 /*!
AnnaBridge 172:65be27845400 821 * @name Reading
AnnaBridge 172:65be27845400 822 * @{
AnnaBridge 172:65be27845400 823 */
AnnaBridge 172:65be27845400 824
AnnaBridge 172:65be27845400 825 /*!
AnnaBridge 172:65be27845400 826 * @brief Reads the resource with data at locations passed in through parameters.
AnnaBridge 172:65be27845400 827 *
AnnaBridge 172:65be27845400 828 * This function reads the flash memory with the desired location for a given
AnnaBridge 172:65be27845400 829 * flash area as determined by the start address and length.
AnnaBridge 172:65be27845400 830 *
AnnaBridge 172:65be27845400 831 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 832 * @param start The start address of the desired flash memory to be programmed. Must be
AnnaBridge 172:65be27845400 833 * word-aligned.
AnnaBridge 172:65be27845400 834 * @param dst A pointer to the destination buffer of data that is used to store
AnnaBridge 172:65be27845400 835 * data to be read.
AnnaBridge 172:65be27845400 836 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 837 * to be read. Must be word-aligned.
AnnaBridge 172:65be27845400 838 * @param option The resource option which indicates which area should be read back.
AnnaBridge 172:65be27845400 839 *
AnnaBridge 172:65be27845400 840 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 841 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 842 * @retval #kStatus_FLASH_AlignmentError Parameter is not aligned with the specified baseline.
AnnaBridge 172:65be27845400 843 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 844 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 845 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 846 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 847 */
AnnaBridge 172:65be27845400 848 #if defined(FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD) && FSL_FEATURE_FLASH_HAS_READ_RESOURCE_CMD
AnnaBridge 172:65be27845400 849 status_t FLASH_ReadResource(
AnnaBridge 172:65be27845400 850 flash_config_t *config, uint32_t start, uint32_t *dst, uint32_t lengthInBytes, flash_read_resource_option_t option);
AnnaBridge 172:65be27845400 851 #endif
AnnaBridge 172:65be27845400 852
AnnaBridge 172:65be27845400 853 /*!
AnnaBridge 172:65be27845400 854 * @brief Reads the Program Once Field through parameters.
AnnaBridge 172:65be27845400 855 *
AnnaBridge 172:65be27845400 856 * This function reads the read once feild with given index and length.
AnnaBridge 172:65be27845400 857 *
AnnaBridge 172:65be27845400 858 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 859 * @param index The index indicating the area of program once field to be read.
AnnaBridge 172:65be27845400 860 * @param dst A pointer to the destination buffer of data that is used to store
AnnaBridge 172:65be27845400 861 * data to be read.
AnnaBridge 172:65be27845400 862 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 863 * to be programmed. Must be word-aligned.
AnnaBridge 172:65be27845400 864 *
AnnaBridge 172:65be27845400 865 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 866 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 867 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 868 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 869 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 870 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 871 */
AnnaBridge 172:65be27845400 872 status_t FLASH_ReadOnce(flash_config_t *config, uint32_t index, uint32_t *dst, uint32_t lengthInBytes);
AnnaBridge 172:65be27845400 873
AnnaBridge 172:65be27845400 874 /*@}*/
AnnaBridge 172:65be27845400 875
AnnaBridge 172:65be27845400 876 /*!
AnnaBridge 172:65be27845400 877 * @name Security
AnnaBridge 172:65be27845400 878 * @{
AnnaBridge 172:65be27845400 879 */
AnnaBridge 172:65be27845400 880
AnnaBridge 172:65be27845400 881 /*!
AnnaBridge 172:65be27845400 882 * @brief Returns the security state via the pointer passed into the function.
AnnaBridge 172:65be27845400 883 *
AnnaBridge 172:65be27845400 884 * This function retrieves the current flash security status, including the
AnnaBridge 172:65be27845400 885 * security enabling state and the backdoor key enabling state.
AnnaBridge 172:65be27845400 886 *
AnnaBridge 172:65be27845400 887 * @param config A pointer to storage for the driver runtime state.
AnnaBridge 172:65be27845400 888 * @param state A pointer to the value returned for the current security status code:
AnnaBridge 172:65be27845400 889 *
AnnaBridge 172:65be27845400 890 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 891 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 892 */
AnnaBridge 172:65be27845400 893 status_t FLASH_GetSecurityState(flash_config_t *config, flash_security_state_t *state);
AnnaBridge 172:65be27845400 894
AnnaBridge 172:65be27845400 895 /*!
AnnaBridge 172:65be27845400 896 * @brief Allows users to bypass security with a backdoor key.
AnnaBridge 172:65be27845400 897 *
AnnaBridge 172:65be27845400 898 * If the MCU is in secured state, this function unsecures the MCU by
AnnaBridge 172:65be27845400 899 * comparing the provided backdoor key with ones in the flash configuration
AnnaBridge 172:65be27845400 900 * field.
AnnaBridge 172:65be27845400 901 *
AnnaBridge 172:65be27845400 902 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 903 * @param backdoorKey A pointer to the user buffer containing the backdoor key.
AnnaBridge 172:65be27845400 904 *
AnnaBridge 172:65be27845400 905 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 906 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 907 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 908 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 909 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 910 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 911 */
AnnaBridge 172:65be27845400 912 status_t FLASH_SecurityBypass(flash_config_t *config, const uint8_t *backdoorKey);
AnnaBridge 172:65be27845400 913
AnnaBridge 172:65be27845400 914 /*@}*/
AnnaBridge 172:65be27845400 915
AnnaBridge 172:65be27845400 916 /*!
AnnaBridge 172:65be27845400 917 * @name Verification
AnnaBridge 172:65be27845400 918 * @{
AnnaBridge 172:65be27845400 919 */
AnnaBridge 172:65be27845400 920
AnnaBridge 172:65be27845400 921 /*!
AnnaBridge 172:65be27845400 922 * @brief Verifies erasure of the entire flash at a specified margin level.
AnnaBridge 172:65be27845400 923 *
AnnaBridge 172:65be27845400 924 * This function checks whether the flash is erased to the
AnnaBridge 172:65be27845400 925 * specified read margin level.
AnnaBridge 172:65be27845400 926 *
AnnaBridge 172:65be27845400 927 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 928 * @param margin Read margin choice.
AnnaBridge 172:65be27845400 929 *
AnnaBridge 172:65be27845400 930 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 931 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 932 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 933 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 934 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 935 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 936 */
AnnaBridge 172:65be27845400 937 status_t FLASH_VerifyEraseAll(flash_config_t *config, flash_margin_value_t margin);
AnnaBridge 172:65be27845400 938
AnnaBridge 172:65be27845400 939 /*!
AnnaBridge 172:65be27845400 940 * @brief Verifies an erasure of the desired flash area at a specified margin level.
AnnaBridge 172:65be27845400 941 *
AnnaBridge 172:65be27845400 942 * This function checks the appropriate number of flash sectors based on
AnnaBridge 172:65be27845400 943 * the desired start address and length to check whether the flash is erased
AnnaBridge 172:65be27845400 944 * to the specified read margin level.
AnnaBridge 172:65be27845400 945 *
AnnaBridge 172:65be27845400 946 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 947 * @param start The start address of the desired flash memory to be verified.
AnnaBridge 172:65be27845400 948 * The start address does not need to be sector-aligned but must be word-aligned.
AnnaBridge 172:65be27845400 949 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 950 * to be verified. Must be word-aligned.
AnnaBridge 172:65be27845400 951 * @param margin Read margin choice.
AnnaBridge 172:65be27845400 952 *
AnnaBridge 172:65be27845400 953 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 954 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 955 * @retval #kStatus_FLASH_AlignmentError Parameter is not aligned with specified baseline.
AnnaBridge 172:65be27845400 956 * @retval #kStatus_FLASH_AddressError Address is out of range.
AnnaBridge 172:65be27845400 957 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 958 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 959 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 960 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 961 */
AnnaBridge 172:65be27845400 962 status_t FLASH_VerifyErase(flash_config_t *config, uint32_t start, uint32_t lengthInBytes, flash_margin_value_t margin);
AnnaBridge 172:65be27845400 963
AnnaBridge 172:65be27845400 964 /*!
AnnaBridge 172:65be27845400 965 * @brief Verifies programming of the desired flash area at a specified margin level.
AnnaBridge 172:65be27845400 966 *
AnnaBridge 172:65be27845400 967 * This function verifies the data programed in the flash memory using the
AnnaBridge 172:65be27845400 968 * Flash Program Check Command and compares it to the expected data for a given
AnnaBridge 172:65be27845400 969 * flash area as determined by the start address and length.
AnnaBridge 172:65be27845400 970 *
AnnaBridge 172:65be27845400 971 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 972 * @param start The start address of the desired flash memory to be verified. Must be word-aligned.
AnnaBridge 172:65be27845400 973 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 974 * to be verified. Must be word-aligned.
AnnaBridge 172:65be27845400 975 * @param expectedData A pointer to the expected data that is to be
AnnaBridge 172:65be27845400 976 * verified against.
AnnaBridge 172:65be27845400 977 * @param margin Read margin choice.
AnnaBridge 172:65be27845400 978 * @param failedAddress A pointer to the returned failing address.
AnnaBridge 172:65be27845400 979 * @param failedData A pointer to the returned failing data. Some derivatives do
AnnaBridge 172:65be27845400 980 * not include failed data as part of the FCCOBx registers. In this
AnnaBridge 172:65be27845400 981 * case, zeros are returned upon failure.
AnnaBridge 172:65be27845400 982 *
AnnaBridge 172:65be27845400 983 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 984 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 985 * @retval #kStatus_FLASH_AlignmentError Parameter is not aligned with specified baseline.
AnnaBridge 172:65be27845400 986 * @retval #kStatus_FLASH_AddressError Address is out of range.
AnnaBridge 172:65be27845400 987 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 988 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 989 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 990 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 991 */
AnnaBridge 172:65be27845400 992 status_t FLASH_VerifyProgram(flash_config_t *config,
AnnaBridge 172:65be27845400 993 uint32_t start,
AnnaBridge 172:65be27845400 994 uint32_t lengthInBytes,
AnnaBridge 172:65be27845400 995 const uint32_t *expectedData,
AnnaBridge 172:65be27845400 996 flash_margin_value_t margin,
AnnaBridge 172:65be27845400 997 uint32_t *failedAddress,
AnnaBridge 172:65be27845400 998 uint32_t *failedData);
AnnaBridge 172:65be27845400 999
AnnaBridge 172:65be27845400 1000 /*!
AnnaBridge 172:65be27845400 1001 * @brief Verifies whether the program flash execute-only segments have been erased to
AnnaBridge 172:65be27845400 1002 * the specified read margin level.
AnnaBridge 172:65be27845400 1003 *
AnnaBridge 172:65be27845400 1004 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1005 * @param margin Read margin choice.
AnnaBridge 172:65be27845400 1006 *
AnnaBridge 172:65be27845400 1007 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1008 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1009 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 1010 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 1011 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 1012 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 1013 */
AnnaBridge 172:65be27845400 1014 status_t FLASH_VerifyEraseAllExecuteOnlySegments(flash_config_t *config, flash_margin_value_t margin);
AnnaBridge 172:65be27845400 1015
AnnaBridge 172:65be27845400 1016 /*@}*/
AnnaBridge 172:65be27845400 1017
AnnaBridge 172:65be27845400 1018 /*!
AnnaBridge 172:65be27845400 1019 * @name Protection
AnnaBridge 172:65be27845400 1020 * @{
AnnaBridge 172:65be27845400 1021 */
AnnaBridge 172:65be27845400 1022
AnnaBridge 172:65be27845400 1023 /*!
AnnaBridge 172:65be27845400 1024 * @brief Returns the protection state of the desired flash area via the pointer passed into the function.
AnnaBridge 172:65be27845400 1025 *
AnnaBridge 172:65be27845400 1026 * This function retrieves the current flash protect status for a given
AnnaBridge 172:65be27845400 1027 * flash area as determined by the start address and length.
AnnaBridge 172:65be27845400 1028 *
AnnaBridge 172:65be27845400 1029 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1030 * @param start The start address of the desired flash memory to be checked. Must be word-aligned.
AnnaBridge 172:65be27845400 1031 * @param lengthInBytes The length, given in bytes (not words or long-words)
AnnaBridge 172:65be27845400 1032 * to be checked. Must be word-aligned.
AnnaBridge 172:65be27845400 1033 * @param protection_state A pointer to the value returned for the current
AnnaBridge 172:65be27845400 1034 * protection status code for the desired flash area.
AnnaBridge 172:65be27845400 1035 *
AnnaBridge 172:65be27845400 1036 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1037 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1038 * @retval #kStatus_FLASH_AlignmentError Parameter is not aligned with specified baseline.
AnnaBridge 172:65be27845400 1039 * @retval #kStatus_FLASH_AddressError The address is out of range.
AnnaBridge 172:65be27845400 1040 */
AnnaBridge 172:65be27845400 1041 status_t FLASH_IsProtected(flash_config_t *config,
AnnaBridge 172:65be27845400 1042 uint32_t start,
AnnaBridge 172:65be27845400 1043 uint32_t lengthInBytes,
AnnaBridge 172:65be27845400 1044 flash_protection_state_t *protection_state);
AnnaBridge 172:65be27845400 1045
AnnaBridge 172:65be27845400 1046 /*!
AnnaBridge 172:65be27845400 1047 * @brief Returns the access state of the desired flash area via the pointer passed into the function.
AnnaBridge 172:65be27845400 1048 *
AnnaBridge 172:65be27845400 1049 * This function retrieves the current flash access status for a given
AnnaBridge 172:65be27845400 1050 * flash area as determined by the start address and length.
AnnaBridge 172:65be27845400 1051 *
AnnaBridge 172:65be27845400 1052 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1053 * @param start The start address of the desired flash memory to be checked. Must be word-aligned.
AnnaBridge 172:65be27845400 1054 * @param lengthInBytes The length, given in bytes (not words or long-words),
AnnaBridge 172:65be27845400 1055 * to be checked. Must be word-aligned.
AnnaBridge 172:65be27845400 1056 * @param access_state A pointer to the value returned for the current
AnnaBridge 172:65be27845400 1057 * access status code for the desired flash area.
AnnaBridge 172:65be27845400 1058 *
AnnaBridge 172:65be27845400 1059 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1060 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1061 * @retval #kStatus_FLASH_AlignmentError The parameter is not aligned to the specified baseline.
AnnaBridge 172:65be27845400 1062 * @retval #kStatus_FLASH_AddressError The address is out of range.
AnnaBridge 172:65be27845400 1063 */
AnnaBridge 172:65be27845400 1064 status_t FLASH_IsExecuteOnly(flash_config_t *config,
AnnaBridge 172:65be27845400 1065 uint32_t start,
AnnaBridge 172:65be27845400 1066 uint32_t lengthInBytes,
AnnaBridge 172:65be27845400 1067 flash_execute_only_access_state_t *access_state);
AnnaBridge 172:65be27845400 1068
AnnaBridge 172:65be27845400 1069 /*@}*/
AnnaBridge 172:65be27845400 1070
AnnaBridge 172:65be27845400 1071 /*!
AnnaBridge 172:65be27845400 1072 * @name Properties
AnnaBridge 172:65be27845400 1073 * @{
AnnaBridge 172:65be27845400 1074 */
AnnaBridge 172:65be27845400 1075
AnnaBridge 172:65be27845400 1076 /*!
AnnaBridge 172:65be27845400 1077 * @brief Returns the desired flash property.
AnnaBridge 172:65be27845400 1078 *
AnnaBridge 172:65be27845400 1079 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1080 * @param whichProperty The desired property from the list of properties in
AnnaBridge 172:65be27845400 1081 * enum flash_property_tag_t
AnnaBridge 172:65be27845400 1082 * @param value A pointer to the value returned for the desired flash property.
AnnaBridge 172:65be27845400 1083 *
AnnaBridge 172:65be27845400 1084 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1085 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1086 * @retval #kStatus_FLASH_UnknownProperty An unknown property tag.
AnnaBridge 172:65be27845400 1087 */
AnnaBridge 172:65be27845400 1088 status_t FLASH_GetProperty(flash_config_t *config, flash_property_tag_t whichProperty, uint32_t *value);
AnnaBridge 172:65be27845400 1089
AnnaBridge 172:65be27845400 1090 /*!
AnnaBridge 172:65be27845400 1091 * @brief Sets the desired flash property.
AnnaBridge 172:65be27845400 1092 *
AnnaBridge 172:65be27845400 1093 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1094 * @param whichProperty The desired property from the list of properties in
AnnaBridge 172:65be27845400 1095 * enum flash_property_tag_t
AnnaBridge 172:65be27845400 1096 * @param value A to set for the desired flash property.
AnnaBridge 172:65be27845400 1097 *
AnnaBridge 172:65be27845400 1098 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1099 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1100 * @retval #kStatus_FLASH_UnknownProperty An unknown property tag.
AnnaBridge 172:65be27845400 1101 * @retval #kStatus_FLASH_InvalidPropertyValue An invalid property value.
AnnaBridge 172:65be27845400 1102 * @retval #kStatus_FLASH_ReadOnlyProperty An read-only property tag.
AnnaBridge 172:65be27845400 1103 */
AnnaBridge 172:65be27845400 1104 #if FLASH_SSD_IS_SECONDARY_FLASH_SUPPORTED
AnnaBridge 172:65be27845400 1105 status_t FLASH_SetProperty(flash_config_t *config, flash_property_tag_t whichProperty, uint32_t value);
AnnaBridge 172:65be27845400 1106 #endif
AnnaBridge 172:65be27845400 1107
AnnaBridge 172:65be27845400 1108 /*@}*/
AnnaBridge 172:65be27845400 1109
AnnaBridge 172:65be27845400 1110 /*!
AnnaBridge 172:65be27845400 1111 * @name FlexRAM
AnnaBridge 172:65be27845400 1112 * @{
AnnaBridge 172:65be27845400 1113 */
AnnaBridge 172:65be27845400 1114
AnnaBridge 172:65be27845400 1115 /*!
AnnaBridge 172:65be27845400 1116 * @brief Sets the FlexRAM function command.
AnnaBridge 172:65be27845400 1117 *
AnnaBridge 172:65be27845400 1118 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1119 * @param option The option used to set the work mode of FlexRAM.
AnnaBridge 172:65be27845400 1120 *
AnnaBridge 172:65be27845400 1121 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1122 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1123 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 1124 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 1125 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 1126 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 1127 */
AnnaBridge 172:65be27845400 1128 #if defined(FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD) && FSL_FEATURE_FLASH_HAS_SET_FLEXRAM_FUNCTION_CMD
AnnaBridge 172:65be27845400 1129 status_t FLASH_SetFlexramFunction(flash_config_t *config, flash_flexram_function_option_t option);
AnnaBridge 172:65be27845400 1130 #endif
AnnaBridge 172:65be27845400 1131
AnnaBridge 172:65be27845400 1132 /*@}*/
AnnaBridge 172:65be27845400 1133
AnnaBridge 172:65be27845400 1134 /*!
AnnaBridge 172:65be27845400 1135 * @name Swap
AnnaBridge 172:65be27845400 1136 * @{
AnnaBridge 172:65be27845400 1137 */
AnnaBridge 172:65be27845400 1138
AnnaBridge 172:65be27845400 1139 /*!
AnnaBridge 172:65be27845400 1140 * @brief Configures the Swap function or checks the the swap state of the Flash module.
AnnaBridge 172:65be27845400 1141 *
AnnaBridge 172:65be27845400 1142 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1143 * @param address Address used to configure the flash Swap function.
AnnaBridge 172:65be27845400 1144 * @param option The possible option used to configure Flash Swap function or check the flash Swap status
AnnaBridge 172:65be27845400 1145 * @param returnInfo A pointer to the data which is used to return the information of flash Swap.
AnnaBridge 172:65be27845400 1146 *
AnnaBridge 172:65be27845400 1147 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1148 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1149 * @retval #kStatus_FLASH_AlignmentError Parameter is not aligned with specified baseline.
AnnaBridge 172:65be27845400 1150 * @retval #kStatus_FLASH_SwapIndicatorAddressError Swap indicator address is invalid.
AnnaBridge 172:65be27845400 1151 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 1152 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 1153 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 1154 * @retval #kStatus_FLASH_CommandFailure Run-time error during the command execution.
AnnaBridge 172:65be27845400 1155 */
AnnaBridge 172:65be27845400 1156 #if defined(FSL_FEATURE_FLASH_HAS_SWAP_CONTROL_CMD) && FSL_FEATURE_FLASH_HAS_SWAP_CONTROL_CMD
AnnaBridge 172:65be27845400 1157 status_t FLASH_SwapControl(flash_config_t *config,
AnnaBridge 172:65be27845400 1158 uint32_t address,
AnnaBridge 172:65be27845400 1159 flash_swap_control_option_t option,
AnnaBridge 172:65be27845400 1160 flash_swap_state_config_t *returnInfo);
AnnaBridge 172:65be27845400 1161 #endif
AnnaBridge 172:65be27845400 1162
AnnaBridge 172:65be27845400 1163 /*!
AnnaBridge 172:65be27845400 1164 * @brief Swaps the lower half flash with the higher half flash.
AnnaBridge 172:65be27845400 1165 *
AnnaBridge 172:65be27845400 1166 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1167 * @param address Address used to configure the flash swap function
AnnaBridge 172:65be27845400 1168 * @param option The possible option used to configure the Flash Swap function or check the flash Swap status.
AnnaBridge 172:65be27845400 1169 *
AnnaBridge 172:65be27845400 1170 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1171 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1172 * @retval #kStatus_FLASH_AlignmentError Parameter is not aligned with specified baseline.
AnnaBridge 172:65be27845400 1173 * @retval #kStatus_FLASH_SwapIndicatorAddressError Swap indicator address is invalid.
AnnaBridge 172:65be27845400 1174 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 1175 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 1176 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 1177 * @retval #kStatus_FLASH_CommandFailure Run-time error during command execution.
AnnaBridge 172:65be27845400 1178 * @retval #kStatus_FLASH_SwapSystemNotInUninitialized Swap system is not in an uninitialzed state.
AnnaBridge 172:65be27845400 1179 */
AnnaBridge 172:65be27845400 1180 #if defined(FSL_FEATURE_FLASH_HAS_PFLASH_BLOCK_SWAP) && FSL_FEATURE_FLASH_HAS_PFLASH_BLOCK_SWAP
AnnaBridge 172:65be27845400 1181 status_t FLASH_Swap(flash_config_t *config, uint32_t address, flash_swap_function_option_t option);
AnnaBridge 172:65be27845400 1182 #endif
AnnaBridge 172:65be27845400 1183
AnnaBridge 172:65be27845400 1184 /*!
AnnaBridge 172:65be27845400 1185 * @name FlexNVM
AnnaBridge 172:65be27845400 1186 * @{
AnnaBridge 172:65be27845400 1187 */
AnnaBridge 172:65be27845400 1188
AnnaBridge 172:65be27845400 1189 /*!
AnnaBridge 172:65be27845400 1190 * @brief Prepares the FlexNVM block for use as data flash, EEPROM backup, or a combination of both and initializes the
AnnaBridge 172:65be27845400 1191 * FlexRAM.
AnnaBridge 172:65be27845400 1192 *
AnnaBridge 172:65be27845400 1193 * @param config Pointer to storage for the driver runtime state.
AnnaBridge 172:65be27845400 1194 * @param option The option used to set FlexRAM load behavior during reset.
AnnaBridge 172:65be27845400 1195 * @param eepromDataSizeCode Determines the amount of FlexRAM used in each of the available EEPROM subsystems.
AnnaBridge 172:65be27845400 1196 * @param flexnvmPartitionCode Specifies how to split the FlexNVM block between data flash memory and EEPROM backup
AnnaBridge 172:65be27845400 1197 * memory supporting EEPROM functions.
AnnaBridge 172:65be27845400 1198 *
AnnaBridge 172:65be27845400 1199 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1200 * @retval #kStatus_FLASH_InvalidArgument Invalid argument is provided.
AnnaBridge 172:65be27845400 1201 * @retval #kStatus_FLASH_ExecuteInRamFunctionNotReady Execute-in-RAM function is not available.
AnnaBridge 172:65be27845400 1202 * @retval #kStatus_FLASH_AccessError Invalid instruction codes and out-of bounds addresses.
AnnaBridge 172:65be27845400 1203 * @retval #kStatus_FLASH_ProtectionViolation The program/erase operation is requested to execute on protected areas.
AnnaBridge 172:65be27845400 1204 * @retval #kStatus_FLASH_CommandFailure Run-time error during command execution.
AnnaBridge 172:65be27845400 1205 */
AnnaBridge 172:65be27845400 1206 #if defined(FSL_FEATURE_FLASH_HAS_PROGRAM_PARTITION_CMD) && FSL_FEATURE_FLASH_HAS_PROGRAM_PARTITION_CMD
AnnaBridge 172:65be27845400 1207 status_t FLASH_ProgramPartition(flash_config_t *config,
AnnaBridge 172:65be27845400 1208 flash_partition_flexram_load_option_t option,
AnnaBridge 172:65be27845400 1209 uint32_t eepromDataSizeCode,
AnnaBridge 172:65be27845400 1210 uint32_t flexnvmPartitionCode);
AnnaBridge 172:65be27845400 1211 #endif
AnnaBridge 172:65be27845400 1212
AnnaBridge 172:65be27845400 1213 /*@}*/
AnnaBridge 172:65be27845400 1214
AnnaBridge 172:65be27845400 1215 /*!
AnnaBridge 172:65be27845400 1216 * @name Flash Protection Utilities
AnnaBridge 172:65be27845400 1217 * @{
AnnaBridge 172:65be27845400 1218 */
AnnaBridge 172:65be27845400 1219
AnnaBridge 172:65be27845400 1220 /*!
AnnaBridge 172:65be27845400 1221 * @brief Sets the PFlash Protection to the intended protection status.
AnnaBridge 172:65be27845400 1222 *
AnnaBridge 172:65be27845400 1223 * @param config A pointer to storage for the driver runtime state.
AnnaBridge 172:65be27845400 1224 * @param protectStatus The expected protect status to set to the PFlash protection register. Each bit is
AnnaBridge 172:65be27845400 1225 * corresponding to protection of 1/32(64) of the total PFlash. The least significant bit is corresponding to the lowest
AnnaBridge 172:65be27845400 1226 * address area of PFlash. The most significant bit is corresponding to the highest address area of PFlash. There are
AnnaBridge 172:65be27845400 1227 * two possible cases as shown below:
AnnaBridge 172:65be27845400 1228 * 0: this area is protected.
AnnaBridge 172:65be27845400 1229 * 1: this area is unprotected.
AnnaBridge 172:65be27845400 1230 *
AnnaBridge 172:65be27845400 1231 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1232 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1233 * @retval #kStatus_FLASH_CommandFailure Run-time error during command execution.
AnnaBridge 172:65be27845400 1234 */
AnnaBridge 172:65be27845400 1235 status_t FLASH_PflashSetProtection(flash_config_t *config, pflash_protection_status_t *protectStatus);
AnnaBridge 172:65be27845400 1236
AnnaBridge 172:65be27845400 1237 /*!
AnnaBridge 172:65be27845400 1238 * @brief Gets the PFlash protection status.
AnnaBridge 172:65be27845400 1239 *
AnnaBridge 172:65be27845400 1240 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1241 * @param protectStatus Protect status returned by the PFlash IP. Each bit is corresponding to the protection of
AnnaBridge 172:65be27845400 1242 * 1/32(64)
AnnaBridge 172:65be27845400 1243 * of the
AnnaBridge 172:65be27845400 1244 * total PFlash. The least significant bit corresponds to the lowest address area of the PFlash. The most significant
AnnaBridge 172:65be27845400 1245 * bit corresponds to the highest address area of PFlash. There are two possible cases as shown below:
AnnaBridge 172:65be27845400 1246 * 0: this area is protected.
AnnaBridge 172:65be27845400 1247 * 1: this area is unprotected.
AnnaBridge 172:65be27845400 1248 *
AnnaBridge 172:65be27845400 1249 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1250 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1251 */
AnnaBridge 172:65be27845400 1252 status_t FLASH_PflashGetProtection(flash_config_t *config, pflash_protection_status_t *protectStatus);
AnnaBridge 172:65be27845400 1253
AnnaBridge 172:65be27845400 1254 /*!
AnnaBridge 172:65be27845400 1255 * @brief Sets the DFlash protection to the intended protection status.
AnnaBridge 172:65be27845400 1256 *
AnnaBridge 172:65be27845400 1257 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1258 * @param protectStatus The expected protect status to set to the DFlash protection register. Each bit
AnnaBridge 172:65be27845400 1259 * corresponds to the protection of the 1/8 of the total DFlash. The least significant bit corresponds to the lowest
AnnaBridge 172:65be27845400 1260 * address area of the DFlash. The most significant bit corresponds to the highest address area of the DFlash. There
AnnaBridge 172:65be27845400 1261 * are
AnnaBridge 172:65be27845400 1262 * two possible cases as shown below:
AnnaBridge 172:65be27845400 1263 * 0: this area is protected.
AnnaBridge 172:65be27845400 1264 * 1: this area is unprotected.
AnnaBridge 172:65be27845400 1265 *
AnnaBridge 172:65be27845400 1266 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1267 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1268 * @retval #kStatus_FLASH_CommandNotSupported Flash API is not supported.
AnnaBridge 172:65be27845400 1269 * @retval #kStatus_FLASH_CommandFailure Run-time error during command execution.
AnnaBridge 172:65be27845400 1270 */
AnnaBridge 172:65be27845400 1271 #if FLASH_SSD_IS_FLEXNVM_ENABLED
AnnaBridge 172:65be27845400 1272 status_t FLASH_DflashSetProtection(flash_config_t *config, uint8_t protectStatus);
AnnaBridge 172:65be27845400 1273 #endif
AnnaBridge 172:65be27845400 1274
AnnaBridge 172:65be27845400 1275 /*!
AnnaBridge 172:65be27845400 1276 * @brief Gets the DFlash protection status.
AnnaBridge 172:65be27845400 1277 *
AnnaBridge 172:65be27845400 1278 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1279 * @param protectStatus DFlash Protect status returned by the PFlash IP. Each bit corresponds to the protection of the
AnnaBridge 172:65be27845400 1280 * 1/8 of
AnnaBridge 172:65be27845400 1281 * the total DFlash. The least significant bit corresponds to the lowest address area of the DFlash. The most
AnnaBridge 172:65be27845400 1282 * significant bit corresponds to the highest address area of the DFlash, and so on. There are two possible cases as
AnnaBridge 172:65be27845400 1283 * below:
AnnaBridge 172:65be27845400 1284 * 0: this area is protected.
AnnaBridge 172:65be27845400 1285 * 1: this area is unprotected.
AnnaBridge 172:65be27845400 1286 *
AnnaBridge 172:65be27845400 1287 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1288 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1289 * @retval #kStatus_FLASH_CommandNotSupported Flash API is not supported.
AnnaBridge 172:65be27845400 1290 */
AnnaBridge 172:65be27845400 1291 #if FLASH_SSD_IS_FLEXNVM_ENABLED
AnnaBridge 172:65be27845400 1292 status_t FLASH_DflashGetProtection(flash_config_t *config, uint8_t *protectStatus);
AnnaBridge 172:65be27845400 1293 #endif
AnnaBridge 172:65be27845400 1294
AnnaBridge 172:65be27845400 1295 /*!
AnnaBridge 172:65be27845400 1296 * @brief Sets the EEPROM protection to the intended protection status.
AnnaBridge 172:65be27845400 1297 *
AnnaBridge 172:65be27845400 1298 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1299 * @param protectStatus The expected protect status to set to the EEPROM protection register. Each bit
AnnaBridge 172:65be27845400 1300 * corresponds to the protection of the 1/8 of the total EEPROM. The least significant bit corresponds to the lowest
AnnaBridge 172:65be27845400 1301 * address area of the EEPROM. The most significant bit corresponds to the highest address area of EEPROM, and so on.
AnnaBridge 172:65be27845400 1302 * There are two possible cases as shown below:
AnnaBridge 172:65be27845400 1303 * 0: this area is protected.
AnnaBridge 172:65be27845400 1304 * 1: this area is unprotected.
AnnaBridge 172:65be27845400 1305 *
AnnaBridge 172:65be27845400 1306 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1307 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1308 * @retval #kStatus_FLASH_CommandNotSupported Flash API is not supported.
AnnaBridge 172:65be27845400 1309 * @retval #kStatus_FLASH_CommandFailure Run-time error during command execution.
AnnaBridge 172:65be27845400 1310 */
AnnaBridge 172:65be27845400 1311 #if FLASH_SSD_IS_FLEXNVM_ENABLED
AnnaBridge 172:65be27845400 1312 status_t FLASH_EepromSetProtection(flash_config_t *config, uint8_t protectStatus);
AnnaBridge 172:65be27845400 1313 #endif
AnnaBridge 172:65be27845400 1314
AnnaBridge 172:65be27845400 1315 /*!
AnnaBridge 172:65be27845400 1316 * @brief Gets the DFlash protection status.
AnnaBridge 172:65be27845400 1317 *
AnnaBridge 172:65be27845400 1318 * @param config A pointer to the storage for the driver runtime state.
AnnaBridge 172:65be27845400 1319 * @param protectStatus DFlash Protect status returned by the PFlash IP. Each bit corresponds to the protection of the
AnnaBridge 172:65be27845400 1320 * 1/8 of
AnnaBridge 172:65be27845400 1321 * the total EEPROM. The least significant bit corresponds to the lowest address area of the EEPROM. The most
AnnaBridge 172:65be27845400 1322 * significant bit corresponds to the highest address area of the EEPROM. There are two possible cases as below:
AnnaBridge 172:65be27845400 1323 * 0: this area is protected.
AnnaBridge 172:65be27845400 1324 * 1: this area is unprotected.
AnnaBridge 172:65be27845400 1325 *
AnnaBridge 172:65be27845400 1326 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1327 * @retval #kStatus_FLASH_InvalidArgument An invalid argument is provided.
AnnaBridge 172:65be27845400 1328 * @retval #kStatus_FLASH_CommandNotSupported Flash API is not supported.
AnnaBridge 172:65be27845400 1329 */
AnnaBridge 172:65be27845400 1330 #if FLASH_SSD_IS_FLEXNVM_ENABLED
AnnaBridge 172:65be27845400 1331 status_t FLASH_EepromGetProtection(flash_config_t *config, uint8_t *protectStatus);
AnnaBridge 172:65be27845400 1332 #endif
AnnaBridge 172:65be27845400 1333
AnnaBridge 172:65be27845400 1334 /*@}*/
AnnaBridge 172:65be27845400 1335
AnnaBridge 172:65be27845400 1336 /*@}*/
AnnaBridge 172:65be27845400 1337
AnnaBridge 172:65be27845400 1338 /*!
AnnaBridge 172:65be27845400 1339 * @name Flash Speculation Utilities
AnnaBridge 172:65be27845400 1340 * @{
AnnaBridge 172:65be27845400 1341 */
AnnaBridge 172:65be27845400 1342
AnnaBridge 172:65be27845400 1343 /*!
AnnaBridge 172:65be27845400 1344 * @brief Sets the PFlash prefetch speculation to the intended speculation status.
AnnaBridge 172:65be27845400 1345 *
AnnaBridge 172:65be27845400 1346 * @param speculationStatus The expected protect status to set to the PFlash protection register. Each bit is
AnnaBridge 172:65be27845400 1347 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1348 * @retval #kStatus_FLASH_InvalidSpeculationOption An invalid speculation option argument is provided.
AnnaBridge 172:65be27845400 1349 */
AnnaBridge 172:65be27845400 1350 status_t FLASH_PflashSetPrefetchSpeculation(flash_prefetch_speculation_status_t *speculationStatus);
AnnaBridge 172:65be27845400 1351
AnnaBridge 172:65be27845400 1352 /*!
AnnaBridge 172:65be27845400 1353 * @brief Gets the PFlash prefetch speculation status.
AnnaBridge 172:65be27845400 1354 *
AnnaBridge 172:65be27845400 1355 * @param speculationStatus Speculation status returned by the PFlash IP.
AnnaBridge 172:65be27845400 1356 * @retval #kStatus_FLASH_Success API was executed successfully.
AnnaBridge 172:65be27845400 1357 */
AnnaBridge 172:65be27845400 1358 status_t FLASH_PflashGetPrefetchSpeculation(flash_prefetch_speculation_status_t *speculationStatus);
AnnaBridge 172:65be27845400 1359
AnnaBridge 172:65be27845400 1360 /*@}*/
AnnaBridge 172:65be27845400 1361
AnnaBridge 172:65be27845400 1362 #if defined(__cplusplus)
AnnaBridge 172:65be27845400 1363 }
AnnaBridge 172:65be27845400 1364 #endif
AnnaBridge 172:65be27845400 1365
AnnaBridge 172:65be27845400 1366 /*! @}*/
AnnaBridge 172:65be27845400 1367
AnnaBridge 172:65be27845400 1368 #endif /* _FSL_FLASH_H_ */