EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

drivers/FlashIAP.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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