Marco Zecchini
/
Example_RTOS
Rtos API example
Embed:
(wiki syntax)
Show/hide line numbers
ProfilingBlockDevice.h
00001 /* mbed Microcontroller Library 00002 * Copyright (c) 2017 ARM Limited 00003 * 00004 * Permission is hereby granted, free of charge, to any person obtaining a copy 00005 * of this software and associated documentation files (the "Software"), to deal 00006 * in the Software without restriction, including without limitation the rights 00007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 00008 * copies of the Software, and to permit persons to whom the Software is 00009 * furnished to do so, subject to the following conditions: 00010 * 00011 * The above copyright notice and this permission notice shall be included in 00012 * all copies or substantial portions of the Software. 00013 * 00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 00015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 00016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 00017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 00018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 00019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 00020 * SOFTWARE. 00021 */ 00022 #ifndef MBED_PROFILING_BLOCK_DEVICE_H 00023 #define MBED_PROFILING_BLOCK_DEVICE_H 00024 00025 #include "BlockDevice.h" 00026 #include "mbed.h" 00027 00028 00029 /** Block device for measuring storage operations of another block device 00030 * 00031 * @code 00032 * #include "mbed.h" 00033 * #include "HeapBlockDevice.h" 00034 * #include "ProfilingBlockDevice.h" 00035 * 00036 * // Create a heap block device and profiling block device 00037 * HeapBlockDevice mem(64*512, 512); 00038 * ProfilingBlockDevice profiler(&mem); 00039 * 00040 * // do block device work.... 00041 * 00042 * printf("read count: %lld\n", profiler.get_read_count()); 00043 * printf("program count: %lld\n", profiler.get_program_count()); 00044 * printf("erase count: %lld\n", profiler.get_erase_count()); 00045 * @endcode 00046 */ 00047 class ProfilingBlockDevice : public BlockDevice 00048 { 00049 public: 00050 /** Lifetime of the memory block device 00051 * 00052 * @param bd Block device to back the ProfilingBlockDevice 00053 */ 00054 ProfilingBlockDevice(BlockDevice *bd); 00055 00056 /** Lifetime of a block device 00057 */ 00058 virtual ~ProfilingBlockDevice() {}; 00059 00060 /** Initialize a block device 00061 * 00062 * @return 0 on success or a negative error code on failure 00063 * @note The init and deinit functions do not effect profile counts 00064 */ 00065 virtual int init(); 00066 00067 /** Deinitialize a block device 00068 * 00069 * @return 0 on success or a negative error code on failure 00070 * @note The init and deinit functions do not effect profile counts 00071 */ 00072 virtual int deinit(); 00073 00074 /** Read blocks from a block device 00075 * 00076 * @param buffer Buffer to read blocks into 00077 * @param addr Address of block to begin reading from 00078 * @param size Size to read in bytes, must be a multiple of read block size 00079 * @return 0 on success, negative error code on failure 00080 */ 00081 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size); 00082 00083 /** Program blocks to a block device 00084 * 00085 * The blocks must have been erased prior to being programmed 00086 * 00087 * @param buffer Buffer of data to write to blocks 00088 * @param addr Address of block to begin writing to 00089 * @param size Size to write in bytes, must be a multiple of program block size 00090 * @return 0 on success, negative error code on failure 00091 */ 00092 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size); 00093 00094 /** Erase blocks on a block device 00095 * 00096 * The state of an erased block is undefined until it has been programmed 00097 * 00098 * @param addr Address of block to begin erasing 00099 * @param size Size to erase in bytes, must be a multiple of erase block size 00100 * @return 0 on success, negative error code on failure 00101 */ 00102 virtual int erase(bd_addr_t addr, bd_size_t size); 00103 00104 /** Get the size of a readable block 00105 * 00106 * @return Size of a readable block in bytes 00107 */ 00108 virtual bd_size_t get_read_size() const; 00109 00110 /** Get the size of a programable block 00111 * 00112 * @return Size of a programable block in bytes 00113 * @note Must be a multiple of the read size 00114 */ 00115 virtual bd_size_t get_program_size() const; 00116 00117 /** Get the size of a eraseable block 00118 * 00119 * @return Size of a eraseable block in bytes 00120 * @note Must be a multiple of the program size 00121 */ 00122 virtual bd_size_t get_erase_size() const; 00123 00124 /** Get the total size of the underlying device 00125 * 00126 * @return Size of the underlying device in bytes 00127 */ 00128 virtual bd_size_t size() const; 00129 00130 /** Reset the current profile counts to zero 00131 */ 00132 void reset(); 00133 00134 /** Get number of bytes that have been read from the block device 00135 * 00136 * @return The number of bytes that have been read from the block device 00137 */ 00138 bd_size_t get_read_count() const; 00139 00140 /** Get number of bytes that have been programed to the block device 00141 * 00142 * @return The number of bytes that have been programed to the block device 00143 */ 00144 bd_size_t get_program_count() const; 00145 00146 /** Get number of bytes that have been erased from the block device 00147 * 00148 * @return The number of bytes that have been erased from the block device 00149 */ 00150 bd_size_t get_erase_count() const; 00151 00152 private: 00153 BlockDevice *_bd; 00154 bd_size_t _read_count; 00155 bd_size_t _program_count; 00156 bd_size_t _erase_count; 00157 }; 00158 00159 00160 #endif
Generated on Sun Jul 17 2022 08:25:29 by 1.7.2