Lazily allocated heap-backed block device. More...
#include <HeapBlockDevice.h>
Public Member Functions | |
HeapBlockDevice (bd_size_t size, bd_size_t block=512) | |
Lifetime of the memory block device. More... | |
HeapBlockDevice (bd_size_t size, bd_size_t read, bd_size_t program, bd_size_t erase) | |
Lifetime of the memory block device. More... | |
virtual int | init () |
Initialize a block device. More... | |
virtual int | deinit () |
Deinitialize a block device. More... | |
virtual int | read (void *buffer, bd_addr_t addr, bd_size_t size) |
Read blocks from a block device. More... | |
virtual int | program (const void *buffer, bd_addr_t addr, bd_size_t size) |
Program blocks to a block device. More... | |
virtual int | erase (bd_addr_t addr, bd_size_t size) |
Erase blocks on a block device. More... | |
virtual bd_size_t | get_read_size () const |
Get the size of a readable block. More... | |
virtual bd_size_t | get_program_size () const |
Get the size of a programmable block. More... | |
virtual bd_size_t | get_erase_size () const |
Get the size of an erasable block. More... | |
virtual bd_size_t | get_erase_size (bd_addr_t addr) const |
Get the size of an erasable block given address. More... | |
virtual bd_size_t | size () const |
Get the total size of the underlying device. More... | |
virtual const char * | get_type () const |
Get the BlockDevice class type. More... | |
virtual int | sync () |
Ensure data on storage is in sync with the driver. More... | |
virtual int | trim (bd_addr_t addr, bd_size_t size) |
Mark blocks as no longer in use. More... | |
virtual int | get_erase_value () const |
Get the value of storage when erased. More... | |
virtual bool | is_valid_read (bd_addr_t addr, bd_size_t size) const |
Convenience function for checking block read validity. More... | |
virtual bool | is_valid_program (bd_addr_t addr, bd_size_t size) const |
Convenience function for checking block program validity. More... | |
virtual bool | is_valid_erase (bd_addr_t addr, bd_size_t size) const |
Convenience function for checking block erase validity. More... | |
Static Public Member Functions | |
static BlockDevice * | get_default_instance () |
Return the default block device. More... | |
Lazily allocated heap-backed block device.
Useful for simulating a block device and tests
Definition at line 59 of file HeapBlockDevice.h.
HeapBlockDevice | ( | bd_size_t | size, |
bd_size_t | block = 512 |
||
) |
Lifetime of the memory block device.
size | Size of the Block Device in bytes |
block | Block size in bytes. Minimum read, program, and erase sizes are configured to this value |
HeapBlockDevice | ( | bd_size_t | size, |
bd_size_t | read, | ||
bd_size_t | program, | ||
bd_size_t | erase | ||
) |
Lifetime of the memory block device.
size | Size of the Block Device in bytes |
read | Minimum read size required in bytes |
program | Minimum program size required in bytes |
erase | Minimum erase size required in bytes |
|
virtual |
Deinitialize a block device.
Implements BlockDevice.
|
virtual |
Erase blocks on a block device.
The state of an erased block is undefined until it has been programmed
addr | Address of block to begin erasing |
size | Size to erase in bytes, must be a multiple of erase block size |
Reimplemented from BlockDevice.
|
staticinherited |
Return the default block device.
Returns the default block device based on the configuration JSON. Use the components in target.json or application config to change the default block device.
An application can override all target settings by implementing BlockDevice::get_default_instance() - the default definition is weak, and calls get_target_default_instance().
|
virtual |
Get the size of an erasable block.
Reimplemented from BlockDevice.
|
virtual |
Get the size of an erasable block given address.
addr | Address within the erasable block |
Reimplemented from BlockDevice.
|
virtualinherited |
Get the value of storage when erased.
If get_erase_value returns a non-negative byte value, the underlying storage is set to that value when erased, and storage containing that value can be programmed without another erase.
Reimplemented in QSPIFBlockDevice, SPIFBlockDevice, MBRBlockDevice, ChainingBlockDevice, SPIFReducedBlockDevice, BufferedBlockDevice, ExhaustibleBlockDevice, SlicingBlockDevice, ProfilingBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
Definition at line 184 of file BlockDevice.h.
|
virtual |
Get the size of a programmable block.
Implements BlockDevice.
|
virtual |
|
virtual |
Get the BlockDevice class type.
Implements BlockDevice.
|
virtual |
Initialize a block device.
Implements BlockDevice.
|
virtualinherited |
Convenience function for checking block erase validity.
addr | Address of block to begin erasing |
size | Size to erase in bytes |
Reimplemented in SlicingBlockDevice.
Definition at line 229 of file BlockDevice.h.
|
virtualinherited |
Convenience function for checking block program validity.
addr | Address of block to begin writing to |
size | Size to write in bytes |
Reimplemented in SlicingBlockDevice.
Definition at line 215 of file BlockDevice.h.
|
virtualinherited |
Convenience function for checking block read validity.
addr | Address of block to begin reading from |
size | Size to read in bytes |
Reimplemented in SlicingBlockDevice.
Definition at line 201 of file BlockDevice.h.
|
virtual |
Program blocks to a block device.
The blocks must have been erased prior to being programmed
buffer | Buffer of data to write to blocks |
addr | Address of block to begin writing to |
size | Size to write in bytes, must be a multiple of program block size |
Implements BlockDevice.
|
virtual |
Read blocks from a block device.
buffer | Buffer to read blocks into |
addr | Address of block to begin reading from |
size | Size to read in bytes, must be a multiple of read block size |
Implements BlockDevice.
|
virtual |
Get the total size of the underlying device.
Implements BlockDevice.
|
virtualinherited |
Ensure data on storage is in sync with the driver.
Reimplemented in MBRBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.
Definition at line 82 of file BlockDevice.h.
|
virtualinherited |
Mark blocks as no longer in use.
This function provides a hint to the underlying block device that a region of blocks is no longer in use and may be erased without side effects. Erase must still be called before programming, but trimming allows flash-translation-layers to schedule erases when the device is not busy.
addr | Address of block to mark as unused |
size | Size to mark as unused in bytes, must be a multiple of the erase block size |
Reimplemented in SDBlockDevice, and BufferedBlockDevice.
Definition at line 136 of file BlockDevice.h.