The TLM2 transaction recorder. More...

#include <axi_recorder.h>

Inheritance diagram for axi::scv::axi_recorder< TYPES >:

[legend]

Collaboration diagram for axi::scv::axi_recorder< TYPES >:

[legend]

Public Types
template<unsigned int BUSWIDTH = 32, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using	initiator_socket_type = axi::axi_initiator_socket<BUSWIDTH, TYPES, N, POL>
template<unsigned int BUSWIDTH = 32, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using	target_socket_type = axi::axi_target_socket<BUSWIDTH, TYPES, N, POL>

Public Member Functions
virtual tlm::tlm_fw_transport_if< TYPES > *	get_fw_if ()=0
	the port where fw accesses are forwarded to
virtual tlm::tlm_bw_transport_if< TYPES > *	get_bw_if ()=0
	the port where bw accesses are forwarded to
	axi_recorder (const char name, unsigned bus_width, bool recording_enabled=true, SCVNS scv_tr_db tr_db=SCVNS scv_tr_db::get_default_db())
	The constructor of the component.
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.
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.
void	b_transport (typename TYPES::tlm_payload_type &trans, sc_core::sc_time &delay) override
	The blocking transport function.
bool	get_direct_mem_ptr (typename TYPES::tlm_payload_type &trans, tlm::tlm_dmi &dmi_data) override
	The direct memory interface forward function.
void	invalidate_direct_mem_ptr (sc_dt::uint64 start_addr, sc_dt::uint64 end_addr) override
	The direct memory interface backward function.
unsigned int	transport_dbg (typename TYPES::tlm_payload_type &trans) override
	The debug transportfunction.
bool	isRecordingBlockingTxEnabled () const
	get the current state of transaction recording
bool	isRecordingNonBlockingTxEnabled () const
	get the current state of transaction recording

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
cci::cci_param< bool >	enableTrDbgTracing {"enableTrDbgTracing", false}
	the attribute to selectively enable/disable transport dbg recording
cci::cci_param< bool >	enableProtocolChecker {"enableProtocolChecker", false}
	the attribute to enable/disable protocol checking
cci::cci_param< unsigned >	rd_response_timeout {"rd_response_timeout", 0}
cci::cci_param< unsigned >	wr_response_timeout {"wr_response_timeout", 0}

Protected Member Functions
void	initialize_streams ()

Detailed Description

template<typename TYPES = axi::axi_protocol_types>
class axi::scv::axi_recorder< TYPES >

The TLM2 transaction recorder.

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

Definition at line 50 of file axi_recorder.h.

Member Typedef Documentation

◆ initiator_socket_type

template<typename TYPES = axi::axi_protocol_types>

template<unsigned int BUSWIDTH = 32, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>

using axi::scv::axi_recorder< TYPES >::initiator_socket_type = axi::axi_initiator_socket<BUSWIDTH, TYPES, N, POL>

Definition at line 53 of file axi_recorder.h.

◆ target_socket_type

template<typename TYPES = axi::axi_protocol_types>

template<unsigned int BUSWIDTH = 32, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>

using axi::scv::axi_recorder< TYPES >::target_socket_type = axi::axi_target_socket<BUSWIDTH, TYPES, N, POL>

Definition at line 56 of file axi_recorder.h.

Constructor & Destructor Documentation

◆ axi_recorder()

template<typename TYPES = axi::axi_protocol_types>

axi::scv::axi_recorder< TYPES >::axi_recorder	(	const char *	name,
		unsigned	bus_width,
		bool	recording_enabled = true,
		SCVNS scv_tr_db *	tr_db = SCVNS scv_tr_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 scv_tr_db::set_default_db() ) recording is disabled.

Definition at line 94 of file axi_recorder.h.

◆ ~axi_recorder()

template<typename TYPES = axi::axi_protocol_types>

virtual axi::scv::axi_recorder< TYPES >::~axi_recorder ( )

inlineoverridevirtual

Definition at line 104 of file axi_recorder.h.

Member Function Documentation

◆ b_transport()

template<typename TYPES>

void axi::scv::axi_recorder< 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 290 of file axi_recorder.h.

◆ get_direct_mem_ptr()

template<typename TYPES>

bool axi::scv::axi_recorder< 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 568 of file axi_recorder.h.

◆ initialize_streams()

template<typename TYPES = axi::axi_protocol_types>

