The TLM2 transaction recorder. More...

#include <chi_lwtr.h>

Inheritance diagram for chi::lwtr::chi_lwtr< TYPES >:

[legend]

Collaboration diagram for chi::lwtr::chi_lwtr< TYPES >:

[legend]

Public Member Functions
	chi_lwtr (char const full_name, unsigned bus_width, bool recording_enabled=true, tx_db tr_db=tx_db::get_default_db())
	The constructor of the component. More...

tlm::tlm_sync_enum	nb_transport_fw (typename TYPES::tlm_payload_type &trans, typename TYPES::tlm_phase_type &phase, sc_core::sc_time &delay) override
	The non-blocking forward transport function. More...

tlm::tlm_sync_enum	nb_transport_bw (typename TYPES::tlm_payload_type &trans, typename TYPES::tlm_phase_type &phase, sc_core::sc_time &delay) override
	The non-blocking backward transport function. More...

void	b_transport (typename TYPES::tlm_payload_type &trans, sc_core::sc_time &delay) override
	The blocking transport function. More...

void	b_snoop (typename TYPES::tlm_payload_type &trans, sc_core::sc_time &delay) override
	The blocking snoop function. More...

bool	get_direct_mem_ptr (typename TYPES::tlm_payload_type &trans, tlm::tlm_dmi &dmi_data) override
	The direct memory interface forward function. More...

void	invalidate_direct_mem_ptr (sc_dt::uint64 start_addr, sc_dt::uint64 end_addr) override
	The direct memory interface backward function. More...

unsigned int	transport_dbg (typename TYPES::tlm_payload_type &trans) override
	The debug transportfunction. More...

bool	isRecordingBlockingTxEnabled () const
	get the current state of transaction recording More...

bool	isRecordingNonBlockingTxEnabled () const
	get the current state of transaction recording More...

Public Member Functions inherited from chi::bw_blocking_transport_if< TRANS >
virtual void	b_snoop (TRANS &trans, sc_core::sc_time &t)=0
	snoop access to a snooped master More...

Public Attributes
cci::cci_param< bool >	enableBlTracing
	the attribute to selectively enable/disable recording of blocking protocol tx

cci::cci_param< bool >	enableNbTracing
	the attribute to selectively enable/disable recording of non-blocking protocol tx

cci::cci_param< bool >	enableTimedTracing {"enableTimedTracing", true}
	the attribute to selectively enable/disable timed recording

cci::cci_param< bool >	enableDmiTracing {"enableDmiTracing", false}
	the attribute to selectively enable/disable DMI recording

Protected Member Functions
void	initialize_streams ()

Protected Attributes
sc_core::sc_port< chi::chi_fw_transport_if< TYPES > >	fw_port {"fw_port"}
	the port where fw accesses are forwarded to

sc_core::sc_port< chi::chi_bw_transport_if< TYPES > >	bw_port {"bw_port"}
	the port where bw accesses are forwarded to

Detailed Description

template<typename TYPES = chi::chi_protocol_types>
class chi::lwtr::chi_lwtr< TYPES >

The TLM2 transaction recorder.

This module records all TLM transaction to a LWTR transaction fiber for further viewing and analysis. The handle of the created transaction is stored in an tlm_extension so that another instance of the chi_lwtr e.g. further down the path can link to it.

Definition at line 64 of file chi_lwtr.h.

Constructor & Destructor Documentation

◆ chi_lwtr()

template<typename TYPES = chi::chi_protocol_types>

chi::lwtr::chi_lwtr< TYPES >::chi_lwtr	(	char const *	full_name,
		unsigned	bus_width,
		bool	recording_enabled = `true`,
		tx_db *	tr_db = `tx_db::get_default_db()`
	)

inline

The constructor of the component.

Parameters

name	is the SystemC module name of the recorder
tr_db	is a pointer to a transaction recording database. If none is provided the default one is retrieved. If this database is not initialized (e.g. by not calling lwtr::set_default_db() ) recording is disabled.

Definition at line 86 of file chi_lwtr.h.

Member Function Documentation

◆ b_snoop()

template<typename TYPES >

void chi::lwtr::chi_lwtr< TYPES >::b_snoop	(	typename TYPES::tlm_payload_type &	trans,
		sc_core::sc_time &	delay
	)

override

The blocking snoop function.

This type of transaction is forwarded and recorded to a transaction stream named "b_tx" with current timestamps. Additionally a "b_tx_timed" is been created recording the transactions at their annotated delay

Parameters

trans	is the generic payload of the transaction
delay	is the annotated delay

Definition at line 402 of file chi_lwtr.h.

◆ b_transport()

template<typename TYPES >

