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_FF_LPC546XX/TOOLCHAIN_GCC_ARM/fsl_eeprom.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*
AnnaBridge 171:3a7713b1edbc 2 * The Clear BSD License
AnnaBridge 171:3a7713b1edbc 3 * Copyright (c) 2016, Freescale Semiconductor, Inc.
AnnaBridge 171:3a7713b1edbc 4 * Copyright 2016-2017 NXP
AnnaBridge 171:3a7713b1edbc 5 * All rights reserved.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 171:3a7713b1edbc 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 171:3a7713b1edbc 9 * that the following conditions are met:
AnnaBridge 171:3a7713b1edbc 10 *
AnnaBridge 171:3a7713b1edbc 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 171:3a7713b1edbc 12 * of conditions and the following disclaimer.
AnnaBridge 171:3a7713b1edbc 13 *
AnnaBridge 171:3a7713b1edbc 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 171:3a7713b1edbc 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 171:3a7713b1edbc 16 * other materials provided with the distribution.
AnnaBridge 171:3a7713b1edbc 17 *
AnnaBridge 171:3a7713b1edbc 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 171:3a7713b1edbc 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 171:3a7713b1edbc 20 * software without specific prior written permission.
AnnaBridge 171:3a7713b1edbc 21 *
AnnaBridge 171:3a7713b1edbc 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 171:3a7713b1edbc 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 171:3a7713b1edbc 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 171:3a7713b1edbc 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 171:3a7713b1edbc 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 171:3a7713b1edbc 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 171:3a7713b1edbc 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 171:3a7713b1edbc 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 171:3a7713b1edbc 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 171:3a7713b1edbc 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 171:3a7713b1edbc 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 171:3a7713b1edbc 33 */
AnnaBridge 171:3a7713b1edbc 34 #ifndef _FSL_EEPROM_H_
AnnaBridge 171:3a7713b1edbc 35 #define _FSL_EEPROM_H_
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 #include "fsl_common.h"
AnnaBridge 171:3a7713b1edbc 38
AnnaBridge 171:3a7713b1edbc 39 /*!
AnnaBridge 171:3a7713b1edbc 40 * @addtogroup eeprom
AnnaBridge 171:3a7713b1edbc 41 * @{
AnnaBridge 171:3a7713b1edbc 42 */
AnnaBridge 171:3a7713b1edbc 43
AnnaBridge 171:3a7713b1edbc 44 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 45 * Definitions
AnnaBridge 171:3a7713b1edbc 46 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 47
AnnaBridge 171:3a7713b1edbc 48 /*! @name Driver version */
AnnaBridge 171:3a7713b1edbc 49 /*@{*/
AnnaBridge 171:3a7713b1edbc 50 /*! @brief EEPROM driver version 2.0.0. */
AnnaBridge 171:3a7713b1edbc 51 #define FSL_EEPROM_DRIVER_VERSION (MAKE_VERSION(2, 0, 0))
AnnaBridge 171:3a7713b1edbc 52 /*@}*/
AnnaBridge 171:3a7713b1edbc 53
AnnaBridge 171:3a7713b1edbc 54 /*! @brief EEPROM automatic program option */
AnnaBridge 171:3a7713b1edbc 55 typedef enum _eeprom_auto_program
AnnaBridge 171:3a7713b1edbc 56 {
AnnaBridge 171:3a7713b1edbc 57 kEEPROM_AutoProgramDisable = 0x0, /*!< Disable auto program */
AnnaBridge 171:3a7713b1edbc 58 kEEPROM_AutoProgramWriteWord = 0x1, /*!< Auto program triggered after 1 word is written */
AnnaBridge 171:3a7713b1edbc 59 kEEPROM_AutoProgramLastWord = 0x2 /*!< Auto program triggered after last word of a page written */
AnnaBridge 171:3a7713b1edbc 60 } eeprom_auto_program_t;
AnnaBridge 171:3a7713b1edbc 61
AnnaBridge 171:3a7713b1edbc 62 /*! @brief EEPROM interrupt source */
AnnaBridge 171:3a7713b1edbc 63 typedef enum _eeprom_interrupt_enable
AnnaBridge 171:3a7713b1edbc 64 {
AnnaBridge 171:3a7713b1edbc 65 kEEPROM_ProgramFinishInterruptEnable = EEPROM_INTENSET_PROG_SET_EN_MASK, /*!< Interrupt while program finished */
AnnaBridge 171:3a7713b1edbc 66 } eeprom_interrupt_enable_t;
AnnaBridge 171:3a7713b1edbc 67
AnnaBridge 171:3a7713b1edbc 68 /*!
AnnaBridge 171:3a7713b1edbc 69 * @brief EEPROM region configuration structure.
AnnaBridge 171:3a7713b1edbc 70 */
AnnaBridge 171:3a7713b1edbc 71 typedef struct _eeprom_config
AnnaBridge 171:3a7713b1edbc 72 {
AnnaBridge 171:3a7713b1edbc 73 eeprom_auto_program_t autoProgram; /*!< Automatic program feature. */
AnnaBridge 171:3a7713b1edbc 74 uint8_t readWaitPhase1; /*!< EEPROM read waiting phase 1 */
AnnaBridge 171:3a7713b1edbc 75 uint8_t readWaitPhase2; /*!< EEPROM read waiting phase 2 */
AnnaBridge 171:3a7713b1edbc 76 uint8_t writeWaitPhase1; /*!< EEPROM write waiting phase 1 */
AnnaBridge 171:3a7713b1edbc 77 uint8_t writeWaitPhase2; /*!< EEPROM write waiting phase 2 */
AnnaBridge 171:3a7713b1edbc 78 uint8_t writeWaitPhase3; /*!< EEPROM write waiting phase 3 */
AnnaBridge 171:3a7713b1edbc 79 bool lockTimingParam; /*!< If lock the read and write wait phase settings */
AnnaBridge 171:3a7713b1edbc 80 } eeprom_config_t;
AnnaBridge 171:3a7713b1edbc 81
AnnaBridge 171:3a7713b1edbc 82 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 83 * API
AnnaBridge 171:3a7713b1edbc 84 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 85
AnnaBridge 171:3a7713b1edbc 86 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 87 extern "C" {
AnnaBridge 171:3a7713b1edbc 88 #endif /* _cplusplus */
AnnaBridge 171:3a7713b1edbc 89
AnnaBridge 171:3a7713b1edbc 90 /*!
AnnaBridge 171:3a7713b1edbc 91 * @name Initialization and deinitialization
AnnaBridge 171:3a7713b1edbc 92 * @{
AnnaBridge 171:3a7713b1edbc 93 */
AnnaBridge 171:3a7713b1edbc 94
AnnaBridge 171:3a7713b1edbc 95 /*!
AnnaBridge 171:3a7713b1edbc 96 * @brief Initializes the EEPROM with the user configuration structure.
AnnaBridge 171:3a7713b1edbc 97 *
AnnaBridge 171:3a7713b1edbc 98 * This function configures the EEPROM module with the user-defined configuration. This function also sets the
AnnaBridge 171:3a7713b1edbc 99 * internal clock frequency to about 155kHz according to the source clock frequency.
AnnaBridge 171:3a7713b1edbc 100 *
AnnaBridge 171:3a7713b1edbc 101 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 102 * @param config The pointer to the configuration structure.
AnnaBridge 171:3a7713b1edbc 103 * @param sourceClock_Hz EEPROM source clock frequency in Hz.
AnnaBridge 171:3a7713b1edbc 104 */
AnnaBridge 171:3a7713b1edbc 105 void EEPROM_Init(EEPROM_Type *base, const eeprom_config_t *config, uint32_t sourceClock_Hz);
AnnaBridge 171:3a7713b1edbc 106
AnnaBridge 171:3a7713b1edbc 107 /*!
AnnaBridge 171:3a7713b1edbc 108 * @brief Get EEPROM default configure settings.
AnnaBridge 171:3a7713b1edbc 109 *
AnnaBridge 171:3a7713b1edbc 110 * @param config EEPROM config structure pointer.
AnnaBridge 171:3a7713b1edbc 111 */
AnnaBridge 171:3a7713b1edbc 112 void EEPROM_GetDefaultConfig(eeprom_config_t *config);
AnnaBridge 171:3a7713b1edbc 113
AnnaBridge 171:3a7713b1edbc 114 /*!
AnnaBridge 171:3a7713b1edbc 115 * @brief Deinitializes the EEPROM regions.
AnnaBridge 171:3a7713b1edbc 116 *
AnnaBridge 171:3a7713b1edbc 117 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 118 */
AnnaBridge 171:3a7713b1edbc 119 void EEPROM_Deinit(EEPROM_Type *base);
AnnaBridge 171:3a7713b1edbc 120
AnnaBridge 171:3a7713b1edbc 121 /* @}*/
AnnaBridge 171:3a7713b1edbc 122
AnnaBridge 171:3a7713b1edbc 123 /*!
AnnaBridge 171:3a7713b1edbc 124 * @name Basic Control Operations
AnnaBridge 171:3a7713b1edbc 125 * @{
AnnaBridge 171:3a7713b1edbc 126 */
AnnaBridge 171:3a7713b1edbc 127
AnnaBridge 171:3a7713b1edbc 128 /*!
AnnaBridge 171:3a7713b1edbc 129 * @brief Set EEPROM automatic program feature.
AnnaBridge 171:3a7713b1edbc 130 *
AnnaBridge 171:3a7713b1edbc 131 * EEPROM write always needs a program and erase cycle to write the data into EEPROM. This program and erase cycle can
AnnaBridge 171:3a7713b1edbc 132 * be finished automaticlly or manually. If users want to use or disable auto program feature, users can call this API.
AnnaBridge 171:3a7713b1edbc 133 *
AnnaBridge 171:3a7713b1edbc 134 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 135 * @param autoProgram EEPROM auto program feature need to set.
AnnaBridge 171:3a7713b1edbc 136 */
AnnaBridge 171:3a7713b1edbc 137 static inline void EEPROM_SetAutoProgram(EEPROM_Type *base, eeprom_auto_program_t autoProgram)
AnnaBridge 171:3a7713b1edbc 138 {
AnnaBridge 171:3a7713b1edbc 139 base->AUTOPROG = autoProgram;
AnnaBridge 171:3a7713b1edbc 140 }
AnnaBridge 171:3a7713b1edbc 141
AnnaBridge 171:3a7713b1edbc 142 /*!
AnnaBridge 171:3a7713b1edbc 143 * @brief Set EEPROM to in/out power down mode.
AnnaBridge 171:3a7713b1edbc 144 *
AnnaBridge 171:3a7713b1edbc 145 * This function make EEPROM eneter or out of power mode. Notice that, users shall not put EEPROM into power down mode
AnnaBridge 171:3a7713b1edbc 146 * while there is still any pending EEPROM operation. While EEPROM is wakes up from power down mode, any EEPROM
AnnaBridge 171:3a7713b1edbc 147 * operation has to be suspended for 100 us.
AnnaBridge 171:3a7713b1edbc 148 *
AnnaBridge 171:3a7713b1edbc 149 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 150 * @param enable True means enter to power down mode, false means wake up.
AnnaBridge 171:3a7713b1edbc 151 */
AnnaBridge 171:3a7713b1edbc 152 static inline void EEPROM_SetPowerDownMode(EEPROM_Type *base, bool enable)
AnnaBridge 171:3a7713b1edbc 153 {
AnnaBridge 171:3a7713b1edbc 154 base->PWRDWN = enable;
AnnaBridge 171:3a7713b1edbc 155 }
AnnaBridge 171:3a7713b1edbc 156
AnnaBridge 171:3a7713b1edbc 157 /*!
AnnaBridge 171:3a7713b1edbc 158 * @brief Enable EEPROM interrupt.
AnnaBridge 171:3a7713b1edbc 159 *
AnnaBridge 171:3a7713b1edbc 160 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 161 * @param mask EEPROM interrupt enable mask. It is a logic OR of members the
AnnaBridge 171:3a7713b1edbc 162 * enumeration :: eeprom_interrupt_enable_t
AnnaBridge 171:3a7713b1edbc 163 */
AnnaBridge 171:3a7713b1edbc 164 static inline void EEPROM_EnableInterrupt(EEPROM_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 165 {
AnnaBridge 171:3a7713b1edbc 166 base->INTENSET = mask;
AnnaBridge 171:3a7713b1edbc 167 }
AnnaBridge 171:3a7713b1edbc 168
AnnaBridge 171:3a7713b1edbc 169 /*!
AnnaBridge 171:3a7713b1edbc 170 * @brief Disable EEPROM interrupt.
AnnaBridge 171:3a7713b1edbc 171 *
AnnaBridge 171:3a7713b1edbc 172 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 173 * @param mask EEPROM interrupt enable mask. It is a logic OR of members the
AnnaBridge 171:3a7713b1edbc 174 * enumeration :: eeprom_interrupt_enable_t
AnnaBridge 171:3a7713b1edbc 175 */
AnnaBridge 171:3a7713b1edbc 176 static inline void EEPROM_DisableInterrupt(EEPROM_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 177 {
AnnaBridge 171:3a7713b1edbc 178 base->INTENCLR = mask;
AnnaBridge 171:3a7713b1edbc 179 }
AnnaBridge 171:3a7713b1edbc 180
AnnaBridge 171:3a7713b1edbc 181 /*!
AnnaBridge 171:3a7713b1edbc 182 * @brief Get the status of all interrupt flags for ERPROM.
AnnaBridge 171:3a7713b1edbc 183 *
AnnaBridge 171:3a7713b1edbc 184 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 185 * @return EEPROM interrupt flag status
AnnaBridge 171:3a7713b1edbc 186 */
AnnaBridge 171:3a7713b1edbc 187 static inline uint32_t EEPROM_GetInterruptStatus(EEPROM_Type *base)
AnnaBridge 171:3a7713b1edbc 188 {
AnnaBridge 171:3a7713b1edbc 189 return base->INTSTAT;
AnnaBridge 171:3a7713b1edbc 190 }
AnnaBridge 171:3a7713b1edbc 191
AnnaBridge 171:3a7713b1edbc 192 /*!
AnnaBridge 171:3a7713b1edbc 193 * @brief Get the status of enabled interrupt flags for ERPROM.
AnnaBridge 171:3a7713b1edbc 194 *
AnnaBridge 171:3a7713b1edbc 195 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 196 * @return EEPROM enabled interrupt flag status
AnnaBridge 171:3a7713b1edbc 197 */
AnnaBridge 171:3a7713b1edbc 198 static inline uint32_t EEPROM_GetEnabledInterruptStatus(EEPROM_Type *base)
AnnaBridge 171:3a7713b1edbc 199 {
AnnaBridge 171:3a7713b1edbc 200 return base->INTEN;
AnnaBridge 171:3a7713b1edbc 201 }
AnnaBridge 171:3a7713b1edbc 202
AnnaBridge 171:3a7713b1edbc 203 /*!
AnnaBridge 171:3a7713b1edbc 204 * @brief Set interrupt flags manually.
AnnaBridge 171:3a7713b1edbc 205 *
AnnaBridge 171:3a7713b1edbc 206 * This API trigger a interrupt manually, users can no need to wait for hardware trigger interrupt. Call this API will
AnnaBridge 171:3a7713b1edbc 207 * set the corresponding bit in INSTAT register.
AnnaBridge 171:3a7713b1edbc 208 *
AnnaBridge 171:3a7713b1edbc 209 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 210 * @param mask EEPROM interrupt flag need to be set. It is a logic OR of members of
AnnaBridge 171:3a7713b1edbc 211 * enumeration:: eeprom_interrupt_enable_t
AnnaBridge 171:3a7713b1edbc 212 */
AnnaBridge 171:3a7713b1edbc 213 static inline void EEPROM_SetInterruptFlag(EEPROM_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 214 {
AnnaBridge 171:3a7713b1edbc 215 base->INTSTATSET = mask;
AnnaBridge 171:3a7713b1edbc 216 }
AnnaBridge 171:3a7713b1edbc 217
AnnaBridge 171:3a7713b1edbc 218 /*!
AnnaBridge 171:3a7713b1edbc 219 * @brief Clear interrupt flags manually.
AnnaBridge 171:3a7713b1edbc 220 *
AnnaBridge 171:3a7713b1edbc 221 * This API clears interrupt flags manually. Call this API will clear the corresponding bit in INSTAT register.
AnnaBridge 171:3a7713b1edbc 222 *
AnnaBridge 171:3a7713b1edbc 223 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 224 * @param mask EEPROM interrupt flag need to be cleared. It is a logic OR of members of
AnnaBridge 171:3a7713b1edbc 225 * enumeration:: eeprom_interrupt_enable_t
AnnaBridge 171:3a7713b1edbc 226 */
AnnaBridge 171:3a7713b1edbc 227 static inline void EEPROM_ClearInterruptFlag(EEPROM_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 228 {
AnnaBridge 171:3a7713b1edbc 229 base->INTSTATCLR = mask;
AnnaBridge 171:3a7713b1edbc 230 }
AnnaBridge 171:3a7713b1edbc 231
AnnaBridge 171:3a7713b1edbc 232 /*!
AnnaBridge 171:3a7713b1edbc 233 * @brief Write a word data in address of EEPROM.
AnnaBridge 171:3a7713b1edbc 234 *
AnnaBridge 171:3a7713b1edbc 235 * Users can write a page or at least a word data into EEPROM address.
AnnaBridge 171:3a7713b1edbc 236 *
AnnaBridge 171:3a7713b1edbc 237 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 238 * @param offset Offset from the begining address of EEPROM. This value shall be 4-byte aligned.
AnnaBridge 171:3a7713b1edbc 239 * @param data Data need be write.
AnnaBridge 171:3a7713b1edbc 240 */
AnnaBridge 171:3a7713b1edbc 241 status_t EEPROM_WriteWord(EEPROM_Type *base, uint32_t offset, uint32_t data);
AnnaBridge 171:3a7713b1edbc 242
AnnaBridge 171:3a7713b1edbc 243 /*!
AnnaBridge 171:3a7713b1edbc 244 * @brief Write a page data into EEPROM.
AnnaBridge 171:3a7713b1edbc 245 *
AnnaBridge 171:3a7713b1edbc 246 * Users can write a page or at least a word data into EEPROM address.
AnnaBridge 171:3a7713b1edbc 247 *
AnnaBridge 171:3a7713b1edbc 248 * @param base EEPROM peripheral base address.
AnnaBridge 171:3a7713b1edbc 249 * @param pageNum Page number to be written.
AnnaBridge 171:3a7713b1edbc 250 * @param data Data need be write. This array data size shall equals to the page size.
AnnaBridge 171:3a7713b1edbc 251 */
AnnaBridge 171:3a7713b1edbc 252 status_t EEPROM_WritePage(EEPROM_Type *base, uint32_t pageNum, uint32_t *data);
AnnaBridge 171:3a7713b1edbc 253
AnnaBridge 171:3a7713b1edbc 254 /* @} */
AnnaBridge 171:3a7713b1edbc 255
AnnaBridge 171:3a7713b1edbc 256 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 257 }
AnnaBridge 171:3a7713b1edbc 258 #endif
AnnaBridge 171:3a7713b1edbc 259
AnnaBridge 171:3a7713b1edbc 260 /*! @}*/
AnnaBridge 171:3a7713b1edbc 261
AnnaBridge 171:3a7713b1edbc 262 #endif /* _FSL_EEPROM_H_ */