amba_pv::amba_pv_simple_probe< BUSWIDTH > Class Template Reference

Inherits amba_pv::amba_pv_fw_transport_if, and amba_pv::amba_pv_bw_transport_if.

---

Detailed Description

template<unsigned int BUSWIDTH = 64>
class amba_pv::amba_pv_simple_probe< BUSWIDTH >

AMBA-PV simple probe component.

The amba_pv_simple_probe class prints the contents of transaction between a master and a slave to std::cout, a file, or a stream.

Parameters:

BUSWIDTH

bus width in bits as one of 8, 16, 32, 64, 128, 256, 512, or 1024. Defaults to 64.

Public Member Functions
	amba_pv_simple_probe (const sc_core::sc_module_name &, bool=true)
	Constructor.
	amba_pv_simple_probe (const sc_core::sc_module_name &, const std::string &, bool=true)
	Constructor.
	amba_pv_simple_probe (const sc_core::sc_module_name &, std::ostream &, bool=true)
	Constructor.
virtual	~amba_pv_simple_probe ()
	Destructor.
virtual const char *	kind () const
	Returns the kind string of this probe.
virtual void	b_transport (int, amba_pv_transaction &, sc_core::sc_time &)
	Completes a transaction and prints its contents to std::cout.
virtual unsigned int	transport_dbg (int, amba_pv_transaction &)
	Debug access to a target.
virtual bool	get_direct_mem_ptr (int, amba_pv_transaction &, tlm::tlm_dmi &)
	Requests a DMI access based on the specified transaction.
virtual void	invalidate_direct_mem_ptr (int, sc_dt::uint64, sc_dt::uint64)
	Invalidates DMI pointers previously established for the specified DMI region.
void	set_verbose (bool=true)
	Sets verbosity of this probe.
void	set_out_file (const std::string &)
	Sets the file transactions are printed to.
void	set_out_file (std::ostream &)
	Sets the stream transactions are printed to.
void	set_trans_verbose (bool=true)
	Sets verbosity of this probe.
void	set_transport_verbose (bool=true)
	Sets verbosity of this probe with regard to b_transport() regular transactions.
bool	is_transport_verbose () const
	Gets verbosity of this probe with regard to b_transport() regular transactions.
void	set_debug_verbose (bool=true)
	Sets verbosity of this probe with regard to transport_dbg() debug transactions.
bool	is_debug_verbose () const
	Gets verbosity of this probe with regard to transport_dbg() debug transactions.
void	set_dmi_verbose (bool=true)
	Sets verbosity of this probe with regard to DMI transactions.
bool	is_dmi_verbose () const
	Gets verbosity of this probe with regard to DMI transactions.
void	set_data_verbose (bool=true)
	Sets verbosity of this probe with regard to transactions data.
bool	is_data_verbose () const
	Gets verbosity of this probe with regard to transactions data.
Data Fields
amba_pv_slave_socket< BUSWIDTH >	amba_pv_s
	Slave socket.
amba_pv_master_socket< BUSWIDTH >	amba_pv_m
	Master socket.

---

Constructor & Destructor Documentation

template<unsigned int BUSWIDTH>

amba_pv::amba_pv_simple_probe< BUSWIDTH >::amba_pv_simple_probe	(	const sc_core::sc_module_name &	name,
		bool	trans_verbose = true
	)			[inline, explicit]

Constructor.

Parameters:

	name	probe name.
	trans_verbose	true to print transactions (default), false otherwise.

See also:

set_trans_verbose()

template<unsigned int BUSWIDTH>

amba_pv::amba_pv_simple_probe< BUSWIDTH >::amba_pv_simple_probe	(	const sc_core::sc_module_name &	name,
		const std::string &	file,
		bool	trans_verbose = true
	)			[inline]

Constructor.

Constructs a new amba_pv_simple_probe that prints transactions to the specified file.

Note:

The file will be truncated.

Parameters:

	name	probe name.
	file	file transactions are printed to.
	trans_verbose	true to print transactions (default), false otherwise.

See also:

set_out_file(), set_trans_verbose()

template<unsigned int BUSWIDTH>

amba_pv::amba_pv_simple_probe< BUSWIDTH >::amba_pv_simple_probe	(	const sc_core::sc_module_name &	name,
		std::ostream &	stream,
		bool	trans_verbose = true
	)			[inline]

Constructor.

Constructs a new amba_pv_simple_probe that prints transactions to the specified stream.

Parameters:

	name	probe name.
	stream	stream transactions are printed to.
	trans_verbose	true to print transactions (default), false otherwise.

See also:

set_out_file(), set_trans_verbose()

template<unsigned int BUSWIDTH>

amba_pv::amba_pv_simple_probe< BUSWIDTH >::~amba_pv_simple_probe

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

template<unsigned int BUSWIDTH>

const char * amba_pv::amba_pv_simple_probe< BUSWIDTH >::kind

(

)

const [inline, virtual]

Returns the kind string of this probe.

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::b_transport	(	int	socket_id,
		amba_pv_transaction &	trans,
		sc_core::sc_time &	t
	)			[inline, virtual]

Completes a transaction and prints its contents to std::cout.

See also:

amba_pv_extension, set_transport_verbose()

Implements amba_pv::amba_pv_fw_transport_if.

template<unsigned int BUSWIDTH>

