Pedro Correia / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

drivers/FlashIAP.cpp@187:fa51feb62426, 2018-10-09 (annotated)

Committer:
pmcorreia
Date:
Tue Oct 09 14:42:37 2018 +0000
Revision:
187:fa51feb62426
Parent:
186:707f6e361f3e 
Updated version to work with F446RE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 160:d5399cc887bb 1 /* mbed Microcontroller Library
<> 160:d5399cc887bb 2 * Copyright (c) 2017 ARM Limited
<> 160:d5399cc887bb 3 *
<> 160:d5399cc887bb 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
<> 160:d5399cc887bb 5 * of this software and associated documentation files (the "Software"), to deal
<> 160:d5399cc887bb 6 * in the Software without restriction, including without limitation the rights
<> 160:d5399cc887bb 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
<> 160:d5399cc887bb 8 * copies of the Software, and to permit persons to whom the Software is
<> 160:d5399cc887bb 9 * furnished to do so, subject to the following conditions:
<> 160:d5399cc887bb 10 *
<> 160:d5399cc887bb 11 * The above copyright notice and this permission notice shall be included in
<> 160:d5399cc887bb 12 * all copies or substantial portions of the Software.
<> 160:d5399cc887bb 13 *
<> 160:d5399cc887bb 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
<> 160:d5399cc887bb 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
<> 160:d5399cc887bb 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
<> 160:d5399cc887bb 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
<> 160:d5399cc887bb 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
<> 160:d5399cc887bb 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
<> 160:d5399cc887bb 20 * SOFTWARE.
<> 160:d5399cc887bb 21 */
<> 160:d5399cc887bb 22
AnnaBridge 184:08ed48f1de7f 23 #include <stdio.h>
<> 160:d5399cc887bb 24 #include <string.h>
AnnaBridge 184:08ed48f1de7f 25 #include <algorithm>
<> 160:d5399cc887bb 26 #include "FlashIAP.h"
<> 160:d5399cc887bb 27 #include "mbed_assert.h"
<> 160:d5399cc887bb 28
<> 160:d5399cc887bb 29
<> 160:d5399cc887bb 30 #ifdef DEVICE_FLASH
<> 160:d5399cc887bb 31
<> 160:d5399cc887bb 32 namespace mbed {
<> 160:d5399cc887bb 33
<> 160:d5399cc887bb 34 SingletonPtr<PlatformMutex> FlashIAP::_mutex;
<> 160:d5399cc887bb 35
<> 160:d5399cc887bb 36 static inline bool is_aligned(uint32_t number, uint32_t alignment)
<> 160:d5399cc887bb 37 {
<> 160:d5399cc887bb 38 if ((number % alignment) != 0) {
<> 160:d5399cc887bb 39 return false;
<> 160:d5399cc887bb 40 } else {
<> 160:d5399cc887bb 41 return true;
<> 160:d5399cc887bb 42 }
<> 160:d5399cc887bb 43 }
<> 160:d5399cc887bb 44
<> 160:d5399cc887bb 45 FlashIAP::FlashIAP()
<> 160:d5399cc887bb 46 {
<> 160:d5399cc887bb 47
<> 160:d5399cc887bb 48 }
<> 160:d5399cc887bb 49
<> 160:d5399cc887bb 50 FlashIAP::~FlashIAP()
<> 160:d5399cc887bb 51 {
<> 160:d5399cc887bb 52
<> 160:d5399cc887bb 53 }
<> 160:d5399cc887bb 54
<> 160:d5399cc887bb 55 int FlashIAP::init()
<> 160:d5399cc887bb 56 {
<> 160:d5399cc887bb 57 int ret = 0;
<> 160:d5399cc887bb 58 _mutex->lock();
<> 160:d5399cc887bb 59 if (flash_init(&_flash)) {
Kojto 169:e3b6fe271b81 60 ret = -1;
<> 160:d5399cc887bb 61 }
AnnaBridge 184:08ed48f1de7f 62 uint32_t page_size = get_page_size();
AnnaBridge 184:08ed48f1de7f 63 _page_buf = new uint8_t[page_size];
AnnaBridge 184:08ed48f1de7f 64
<> 160:d5399cc887bb 65 _mutex->unlock();
<> 160:d5399cc887bb 66 return ret;
<> 160:d5399cc887bb 67 }
<> 160:d5399cc887bb 68
<> 160:d5399cc887bb 69 int FlashIAP::deinit()
<> 160:d5399cc887bb 70 {
<> 160:d5399cc887bb 71 int ret = 0;
<> 160:d5399cc887bb 72 _mutex->lock();
<> 160:d5399cc887bb 73 if (flash_free(&_flash)) {
Kojto 169:e3b6fe271b81 74 ret = -1;
<> 160:d5399cc887bb 75 }
AnnaBridge 184:08ed48f1de7f 76 delete[] _page_buf;
<> 160:d5399cc887bb 77 _mutex->unlock();
<> 160:d5399cc887bb 78 return ret;
<> 160:d5399cc887bb 79 }
<> 160:d5399cc887bb 80
<> 160:d5399cc887bb 81
<> 160:d5399cc887bb 82 int FlashIAP::read(void *buffer, uint32_t addr, uint32_t size)
<> 160:d5399cc887bb 83 {
Kojto 169:e3b6fe271b81 84 int32_t ret = -1;
<> 160:d5399cc887bb 85 _mutex->lock();
Kojto 169:e3b6fe271b81 86 ret = flash_read(&_flash, addr, (uint8_t *) buffer, size);
<> 160:d5399cc887bb 87 _mutex->unlock();
Kojto 169:e3b6fe271b81 88 return ret;
<> 160:d5399cc887bb 89 }
<> 160:d5399cc887bb 90
<> 160:d5399cc887bb 91 int FlashIAP::program(const void *buffer, uint32_t addr, uint32_t size)
<> 160:d5399cc887bb 92 {
<> 160:d5399cc887bb 93 uint32_t page_size = get_page_size();
AnnaBridge 184:08ed48f1de7f 94 uint32_t flash_size = flash_get_size(&_flash);
AnnaBridge 184:08ed48f1de7f 95 uint32_t flash_start_addr = flash_get_start_address(&_flash);
AnnaBridge 184:08ed48f1de7f 96 uint32_t chunk, prog_size;
AnnaBridge 184:08ed48f1de7f 97 const uint8_t *buf = (uint8_t *) buffer;
AnnaBridge 184:08ed48f1de7f 98 const uint8_t *prog_buf;
AnnaBridge 184:08ed48f1de7f 99
AnnaBridge 184:08ed48f1de7f 100 // addr should be aligned to page size
AnnaBridge 184:08ed48f1de7f 101 if (!is_aligned(addr, page_size) || (!buffer) ||
AnnaBridge 184:08ed48f1de7f 102 ((addr + size) > (flash_start_addr + flash_size))) {
<> 160:d5399cc887bb 103 return -1;
<> 160:d5399cc887bb 104 }
<> 160:d5399cc887bb 105
<> 160:d5399cc887bb 106 int ret = 0;
<> 160:d5399cc887bb 107 _mutex->lock();
AnnaBridge 184:08ed48f1de7f 108 while (size) {
AnnaBridge 184:08ed48f1de7f 109 uint32_t current_sector_size = flash_get_sector_size(&_flash, addr);
Anna Bridge 186:707f6e361f3e 110 bool unaligned_src = (((size_t) buf / sizeof(uint32_t) * sizeof(uint32_t)) != (size_t) buf);
AnnaBridge 184:08ed48f1de7f 111 chunk = std::min(current_sector_size - (addr % current_sector_size), size);
Anna Bridge 186:707f6e361f3e 112 // Need to use the internal page buffer in any of these two cases:
Anna Bridge 186:707f6e361f3e 113 // 1. Size is not page aligned
Anna Bridge 186:707f6e361f3e 114 // 2. Source buffer is not aligned to uint32_t. This is not supported by many targets (although
Anna Bridge 186:707f6e361f3e 115 // the pointer they accept is of uint8_t).
Anna Bridge 186:707f6e361f3e 116 if (unaligned_src || (chunk < page_size)) {
Anna Bridge 186:707f6e361f3e 117 chunk = std::min(chunk, page_size);
AnnaBridge 184:08ed48f1de7f 118 memcpy(_page_buf, buf, chunk);
Anna Bridge 186:707f6e361f3e 119 if (chunk < page_size) {
Anna Bridge 186:707f6e361f3e 120 memset(_page_buf + chunk, 0xFF, page_size - chunk);
Anna Bridge 186:707f6e361f3e 121 }
AnnaBridge 184:08ed48f1de7f 122 prog_buf = _page_buf;
AnnaBridge 184:08ed48f1de7f 123 prog_size = page_size;
AnnaBridge 184:08ed48f1de7f 124 } else {
AnnaBridge 184:08ed48f1de7f 125 chunk = chunk / page_size * page_size;
AnnaBridge 184:08ed48f1de7f 126 prog_buf = buf;
AnnaBridge 184:08ed48f1de7f 127 prog_size = chunk;
AnnaBridge 184:08ed48f1de7f 128 }
AnnaBridge 184:08ed48f1de7f 129 if (flash_program_page(&_flash, addr, prog_buf, prog_size)) {
AnnaBridge 184:08ed48f1de7f 130 ret = -1;
AnnaBridge 184:08ed48f1de7f 131 break;
AnnaBridge 184:08ed48f1de7f 132 }
AnnaBridge 184:08ed48f1de7f 133 size -= chunk;
AnnaBridge 184:08ed48f1de7f 134 addr += chunk;
AnnaBridge 184:08ed48f1de7f 135 buf += chunk;
<> 160:d5399cc887bb 136 }
<> 160:d5399cc887bb 137 _mutex->unlock();
AnnaBridge 184:08ed48f1de7f 138
<> 160:d5399cc887bb 139 return ret;
<> 160:d5399cc887bb 140 }
<> 160:d5399cc887bb 141
<> 160:d5399cc887bb 142 bool FlashIAP::is_aligned_to_sector(uint32_t addr, uint32_t size)
<> 160:d5399cc887bb 143 {
<> 160:d5399cc887bb 144 uint32_t current_sector_size = flash_get_sector_size(&_flash, addr);
<> 160:d5399cc887bb 145 if (!is_aligned(size, current_sector_size) ||
<> 160:d5399cc887bb 146 !is_aligned(addr, current_sector_size)) {
<> 160:d5399cc887bb 147 return false;
<> 160:d5399cc887bb 148 } else {
<> 160:d5399cc887bb 149 return true;
<> 160:d5399cc887bb 150 }
<> 160:d5399cc887bb 151 }
<> 160:d5399cc887bb 152
<> 160:d5399cc887bb 153 int FlashIAP::erase(uint32_t addr, uint32_t size)
<> 160:d5399cc887bb 154 {
AnnaBridge 184:08ed48f1de7f 155 uint32_t current_sector_size;
AnnaBridge 184:08ed48f1de7f 156 uint32_t flash_size = flash_get_size(&_flash);
AnnaBridge 184:08ed48f1de7f 157 uint32_t flash_start_addr = flash_get_start_address(&_flash);
AnnaBridge 184:08ed48f1de7f 158 uint32_t flash_end_addr = flash_start_addr + flash_size;
AnnaBridge 184:08ed48f1de7f 159 uint32_t erase_end_addr = addr + size;
<> 160:d5399cc887bb 160
AnnaBridge 184:08ed48f1de7f 161 if (erase_end_addr > flash_end_addr) {
<> 160:d5399cc887bb 162 return -1;
AnnaBridge 184:08ed48f1de7f 163 } else if (erase_end_addr < flash_end_addr){
AnnaBridge 184:08ed48f1de7f 164 uint32_t following_sector_size = flash_get_sector_size(&_flash, erase_end_addr);
AnnaBridge 184:08ed48f1de7f 165 if (!is_aligned(erase_end_addr, following_sector_size)) {
AnnaBridge 184:08ed48f1de7f 166 return -1;
AnnaBridge 184:08ed48f1de7f 167 }
<> 160:d5399cc887bb 168 }
<> 160:d5399cc887bb 169
<> 160:d5399cc887bb 170 int32_t ret = 0;
<> 160:d5399cc887bb 171 _mutex->lock();
<> 160:d5399cc887bb 172 while (size) {
<> 160:d5399cc887bb 173 ret = flash_erase_sector(&_flash, addr);
<> 160:d5399cc887bb 174 if (ret != 0) {
<> 160:d5399cc887bb 175 ret = -1;
<> 160:d5399cc887bb 176 break;
<> 160:d5399cc887bb 177 }
<> 160:d5399cc887bb 178 current_sector_size = flash_get_sector_size(&_flash, addr);
<> 160:d5399cc887bb 179 size -= current_sector_size;
<> 160:d5399cc887bb 180 addr += current_sector_size;
<> 160:d5399cc887bb 181 }
<> 160:d5399cc887bb 182 _mutex->unlock();
<> 160:d5399cc887bb 183 return ret;
<> 160:d5399cc887bb 184 }
<> 160:d5399cc887bb 185
<> 160:d5399cc887bb 186 uint32_t FlashIAP::get_page_size() const
<> 160:d5399cc887bb 187 {
<> 160:d5399cc887bb 188 return flash_get_page_size(&_flash);
<> 160:d5399cc887bb 189 }
<> 160:d5399cc887bb 190
<> 160:d5399cc887bb 191 uint32_t FlashIAP::get_sector_size(uint32_t addr) const
<> 160:d5399cc887bb 192 {
<> 160:d5399cc887bb 193 return flash_get_sector_size(&_flash, addr);
<> 160:d5399cc887bb 194 }
<> 160:d5399cc887bb 195
<> 160:d5399cc887bb 196 uint32_t FlashIAP::get_flash_start() const
<> 160:d5399cc887bb 197 {
<> 160:d5399cc887bb 198 return flash_get_start_address(&_flash);
<> 160:d5399cc887bb 199 }
<> 160:d5399cc887bb 200
<> 160:d5399cc887bb 201 uint32_t FlashIAP::get_flash_size() const
<> 160:d5399cc887bb 202 {
<> 160:d5399cc887bb 203 return flash_get_size(&_flash);
<> 160:d5399cc887bb 204 }
<> 160:d5399cc887bb 205
<> 160:d5399cc887bb 206 }
<> 160:d5399cc887bb 207
<> 160:d5399cc887bb 208 #endif