Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

features/filesystem/bd/ChainingBlockDevice.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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