Kev Mann / mbed-dev-OS5_10_4

features/storage/blockdevice/BufferedBlockDevice.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) 2018 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_BUFFERED_BLOCK_DEVICE_H
kevman 0:38ceb79fef03 23 #define MBED_BUFFERED_BLOCK_DEVICE_H
kevman 0:38ceb79fef03 24
kevman 0:38ceb79fef03 25 #include "BlockDevice.h"
kevman 0:38ceb79fef03 26
kevman 0:38ceb79fef03 27
kevman 0:38ceb79fef03 28 /** Block device for allowing minimal read and program sizes (of 1) for the underlying BD,
kevman 0:38ceb79fef03 29 * using a buffer on the heap.
kevman 0:38ceb79fef03 30 */
kevman 0:38ceb79fef03 31 class BufferedBlockDevice : public BlockDevice {
kevman 0:38ceb79fef03 32 public:
kevman 0:38ceb79fef03 33 /** Lifetime of the memory block device
kevman 0:38ceb79fef03 34 *
kevman 0:38ceb79fef03 35 * @param bd Block device to back the BufferedBlockDevice
kevman 0:38ceb79fef03 36 */
kevman 0:38ceb79fef03 37 BufferedBlockDevice(BlockDevice *bd);
kevman 0:38ceb79fef03 38
kevman 0:38ceb79fef03 39 /** Lifetime of a block device
kevman 0:38ceb79fef03 40 */
kevman 0:38ceb79fef03 41 virtual ~BufferedBlockDevice();
kevman 0:38ceb79fef03 42
kevman 0:38ceb79fef03 43 /** Initialize a block device
kevman 0:38ceb79fef03 44 *
kevman 0:38ceb79fef03 45 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 46 */
kevman 0:38ceb79fef03 47 virtual int init();
kevman 0:38ceb79fef03 48
kevman 0:38ceb79fef03 49 /** Deinitialize a block device
kevman 0:38ceb79fef03 50 *
kevman 0:38ceb79fef03 51 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 52 */
kevman 0:38ceb79fef03 53 virtual int deinit();
kevman 0:38ceb79fef03 54
kevman 0:38ceb79fef03 55 /** Ensure data on storage is in sync with the driver
kevman 0:38ceb79fef03 56 *
kevman 0:38ceb79fef03 57 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 58 */
kevman 0:38ceb79fef03 59 virtual int sync();
kevman 0:38ceb79fef03 60
kevman 0:38ceb79fef03 61 /** Read blocks from a block device
kevman 0:38ceb79fef03 62 *
kevman 0:38ceb79fef03 63 * @param buffer Buffer to read blocks into
kevman 0:38ceb79fef03 64 * @param addr Address of block to begin reading from
kevman 0:38ceb79fef03 65 * @param size Size to read in bytes, must be a multiple of read block size
kevman 0:38ceb79fef03 66 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 67 */
kevman 0:38ceb79fef03 68 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 69
kevman 0:38ceb79fef03 70 /** Program blocks to a block device
kevman 0:38ceb79fef03 71 *
kevman 0:38ceb79fef03 72 * The blocks must have been erased prior to being programmed
kevman 0:38ceb79fef03 73 *
kevman 0:38ceb79fef03 74 * @param buffer Buffer of data to write to blocks
kevman 0:38ceb79fef03 75 * @param addr Address of block to begin writing to
kevman 0:38ceb79fef03 76 * @param size Size to write in bytes, must be a multiple of program block size
kevman 0:38ceb79fef03 77 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 78 */
kevman 0:38ceb79fef03 79 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 80
kevman 0:38ceb79fef03 81 /** Erase blocks on a block device
kevman 0:38ceb79fef03 82 *
kevman 0:38ceb79fef03 83 * The state of an erased block is undefined until it has been programmed,
kevman 0:38ceb79fef03 84 * unless get_erase_value returns a non-negative byte value
kevman 0:38ceb79fef03 85 *
kevman 0:38ceb79fef03 86 * @param addr Address of block to begin erasing
kevman 0:38ceb79fef03 87 * @param size Size to erase in bytes, must be a multiple of erase block size
kevman 0:38ceb79fef03 88 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 89 */
kevman 0:38ceb79fef03 90 virtual int erase(bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 91
kevman 0:38ceb79fef03 92 /** Mark blocks as no longer in use
kevman 0:38ceb79fef03 93 *
kevman 0:38ceb79fef03 94 * This function provides a hint to the underlying block device that a region of blocks
kevman 0:38ceb79fef03 95 * is no longer in use and may be erased without side effects. Erase must still be called
kevman 0:38ceb79fef03 96 * before programming, but trimming allows flash-translation-layers to schedule erases when
kevman 0:38ceb79fef03 97 * the device is not busy.
kevman 0:38ceb79fef03 98 *
kevman 0:38ceb79fef03 99 * @param addr Address of block to mark as unused
kevman 0:38ceb79fef03 100 * @param size Size to mark as unused in bytes, must be a multiple of erase block size
kevman 0:38ceb79fef03 101 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 102 */
kevman 0:38ceb79fef03 103 virtual int trim(bd_addr_t addr, bd_size_t size);
kevman 0:38ceb79fef03 104
kevman 0:38ceb79fef03 105 /** Get the size of a readable block
kevman 0:38ceb79fef03 106 *
kevman 0:38ceb79fef03 107 * @return Size of a readable block in bytes
kevman 0:38ceb79fef03 108 */
kevman 0:38ceb79fef03 109 virtual bd_size_t get_read_size() const;
kevman 0:38ceb79fef03 110
kevman 0:38ceb79fef03 111 /** Get the size of a programmable block
kevman 0:38ceb79fef03 112 *
kevman 0:38ceb79fef03 113 * @return Size of a programmable block in bytes
kevman 0:38ceb79fef03 114 * @note Must be a multiple of the read size
kevman 0:38ceb79fef03 115 */
kevman 0:38ceb79fef03 116 virtual bd_size_t get_program_size() const;
kevman 0:38ceb79fef03 117
kevman 0:38ceb79fef03 118 /** Get the size of an erasable block
kevman 0:38ceb79fef03 119 *
kevman 0:38ceb79fef03 120 * @return Size of an erasable block in bytes
kevman 0:38ceb79fef03 121 * @note Must be a multiple of the program size
kevman 0:38ceb79fef03 122 */
kevman 0:38ceb79fef03 123 virtual bd_size_t get_erase_size() const;
kevman 0:38ceb79fef03 124
kevman 0:38ceb79fef03 125 /** Get the size of an erasable block given address
kevman 0:38ceb79fef03 126 *
kevman 0:38ceb79fef03 127 * @param addr Address within the erasable block
kevman 0:38ceb79fef03 128 * @return Size of an erasable block in bytes
kevman 0:38ceb79fef03 129 * @note Must be a multiple of the program size
kevman 0:38ceb79fef03 130 */
kevman 0:38ceb79fef03 131 virtual bd_size_t get_erase_size(bd_addr_t addr) const;
kevman 0:38ceb79fef03 132
kevman 0:38ceb79fef03 133 /** Get the value of storage when erased
kevman 0:38ceb79fef03 134 *
kevman 0:38ceb79fef03 135 * If get_erase_value returns a non-negative byte value, the underlying
kevman 0:38ceb79fef03 136 * storage is set to that value when erased, and storage containing
kevman 0:38ceb79fef03 137 * that value can be programmed without another erase.
kevman 0:38ceb79fef03 138 *
kevman 0:38ceb79fef03 139 * @return The value of storage when erased, or -1 if you can't
kevman 0:38ceb79fef03 140 * rely on the value of erased storage
kevman 0:38ceb79fef03 141 */
kevman 0:38ceb79fef03 142 virtual int get_erase_value() const;
kevman 0:38ceb79fef03 143
kevman 0:38ceb79fef03 144 /** Get the total size of the underlying device
kevman 0:38ceb79fef03 145 *
kevman 0:38ceb79fef03 146 * @return Size of the underlying device in bytes
kevman 0:38ceb79fef03 147 */
kevman 0:38ceb79fef03 148 virtual bd_size_t size() const;
kevman 0:38ceb79fef03 149
kevman 0:38ceb79fef03 150 protected:
kevman 0:38ceb79fef03 151 BlockDevice *_bd;
kevman 0:38ceb79fef03 152 bd_size_t _bd_program_size;
kevman 0:38ceb79fef03 153 bd_size_t _curr_aligned_addr;
kevman 0:38ceb79fef03 154 bool _flushed;
kevman 0:38ceb79fef03 155 uint8_t *_cache;
kevman 0:38ceb79fef03 156 uint32_t _init_ref_count;
kevman 0:38ceb79fef03 157 bool _is_initialized;
kevman 0:38ceb79fef03 158
kevman 0:38ceb79fef03 159 /** Flush data in cache
kevman 0:38ceb79fef03 160 *
kevman 0:38ceb79fef03 161 * @return 0 on success or a negative error code on failure
kevman 0:38ceb79fef03 162 */
kevman 0:38ceb79fef03 163 int flush();
kevman 0:38ceb79fef03 164
kevman 0:38ceb79fef03 165 };
kevman 0:38ceb79fef03 166
kevman 0:38ceb79fef03 167
kevman 0:38ceb79fef03 168 #endif