A hardware device capable of writing and reading blocks. More...
#include <BlockDevice.h>
Public Member Functions | |
virtual | ~BlockDevice () |
Lifetime of a block device. More... | |
virtual int | init ()=0 |
Initialize a block device. More... | |
virtual int | deinit ()=0 |
Deinitialize a block device. More... | |
virtual int | sync () |
Ensure data on storage is in sync with the driver. More... | |
virtual int | read (void *buffer, bd_addr_t addr, bd_size_t size)=0 |
Read blocks from a block device. More... | |
virtual int | program (const void *buffer, bd_addr_t addr, bd_size_t size)=0 |
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 int | trim (bd_addr_t addr, bd_size_t size) |
Mark blocks as no longer in use. More... | |
virtual bd_size_t | get_read_size () const =0 |
Get the size of a readable block. More... | |
virtual bd_size_t | get_program_size () const =0 |
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 int | get_erase_value () const |
Get the value of storage when erased. More... | |
virtual bd_size_t | size () const =0 |
Get the total size of the underlying device. 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... | |
virtual const char * | get_type () const =0 |
Get the BlockDevice class type. More... | |
Static Public Member Functions | |
static BlockDevice * | get_default_instance () |
Return the default block device. More... | |
A hardware device capable of writing and reading blocks.
Definition at line 48 of file BlockDevice.h.
|
virtual |
Lifetime of a block device.
Definition at line 65 of file BlockDevice.h.
|
pure virtual |
Deinitialize a block device.
Implemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, SDBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, FlashIAPBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.
|
virtual |
Erase blocks on a block device.
The state of an erased block is undefined until it has been programmed, unless get_erase_value returns a non-negative byte value
addr | Address of block to begin erasing |
size | Size to erase in bytes, must be a multiple of the erase block size |
Reimplemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, BufferedBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
Definition at line 121 of file BlockDevice.h.
|
static |
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 in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ProfilingBlockDevice, ObservingBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
Definition at line 160 of file BlockDevice.h.
|
virtual |
Get the size of an erasable block given address.
addr | Address within the erasable block |
Reimplemented in QSPIFBlockDevice, SPIFBlockDevice, DataFlashBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ProfilingBlockDevice, ObservingBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
Definition at line 171 of file BlockDevice.h.
|
virtual |
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 OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, MBRBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, SlicingBlockDevice, ProfilingBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
Definition at line 185 of file BlockDevice.h.
|
pure virtual |
Get the size of a programmable block.
Implemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, SDBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
|
pure virtual |
Get the size of a readable block.
Implemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, SDBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
|
pure virtual |
Get the BlockDevice class type.
Implemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, MBRBlockDevice, SDBlockDevice, DataFlashBlockDevice, ChainingBlockDevice, I2CEEBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, HeapBlockDevice, SlicingBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
|
pure virtual |
Initialize a block device.
Implemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, SDBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, FlashIAPBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.
|
virtual |
Convenience function for checking block erase validity.
addr | Address of block to begin erasing |
size | Size to erase in bytes |
Reimplemented in SlicingBlockDevice, and FlashIAPBlockDevice.
Definition at line 230 of file BlockDevice.h.
|
virtual |
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 216 of file BlockDevice.h.
|
virtual |
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 202 of file BlockDevice.h.
|
pure virtual |
Program blocks to a block device.
The blocks must have been erased prior to being programmed
If a failure occurs, it is not possible to determine how many bytes succeeded
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 the program block size |
Implemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, SDBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, BufferedBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
|
pure virtual |
Read blocks from a block device.
If a failure occurs, it is not possible to determine how many bytes succeeded
buffer | Buffer to write blocks to |
addr | Address of block to begin reading from |
size | Size to read in bytes, must be a multiple of the read block size |
Implemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, SDBlockDevice, MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, ExhaustibleBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, BufferedBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
|
pure virtual |
Get the total size of the underlying device.
Implemented in OSPIFBlockDevice, QSPIFBlockDevice, SPINANDBlockDevice, SPIFBlockDevice, MBRBlockDevice, DataFlashBlockDevice, SDBlockDevice, ChainingBlockDevice, I2CEEBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, HeapBlockDevice, SlicingBlockDevice, ProfilingBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.
|
virtual |
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 83 of file BlockDevice.h.
|
virtual |
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 137 of file BlockDevice.h.