void axi::scv::axi_recorder< TYPES >::initialize_streams ( )

inlineprotected

Definition at line 234 of file axi_recorder.h.

◆ invalidate_direct_mem_ptr()

template<typename TYPES>

void axi::scv::axi_recorder< 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 587 of file axi_recorder.h.

◆ isRecordingBlockingTxEnabled()

template<typename TYPES = axi::axi_protocol_types>

bool axi::scv::axi_recorder< 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 187 of file axi_recorder.h.

◆ isRecordingNonBlockingTxEnabled()

template<typename TYPES = axi::axi_protocol_types>

bool axi::scv::axi_recorder< 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 193 of file axi_recorder.h.

◆ nb_transport_bw()

template<typename TYPES>

tlm::tlm_sync_enum axi::scv::axi_recorder< 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 428 of file axi_recorder.h.

◆ nb_transport_fw()

template<typename TYPES>

tlm::tlm_sync_enum axi::scv::axi_recorder< 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 346 of file axi_recorder.h.

◆ transport_dbg()

template<typename TYPES>

unsigned int axi::scv::axi_recorder< 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 604 of file axi_recorder.h.

Member Data Documentation

◆ enableBlTracing

template<typename TYPES = axi::axi_protocol_types>

cci::cci_param<bool> axi::scv::axi_recorder< TYPES >::enableBlTracing

the attribute to selectively enable/disable recording of blocking protocol tx

Definition at line 59 of file axi_recorder.h.

◆ enableDmiTracing

template<typename TYPES = axi::axi_protocol_types>

cci::cci_param<bool> axi::scv::axi_recorder< TYPES >::enableDmiTracing {"enableDmiTracing", false}

the attribute to selectively enable/disable DMI recording

Definition at line 68 of file axi_recorder.h.

◆ enableNbTracing

template<typename TYPES = axi::axi_protocol_types>

cci::cci_param<bool> axi::scv::axi_recorder< TYPES >::enableNbTracing

the attribute to selectively enable/disable recording of non-blocking protocol tx

Definition at line 62 of file axi_recorder.h.

◆ enableProtocolChecker

template<typename TYPES = axi::axi_protocol_types>

cci::cci_param<bool> axi::scv::axi_recorder< TYPES >::enableProtocolChecker {"enableProtocolChecker", false}

the attribute to enable/disable protocol checking

Definition at line 74 of file axi_recorder.h.

◆ enableTimedTracing

template<typename TYPES = axi::axi_protocol_types>

cci::cci_param<bool> axi::scv::axi_recorder< TYPES >::enableTimedTracing {"enableTimedTracing", true}

the attribute to selectively enable/disable timed recording

Definition at line 65 of file axi_recorder.h.

◆ enableTrDbgTracing

template<typename TYPES = axi::axi_protocol_types>

cci::cci_param<bool> axi::scv::axi_recorder< TYPES >::enableTrDbgTracing {"enableTrDbgTracing", false}

the attribute to selectively enable/disable transport dbg recording

Definition at line 71 of file axi_recorder.h.

◆ rd_response_timeout

template<typename TYPES = axi::axi_protocol_types>

cci::cci_param<unsigned> axi::scv::axi_recorder< TYPES >::rd_response_timeout {"rd_response_timeout", 0}

Definition at line 76 of file axi_recorder.h.

◆ wr_response_timeout

template<typename TYPES = axi::axi_protocol_types>

cci::cci_param<unsigned> axi::scv::axi_recorder< TYPES >::wr_response_timeout {"wr_response_timeout", 0}

Definition at line 78 of file axi_recorder.h.

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

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ initiator_socket_type

◆ target_socket_type

Constructor & Destructor Documentation

◆ axi_recorder()

◆ ~axi_recorder()

Member Function Documentation

◆ b_transport()

◆ get_direct_mem_ptr()

◆ initialize_streams()

◆ invalidate_direct_mem_ptr()

◆ isRecordingBlockingTxEnabled()

◆ isRecordingNonBlockingTxEnabled()

◆ nb_transport_bw()

◆ nb_transport_fw()

◆ transport_dbg()

Member Data Documentation

◆ enableBlTracing

◆ enableDmiTracing

◆ enableNbTracing

◆ enableProtocolChecker

◆ enableTimedTracing

◆ enableTrDbgTracing

◆ rd_response_timeout

◆ wr_response_timeout