AMBA-PV Extensions to OSCI TLM 2.0 Reference Manual

amba_pv Namespace Reference


Detailed Description

AMBA-PV namespace.

Namespace amba_pv contains all the AMBA-PV classes.


Data Structures

class  amba_pv_addressing
 Provides support for AMBA 3 buses addressing options. More...
class  amba_pv_attributes
 Provides support for additional user-defined attributes. More...
class  amba_pv_control
 Provides support for additional control information used by the AMBA 3 buses. More...
class  amba_pv_extension
 AMBA-PV extension type. More...
class  amba_pv_fw_transport_if
 AMBA-PV core transaction interface. More...
class  amba_pv_bw_transport_if
 AMBA-PV core transaction interface. More...
struct  amba_pv_protocol_types
 AMBA-PV protocol types. More...
class  amba_pv_address_region
 AMBA-PV address region structure. More...
class  amba_pv_address_map
 AMBA-PV address mapping information structure. More...
class  amba_pv_from_tlm_bridge
 OSCI TLM 2.0 BP to AMBA-PV bridge module. More...
class  amba_pv_to_tlm_bridge
 AMBA-PV to OSCI TLM 2.0 BP bridge module. More...
class  amba_pv_decoder
 AMBA-PV bus decoder model. More...
class  amba_pv_exclusive_monitor
 AMBA-PV exclusive access monitor. More...
class  amba_pv_memory
 AMBA-PV advanced memory model. More...
class  amba_pv_memory_base
 AMBA-PV memory model base class. More...
class  amba_pv_simple_memory
 AMBA-PV simple memory model. More...
class  amba_pv_simple_probe
 AMBA-PV simple probe component. More...
class  signal_from_sc_bridge
 Generic sc_signal to Signal bridge module. More...
class  signal_to_sc_bridge
 Generic Signal to sc_signal bridge module. More...
class  signal_state_from_sc_bridge
 Generic sc_signal to SignalState bridge module. More...
class  signal_state_to_sc_bridge
 Generic SignalState to sc_signal bridge module. More...
class  signal_transport_if
 Signal core interface. More...
class  signal_state_transport_if
 SignalState core interface. More...
class  signal_if
 Signal interface. More...
class  signal_state_if
 SignalState interface. More...
class  signal_master_port
 Signal port to be instantiated on the master side. More...
class  signal_state_master_port
 SignalState port to be instantiated on the master side. More...
class  signal_request
 Signal request type. More...
class  signal_response
 Signal response type. More...
class  signal_slave_base
 Base class for all Signal slave modules. More...
class  signal_state_slave_base
 Base class for all SignalState slave modules. More...
class  signal_export_base
 Signal export base class. More...
class  signal_slave_export
 Signal export to be instantiated on the slave side. More...
class  signal_state_slave_export
 SignalState export to be instantiated on the slave side. More...
class  amba_pv_master_socket
 AMBA-PV socket to be instantiated on the master side. More...
class  amba_pv_slave_socket
 AMBA-PV socket to be instantiated on the slave side. More...
class  amba_pv_socket_array
 AMBA-PV socket array class. More...
class  amba_pv_socket_base
 AMBA-PV socket base class. More...
class  amba_pv_if
 AMBA-PV user-layer transaction interface. More...
class  amba_pv_master_base
 Base class for all AMBA-PV master modules. More...
class  amba_pv_slave_base
 Base class for all AMBA-PV slave modules. More...

Typedefs

typedef
amba_pv_protocol_types::tlm_payload_type 
amba_pv_transaction
 AMBA-PV transaction type.

Enumerations

enum  amba_pv_burst_t {
  AMBA_PV_FIXED,
  AMBA_PV_INCR,
  AMBA_PV_WRAP
}
 Burst type. More...
enum  amba_pv_resp_t {
  AMBA_PV_OKAY,
  AMBA_PV_EXOKAY,
  AMBA_PV_SLVERR,
  AMBA_PV_DECERR
}
 AMBA-PV response type. More...
enum  signal_command {
  SIGNAL_SET,
  SIGNAL_GET
}
 Signal request command type. More...

