John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

targets/TARGET_STM/TARGET_STM32L4/flash_api.c@182:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
182:57724642e740
Parent:
176:af195413fb11 
mbed-dev library. Release version 159.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 167:e84263d55307 1 /* mbed Microcontroller Library
AnnaBridge 167:e84263d55307 2 * Copyright (c) 2017 ARM Limited
AnnaBridge 167:e84263d55307 3 *
AnnaBridge 167:e84263d55307 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 167:e84263d55307 5 * you may not use this file except in compliance with the License.
AnnaBridge 167:e84263d55307 6 * You may obtain a copy of the License at
AnnaBridge 167:e84263d55307 7 *
AnnaBridge 167:e84263d55307 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 167:e84263d55307 9 *
AnnaBridge 167:e84263d55307 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 167:e84263d55307 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 167:e84263d55307 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 167:e84263d55307 13 * See the License for the specific language governing permissions and
AnnaBridge 167:e84263d55307 14 * limitations under the License.
AnnaBridge 167:e84263d55307 15 */
AnnaBridge 167:e84263d55307 16
AnnaBridge 167:e84263d55307 17 #include "flash_api.h"
AnnaBridge 167:e84263d55307 18 #include "mbed_critical.h"
AnnaBridge 167:e84263d55307 19
AnnaBridge 167:e84263d55307 20 #if DEVICE_FLASH
AnnaBridge 167:e84263d55307 21 #include "mbed_assert.h"
AnnaBridge 167:e84263d55307 22 #include "cmsis.h"
AnnaBridge 167:e84263d55307 23
AnnaBridge 167:e84263d55307 24 /**
AnnaBridge 167:e84263d55307 25 * @brief Gets the page of a given address
AnnaBridge 167:e84263d55307 26 * @param Addr: Address of the FLASH Memory
AnnaBridge 167:e84263d55307 27 * @retval The page of a given address
AnnaBridge 167:e84263d55307 28 */
AnnaBridge 167:e84263d55307 29 static uint32_t GetPage(uint32_t Addr)
AnnaBridge 167:e84263d55307 30 {
AnnaBridge 167:e84263d55307 31 uint32_t page = 0;
AnnaBridge 167:e84263d55307 32
AnnaBridge 167:e84263d55307 33 if (Addr < (FLASH_BASE + FLASH_BANK_SIZE)) {
AnnaBridge 167:e84263d55307 34 /* Bank 1 */
AnnaBridge 167:e84263d55307 35 page = (Addr - FLASH_BASE) / FLASH_PAGE_SIZE;
AnnaBridge 167:e84263d55307 36 } else {
AnnaBridge 167:e84263d55307 37 /* Bank 2 */
AnnaBridge 167:e84263d55307 38 page = (Addr - (FLASH_BASE + FLASH_BANK_SIZE)) / FLASH_PAGE_SIZE;
AnnaBridge 167:e84263d55307 39 }
AnnaBridge 167:e84263d55307 40
AnnaBridge 167:e84263d55307 41 return page;
AnnaBridge 167:e84263d55307 42 }
AnnaBridge 167:e84263d55307 43
AnnaBridge 167:e84263d55307 44 /**
AnnaBridge 167:e84263d55307 45 * @brief Gets the bank of a given address
AnnaBridge 167:e84263d55307 46 * @param Addr: Address of the FLASH Memory
AnnaBridge 167:e84263d55307 47 * @retval The bank of a given address
AnnaBridge 167:e84263d55307 48 */
AnnaBridge 167:e84263d55307 49 static uint32_t GetBank(uint32_t Addr)
AnnaBridge 167:e84263d55307 50 {
AnnaBridge 167:e84263d55307 51 uint32_t bank = 0;
AnnaBridge 167:e84263d55307 52 #if defined(SYSCFG_MEMRMP_FB_MODE)
AnnaBridge 167:e84263d55307 53 if (READ_BIT(SYSCFG->MEMRMP, SYSCFG_MEMRMP_FB_MODE) == 0) {
AnnaBridge 167:e84263d55307 54 /* No Bank swap */
AnnaBridge 167:e84263d55307 55 if (Addr < (FLASH_BASE + FLASH_BANK_SIZE)) {
AnnaBridge 167:e84263d55307 56 bank = FLASH_BANK_1;
AnnaBridge 167:e84263d55307 57 } else {
AnnaBridge 167:e84263d55307 58 bank = FLASH_BANK_2;
AnnaBridge 167:e84263d55307 59 }
AnnaBridge 167:e84263d55307 60 } else {
AnnaBridge 167:e84263d55307 61 /* Bank swap */
AnnaBridge 167:e84263d55307 62 if (Addr < (FLASH_BASE + FLASH_BANK_SIZE)) {
AnnaBridge 167:e84263d55307 63 bank = FLASH_BANK_2;
AnnaBridge 167:e84263d55307 64 } else {
AnnaBridge 167:e84263d55307 65 bank = FLASH_BANK_1;
AnnaBridge 167:e84263d55307 66 }
AnnaBridge 167:e84263d55307 67 }
AnnaBridge 167:e84263d55307 68 #else
AnnaBridge 167:e84263d55307 69 /* Device like L432KC */
AnnaBridge 167:e84263d55307 70 bank = FLASH_BANK_1;
AnnaBridge 167:e84263d55307 71 #endif
AnnaBridge 167:e84263d55307 72
AnnaBridge 167:e84263d55307 73 return bank;
AnnaBridge 167:e84263d55307 74 }
AnnaBridge 167:e84263d55307 75
AnnaBridge 167:e84263d55307 76 /** Initialize the flash peripheral and the flash_t object
AnnaBridge 167:e84263d55307 77 *
AnnaBridge 167:e84263d55307 78 * @param obj The flash object
AnnaBridge 167:e84263d55307 79 * @return 0 for success, -1 for error
AnnaBridge 167:e84263d55307 80 */
AnnaBridge 167:e84263d55307 81 int32_t flash_init(flash_t *obj)
AnnaBridge 167:e84263d55307 82 {
AnnaBridge 167:e84263d55307 83 return 0;
AnnaBridge 167:e84263d55307 84 }
AnnaBridge 167:e84263d55307 85
AnnaBridge 167:e84263d55307 86 /** Uninitialize the flash peripheral and the flash_t object
AnnaBridge 167:e84263d55307 87 *
AnnaBridge 167:e84263d55307 88 * @param obj The flash object
AnnaBridge 167:e84263d55307 89 * @return 0 for success, -1 for error
AnnaBridge 167:e84263d55307 90 */
AnnaBridge 167:e84263d55307 91 int32_t flash_free(flash_t *obj)
AnnaBridge 167:e84263d55307 92 {
AnnaBridge 167:e84263d55307 93 return 0;
AnnaBridge 167:e84263d55307 94 }
AnnaBridge 167:e84263d55307 95
AnnaBridge 176:af195413fb11 96 static int32_t flash_unlock(void)
AnnaBridge 176:af195413fb11 97 {
AnnaBridge 176:af195413fb11 98 /* Allow Access to Flash control registers and user Falsh */
AnnaBridge 176:af195413fb11 99 if (HAL_FLASH_Unlock()) {
AnnaBridge 176:af195413fb11 100 return -1;
AnnaBridge 176:af195413fb11 101 } else {
AnnaBridge 176:af195413fb11 102 return 0;
AnnaBridge 176:af195413fb11 103 }
AnnaBridge 176:af195413fb11 104 }
AnnaBridge 176:af195413fb11 105
AnnaBridge 176:af195413fb11 106 static int32_t flash_lock(void)
AnnaBridge 176:af195413fb11 107 {
AnnaBridge 176:af195413fb11 108 /* Disable the Flash option control register access (recommended to protect
AnnaBridge 176:af195413fb11 109 the option Bytes against possible unwanted operations) */
AnnaBridge 176:af195413fb11 110 if (HAL_FLASH_Lock()) {
AnnaBridge 176:af195413fb11 111 return -1;
AnnaBridge 176:af195413fb11 112 } else {
AnnaBridge 176:af195413fb11 113 return 0;
AnnaBridge 176:af195413fb11 114 }
AnnaBridge 176:af195413fb11 115 }
AnnaBridge 176:af195413fb11 116
AnnaBridge 167:e84263d55307 117 /** Erase one sector starting at defined address
AnnaBridge 167:e84263d55307 118 *
AnnaBridge 167:e84263d55307 119 * The address should be at sector boundary. This function does not do any check for address alignments
AnnaBridge 167:e84263d55307 120 * @param obj The flash object
AnnaBridge 167:e84263d55307 121 * @param address The sector starting address
AnnaBridge 167:e84263d55307 122 * @return 0 for success, -1 for error
AnnaBridge 167:e84263d55307 123 */
AnnaBridge 167:e84263d55307 124 int32_t flash_erase_sector(flash_t *obj, uint32_t address)
AnnaBridge 167:e84263d55307 125 {
AnnaBridge 167:e84263d55307 126 uint32_t FirstPage = 0, BankNumber = 0;
AnnaBridge 167:e84263d55307 127 uint32_t PAGEError = 0;
AnnaBridge 167:e84263d55307 128 FLASH_EraseInitTypeDef EraseInitStruct;
AnnaBridge 176:af195413fb11 129 int32_t status = 0;
AnnaBridge 167:e84263d55307 130
AnnaBridge 167:e84263d55307 131 if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
AnnaBridge 167:e84263d55307 132
AnnaBridge 167:e84263d55307 133 return -1;
AnnaBridge 167:e84263d55307 134 }
AnnaBridge 167:e84263d55307 135
AnnaBridge 176:af195413fb11 136 if (flash_unlock() != HAL_OK) {
AnnaBridge 176:af195413fb11 137 return -1;
AnnaBridge 176:af195413fb11 138 }
AnnaBridge 176:af195413fb11 139
AnnaBridge 167:e84263d55307 140 /* Clear OPTVERR bit set on virgin samples */
AnnaBridge 167:e84263d55307 141 __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_OPTVERR);
AnnaBridge 167:e84263d55307 142 /* Get the 1st page to erase */
AnnaBridge 167:e84263d55307 143 FirstPage = GetPage(address);
AnnaBridge 167:e84263d55307 144 /* MBED HAL erases 1 page / sector at a time */
AnnaBridge 167:e84263d55307 145 /* Get the bank */
AnnaBridge 167:e84263d55307 146 BankNumber = GetBank(address);
AnnaBridge 167:e84263d55307 147 /* Fill EraseInit structure*/
AnnaBridge 167:e84263d55307 148 EraseInitStruct.TypeErase = FLASH_TYPEERASE_PAGES;
AnnaBridge 167:e84263d55307 149 EraseInitStruct.Banks = BankNumber;
AnnaBridge 167:e84263d55307 150 EraseInitStruct.Page = FirstPage;
AnnaBridge 167:e84263d55307 151 EraseInitStruct.NbPages = 1;
AnnaBridge 167:e84263d55307 152
AnnaBridge 167:e84263d55307 153 /* Note: If an erase operation in Flash memory also concerns data in the data or instruction cache,
AnnaBridge 167:e84263d55307 154 you have to make sure that these data are rewritten before they are accessed during code
AnnaBridge 167:e84263d55307 155 execution. If this cannot be done safely, it is recommended to flush the caches by setting the
AnnaBridge 167:e84263d55307 156 DCRST and ICRST bits in the FLASH_CR register. */
AnnaBridge 167:e84263d55307 157
AnnaBridge 167:e84263d55307 158 if (HAL_FLASHEx_Erase(&EraseInitStruct, &PAGEError) != HAL_OK) {
AnnaBridge 176:af195413fb11 159 status = -1;
AnnaBridge 167:e84263d55307 160 }
AnnaBridge 176:af195413fb11 161
AnnaBridge 176:af195413fb11 162 flash_lock();
AnnaBridge 176:af195413fb11 163
AnnaBridge 176:af195413fb11 164 return status;
AnnaBridge 167:e84263d55307 165 }
AnnaBridge 167:e84263d55307 166
AnnaBridge 167:e84263d55307 167 /** Program one page starting at defined address
AnnaBridge 167:e84263d55307 168 *
AnnaBridge 167:e84263d55307 169 * The page should be at page boundary, should not cross multiple sectors.
AnnaBridge 167:e84263d55307 170 * This function does not do any check for address alignments or if size
AnnaBridge 167:e84263d55307 171 * is aligned to a page size.
AnnaBridge 167:e84263d55307 172 * @param obj The flash object
AnnaBridge 167:e84263d55307 173 * @param address The sector starting address
AnnaBridge 167:e84263d55307 174 * @param data The data buffer to be programmed
AnnaBridge 167:e84263d55307 175 * @param size The number of bytes to program
AnnaBridge 167:e84263d55307 176 * @return 0 for success, -1 for error
AnnaBridge 167:e84263d55307 177 */
AnnaBridge 167:e84263d55307 178 int32_t flash_program_page(flash_t *obj, uint32_t address,
AnnaBridge 167:e84263d55307 179 const uint8_t *data, uint32_t size)
AnnaBridge 167:e84263d55307 180 {
AnnaBridge 167:e84263d55307 181 uint32_t StartAddress = 0;
AnnaBridge 176:af195413fb11 182 int32_t status = 0;
AnnaBridge 167:e84263d55307 183
AnnaBridge 167:e84263d55307 184 if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
AnnaBridge 167:e84263d55307 185 return -1;
AnnaBridge 167:e84263d55307 186 }
AnnaBridge 167:e84263d55307 187
AnnaBridge 167:e84263d55307 188 if ((size % 8) != 0) {
AnnaBridge 167:e84263d55307 189 /* L4 flash devices can only be programmed 64bits/8 bytes at a time */
AnnaBridge 167:e84263d55307 190 return -1;
AnnaBridge 167:e84263d55307 191 }
AnnaBridge 167:e84263d55307 192
AnnaBridge 176:af195413fb11 193 if (flash_unlock() != HAL_OK) {
AnnaBridge 176:af195413fb11 194 return -1;
AnnaBridge 176:af195413fb11 195 }
AnnaBridge 176:af195413fb11 196
AnnaBridge 167:e84263d55307 197 /* Program the user Flash area word by word */
AnnaBridge 167:e84263d55307 198 StartAddress = address;
AnnaBridge 167:e84263d55307 199
AnnaBridge 167:e84263d55307 200 /* HW needs an aligned address to program flash, which data
AnnaBridge 167:e84263d55307 201 * parameters doesn't ensure */
AnnaBridge 167:e84263d55307 202 if ((uint32_t) data % 4 != 0) {
AnnaBridge 167:e84263d55307 203 volatile uint64_t data64;
AnnaBridge 176:af195413fb11 204 while ((address < (StartAddress + size)) && (status == 0)) {
AnnaBridge 167:e84263d55307 205 for (uint8_t i =0; i < 8; i++) {
AnnaBridge 167:e84263d55307 206 *(((uint8_t *) &data64) + i) = *(data + i);
AnnaBridge 167:e84263d55307 207 }
AnnaBridge 167:e84263d55307 208
AnnaBridge 176:af195413fb11 209 if (HAL_FLASH_Program(FLASH_TYPEPROGRAM_DOUBLEWORD, address, data64)
AnnaBridge 176:af195413fb11 210 == HAL_OK) {
AnnaBridge 167:e84263d55307 211 address = address + 8;
AnnaBridge 167:e84263d55307 212 data = data + 8;
AnnaBridge 167:e84263d55307 213 } else {
AnnaBridge 176:af195413fb11 214 status = -1;
AnnaBridge 167:e84263d55307 215 }
AnnaBridge 167:e84263d55307 216 }
AnnaBridge 167:e84263d55307 217 } else { /* case where data is aligned, so let's avoid any copy */
AnnaBridge 176:af195413fb11 218 while ((address < (StartAddress + size)) && (status == 0)) {
AnnaBridge 176:af195413fb11 219 if (HAL_FLASH_Program(FLASH_TYPEPROGRAM_DOUBLEWORD, address,
AnnaBridge 176:af195413fb11 220 *((uint64_t*) data))
AnnaBridge 176:af195413fb11 221 == HAL_OK) {
AnnaBridge 167:e84263d55307 222 address = address + 8;
AnnaBridge 167:e84263d55307 223 data = data + 8;
AnnaBridge 167:e84263d55307 224 } else {
AnnaBridge 176:af195413fb11 225 status = -1;
AnnaBridge 167:e84263d55307 226 }
AnnaBridge 167:e84263d55307 227 }
AnnaBridge 167:e84263d55307 228 }
AnnaBridge 167:e84263d55307 229
AnnaBridge 176:af195413fb11 230 flash_lock();
AnnaBridge 176:af195413fb11 231
AnnaBridge 176:af195413fb11 232 return status;
AnnaBridge 167:e84263d55307 233 }
AnnaBridge 167:e84263d55307 234
AnnaBridge 167:e84263d55307 235 /** Get sector size
AnnaBridge 176:af195413fb11 236 *
AnnaBridge 167:e84263d55307 237 * @param obj The flash object
AnnaBridge 167:e84263d55307 238 * @param address The sector starting address
AnnaBridge 167:e84263d55307 239 * @return The size of a sector
AnnaBridge 167:e84263d55307 240 */
AnnaBridge 167:e84263d55307 241 uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address) {
AnnaBridge 167:e84263d55307 242 /* considering 1 sector = 1 page */
AnnaBridge 167:e84263d55307 243 if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
AnnaBridge 167:e84263d55307 244 return MBED_FLASH_INVALID_SIZE;
AnnaBridge 167:e84263d55307 245 } else {
AnnaBridge 167:e84263d55307 246 return FLASH_PAGE_SIZE;
AnnaBridge 167:e84263d55307 247 }
AnnaBridge 167:e84263d55307 248 }
AnnaBridge 167:e84263d55307 249
AnnaBridge 167:e84263d55307 250 /** Get page size
AnnaBridge 167:e84263d55307 251 *
AnnaBridge 167:e84263d55307 252 * @param obj The flash object
AnnaBridge 167:e84263d55307 253 * @param address The page starting address
AnnaBridge 167:e84263d55307 254 * @return The size of a page
AnnaBridge 167:e84263d55307 255 */
AnnaBridge 167:e84263d55307 256 uint32_t flash_get_page_size(const flash_t *obj) {
AnnaBridge 175:b96e65c34a4d 257 /* Page size is the minimum programable size, which 8 bytes */
AnnaBridge 175:b96e65c34a4d 258 return 8;
AnnaBridge 167:e84263d55307 259 }
AnnaBridge 167:e84263d55307 260
AnnaBridge 167:e84263d55307 261 /** Get start address for the flash region
AnnaBridge 167:e84263d55307 262 *
AnnaBridge 167:e84263d55307 263 * @param obj The flash object
AnnaBridge 167:e84263d55307 264 * @return The start address for the flash region
AnnaBridge 167:e84263d55307 265 */
AnnaBridge 167:e84263d55307 266 uint32_t flash_get_start_address(const flash_t *obj) {
AnnaBridge 167:e84263d55307 267 return FLASH_BASE;
AnnaBridge 167:e84263d55307 268 }
AnnaBridge 167:e84263d55307 269
AnnaBridge 167:e84263d55307 270 /** Get the flash region size
AnnaBridge 167:e84263d55307 271 *
AnnaBridge 167:e84263d55307 272 * @param obj The flash object
AnnaBridge 167:e84263d55307 273 * @return The flash region size
AnnaBridge 167:e84263d55307 274 */
AnnaBridge 167:e84263d55307 275 uint32_t flash_get_size(const flash_t *obj) {
AnnaBridge 167:e84263d55307 276 return FLASH_SIZE;
AnnaBridge 167:e84263d55307 277 }
AnnaBridge 167:e84263d55307 278
AnnaBridge 167:e84263d55307 279 #endif