ON Semiconductor / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

targets/TARGET_Maxim/TARGET_MAX32625/mxc/flc.c@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1 /**
group-onsemi 0:098463de4c5d 2 * @file flc.c
group-onsemi 0:098463de4c5d 3 * @brief This file contains the function implementations for the Flash
group-onsemi 0:098463de4c5d 4 * Controller peripheral module.
group-onsemi 0:098463de4c5d 5 */
group-onsemi 0:098463de4c5d 6
group-onsemi 0:098463de4c5d 7 /* ****************************************************************************
group-onsemi 0:098463de4c5d 8 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
group-onsemi 0:098463de4c5d 9 *
group-onsemi 0:098463de4c5d 10 * Permission is hereby granted, free of charge, to any person obtaining a
group-onsemi 0:098463de4c5d 11 * copy of this software and associated documentation files (the "Software"),
group-onsemi 0:098463de4c5d 12 * to deal in the Software without restriction, including without limitation
group-onsemi 0:098463de4c5d 13 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
group-onsemi 0:098463de4c5d 14 * and/or sell copies of the Software, and to permit persons to whom the
group-onsemi 0:098463de4c5d 15 * Software is furnished to do so, subject to the following conditions:
group-onsemi 0:098463de4c5d 16 *
group-onsemi 0:098463de4c5d 17 * The above copyright notice and this permission notice shall be included
group-onsemi 0:098463de4c5d 18 * in all copies or substantial portions of the Software.
group-onsemi 0:098463de4c5d 19 *
group-onsemi 0:098463de4c5d 20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
group-onsemi 0:098463de4c5d 21 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
group-onsemi 0:098463de4c5d 22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
group-onsemi 0:098463de4c5d 23 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
group-onsemi 0:098463de4c5d 24 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
group-onsemi 0:098463de4c5d 25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
group-onsemi 0:098463de4c5d 26 * OTHER DEALINGS IN THE SOFTWARE.
group-onsemi 0:098463de4c5d 27 *
group-onsemi 0:098463de4c5d 28 * Except as contained in this notice, the name of Maxim Integrated
group-onsemi 0:098463de4c5d 29 * Products, Inc. shall not be used except as stated in the Maxim Integrated
group-onsemi 0:098463de4c5d 30 * Products, Inc. Branding Policy.
group-onsemi 0:098463de4c5d 31 *
group-onsemi 0:098463de4c5d 32 * The mere transfer of this software does not imply any licenses
group-onsemi 0:098463de4c5d 33 * of trade secrets, proprietary technology, copyrights, patents,
group-onsemi 0:098463de4c5d 34 * trademarks, maskwork rights, or any other form of intellectual
group-onsemi 0:098463de4c5d 35 * property whatsoever. Maxim Integrated Products, Inc. retains all
group-onsemi 0:098463de4c5d 36 * ownership rights.
group-onsemi 0:098463de4c5d 37 *
group-onsemi 0:098463de4c5d 38 * $Date: 2016-08-02 13:46:43 -0500 (Tue, 02 Aug 2016) $
group-onsemi 0:098463de4c5d 39 * $Revision: 23898 $
group-onsemi 0:098463de4c5d 40 *
group-onsemi 0:098463de4c5d 41 *************************************************************************** */
group-onsemi 0:098463de4c5d 42
group-onsemi 0:098463de4c5d 43 /* **** Includes **** */
group-onsemi 0:098463de4c5d 44 #include "mxc_config.h"
group-onsemi 0:098463de4c5d 45 #include "flc.h"
group-onsemi 0:098463de4c5d 46
group-onsemi 0:098463de4c5d 47
group-onsemi 0:098463de4c5d 48 /**
group-onsemi 0:098463de4c5d 49 * @ingroup flc
group-onsemi 0:098463de4c5d 50 * @{
group-onsemi 0:098463de4c5d 51 */
group-onsemi 0:098463de4c5d 52
group-onsemi 0:098463de4c5d 53 /* **** Definitions **** */
group-onsemi 0:098463de4c5d 54
group-onsemi 0:098463de4c5d 55 /* **** Globals **** */
group-onsemi 0:098463de4c5d 56
group-onsemi 0:098463de4c5d 57 /* **** Functions **** */
group-onsemi 0:098463de4c5d 58
group-onsemi 0:098463de4c5d 59 /* ************************************************************************* */
group-onsemi 0:098463de4c5d 60 #if defined ( __GNUC__ )
group-onsemi 0:098463de4c5d 61 #undef IAR_PRAGMAS //Make sure this is not defined for GCC
group-onsemi 0:098463de4c5d 62 #endif
group-onsemi 0:098463de4c5d 63
group-onsemi 0:098463de4c5d 64 #if IAR_PRAGMAS
group-onsemi 0:098463de4c5d 65 // IAR memory section declaration for the in-system flash programming functions to be loaded in RAM.
group-onsemi 0:098463de4c5d 66 #pragma section=".flashprog"
group-onsemi 0:098463de4c5d 67 #endif
group-onsemi 0:098463de4c5d 68 #if defined ( __GNUC__ )
group-onsemi 0:098463de4c5d 69 __attribute__ ((section(".flashprog")))
group-onsemi 0:098463de4c5d 70 #endif
group-onsemi 0:098463de4c5d 71 /**
group-onsemi 0:098463de4c5d 72 * @brief Return the status of the busy state of the flash controller.
group-onsemi 0:098463de4c5d 73 *
group-onsemi 0:098463de4c5d 74 * @return 0 Flash Controller is idle.
group-onsemi 0:098463de4c5d 75 * @return Non-zero indicates the flash controller is performing an
group-onsemi 0:098463de4c5d 76 * erase or write request.
group-onsemi 0:098463de4c5d 77 */
group-onsemi 0:098463de4c5d 78 __STATIC_INLINE int FLC_Busy(void)
group-onsemi 0:098463de4c5d 79 {
group-onsemi 0:098463de4c5d 80 return (MXC_FLC->ctrl & (MXC_F_FLC_CTRL_WRITE | MXC_F_FLC_CTRL_MASS_ERASE | MXC_F_FLC_CTRL_PAGE_ERASE));
group-onsemi 0:098463de4c5d 81 }
group-onsemi 0:098463de4c5d 82
group-onsemi 0:098463de4c5d 83 /* ************************************************************************* */
group-onsemi 0:098463de4c5d 84 #if IAR_PRAGMAS
group-onsemi 0:098463de4c5d 85 // IAR memory section declaration for the in-system flash programming functions to be loaded in RAM.
group-onsemi 0:098463de4c5d 86 #pragma section=".flashprog"
group-onsemi 0:098463de4c5d 87 #endif
group-onsemi 0:098463de4c5d 88 #if defined ( __GNUC__ )
group-onsemi 0:098463de4c5d 89 __attribute__ ((section(".flashprog")))
group-onsemi 0:098463de4c5d 90 #endif
group-onsemi 0:098463de4c5d 91 int FLC_Init(void)
group-onsemi 0:098463de4c5d 92 {
group-onsemi 0:098463de4c5d 93 /* Check if the flash controller is busy */
group-onsemi 0:098463de4c5d 94 if (FLC_Busy()) {
group-onsemi 0:098463de4c5d 95 return E_BUSY;
group-onsemi 0:098463de4c5d 96 }
group-onsemi 0:098463de4c5d 97
group-onsemi 0:098463de4c5d 98 /* Enable automatic calculation of the clock divider to generate a 1MHz clock from the APB clock */
group-onsemi 0:098463de4c5d 99 MXC_FLC->perform |= MXC_F_FLC_PERFORM_AUTO_CLKDIV;
group-onsemi 0:098463de4c5d 100
group-onsemi 0:098463de4c5d 101 /* The flash controller will stall any reads while flash operations are in
group-onsemi 0:098463de4c5d 102 * progress. Disable the legacy failure detection logic that would flag reads
group-onsemi 0:098463de4c5d 103 * during flash operations as errors.
group-onsemi 0:098463de4c5d 104 */
group-onsemi 0:098463de4c5d 105 MXC_FLC->perform |= MXC_F_FLC_PERFORM_EN_PREVENT_FAIL;
group-onsemi 0:098463de4c5d 106
group-onsemi 0:098463de4c5d 107 return E_NO_ERROR;
group-onsemi 0:098463de4c5d 108 }
group-onsemi 0:098463de4c5d 109
group-onsemi 0:098463de4c5d 110 /* ************************************************************************* */
group-onsemi 0:098463de4c5d 111 #if IAR_PRAGMAS
group-onsemi 0:098463de4c5d 112 // IAR memory section declaration for the in-system flash programming functions to be loaded in RAM.
group-onsemi 0:098463de4c5d 113 #pragma section=".flashprog"
group-onsemi 0:098463de4c5d 114 #endif
group-onsemi 0:098463de4c5d 115 #if defined ( __GNUC__ )
group-onsemi 0:098463de4c5d 116 __attribute__ ((section(".flashprog")))
group-onsemi 0:098463de4c5d 117 #endif
group-onsemi 0:098463de4c5d 118 int FLC_PageErase(uint32_t address, uint8_t erase_code, uint8_t unlock_key)
group-onsemi 0:098463de4c5d 119 {
group-onsemi 0:098463de4c5d 120 /* Check if the flash controller is busy */
group-onsemi 0:098463de4c5d 121 if (FLC_Busy()) {
group-onsemi 0:098463de4c5d 122 return E_BUSY;
group-onsemi 0:098463de4c5d 123 }
group-onsemi 0:098463de4c5d 124
group-onsemi 0:098463de4c5d 125 /* Clear stale errors. Interrupt flags can only be written to zero, so this is safe */
group-onsemi 0:098463de4c5d 126 MXC_FLC->intr &= ~MXC_F_FLC_INTR_FAILED_IF;
group-onsemi 0:098463de4c5d 127
group-onsemi 0:098463de4c5d 128 /* Unlock flash */
group-onsemi 0:098463de4c5d 129 MXC_FLC->ctrl = (MXC_FLC->ctrl & ~MXC_F_FLC_CTRL_FLSH_UNLOCK) |
group-onsemi 0:098463de4c5d 130 ((unlock_key << MXC_F_FLC_CTRL_FLSH_UNLOCK_POS) & MXC_F_FLC_CTRL_FLSH_UNLOCK);
group-onsemi 0:098463de4c5d 131
group-onsemi 0:098463de4c5d 132 /* Write the Erase Code */
group-onsemi 0:098463de4c5d 133 MXC_FLC->ctrl = (MXC_FLC->ctrl & ~MXC_F_FLC_CTRL_ERASE_CODE) |
group-onsemi 0:098463de4c5d 134 ((erase_code << MXC_F_FLC_CTRL_ERASE_CODE_POS) & MXC_F_FLC_CTRL_ERASE_CODE);
group-onsemi 0:098463de4c5d 135
group-onsemi 0:098463de4c5d 136 /* Erase the request page */
group-onsemi 0:098463de4c5d 137 MXC_FLC->faddr = address;
group-onsemi 0:098463de4c5d 138 MXC_FLC->ctrl |= MXC_F_FLC_CTRL_PAGE_ERASE;
group-onsemi 0:098463de4c5d 139
group-onsemi 0:098463de4c5d 140 /* Wait until flash operation is complete */
group-onsemi 0:098463de4c5d 141 while (FLC_Busy());
group-onsemi 0:098463de4c5d 142
group-onsemi 0:098463de4c5d 143 /* Lock flash */
group-onsemi 0:098463de4c5d 144 MXC_FLC->ctrl &= ~(MXC_F_FLC_CTRL_FLSH_UNLOCK | MXC_F_FLC_CTRL_ERASE_CODE);
group-onsemi 0:098463de4c5d 145
group-onsemi 0:098463de4c5d 146 /* Check for failures */
group-onsemi 0:098463de4c5d 147 if (MXC_FLC->intr & MXC_F_FLC_INTR_FAILED_IF) {
group-onsemi 0:098463de4c5d 148 /* Interrupt flags can only be written to zero, so this is safe */
group-onsemi 0:098463de4c5d 149 MXC_FLC->intr &= ~MXC_F_FLC_INTR_FAILED_IF;
group-onsemi 0:098463de4c5d 150 return E_UNKNOWN;
group-onsemi 0:098463de4c5d 151 }
group-onsemi 0:098463de4c5d 152
group-onsemi 0:098463de4c5d 153 return E_NO_ERROR;
group-onsemi 0:098463de4c5d 154 }
group-onsemi 0:098463de4c5d 155
group-onsemi 0:098463de4c5d 156 /* ************************************************************************* */
group-onsemi 0:098463de4c5d 157 #if IAR_PRAGMAS
group-onsemi 0:098463de4c5d 158 // IAR memory section declaration for the in-system flash programming functions to be loaded in RAM.
group-onsemi 0:098463de4c5d 159 #pragma section=".flashprog"
group-onsemi 0:098463de4c5d 160 #endif
group-onsemi 0:098463de4c5d 161 #if defined ( __GNUC__ )
group-onsemi 0:098463de4c5d 162 __attribute__ ((section(".flashprog")))
group-onsemi 0:098463de4c5d 163 #endif
group-onsemi 0:098463de4c5d 164 int FLC_Write(uint32_t address, const void *data, uint32_t length, uint8_t unlock_key)
group-onsemi 0:098463de4c5d 165 {
group-onsemi 0:098463de4c5d 166 uint32_t *ptr = (uint32_t*)data;
group-onsemi 0:098463de4c5d 167
group-onsemi 0:098463de4c5d 168 /* Can only write in full word units */
group-onsemi 0:098463de4c5d 169 if ((address & 3) || (length & 3)) {
group-onsemi 0:098463de4c5d 170 return E_BAD_PARAM;
group-onsemi 0:098463de4c5d 171 }
group-onsemi 0:098463de4c5d 172
group-onsemi 0:098463de4c5d 173 if (length == 0) {
group-onsemi 0:098463de4c5d 174 /* Nothing to do */
group-onsemi 0:098463de4c5d 175 return E_NO_ERROR;
group-onsemi 0:098463de4c5d 176 }
group-onsemi 0:098463de4c5d 177
group-onsemi 0:098463de4c5d 178 /* Check if the flash controller is busy */
group-onsemi 0:098463de4c5d 179 if (FLC_Busy()) {
group-onsemi 0:098463de4c5d 180 return E_BUSY;
group-onsemi 0:098463de4c5d 181 }
group-onsemi 0:098463de4c5d 182
group-onsemi 0:098463de4c5d 183 /* Clear stale errors. Interrupt flags can only be written to zero, so this is safe */
group-onsemi 0:098463de4c5d 184 MXC_FLC->intr &= ~MXC_F_FLC_INTR_FAILED_IF;
group-onsemi 0:098463de4c5d 185
group-onsemi 0:098463de4c5d 186 /* Unlock flash */
group-onsemi 0:098463de4c5d 187 MXC_FLC->ctrl = (MXC_FLC->ctrl & ~MXC_F_FLC_CTRL_FLSH_UNLOCK) |
group-onsemi 0:098463de4c5d 188 ((unlock_key << MXC_F_FLC_CTRL_FLSH_UNLOCK_POS) & MXC_F_FLC_CTRL_FLSH_UNLOCK);
group-onsemi 0:098463de4c5d 189
group-onsemi 0:098463de4c5d 190 /* Set the address to write and enable auto increment */
group-onsemi 0:098463de4c5d 191 MXC_FLC->faddr = address;
group-onsemi 0:098463de4c5d 192 MXC_FLC->ctrl |= MXC_F_FLC_CTRL_AUTO_INCRE_MODE;
group-onsemi 0:098463de4c5d 193 uint32_t write_cmd = MXC_FLC->ctrl | MXC_F_FLC_CTRL_WRITE;
group-onsemi 0:098463de4c5d 194
group-onsemi 0:098463de4c5d 195 for (; length > 0; length -= 4) {
group-onsemi 0:098463de4c5d 196 /* Perform the write */
group-onsemi 0:098463de4c5d 197 MXC_FLC->fdata = *ptr++;
group-onsemi 0:098463de4c5d 198 MXC_FLC->ctrl = write_cmd;
group-onsemi 0:098463de4c5d 199 while (FLC_Busy());
group-onsemi 0:098463de4c5d 200 }
group-onsemi 0:098463de4c5d 201
group-onsemi 0:098463de4c5d 202 /* Lock flash */
group-onsemi 0:098463de4c5d 203 MXC_FLC->ctrl &= ~MXC_F_FLC_CTRL_FLSH_UNLOCK;
group-onsemi 0:098463de4c5d 204
group-onsemi 0:098463de4c5d 205 /* Check for failures */
group-onsemi 0:098463de4c5d 206 if (MXC_FLC->intr & MXC_F_FLC_INTR_FAILED_IF) {
group-onsemi 0:098463de4c5d 207 /* Interrupt flags can only be written to zero, so this is safe */
group-onsemi 0:098463de4c5d 208 MXC_FLC->intr &= ~MXC_F_FLC_INTR_FAILED_IF;
group-onsemi 0:098463de4c5d 209 return E_UNKNOWN;
group-onsemi 0:098463de4c5d 210 }
group-onsemi 0:098463de4c5d 211
group-onsemi 0:098463de4c5d 212 return E_NO_ERROR;
group-onsemi 0:098463de4c5d 213 }
group-onsemi 0:098463de4c5d 214
group-onsemi 0:098463de4c5d 215 /* ************************************************************************* */
group-onsemi 0:098463de4c5d 216 #if IAR_PRAGMAS
group-onsemi 0:098463de4c5d 217 // IAR memory section declaration for the in-system flash programming functions to be loaded in RAM.
group-onsemi 0:098463de4c5d 218 #pragma section=".flashprog"
group-onsemi 0:098463de4c5d 219 #endif
group-onsemi 0:098463de4c5d 220 #if defined ( __GNUC__ )
group-onsemi 0:098463de4c5d 221 __attribute__ ((section(".flashprog")))
group-onsemi 0:098463de4c5d 222 #endif
group-onsemi 0:098463de4c5d 223 int FLC_MassErase(uint8_t erase_code, uint8_t unlock_key)
group-onsemi 0:098463de4c5d 224 {
group-onsemi 0:098463de4c5d 225 /* Check if the flash controller is busy */
group-onsemi 0:098463de4c5d 226 if (FLC_Busy()) {
group-onsemi 0:098463de4c5d 227 return E_BUSY;
group-onsemi 0:098463de4c5d 228 }
group-onsemi 0:098463de4c5d 229
group-onsemi 0:098463de4c5d 230 /* Clear stale errors. Interrupt flags can only be written to zero, so this is safe */
group-onsemi 0:098463de4c5d 231 MXC_FLC->intr &= ~MXC_F_FLC_INTR_FAILED_IF;
group-onsemi 0:098463de4c5d 232
group-onsemi 0:098463de4c5d 233 /* Unlock flash */
group-onsemi 0:098463de4c5d 234 MXC_FLC->ctrl = (MXC_FLC->ctrl & ~MXC_F_FLC_CTRL_FLSH_UNLOCK) |
group-onsemi 0:098463de4c5d 235 ((unlock_key << MXC_F_FLC_CTRL_FLSH_UNLOCK_POS) & MXC_F_FLC_CTRL_FLSH_UNLOCK);
group-onsemi 0:098463de4c5d 236
group-onsemi 0:098463de4c5d 237 /* Write the Erase Code */
group-onsemi 0:098463de4c5d 238 MXC_FLC->ctrl = (MXC_FLC->ctrl & ~MXC_F_FLC_CTRL_ERASE_CODE) |
group-onsemi 0:098463de4c5d 239 ((erase_code << MXC_F_FLC_CTRL_ERASE_CODE_POS) & MXC_F_FLC_CTRL_ERASE_CODE);
group-onsemi 0:098463de4c5d 240
group-onsemi 0:098463de4c5d 241 /* Start the mass erase */
group-onsemi 0:098463de4c5d 242 MXC_FLC->ctrl |= MXC_F_FLC_CTRL_MASS_ERASE;
group-onsemi 0:098463de4c5d 243
group-onsemi 0:098463de4c5d 244 /* Wait until flash operation is complete */
group-onsemi 0:098463de4c5d 245 while (FLC_Busy());
group-onsemi 0:098463de4c5d 246
group-onsemi 0:098463de4c5d 247 /* Lock flash */
group-onsemi 0:098463de4c5d 248 MXC_FLC->ctrl &= ~(MXC_F_FLC_CTRL_FLSH_UNLOCK | MXC_F_FLC_CTRL_ERASE_CODE);
group-onsemi 0:098463de4c5d 249
group-onsemi 0:098463de4c5d 250 /* Check for failures */
group-onsemi 0:098463de4c5d 251 if (MXC_FLC->intr & MXC_F_FLC_INTR_FAILED_IF) {
group-onsemi 0:098463de4c5d 252 /* Interrupt flags can only be written to zero, so this is safe */
group-onsemi 0:098463de4c5d 253 MXC_FLC->intr &= ~MXC_F_FLC_INTR_FAILED_IF;
group-onsemi 0:098463de4c5d 254 return E_UNKNOWN;
group-onsemi 0:098463de4c5d 255 }
group-onsemi 0:098463de4c5d 256
group-onsemi 0:098463de4c5d 257 return E_NO_ERROR;
group-onsemi 0:098463de4c5d 258 }
group-onsemi 0:098463de4c5d 259
group-onsemi 0:098463de4c5d 260 /**@} end of group flc */