TLM-2.0  2.0.3
Accellera TLM-2.0 proof-of-concept library
Public Member Functions | List of all members
tlm::tlm_generic_payload Class Reference

#include <tlm_core/tlm_2/tlm_generic_payload/tlm_gp.h>

Public Member Functions

 tlm_generic_payload ()
 
 tlm_generic_payload (tlm_mm_interface *mm)
 
void acquire ()
 
void release ()
 
int get_ref_count () const
 
void set_mm (tlm_mm_interface *mm)
 
bool has_mm () const
 
void reset ()
 
void deep_copy_from (const tlm_generic_payload &other)
 
void update_original_from (const tlm_generic_payload &other, bool use_byte_enable_on_read=true)
 
void update_extensions_from (const tlm_generic_payload &other)
 
void free_all_extensions ()
 
virtual ~tlm_generic_payload ()
 
bool is_read () const
 
void set_read ()
 
bool is_write () const
 
void set_write ()
 
tlm_command get_command () const
 
void set_command (const tlm_command command)
 
sc_dt::uint64 get_address () const
 
void set_address (const sc_dt::uint64 address)
 
unsigned char * get_data_ptr () const
 
void set_data_ptr (unsigned char *data)
 
unsigned int get_data_length () const
 
void set_data_length (const unsigned int length)
 
bool is_response_ok () const
 
bool is_response_error () const
 
tlm_response_status get_response_status () const
 
void set_response_status (const tlm_response_status response_status)
 
std::string get_response_string () const
 
unsigned int get_streaming_width () const
 
void set_streaming_width (const unsigned int streaming_width)
 
unsigned char * get_byte_enable_ptr () const
 
void set_byte_enable_ptr (unsigned char *byte_enable)
 
unsigned int get_byte_enable_length () const
 
void set_byte_enable_length (const unsigned int byte_enable_length)
 
void set_dmi_allowed (bool dmi_allowed)
 
bool is_dmi_allowed () const
 
tlm_gp_option get_gp_option () const
 
void set_gp_option (const tlm_gp_option gp_opt)
 
template<typename T >
T * set_extension (T *ext)
 
tlm_extension_baseset_extension (unsigned int index, tlm_extension_base *ext)
 
template<typename T >
T * set_auto_extension (T *ext)
 
tlm_extension_baseset_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_baseget_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 ()
 
void resize_extensions ()
 

Detailed Description

Definition at line 120 of file tlm_gp.h.

Constructor & Destructor Documentation

tlm::tlm_generic_payload::tlm_generic_payload ( )
inline

Definition at line 128 of file tlm_gp.h.

tlm::tlm_generic_payload::tlm_generic_payload ( tlm_mm_interface mm)
inlineexplicit

Definition at line 145 of file tlm_gp.h.

virtual tlm::tlm_generic_payload::~tlm_generic_payload ( )
inlinevirtual

Definition at line 364 of file tlm_gp.h.

Member Function Documentation

void tlm::tlm_generic_payload::acquire ( )
inline

Definition at line 162 of file tlm_gp.h.

template<typename T >
void tlm::tlm_generic_payload::clear_extension ( const T *  ext)
inline

Definition at line 571 of file tlm_gp.h.

template<typename T >
void tlm::tlm_generic_payload::clear_extension ( )
inline

Definition at line 580 of file tlm_gp.h.

void tlm::tlm_generic_payload::deep_copy_from ( const tlm_generic_payload other)
inline

Definition at line 224 of file tlm_gp.h.

void tlm::tlm_generic_payload::free_all_extensions ( )
inline

Definition at line 349 of file tlm_gp.h.

sc_dt::uint64 tlm::tlm_generic_payload::get_address ( ) const
inline

Definition at line 382 of file tlm_gp.h.

unsigned int tlm::tlm_generic_payload::get_byte_enable_length ( ) const
inline

Definition at line 421 of file tlm_gp.h.

unsigned char* tlm::tlm_generic_payload::get_byte_enable_ptr ( ) const
inline

Definition at line 419 of file tlm_gp.h.

tlm_command tlm::tlm_generic_payload::get_command ( ) const
inline

Definition at line 378 of file tlm_gp.h.

unsigned int tlm::tlm_generic_payload::get_data_length ( ) const
inline

Definition at line 390 of file tlm_gp.h.

unsigned char* tlm::tlm_generic_payload::get_data_ptr ( ) const
inline

Definition at line 386 of file tlm_gp.h.

template<typename T >
void tlm::tlm_generic_payload::get_extension ( T *&  ext) const
inline

