The TLM2 transaction recorder. More...

#include <tlm_recorder.h>

Inheritance diagram for tlm::scc::scv::tlm_recorder< TYPES >:

Collaboration diagram for tlm::scc::scv::tlm_recorder< TYPES >:

Public Types
using	recording_types = impl::tlm_recording_types< TYPES >

using	mm = tlm::scc::tlm_mm< recording_types >

using	tlm_recording_payload = impl::tlm_recording_payload< TYPES >

Public Member Functions
	tlm_recorder (sc_core::sc_port_b< tlm::tlm_fw_transport_if< TYPES >> &fw_port, sc_core::sc_port_b< tlm::tlm_bw_transport_if< TYPES >> &bw_port, bool recording_enabled=true, SCVNS scv_tr_db *tr_db=SCVNS scv_tr_db::get_default_db())

	tlm_recorder (const char name, sc_core::sc_port_b< tlm::tlm_fw_transport_if< TYPES >> &fw_port, sc_core::sc_port_b< tlm::tlm_bw_transport_if< TYPES >> &bw_port, bool recording_enabled=true, SCVNS scv_tr_db tr_db=SCVNS scv_tr_db::get_default_db())

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...

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...

void	initialize_streams ()

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

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

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

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

sc_core::sc_port_b< tlm::tlm_fw_transport_if< TYPES > > &	fw_port
	the port where fw accesses are forwarded to

sc_core::sc_port_b< tlm::tlm_bw_transport_if< TYPES > > &	bw_port
	the port where bw accesses are forwarded to

Detailed Description

template<typename TYPES = tlm::tlm_base_protocol_types>
class tlm::scc::scv::tlm_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 scv_tlm_recorder e.g. further down the opath can link to it.

Definition at line 81 of file tlm_recorder.h.

Member Function Documentation

◆ b_transport()

template<typename TYPES >

void tlm::scc::scv::tlm_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 342 of file tlm_recorder.h.

◆ get_direct_mem_ptr()

template<typename TYPES >

bool tlm::scc::scv::tlm_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 635 of file tlm_recorder.h.

◆ invalidate_direct_mem_ptr()

template<typename TYPES >

void tlm::scc::scv::tlm_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 653 of file tlm_recorder.h.

◆ isRecordingBlockingTxEnabled()

template<typename TYPES = tlm::tlm_base_protocol_types>

bool tlm::scc::scv::tlm_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 236 of file tlm_recorder.h.

◆ isRecordingNonBlockingTxEnabled()

template<typename TYPES = tlm::tlm_base_protocol_types>

bool tlm::scc::scv::tlm_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 242 of file tlm_recorder.h.

◆ nb_transport_bw()

template<typename TYPES >

tlm::tlm_sync_enum tlm::scc::scv::tlm_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 512 of file tlm_recorder.h.

◆ nb_transport_fw()

template<typename TYPES >

tlm::tlm_sync_enum tlm::scc::scv::tlm_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 427 of file tlm_recorder.h.

◆ transport_dbg()

template<typename TYPES >

unsigned int tlm::scc::scv::tlm_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 670 of file tlm_recorder.h.

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

/home/eyck/git/SystemC-Components/src/sysc/tlm/scc/scv/tlm_recorder.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

template<typename TYPES = tlm::tlm_base_protocol_types> class tlm::scc::scv::tlm_recorder< TYPES >

Member Function Documentation

◆ b_transport()

◆ get_direct_mem_ptr()

◆ invalidate_direct_mem_ptr()

◆ isRecordingBlockingTxEnabled()

◆ isRecordingNonBlockingTxEnabled()

◆ nb_transport_bw()

◆ nb_transport_fw()

◆ transport_dbg()

template<typename TYPES = tlm::tlm_base_protocol_types>
class tlm::scc::scv::tlm_recorder< TYPES >