Kev Mann / mbed-dev-OS5_10_4

RTC auf true

features/storage/blockdevice/ProfilingBlockDevice.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

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_PROFILING_BLOCK_DEVICE_H
kevman 0:38ceb79fef03 23 #define MBED_PROFILING_BLOCK_DEVICE_H
kevman 0:38ceb79fef03 24
kevman 0:38ceb79fef03 25 #include "BlockDevice.h"
kevman 0:38ceb79fef03 26
kevman 0:38ceb79fef03 27
kevman 0:38ceb79fef03 28 /** Block device for measuring storage operations of another block device
kevman 0:38ceb79fef03 29 *
kevman 0:38ceb79fef03 30 * @code
kevman 0:38ceb79fef03 31 * #include "mbed.h"
kevman 0:38ceb79fef03 32 * #include "HeapBlockDevice.h"
kevman 0:38ceb79fef03 33 * #include "ProfilingBlockDevice.h"
kevman 0:38ceb79fef03 34 *
kevman 0:38ceb79fef03 35 * // Create a heap block device and profiling block device
kevman 0:38ceb79fef03 36 * HeapBlockDevice mem(64*512, 512);
kevman 0:38ceb79fef03 37 * ProfilingBlockDevice profiler(&mem);
kevman 0:38ceb79fef03 38 *
kevman 0:38ceb79fef03 39 * // do block device work....
kevman 0:38ceb79fef03 40 *
kevman 0:38ceb79fef03 41 * printf("read count: %lld\n", profiler.get_read_count());
kevman 0:38ceb79fef03 42 * printf("program count: %lld\n", profiler.get_program_count());
kevman 0:38ceb79fef03 43 * printf("erase count: %lld\n", profiler.get_erase_count());
kevman 0:38ceb79fef03 44 * @endcode
kevman 0:38ceb79fef03 45 */
kevman 0:38ceb79fef03 46 class ProfilingBlockDevice : public BlockDevice
kevman 0:38ceb79fef03 47 {
kevman 0:38ceb79fef03 48 public:
kevman 0:38ceb79fef03 49 /** Lifetime of the memory block device
kevman 0:38ceb79fef03 50 *
kevman 0:38ceb79fef03 51 * @param bd Block device to back the ProfilingBlockDevice
kevman 0:38ceb79fef03 52 */
kevman 0:38ceb79fef03 53 ProfilingBlockDevice(BlockDevice *bd);
kevman 0:38ceb79fef03 54
kevman 0:38ceb79fef03 55 /** Lifetime of a block device
kevman 0:38ceb79fef03 56 */
kevman 0:38ceb79fef03 57 virtual ~ProfilingBlockDevice() {};
kevman 0:38ceb79fef03 58
kevman 0:38ceb79fef03 59 /** Initialize a block device
kevman 0:38ceb79fef03 60 *
kevman 0:38ceb79fef03 61 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 62 * @note The init and deinit functions do not effect profile counts
kevman 0:38ceb79fef03 63 */
kevman 0:38ceb79fef03 64 virtual int init();
kevman 0:38ceb79fef03 65
kevman 0:38ceb79fef03 66 /** Deinitialize a block device
kevman 0:38ceb79fef03 67 *
kevman 0:38ceb79fef03 68 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 69 * @note The init and deinit functions do not effect profile counts
kevman 0:38ceb79fef03 70 */
kevman 0:38ceb79fef03 71 virtual int deinit();
kevman 0:38ceb79fef03 72
kevman 0:38ceb79fef03 73 /** Ensure data on storage is in sync with the driver
kevman 0:38ceb79fef03 74 *
kevman 0:38ceb79fef03 75 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 76 */
kevman 0:38ceb79fef03 77 virtual int sync();
kevman 0:38ceb79fef03 78
kevman 0:38ceb79fef03 79 /** Read blocks from a block device
kevman 0:38ceb79fef03 80 *
kevman 0:38ceb79fef03 81 * @param buffer Buffer to read blocks into
kevman 0:38ceb79fef03 82 * @param addr Address of block to begin reading from
kevman 0:38ceb79fef03 83 * @param size Size to read in bytes, must be a multiple of read block size
kevman 0:38ceb79fef03 84 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 85 */
kevman 0:38ceb79fef03 86 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 87
kevman 0:38ceb79fef03 88 /** Program blocks to a block device
kevman 0:38ceb79fef03 89 *
kevman 0:38ceb79fef03 90 * The blocks must have been erased prior to being programmed
kevman 0:38ceb79fef03 91 *
kevman 0:38ceb79fef03 92 * @param buffer Buffer of data to write to blocks
kevman 0:38ceb79fef03 93 * @param addr Address of block to begin writing to
kevman 0:38ceb79fef03 94 * @param size Size to write in bytes, must be a multiple of program block size
kevman 0:38ceb79fef03 95 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 96 */
kevman 0:38ceb79fef03 97 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 98
kevman 0:38ceb79fef03 99 /** Erase blocks on a block device
kevman 0:38ceb79fef03 100 *
kevman 0:38ceb79fef03 101 * The state of an erased block is undefined until it has been programmed,
kevman 0:38ceb79fef03 102 * unless get_erase_value returns a non-negative byte value
kevman 0:38ceb79fef03 103 *
kevman 0:38ceb79fef03 104 * @param addr Address of block to begin erasing
kevman 0:38ceb79fef03 105 * @param size Size to erase in bytes, must be a multiple of erase block size
kevman 0:38ceb79fef03 106 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 107 */
kevman 0:38ceb79fef03 108 virtual int erase(bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 109
kevman 0:38ceb79fef03 110 /** Get the size of a readable block
kevman 0:38ceb79fef03 111 *
kevman 0:38ceb79fef03 112 * @return Size of a readable block in bytes
kevman 0:38ceb79fef03 113 */
kevman 0:38ceb79fef03 114 virtual bd_size_t get_read_size() const;
kevman 0:38ceb79fef03 115
kevman 0:38ceb79fef03 116 /** Get the size of a programmable block
kevman 0:38ceb79fef03 117 *
kevman 0:38ceb79fef03 118 * @return Size of a programmable block in bytes
kevman 0:38ceb79fef03 119 * @note Must be a multiple of the read size
kevman 0:38ceb79fef03 120 */
kevman 0:38ceb79fef03 121 virtual bd_size_t get_program_size() const;
kevman 0:38ceb79fef03 122
kevman 0:38ceb79fef03 123 /** Get the size of an erasable block
kevman 0:38ceb79fef03 124 *
kevman 0:38ceb79fef03 125 * @return Size of an erasable block in bytes
kevman 0:38ceb79fef03 126 * @note Must be a multiple of the program size
kevman 0:38ceb79fef03 127 */
kevman 0:38ceb79fef03 128 virtual bd_size_t get_erase_size() const;
kevman 0:38ceb79fef03 129
kevman 0:38ceb79fef03 130 /** Get the size of an erasable block given address
kevman 0:38ceb79fef03 131 *
kevman 0:38ceb79fef03 132 * @param addr Address within the erasable block
kevman 0:38ceb79fef03 133 * @return Size of an erasable block in bytes
kevman 0:38ceb79fef03 134 * @note Must be a multiple of the program size
kevman 0:38ceb79fef03 135 */
kevman 0:38ceb79fef03 136 virtual bd_size_t get_erase_size(bd_addr_t addr) const;
kevman 0:38ceb79fef03 137
kevman 0:38ceb79fef03 138 /** Get the value of storage when erased
kevman 0:38ceb79fef03 139 *
kevman 0:38ceb79fef03 140 * If get_erase_value returns a non-negative byte value, the underlying
kevman 0:38ceb79fef03 141 * storage is set to that value when erased, and you can program storage
kevman 0:38ceb79fef03 142 * containing that value without another erase.
kevman 0:38ceb79fef03 143 *
kevman 0:38ceb79fef03 144 * @return The value of storage when erased, or -1 if you can't
kevman 0:38ceb79fef03 145 * rely on the value of erased storage
kevman 0:38ceb79fef03 146 */
kevman 0:38ceb79fef03 147 virtual int get_erase_value() const;
kevman 0:38ceb79fef03 148
kevman 0:38ceb79fef03 149 /** Get the total size of the underlying device
kevman 0:38ceb79fef03 150 *
kevman 0:38ceb79fef03 151 * @return Size of the underlying device in bytes
kevman 0:38ceb79fef03 152 */
kevman 0:38ceb79fef03 153 virtual bd_size_t size() const;
kevman 0:38ceb79fef03 154
kevman 0:38ceb79fef03 155 /** Reset the current profile counts to zero
kevman 0:38ceb79fef03 156 */
kevman 0:38ceb79fef03 157 void reset();
kevman 0:38ceb79fef03 158
kevman 0:38ceb79fef03 159 /** Get number of bytes that have been read from the block device
kevman 0:38ceb79fef03 160 *
kevman 0:38ceb79fef03 161 * @return The number of bytes that have been read from the block device
kevman 0:38ceb79fef03 162 */
kevman 0:38ceb79fef03 163 bd_size_t get_read_count() const;
kevman 0:38ceb79fef03 164
kevman 0:38ceb79fef03 165 /** Get number of bytes that have been programed to the block device
kevman 0:38ceb79fef03 166 *
kevman 0:38ceb79fef03 167 * @return The number of bytes that have been programed to the block device
kevman 0:38ceb79fef03 168 */
kevman 0:38ceb79fef03 169 bd_size_t get_program_count() const;
kevman 0:38ceb79fef03 170
kevman 0:38ceb79fef03 171 /** Get number of bytes that have been erased from the block device
kevman 0:38ceb79fef03 172 *
kevman 0:38ceb79fef03 173 * @return The number of bytes that have been erased from the block device
kevman 0:38ceb79fef03 174 */
kevman 0:38ceb79fef03 175 bd_size_t get_erase_count() const;
kevman 0:38ceb79fef03 176
kevman 0:38ceb79fef03 177 private:
kevman 0:38ceb79fef03 178 BlockDevice *_bd;
kevman 0:38ceb79fef03 179 bd_size_t _read_count;
kevman 0:38ceb79fef03 180 bd_size_t _program_count;
kevman 0:38ceb79fef03 181 bd_size_t _erase_count;
kevman 0:38ceb79fef03 182 };
kevman 0:38ceb79fef03 183
kevman 0:38ceb79fef03 184
kevman 0:38ceb79fef03 185 #endif