Lifetime of the memory block device.

Parameters

bd	Block device to back the SlicingBlockDevice
start	Start block address to map to block 0, negative addresses are calculated from the end of the underlying block device
end	End block address to mark the end of the block device, this block is not mapped, negative addresses are calculated from the end of the underlying block device. The default stops at end of the underlying block device.

Lifetime of a block device.

Definition at line 52 of file SlicingBlockDevice.h.

Deinitialize a block device.

Returns

0 on success or a negative error code on failure

Implements BlockDevice.

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 erase block size

Returns

0 on success or a negative error code on failure

Reimplemented from BlockDevice.

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

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

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

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

Get the size of a programmable block.

Returns

Size of a programmable block in bytes

Note

Must be a multiple of the read size

Implements BlockDevice.

Get the size of a readable block.

Returns

Size of a readable block in bytes

Implements BlockDevice.

Get the BlockDevice class type.

Returns

A string represent the BlockDevice class type.

Implements BlockDevice.

Initialize a block device.

Returns

0 on success or a negative error code on failure

Implements BlockDevice.

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

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

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

Program blocks to a block device.

The blocks must have been erased prior to being programmed

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 program block size

Returns

0 on success or a negative error code on failure

Implements BlockDevice.

Read blocks from a block device.

Parameters

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

Returns

0 on success or a negative error code on failure

Implements BlockDevice.

Get the total size of the underlying device.

Returns

Size of the underlying device in bytes

Implements BlockDevice.

Ensure data on storage is in sync with the driver.

Returns

0 on success or a negative error code on failure

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.

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 SDBlockDevice, and BufferedBlockDevice.

Definition at line 136 of file BlockDevice.h.