mirror of https://github.com/ARMmbed/mbed-os.git
143 lines
4.6 KiB
C++
143 lines
4.6 KiB
C++
/* mbed Microcontroller Library
|
|
* Copyright (c) 2018 ARM Limited
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*/
|
|
#ifndef MBED_FLASH_SIM_BLOCK_DEVICE_H
|
|
#define MBED_FLASH_SIM_BLOCK_DEVICE_H
|
|
|
|
#include "BlockDevice.h"
|
|
|
|
enum {
|
|
BD_ERROR_NOT_ERASED = -3201,
|
|
};
|
|
|
|
/** Flash simulating block device
|
|
*
|
|
* Flash simulation BD adaptor
|
|
*
|
|
*/
|
|
class FlashSimBlockDevice : public BlockDevice {
|
|
public:
|
|
|
|
/** Constructor
|
|
*
|
|
* @param bd Block device to back the FlashSimBlockDevice
|
|
* @param erase_value Value stored in a block after it's erased
|
|
*/
|
|
FlashSimBlockDevice(BlockDevice *bd, uint8_t erase_value = 0xFF);
|
|
virtual ~FlashSimBlockDevice();
|
|
|
|
/** Initialize a block device
|
|
*
|
|
* @return 0 on success or a negative error code on failure
|
|
*/
|
|
virtual int init();
|
|
|
|
/** Deinitialize the block device
|
|
*
|
|
* @return 0 on success or a negative error code on failure
|
|
*/
|
|
virtual int deinit();
|
|
|
|
/** Ensure data on storage is in sync with the driver
|
|
*
|
|
* @return 0 on success or a negative error code on failure
|
|
*/
|
|
virtual int sync();
|
|
|
|
/** Read blocks from the block device
|
|
*
|
|
* @param buffer Buffer to read blocks into
|
|
* @param addr Address of block to begin reading from
|
|
* @param size Size to read in bytes, must be a multiple of read block size
|
|
* @return 0 on success, negative error code on failure
|
|
*/
|
|
virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
|
|
|
|
/** Program blocks to the block device
|
|
*
|
|
* The blocks must have been erased prior to being programmed
|
|
*
|
|
* @param buffer Buffer of data to write to blocks
|
|
* @param addr Address of block to begin writing to
|
|
* @param size Size to write in bytes, must be a multiple of program block size
|
|
* @return 0 on success, negative error code on failure
|
|
*/
|
|
virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
|
|
|
|
/** Erase blocks on the block device
|
|
*
|
|
* Required before any write to these addresses
|
|
*
|
|
* @param addr Address of block to begin erasing
|
|
* @param size Size to erase in bytes, must be a multiple of erase block size
|
|
* @return 0 on success, negative error code on failure
|
|
*/
|
|
virtual int erase(bd_addr_t addr, bd_size_t size);
|
|
|
|
/** Get the size of a readable block
|
|
*
|
|
* @return Size of a readable block in bytes
|
|
*/
|
|
virtual bd_size_t get_read_size() const;
|
|
|
|
/** Get the size of a programmable block
|
|
*
|
|
* @return Size of a programmable block in bytes
|
|
*/
|
|
virtual bd_size_t get_program_size() const;
|
|
|
|
/** Get the size of an erasable block
|
|
*
|
|
* @return Size of an erasable block in bytes
|
|
*/
|
|
virtual bd_size_t get_erase_size() const;
|
|
|
|
/** Get the size of an erasable block given address
|
|
*
|
|
* @param addr Address within the erasable block
|
|
* @return Size of an erasable block in bytes
|
|
* @note Must be a multiple of the program size
|
|
*/
|
|
virtual bd_size_t get_erase_size(bd_addr_t addr) const;
|
|
|
|
/** Get the value of storage when erased
|
|
*
|
|
* @return The value of storage when erased
|
|
*/
|
|
virtual int get_erase_value() const;
|
|
|
|
/** Get the total size of the underlying device
|
|
*
|
|
* @return Size of the underlying device in bytes
|
|
*/
|
|
virtual bd_size_t size() const;
|
|
|
|
private:
|
|
uint8_t _erase_value;
|
|
bd_size_t _blank_buf_size;
|
|
uint8_t *_blank_buf;
|
|
BlockDevice *_bd;
|
|
uint32_t _init_ref_count;
|
|
bool _is_initialized;
|
|
};
|
|
|
|
#endif
|