![]() |
Mbed OS Reference
|
Block device for allowing minimal read and program sizes (of 1) for the underlying BD, using a buffer on the heap. More...
#include <BufferedBlockDevice.h>
Public Member Functions | |
BufferedBlockDevice (BlockDevice *bd) | |
Lifetime of a memory-buffered block device wrapping an underlying block device. More... | |
virtual | ~BufferedBlockDevice () |
Lifetime of the memory-buffered block device. More... | |
virtual int | init () |
Initialize a buffered-memory block device and its underlying block device. More... | |
virtual int | deinit () |
Deinitialize the buffered-memory block device and its underlying block device. More... | |
virtual int | sync () |
Ensure that data on the underlying storage block device is in sync with the memory-buffered block device. More... | |
virtual int | read (void *buffer, bd_addr_t addr, bd_size_t size) |
Read blocks from the memory-buffered block device. More... | |
virtual int | program (const void *buffer, bd_addr_t addr, bd_size_t size) |
Program data to the memory-buffered block device. More... | |
virtual int | erase (bd_addr_t addr, bd_size_t size) |
Erase blocks from the memory-buffered 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 |
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 of a given address. More... | |
virtual int | get_erase_value () const |
Get the value of storage data after being erased. More... | |
virtual bd_size_t | size () const |
Get the total size of the underlying device. More... | |
virtual const char * | get_type () const |
Get the underlying BlockDevice class type. 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... | |
Block device for allowing minimal read and program sizes (of 1) for the underlying BD, using a buffer on the heap.
Definition at line 32 of file BufferedBlockDevice.h.
BufferedBlockDevice | ( | BlockDevice * | bd | ) |
Lifetime of a memory-buffered block device wrapping an underlying block device.
bd | Block device to back the BufferedBlockDevice |
|
virtual |
Lifetime of the memory-buffered block device.
|
virtual |
Initialize a buffered-memory block device and its underlying block device.
Implements BlockDevice.
|
virtual |
Deinitialize the buffered-memory block device and its underlying block device.
Implements BlockDevice.
|
virtual |
Ensure that data on the underlying storage block device is in sync with the memory-buffered block device.
Reimplemented from BlockDevice.
Read blocks from the memory-buffered 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.
Program data to the memory-buffered block device.
The write address blocks must be 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.
Erase blocks from the memory-buffered 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 erase block size |
Reimplemented from BlockDevice.
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 erase block size |
Reimplemented from BlockDevice.
|
virtual |
|
virtual |
Get the size of a programmable block.
Implements BlockDevice.
|
virtual |
Get the size of an erasable block.
Reimplemented from BlockDevice.
Get the size of an erasable block of a given address.
addr | Address within the erasable block |
Reimplemented from BlockDevice.
|
virtual |
Get the value of storage data after being 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 from BlockDevice.
|
virtual |
Get the total size of the underlying device.
Implements BlockDevice.
|
virtual |
Get the underlying BlockDevice class type.
Implements 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().
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 207 of file BlockDevice.h.
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 221 of file BlockDevice.h.
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 235 of file BlockDevice.h.