Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/storage/blockdevice/SlicingBlockDevice.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* mbed Microcontroller Library
kenjiArai 0:5b88d5760320 2 * Copyright (c) 2017 ARM Limited
kenjiArai 0:5b88d5760320 3 *
kenjiArai 0:5b88d5760320 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
kenjiArai 0:5b88d5760320 5 * of this software and associated documentation files (the "Software"), to deal
kenjiArai 0:5b88d5760320 6 * in the Software without restriction, including without limitation the rights
kenjiArai 0:5b88d5760320 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
kenjiArai 0:5b88d5760320 8 * copies of the Software, and to permit persons to whom the Software is
kenjiArai 0:5b88d5760320 9 * furnished to do so, subject to the following conditions:
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * The above copyright notice and this permission notice shall be included in
kenjiArai 0:5b88d5760320 12 * all copies or substantial portions of the Software.
kenjiArai 0:5b88d5760320 13 *
kenjiArai 0:5b88d5760320 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
kenjiArai 0:5b88d5760320 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
kenjiArai 0:5b88d5760320 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
kenjiArai 0:5b88d5760320 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
kenjiArai 0:5b88d5760320 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kenjiArai 0:5b88d5760320 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
kenjiArai 0:5b88d5760320 20 * SOFTWARE.
kenjiArai 0:5b88d5760320 21 */
kenjiArai 0:5b88d5760320 22
kenjiArai 0:5b88d5760320 23 /** \addtogroup storage */
kenjiArai 0:5b88d5760320 24 /** @{*/
kenjiArai 0:5b88d5760320 25
kenjiArai 0:5b88d5760320 26 #ifndef MBED_SLICING_BLOCK_DEVICE_H
kenjiArai 0:5b88d5760320 27 #define MBED_SLICING_BLOCK_DEVICE_H
kenjiArai 0:5b88d5760320 28
kenjiArai 0:5b88d5760320 29 #include "BlockDevice.h"
kenjiArai 0:5b88d5760320 30 #include "platform/mbed_assert.h"
kenjiArai 0:5b88d5760320 31
kenjiArai 0:5b88d5760320 32 namespace mbed {
kenjiArai 0:5b88d5760320 33
kenjiArai 0:5b88d5760320 34 /** Block device for mapping to a slice of another block device
kenjiArai 0:5b88d5760320 35 */
kenjiArai 0:5b88d5760320 36 class SlicingBlockDevice : public BlockDevice {
kenjiArai 0:5b88d5760320 37 public:
kenjiArai 0:5b88d5760320 38 /** Lifetime of the memory block device
kenjiArai 0:5b88d5760320 39 *
kenjiArai 0:5b88d5760320 40 * @param bd Block device to back the SlicingBlockDevice
kenjiArai 0:5b88d5760320 41 * @param start Start block address to map to block 0, negative addresses
kenjiArai 0:5b88d5760320 42 * are calculated from the end of the underlying block device
kenjiArai 0:5b88d5760320 43 * @param end End block address to mark the end of the block device,
kenjiArai 0:5b88d5760320 44 * this block is not mapped, negative addresses are
kenjiArai 0:5b88d5760320 45 * calculated from the end of the underlying block device.
kenjiArai 0:5b88d5760320 46 * The default stops at end of the underlying block device.
kenjiArai 0:5b88d5760320 47 */
kenjiArai 0:5b88d5760320 48 SlicingBlockDevice(BlockDevice *bd, bd_addr_t start, bd_addr_t end = 0);
kenjiArai 0:5b88d5760320 49
kenjiArai 0:5b88d5760320 50 /** Lifetime of a block device
kenjiArai 0:5b88d5760320 51 */
kenjiArai 0:5b88d5760320 52 virtual ~SlicingBlockDevice() {};
kenjiArai 0:5b88d5760320 53
kenjiArai 0:5b88d5760320 54 /** Initialize a block device
kenjiArai 0:5b88d5760320 55 *
kenjiArai 0:5b88d5760320 56 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 57 */
kenjiArai 0:5b88d5760320 58 virtual int init();
kenjiArai 0:5b88d5760320 59
kenjiArai 0:5b88d5760320 60 /** Deinitialize a block device
kenjiArai 0:5b88d5760320 61 *
kenjiArai 0:5b88d5760320 62 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 63 */
kenjiArai 0:5b88d5760320 64 virtual int deinit();
kenjiArai 0:5b88d5760320 65
kenjiArai 0:5b88d5760320 66 /** Ensure data on storage is in sync with the driver
kenjiArai 0:5b88d5760320 67 *
kenjiArai 0:5b88d5760320 68 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 69 */
kenjiArai 0:5b88d5760320 70 virtual int sync();
kenjiArai 0:5b88d5760320 71
kenjiArai 0:5b88d5760320 72 /** Read blocks from a block device
kenjiArai 0:5b88d5760320 73 *
kenjiArai 0:5b88d5760320 74 * @param buffer Buffer to read blocks into
kenjiArai 0:5b88d5760320 75 * @param addr Address of block to begin reading from
kenjiArai 0:5b88d5760320 76 * @param size Size to read in bytes, must be a multiple of read block size
kenjiArai 0:5b88d5760320 77 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 78 */
kenjiArai 0:5b88d5760320 79 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
kenjiArai 0:5b88d5760320 80
kenjiArai 0:5b88d5760320 81 /** Program blocks to a block device
kenjiArai 0:5b88d5760320 82 *
kenjiArai 0:5b88d5760320 83 * The blocks must have been erased prior to being programmed
kenjiArai 0:5b88d5760320 84 *
kenjiArai 0:5b88d5760320 85 * @param buffer Buffer of data to write to blocks
kenjiArai 0:5b88d5760320 86 * @param addr Address of block to begin writing to
kenjiArai 0:5b88d5760320 87 * @param size Size to write in bytes, must be a multiple of program block size
kenjiArai 0:5b88d5760320 88 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 89 */
kenjiArai 0:5b88d5760320 90 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
kenjiArai 0:5b88d5760320 91
kenjiArai 0:5b88d5760320 92 /** Erase blocks on a block device
kenjiArai 0:5b88d5760320 93 *
kenjiArai 0:5b88d5760320 94 * The state of an erased block is undefined until it has been programmed,
kenjiArai 0:5b88d5760320 95 * unless get_erase_value returns a non-negative byte value
kenjiArai 0:5b88d5760320 96 *
kenjiArai 0:5b88d5760320 97 * @param addr Address of block to begin erasing
kenjiArai 0:5b88d5760320 98 * @param size Size to erase in bytes, must be a multiple of erase block size
kenjiArai 0:5b88d5760320 99 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 100 */
kenjiArai 0:5b88d5760320 101 virtual int erase(bd_addr_t addr, bd_size_t size);
kenjiArai 0:5b88d5760320 102
kenjiArai 0:5b88d5760320 103 /** Get the size of a readable block
kenjiArai 0:5b88d5760320 104 *
kenjiArai 0:5b88d5760320 105 * @return Size of a readable block in bytes
kenjiArai 0:5b88d5760320 106 */
kenjiArai 0:5b88d5760320 107 virtual bd_size_t get_read_size() const;
kenjiArai 0:5b88d5760320 108
kenjiArai 0:5b88d5760320 109 /** Get the size of a programmable block
kenjiArai 0:5b88d5760320 110 *
kenjiArai 0:5b88d5760320 111 * @return Size of a programmable block in bytes
kenjiArai 0:5b88d5760320 112 * @note Must be a multiple of the read size
kenjiArai 0:5b88d5760320 113 */
kenjiArai 0:5b88d5760320 114 virtual bd_size_t get_program_size() const;
kenjiArai 0:5b88d5760320 115
kenjiArai 0:5b88d5760320 116 /** Get the size of an erasable block
kenjiArai 0:5b88d5760320 117 *
kenjiArai 0:5b88d5760320 118 * @return Size of an erasable block in bytes
kenjiArai 0:5b88d5760320 119 * @note Must be a multiple of the program size
kenjiArai 0:5b88d5760320 120 */
kenjiArai 0:5b88d5760320 121 virtual bd_size_t get_erase_size() const;
kenjiArai 0:5b88d5760320 122
kenjiArai 0:5b88d5760320 123 /** Get the size of an erasable block given address
kenjiArai 0:5b88d5760320 124 *
kenjiArai 0:5b88d5760320 125 * @param addr Address within the erasable block
kenjiArai 0:5b88d5760320 126 * @return Size of an erasable block in bytes
kenjiArai 0:5b88d5760320 127 * @note Must be a multiple of the program size
kenjiArai 0:5b88d5760320 128 */
kenjiArai 0:5b88d5760320 129 virtual bd_size_t get_erase_size(bd_addr_t addr) const;
kenjiArai 0:5b88d5760320 130
kenjiArai 0:5b88d5760320 131 /** Get the value of storage when erased
kenjiArai 0:5b88d5760320 132 *
kenjiArai 0:5b88d5760320 133 * If get_erase_value returns a non-negative byte value, the underlying
kenjiArai 0:5b88d5760320 134 * storage is set to that value when erased, and storage containing
kenjiArai 0:5b88d5760320 135 * that value can be programmed without another erase.
kenjiArai 0:5b88d5760320 136 *
kenjiArai 0:5b88d5760320 137 * @return The value of storage when erased, or -1 if you can't
kenjiArai 0:5b88d5760320 138 * rely on the value of erased storage
kenjiArai 0:5b88d5760320 139 */
kenjiArai 0:5b88d5760320 140 virtual int get_erase_value() const;
kenjiArai 0:5b88d5760320 141
kenjiArai 0:5b88d5760320 142 /** Get the total size of the underlying device
kenjiArai 0:5b88d5760320 143 *
kenjiArai 0:5b88d5760320 144 * @return Size of the underlying device in bytes
kenjiArai 0:5b88d5760320 145 */
kenjiArai 0:5b88d5760320 146 virtual bd_size_t size() const;
kenjiArai 0:5b88d5760320 147
kenjiArai 0:5b88d5760320 148 /** Get the BlockDevice class type.
kenjiArai 0:5b88d5760320 149 *
kenjiArai 0:5b88d5760320 150 * @return A string represent the BlockDevice class type.
kenjiArai 0:5b88d5760320 151 */
kenjiArai 0:5b88d5760320 152 virtual const char *get_type() const;
kenjiArai 0:5b88d5760320 153
kenjiArai 0:5b88d5760320 154 /** Convenience function for checking block program validity
kenjiArai 0:5b88d5760320 155 *
kenjiArai 0:5b88d5760320 156 * @param addr Address of block to begin writing to
kenjiArai 0:5b88d5760320 157 * @param size Size to write in bytes
kenjiArai 0:5b88d5760320 158 * @return True if program is valid for underlying block device
kenjiArai 0:5b88d5760320 159 */
kenjiArai 0:5b88d5760320 160 virtual bool is_valid_program(bd_addr_t addr, bd_size_t size) const;
kenjiArai 0:5b88d5760320 161
kenjiArai 0:5b88d5760320 162 /** Convenience function for checking block read validity
kenjiArai 0:5b88d5760320 163 *
kenjiArai 0:5b88d5760320 164 * @param addr Address of block to begin reading from
kenjiArai 0:5b88d5760320 165 * @param size Size to read in bytes
kenjiArai 0:5b88d5760320 166 * @return True if read is valid for underlying block device
kenjiArai 0:5b88d5760320 167 */
kenjiArai 0:5b88d5760320 168 virtual bool is_valid_read(bd_addr_t addr, bd_size_t size) const;
kenjiArai 0:5b88d5760320 169
kenjiArai 0:5b88d5760320 170 /** Convenience function for checking block erase validity
kenjiArai 0:5b88d5760320 171 *
kenjiArai 0:5b88d5760320 172 * @param addr Address of block to begin erasing
kenjiArai 0:5b88d5760320 173 * @param size Size to erase in bytes
kenjiArai 0:5b88d5760320 174 * @return True if erase is valid for underlying block device
kenjiArai 0:5b88d5760320 175 */
kenjiArai 0:5b88d5760320 176 virtual bool is_valid_erase(bd_addr_t addr, bd_size_t size) const;
kenjiArai 0:5b88d5760320 177
kenjiArai 0:5b88d5760320 178
kenjiArai 0:5b88d5760320 179 protected:
kenjiArai 0:5b88d5760320 180 BlockDevice *_bd;
kenjiArai 0:5b88d5760320 181 bool _start_from_end;
kenjiArai 0:5b88d5760320 182 bd_size_t _start;
kenjiArai 0:5b88d5760320 183 bool _stop_from_end;
kenjiArai 0:5b88d5760320 184 bd_size_t _stop;
kenjiArai 0:5b88d5760320 185 };
kenjiArai 0:5b88d5760320 186
kenjiArai 0:5b88d5760320 187 } // namespace mbed
kenjiArai 0:5b88d5760320 188
kenjiArai 0:5b88d5760320 189 // Added "using" for backwards compatibility
kenjiArai 0:5b88d5760320 190 #ifndef MBED_NO_GLOBAL_USING_DIRECTIVE
kenjiArai 0:5b88d5760320 191 using mbed::SlicingBlockDevice;
kenjiArai 0:5b88d5760320 192 #endif
kenjiArai 0:5b88d5760320 193
kenjiArai 0:5b88d5760320 194 #endif
kenjiArai 0:5b88d5760320 195
kenjiArai 0:5b88d5760320 196 /** @}*/