Aditya Mehrotra / 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.

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

targets/TARGET_STM/TARGET_STM32F4/flash_api.c@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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