Kev Mann / mbed-dev-OS5_10_4

RTC auf true

features/storage/blockdevice/ChainingBlockDevice.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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