Functions

std::string amba_pv_burst_string (amba_pv_burst_t burst)
 Returns the text string representation of the specified burst type.
sc_dt::uint64 amba_pv_address (const sc_dt::uint64 &addr, unsigned int length, unsigned int size, amba_pv_burst_t burst, unsigned int n)
 Computes the address of a transfer in a burst.
bool amba_pv_is_valid_length (unsigned int length, amba_pv_burst_t burst=AMBA_PV_INCR)
 Returns true if the given burst length is valid.
bool amba_pv_is_valid_size (unsigned int size)
 Returns true if the given burst size is valid.
std::string amba_pv_resp_string (amba_pv_resp_t resp)
 Returns the text string representation of the specified AMBA-PV response.
amba_pv_resp_t amba_pv_resp_from_tlm (tlm::tlm_response_status response_status)
 Translates the specified TLM 2.0 response status value into an AMBA-PV response.
tlm::tlm_response_status amba_pv_resp_to_tlm (amba_pv_resp_t resp)
 Translates the specified AMBA-PV response value into a TLM 2.0 response status.

Typedef Documentation

typedef amba_pv_protocol_types::tlm_payload_type amba_pv::amba_pv_transaction


Enumeration Type Documentation

Burst type.

The burst type, together with the size information, determines how the address for each transfer within the burst is calculated.

See also:
amba_pv_addressing
Enumerator:
AMBA_PV_FIXED  is a fixed-address burst.

AMBA_PV_INCR  is an incrementing-address burst.

AMBA_PV_WRAP  is an incrementing-address burst that wraps to a lower address at the wrap boundary.

AMBA-PV response type.

See also:
amba_pv_extension
Enumerator:
AMBA_PV_OKAY  indicates that a normal access has been successful.

It also indicates an exclusive access failure.

AMBA_PV_EXOKAY  indicates that either the read or write portion of an exclusive access has been successful.

AMBA_PV_SLVERR  indicates that the access has reached the slave successfully, but the slave returned an error condition to the originating master.

AMBA_PV_DECERR  indicates that there is no slave at the transaction address.

This is typically generated by an interconnect component.

Signal request command type.

Enumerator:
SIGNAL_SET  is the command to issue a set operation.

SIGNAL_GET  is the command to issue a get operation.


Function Documentation

std::string amba_pv::amba_pv_burst_string (amba_pv_burst_t burst )  [inline]

Returns the text string representation of the specified burst type.

Parameters:
burst burst type as one of AMBA_PV_FIXED, AMBA_PV_INCR, or AMBA_PV_WRAP.
Returns:
the text string representation of burst.

sc_dt::uint64 amba_pv::amba_pv_address (const sc_dt::uint64 & addr,
unsigned int length,
unsigned int size,
amba_pv_burst_t burst,
unsigned int n 
) [inline]

Computes the address of a transfer in a burst.

Parameters:
addr burst address.
length burst length.
size burst size in bytes.
burst burst type as one of AMBA_PV_FIXED, AMBA_PV_INCR, or AMBA_PV_WRAP.
n burst beat number as in [0 .. (length - 1)].

bool amba_pv::amba_pv_is_valid_length (unsigned int length,
amba_pv_burst_t burst = AMBA_PV_INCR 
) [inline]

Returns true if the given burst length is valid.

Parameters:
length burst length.
burst burst type as one of AMBA_PV_FIXED, AMBA_PV_INCR (default), or AMBA_PV_WRAP.

bool amba_pv::amba_pv_is_valid_size (unsigned int size )  [inline]

std::string amba_pv::amba_pv_resp_string (amba_pv_resp_t resp )  [inline]

amba_pv_resp_t amba_pv::amba_pv_resp_from_tlm (tlm::tlm_response_status response_status )  [inline]

tlm::tlm_response_status amba_pv::amba_pv_resp_to_tlm (amba_pv_resp_t resp )  [inline]

Copyright © 2009 ARM Limited. All rights reserved. ARM DUI 0522A
Non-Confidential