Kev Mann / mbed-dev-OS5_10_4

RTC auf true

features/storage/blockdevice/HeapBlockDevice.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

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_MEM_BLOCK_DEVICE_H
kevman 0:38ceb79fef03 23 #define MBED_MEM_BLOCK_DEVICE_H
kevman 0:38ceb79fef03 24
kevman 0:38ceb79fef03 25 #include "BlockDevice.h"
kevman 0:38ceb79fef03 26 #include "platform/mbed_assert.h"
kevman 0:38ceb79fef03 27 #include <string.h>
kevman 0:38ceb79fef03 28 #include <stdlib.h>
kevman 0:38ceb79fef03 29
kevman 0:38ceb79fef03 30 /** Lazily allocated heap-backed block device
kevman 0:38ceb79fef03 31 *
kevman 0:38ceb79fef03 32 * Useful for simulating a block device and tests
kevman 0:38ceb79fef03 33 *
kevman 0:38ceb79fef03 34 * @code
kevman 0:38ceb79fef03 35 * #include "mbed.h"
kevman 0:38ceb79fef03 36 * #include "HeapBlockDevice.h"
kevman 0:38ceb79fef03 37 *
kevman 0:38ceb79fef03 38 * #define BLOCK_SIZE 512
kevman 0:38ceb79fef03 39 *
kevman 0:38ceb79fef03 40 * HeapBlockDevice bd(2048, BLOCK_SIZE); // 2048 bytes with a block size of 512 bytes
kevman 0:38ceb79fef03 41 * uint8_t block[BLOCK_SIZE] = "Hello World!\n";
kevman 0:38ceb79fef03 42 *
kevman 0:38ceb79fef03 43 * int main() {
kevman 0:38ceb79fef03 44 * bd.init();
kevman 0:38ceb79fef03 45 * bd.erase(0, BLOCK_SIZE);
kevman 0:38ceb79fef03 46 * bd.program(block, 0, BLOCK_SIZE);
kevman 0:38ceb79fef03 47 * bd.read(block, 0, BLOCK_SIZE);
kevman 0:38ceb79fef03 48 * printf("%s", block);
kevman 0:38ceb79fef03 49 * bd.deinit();
kevman 0:38ceb79fef03 50 * }
kevman 0:38ceb79fef03 51 * @endcode
kevman 0:38ceb79fef03 52 */
kevman 0:38ceb79fef03 53 class HeapBlockDevice : public BlockDevice
kevman 0:38ceb79fef03 54 {
kevman 0:38ceb79fef03 55 public:
kevman 0:38ceb79fef03 56
kevman 0:38ceb79fef03 57 /** Lifetime of the memory block device
kevman 0:38ceb79fef03 58 *
kevman 0:38ceb79fef03 59 * @param size Size of the Block Device in bytes
kevman 0:38ceb79fef03 60 * @param block Block size in bytes. Minimum read, program, and erase sizes are
kevman 0:38ceb79fef03 61 * configured to this value
kevman 0:38ceb79fef03 62 */
kevman 0:38ceb79fef03 63 HeapBlockDevice(bd_size_t size, bd_size_t block=512);
kevman 0:38ceb79fef03 64 /** Lifetime of the memory block device
kevman 0:38ceb79fef03 65 *
kevman 0:38ceb79fef03 66 * @param size Size of the Block Device in bytes
kevman 0:38ceb79fef03 67 * @param read Minimum read size required in bytes
kevman 0:38ceb79fef03 68 * @param program Minimum program size required in bytes
kevman 0:38ceb79fef03 69 * @param erase Minimum erase size required in bytes
kevman 0:38ceb79fef03 70 */
kevman 0:38ceb79fef03 71 HeapBlockDevice(bd_size_t size, bd_size_t read, bd_size_t program, bd_size_t erase);
kevman 0:38ceb79fef03 72 virtual ~HeapBlockDevice();
kevman 0:38ceb79fef03 73
kevman 0:38ceb79fef03 74 /** Initialize a block device
kevman 0:38ceb79fef03 75 *
kevman 0:38ceb79fef03 76 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 77 */
kevman 0:38ceb79fef03 78 virtual int init();
kevman 0:38ceb79fef03 79
kevman 0:38ceb79fef03 80 /** Deinitialize a block device
kevman 0:38ceb79fef03 81 *
kevman 0:38ceb79fef03 82 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 83 */
kevman 0:38ceb79fef03 84 virtual int deinit();
kevman 0:38ceb79fef03 85
kevman 0:38ceb79fef03 86 /** Read blocks from a block device
kevman 0:38ceb79fef03 87 *
kevman 0:38ceb79fef03 88 * @param buffer Buffer to read blocks into
kevman 0:38ceb79fef03 89 * @param addr Address of block to begin reading from
kevman 0:38ceb79fef03 90 * @param size Size to read in bytes, must be a multiple of read block size
kevman 0:38ceb79fef03 91 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 92 */
kevman 0:38ceb79fef03 93 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 94
kevman 0:38ceb79fef03 95 /** Program blocks to a block device
kevman 0:38ceb79fef03 96 *
kevman 0:38ceb79fef03 97 * The blocks must have been erased prior to being programmed
kevman 0:38ceb79fef03 98 *
kevman 0:38ceb79fef03 99 * @param buffer Buffer of data to write to blocks
kevman 0:38ceb79fef03 100 * @param addr Address of block to begin writing to
kevman 0:38ceb79fef03 101 * @param size Size to write in bytes, must be a multiple of program block size
kevman 0:38ceb79fef03 102 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 103 */
kevman 0:38ceb79fef03 104 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 105
kevman 0:38ceb79fef03 106 /** Erase blocks on a block device
kevman 0:38ceb79fef03 107 *
kevman 0:38ceb79fef03 108 * The state of an erased block is undefined until it has been programmed
kevman 0:38ceb79fef03 109 *
kevman 0:38ceb79fef03 110 * @param addr Address of block to begin erasing
kevman 0:38ceb79fef03 111 * @param size Size to erase in bytes, must be a multiple of erase block size
kevman 0:38ceb79fef03 112 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 113 */
kevman 0:38ceb79fef03 114 virtual int erase(bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 115
kevman 0:38ceb79fef03 116 /** Get the size of a readable block
kevman 0:38ceb79fef03 117 *
kevman 0:38ceb79fef03 118 * @return Size of a readable block in bytes
kevman 0:38ceb79fef03 119 */
kevman 0:38ceb79fef03 120 virtual bd_size_t get_read_size() const;
kevman 0:38ceb79fef03 121
kevman 0:38ceb79fef03 122 /** Get the size of a programmable block
kevman 0:38ceb79fef03 123 *
kevman 0:38ceb79fef03 124 * @return Size of a programmable block in bytes
kevman 0:38ceb79fef03 125 */
kevman 0:38ceb79fef03 126 virtual bd_size_t get_program_size() const;
kevman 0:38ceb79fef03 127
kevman 0:38ceb79fef03 128 /** Get the size of an erasable block
kevman 0:38ceb79fef03 129 *
kevman 0:38ceb79fef03 130 * @return Size of an erasable block in bytes
kevman 0:38ceb79fef03 131 */
kevman 0:38ceb79fef03 132 virtual bd_size_t get_erase_size() const;
kevman 0:38ceb79fef03 133
kevman 0:38ceb79fef03 134 /** Get the size of an erasable block given address
kevman 0:38ceb79fef03 135 *
kevman 0:38ceb79fef03 136 * @param addr Address within the erasable block
kevman 0:38ceb79fef03 137 * @return Size of an erasable block in bytes
kevman 0:38ceb79fef03 138 * @note Must be a multiple of the program size
kevman 0:38ceb79fef03 139 */
kevman 0:38ceb79fef03 140 virtual bd_size_t get_erase_size(bd_addr_t addr) const;
kevman 0:38ceb79fef03 141
kevman 0:38ceb79fef03 142 /** Get the total size of the underlying device
kevman 0:38ceb79fef03 143 *
kevman 0:38ceb79fef03 144 * @return Size of the underlying device in bytes
kevman 0:38ceb79fef03 145 */
kevman 0:38ceb79fef03 146 virtual bd_size_t size() const;
kevman 0:38ceb79fef03 147
kevman 0:38ceb79fef03 148 private:
kevman 0:38ceb79fef03 149 bd_size_t _read_size;
kevman 0:38ceb79fef03 150 bd_size_t _program_size;
kevman 0:38ceb79fef03 151 bd_size_t _erase_size;
kevman 0:38ceb79fef03 152 bd_size_t _count;
kevman 0:38ceb79fef03 153 uint8_t **_blocks;
kevman 0:38ceb79fef03 154 uint32_t _init_ref_count;
kevman 0:38ceb79fef03 155 bool _is_initialized;
kevman 0:38ceb79fef03 156 };
kevman 0:38ceb79fef03 157
kevman 0:38ceb79fef03 158
kevman 0:38ceb79fef03 159 #endif