Nicolas Borla / Mbed OS BBR_1Ebene

BBR 1 Ebene

mbed-os/features/filesystem/bd/ChainingBlockDevice.h@0:fbdae7e6d805, 2018-05-14 (annotated)

Committer:
borlanic
Date:
Mon May 14 11:29:06 2018 +0000
Revision:
0:fbdae7e6d805
BBR

Who changed what in which revision?

UserRevisionLine numberNew contents of line
borlanic 0:fbdae7e6d805 1 /* mbed Microcontroller Library
borlanic 0:fbdae7e6d805 2 * Copyright (c) 2017 ARM Limited
borlanic 0:fbdae7e6d805 3 *
borlanic 0:fbdae7e6d805 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
borlanic 0:fbdae7e6d805 5 * of this software and associated documentation files (the "Software"), to deal
borlanic 0:fbdae7e6d805 6 * in the Software without restriction, including without limitation the rights
borlanic 0:fbdae7e6d805 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
borlanic 0:fbdae7e6d805 8 * copies of the Software, and to permit persons to whom the Software is
borlanic 0:fbdae7e6d805 9 * furnished to do so, subject to the following conditions:
borlanic 0:fbdae7e6d805 10 *
borlanic 0:fbdae7e6d805 11 * The above copyright notice and this permission notice shall be included in
borlanic 0:fbdae7e6d805 12 * all copies or substantial portions of the Software.
borlanic 0:fbdae7e6d805 13 *
borlanic 0:fbdae7e6d805 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
borlanic 0:fbdae7e6d805 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
borlanic 0:fbdae7e6d805 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
borlanic 0:fbdae7e6d805 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
borlanic 0:fbdae7e6d805 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
borlanic 0:fbdae7e6d805 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
borlanic 0:fbdae7e6d805 20 * SOFTWARE.
borlanic 0:fbdae7e6d805 21 */
borlanic 0:fbdae7e6d805 22 #ifndef MBED_CHAINING_BLOCK_DEVICE_H
borlanic 0:fbdae7e6d805 23 #define MBED_CHAINING_BLOCK_DEVICE_H
borlanic 0:fbdae7e6d805 24
borlanic 0:fbdae7e6d805 25 #include "BlockDevice.h"
borlanic 0:fbdae7e6d805 26 #include "mbed.h"
borlanic 0:fbdae7e6d805 27
borlanic 0:fbdae7e6d805 28
borlanic 0:fbdae7e6d805 29 /** Block device for chaining multiple block devices
borlanic 0:fbdae7e6d805 30 * with the similar block sizes at sequential addresses
borlanic 0:fbdae7e6d805 31 *
borlanic 0:fbdae7e6d805 32 * @code
borlanic 0:fbdae7e6d805 33 * #include "mbed.h"
borlanic 0:fbdae7e6d805 34 * #include "HeapBlockDevice.h"
borlanic 0:fbdae7e6d805 35 * #include "ChainingBlockDevice.h"
borlanic 0:fbdae7e6d805 36 *
borlanic 0:fbdae7e6d805 37 * // Create two smaller block devices with
borlanic 0:fbdae7e6d805 38 * // 64 and 32 blocks of size 512 bytes
borlanic 0:fbdae7e6d805 39 * HeapBlockDevice mem1(64*512, 512);
borlanic 0:fbdae7e6d805 40 * HeapBlockDevice mem2(32*512, 512);
borlanic 0:fbdae7e6d805 41 *
borlanic 0:fbdae7e6d805 42 * // Create a block device backed by mem1 and mem2
borlanic 0:fbdae7e6d805 43 * // contains 96 blocks of size 512 bytes
borlanic 0:fbdae7e6d805 44 * BlockDevice *bds[] = {&mem1, &mem2};
borlanic 0:fbdae7e6d805 45 * ChainingBlockDevice chainmem(bds);
borlanic 0:fbdae7e6d805 46 * @endcode
borlanic 0:fbdae7e6d805 47 */
borlanic 0:fbdae7e6d805 48 class ChainingBlockDevice : public BlockDevice
borlanic 0:fbdae7e6d805 49 {
borlanic 0:fbdae7e6d805 50 public:
borlanic 0:fbdae7e6d805 51 /** Lifetime of the memory block device
borlanic 0:fbdae7e6d805 52 *
borlanic 0:fbdae7e6d805 53 * @param bds Array of block devices to chain with sequential block addresses
borlanic 0:fbdae7e6d805 54 * @param bd_count Number of block devices to chain
borlanic 0:fbdae7e6d805 55 * @note All block devices must have the same block size
borlanic 0:fbdae7e6d805 56 */
borlanic 0:fbdae7e6d805 57 ChainingBlockDevice(BlockDevice **bds, size_t bd_count);
borlanic 0:fbdae7e6d805 58
borlanic 0:fbdae7e6d805 59 /** Lifetime of the memory block device
borlanic 0:fbdae7e6d805 60 *
borlanic 0:fbdae7e6d805 61 * @param bds Array of block devices to chain with sequential block addresses
borlanic 0:fbdae7e6d805 62 * @note All block devices must have the same block size
borlanic 0:fbdae7e6d805 63 */
borlanic 0:fbdae7e6d805 64 template <size_t Size>
borlanic 0:fbdae7e6d805 65 ChainingBlockDevice(BlockDevice *(&bds)[Size])
borlanic 0:fbdae7e6d805 66 : _bds(bds), _bd_count(sizeof(bds) / sizeof(bds[0]))
borlanic 0:fbdae7e6d805 67 , _read_size(0), _program_size(0), _erase_size(0), _size(0)
borlanic 0:fbdae7e6d805 68 {
borlanic 0:fbdae7e6d805 69 }
borlanic 0:fbdae7e6d805 70
borlanic 0:fbdae7e6d805 71 /** Lifetime of the memory block device
borlanic 0:fbdae7e6d805 72 *
borlanic 0:fbdae7e6d805 73 */
borlanic 0:fbdae7e6d805 74 virtual ~ChainingBlockDevice() {}
borlanic 0:fbdae7e6d805 75
borlanic 0:fbdae7e6d805 76 /** Initialize a block device
borlanic 0:fbdae7e6d805 77 *
borlanic 0:fbdae7e6d805 78 * @return 0 on success or a negative error code on failure
borlanic 0:fbdae7e6d805 79 */
borlanic 0:fbdae7e6d805 80 virtual int init();
borlanic 0:fbdae7e6d805 81
borlanic 0:fbdae7e6d805 82 /** Deinitialize a block device
borlanic 0:fbdae7e6d805 83 *
borlanic 0:fbdae7e6d805 84 * @return 0 on success or a negative error code on failure
borlanic 0:fbdae7e6d805 85 */
borlanic 0:fbdae7e6d805 86 virtual int deinit();
borlanic 0:fbdae7e6d805 87
borlanic 0:fbdae7e6d805 88 /** Ensure data on storage is in sync with the driver
borlanic 0:fbdae7e6d805 89 *
borlanic 0:fbdae7e6d805 90 * @return 0 on success or a negative error code on failure
borlanic 0:fbdae7e6d805 91 */
borlanic 0:fbdae7e6d805 92 virtual int sync();
borlanic 0:fbdae7e6d805 93
borlanic 0:fbdae7e6d805 94 /** Read blocks from a block device
borlanic 0:fbdae7e6d805 95 *
borlanic 0:fbdae7e6d805 96 * @param buffer Buffer to write blocks to
borlanic 0:fbdae7e6d805 97 * @param addr Address of block to begin reading from
borlanic 0:fbdae7e6d805 98 * @param size Size to read in bytes, must be a multiple of read block size
borlanic 0:fbdae7e6d805 99 * @return 0 on success, negative error code on failure
borlanic 0:fbdae7e6d805 100 */
borlanic 0:fbdae7e6d805 101 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
borlanic 0:fbdae7e6d805 102
borlanic 0:fbdae7e6d805 103 /** Program blocks to a block device
borlanic 0:fbdae7e6d805 104 *
borlanic 0:fbdae7e6d805 105 * The blocks must have been erased prior to being programmed
borlanic 0:fbdae7e6d805 106 *
borlanic 0:fbdae7e6d805 107 * @param buffer Buffer of data to write to blocks
borlanic 0:fbdae7e6d805 108 * @param addr Address of block to begin writing to
borlanic 0:fbdae7e6d805 109 * @param size Size to write in bytes, must be a multiple of program block size
borlanic 0:fbdae7e6d805 110 * @return 0 on success, negative error code on failure
borlanic 0:fbdae7e6d805 111 */
borlanic 0:fbdae7e6d805 112 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
borlanic 0:fbdae7e6d805 113
borlanic 0:fbdae7e6d805 114 /** Erase blocks on a block device
borlanic 0:fbdae7e6d805 115 *
borlanic 0:fbdae7e6d805 116 * The state of an erased block is undefined until it has been programmed,
borlanic 0:fbdae7e6d805 117 * unless get_erase_value returns a non-negative byte value
borlanic 0:fbdae7e6d805 118 *
borlanic 0:fbdae7e6d805 119 * @param addr Address of block to begin erasing
borlanic 0:fbdae7e6d805 120 * @param size Size to erase in bytes, must be a multiple of erase block size
borlanic 0:fbdae7e6d805 121 * @return 0 on success, negative error code on failure
borlanic 0:fbdae7e6d805 122 */
borlanic 0:fbdae7e6d805 123 virtual int erase(bd_addr_t addr, bd_size_t size);
borlanic 0:fbdae7e6d805 124
borlanic 0:fbdae7e6d805 125 /** Get the size of a readable block
borlanic 0:fbdae7e6d805 126 *
borlanic 0:fbdae7e6d805 127 * @return Size of a readable block in bytes
borlanic 0:fbdae7e6d805 128 */
borlanic 0:fbdae7e6d805 129 virtual bd_size_t get_read_size() const;
borlanic 0:fbdae7e6d805 130
borlanic 0:fbdae7e6d805 131 /** Get the size of a programmable block
borlanic 0:fbdae7e6d805 132 *
borlanic 0:fbdae7e6d805 133 * @return Size of a programmable block in bytes
borlanic 0:fbdae7e6d805 134 * @note Must be a multiple of the read size
borlanic 0:fbdae7e6d805 135 */
borlanic 0:fbdae7e6d805 136 virtual bd_size_t get_program_size() const;
borlanic 0:fbdae7e6d805 137
borlanic 0:fbdae7e6d805 138 /** Get the size of an eraseable block
borlanic 0:fbdae7e6d805 139 *
borlanic 0:fbdae7e6d805 140 * @return Size of an erasable block in bytes
borlanic 0:fbdae7e6d805 141 * @note Must be a multiple of the program size
borlanic 0:fbdae7e6d805 142 */
borlanic 0:fbdae7e6d805 143 virtual bd_size_t get_erase_size() const;
borlanic 0:fbdae7e6d805 144
borlanic 0:fbdae7e6d805 145 /** Get the size of an erasable block given address
borlanic 0:fbdae7e6d805 146 *
borlanic 0:fbdae7e6d805 147 * @param addr Address within the erasable block
borlanic 0:fbdae7e6d805 148 * @return Size of an erasable block in bytes
borlanic 0:fbdae7e6d805 149 * @note Must be a multiple of the program size
borlanic 0:fbdae7e6d805 150 */
borlanic 0:fbdae7e6d805 151 virtual bd_size_t get_erase_size(bd_addr_t addr) const;
borlanic 0:fbdae7e6d805 152
borlanic 0:fbdae7e6d805 153 /** Get the value of storage when erased
borlanic 0:fbdae7e6d805 154 *
borlanic 0:fbdae7e6d805 155 * If get_erase_value returns a non-negative byte value, the underlying
borlanic 0:fbdae7e6d805 156 * storage is set to that value when erased, and storage containing
borlanic 0:fbdae7e6d805 157 * that value can be programmed without another erase.
borlanic 0:fbdae7e6d805 158 *
borlanic 0:fbdae7e6d805 159 * @return The value of storage when erased, or -1 if you can't
borlanic 0:fbdae7e6d805 160 * rely on the value of erased storage
borlanic 0:fbdae7e6d805 161 */
borlanic 0:fbdae7e6d805 162 virtual int get_erase_value() const;
borlanic 0:fbdae7e6d805 163
borlanic 0:fbdae7e6d805 164 /** Get the total size of the underlying device
borlanic 0:fbdae7e6d805 165 *
borlanic 0:fbdae7e6d805 166 * @return Size of the underlying device in bytes
borlanic 0:fbdae7e6d805 167 */
borlanic 0:fbdae7e6d805 168 virtual bd_size_t size() const;
borlanic 0:fbdae7e6d805 169
borlanic 0:fbdae7e6d805 170 protected:
borlanic 0:fbdae7e6d805 171 BlockDevice **_bds;
borlanic 0:fbdae7e6d805 172 size_t _bd_count;
borlanic 0:fbdae7e6d805 173 bd_size_t _read_size;
borlanic 0:fbdae7e6d805 174 bd_size_t _program_size;
borlanic 0:fbdae7e6d805 175 bd_size_t _erase_size;
borlanic 0:fbdae7e6d805 176 bd_size_t _size;
borlanic 0:fbdae7e6d805 177 int _erase_value;
borlanic 0:fbdae7e6d805 178 };
borlanic 0:fbdae7e6d805 179
borlanic 0:fbdae7e6d805 180
borlanic 0:fbdae7e6d805 181 #endif