Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/FlashIAP.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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