Section tag bootloader command. More...

Inheritance diagram for elftosb::EncoreBootImage::TagCommand:

Collaboration diagram for elftosb::EncoreBootImage::TagCommand:

Public Member Functions
	TagCommand ()
	Default constructor.

	TagCommand (const Section &section)
	Constructor taking a section object. More...

virtual void	initFromData (const cipher_block_t blocks, unsigned count, unsigned consumed)
	Read the command contents from raw data. More...

virtual void	debugPrint () const
	Print out a string representation of the object.

Header
virtual uint8_t	getTag () const
	Returns the tag value for this command.

virtual void	fillCommandHeader (boot_command_t &header)
	Constructs the header for this boot command. More...

Field accessors
void	setSectionIdentifier (uint32_t identifier)

void	setSectionLength (uint32_t length)

void	setSectionFlags (uint32_t flags)

void	setLast (bool isLast)

Public Member Functions inherited from elftosb::EncoreBootImage::BootCommand
	BootCommand ()
	Default constructor.

virtual	~BootCommand ()
	Destructor.

virtual uint8_t	calculateChecksum (const boot_command_t &header)
	Calculates the checksum for the given command header. More...

virtual unsigned	getBlockCount () const
	Returns the total number of cipher blocks. More...

virtual unsigned	getBlocks (unsigned offset, unsigned maxCount, cipher_block_t *data)
	Returns the contents of up to maxCount cipher blocks. More...

virtual unsigned	getDataBlockCount () const
	Returns the number of data cipher blocks that follow this command. More...

virtual unsigned	getDataBlocks (unsigned offset, unsigned maxCount, cipher_block_t *data)
	Returns the contents of up to maxCount data blocks. More...

Cipher blocks

Protected Attributes
uint32_t	m_sectionIdentifier
	Unique identifier for the section containing this command.

uint32_t	m_sectionLength
	Number of cipher blocks this section occupies.

uint32_t	m_sectionFlags
	Flags pertaining to this section.

bool	m_isLast
	Is this the last tag command?

Additional Inherited Members
Static Public Member Functions inherited from elftosb::EncoreBootImage::BootCommand
static BootCommand *	createFromData (const cipher_block_t blocks, unsigned count, unsigned consumed)
	Creates the correct subclass of BootCommand for the given raw data. More...

Protected Types inherited from elftosb::EncoreBootImage::BootCommand
enum	{ CMD_TAG_FIELD = 1, CMD_FLAGS_FIELD = 2, CMD_ADDRESS_FIELD = 4, CMD_COUNT_FIELD = 8, CMD_DATA_FIELD = 16 }
	The flag bit values for the whichFields parameter of validateHeader().

Protected Member Functions inherited from elftosb::EncoreBootImage::BootCommand
void	validateHeader (const boot_command_t modelHeader, const boot_command_t testHeader, unsigned whichFields)

Detailed Description

Section tag bootloader command.

Constructor & Destructor Documentation

EncoreBootImage::TagCommand::TagCommand ( const Section & section )

Constructor taking a section object.

The identifier, length, and flags fields are taken from section.

void EncoreBootImage::TagCommand::fillCommandHeader ( boot_command_t & header )

virtual

Constructs the header for this boot command.

This method currently assumes that the next tag command will come immediately after the data for this section.

void EncoreBootImage::TagCommand::initFromData	(	const cipher_block_t *	blocks,
		unsigned	count,
		unsigned *	consumed
	)

virtual

Read the command contents from raw data.

Parameters

	blocks	Pointer to the raw data blocks.
	count	Number of blocks pointed to by blocks.
[out]	consumed	On exit, this points to the number of cipher blocks that were occupied by the command. Should be at least 1 for every command. This must not be NULL on entry!

Exceptions

std::runtime_error Thrown if header fields are invalid.

The documentation for this class was generated from the following files: