Block device for managing a Master Boot Record https://en.wikipedia.org/wiki/Master_boot_record. More...

#include <MBRBlockDevice.h>

Inheritance diagram for MBRBlockDevice:

Public Member Functions
	MBRBlockDevice (BlockDevice *bd, int part)
	Lifetime of the block device. More...

virtual	~MBRBlockDevice ()
	Lifetime of the block device. More...

virtual int	init ()
	Initialize a block device. More...

virtual int	deinit ()
	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)
	Read blocks from a block device. More...

virtual int	program (const void *buffer, bd_addr_t addr, bd_size_t size)
	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 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 given address. More...

virtual int	get_erase_value () const
	Get the value of storage when erased. More...

virtual bd_size_t	size () const
	Get the total size of the underlying device. More...

virtual bd_addr_t	get_partition_start () const
	Get the offset of the partition on the underlying block device. More...

virtual bd_addr_t	get_partition_stop () const
	Get size of partition on underlying block device. More...

virtual uint8_t	get_partition_type () const
	Get 8-bit type of the partition. More...

virtual int	get_partition_number () const
	Get the partition number. More...

virtual const char *	get_type () const
	Get the BlockDevice class type. More...

virtual int	trim (bd_addr_t addr, bd_size_t size)
	Mark blocks as no longer in use. 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 int	partition (BlockDevice *bd, int part, uint8_t type, bd_addr_t start)
	Format the MBR to contain the following partition. More...

static int	partition (BlockDevice *bd, int part, uint8_t type, bd_addr_t start, bd_addr_t stop)
	Format the MBR to contain the following partition. More...

static BlockDevice *	get_default_instance ()
	Return the default block device. More...

Detailed Description

Block device for managing a Master Boot Record https://en.wikipedia.org/wiki/Master_boot_record.

Note

The MBR partition table is relatively limited:

At most 4 partitions are supported
Extended partitions are currently not supported and will error during init

Definition at line 45 of file MBRBlockDevice.h.

Constructor & Destructor Documentation

◆ MBRBlockDevice()

MBRBlockDevice	(	BlockDevice *	bd,
		int	part
	)

Lifetime of the block device.

Parameters

bd	Block device to back the MBRBlockDevice
part	Partition to use, 1-4

◆ ~MBRBlockDevice()

virtual ~MBRBlockDevice ( )

virtual

Lifetime of the block device.

Definition at line 90 of file MBRBlockDevice.h.

Member Function Documentation

◆ partition() [1/2]

static int partition	(	BlockDevice *	bd,
		int	part,
		uint8_t	type,
		bd_addr_t	start
	)

static

Format the MBR to contain the following partition.

Parameters

bd	Block device to partition
part	Partition to use, 1-4
type	8-bit partition type to specify the filesystem to use in this partition. It can be found in the filesystem documentation or refer to https://en.wikipedia.org/wiki/Partition_type#List_of_partition_IDs
start	Start block address to map to block 0 of partition. Negative addresses are calculated from the end of the underlying block devices. Block 0 is implicitly ignored from the range to store the MBR.

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

Note: This is the same as partition(bd, part, type, start, bd->size())

◆ partition() [2/2]

static int partition	(	BlockDevice *	bd,
		int	part,
		uint8_t	type,
		bd_addr_t	start,
		bd_addr_t	stop
	)

static

Format the MBR to contain the following partition.

Parameters

bd	Block device to partition
part	Partition to use, 1-4
type	8-bit partition type to specify the filesystem to use in this partition. It can be found in the filesystem documentation or refer to https://en.wikipedia.org/wiki/Partition_type#List_of_partition_IDs
start	Start block address to map to block 0 of partition, negative addresses are calculated from the end of the underlying block devices. Block 0 is implicitly ignored from the range to store the MBR.
stop	End block address to mark the end of the partition. This block is not mapped: negative addresses are calculated from the end of the underlying block device.

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

◆ init()

virtual int init ( )

virtual

Initialize a block device.

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

Implements BlockDevice.

◆ deinit()

virtual int deinit ( )

virtual

Deinitialize a block device.

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

Implements BlockDevice.

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

◆ read()

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

virtual

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.

◆ program()

virtual int program	(	const void *	buffer,
		bd_addr_t	addr,
		bd_size_t	size
	)

virtual

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.

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

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

Reimplemented from BlockDevice.

◆ get_read_size()

virtual bd_size_t get_read_size ( ) const

virtual

Get the size of a readable block.

Returns: Size of a readable block in bytes

Implements BlockDevice.

◆ get_program_size()

virtual bd_size_t get_program_size ( ) const

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

Implements BlockDevice.

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

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

◆ 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 erased storage

Reimplemented from BlockDevice.

◆ size()

virtual bd_size_t size ( ) const

virtual

Get the total size of the underlying device.

Returns: Size of the underlying device in bytes

Implements BlockDevice.

◆ get_partition_start()

virtual bd_addr_t get_partition_start ( ) const

virtual

Get the offset of the partition on the underlying block device.

Returns: Offset of the partition on the underlying device

◆ get_partition_stop()

virtual bd_addr_t get_partition_stop ( ) const

virtual

Get size of partition on underlying block device.

Returns: Size of the partition on the underlying device

◆ get_partition_type()

virtual uint8_t get_partition_type ( ) const

virtual

Get 8-bit type of the partition.

Returns: 8-bit type of partition assigned during format

◆ get_partition_number()

virtual int get_partition_number ( ) const

virtual

Get the partition number.

Returns: The partition number, 1-4

◆ get_type()

virtual const char * get_type ( ) const

virtual

Get the BlockDevice class type.

Returns: A string represent the BlockDevice class type.

Implements BlockDevice.

◆ get_default_instance()

static BlockDevice * get_default_instance ( )

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

◆ trim()

virtual int trim	(	bd_addr_t	addr,
		bd_size_t	size
	)

virtualinherited

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.

◆ is_valid_read()

virtual bool is_valid_read	(	bd_addr_t	addr,
		bd_size_t	size
	)		const

virtualinherited

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

virtualinherited

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

virtualinherited

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.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MBRBlockDevice()

◆ ~MBRBlockDevice()

Member Function Documentation

◆ partition() [1/2]

◆ partition() [2/2]

◆ init()

◆ deinit()

◆ sync()

◆ read()

◆ program()

◆ erase()

◆ get_read_size()

◆ get_program_size()

◆ get_erase_size() [1/2]

◆ get_erase_size() [2/2]

◆ get_erase_value()

◆ size()

◆ get_partition_start()

◆ get_partition_stop()

◆ get_partition_type()

◆ get_partition_number()

◆ get_type()

◆ get_default_instance()

◆ trim()

◆ is_valid_read()

◆ is_valid_program()

◆ is_valid_erase()