elftosb::EncoreBootImage::FillCommand Class Reference

Pattern fill bootloader command. More...

#include <EncoreBootImage.h>

Inheritance diagram for elftosb::EncoreBootImage::FillCommand:

Collaboration diagram for elftosb::EncoreBootImage::FillCommand:

Public Member Functions
	FillCommand ()
	Default constructor. 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.
Address range
void	setAddress (uint32_t address)
uint32_t	getAddress () const
void	setFillCount (uint32_t count)
uint32_t	getFillCount () const
Pattern
void	setPattern (uint8_t pattern)
void	setPattern (uint16_t pattern)
void	setPattern (uint32_t pattern)
uint32_t	getPattern () const
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_address
	Fill start address.
uint32_t	m_count
	Number of bytes to fill.
uint32_t	m_pattern
	Fill pattern.

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

Pattern fill bootloader command.

Constructor & Destructor Documentation

EncoreBootImage::FillCommand::FillCommand

(

)

Default constructor.

The pattern, address, and count are all initialized to zero, and the pattern size is set to a word.

Member Function Documentation

void EncoreBootImage::FillCommand::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.

Implements elftosb::EncoreBootImage::BootCommand.

void EncoreBootImage::FillCommand::setPattern

(

uint8_t

pattern

)

Extends the pattern across 32 bits.

void EncoreBootImage::FillCommand::setPattern

(

uint16_t

pattern

)

Extends the pattern across 32 bits.

---

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

• EncoreBootImage.h
• EncoreBootImage.cpp