Denislam Valeev / Mbed OS Nucleo_rtos_basic

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/features/filesystem/bd/HeapBlockDevice.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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