Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/storage/blockdevice/HeapBlockDevice.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
mbed-os5 only for TYBLE16

Who changed what in which revision?

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