Gan likun / mbed-dev

00

drivers/FlashIAP.cpp@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ganlikun 0:13413ea9a877 1 /* mbed Microcontroller Library
ganlikun 0:13413ea9a877 2 * Copyright (c) 2017 ARM Limited
ganlikun 0:13413ea9a877 3 *
ganlikun 0:13413ea9a877 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
ganlikun 0:13413ea9a877 5 * of this software and associated documentation files (the "Software"), to deal
ganlikun 0:13413ea9a877 6 * in the Software without restriction, including without limitation the rights
ganlikun 0:13413ea9a877 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ganlikun 0:13413ea9a877 8 * copies of the Software, and to permit persons to whom the Software is
ganlikun 0:13413ea9a877 9 * furnished to do so, subject to the following conditions:
ganlikun 0:13413ea9a877 10 *
ganlikun 0:13413ea9a877 11 * The above copyright notice and this permission notice shall be included in
ganlikun 0:13413ea9a877 12 * all copies or substantial portions of the Software.
ganlikun 0:13413ea9a877 13 *
ganlikun 0:13413ea9a877 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ganlikun 0:13413ea9a877 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ganlikun 0:13413ea9a877 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ganlikun 0:13413ea9a877 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ganlikun 0:13413ea9a877 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ganlikun 0:13413ea9a877 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
ganlikun 0:13413ea9a877 20 * SOFTWARE.
ganlikun 0:13413ea9a877 21 */
ganlikun 0:13413ea9a877 22
ganlikun 0:13413ea9a877 23 #include <string.h>
ganlikun 0:13413ea9a877 24 #include "FlashIAP.h"
ganlikun 0:13413ea9a877 25 #include "mbed_assert.h"
ganlikun 0:13413ea9a877 26
ganlikun 0:13413ea9a877 27
ganlikun 0:13413ea9a877 28 #ifdef DEVICE_FLASH
ganlikun 0:13413ea9a877 29
ganlikun 0:13413ea9a877 30 namespace mbed {
ganlikun 0:13413ea9a877 31
ganlikun 0:13413ea9a877 32 SingletonPtr<PlatformMutex> FlashIAP::_mutex;
ganlikun 0:13413ea9a877 33
ganlikun 0:13413ea9a877 34 static inline bool is_aligned(uint32_t number, uint32_t alignment)
ganlikun 0:13413ea9a877 35 {
ganlikun 0:13413ea9a877 36 if ((number % alignment) != 0) {
ganlikun 0:13413ea9a877 37 return false;
ganlikun 0:13413ea9a877 38 } else {
ganlikun 0:13413ea9a877 39 return true;
ganlikun 0:13413ea9a877 40 }
ganlikun 0:13413ea9a877 41 }
ganlikun 0:13413ea9a877 42
ganlikun 0:13413ea9a877 43 FlashIAP::FlashIAP()
ganlikun 0:13413ea9a877 44 {
ganlikun 0:13413ea9a877 45
ganlikun 0:13413ea9a877 46 }
ganlikun 0:13413ea9a877 47
ganlikun 0:13413ea9a877 48 FlashIAP::~FlashIAP()
ganlikun 0:13413ea9a877 49 {
ganlikun 0:13413ea9a877 50
ganlikun 0:13413ea9a877 51 }
ganlikun 0:13413ea9a877 52
ganlikun 0:13413ea9a877 53 int FlashIAP::init()
ganlikun 0:13413ea9a877 54 {
ganlikun 0:13413ea9a877 55 int ret = 0;
ganlikun 0:13413ea9a877 56 _mutex->lock();
ganlikun 0:13413ea9a877 57 if (flash_init(&_flash)) {
ganlikun 0:13413ea9a877 58 ret = -1;
ganlikun 0:13413ea9a877 59 }
ganlikun 0:13413ea9a877 60 _mutex->unlock();
ganlikun 0:13413ea9a877 61 return ret;
ganlikun 0:13413ea9a877 62 }
ganlikun 0:13413ea9a877 63
ganlikun 0:13413ea9a877 64 int FlashIAP::deinit()
ganlikun 0:13413ea9a877 65 {
ganlikun 0:13413ea9a877 66 int ret = 0;
ganlikun 0:13413ea9a877 67 _mutex->lock();
ganlikun 0:13413ea9a877 68 if (flash_free(&_flash)) {
ganlikun 0:13413ea9a877 69 ret = -1;
ganlikun 0:13413ea9a877 70 }
ganlikun 0:13413ea9a877 71 _mutex->unlock();
ganlikun 0:13413ea9a877 72 return ret;
ganlikun 0:13413ea9a877 73 }
ganlikun 0:13413ea9a877 74
ganlikun 0:13413ea9a877 75
ganlikun 0:13413ea9a877 76 int FlashIAP::read(void *buffer, uint32_t addr, uint32_t size)
ganlikun 0:13413ea9a877 77 {
ganlikun 0:13413ea9a877 78 int32_t ret = -1;
ganlikun 0:13413ea9a877 79 _mutex->lock();
ganlikun 0:13413ea9a877 80 ret = flash_read(&_flash, addr, (uint8_t *) buffer, size);
ganlikun 0:13413ea9a877 81 _mutex->unlock();
ganlikun 0:13413ea9a877 82 return ret;
ganlikun 0:13413ea9a877 83 }
ganlikun 0:13413ea9a877 84
ganlikun 0:13413ea9a877 85 int FlashIAP::program(const void *buffer, uint32_t addr, uint32_t size)
ganlikun 0:13413ea9a877 86 {
ganlikun 0:13413ea9a877 87 uint32_t page_size = get_page_size();
ganlikun 0:13413ea9a877 88 uint32_t current_sector_size = flash_get_sector_size(&_flash, addr);
ganlikun 0:13413ea9a877 89 // addr and size should be aligned to page size, and multiple of page size
ganlikun 0:13413ea9a877 90 // page program should not cross sector boundaries
ganlikun 0:13413ea9a877 91 if (!is_aligned(addr, page_size) ||
ganlikun 0:13413ea9a877 92 !is_aligned(size, page_size) ||
ganlikun 0:13413ea9a877 93 (size < page_size) ||
ganlikun 0:13413ea9a877 94 (((addr % current_sector_size) + size) > current_sector_size)) {
ganlikun 0:13413ea9a877 95 return -1;
ganlikun 0:13413ea9a877 96 }
ganlikun 0:13413ea9a877 97
ganlikun 0:13413ea9a877 98 int ret = 0;
ganlikun 0:13413ea9a877 99 _mutex->lock();
ganlikun 0:13413ea9a877 100 if (flash_program_page(&_flash, addr, (const uint8_t *)buffer, size)) {
ganlikun 0:13413ea9a877 101 ret = -1;
ganlikun 0:13413ea9a877 102 }
ganlikun 0:13413ea9a877 103 _mutex->unlock();
ganlikun 0:13413ea9a877 104 return ret;
ganlikun 0:13413ea9a877 105 }
ganlikun 0:13413ea9a877 106
ganlikun 0:13413ea9a877 107 bool FlashIAP::is_aligned_to_sector(uint32_t addr, uint32_t size)
ganlikun 0:13413ea9a877 108 {
ganlikun 0:13413ea9a877 109 uint32_t current_sector_size = flash_get_sector_size(&_flash, addr);
ganlikun 0:13413ea9a877 110 if (!is_aligned(size, current_sector_size) ||
ganlikun 0:13413ea9a877 111 !is_aligned(addr, current_sector_size)) {
ganlikun 0:13413ea9a877 112 return false;
ganlikun 0:13413ea9a877 113 } else {
ganlikun 0:13413ea9a877 114 return true;
ganlikun 0:13413ea9a877 115 }
ganlikun 0:13413ea9a877 116 }
ganlikun 0:13413ea9a877 117
ganlikun 0:13413ea9a877 118 int FlashIAP::erase(uint32_t addr, uint32_t size)
ganlikun 0:13413ea9a877 119 {
ganlikun 0:13413ea9a877 120 uint32_t current_sector_size = 0UL;
ganlikun 0:13413ea9a877 121
ganlikun 0:13413ea9a877 122 if (!is_aligned_to_sector(addr, size)) {
ganlikun 0:13413ea9a877 123 return -1;
ganlikun 0:13413ea9a877 124 }
ganlikun 0:13413ea9a877 125
ganlikun 0:13413ea9a877 126 int32_t ret = 0;
ganlikun 0:13413ea9a877 127 _mutex->lock();
ganlikun 0:13413ea9a877 128 while (size) {
ganlikun 0:13413ea9a877 129 ret = flash_erase_sector(&_flash, addr);
ganlikun 0:13413ea9a877 130 if (ret != 0) {
ganlikun 0:13413ea9a877 131 ret = -1;
ganlikun 0:13413ea9a877 132 break;
ganlikun 0:13413ea9a877 133 }
ganlikun 0:13413ea9a877 134 current_sector_size = flash_get_sector_size(&_flash, addr);
ganlikun 0:13413ea9a877 135 if (!is_aligned_to_sector(addr, size)) {
ganlikun 0:13413ea9a877 136 ret = -1;
ganlikun 0:13413ea9a877 137 break;
ganlikun 0:13413ea9a877 138 }
ganlikun 0:13413ea9a877 139 size -= current_sector_size;
ganlikun 0:13413ea9a877 140 addr += current_sector_size;
ganlikun 0:13413ea9a877 141 }
ganlikun 0:13413ea9a877 142 _mutex->unlock();
ganlikun 0:13413ea9a877 143 return ret;
ganlikun 0:13413ea9a877 144 }
ganlikun 0:13413ea9a877 145
ganlikun 0:13413ea9a877 146 uint32_t FlashIAP::get_page_size() const
ganlikun 0:13413ea9a877 147 {
ganlikun 0:13413ea9a877 148 return flash_get_page_size(&_flash);
ganlikun 0:13413ea9a877 149 }
ganlikun 0:13413ea9a877 150
ganlikun 0:13413ea9a877 151 uint32_t FlashIAP::get_sector_size(uint32_t addr) const
ganlikun 0:13413ea9a877 152 {
ganlikun 0:13413ea9a877 153 return flash_get_sector_size(&_flash, addr);
ganlikun 0:13413ea9a877 154 }
ganlikun 0:13413ea9a877 155
ganlikun 0:13413ea9a877 156 uint32_t FlashIAP::get_flash_start() const
ganlikun 0:13413ea9a877 157 {
ganlikun 0:13413ea9a877 158 return flash_get_start_address(&_flash);
ganlikun 0:13413ea9a877 159 }
ganlikun 0:13413ea9a877 160
ganlikun 0:13413ea9a877 161 uint32_t FlashIAP::get_flash_size() const
ganlikun 0:13413ea9a877 162 {
ganlikun 0:13413ea9a877 163 return flash_get_size(&_flash);
ganlikun 0:13413ea9a877 164 }
ganlikun 0:13413ea9a877 165
ganlikun 0:13413ea9a877 166 }
ganlikun 0:13413ea9a877 167
ganlikun 0:13413ea9a877 168 #endif
ganlikun 0:13413ea9a877 169