unsigned int amba_pv::amba_pv_simple_probe< BUSWIDTH >::transport_dbg	(	int	socket_id,
		amba_pv_transaction &	trans
	)			[inline, virtual]

Debug access to a target.

This version of the method forwards this debug access to the slave and prints its contents.

See also:

set_debug_verbose()

Implements amba_pv::amba_pv_fw_transport_if.

template<unsigned int BUSWIDTH>

bool amba_pv::amba_pv_simple_probe< BUSWIDTH >::get_direct_mem_ptr	(	int	socket_id,
		amba_pv_transaction &	trans,
		tlm::tlm_dmi &	dmi_data
	)			[inline, virtual]

Requests a DMI access based on the specified transaction.

This version of the method forwards this DMI access request to the slave and prints its contents.

See also:

set_dmi_verbose()

Implements amba_pv::amba_pv_fw_transport_if.

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::invalidate_direct_mem_ptr	(	int	socket_id,
		sc_dt::uint64	start_range,
		sc_dt::uint64	end_range
	)			[inline, virtual]

Invalidates DMI pointers previously established for the specified DMI region.

This version of the method forwards this DMI call to the master after printing its arguments.

See also:

set_dmi_verbose()

Implements amba_pv::amba_pv_bw_transport_if.

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::set_verbose

(

bool

verbose = true

)

[inline]

Sets verbosity of this probe.

If verbosity is set to false, no transactions are printed.

Parameters:

verbose

true to print transactions (default), false otherwise.

Note:

set_verbose() is deprecated. Use set_trans_verbose() instead.

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::set_out_file

(

const std::string &

file

)

[inline]

Sets the file transactions are printed to.

The current file is closed before the new file is opened. The new file is truncated.

Parameters:

file

file transactions are printed to.

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::set_out_file

(

std::ostream &

stream

)

[inline]

Sets the stream transactions are printed to.

The current file is closed.

Parameters:

stream

stream transactions will be printed to.

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::set_trans_verbose

(

bool

verbose = true

)

[inline]

Sets verbosity of this probe.

If verbosity is set to false, no transactions are printed.

Parameters:

verbose

true to print transactions (default), false otherwise.

See also:

set_transport_verbose(), set_debug_verbose(), set_dmi_verbose()

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::set_transport_verbose

(

bool

verbose = true

)

[inline]

Sets verbosity of this probe with regard to b_transport() regular transactions.

If verbosity is set to false, no regular transactions are printed.

Parameters:

verbose

true to print b_transport() regular transactions (default), false otherwise.

See also:

is_transport_verbose()

template<unsigned int BUSWIDTH>

bool amba_pv::amba_pv_simple_probe< BUSWIDTH >::is_transport_verbose

(

)

const [inline]

Gets verbosity of this probe with regard to b_transport() regular transactions.

Returns:

Returns true if regular transactions are printed (default), false otherwise.

See also:

set_transport_verbose()

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::set_debug_verbose

(

bool

verbose = true

)

[inline]

Sets verbosity of this probe with regard to transport_dbg() debug transactions.

If verbosity is set to false, no debug transactions are printed.

Parameters:

verbose

true to print debug transactions (default), false otherwise.

See also:

is_debug_verbose()

template<unsigned int BUSWIDTH>

bool amba_pv::amba_pv_simple_probe< BUSWIDTH >::is_debug_verbose

(

)

const [inline]

Gets verbosity of this probe with regard to transport_dbg() debug transactions.

Returns:

Returns true if debug transactions are printed (default), false otherwise.

See also:

set_debug_verbose()

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::set_dmi_verbose

(

bool

verbose = true

)

[inline]

Sets verbosity of this probe with regard to DMI transactions.

If verbosity is set to false, no DMI transactions are printed.

Parameters:

verbose

true to print DMI transactions (default), false otherwise.

See also:

is_dmi_verbose()

template<unsigned int BUSWIDTH>

bool amba_pv::amba_pv_simple_probe< BUSWIDTH >::is_dmi_verbose

(

)

const [inline]

Gets verbosity of this probe with regard to DMI transactions.

Returns:

Returns true if DMI transactions are printed (default), false otherwise.

See also:

set_dmi_verbose()

template<unsigned int BUSWIDTH>

void amba_pv::amba_pv_simple_probe< BUSWIDTH >::set_data_verbose

(

bool

verbose = true

)

[inline]

Sets verbosity of this probe with regard to transactions data.

If verbosity is set to false, the data pointer is printed instead.

Parameters:

verbose

true to print transactions data (default), false otherwise.

See also:

is_data_verbose()

template<unsigned int BUSWIDTH>

bool amba_pv::amba_pv_simple_probe< BUSWIDTH >::is_data_verbose

(

)

const [inline]

Gets verbosity of this probe with regard to transactions data.

Returns:

Returns true if transactions data are printed, false otherwise.

See also:

set_data_verbose()

---

Field Documentation

template<unsigned int BUSWIDTH = 64>

amba_pv_slave_socket<BUSWIDTH> amba_pv::amba_pv_simple_probe< BUSWIDTH >::amba_pv_s

Slave socket.

template<unsigned int BUSWIDTH = 64>

amba_pv_master_socket<BUSWIDTH> amba_pv::amba_pv_simple_probe< BUSWIDTH >::amba_pv_m

Master socket.