#include <axi_tlm.h>

Inheritance diagram for axi::request:

[legend]

Public Member Functions
	request ()=default
	the default constructor
void	reset ()
	reset all data member to their default
void	set_length (uint8_t)
	set the AxLEN value of the transaction, the value denotes the burst length - 1
uint8_t	get_length () const
	get the AxLEN value of the transaction, the value denotes the burst length - 1
void	set_size (uint8_t)
	get the AxSIZE value of the transaction, the length is 2^size. It needs to be less than 10 (512 bit width)
uint8_t	get_size () const
	set the AxSIZE value of the transaction
void	set_burst (burst_e)
	set the AxBURST value,
burst_e	get_burst () const
	get the AxBURST value,
void	set_prot (uint8_t)
	set the AxPROT value as POD, only values from 0...7 are allowed
uint8_t	get_prot () const
	set the AxPROT value as POD, only values from 0...7 are allowed
void	set_privileged (bool=true)
	set the privileged bit of the AxPROT (AxPROT[0])
bool	is_privileged () const
	get the privileged bit of the AxPROT (AxPROT[0])
void	set_non_secure (bool=true)
	set the non-secure bit of the AxPROT (AxPROT[1])
bool	is_non_secure () const
	set the non-secure bit of the AxPROT (AxPROT[1])
void	set_instruction (bool=true)
	set the instruction bit of the AxPROT (AxPROT[2])
bool	is_instruction () const
	set the instruction bit of the AxPROT (AxPROT[2])
void	set_cache (uint8_t)
	set the AxCACHE value as POD, only value from 0..15 are allowed
uint8_t	get_cache () const
	get the AxCACHE value as POD
void	set_qos (uint8_t)
	set the AxQOS (quality of service) value
uint8_t	get_qos () const
	get the AxQOS (quality of service) value
void	set_region (uint8_t)
	set the AxREGION value
uint8_t	get_region () const
	get the AxREGION value
void	set_atop (uint8_t)
	set the raw AWATOP value
uint8_t	get_atop () const
	get the raw AWATOP value return the unique value
void	set_stash_nid (uint8_t)
	set the raw AWSTASHNID value
uint8_t	get_stash_nid () const
	get the raw AWSTASHNID value return the unique value
bool	is_stash_nid_en () const
	check if AWSTASHNID is valid return the valid value
void	set_stash_lpid (uint8_t)
	set the raw AWSTASHLPID value
uint8_t	get_stash_lpid () const
	get the raw AWSTASHLPID value return the unique value
bool	is_stash_lpid_en () const
	check if AWSTASHLPID is valid return the valid value

Protected Types
enum	{ BUFFERABLE = 1 , CACHEABLE = 2 , RA = 4 , WA = 8 , EXCL = 1 , LOCKED = 2 , PRIVILEGED = 1 , SECURE = 2 , INSTRUCTION = 4 }

Protected Member Functions
request &	operator= (const request &o)

Protected Attributes
bool	unique {false}
uint8_t	length {0}
uint8_t	size {0}
burst_e	burst {burst_e::FIXED}
uint8_t	prot {0}
uint8_t	qos {0}
uint8_t	region {0}
domain_e	domain {domain_e::NON_SHAREABLE}
snoop_e	snoop {snoop_e::READ_NO_SNOOP}
bar_e	barrier {bar_e::RESPECT_BARRIER}
lock_e	lock {lock_e::NORMAL}
uint8_t	cache {0}
uint8_t	atop {0}
uint16_t	stash_nid {std::numeric_limits<uint16_t>::max()}
uint8_t	stash_lpid {std::numeric_limits<uint8_t>::max()}

Detailed Description

The request part of AXI3, AXI4 and ACE transactions. All member data are stored in this class to allow easy reuse of free'd memory and prevent memory fragmentation. The request class holds the data in a similar representation than in the HW implementation. Derived classes are not expected to add data member, they only add interpretation of bits and fields as member functions

Definition at line 204 of file axi_tlm.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Definition at line 373 of file axi_tlm.h.

Member Function Documentation

◆ get_atop()

uint8_t axi::request::get_atop ( ) const

inline

get the raw AWATOP value return the unique value

Definition at line 1531 of file axi_tlm.h.

◆ get_burst()

burst_e axi::request::get_burst ( ) const

inline

get the AxBURST value,

See also: burst_e

Returns

Definition at line 1465 of file axi_tlm.h.

◆ get_cache()

uint8_t axi::request::get_cache ( ) const

