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/HeapBlockDevice.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_MEM_BLOCK_DEVICE_H
dkato 0:f782d9c66c49 23 #define MBED_MEM_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 /** Lazily allocated heap-backed block device
dkato 0:f782d9c66c49 30 *
dkato 0:f782d9c66c49 31 * Useful for simulating a block device and tests
dkato 0:f782d9c66c49 32 *
dkato 0:f782d9c66c49 33 * @code
dkato 0:f782d9c66c49 34 * #include "mbed.h"
dkato 0:f782d9c66c49 35 * #include "HeapBlockDevice.h"
dkato 0:f782d9c66c49 36 *
dkato 0:f782d9c66c49 37 * HeapBlockDevice bd(2048, 512); // 2048 bytes with a block size of 512 bytes
dkato 0:f782d9c66c49 38 * uint8_t block[512] = "Hello World!\n";
dkato 0:f782d9c66c49 39 *
dkato 0:f782d9c66c49 40 * int main() {
dkato 0:f782d9c66c49 41 * bd.init();
dkato 0:f782d9c66c49 42 * bd.program(block, 0);
dkato 0:f782d9c66c49 43 * bd.read(block, 0);
dkato 0:f782d9c66c49 44 * printf("%s", block);
dkato 0:f782d9c66c49 45 * bd.deinit();
dkato 0:f782d9c66c49 46 * }
dkato 0:f782d9c66c49 47 */
dkato 0:f782d9c66c49 48 class HeapBlockDevice : public BlockDevice
dkato 0:f782d9c66c49 49 {
dkato 0:f782d9c66c49 50 public:
dkato 0:f782d9c66c49 51
dkato 0:f782d9c66c49 52 /** Lifetime of the memory block device
dkato 0:f782d9c66c49 53 */
dkato 0:f782d9c66c49 54 HeapBlockDevice(bd_size_t size, bd_size_t block=512);
dkato 0:f782d9c66c49 55 HeapBlockDevice(bd_size_t size, bd_size_t read, bd_size_t program, bd_size_t erase);
dkato 0:f782d9c66c49 56 virtual ~HeapBlockDevice();
dkato 0:f782d9c66c49 57
dkato 0:f782d9c66c49 58 /** Initialize a block device
dkato 0:f782d9c66c49 59 *
dkato 0:f782d9c66c49 60 * @return 0 on success or a negative error code on failure
dkato 0:f782d9c66c49 61 */
dkato 0:f782d9c66c49 62 virtual int init();
dkato 0:f782d9c66c49 63
dkato 0:f782d9c66c49 64 /** Deinitialize a block device
dkato 0:f782d9c66c49 65 *
dkato 0:f782d9c66c49 66 * @return 0 on success or a negative error code on failure
dkato 0:f782d9c66c49 67 */
dkato 0:f782d9c66c49 68 virtual int deinit();
dkato 0:f782d9c66c49 69
dkato 0:f782d9c66c49 70 /** Read blocks from a block device
dkato 0:f782d9c66c49 71 *
dkato 0:f782d9c66c49 72 * @param buffer Buffer to read blocks into
dkato 0:f782d9c66c49 73 * @param addr Address of block to begin reading from
dkato 0:f782d9c66c49 74 * @param size Size to read in bytes, must be a multiple of read block size
dkato 0:f782d9c66c49 75 * @return 0 on success, negative error code on failure
dkato 0:f782d9c66c49 76 */
dkato 0:f782d9c66c49 77 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
dkato 0:f782d9c66c49 78
dkato 0:f782d9c66c49 79 /** Program blocks to a block device
dkato 0:f782d9c66c49 80 *
dkato 0:f782d9c66c49 81 * The blocks must have been erased prior to being programmed
dkato 0:f782d9c66c49 82 *
dkato 0:f782d9c66c49 83 * @param buffer Buffer of data to write to blocks
dkato 0:f782d9c66c49 84 * @param addr Address of block to begin writing to
dkato 0:f782d9c66c49 85 * @param size Size to write in bytes, must be a multiple of program block size
dkato 0:f782d9c66c49 86 * @return 0 on success, negative error code on failure
dkato 0:f782d9c66c49 87 */
dkato 0:f782d9c66c49 88 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
dkato 0:f782d9c66c49 89
dkato 0:f782d9c66c49 90 /** Erase blocks on a block device
dkato 0:f782d9c66c49 91 *
dkato 0:f782d9c66c49 92 * The state of an erased block is undefined until it has been programmed
dkato 0:f782d9c66c49 93 *
dkato 0:f782d9c66c49 94 * @param addr Address of block to begin erasing
dkato 0:f782d9c66c49 95 * @param size Size to erase in bytes, must be a multiple of erase block size
dkato 0:f782d9c66c49 96 * @return 0 on success, negative error code on failure
dkato 0:f782d9c66c49 97 */
dkato 0:f782d9c66c49 98 virtual int erase(bd_addr_t addr, bd_size_t size);
dkato 0:f782d9c66c49 99
dkato 0:f782d9c66c49 100 /** Get the size of a readable block
dkato 0:f782d9c66c49 101 *
dkato 0:f782d9c66c49 102 * @return Size of a readable block in bytes
dkato 0:f782d9c66c49 103 */
dkato 0:f782d9c66c49 104 virtual bd_size_t get_read_size() const;
dkato 0:f782d9c66c49 105
dkato 0:f782d9c66c49 106 /** Get the size of a programable block
dkato 0:f782d9c66c49 107 *
dkato 0:f782d9c66c49 108 * @return Size of a programable block in bytes
dkato 0:f782d9c66c49 109 */
dkato 0:f782d9c66c49 110 virtual bd_size_t get_program_size() const;
dkato 0:f782d9c66c49 111
dkato 0:f782d9c66c49 112 /** Get the size of a eraseable block
dkato 0:f782d9c66c49 113 *
dkato 0:f782d9c66c49 114 * @return Size of a eraseable block in bytes
dkato 0:f782d9c66c49 115 */
dkato 0:f782d9c66c49 116 virtual bd_size_t get_erase_size() const;
dkato 0:f782d9c66c49 117
dkato 0:f782d9c66c49 118 /** Get the total size of the underlying device
dkato 0:f782d9c66c49 119 *
dkato 0:f782d9c66c49 120 * @return Size of the underlying device in bytes
dkato 0:f782d9c66c49 121 */
dkato 0:f782d9c66c49 122 virtual bd_size_t size() const;
dkato 0:f782d9c66c49 123
dkato 0:f782d9c66c49 124 private:
dkato 0:f782d9c66c49 125 bd_size_t _read_size;
dkato 0:f782d9c66c49 126 bd_size_t _program_size;
dkato 0:f782d9c66c49 127 bd_size_t _erase_size;
dkato 0:f782d9c66c49 128 bd_size_t _count;
dkato 0:f782d9c66c49 129 uint8_t **_blocks;
dkato 0:f782d9c66c49 130 };
dkato 0:f782d9c66c49 131
dkato 0:f782d9c66c49 132
dkato 0:f782d9c66c49 133 #endif