Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
FlashSimBlockDevice.h
00001 /* mbed Microcontroller Library 00002 * Copyright (c) 2018 ARM Limited 00003 * 00004 * Permission is hereby granted, free of charge, to any person obtaining a copy 00005 * of this software and associated documentation files (the "Software"), to deal 00006 * in the Software without restriction, including without limitation the rights 00007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 00008 * copies of the Software, and to permit persons to whom the Software is 00009 * furnished to do so, subject to the following conditions: 00010 * 00011 * The above copyright notice and this permission notice shall be included in 00012 * all copies or substantial portions of the Software. 00013 * 00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 00015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 00016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 00017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 00018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 00019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 00020 * SOFTWARE. 00021 */ 00022 #ifndef MBED_FLASH_SIM_BLOCK_DEVICE_H 00023 #define MBED_FLASH_SIM_BLOCK_DEVICE_H 00024 00025 #include "BlockDevice.h" 00026 00027 enum { 00028 BD_ERROR_NOT_ERASED = -3201, 00029 }; 00030 00031 /** Flash simulating block device 00032 * 00033 * Flash simulation BD adaptor 00034 * 00035 */ 00036 class FlashSimBlockDevice : public BlockDevice { 00037 public: 00038 00039 /** Constructor 00040 * 00041 * @param bd Block device to back the FlashSimBlockDevice 00042 * @param erase_value Value stored in a block after it's erased 00043 */ 00044 FlashSimBlockDevice(BlockDevice *bd, uint8_t erase_value = 0xFF); 00045 virtual ~FlashSimBlockDevice(); 00046 00047 /** Initialize a block device 00048 * 00049 * @return 0 on success or a negative error code on failure 00050 */ 00051 virtual int init(); 00052 00053 /** Deinitialize the block device 00054 * 00055 * @return 0 on success or a negative error code on failure 00056 */ 00057 virtual int deinit(); 00058 00059 /** Ensure data on storage is in sync with the driver 00060 * 00061 * @return 0 on success or a negative error code on failure 00062 */ 00063 virtual int sync(); 00064 00065 /** Read blocks from the block device 00066 * 00067 * @param buffer Buffer to read blocks into 00068 * @param addr Address of block to begin reading from 00069 * @param size Size to read in bytes, must be a multiple of read block size 00070 * @return 0 on success, negative error code on failure 00071 */ 00072 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size); 00073 00074 /** Program blocks to the block device 00075 * 00076 * The blocks must have been erased prior to being programmed 00077 * 00078 * @param buffer Buffer of data to write to blocks 00079 * @param addr Address of block to begin writing to 00080 * @param size Size to write in bytes, must be a multiple of program block size 00081 * @return 0 on success, negative error code on failure 00082 */ 00083 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size); 00084 00085 /** Erase blocks on the block device 00086 * 00087 * Required before any write to these addresses 00088 * 00089 * @param addr Address of block to begin erasing 00090 * @param size Size to erase in bytes, must be a multiple of erase block size 00091 * @return 0 on success, negative error code on failure 00092 */ 00093 virtual int erase(bd_addr_t addr, bd_size_t size); 00094 00095 /** Get the size of a readable block 00096 * 00097 * @return Size of a readable block in bytes 00098 */ 00099 virtual bd_size_t get_read_size() const; 00100 00101 /** Get the size of a programmable block 00102 * 00103 * @return Size of a programmable block in bytes 00104 */ 00105 virtual bd_size_t get_program_size() const; 00106 00107 /** Get the size of an erasable block 00108 * 00109 * @return Size of an erasable block in bytes 00110 */ 00111 virtual bd_size_t get_erase_size() const; 00112 00113 /** Get the size of an erasable block given address 00114 * 00115 * @param addr Address within the erasable block 00116 * @return Size of an erasable block in bytes 00117 * @note Must be a multiple of the program size 00118 */ 00119 virtual bd_size_t get_erase_size(bd_addr_t addr) const; 00120 00121 /** Get the value of storage when erased 00122 * 00123 * @return The value of storage when erased 00124 */ 00125 virtual int get_erase_value() const; 00126 00127 /** Get the total size of the underlying device 00128 * 00129 * @return Size of the underlying device in bytes 00130 */ 00131 virtual bd_size_t size() const; 00132 00133 private: 00134 uint8_t _erase_value; 00135 bd_size_t _blank_buf_size; 00136 uint8_t *_blank_buf; 00137 BlockDevice *_bd; 00138 uint32_t _init_ref_count; 00139 bool _is_initialized; 00140 }; 00141 00142 #endif
Generated on Tue Aug 9 2022 00:37:07 by
