Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
BlockDevice Class Referenceabstract

#include <BlockDevice.h>

Inheritance diagram for BlockDevice:
BufferedBlockDevice ChainingBlockDevice ExhaustibleBlockDevice FlashSimBlockDevice HeapBlockDevice MBRBlockDevice ObservingBlockDevice ProfilingBlockDevice ReadOnlyBlockDevice SlicingBlockDevice

Public Member Functions

virtual ~BlockDevice ()
 
virtual int init ()=0
 
virtual int deinit ()=0
 
virtual int sync ()
 
virtual int read (void *buffer, bd_addr_t addr, bd_size_t size)=0
 
virtual int program (const void *buffer, bd_addr_t addr, bd_size_t size)=0
 
virtual int erase (bd_addr_t addr, bd_size_t size)
 
virtual int trim (bd_addr_t addr, bd_size_t size)
 
virtual bd_size_t get_read_size () const =0
 
virtual bd_size_t get_program_size () const =0
 
virtual bd_size_t get_erase_size () const
 
virtual bd_size_t get_erase_size (bd_addr_t addr) const
 
virtual int get_erase_value () const
 
virtual bd_size_t size () const =0
 
bool is_valid_read (bd_addr_t addr, bd_size_t size) const
 
bool is_valid_program (bd_addr_t addr, bd_size_t size) const
 
bool is_valid_erase (bd_addr_t addr, bd_size_t size) const
 

Detailed Description

A hardware device capable of writing and reading blocks

Constructor & Destructor Documentation

virtual BlockDevice::~BlockDevice ( )
inlinevirtual

Lifetime of a block device

Member Function Documentation

virtual int BlockDevice::deinit ( )
pure virtual

Deinitialize a block device

Returns
0 on success or a negative error code on failure

Implemented in MBRBlockDevice, ChainingBlockDevice, HeapBlockDevice, SlicingBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.

virtual int BlockDevice::erase ( bd_addr_t  addr,
bd_size_t  size 
)
inlinevirtual

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

Parameters
addrAddress of block to begin erasing
sizeSize to erase in bytes, must be a multiple of erase block size
Returns
0 on success, negative error code on failure

Reimplemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, HeapBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.

virtual bd_size_t BlockDevice::get_erase_size ( ) const
inlinevirtual

Get the size of an erasable block

Returns
Size of an erasable block in bytes
Note
Must be a multiple of the program size

Reimplemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, HeapBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, and ReadOnlyBlockDevice.

virtual bd_size_t BlockDevice::get_erase_size ( bd_addr_t  addr) const
inlinevirtual

Get the size of an erasable block given address

Parameters
addrAddress within the erasable block
Returns
Size of an erasable block in bytes
Note
Must be a multiple of the program size

Reimplemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, HeapBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, and ReadOnlyBlockDevice.

virtual int BlockDevice::get_erase_value ( ) const
inlinevirtual

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.

Returns
The value of storage when erased, or -1 if you can't rely on the value of erased storage

Reimplemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, and ReadOnlyBlockDevice.

virtual bd_size_t BlockDevice::get_program_size ( ) const
pure virtual

Get the size of a programmable block

Returns
Size of a programmable block in bytes
Note
Must be a multiple of the read size

Implemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, HeapBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, and ReadOnlyBlockDevice.

virtual bd_size_t BlockDevice::get_read_size ( ) const
pure virtual
virtual int BlockDevice::init ( )
pure virtual
bool BlockDevice::is_valid_erase ( bd_addr_t  addr,
bd_size_t  size 
) const
inline

Convenience function for checking block erase validity

Parameters
addrAddress of block to begin erasing
sizeSize to erase in bytes
Returns
True if erase is valid for underlying block device
bool BlockDevice::is_valid_program ( bd_addr_t  addr,
bd_size_t  size 
) const
inline

Convenience function for checking block program validity

Parameters
addrAddress of block to begin writing to
sizeSize to write in bytes
Returns
True if program is valid for underlying block device
bool BlockDevice::is_valid_read ( bd_addr_t  addr,
bd_size_t  size 
) const
inline

Convenience function for checking block read validity

Parameters
addrAddress of block to begin reading from
sizeSize to read in bytes
Returns
True if read is valid for underlying block device
virtual int BlockDevice::program ( const void *  buffer,
bd_addr_t  addr,
bd_size_t  size 
)
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

Parameters
bufferBuffer of data to write to blocks
addrAddress of block to begin writing to
sizeSize to write in bytes, must be a multiple of program block size
Returns
0 on success, negative error code on failure

Implemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, HeapBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.

virtual int BlockDevice::read ( void *  buffer,
bd_addr_t  addr,
bd_size_t  size 
)
pure virtual

Read blocks from a block device

If a failure occurs, it is not possible to determine how many bytes succeeded

Parameters
bufferBuffer to write blocks to
addrAddress of block to begin reading from
sizeSize to read in bytes, must be a multiple of read block size
Returns
0 on success, negative error code on failure

Implemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, HeapBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.

virtual bd_size_t BlockDevice::size ( ) const
pure virtual

Get the total size of the underlying device

Returns
Size of the underlying device in bytes

Implemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, HeapBlockDevice, ObservingBlockDevice, FlashSimBlockDevice, and ReadOnlyBlockDevice.

virtual int BlockDevice::sync ( )
inlinevirtual

Ensure data on storage is in sync with the driver

Returns
0 on success or a negative error code on failure

Reimplemented in MBRBlockDevice, ChainingBlockDevice, SlicingBlockDevice, ProfilingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.

virtual int BlockDevice::trim ( bd_addr_t  addr,
bd_size_t  size 
)
inlinevirtual

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.

Parameters
addrAddress of block to mark as unused
sizeSize to mark as unused in bytes, must be a multiple of erase block size
Returns
0 on success, negative error code on failure

Reimplemented in BufferedBlockDevice.


The documentation for this class was generated from the following file:
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.