Kev Mann / mbed-dev-OS5_10_4

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.

features/storage/blockdevice/ObservingBlockDevice.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-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_OBSERVING_BLOCK_DEVICE_H
kevman 0:38ceb79fef03 23 #define MBED_OBSERVING_BLOCK_DEVICE_H
kevman 0:38ceb79fef03 24
kevman 0:38ceb79fef03 25 #include "BlockDevice.h"
kevman 0:38ceb79fef03 26 #include "platform/PlatformMutex.h"
kevman 0:38ceb79fef03 27 #include "platform/Callback.h"
kevman 0:38ceb79fef03 28
kevman 0:38ceb79fef03 29
kevman 0:38ceb79fef03 30 class ObservingBlockDevice : public BlockDevice
kevman 0:38ceb79fef03 31 {
kevman 0:38ceb79fef03 32 public:
kevman 0:38ceb79fef03 33
kevman 0:38ceb79fef03 34 /** Lifetime of the block device
kevman 0:38ceb79fef03 35 *
kevman 0:38ceb79fef03 36 * @param bd Block device to observe
kevman 0:38ceb79fef03 37 */
kevman 0:38ceb79fef03 38 ObservingBlockDevice(BlockDevice *bd);
kevman 0:38ceb79fef03 39 virtual ~ObservingBlockDevice();
kevman 0:38ceb79fef03 40
kevman 0:38ceb79fef03 41 /** Attach a callback which is called on change
kevman 0:38ceb79fef03 42 *
kevman 0:38ceb79fef03 43 * @param cb Function to call on filesystem change (erase or program)
kevman 0:38ceb79fef03 44 */
kevman 0:38ceb79fef03 45 void attach(mbed::Callback<void(BlockDevice *)> cb);
kevman 0:38ceb79fef03 46
kevman 0:38ceb79fef03 47 /** Initialize a block device
kevman 0:38ceb79fef03 48 *
kevman 0:38ceb79fef03 49 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 50 */
kevman 0:38ceb79fef03 51 virtual int init();
kevman 0:38ceb79fef03 52
kevman 0:38ceb79fef03 53 /** Deinitialize a block device
kevman 0:38ceb79fef03 54 *
kevman 0:38ceb79fef03 55 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 56 */
kevman 0:38ceb79fef03 57 virtual int deinit();
kevman 0:38ceb79fef03 58
kevman 0:38ceb79fef03 59 /** Ensure data on storage is in sync with the driver
kevman 0:38ceb79fef03 60 *
kevman 0:38ceb79fef03 61 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 62 */
kevman 0:38ceb79fef03 63 virtual int sync();
kevman 0:38ceb79fef03 64
kevman 0:38ceb79fef03 65 /** Read blocks from a block device
kevman 0:38ceb79fef03 66 *
kevman 0:38ceb79fef03 67 * @param buffer Buffer to read blocks into
kevman 0:38ceb79fef03 68 * @param addr Address of block to begin reading from
kevman 0:38ceb79fef03 69 * @param size Size to read in bytes, must be a multiple of read block size
kevman 0:38ceb79fef03 70 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 71 */
kevman 0:38ceb79fef03 72 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 73
kevman 0:38ceb79fef03 74 /** Program blocks to a block device
kevman 0:38ceb79fef03 75 *
kevman 0:38ceb79fef03 76 * The blocks must have been erased prior to being programmed
kevman 0:38ceb79fef03 77 *
kevman 0:38ceb79fef03 78 * @param buffer Buffer of data to write to blocks
kevman 0:38ceb79fef03 79 * @param addr Address of block to begin writing to
kevman 0:38ceb79fef03 80 * @param size Size to write in bytes, must be a multiple of program block size
kevman 0:38ceb79fef03 81 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 82 */
kevman 0:38ceb79fef03 83 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 84
kevman 0:38ceb79fef03 85 /** Erase blocks on a block device
kevman 0:38ceb79fef03 86 *
kevman 0:38ceb79fef03 87 * The state of an erased block is undefined until it has been programmed,
kevman 0:38ceb79fef03 88 * unless get_erase_value returns a non-negative byte value
kevman 0:38ceb79fef03 89 *
kevman 0:38ceb79fef03 90 * @param addr Address of block to begin erasing
kevman 0:38ceb79fef03 91 * @param size Size to erase in bytes, must be a multiple of erase block size
kevman 0:38ceb79fef03 92 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 93 */
kevman 0:38ceb79fef03 94 virtual int erase(bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 95
kevman 0:38ceb79fef03 96 /** Get the size of a readable block
kevman 0:38ceb79fef03 97 *
kevman 0:38ceb79fef03 98 * @return Size of a readable block in bytes
kevman 0:38ceb79fef03 99 */
kevman 0:38ceb79fef03 100 virtual bd_size_t get_read_size() const;
kevman 0:38ceb79fef03 101
kevman 0:38ceb79fef03 102 /** Get the size of a programmable block
kevman 0:38ceb79fef03 103 *
kevman 0:38ceb79fef03 104 * @return Size of a programmable block in bytes
kevman 0:38ceb79fef03 105 */
kevman 0:38ceb79fef03 106 virtual bd_size_t get_program_size() const;
kevman 0:38ceb79fef03 107
kevman 0:38ceb79fef03 108 /** Get the size of an erasable block
kevman 0:38ceb79fef03 109 *
kevman 0:38ceb79fef03 110 * @return Size of an erasable block in bytes
kevman 0:38ceb79fef03 111 */
kevman 0:38ceb79fef03 112 virtual bd_size_t get_erase_size() const;
kevman 0:38ceb79fef03 113
kevman 0:38ceb79fef03 114 /** Get the size of an erasable block given address
kevman 0:38ceb79fef03 115 *
kevman 0:38ceb79fef03 116 * @param addr Address within the erasable block
kevman 0:38ceb79fef03 117 * @return Size of an erasable block in bytes
kevman 0:38ceb79fef03 118 * @note Must be a multiple of the program size
kevman 0:38ceb79fef03 119 */
kevman 0:38ceb79fef03 120 virtual bd_size_t get_erase_size(bd_addr_t addr) const;
kevman 0:38ceb79fef03 121
kevman 0:38ceb79fef03 122 /** Get the value of storage when erased
kevman 0:38ceb79fef03 123 *
kevman 0:38ceb79fef03 124 * If get_erase_value returns a non-negative byte value, the underlying
kevman 0:38ceb79fef03 125 * storage is set to that value when erased, and storage containing
kevman 0:38ceb79fef03 126 * that value can be programmed without another erase.
kevman 0:38ceb79fef03 127 *
kevman 0:38ceb79fef03 128 * @return The value of storage when erased, or -1 if you can't
kevman 0:38ceb79fef03 129 * rely on the value of erased storage
kevman 0:38ceb79fef03 130 */
kevman 0:38ceb79fef03 131 virtual int get_erase_value() const;
kevman 0:38ceb79fef03 132
kevman 0:38ceb79fef03 133 /** Get the total size of the underlying device
kevman 0:38ceb79fef03 134 *
kevman 0:38ceb79fef03 135 * @return Size of the underlying device in bytes
kevman 0:38ceb79fef03 136 */
kevman 0:38ceb79fef03 137 virtual bd_size_t size() const;
kevman 0:38ceb79fef03 138
kevman 0:38ceb79fef03 139 private:
kevman 0:38ceb79fef03 140 BlockDevice *_bd;
kevman 0:38ceb79fef03 141 mbed::Callback<void(BlockDevice *)> _change;
kevman 0:38ceb79fef03 142 };
kevman 0:38ceb79fef03 143
kevman 0:38ceb79fef03 144
kevman 0:38ceb79fef03 145
kevman 0:38ceb79fef03 146 #endif