The TLM2 transaction recorder. More...

#include <ace_recorder.h>

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

[legend]

Collaboration diagram for axi::scv::ace_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::ace_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::ace_target_socket<BUSWIDTH, TYPES, N, POL>

Public Member Functions
virtual axi::ace_fw_transport_if< TYPES > *	get_fw_if ()=0
	the port where fw accesses are forwarded to
virtual axi::ace_bw_transport_if< TYPES > *	get_bw_if ()=0
	the port where bw accesses are forwarded to
	ace_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.
void	b_snoop (typename TYPES::tlm_payload_type &trans, sc_core::sc_time &delay) override
	The blocking snoop 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 Member Functions inherited from axi::bw_blocking_transport_if< axi::axi_protocol_types::tlm_payload_type >
virtual void	b_snoop (axi::axi_protocol_types::tlm_payload_type &trans, sc_core::sc_time &t)=0
	snoop access to a snooped master

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::ace_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 ace_recorder e.g. further down the path can link to it.

Definition at line 48 of file ace_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::ace_recorder< TYPES >::initiator_socket_type = axi::ace_initiator_socket<BUSWIDTH, TYPES, N, POL>

Definition at line 51 of file ace_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::ace_recorder< TYPES >::target_socket_type = axi::ace_target_socket<BUSWIDTH, TYPES, N, POL>

Definition at line 54 of file ace_recorder.h.

Constructor & Destructor Documentation

◆ ace_recorder()

template<typename TYPES = axi::axi_protocol_types>

axi::scv::ace_recorder< TYPES >::ace_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 92 of file ace_recorder.h.

◆ ~ace_recorder()

template<typename TYPES = axi::axi_protocol_types>

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

inlineoverridevirtual

Definition at line 101 of file ace_recorder.h.

Member Function Documentation

◆ b_snoop()

template<typename TYPES>

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

◆ b_transport()

template<typename TYPES>

void axi::scv::ace_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 289 of file ace_recorder.h.

◆ get_direct_mem_ptr()

template<typename TYPES>

bool axi::scv::ace_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 639 of file ace_recorder.h.

◆ initialize_streams()

template<typename TYPES = axi::axi_protocol_types>

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

inlineprotected

Definition at line 239 of file ace_recorder.h.

◆ invalidate_direct_mem_ptr()

template<typename TYPES>

void axi::scv::ace_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 657 of file ace_recorder.h.

◆ isRecordingBlockingTxEnabled()

template<typename TYPES = axi::axi_protocol_types>

bool axi::scv::ace_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 192 of file ace_recorder.h.

◆ isRecordingNonBlockingTxEnabled()

template<typename TYPES = axi::axi_protocol_types>

bool axi::scv::ace_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 198 of file ace_recorder.h.

◆ nb_transport_bw()

template<typename TYPES>

tlm::tlm_sync_enum axi::scv::ace_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 493 of file ace_recorder.h.

◆ nb_transport_fw()

template<typename TYPES>

tlm::tlm_sync_enum axi::scv::ace_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 408 of file ace_recorder.h.

◆ transport_dbg()

template<typename TYPES>

unsigned int axi::scv::ace_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 674 of file ace_recorder.h.

Member Data Documentation

◆ enableBlTracing

template<typename TYPES = axi::axi_protocol_types>

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

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

Definition at line 57 of file ace_recorder.h.

◆ enableDmiTracing

template<typename TYPES = axi::axi_protocol_types>

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

the attribute to selectively enable/disable DMI recording

Definition at line 66 of file ace_recorder.h.

◆ enableNbTracing

template<typename TYPES = axi::axi_protocol_types>

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

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

Definition at line 60 of file ace_recorder.h.

◆ enableProtocolChecker

template<typename TYPES = axi::axi_protocol_types>

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

the attribute to enable/disable protocol checking

Definition at line 72 of file ace_recorder.h.

◆ enableTimedTracing

template<typename TYPES = axi::axi_protocol_types>

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

the attribute to selectively enable/disable timed recording

Definition at line 63 of file ace_recorder.h.

◆ enableTrDbgTracing

template<typename TYPES = axi::axi_protocol_types>

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

the attribute to selectively enable/disable transport dbg recording

Definition at line 69 of file ace_recorder.h.

◆ rd_response_timeout

template<typename TYPES = axi::axi_protocol_types>

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

Definition at line 74 of file ace_recorder.h.

◆ wr_response_timeout

template<typename TYPES = axi::axi_protocol_types>

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

Definition at line 76 of file ace_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/ace_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

◆ ace_recorder()

◆ ~ace_recorder()

Member Function Documentation

◆ b_snoop()

◆ 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