Nicolas Borla / Mbed OS BBR_1Ebene

BBR 1 Ebene

mbed-os/features/filesystem/bd/ExhaustibleBlockDevice.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_EXHAUSTIBLE_BLOCK_DEVICE_H
borlanic 0:fbdae7e6d805 23 #define MBED_EXHAUSTIBLE_BLOCK_DEVICE_H
borlanic 0:fbdae7e6d805 24
borlanic 0:fbdae7e6d805 25 #include "BlockDevice.h"
borlanic 0:fbdae7e6d805 26
borlanic 0:fbdae7e6d805 27
borlanic 0:fbdae7e6d805 28 /** Heap backed block device which simulates failures
borlanic 0:fbdae7e6d805 29 *
borlanic 0:fbdae7e6d805 30 * Similar to heap block device but sectors wear out and are no longer programmable
borlanic 0:fbdae7e6d805 31 * after a configurable number of cycles.
borlanic 0:fbdae7e6d805 32 *
borlanic 0:fbdae7e6d805 33 */
borlanic 0:fbdae7e6d805 34 class ExhaustibleBlockDevice : public BlockDevice
borlanic 0:fbdae7e6d805 35 {
borlanic 0:fbdae7e6d805 36 public:
borlanic 0:fbdae7e6d805 37 /** Lifetime of the block device
borlanic 0:fbdae7e6d805 38 *
borlanic 0:fbdae7e6d805 39 * @param bd Block device to back the ExhaustibleBlockDevice
borlanic 0:fbdae7e6d805 40 * @param erase_cycles Number of erase cycles before failure
borlanic 0:fbdae7e6d805 41 */
borlanic 0:fbdae7e6d805 42 ExhaustibleBlockDevice(BlockDevice *bd, uint32_t erase_cycles);
borlanic 0:fbdae7e6d805 43 virtual ~ExhaustibleBlockDevice();
borlanic 0:fbdae7e6d805 44
borlanic 0:fbdae7e6d805 45 /**
borlanic 0:fbdae7e6d805 46 * Get the number of erase cycles remaining on a block
borlanic 0:fbdae7e6d805 47 *
borlanic 0:fbdae7e6d805 48 * @param addr Any address in the block being queried for erase cycles
borlanic 0:fbdae7e6d805 49 * @return Number of erase cycles remaining
borlanic 0:fbdae7e6d805 50 */
borlanic 0:fbdae7e6d805 51 uint32_t get_erase_cycles(bd_addr_t addr) const;
borlanic 0:fbdae7e6d805 52
borlanic 0:fbdae7e6d805 53 /**
borlanic 0:fbdae7e6d805 54 * Set the number of erase cycles before failure
borlanic 0:fbdae7e6d805 55 *
borlanic 0:fbdae7e6d805 56 * @param addr Any address in the block being queried for erase cycles
borlanic 0:fbdae7e6d805 57 * @param cycles Erase cycles before the block malfunctions
borlanic 0:fbdae7e6d805 58 */
borlanic 0:fbdae7e6d805 59 void set_erase_cycles(bd_addr_t addr, uint32_t cycles);
borlanic 0:fbdae7e6d805 60
borlanic 0:fbdae7e6d805 61 /** Initialize a block device
borlanic 0:fbdae7e6d805 62 *
borlanic 0:fbdae7e6d805 63 * @return 0 on success or a negative error code on failure
borlanic 0:fbdae7e6d805 64 */
borlanic 0:fbdae7e6d805 65 virtual int init();
borlanic 0:fbdae7e6d805 66
borlanic 0:fbdae7e6d805 67 /** Deinitialize a block device
borlanic 0:fbdae7e6d805 68 *
borlanic 0:fbdae7e6d805 69 * @return 0 on success or a negative error code on failure
borlanic 0:fbdae7e6d805 70 */
borlanic 0:fbdae7e6d805 71 virtual int deinit();
borlanic 0:fbdae7e6d805 72
borlanic 0:fbdae7e6d805 73 /** Ensure data on storage is in sync with the driver
borlanic 0:fbdae7e6d805 74 *
borlanic 0:fbdae7e6d805 75 * @return 0 on success or a negative error code on failure
borlanic 0:fbdae7e6d805 76 */
borlanic 0:fbdae7e6d805 77 virtual int sync();
borlanic 0:fbdae7e6d805 78
borlanic 0:fbdae7e6d805 79 /** Read blocks from a block device
borlanic 0:fbdae7e6d805 80 *
borlanic 0:fbdae7e6d805 81 * @param buffer Buffer to read blocks into
borlanic 0:fbdae7e6d805 82 * @param addr Address of block to begin reading from
borlanic 0:fbdae7e6d805 83 * @param size Size to read in bytes, must be a multiple of read block size
borlanic 0:fbdae7e6d805 84 * @return 0 on success, negative error code on failure
borlanic 0:fbdae7e6d805 85 */
borlanic 0:fbdae7e6d805 86 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
borlanic 0:fbdae7e6d805 87
borlanic 0:fbdae7e6d805 88 /** Program blocks to a block device
borlanic 0:fbdae7e6d805 89 *
borlanic 0:fbdae7e6d805 90 * The blocks must have been erased prior to being programmed
borlanic 0:fbdae7e6d805 91 *
borlanic 0:fbdae7e6d805 92 * @param buffer Buffer of data to write to blocks
borlanic 0:fbdae7e6d805 93 * @param addr Address of block to begin writing to
borlanic 0:fbdae7e6d805 94 * @param size Size to write in bytes, must be a multiple of program block size
borlanic 0:fbdae7e6d805 95 * @return 0 on success, negative error code on failure
borlanic 0:fbdae7e6d805 96 */
borlanic 0:fbdae7e6d805 97 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
borlanic 0:fbdae7e6d805 98
borlanic 0:fbdae7e6d805 99 /** Erase blocks on a block device
borlanic 0:fbdae7e6d805 100 *
borlanic 0:fbdae7e6d805 101 * The state of an erased block is undefined until it has been programmed,
borlanic 0:fbdae7e6d805 102 * unless get_erase_value returns a non-negative byte value
borlanic 0:fbdae7e6d805 103 *
borlanic 0:fbdae7e6d805 104 * @param addr Address of block to begin erasing
borlanic 0:fbdae7e6d805 105 * @param size Size to erase in bytes, must be a multiple of erase block size
borlanic 0:fbdae7e6d805 106 * @return 0 on success, negative error code on failure
borlanic 0:fbdae7e6d805 107 */
borlanic 0:fbdae7e6d805 108 virtual int erase(bd_addr_t addr, bd_size_t size);
borlanic 0:fbdae7e6d805 109
borlanic 0:fbdae7e6d805 110 /** Get the size of a readable block
borlanic 0:fbdae7e6d805 111 *
borlanic 0:fbdae7e6d805 112 * @return Size of a readable block in bytes
borlanic 0:fbdae7e6d805 113 */
borlanic 0:fbdae7e6d805 114 virtual bd_size_t get_read_size() const;
borlanic 0:fbdae7e6d805 115
borlanic 0:fbdae7e6d805 116 /** Get the size of a programmable block
borlanic 0:fbdae7e6d805 117 *
borlanic 0:fbdae7e6d805 118 * @return Size of a programmable block in bytes
borlanic 0:fbdae7e6d805 119 */
borlanic 0:fbdae7e6d805 120 virtual bd_size_t get_program_size() const;
borlanic 0:fbdae7e6d805 121
borlanic 0:fbdae7e6d805 122 /** Get the size of an erasable block
borlanic 0:fbdae7e6d805 123 *
borlanic 0:fbdae7e6d805 124 * @return Size of an erasable block in bytes
borlanic 0:fbdae7e6d805 125 */
borlanic 0:fbdae7e6d805 126 virtual bd_size_t get_erase_size() const;
borlanic 0:fbdae7e6d805 127
borlanic 0:fbdae7e6d805 128 /** Get the size of an erasable block given address
borlanic 0:fbdae7e6d805 129 *
borlanic 0:fbdae7e6d805 130 * @param addr Address within the erasable block
borlanic 0:fbdae7e6d805 131 * @return Size of an erasable block in bytes
borlanic 0:fbdae7e6d805 132 * @note Must be a multiple of the program size
borlanic 0:fbdae7e6d805 133 */
borlanic 0:fbdae7e6d805 134 virtual bd_size_t get_erase_size(bd_addr_t addr) const;
borlanic 0:fbdae7e6d805 135
borlanic 0:fbdae7e6d805 136 /** Get the value of storage when erased
borlanic 0:fbdae7e6d805 137 *
borlanic 0:fbdae7e6d805 138 * If get_erase_value returns a non-negative byte value, the underlying
borlanic 0:fbdae7e6d805 139 * storage is set to that value when erased, and storage containing
borlanic 0:fbdae7e6d805 140 * that value can be programmed without another erase.
borlanic 0:fbdae7e6d805 141 *
borlanic 0:fbdae7e6d805 142 * @return The value of storage when erased, or -1 if you can't
borlanic 0:fbdae7e6d805 143 * rely on the value of erased storage
borlanic 0:fbdae7e6d805 144 */
borlanic 0:fbdae7e6d805 145 virtual int get_erase_value() const;
borlanic 0:fbdae7e6d805 146
borlanic 0:fbdae7e6d805 147 /** Get the total size of the underlying device
borlanic 0:fbdae7e6d805 148 *
borlanic 0:fbdae7e6d805 149 * @return Size of the underlying device in bytes
borlanic 0:fbdae7e6d805 150 */
borlanic 0:fbdae7e6d805 151 virtual bd_size_t size() const;
borlanic 0:fbdae7e6d805 152
borlanic 0:fbdae7e6d805 153 private:
borlanic 0:fbdae7e6d805 154 BlockDevice *_bd;
borlanic 0:fbdae7e6d805 155 uint32_t *_erase_array;
borlanic 0:fbdae7e6d805 156 uint32_t _erase_cycles;
borlanic 0:fbdae7e6d805 157 };
borlanic 0:fbdae7e6d805 158
borlanic 0:fbdae7e6d805 159
borlanic 0:fbdae7e6d805 160 #endif