MemoryMap

class MemoryMap

Represents the layout of memory for a target system, including sections and segments.

DEFINITION

class MemoryMap;

class Block

DEFINITION

class Block;

constructor Block

DEFINITION

Block	(	uint64_t bank,
		uint64_t start,
		uint64_t size	);

PARAMETER	DESCRIPTION
`bank`
`start`
`size`

method operator<const

DEFINITION

bool operator<

(

const Block & other

) const;

PARAMETER	DESCRIPTION
`other`

RETURNS	DESCRIPTION
`bool`

method operator==const

DEFINITION

bool operator==

(

const Block & other

) const;

PARAMETER	DESCRIPTION
`other`

RETURNS	DESCRIPTION
`bool`

member bank

DEFINITION

uint64_t bank;

member range

DEFINITION

Range range;

class Section

DEFINITION

class Section;

constructor Section

DEFINITION

Section

(

);

constructor Section

DEFINITION

Section	(	Symbol name,
		AccessType access,
		std::vector< Block > raw_blocks	);

PARAMETER	DESCRIPTION
`name`
`access`
`raw_blocks`

method add_blocks

DEFINITION

void add_blocks

(

std::vector< Block > raw_blocks

);

PARAMETER	DESCRIPTION
`raw_blocks`

method clear

DEFINITION

void clear

(

);

method emptyconst

DEFINITION

bool empty

(

) const;

RETURNS	DESCRIPTION
`bool`

method maximum_addressconst

DEFINITION

uint64_t maximum_address

(

) const;

RETURNS	DESCRIPTION
`uint64_t`

method minimum_addressconst

DEFINITION

uint64_t minimum_address

(

) const;

RETURNS	DESCRIPTION
`uint64_t`

method operator<const

DEFINITION

bool operator<

(

const Section & other

) const;

PARAMETER	DESCRIPTION
`other`

RETURNS	DESCRIPTION
`bool`

member access

DEFINITION

AccessType access;

member blocks

DEFINITION

std::vector< Block > blocks;

member name

DEFINITION

Symbol name;

member size

DEFINITION

size_t size;

enum AccessType

DEFINITION

enum AccessType;

VALUE	DESCRIPTION
`RESERVE_ONLY`
`READ_ONLY`
`READ_WRITE`

method access_type_lessstatic

DEFINITION

static bool access_type_less	(	AccessType a,
		AccessType b	);

PARAMETER	DESCRIPTION
`a`
`b`

RETURNS	DESCRIPTION
`bool`

method add_section

DEFINITION

void add_section

(

Section section

);

PARAMETER	DESCRIPTION
`section`

method add_segment

DEFINITION

void add_segment	(	Symbol name,
		std::vector< Block > segment	);

PARAMETER	DESCRIPTION
`name`
`segment`

method has_sectionconst

DEFINITION

bool has_section

(

Symbol name

) const;

PARAMETER	DESCRIPTION
`name`

RETURNS	DESCRIPTION
`bool`

method initialize_memoryconst

DEFINITION

Memory initialize_memory

(

) const;

RETURNS	DESCRIPTION
`Memory`

method is_abstractconst

DEFINITION

bool is_abstract

(

) const;

RETURNS	DESCRIPTION
`bool`

method is_compatible_withconst

DEFINITION

bool is_compatible_with

(

const MemoryMap & other

) const;

PARAMETER	DESCRIPTION
`other`

RETURNS	DESCRIPTION
`bool`

method sectionconst

DEFINITION

const Section * section

(

Symbol name

) const;

PARAMETER	DESCRIPTION
`name`

RETURNS	DESCRIPTION
`const Section *`

method segmentconst

DEFINITION

const std::vector< Block > * segment

(

Symbol name

) const;

PARAMETER	DESCRIPTION
`name`

RETURNS	DESCRIPTION
`const std::vector< Block > *`

member fill_byte

DEFINITION

uint8_t fill_byte;

member sections

DEFINITION

std::unordered_map< Symbol, Section > sections;

member segments

DEFINITION

std::unordered_map< Symbol, std::vector< Block > > segments;

class Block

DEFINITION

class Block;

constructor Block

DEFINITION

Block	(	uint64_t bank,
		uint64_t start,
		uint64_t size	);

PARAMETER	DESCRIPTION
`bank`
`start`
`size`

method operator<const

DEFINITION

bool operator<

(

const Block & other

) const;

PARAMETER	DESCRIPTION
`other`

RETURNS	DESCRIPTION
`bool`

method operator==const

DEFINITION

bool operator==

(

const Block & other

) const;

PARAMETER	DESCRIPTION
`other`

RETURNS	DESCRIPTION
`bool`

member bank

DEFINITION

uint64_t bank;

member range

DEFINITION

Range range;

class Section

DEFINITION

class Section;

constructor Section

DEFINITION

Section

(

);

constructor Section

DEFINITION

Section	(	Symbol name,
		AccessType access,
		std::vector< Block > raw_blocks	);

PARAMETER	DESCRIPTION
`name`
`access`
`raw_blocks`

method add_blocks

DEFINITION

void add_blocks

(

std::vector< Block > raw_blocks

);

PARAMETER	DESCRIPTION
`raw_blocks`

method clear

DEFINITION

void clear

(

);

method emptyconst

DEFINITION

bool empty

(

) const;

RETURNS	DESCRIPTION
`bool`

method maximum_addressconst

DEFINITION

uint64_t maximum_address

(

) const;

RETURNS	DESCRIPTION
`uint64_t`

method minimum_addressconst

DEFINITION

uint64_t minimum_address

(

) const;

RETURNS	DESCRIPTION
`uint64_t`

method operator<const

DEFINITION

bool operator<

(

const Section & other

) const;

PARAMETER	DESCRIPTION
`other`

RETURNS	DESCRIPTION
`bool`

member access

DEFINITION

AccessType access;

member blocks

DEFINITION

std::vector< Block > blocks;

member name

DEFINITION

Symbol name;

member size

DEFINITION

size_t size;