A hardware device capable of writing and reading blocks. More...

#include <BlockDevice.h>

Inheritance diagram for BlockDevice:

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...

Detailed Description

A hardware device capable of writing and reading blocks.

Definition at line 53 of file BlockDevice.h.

Constructor & Destructor Documentation

◆ ~BlockDevice()

virtual ~BlockDevice ( )

virtual

Lifetime of a block device.

Definition at line 70 of file BlockDevice.h.

Member Function Documentation

◆ get_default_instance()

static BlockDevice * get_default_instance ( )

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().

◆ init()

virtual int init ( )

pure virtual

Initialize a block device.

Returns: 0 on success or a negative error code on failure

Implemented in DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

◆ deinit()

virtual int deinit ( )

pure virtual

Deinitialize a block device.

Returns: 0 on success or a negative error code on failure

Implemented in DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

◆ sync()

virtual int sync ( )

virtual

Ensure data on storage is in sync with the driver.

Returns: 0 on success or a negative error code on failure

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

Definition at line 88 of file BlockDevice.h.

◆ read()

virtual int 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

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

Returns: 0 on success or a negative error code on failure

Implemented in BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SDBlockDevice, SPIFBlockDevice, and FlashIAPBlockDevice.

◆ program()

virtual int 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

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

Returns: 0 on success or a negative error code on failure

Implemented in BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SDBlockDevice, SPIFBlockDevice, and FlashIAPBlockDevice.

◆ erase()

virtual int erase	(	bd_addr_t	addr,
		bd_size_t	size
	)

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

Parameters

addr	Address of block to begin erasing
size	Size to erase in bytes, must be a multiple of the erase block size

Returns: 0 on success or a negative error code on failure

Reimplemented in BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SPIFBlockDevice, and FlashIAPBlockDevice.

Definition at line 126 of file BlockDevice.h.

◆ trim()

virtual int trim	(	bd_addr_t	addr,
		bd_size_t	size
	)

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.

Parameters

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

Returns: 0 on success or a negative error code on failure

Reimplemented in BufferedBlockDevice, and SDBlockDevice.

Definition at line 142 of file BlockDevice.h.

◆ get_read_size()

virtual bd_size_t get_read_size ( ) const

pure virtual

Get the size of a readable block.

Returns: Size of a readable block in bytes

Implemented in DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

◆ get_program_size()

virtual bd_size_t 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 DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

◆ get_erase_size() [1/2]

virtual bd_size_t get_erase_size ( ) const

virtual

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 DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

Definition at line 165 of file BlockDevice.h.

◆ get_erase_size() [2/2]

virtual bd_size_t get_erase_size ( bd_addr_t addr ) const

virtual

Get the size of an erasable block given address.

Parameters

addr	Address within the erasable block

Returns: Size of an erasable block in bytes

Note: Must be a multiple of the program size

Reimplemented in BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, DataFlashBlockDevice, QSPIFBlockDevice, SPIFBlockDevice, and FlashIAPBlockDevice.

Definition at line 176 of file BlockDevice.h.

◆ get_erase_value()

virtual int get_erase_value ( ) const

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.

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

Reimplemented in OSPIFBlockDevice, QSPIFBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

Definition at line 190 of file BlockDevice.h.

◆ size()

virtual bd_size_t size ( ) const

pure virtual

Get the total size of the underlying device.

Returns: Size of the underlying device in bytes

Implemented in DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

◆ is_valid_read()

virtual bool is_valid_read	(	bd_addr_t	addr,
		bd_size_t	size
	)		const

virtual

Convenience function for checking block read validity.

Parameters

addr	Address of block to begin reading from
size	Size to read in bytes

Returns: True if read is valid for underlying block device

Reimplemented in SlicingBlockDevice.

Definition at line 207 of file BlockDevice.h.

◆ is_valid_program()

virtual bool is_valid_program	(	bd_addr_t	addr,
		bd_size_t	size
	)		const

virtual

Convenience function for checking block program validity.

Parameters

addr	Address of block to begin writing to
size	Size to write in bytes

Returns: True if program is valid for underlying block device

Reimplemented in SlicingBlockDevice.

Definition at line 221 of file BlockDevice.h.

◆ is_valid_erase()

virtual bool is_valid_erase	(	bd_addr_t	addr,
		bd_size_t	size
	)		const

virtual

Convenience function for checking block erase validity.

Parameters

addr	Address of block to begin erasing
size	Size to erase in bytes

Returns: True if erase is valid for underlying block device

Reimplemented in SlicingBlockDevice, and FlashIAPBlockDevice.

Definition at line 235 of file BlockDevice.h.

◆ get_type()

virtual const char * get_type ( ) const

pure virtual

Get the BlockDevice class type.

Returns: A string represent the BlockDevice class type.

Implemented in DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~BlockDevice()

Member Function Documentation

◆ get_default_instance()

◆ init()

◆ deinit()

◆ sync()

◆ read()

◆ program()

◆ erase()

◆ trim()

◆ get_read_size()

◆ get_program_size()

◆ get_erase_size() [1/2]

◆ get_erase_size() [2/2]

◆ get_erase_value()

◆ size()

◆ is_valid_read()

◆ is_valid_program()

◆ is_valid_erase()

◆ get_type()