Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/storage/blockdevice/BufferedBlockDevice.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
mbed-os5 only for TYBLE16

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* mbed Microcontroller Library
kenjiArai 0:5b88d5760320 2 * Copyright (c) 2018 ARM Limited
kenjiArai 0:5b88d5760320 3 *
kenjiArai 0:5b88d5760320 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
kenjiArai 0:5b88d5760320 5 * of this software and associated documentation files (the "Software"), to deal
kenjiArai 0:5b88d5760320 6 * in the Software without restriction, including without limitation the rights
kenjiArai 0:5b88d5760320 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
kenjiArai 0:5b88d5760320 8 * copies of the Software, and to permit persons to whom the Software is
kenjiArai 0:5b88d5760320 9 * furnished to do so, subject to the following conditions:
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * The above copyright notice and this permission notice shall be included in
kenjiArai 0:5b88d5760320 12 * all copies or substantial portions of the Software.
kenjiArai 0:5b88d5760320 13 *
kenjiArai 0:5b88d5760320 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
kenjiArai 0:5b88d5760320 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
kenjiArai 0:5b88d5760320 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
kenjiArai 0:5b88d5760320 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
kenjiArai 0:5b88d5760320 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kenjiArai 0:5b88d5760320 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
kenjiArai 0:5b88d5760320 20 * SOFTWARE.
kenjiArai 0:5b88d5760320 21 */
kenjiArai 0:5b88d5760320 22
kenjiArai 0:5b88d5760320 23 /** \addtogroup storage */
kenjiArai 0:5b88d5760320 24 /** @{*/
kenjiArai 0:5b88d5760320 25
kenjiArai 0:5b88d5760320 26 #ifndef MBED_BUFFERED_BLOCK_DEVICE_H
kenjiArai 0:5b88d5760320 27 #define MBED_BUFFERED_BLOCK_DEVICE_H
kenjiArai 0:5b88d5760320 28
kenjiArai 0:5b88d5760320 29 #include "BlockDevice.h"
kenjiArai 0:5b88d5760320 30
kenjiArai 0:5b88d5760320 31 namespace mbed {
kenjiArai 0:5b88d5760320 32
kenjiArai 0:5b88d5760320 33 /** Block device for allowing minimal read and program sizes (of 1) for the underlying BD,
kenjiArai 0:5b88d5760320 34 * using a buffer on the heap.
kenjiArai 0:5b88d5760320 35 */
kenjiArai 0:5b88d5760320 36 class BufferedBlockDevice : public BlockDevice {
kenjiArai 0:5b88d5760320 37 public:
kenjiArai 0:5b88d5760320 38 /** Lifetime of a memory-buffered block device wrapping an underlying block device
kenjiArai 0:5b88d5760320 39 *
kenjiArai 0:5b88d5760320 40 * @param bd Block device to back the BufferedBlockDevice
kenjiArai 0:5b88d5760320 41 */
kenjiArai 0:5b88d5760320 42 BufferedBlockDevice(BlockDevice *bd);
kenjiArai 0:5b88d5760320 43
kenjiArai 0:5b88d5760320 44 /** Lifetime of the memory-buffered block device
kenjiArai 0:5b88d5760320 45 */
kenjiArai 0:5b88d5760320 46 virtual ~BufferedBlockDevice();
kenjiArai 0:5b88d5760320 47
kenjiArai 0:5b88d5760320 48 /** Initialize a buffered-memory block device and its underlying block device
kenjiArai 0:5b88d5760320 49 *
kenjiArai 0:5b88d5760320 50 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 51 */
kenjiArai 0:5b88d5760320 52 virtual int init();
kenjiArai 0:5b88d5760320 53
kenjiArai 0:5b88d5760320 54 /** Deinitialize the buffered-memory block device and its underlying block device
kenjiArai 0:5b88d5760320 55 *
kenjiArai 0:5b88d5760320 56 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 57 */
kenjiArai 0:5b88d5760320 58 virtual int deinit();
kenjiArai 0:5b88d5760320 59
kenjiArai 0:5b88d5760320 60 /** Ensure that data on the underlying storage block device is in sync with the
kenjiArai 0:5b88d5760320 61 * memory-buffered block device
kenjiArai 0:5b88d5760320 62 *
kenjiArai 0:5b88d5760320 63 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 64 */
kenjiArai 0:5b88d5760320 65 virtual int sync();
kenjiArai 0:5b88d5760320 66
kenjiArai 0:5b88d5760320 67 /** Read blocks from the memory-buffered block device
kenjiArai 0:5b88d5760320 68 *
kenjiArai 0:5b88d5760320 69 * @param buffer Buffer to read blocks into
kenjiArai 0:5b88d5760320 70 * @param addr Address of block to begin reading from
kenjiArai 0:5b88d5760320 71 * @param size Size to read in bytes, must be a multiple of read block size
kenjiArai 0:5b88d5760320 72 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 73 */
kenjiArai 0:5b88d5760320 74 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
kenjiArai 0:5b88d5760320 75
kenjiArai 0:5b88d5760320 76 /** Program data to the memory-buffered block device
kenjiArai 0:5b88d5760320 77 *
kenjiArai 0:5b88d5760320 78 * The write address blocks must be erased prior to being programmed.
kenjiArai 0:5b88d5760320 79 *
kenjiArai 0:5b88d5760320 80 * @param buffer Buffer of data to write to blocks
kenjiArai 0:5b88d5760320 81 * @param addr Address of block to begin writing to
kenjiArai 0:5b88d5760320 82 * @param size Size to write in bytes, must be a multiple of program block size
kenjiArai 0:5b88d5760320 83 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 84 */
kenjiArai 0:5b88d5760320 85 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
kenjiArai 0:5b88d5760320 86
kenjiArai 0:5b88d5760320 87 /** Erase blocks from the memory-buffered block device
kenjiArai 0:5b88d5760320 88 *
kenjiArai 0:5b88d5760320 89 * The state of an erased block is undefined until it has been programmed,
kenjiArai 0:5b88d5760320 90 * unless get_erase_value returns a non-negative byte value.
kenjiArai 0:5b88d5760320 91 *
kenjiArai 0:5b88d5760320 92 * @param addr Address of block to begin erasing
kenjiArai 0:5b88d5760320 93 * @param size Size to erase in bytes, must be a multiple of erase block size
kenjiArai 0:5b88d5760320 94 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 95 */
kenjiArai 0:5b88d5760320 96 virtual int erase(bd_addr_t addr, bd_size_t size);
kenjiArai 0:5b88d5760320 97
kenjiArai 0:5b88d5760320 98 /** Mark blocks as no longer in use
kenjiArai 0:5b88d5760320 99 *
kenjiArai 0:5b88d5760320 100 * This function provides a hint to the underlying block device that a region of blocks
kenjiArai 0:5b88d5760320 101 * is no longer in use and may be erased without side effects. Erase must still be called
kenjiArai 0:5b88d5760320 102 * before programming, but trimming allows flash-translation-layers to schedule erases when
kenjiArai 0:5b88d5760320 103 * the device is not busy.
kenjiArai 0:5b88d5760320 104 *
kenjiArai 0:5b88d5760320 105 * @param addr Address of block to mark as unused
kenjiArai 0:5b88d5760320 106 * @param size Size to mark as unused in bytes, must be a multiple of erase block size
kenjiArai 0:5b88d5760320 107 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 108 */
kenjiArai 0:5b88d5760320 109 virtual int trim(bd_addr_t addr, bd_size_t size);
kenjiArai 0:5b88d5760320 110
kenjiArai 0:5b88d5760320 111 /** Get the size of a readable block
kenjiArai 0:5b88d5760320 112 *
kenjiArai 0:5b88d5760320 113 * @return Size of a readable block in bytes
kenjiArai 0:5b88d5760320 114 */
kenjiArai 0:5b88d5760320 115 virtual bd_size_t get_read_size() const;
kenjiArai 0:5b88d5760320 116
kenjiArai 0:5b88d5760320 117 /** Get the size of a programmable block
kenjiArai 0:5b88d5760320 118 *
kenjiArai 0:5b88d5760320 119 * @return Size of a programmable block in bytes
kenjiArai 0:5b88d5760320 120 * @note Must be a multiple of the read size
kenjiArai 0:5b88d5760320 121 */
kenjiArai 0:5b88d5760320 122 virtual bd_size_t get_program_size() const;
kenjiArai 0:5b88d5760320 123
kenjiArai 0:5b88d5760320 124 /** Get the size of an erasable block
kenjiArai 0:5b88d5760320 125 *
kenjiArai 0:5b88d5760320 126 * @return Size of an erasable block in bytes
kenjiArai 0:5b88d5760320 127 * @note Must be a multiple of the program size
kenjiArai 0:5b88d5760320 128 */
kenjiArai 0:5b88d5760320 129 virtual bd_size_t get_erase_size() const;
kenjiArai 0:5b88d5760320 130
kenjiArai 0:5b88d5760320 131 /** Get the size of an erasable block of a given address
kenjiArai 0:5b88d5760320 132 *
kenjiArai 0:5b88d5760320 133 * @param addr Address within the erasable block
kenjiArai 0:5b88d5760320 134 * @return Size of an erasable block in bytes
kenjiArai 0:5b88d5760320 135 * @note Must be a multiple of the program size
kenjiArai 0:5b88d5760320 136 */
kenjiArai 0:5b88d5760320 137 virtual bd_size_t get_erase_size(bd_addr_t addr) const;
kenjiArai 0:5b88d5760320 138
kenjiArai 0:5b88d5760320 139 /** Get the value of storage data after being erased
kenjiArai 0:5b88d5760320 140 *
kenjiArai 0:5b88d5760320 141 * If get_erase_value returns a non-negative byte value, the underlying
kenjiArai 0:5b88d5760320 142 * storage is set to that value when erased, and storage containing
kenjiArai 0:5b88d5760320 143 * that value can be programmed without another erase.
kenjiArai 0:5b88d5760320 144 *
kenjiArai 0:5b88d5760320 145 * @return The value of storage when erased, or -1 if you can't
kenjiArai 0:5b88d5760320 146 * rely on the value of erased storage
kenjiArai 0:5b88d5760320 147 */
kenjiArai 0:5b88d5760320 148 virtual int get_erase_value() const;
kenjiArai 0:5b88d5760320 149
kenjiArai 0:5b88d5760320 150 /** Get the total size of the underlying device
kenjiArai 0:5b88d5760320 151 *
kenjiArai 0:5b88d5760320 152 * @return Size of the underlying device in bytes
kenjiArai 0:5b88d5760320 153 */
kenjiArai 0:5b88d5760320 154 virtual bd_size_t size() const;
kenjiArai 0:5b88d5760320 155
kenjiArai 0:5b88d5760320 156 /** Get the underlying BlockDevice class type
kenjiArai 0:5b88d5760320 157 *
kenjiArai 0:5b88d5760320 158 * @return A string representing the underlying BlockDevice class type
kenjiArai 0:5b88d5760320 159 */
kenjiArai 0:5b88d5760320 160 virtual const char *get_type() const;
kenjiArai 0:5b88d5760320 161
kenjiArai 0:5b88d5760320 162 protected:
kenjiArai 0:5b88d5760320 163 BlockDevice *_bd;
kenjiArai 0:5b88d5760320 164 bd_size_t _bd_program_size;
kenjiArai 0:5b88d5760320 165 bd_size_t _bd_read_size;
kenjiArai 0:5b88d5760320 166 bd_size_t _bd_size;
kenjiArai 0:5b88d5760320 167 bd_size_t _write_cache_addr;
kenjiArai 0:5b88d5760320 168 bool _write_cache_valid;
kenjiArai 0:5b88d5760320 169 uint8_t *_write_cache;
kenjiArai 0:5b88d5760320 170 uint8_t *_read_buf;
kenjiArai 0:5b88d5760320 171 uint32_t _init_ref_count;
kenjiArai 0:5b88d5760320 172 bool _is_initialized;
kenjiArai 0:5b88d5760320 173
kenjiArai 0:5b88d5760320 174 #if !(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 175 /** Flush data in cache
kenjiArai 0:5b88d5760320 176 *
kenjiArai 0:5b88d5760320 177 * @return 0 on success or a negative error code on failure
kenjiArai 0:5b88d5760320 178 */
kenjiArai 0:5b88d5760320 179 int flush();
kenjiArai 0:5b88d5760320 180
kenjiArai 0:5b88d5760320 181 /** Invalidate write cache
kenjiArai 0:5b88d5760320 182 *
kenjiArai 0:5b88d5760320 183 * @return none
kenjiArai 0:5b88d5760320 184 */
kenjiArai 0:5b88d5760320 185 void invalidate_write_cache();
kenjiArai 0:5b88d5760320 186 #endif //#if !(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 187 };
kenjiArai 0:5b88d5760320 188 } // namespace mbed
kenjiArai 0:5b88d5760320 189
kenjiArai 0:5b88d5760320 190 // Added "using" for backwards compatibility
kenjiArai 0:5b88d5760320 191 #ifndef MBED_NO_GLOBAL_USING_DIRECTIVE
kenjiArai 0:5b88d5760320 192 using mbed::BufferedBlockDevice;
kenjiArai 0:5b88d5760320 193 #endif
kenjiArai 0:5b88d5760320 194
kenjiArai 0:5b88d5760320 195 #endif
kenjiArai 0:5b88d5760320 196
kenjiArai 0:5b88d5760320 197 /** @}*/