mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/FlashIAP.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2017 ARM Limited
AnnaBridge 156:ff21514d8981 3 *
AnnaBridge 156:ff21514d8981 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
AnnaBridge 156:ff21514d8981 5 * of this software and associated documentation files (the "Software"), to deal
AnnaBridge 156:ff21514d8981 6 * in the Software without restriction, including without limitation the rights
AnnaBridge 156:ff21514d8981 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
AnnaBridge 156:ff21514d8981 8 * copies of the Software, and to permit persons to whom the Software is
AnnaBridge 156:ff21514d8981 9 * furnished to do so, subject to the following conditions:
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * The above copyright notice and this permission notice shall be included in
AnnaBridge 156:ff21514d8981 12 * all copies or substantial portions of the Software.
AnnaBridge 156:ff21514d8981 13 *
AnnaBridge 156:ff21514d8981 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
AnnaBridge 156:ff21514d8981 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
AnnaBridge 156:ff21514d8981 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AnnaBridge 156:ff21514d8981 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
AnnaBridge 156:ff21514d8981 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
AnnaBridge 156:ff21514d8981 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
AnnaBridge 156:ff21514d8981 20 * SOFTWARE.
AnnaBridge 156:ff21514d8981 21 */
AnnaBridge 156:ff21514d8981 22 #ifndef MBED_FLASHIAP_H
AnnaBridge 156:ff21514d8981 23 #define MBED_FLASHIAP_H
AnnaBridge 156:ff21514d8981 24
AnnaBridge 156:ff21514d8981 25 #if defined (DEVICE_FLASH) || defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 #include "flash_api.h"
AnnaBridge 156:ff21514d8981 28 #include "platform/SingletonPtr.h"
AnnaBridge 156:ff21514d8981 29 #include "platform/PlatformMutex.h"
AnnaBridge 156:ff21514d8981 30 #include "platform/NonCopyable.h"
AnnaBridge 171:3a7713b1edbc 31 #include <algorithm>
AnnaBridge 171:3a7713b1edbc 32
AnnaBridge 171:3a7713b1edbc 33 // Export ROM end address
AnnaBridge 171:3a7713b1edbc 34 #if defined(TOOLCHAIN_GCC_ARM)
AnnaBridge 171:3a7713b1edbc 35 extern uint32_t __etext;
AnnaBridge 171:3a7713b1edbc 36 #define FLASHIAP_ROM_END ((uint32_t) &__etext)
AnnaBridge 171:3a7713b1edbc 37 #elif defined(TOOLCHAIN_ARM)
AnnaBridge 171:3a7713b1edbc 38 extern uint32_t Load$$LR$$LR_IROM1$$Limit[];
AnnaBridge 171:3a7713b1edbc 39 #define FLASHIAP_ROM_END ((uint32_t)Load$$LR$$LR_IROM1$$Limit)
AnnaBridge 171:3a7713b1edbc 40 #elif defined(TOOLCHAIN_IAR)
AnnaBridge 171:3a7713b1edbc 41 #pragma section=".rodata"
AnnaBridge 171:3a7713b1edbc 42 #pragma section=".text"
AnnaBridge 171:3a7713b1edbc 43 #define FLASHIAP_ROM_END (std::max((uint32_t) __section_end(".rodata"), (uint32_t) __section_end(".text")))
AnnaBridge 171:3a7713b1edbc 44 #endif
AnnaBridge 156:ff21514d8981 45
AnnaBridge 156:ff21514d8981 46 namespace mbed {
AnnaBridge 156:ff21514d8981 47
AnnaBridge 156:ff21514d8981 48 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 49
AnnaBridge 156:ff21514d8981 50 /** Flash IAP driver. It invokes flash HAL functions.
AnnaBridge 156:ff21514d8981 51 *
AnnaBridge 156:ff21514d8981 52 * @note Synchronization level: Thread safe
AnnaBridge 156:ff21514d8981 53 * @ingroup drivers
AnnaBridge 156:ff21514d8981 54 */
AnnaBridge 156:ff21514d8981 55 class FlashIAP : private NonCopyable<FlashIAP> {
AnnaBridge 156:ff21514d8981 56 public:
AnnaBridge 156:ff21514d8981 57 FlashIAP();
AnnaBridge 156:ff21514d8981 58 ~FlashIAP();
AnnaBridge 156:ff21514d8981 59
AnnaBridge 156:ff21514d8981 60 /** Initialize a flash IAP device
AnnaBridge 156:ff21514d8981 61 *
AnnaBridge 156:ff21514d8981 62 * Should be called once per lifetime of the object.
AnnaBridge 156:ff21514d8981 63 * @return 0 on success or a negative error code on failure
AnnaBridge 156:ff21514d8981 64 */
AnnaBridge 156:ff21514d8981 65 int init();
AnnaBridge 156:ff21514d8981 66
AnnaBridge 156:ff21514d8981 67 /** Deinitialize a flash IAP device
AnnaBridge 156:ff21514d8981 68 *
AnnaBridge 156:ff21514d8981 69 * @return 0 on success or a negative error code on failure
AnnaBridge 156:ff21514d8981 70 */
AnnaBridge 156:ff21514d8981 71 int deinit();
AnnaBridge 156:ff21514d8981 72
AnnaBridge 170:e95d10626187 73 /** Read data from a flash device.
AnnaBridge 156:ff21514d8981 74 *
AnnaBridge 156:ff21514d8981 75 * This method invokes memcpy - reads number of bytes from the address
AnnaBridge 156:ff21514d8981 76 *
AnnaBridge 156:ff21514d8981 77 * @param buffer Buffer to write to
AnnaBridge 156:ff21514d8981 78 * @param addr Flash address to begin reading from
AnnaBridge 156:ff21514d8981 79 * @param size Size to read in bytes
AnnaBridge 156:ff21514d8981 80 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 81 */
AnnaBridge 156:ff21514d8981 82 int read(void *buffer, uint32_t addr, uint32_t size);
AnnaBridge 156:ff21514d8981 83
AnnaBridge 156:ff21514d8981 84 /** Program data to pages
AnnaBridge 156:ff21514d8981 85 *
AnnaBridge 156:ff21514d8981 86 * The sectors must have been erased prior to being programmed
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 156:ff21514d8981 88 * @param buffer Buffer of data to be written
AnnaBridge 165:d1b4690b3f8b 89 * @param addr Address of a page to begin writing to
AnnaBridge 165:d1b4690b3f8b 90 * @param size Size to write in bytes, must be a multiple of program size
AnnaBridge 156:ff21514d8981 91 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 92 */
AnnaBridge 156:ff21514d8981 93 int program(const void *buffer, uint32_t addr, uint32_t size);
AnnaBridge 156:ff21514d8981 94
AnnaBridge 156:ff21514d8981 95 /** Erase sectors
AnnaBridge 156:ff21514d8981 96 *
AnnaBridge 156:ff21514d8981 97 * The state of an erased sector is undefined until it has been programmed
AnnaBridge 156:ff21514d8981 98 *
AnnaBridge 156:ff21514d8981 99 * @param addr Address of a sector to begin erasing, must be a multiple of the sector size
AnnaBridge 156:ff21514d8981 100 * @param size Size to erase in bytes, must be a multiple of the sector size
AnnaBridge 156:ff21514d8981 101 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 102 */
AnnaBridge 156:ff21514d8981 103 int erase(uint32_t addr, uint32_t size);
AnnaBridge 156:ff21514d8981 104
AnnaBridge 156:ff21514d8981 105 /** Get the sector size at the defined address
AnnaBridge 156:ff21514d8981 106 *
AnnaBridge 170:e95d10626187 107 * Sector size might differ at address ranges.
AnnaBridge 156:ff21514d8981 108 * An example <0-0x1000, sector size=1024; 0x10000-0x20000, size=2048>
AnnaBridge 156:ff21514d8981 109 *
AnnaBridge 156:ff21514d8981 110 * @param addr Address of or inside the sector to query
AnnaBridge 156:ff21514d8981 111 * @return Size of a sector in bytes or MBED_FLASH_INVALID_SIZE if not mapped
AnnaBridge 156:ff21514d8981 112 */
AnnaBridge 156:ff21514d8981 113 uint32_t get_sector_size(uint32_t addr) const;
AnnaBridge 156:ff21514d8981 114
AnnaBridge 170:e95d10626187 115 /** Get the flash start address
AnnaBridge 156:ff21514d8981 116 *
AnnaBridge 170:e95d10626187 117 * @return Flash start address
AnnaBridge 156:ff21514d8981 118 */
AnnaBridge 156:ff21514d8981 119 uint32_t get_flash_start() const;
AnnaBridge 156:ff21514d8981 120
AnnaBridge 156:ff21514d8981 121 /** Get the flash size
AnnaBridge 156:ff21514d8981 122 *
AnnaBridge 170:e95d10626187 123 * @return Flash size
AnnaBridge 156:ff21514d8981 124 */
AnnaBridge 156:ff21514d8981 125 uint32_t get_flash_size() const;
AnnaBridge 156:ff21514d8981 126
AnnaBridge 156:ff21514d8981 127 /** Get the program page size
AnnaBridge 156:ff21514d8981 128 *
AnnaBridge 156:ff21514d8981 129 * The page size defines the writable page size
AnnaBridge 156:ff21514d8981 130 * @return Size of a program page in bytes
AnnaBridge 156:ff21514d8981 131 */
AnnaBridge 156:ff21514d8981 132 uint32_t get_page_size() const;
AnnaBridge 156:ff21514d8981 133
AnnaBridge 156:ff21514d8981 134 private:
AnnaBridge 156:ff21514d8981 135
AnnaBridge 156:ff21514d8981 136 /* Check if address and size are aligned to a sector
AnnaBridge 156:ff21514d8981 137 *
AnnaBridge 156:ff21514d8981 138 * @param addr Address of block to check for alignment
AnnaBridge 156:ff21514d8981 139 * @param size Size of block to check for alignment
AnnaBridge 156:ff21514d8981 140 * @return true if the block is sector aligned, false otherwise
AnnaBridge 156:ff21514d8981 141 */
AnnaBridge 156:ff21514d8981 142 bool is_aligned_to_sector(uint32_t addr, uint32_t size);
AnnaBridge 156:ff21514d8981 143
AnnaBridge 156:ff21514d8981 144 flash_t _flash;
AnnaBridge 165:d1b4690b3f8b 145 uint8_t *_page_buf;
AnnaBridge 156:ff21514d8981 146 static SingletonPtr<PlatformMutex> _mutex;
AnnaBridge 156:ff21514d8981 147 };
AnnaBridge 156:ff21514d8981 148
AnnaBridge 156:ff21514d8981 149 } /* namespace mbed */
AnnaBridge 156:ff21514d8981 150
AnnaBridge 156:ff21514d8981 151 #endif /* DEVICE_FLASH */
AnnaBridge 156:ff21514d8981 152
AnnaBridge 156:ff21514d8981 153 #endif /* MBED_FLASHIAP_H */