zhang boie / mbed-dev-f30333

mbed-dev-f303

drivers/FlashIAP.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

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