BA / Mbed OS BaBoRo1

mbed-os/features/filesystem/bd/HeapBlockDevice.h@0:380207fcb5c1, 2018-03-29 (annotated)

Committer:
borlanic
Date:
Thu Mar 29 07:02:09 2018 +0000
Revision:
0:380207fcb5c1
Child:
4:75df35ef4fb6
Encoder, IMU --> OK; Controller --> in bearbeitung

Who changed what in which revision?

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