Definition at line 553 of file tlm_gp.h.

template<typename T >
T* tlm::tlm_generic_payload::get_extension ( ) const
inline

Definition at line 557 of file tlm_gp.h.

tlm_extension_base* tlm::tlm_generic_payload::get_extension ( unsigned int  index) const
inline

Definition at line 562 of file tlm_gp.h.

tlm_gp_option tlm::tlm_generic_payload::get_gp_option ( ) const
inline

Definition at line 430 of file tlm_gp.h.

int tlm::tlm_generic_payload::get_ref_count ( ) const
inline

Definition at line 164 of file tlm_gp.h.

tlm_response_status tlm::tlm_generic_payload::get_response_status ( ) const
inline

Definition at line 396 of file tlm_gp.h.

std::string tlm::tlm_generic_payload::get_response_string ( ) const
inline

Definition at line 399 of file tlm_gp.h.

unsigned int tlm::tlm_generic_payload::get_streaming_width ( ) const
inline

Definition at line 415 of file tlm_gp.h.

bool tlm::tlm_generic_payload::has_mm ( ) const
inline

Definition at line 166 of file tlm_gp.h.

bool tlm::tlm_generic_payload::is_dmi_allowed ( ) const
inline

Definition at line 427 of file tlm_gp.h.

bool tlm::tlm_generic_payload::is_read ( ) const
inline

Definition at line 374 of file tlm_gp.h.

bool tlm::tlm_generic_payload::is_response_error ( ) const
inline

Definition at line 395 of file tlm_gp.h.

bool tlm::tlm_generic_payload::is_response_ok ( ) const
inline

Definition at line 394 of file tlm_gp.h.

bool tlm::tlm_generic_payload::is_write ( ) const
inline

Definition at line 376 of file tlm_gp.h.

void tlm::tlm_generic_payload::release ( )
inline

Definition at line 163 of file tlm_gp.h.

template<typename T >
void tlm::tlm_generic_payload::release_extension ( T *  ext)
inline

Definition at line 588 of file tlm_gp.h.

template<typename T >
void tlm::tlm_generic_payload::release_extension ( )
inline

Definition at line 596 of file tlm_gp.h.

void tlm::tlm_generic_payload::reset ( )
inline

Definition at line 168 of file tlm_gp.h.

void tlm::tlm_generic_payload::resize_extensions ( )
inline

Definition at line 627 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_address ( const sc_dt::uint64  address)
inline

Definition at line 383 of file tlm_gp.h.

template<typename T >
T* tlm::tlm_generic_payload::set_auto_extension ( T *  ext)
inline

Definition at line 536 of file tlm_gp.h.

tlm_extension_base* tlm::tlm_generic_payload::set_auto_extension ( unsigned int  index,
tlm_extension_base ext 
)
inline

Definition at line 542 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_byte_enable_length ( const unsigned int  byte_enable_length)
inline

Definition at line 422 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_byte_enable_ptr ( unsigned char *  byte_enable)
inline

Definition at line 420 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_command ( const tlm_command  command)
inline

Definition at line 379 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_data_length ( const unsigned int  length)
inline

Definition at line 391 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_data_ptr ( unsigned char *  data)
inline

Definition at line 387 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_dmi_allowed ( bool  dmi_allowed)
inline

Definition at line 426 of file tlm_gp.h.

template<typename T >
T* tlm::tlm_generic_payload::set_extension ( T *  ext)
inline

Definition at line 520 of file tlm_gp.h.

tlm_extension_base* tlm::tlm_generic_payload::set_extension ( unsigned int  index,
tlm_extension_base ext 
)
inline

Definition at line 526 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_gp_option ( const tlm_gp_option  gp_opt)
inline

Definition at line 431 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_mm ( tlm_mm_interface mm)
inline

Definition at line 165 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_read ( )
inline

Definition at line 375 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_response_status ( const tlm_response_status  response_status)
inline

Definition at line 397 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_streaming_width ( const unsigned int  streaming_width)
inline

Definition at line 416 of file tlm_gp.h.

void tlm::tlm_generic_payload::set_write ( )
inline

Definition at line 377 of file tlm_gp.h.

void tlm::tlm_generic_payload::update_extensions_from ( const tlm_generic_payload other)
inline

Definition at line 332 of file tlm_gp.h.

void tlm::tlm_generic_payload::update_original_from ( const tlm_generic_payload other,
bool  use_byte_enable_on_read = true 
)
inline

Definition at line 280 of file tlm_gp.h.


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