void chi::lwtr::chi_lwtr< TYPES >::b_transport	(	typename TYPES::tlm_payload_type &	trans,
		sc_core::sc_time &	delay
	)

override

The blocking transport function.

This type of transaction is forwarded and recorded to a transaction stream named "b_tx" with current timestamps. Additionally a "b_tx_timed" is been created recording the transactions at their annotated delay

Parameters

trans	is the generic payload of the transaction
delay	is the annotated delay

Definition at line 337 of file chi_lwtr.h.

◆ get_direct_mem_ptr()

template<typename TYPES >

bool chi::lwtr::chi_lwtr< TYPES >::get_direct_mem_ptr	(	typename TYPES::tlm_payload_type &	trans,
		tlm::tlm_dmi &	dmi_data
	)

override

The direct memory interface forward function.

This type of transaction is just forwarded and not recorded.

Parameters

trans	is the generic payload of the transaction
dmi_data	is the structure holding the dmi information

Returns: if the dmi structure is valid

Definition at line 727 of file chi_lwtr.h.

◆ invalidate_direct_mem_ptr()

template<typename TYPES >

void chi::lwtr::chi_lwtr< TYPES >::invalidate_direct_mem_ptr	(	sc_dt::uint64	start_addr,
		sc_dt::uint64	end_addr
	)

override

The direct memory interface backward function.

This type of transaction is just forwarded and not recorded.

Parameters

start_addr	is the start address of the memory area being invalid
end_addr	is the end address of the memory area being invalid

Definition at line 744 of file chi_lwtr.h.

◆ isRecordingBlockingTxEnabled()

template<typename TYPES = chi::chi_protocol_types>

bool chi::lwtr::chi_lwtr< TYPES >::isRecordingBlockingTxEnabled ( ) const

inline

get the current state of transaction recording

Returns: if true transaction recording is enabled otherwise transaction recording is bypassed

Definition at line 194 of file chi_lwtr.h.

◆ isRecordingNonBlockingTxEnabled()

template<typename TYPES = chi::chi_protocol_types>

bool chi::lwtr::chi_lwtr< TYPES >::isRecordingNonBlockingTxEnabled ( ) const

inline

get the current state of transaction recording

Returns: if true transaction recording is enabled otherwise transaction recording is bypassed

Definition at line 200 of file chi_lwtr.h.

◆ nb_transport_bw()

template<typename TYPES >

tlm::tlm_sync_enum chi::lwtr::chi_lwtr< TYPES >::nb_transport_bw	(	typename TYPES::tlm_payload_type &	trans,
		typename TYPES::tlm_phase_type &	phase,
		sc_core::sc_time &	delay
	)

override

The non-blocking backward transport function.

This type of transaction is forwarded and recorded to a transaction stream named "nb_bw" with current timestamps.

Parameters

trans	is the generic payload of the transaction
phase	is the current phase of the transaction
delay	is the annotated delay

Returns: the sync state of the transaction

Definition at line 549 of file chi_lwtr.h.

◆ nb_transport_fw()

template<typename TYPES >

tlm::tlm_sync_enum chi::lwtr::chi_lwtr< TYPES >::nb_transport_fw	(	typename TYPES::tlm_payload_type &	trans,
		typename TYPES::tlm_phase_type &	phase,
		sc_core::sc_time &	delay
	)

override

The non-blocking forward transport function.

This type of transaction is forwarded and recorded to a transaction stream named "nb_fw" with current timestamps.

Parameters

trans	is the generic payload of the transaction
phase	is the current phase of the transaction
delay	is the annotated delay

Returns: the sync state of the transaction

Definition at line 463 of file chi_lwtr.h.

◆ transport_dbg()

template<typename TYPES >

unsigned int chi::lwtr::chi_lwtr< TYPES >::transport_dbg ( typename TYPES::tlm_payload_type & trans )

override

The debug transportfunction.

This type of transaction is just forwarded and not recorded.

Parameters

trans is the generic payload of the transaction

Returns: the sync state of the transaction

Definition at line 760 of file chi_lwtr.h.

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

/home/eyck/git/SystemC-Components/third_party/axi_chi/chi/lwtr/chi_lwtr.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<typename TYPES = chi::chi_protocol_types> class chi::lwtr::chi_lwtr< TYPES >

Constructor & Destructor Documentation

◆ chi_lwtr()

Member Function Documentation

◆ b_snoop()

◆ b_transport()

◆ get_direct_mem_ptr()

◆ invalidate_direct_mem_ptr()

◆ isRecordingBlockingTxEnabled()

◆ isRecordingNonBlockingTxEnabled()

◆ nb_transport_bw()

◆ nb_transport_fw()

◆ transport_dbg()

template<typename TYPES = chi::chi_protocol_types>
class chi::lwtr::chi_lwtr< TYPES >