Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/FlashIAP.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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