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@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
165:d1b4690b3f8b
Child:
170:e95d10626187
mbed library. Release version 162

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 156:ff21514d8981 31
AnnaBridge 156:ff21514d8981 32 namespace mbed {
AnnaBridge 156:ff21514d8981 33
AnnaBridge 156:ff21514d8981 34 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 35
AnnaBridge 156:ff21514d8981 36 /** Flash IAP driver. It invokes flash HAL functions.
AnnaBridge 156:ff21514d8981 37 *
AnnaBridge 156:ff21514d8981 38 * @note Synchronization level: Thread safe
AnnaBridge 156:ff21514d8981 39 * @ingroup drivers
AnnaBridge 156:ff21514d8981 40 */
AnnaBridge 156:ff21514d8981 41 class FlashIAP : private NonCopyable<FlashIAP> {
AnnaBridge 156:ff21514d8981 42 public:
AnnaBridge 156:ff21514d8981 43 FlashIAP();
AnnaBridge 156:ff21514d8981 44 ~FlashIAP();
AnnaBridge 156:ff21514d8981 45
AnnaBridge 156:ff21514d8981 46 /** Initialize a flash IAP device
AnnaBridge 156:ff21514d8981 47 *
AnnaBridge 156:ff21514d8981 48 * Should be called once per lifetime of the object.
AnnaBridge 156:ff21514d8981 49 * @return 0 on success or a negative error code on failure
AnnaBridge 156:ff21514d8981 50 */
AnnaBridge 156:ff21514d8981 51 int init();
AnnaBridge 156:ff21514d8981 52
AnnaBridge 156:ff21514d8981 53 /** Deinitialize a flash IAP device
AnnaBridge 156:ff21514d8981 54 *
AnnaBridge 156:ff21514d8981 55 * @return 0 on success or a negative error code on failure
AnnaBridge 156:ff21514d8981 56 */
AnnaBridge 156:ff21514d8981 57 int deinit();
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59 /** Read data from a flash device.
AnnaBridge 156:ff21514d8981 60 *
AnnaBridge 156:ff21514d8981 61 * This method invokes memcpy - reads number of bytes from the address
AnnaBridge 156:ff21514d8981 62 *
AnnaBridge 156:ff21514d8981 63 * @param buffer Buffer to write to
AnnaBridge 156:ff21514d8981 64 * @param addr Flash address to begin reading from
AnnaBridge 156:ff21514d8981 65 * @param size Size to read in bytes
AnnaBridge 156:ff21514d8981 66 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 67 */
AnnaBridge 156:ff21514d8981 68 int read(void *buffer, uint32_t addr, uint32_t size);
AnnaBridge 156:ff21514d8981 69
AnnaBridge 156:ff21514d8981 70 /** Program data to pages
AnnaBridge 156:ff21514d8981 71 *
AnnaBridge 156:ff21514d8981 72 * The sectors must have been erased prior to being programmed
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 * @param buffer Buffer of data to be written
AnnaBridge 165:d1b4690b3f8b 75 * @param addr Address of a page to begin writing to
AnnaBridge 165:d1b4690b3f8b 76 * @param size Size to write in bytes, must be a multiple of program size
AnnaBridge 156:ff21514d8981 77 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 78 */
AnnaBridge 156:ff21514d8981 79 int program(const void *buffer, uint32_t addr, uint32_t size);
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 /** Erase sectors
AnnaBridge 156:ff21514d8981 82 *
AnnaBridge 156:ff21514d8981 83 * The state of an erased sector is undefined until it has been programmed
AnnaBridge 156:ff21514d8981 84 *
AnnaBridge 156:ff21514d8981 85 * @param addr Address of a sector to begin erasing, must be a multiple of the sector size
AnnaBridge 156:ff21514d8981 86 * @param size Size to erase in bytes, must be a multiple of the sector size
AnnaBridge 156:ff21514d8981 87 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 88 */
AnnaBridge 156:ff21514d8981 89 int erase(uint32_t addr, uint32_t size);
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 /** Get the sector size at the defined address
AnnaBridge 156:ff21514d8981 92 *
AnnaBridge 156:ff21514d8981 93 * Sector size might differ at address ranges.
AnnaBridge 156:ff21514d8981 94 * An example <0-0x1000, sector size=1024; 0x10000-0x20000, size=2048>
AnnaBridge 156:ff21514d8981 95 *
AnnaBridge 156:ff21514d8981 96 * @param addr Address of or inside the sector to query
AnnaBridge 156:ff21514d8981 97 * @return Size of a sector in bytes or MBED_FLASH_INVALID_SIZE if not mapped
AnnaBridge 156:ff21514d8981 98 */
AnnaBridge 156:ff21514d8981 99 uint32_t get_sector_size(uint32_t addr) const;
AnnaBridge 156:ff21514d8981 100
AnnaBridge 156:ff21514d8981 101 /** Get the flash start address
AnnaBridge 156:ff21514d8981 102 *
AnnaBridge 156:ff21514d8981 103 * @return Flash start address
AnnaBridge 156:ff21514d8981 104 */
AnnaBridge 156:ff21514d8981 105 uint32_t get_flash_start() const;
AnnaBridge 156:ff21514d8981 106
AnnaBridge 156:ff21514d8981 107 /** Get the flash size
AnnaBridge 156:ff21514d8981 108 *
AnnaBridge 156:ff21514d8981 109 * @return Flash size
AnnaBridge 156:ff21514d8981 110 */
AnnaBridge 156:ff21514d8981 111 uint32_t get_flash_size() const;
AnnaBridge 156:ff21514d8981 112
AnnaBridge 156:ff21514d8981 113 /** Get the program page size
AnnaBridge 156:ff21514d8981 114 *
AnnaBridge 156:ff21514d8981 115 * The page size defines the writable page size
AnnaBridge 156:ff21514d8981 116 * @return Size of a program page in bytes
AnnaBridge 156:ff21514d8981 117 */
AnnaBridge 156:ff21514d8981 118 uint32_t get_page_size() const;
AnnaBridge 156:ff21514d8981 119
AnnaBridge 156:ff21514d8981 120 private:
AnnaBridge 156:ff21514d8981 121
AnnaBridge 156:ff21514d8981 122 /* Check if address and size are aligned to a sector
AnnaBridge 156:ff21514d8981 123 *
AnnaBridge 156:ff21514d8981 124 * @param addr Address of block to check for alignment
AnnaBridge 156:ff21514d8981 125 * @param size Size of block to check for alignment
AnnaBridge 156:ff21514d8981 126 * @return true if the block is sector aligned, false otherwise
AnnaBridge 156:ff21514d8981 127 */
AnnaBridge 156:ff21514d8981 128 bool is_aligned_to_sector(uint32_t addr, uint32_t size);
AnnaBridge 156:ff21514d8981 129
AnnaBridge 156:ff21514d8981 130 flash_t _flash;
AnnaBridge 165:d1b4690b3f8b 131 uint8_t *_page_buf;
AnnaBridge 156:ff21514d8981 132 static SingletonPtr<PlatformMutex> _mutex;
AnnaBridge 156:ff21514d8981 133 };
AnnaBridge 156:ff21514d8981 134
AnnaBridge 156:ff21514d8981 135 } /* namespace mbed */
AnnaBridge 156:ff21514d8981 136
AnnaBridge 156:ff21514d8981 137 #endif /* DEVICE_FLASH */
AnnaBridge 156:ff21514d8981 138
AnnaBridge 156:ff21514d8981 139 #endif /* MBED_FLASHIAP_H */