spi::spi_packet_payload Struct Reference

Inheritance diagram for spi::spi_packet_payload:

Collaboration diagram for spi::spi_packet_payload:

Public Member Functions
	spi_packet_payload (unsigned target_id)
	spi_packet_payload (tlm::nw::tlm_base_mm_interface *mm)
	spi_packet_payload (tlm::nw::tlm_base_mm_interface *mm, unsigned target_id)
unsigned	get_target_id () const
const sc_core::sc_time &	get_sender_clk_period () const
void	set_sender_clk_period (sc_core::sc_time period)
void	set_target_id (unsigned id)
Public Member Functions inherited from tlm::nw::tlm_network_payload< SPI_PKT >
	tlm_network_payload ()
	Default constructor.
virtual	~tlm_network_payload ()=default
void	deep_copy_from (const tlm_network_payload &other)
	Non-virtual deep-copying of the object.
SPI_PKT	get_command () const
	Gets the command from the payload.
void	set_command (const SPI_PKT command)
	Sets the command in the payload.
std::vector< uint8_t > const &	get_data () const
	Gets the data from the payload.
void	set_data (std::vector< uint8_t > const &value)
	Sets the data in the payload.
bool	is_response_ok () const
	Checks if the response status is OK.
bool	is_response_error () const
	Checks if the response status is an error.
tlm_response_status	get_response_status () const
	Gets the response status from the payload.
void	set_response_status (const tlm_response_status response_status)
	Sets the response status in the payload.
std::string	get_response_string () const
	Gets the response status as a string.
Public Member Functions inherited from tlm::nw::tlm_network_payload_base
	tlm_network_payload_base ()
	Default constructor.
	tlm_network_payload_base (tlm_base_mm_interface *mm)
	Constructor with memory management interface.
virtual	~tlm_network_payload_base ()
void	reset ()
	Constructor with memory management interface.
void	acquire ()
	Acquires a reference to the payload.
void	release ()
	Releases a reference to the payload.
int	get_ref_count () const
	Gets the reference count of the payload.
void	set_mm (tlm_base_mm_interface *mm)
bool	has_mm () const
void	copy_extensions_from (const tlm_network_payload_base &other)
void	update_extensions_from (const tlm_network_payload_base &other)
void	free_all_extensions ()
template<typename T>
T *	set_extension (T *ext)
tlm_extension_base *	set_extension (unsigned int index, tlm_extension_base *ext)
template<typename T>
T *	set_auto_extension (T *ext)
tlm_extension_base *	set_auto_extension (unsigned int index, tlm_extension_base *ext)
template<typename T>
void	get_extension (T *&ext) const
template<typename T>
T *	get_extension () const
tlm_extension_base *	get_extension (unsigned int index) const
template<typename T>
void	clear_extension (const T *ext)
template<typename T>
void	clear_extension ()
template<typename T>
void	release_extension (T *ext)
template<typename T>
void	release_extension ()
size_t	get_extension_count ()
void	resize_extensions ()

Additional Inherited Members
Static Public Member Functions inherited from tlm::nw::tlm_network_payload< SPI_PKT >
static tlm_network_payload< SPI_PKT > *	create ()
	Creates a new instance of the tlm_network_payload using a thread-local memory manager.
Protected Member Functions inherited from tlm::nw::tlm_network_payload< SPI_PKT >
tlm_network_payload< SPI_PKT > &	operator= (const tlm_network_payload< SPI_PKT > &x)
Protected Attributes inherited from tlm::nw::tlm_network_payload< SPI_PKT >
SPI_PKT	m_command
std::vector< uint8_t >	m_data
tlm_response_status	m_response_status

Detailed Description

Definition at line 34 of file spi_tlm.h.

Constructor & Destructor Documentation

spi_packet_payload() [1/3]

spi::spi_packet_payload::spi_packet_payload ( unsigned target_id )

inline

Definition at line 37 of file spi_tlm.h.

spi_packet_payload() [2/3]

spi::spi_packet_payload::spi_packet_payload ( tlm::nw::tlm_base_mm_interface * mm )

inlineexplicit

Definition at line 40 of file spi_tlm.h.

spi_packet_payload() [3/3]

spi::spi_packet_payload::spi_packet_payload ( tlm::nw::tlm_base_mm_interface * mm, unsigned target_id )

inlineexplicit

Definition at line 43 of file spi_tlm.h.

Member Function Documentation

get_sender_clk_period()

const sc_core::sc_time & spi::spi_packet_payload::get_sender_clk_period ( ) const

inline

Definition at line 49 of file spi_tlm.h.

get_target_id()

unsigned spi::spi_packet_payload::get_target_id ( ) const

inline

Definition at line 47 of file spi_tlm.h.

set_sender_clk_period()

void spi::spi_packet_payload::set_sender_clk_period ( sc_core::sc_time period )

inline

Definition at line 51 of file spi_tlm.h.

set_target_id()

void spi::spi_packet_payload::set_target_id ( unsigned id )

inline

Definition at line 53 of file spi_tlm.h.

---

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

• /home/eyck/Projects/MINRES/SystemC-Components/src/interfaces/spi/spi_tlm.h