Knight KE / Mbed OS Game_Master

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/features/filesystem/bd/ProfilingBlockDevice.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

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