Nicolas Borla / Mbed OS BBR_1Ebene

BBR 1 Ebene

mbed-os/features/filesystem/bd/HeapBlockDevice.h@0:fbdae7e6d805, 2018-05-14 (annotated)

Committer:
borlanic
Date:
Mon May 14 11:29:06 2018 +0000
Revision:
0:fbdae7e6d805
BBR

Who changed what in which revision?

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