SilentSensors / mbed-dev

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.

Fork of mbed-dev by mbed official

targets/TARGET_STM/TARGET_STM32F7/flash_api.c@188:60408c49b6d4, 2018-09-20 (annotated)

Committer:
WaleedElmughrabi
Date:
Thu Sep 20 16:11:23 2018 +0000
Revision:
188:60408c49b6d4
Parent:
187:0387e8f68319 
Fork modified for BG96 error

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 174:b96e65c34a4d 1 /* mbed Microcontroller Library
AnnaBridge 174:b96e65c34a4d 2 *******************************************************************************
AnnaBridge 174:b96e65c34a4d 3 * Copyright (c) 2017, STMicroelectronics
AnnaBridge 174:b96e65c34a4d 4 * All rights reserved.
AnnaBridge 174:b96e65c34a4d 5 *
AnnaBridge 174:b96e65c34a4d 6 * Redistribution and use in source and binary forms, with or without
AnnaBridge 174:b96e65c34a4d 7 * modification, are permitted provided that the following conditions are met:
AnnaBridge 174:b96e65c34a4d 8 *
AnnaBridge 174:b96e65c34a4d 9 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 174:b96e65c34a4d 10 * this list of conditions and the following disclaimer.
AnnaBridge 174:b96e65c34a4d 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 174:b96e65c34a4d 12 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 174:b96e65c34a4d 13 * and/or other materials provided with the distribution.
AnnaBridge 174:b96e65c34a4d 14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 174:b96e65c34a4d 15 * may be used to endorse or promote products derived from this software
AnnaBridge 174:b96e65c34a4d 16 * without specific prior written permission.
AnnaBridge 174:b96e65c34a4d 17 *
AnnaBridge 174:b96e65c34a4d 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 174:b96e65c34a4d 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 174:b96e65c34a4d 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 174:b96e65c34a4d 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 174:b96e65c34a4d 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 174:b96e65c34a4d 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 174:b96e65c34a4d 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 174:b96e65c34a4d 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 174:b96e65c34a4d 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 174:b96e65c34a4d 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 174:b96e65c34a4d 28 *******************************************************************************
AnnaBridge 174:b96e65c34a4d 29 */
AnnaBridge 174:b96e65c34a4d 30
AnnaBridge 174:b96e65c34a4d 31 #if DEVICE_FLASH
AnnaBridge 174:b96e65c34a4d 32 #include "flash_api.h"
AnnaBridge 174:b96e65c34a4d 33 #include "flash_data.h"
AnnaBridge 174:b96e65c34a4d 34 #include "platform/mbed_critical.h"
Anna Bridge 186:707f6e361f3e 35 #include "mbed_error.h"
AnnaBridge 174:b96e65c34a4d 36
AnnaBridge 174:b96e65c34a4d 37 static uint32_t GetSector(uint32_t Address);
AnnaBridge 174:b96e65c34a4d 38 static uint32_t GetSectorSize(uint32_t Sector);
AnnaBridge 174:b96e65c34a4d 39
AnnaBridge 174:b96e65c34a4d 40 int32_t flash_init(flash_t *obj)
AnnaBridge 174:b96e65c34a4d 41 {
Anna Bridge 186:707f6e361f3e 42 // Check Dual Bank option byte (nDBANK) on devices supporting both single and dual bank configurations
Anna Bridge 186:707f6e361f3e 43 #ifdef FLASH_OPTCR_nDBANK
Anna Bridge 186:707f6e361f3e 44 FLASH_OBProgramInitTypeDef OBInit;
Anna Bridge 186:707f6e361f3e 45 /* Allow Access to option bytes sector */
Anna Bridge 186:707f6e361f3e 46 HAL_FLASH_OB_Unlock();
Anna Bridge 186:707f6e361f3e 47 /* Get the Dual bank configuration status */
Anna Bridge 186:707f6e361f3e 48 HAL_FLASHEx_OBGetConfig(&OBInit);
Anna Bridge 186:707f6e361f3e 49 /* Allow Access to option bytes sector */
Anna Bridge 186:707f6e361f3e 50 HAL_FLASH_OB_Lock();
Anna Bridge 186:707f6e361f3e 51 #if MBED_CONF_TARGET_FLASH_DUAL_BANK
AnnaBridge 187:0387e8f68319 52 if ((OBInit.USERConfig & OB_NDBANK_SINGLE_BANK) == OB_NDBANK_SINGLE_BANK) {
Anna Bridge 186:707f6e361f3e 53 error("The Dual Bank mode option byte (nDBANK) must be enabled (box unchecked)\n");
Anna Bridge 186:707f6e361f3e 54 return -1;
Anna Bridge 186:707f6e361f3e 55 }
Anna Bridge 186:707f6e361f3e 56 #else // SINGLE BANK
AnnaBridge 187:0387e8f68319 57 if ((OBInit.USERConfig & OB_NDBANK_SINGLE_BANK) == OB_NDBANK_DUAL_BANK) {
Anna Bridge 186:707f6e361f3e 58 error("The Dual Bank mode option byte (nDBANK) must be disabled (box checked)\n");
Anna Bridge 186:707f6e361f3e 59 return -1;
Anna Bridge 186:707f6e361f3e 60 }
Anna Bridge 186:707f6e361f3e 61 #endif
Anna Bridge 186:707f6e361f3e 62 #else // Devices supporting Single Bank only
Anna Bridge 186:707f6e361f3e 63 #if MBED_CONF_TARGET_FLASH_DUAL_BANK
Anna Bridge 186:707f6e361f3e 64 #error "The Dual Bank configuration is not supported on this device."
Anna Bridge 186:707f6e361f3e 65 #endif
Anna Bridge 186:707f6e361f3e 66 #endif
AnnaBridge 175:af195413fb11 67 return 0;
AnnaBridge 175:af195413fb11 68 }
Anna Bridge 186:707f6e361f3e 69
AnnaBridge 175:af195413fb11 70 int32_t flash_free(flash_t *obj)
AnnaBridge 175:af195413fb11 71 {
AnnaBridge 175:af195413fb11 72 return 0;
AnnaBridge 175:af195413fb11 73 }
AnnaBridge 175:af195413fb11 74
AnnaBridge 175:af195413fb11 75 static int32_t flash_unlock(void)
AnnaBridge 175:af195413fb11 76 {
AnnaBridge 175:af195413fb11 77 /* Allow Access to Flash control registers and user Falsh */
AnnaBridge 174:b96e65c34a4d 78 if (HAL_FLASH_Unlock()) {
AnnaBridge 174:b96e65c34a4d 79 return -1;
AnnaBridge 174:b96e65c34a4d 80 } else {
AnnaBridge 174:b96e65c34a4d 81 return 0;
AnnaBridge 174:b96e65c34a4d 82 }
AnnaBridge 174:b96e65c34a4d 83 }
AnnaBridge 175:af195413fb11 84
AnnaBridge 175:af195413fb11 85 static int32_t flash_lock(void)
AnnaBridge 174:b96e65c34a4d 86 {
AnnaBridge 174:b96e65c34a4d 87 /* Disable the Flash option control register access (recommended to protect
AnnaBridge 174:b96e65c34a4d 88 the option Bytes against possible unwanted operations) */
AnnaBridge 174:b96e65c34a4d 89 if (HAL_FLASH_Lock()) {
AnnaBridge 174:b96e65c34a4d 90 return -1;
AnnaBridge 174:b96e65c34a4d 91 } else {
AnnaBridge 174:b96e65c34a4d 92 return 0;
AnnaBridge 174:b96e65c34a4d 93 }
AnnaBridge 174:b96e65c34a4d 94 }
AnnaBridge 175:af195413fb11 95
AnnaBridge 174:b96e65c34a4d 96 int32_t flash_erase_sector(flash_t *obj, uint32_t address)
AnnaBridge 174:b96e65c34a4d 97 {
AnnaBridge 174:b96e65c34a4d 98 /* Variable used for Erase procedure */
AnnaBridge 174:b96e65c34a4d 99 FLASH_EraseInitTypeDef EraseInitStruct;
AnnaBridge 174:b96e65c34a4d 100 uint32_t SectorId;
AnnaBridge 174:b96e65c34a4d 101 uint32_t SectorError = 0;
AnnaBridge 175:af195413fb11 102 int32_t status = 0;
AnnaBridge 174:b96e65c34a4d 103
AnnaBridge 174:b96e65c34a4d 104 if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
AnnaBridge 174:b96e65c34a4d 105 return -1;
AnnaBridge 174:b96e65c34a4d 106 }
AnnaBridge 174:b96e65c34a4d 107
AnnaBridge 175:af195413fb11 108 if (flash_unlock() != HAL_OK) {
AnnaBridge 175:af195413fb11 109 return -1;
AnnaBridge 175:af195413fb11 110 }
AnnaBridge 175:af195413fb11 111
AnnaBridge 187:0387e8f68319 112 /* Note: If an erase operation in Flash memory also concerns data in the data or instruction cache,
AnnaBridge 187:0387e8f68319 113 you have to make sure that these data are rewritten before they are accessed during code
AnnaBridge 187:0387e8f68319 114 execution. If this cannot be done safely, it is recommended to flush the caches by setting the
AnnaBridge 187:0387e8f68319 115 DCRST and ICRST bits in the FLASH_CR register. */
AnnaBridge 174:b96e65c34a4d 116 __HAL_FLASH_ART_DISABLE();
AnnaBridge 174:b96e65c34a4d 117 __HAL_FLASH_ART_RESET();
AnnaBridge 174:b96e65c34a4d 118 __HAL_FLASH_ART_ENABLE();
AnnaBridge 174:b96e65c34a4d 119
AnnaBridge 174:b96e65c34a4d 120 /* Get the 1st sector to erase */
AnnaBridge 174:b96e65c34a4d 121 SectorId = GetSector(address);
AnnaBridge 174:b96e65c34a4d 122
Anna Bridge 186:707f6e361f3e 123 /* Fill EraseInit structure */
AnnaBridge 174:b96e65c34a4d 124 EraseInitStruct.TypeErase = FLASH_TYPEERASE_SECTORS;
AnnaBridge 174:b96e65c34a4d 125 EraseInitStruct.VoltageRange = FLASH_VOLTAGE_RANGE_3;
AnnaBridge 174:b96e65c34a4d 126 EraseInitStruct.Sector = SectorId;
AnnaBridge 174:b96e65c34a4d 127 EraseInitStruct.NbSectors = 1;
AnnaBridge 174:b96e65c34a4d 128
AnnaBridge 187:0387e8f68319 129 if (HAL_FLASHEx_Erase(&EraseInitStruct, &SectorError) != HAL_OK) {
AnnaBridge 175:af195413fb11 130 status = -1;
AnnaBridge 174:b96e65c34a4d 131 }
AnnaBridge 175:af195413fb11 132
AnnaBridge 175:af195413fb11 133 flash_lock();
AnnaBridge 175:af195413fb11 134
AnnaBridge 175:af195413fb11 135 return status;
AnnaBridge 174:b96e65c34a4d 136 }
AnnaBridge 174:b96e65c34a4d 137
AnnaBridge 174:b96e65c34a4d 138 int32_t flash_program_page(flash_t *obj, uint32_t address, const uint8_t *data,
AnnaBridge 187:0387e8f68319 139 uint32_t size)
AnnaBridge 174:b96e65c34a4d 140 {
AnnaBridge 175:af195413fb11 141 int32_t status = 0;
AnnaBridge 175:af195413fb11 142
AnnaBridge 174:b96e65c34a4d 143 if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
AnnaBridge 174:b96e65c34a4d 144 return -1;
AnnaBridge 174:b96e65c34a4d 145 }
AnnaBridge 174:b96e65c34a4d 146
AnnaBridge 175:af195413fb11 147 if (flash_unlock() != HAL_OK) {
AnnaBridge 175:af195413fb11 148 return -1;
AnnaBridge 175:af195413fb11 149 }
AnnaBridge 175:af195413fb11 150
AnnaBridge 187:0387e8f68319 151 /* Note: If an erase operation in Flash memory also concerns data in the data or instruction cache,
AnnaBridge 187:0387e8f68319 152 you have to make sure that these data are rewritten before they are accessed during code
AnnaBridge 187:0387e8f68319 153 execution. If this cannot be done safely, it is recommended to flush the caches by setting the
AnnaBridge 187:0387e8f68319 154 DCRST and ICRST bits in the FLASH_CR register. */
AnnaBridge 174:b96e65c34a4d 155 __HAL_FLASH_ART_DISABLE();
AnnaBridge 174:b96e65c34a4d 156 __HAL_FLASH_ART_RESET();
AnnaBridge 174:b96e65c34a4d 157 __HAL_FLASH_ART_ENABLE();
AnnaBridge 174:b96e65c34a4d 158
AnnaBridge 175:af195413fb11 159 while ((size > 0) && (status == 0)) {
AnnaBridge 174:b96e65c34a4d 160 if (HAL_FLASH_Program(FLASH_TYPEPROGRAM_BYTE,
AnnaBridge 187:0387e8f68319 161 address, (uint64_t)*data) != HAL_OK) {
AnnaBridge 175:af195413fb11 162 status = -1;
AnnaBridge 174:b96e65c34a4d 163 } else {
AnnaBridge 174:b96e65c34a4d 164 size--;
AnnaBridge 174:b96e65c34a4d 165 address++;
AnnaBridge 174:b96e65c34a4d 166 data++;
AnnaBridge 174:b96e65c34a4d 167 }
AnnaBridge 174:b96e65c34a4d 168 }
AnnaBridge 175:af195413fb11 169
AnnaBridge 175:af195413fb11 170 flash_lock();
AnnaBridge 175:af195413fb11 171
AnnaBridge 175:af195413fb11 172 return status;
AnnaBridge 174:b96e65c34a4d 173 }
AnnaBridge 174:b96e65c34a4d 174
AnnaBridge 174:b96e65c34a4d 175 uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address)
AnnaBridge 174:b96e65c34a4d 176 {
AnnaBridge 174:b96e65c34a4d 177 if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
AnnaBridge 174:b96e65c34a4d 178 return MBED_FLASH_INVALID_SIZE;
AnnaBridge 174:b96e65c34a4d 179 }
AnnaBridge 174:b96e65c34a4d 180
AnnaBridge 174:b96e65c34a4d 181 return (GetSectorSize(GetSector(address)));
AnnaBridge 174:b96e65c34a4d 182 }
AnnaBridge 174:b96e65c34a4d 183
AnnaBridge 174:b96e65c34a4d 184 uint32_t flash_get_page_size(const flash_t *obj)
AnnaBridge 174:b96e65c34a4d 185 {
AnnaBridge 174:b96e65c34a4d 186 // Flash of STM32F7 devices can be programed 1 byte at a time
AnnaBridge 174:b96e65c34a4d 187 return (1);
AnnaBridge 174:b96e65c34a4d 188 }
AnnaBridge 174:b96e65c34a4d 189
AnnaBridge 174:b96e65c34a4d 190 uint32_t flash_get_start_address(const flash_t *obj)
AnnaBridge 174:b96e65c34a4d 191 {
AnnaBridge 174:b96e65c34a4d 192 return FLASH_BASE;
AnnaBridge 174:b96e65c34a4d 193 }
AnnaBridge 174:b96e65c34a4d 194 uint32_t flash_get_size(const flash_t *obj)
AnnaBridge 174:b96e65c34a4d 195 {
AnnaBridge 174:b96e65c34a4d 196 return FLASH_SIZE;
AnnaBridge 174:b96e65c34a4d 197 }
AnnaBridge 174:b96e65c34a4d 198
AnnaBridge 174:b96e65c34a4d 199 /**
AnnaBridge 174:b96e65c34a4d 200 * @brief Gets the sector of a given address
AnnaBridge 174:b96e65c34a4d 201 * @param None
AnnaBridge 174:b96e65c34a4d 202 * @retval The sector of a given address
AnnaBridge 174:b96e65c34a4d 203 */
AnnaBridge 174:b96e65c34a4d 204 static uint32_t GetSector(uint32_t address)
AnnaBridge 174:b96e65c34a4d 205 {
AnnaBridge 174:b96e65c34a4d 206 uint32_t sector = 0;
AnnaBridge 174:b96e65c34a4d 207 uint32_t tmp = address - ADDR_FLASH_SECTOR_0;
Anna Bridge 186:707f6e361f3e 208 #if (MBED_CONF_TARGET_FLASH_DUAL_BANK) && defined(FLASH_OPTCR_nDBANK)
Anna Bridge 186:707f6e361f3e 209 if (address < ADDR_FLASH_SECTOR_4) { // Sectors 0 to 3
Anna Bridge 186:707f6e361f3e 210 sector += tmp >> 14;
Anna Bridge 186:707f6e361f3e 211 } else if (address < ADDR_FLASH_SECTOR_5) { // Sector 4
AnnaBridge 174:b96e65c34a4d 212 sector += FLASH_SECTOR_4;
Anna Bridge 186:707f6e361f3e 213 } else if (address < ADDR_FLASH_SECTOR_12) { // Sectors 5 to 11
Anna Bridge 186:707f6e361f3e 214 sector += 4 + (tmp >> 17);
Anna Bridge 186:707f6e361f3e 215 } else if (address < ADDR_FLASH_SECTOR_16) { // Sectors 12 to 15
Anna Bridge 186:707f6e361f3e 216 tmp = address - ADDR_FLASH_SECTOR_12;
Anna Bridge 186:707f6e361f3e 217 sector += 12 + (tmp >> 14);
Anna Bridge 186:707f6e361f3e 218 } else if (address < ADDR_FLASH_SECTOR_17) { // Sector 16
Anna Bridge 186:707f6e361f3e 219 sector += FLASH_SECTOR_16;
AnnaBridge 187:0387e8f68319 220 } else { // Sectors 17 to 23
Anna Bridge 186:707f6e361f3e 221 tmp = address - ADDR_FLASH_SECTOR_12;
Anna Bridge 186:707f6e361f3e 222 sector += 16 + (tmp >> 17);
Anna Bridge 186:707f6e361f3e 223 }
Anna Bridge 186:707f6e361f3e 224 #else // SINGLE BANK
Anna Bridge 186:707f6e361f3e 225 if (address < ADDR_FLASH_SECTOR_4) { // Sectors 0 to 3
Anna Bridge 186:707f6e361f3e 226 sector += tmp >> 15;
Anna Bridge 186:707f6e361f3e 227 } else if (address < ADDR_FLASH_SECTOR_5) { // Sector 4
Anna Bridge 186:707f6e361f3e 228 sector += FLASH_SECTOR_4;
Anna Bridge 186:707f6e361f3e 229 } else { // Sectors 5 to 11
Anna Bridge 186:707f6e361f3e 230 sector += 4 + (tmp >> 18);
Anna Bridge 186:707f6e361f3e 231 }
Anna Bridge 186:707f6e361f3e 232 #endif
AnnaBridge 174:b96e65c34a4d 233 return sector;
AnnaBridge 174:b96e65c34a4d 234 }
AnnaBridge 174:b96e65c34a4d 235
AnnaBridge 174:b96e65c34a4d 236 /**
AnnaBridge 174:b96e65c34a4d 237 * @brief Gets sector Size
AnnaBridge 174:b96e65c34a4d 238 * @param None
AnnaBridge 174:b96e65c34a4d 239 * @retval The size of a given sector
AnnaBridge 174:b96e65c34a4d 240 */
AnnaBridge 174:b96e65c34a4d 241 static uint32_t GetSectorSize(uint32_t Sector)
AnnaBridge 174:b96e65c34a4d 242 {
AnnaBridge 174:b96e65c34a4d 243 uint32_t sectorsize = 0x00;
Anna Bridge 186:707f6e361f3e 244 #if (MBED_CONF_TARGET_FLASH_DUAL_BANK) && defined(FLASH_OPTCR_nDBANK)
AnnaBridge 187:0387e8f68319 245 if ((Sector == FLASH_SECTOR_0) || (Sector == FLASH_SECTOR_1) || \
AnnaBridge 187:0387e8f68319 246 (Sector == FLASH_SECTOR_2) || (Sector == FLASH_SECTOR_3) || \
AnnaBridge 187:0387e8f68319 247 (Sector == FLASH_SECTOR_12) || (Sector == FLASH_SECTOR_13) || \
AnnaBridge 187:0387e8f68319 248 (Sector == FLASH_SECTOR_14) || (Sector == FLASH_SECTOR_15)) {
AnnaBridge 187:0387e8f68319 249 sectorsize = 16 * 1024;
Anna Bridge 186:707f6e361f3e 250 } else if ((Sector == FLASH_SECTOR_4) || (Sector == FLASH_SECTOR_16)) {
AnnaBridge 187:0387e8f68319 251 sectorsize = 64 * 1024;
Anna Bridge 186:707f6e361f3e 252 } else {
AnnaBridge 187:0387e8f68319 253 sectorsize = 128 * 1024;
Anna Bridge 186:707f6e361f3e 254 }
Anna Bridge 186:707f6e361f3e 255 #else // SINGLE BANK
AnnaBridge 187:0387e8f68319 256 if ((Sector == FLASH_SECTOR_0) || (Sector == FLASH_SECTOR_1) || \
AnnaBridge 187:0387e8f68319 257 (Sector == FLASH_SECTOR_2) || (Sector == FLASH_SECTOR_3)) {
AnnaBridge 187:0387e8f68319 258 sectorsize = 32 * 1024;
AnnaBridge 174:b96e65c34a4d 259 } else if (Sector == FLASH_SECTOR_4) {
AnnaBridge 187:0387e8f68319 260 sectorsize = 128 * 1024;
AnnaBridge 174:b96e65c34a4d 261 } else {
AnnaBridge 187:0387e8f68319 262 sectorsize = 256 * 1024;
AnnaBridge 174:b96e65c34a4d 263 }
Anna Bridge 186:707f6e361f3e 264 #endif
AnnaBridge 174:b96e65c34a4d 265 return sectorsize;
AnnaBridge 174:b96e65c34a4d 266 }
AnnaBridge 174:b96e65c34a4d 267
AnnaBridge 174:b96e65c34a4d 268 #endif