inline

get the AxCACHE value as POD

Returns: the cache value

Definition at line 1511 of file axi_tlm.h.

◆ get_length()

uint8_t axi::request::get_length ( ) const

inline

get the AxLEN value of the transaction, the value denotes the burst length - 1

Returns: the AxLEN value

Definition at line 1454 of file axi_tlm.h.

◆ get_prot()

uint8_t axi::request::get_prot ( ) const

inline

set the AxPROT value as POD, only values from 0...7 are allowed

Returns: the prot value

Definition at line 1472 of file axi_tlm.h.

◆ get_qos()

uint8_t axi::request::get_qos ( ) const

inline

get the AxQOS (quality of service) value

Returns: the qos value

Definition at line 1500 of file axi_tlm.h.

◆ get_region()

uint8_t axi::request::get_region ( ) const

inline

get the AxREGION value

Returns: the region value

Definition at line 1504 of file axi_tlm.h.

◆ get_size()

uint8_t axi::request::get_size ( ) const

inline

set the AxSIZE value of the transaction

Returns: AxSIZE value

Definition at line 1461 of file axi_tlm.h.

◆ get_stash_lpid()

uint8_t axi::request::get_stash_lpid ( ) const

inline

get the raw AWSTASHLPID value return the unique value

Definition at line 1541 of file axi_tlm.h.

◆ get_stash_nid()

uint8_t axi::request::get_stash_nid ( ) const

inline

get the raw AWSTASHNID value return the unique value

Definition at line 1535 of file axi_tlm.h.

◆ is_instruction()

bool axi::request::is_instruction ( ) const

inline

set the instruction bit of the AxPROT (AxPROT[2])

Returns: the instruction bit

Definition at line 1496 of file axi_tlm.h.

◆ is_non_secure()

bool axi::request::is_non_secure ( ) const

inline

set the non-secure bit of the AxPROT (AxPROT[1])

Returns: the non-secure bit

Definition at line 1488 of file axi_tlm.h.

◆ is_privileged()

bool axi::request::is_privileged ( ) const

inline

get the privileged bit of the AxPROT (AxPROT[0])

Returns: the privileged value

Definition at line 1480 of file axi_tlm.h.

◆ is_stash_lpid_en()

bool axi::request::is_stash_lpid_en ( ) const

inline

check if AWSTASHLPID is valid return the valid value

Definition at line 1543 of file axi_tlm.h.

◆ is_stash_nid_en()

bool axi::request::is_stash_nid_en ( ) const

inline

check if AWSTASHNID is valid return the valid value

Definition at line 1537 of file axi_tlm.h.

◆ operator=()

request & axi::request::operator= ( const request & o )

inlineprotected

equal operator

Parameters

o

Returns: reference to self

Definition at line 356 of file axi_tlm.h.

◆ reset()

void axi::request::reset ( )

inline

reset all data member to their default

Definition at line 1436 of file axi_tlm.h.

◆ set_atop()

void axi::request::set_atop ( uint8_t atop )

inline

set the raw AWATOP value

Parameters

the	atop value

Definition at line 1529 of file axi_tlm.h.

◆ set_burst()

void axi::request::set_burst ( burst_e burst )

inline

set the AxBURST value,

See also: burst_e

Parameters

the burst

Definition at line 1463 of file axi_tlm.h.

◆ set_cache()

void axi::request::set_cache ( uint8_t cache )

inline

set the AxCACHE value as POD, only value from 0..15 are allowed

Parameters

the	cache value

Definition at line 1506 of file axi_tlm.h.

◆ set_instruction()

void axi::request::set_instruction ( bool instr = true )

inline

set the instruction bit of the AxPROT (AxPROT[2])

Parameters

the	instruction bit

Definition at line 1490 of file axi_tlm.h.

◆ set_length()

void axi::request::set_length ( uint8_t length )

inline

set the AxLEN value of the transaction, the value denotes the burst length - 1

Parameters

the len value

Definition at line 1452 of file axi_tlm.h.

◆ set_non_secure()

void axi::request::set_non_secure ( bool non_sec = true )

inline

set the non-secure bit of the AxPROT (AxPROT[1])

Parameters

the	non-secure bit

Definition at line 1482 of file axi_tlm.h.

◆ set_privileged()

void axi::request::set_privileged ( bool privileged = true )

inline

set the privileged bit of the AxPROT (AxPROT[0])

Parameters

the	privileged value

Definition at line 1474 of file axi_tlm.h.

