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