Marco Mayer / Mbed OS Queue

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/SlicingBlockDevice.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

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