Kev Mann / mbed-dev-OS5_10_4

features/storage/blockdevice/ReadOnlyBlockDevice.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

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