◆ set_prot()

void axi::request::set_prot ( uint8_t prot )

inline

set the AxPROT value as POD, only values from 0...7 are allowed

Parameters

the	prot value

Definition at line 1467 of file axi_tlm.h.

◆ set_qos()

void axi::request::set_qos ( uint8_t qos )

inline

set the AxQOS (quality of service) value

Parameters

the qos value

Definition at line 1498 of file axi_tlm.h.

◆ set_region()

void axi::request::set_region ( uint8_t region )

inline

set the AxREGION value

Parameters

the	region value

Definition at line 1502 of file axi_tlm.h.

◆ set_size()

void axi::request::set_size ( uint8_t size )

inline

get the AxSIZE value of the transaction, the length is 2^size. It needs to be less than 10 (512 bit width)

Parameters

size	value of AxSIZE

Definition at line 1456 of file axi_tlm.h.

◆ set_stash_lpid()

void axi::request::set_stash_lpid ( uint8_t stash_lpid )

inline

set the raw AWSTASHLPID value

Parameters

the	atop value

Definition at line 1539 of file axi_tlm.h.

◆ set_stash_nid()

void axi::request::set_stash_nid ( uint8_t stash_nid )

inline

set the raw AWSTASHNID value

Parameters

the	atop value

Definition at line 1533 of file axi_tlm.h.

Member Data Documentation

◆ atop

uint8_t axi::request::atop {0}

protected

Definition at line 397 of file axi_tlm.h.

◆ barrier

bar_e axi::request::barrier {bar_e::RESPECT_BARRIER}

protected

Definition at line 394 of file axi_tlm.h.

◆ burst

burst_e axi::request::burst {burst_e::FIXED}

protected

Definition at line 388 of file axi_tlm.h.

◆ cache

uint8_t axi::request::cache {0}

protected

Definition at line 396 of file axi_tlm.h.

◆ domain

domain_e axi::request::domain {domain_e::NON_SHAREABLE}

protected

Definition at line 392 of file axi_tlm.h.

◆ length

uint8_t axi::request::length {0}

protected

Definition at line 386 of file axi_tlm.h.

◆ lock

lock_e axi::request::lock {lock_e::NORMAL}

protected

Definition at line 395 of file axi_tlm.h.

◆ prot

uint8_t axi::request::prot {0}

protected

Definition at line 389 of file axi_tlm.h.

◆ qos

uint8_t axi::request::qos {0}

protected

Definition at line 390 of file axi_tlm.h.

◆ region

uint8_t axi::request::region {0}

protected

Definition at line 391 of file axi_tlm.h.

◆ size

uint8_t axi::request::size {0}

protected

Definition at line 387 of file axi_tlm.h.

◆ snoop

snoop_e axi::request::snoop {snoop_e::READ_NO_SNOOP}

protected

Definition at line 393 of file axi_tlm.h.

◆ stash_lpid

uint8_t axi::request::stash_lpid {std::numeric_limits<uint8_t>::max()}

protected

Definition at line 399 of file axi_tlm.h.

◆ stash_nid

uint16_t axi::request::stash_nid {std::numeric_limits<uint16_t>::max()}

protected

Definition at line 398 of file axi_tlm.h.

◆ unique

bool axi::request::unique {false}

protected

Definition at line 384 of file axi_tlm.h.

The documentation for this struct was generated from the following file:

/home/eyck/Projects/MINRES/SystemC-Components/third_party/axi_chi/axi/axi_tlm.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ get_atop()

◆ get_burst()

◆ get_cache()

◆ get_length()

◆ get_prot()

◆ get_qos()

◆ get_region()

◆ get_size()

◆ get_stash_lpid()

◆ get_stash_nid()

◆ is_instruction()

◆ is_non_secure()

◆ is_privileged()

◆ is_stash_lpid_en()

◆ is_stash_nid_en()

◆ operator=()

◆ reset()

◆ set_atop()

◆ set_burst()

◆ set_cache()

◆ set_instruction()

◆ set_length()

◆ set_non_secure()

◆ set_privileged()

◆ set_prot()

◆ set_qos()

◆ set_region()

◆ set_size()

◆ set_stash_lpid()

◆ set_stash_nid()

Member Data Documentation

◆ atop

◆ barrier

◆ burst

◆ cache

◆ domain

◆ length

◆ lock

◆ prot

◆ qos

◆ region

◆ size

◆ snoop

◆ stash_lpid

◆ stash_nid

◆ unique