gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
CoherentXBar::CoherentXBarMasterPort Class Reference

Declaration of the coherent crossbar master port type, one will be instantiated for each of the slave interfaces connecting to the crossbar. More...

#include <coherent_xbar.hh>

Inheritance diagram for CoherentXBar::CoherentXBarMasterPort:
MasterPort BaseMasterPort Port

Public Member Functions

 CoherentXBarMasterPort (const std::string &_name, CoherentXBar &_xbar, PortID _id)
 
- Public Member Functions inherited from MasterPort
 MasterPort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 Master port. More...
 
virtual ~MasterPort ()
 
void bind (BaseSlavePort &slave_port)
 Bind this master port to a slave port. More...
 
void unbind ()
 Unbind this master port and the associated slave port. More...
 
Tick sendAtomic (PacketPtr pkt)
 Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
void sendFunctional (PacketPtr pkt)
 Send a functional request packet, where the data is instantly updated everywhere in the memory system, without affecting the current state of any block or moving the block. More...
 
bool sendTimingReq (PacketPtr pkt)
 Attempt to send a timing request to the slave port by calling its corresponding receive function. More...
 
bool sendTimingSnoopResp (PacketPtr pkt)
 Attempt to send a timing snoop response packet to the slave port by calling its corresponding receive function. More...
 
virtual void sendRetryResp ()
 Send a retry to the slave port that previously attempted a sendTimingResp to this master port and failed. More...
 
AddrRangeList getAddrRanges () const
 Get the address ranges of the connected slave port. More...
 
void printAddr (Addr a)
 Inject a PrintReq for the given address to print the state of that address throughout the memory system. More...
 
- Public Member Functions inherited from BaseMasterPort
BaseSlavePortgetSlavePort () const
 
bool isConnected () const
 
- Public Member Functions inherited from Port
const std::string name () const
 Return port name (for DPRINTF). More...
 
PortID getId () const
 Get the port id. More...
 

Protected Member Functions

virtual bool isSnooping () const
 Determine if this port should be considered a snooper. More...
 
virtual bool recvTimingResp (PacketPtr pkt)
 When receiving a timing response, pass it to the crossbar. More...
 
virtual void recvTimingSnoopReq (PacketPtr pkt)
 When receiving a timing snoop request, pass it to the crossbar. More...
 
virtual Tick recvAtomicSnoop (PacketPtr pkt)
 When receiving an atomic snoop request, pass it to the crossbar. More...
 
virtual void recvFunctionalSnoop (PacketPtr pkt)
 When receiving a functional snoop request, pass it to the crossbar. More...
 
virtual void recvRangeChange ()
 When reciving a range change from the peer port (at id), pass it to the crossbar. More...
 
virtual void recvReqRetry ()
 When reciving a retry from the peer port (at id), pass it to the crossbar. More...
 
- Protected Member Functions inherited from MasterPort
virtual void recvRetrySnoopResp ()
 Called by the slave port if sendTimingSnoopResp was called on this master port (causing recvTimingSnoopResp to be called on the slave port) and was unsuccesful. More...
 
- Protected Member Functions inherited from BaseMasterPort
 BaseMasterPort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 
virtual ~BaseMasterPort ()
 
- Protected Member Functions inherited from Port
 Port (const std::string &_name, MemObject &_owner, PortID _id)
 Abstract base class for ports. More...
 
virtual ~Port ()
 Virtual destructor due to inheritance. More...
 

Private Attributes

CoherentXBarxbar
 A reference to the crossbar to which this port belongs. More...
 

Additional Inherited Members

- Protected Attributes inherited from BaseMasterPort
BaseSlavePort_baseSlavePort
 
- Protected Attributes inherited from Port
const PortID id
 A numeric identifier to distinguish ports in a vector, and set to InvalidPortID in case this port is not part of a vector. More...
 
MemObjectowner
 A reference to the MemObject that owns this port. More...
 

Detailed Description

Declaration of the coherent crossbar master port type, one will be instantiated for each of the slave interfaces connecting to the crossbar.

Definition at line 147 of file coherent_xbar.hh.

Constructor & Destructor Documentation

CoherentXBar::CoherentXBarMasterPort::CoherentXBarMasterPort ( const std::string &  _name,
CoherentXBar _xbar,
PortID  _id 
)
inline

Definition at line 155 of file coherent_xbar.hh.

Member Function Documentation

virtual bool CoherentXBar::CoherentXBarMasterPort::isSnooping ( ) const
inlineprotectedvirtual

Determine if this port should be considered a snooper.

For a coherent crossbar master port this is always true.

Returns
a boolean that is true if this port is snooping

Reimplemented from MasterPort.

Definition at line 168 of file coherent_xbar.hh.

virtual Tick CoherentXBar::CoherentXBarMasterPort::recvAtomicSnoop ( PacketPtr  pkt)
inlineprotectedvirtual

When receiving an atomic snoop request, pass it to the crossbar.

Reimplemented from MasterPort.

Definition at line 186 of file coherent_xbar.hh.

References CoherentXBar::recvAtomicSnoop(), and xbar.

virtual void CoherentXBar::CoherentXBarMasterPort::recvFunctionalSnoop ( PacketPtr  pkt)
inlineprotectedvirtual

When receiving a functional snoop request, pass it to the crossbar.

Reimplemented from MasterPort.

Definition at line 192 of file coherent_xbar.hh.

References CoherentXBar::recvFunctionalSnoop(), and xbar.

virtual void CoherentXBar::CoherentXBarMasterPort::recvRangeChange ( )
inlineprotectedvirtual

When reciving a range change from the peer port (at id), pass it to the crossbar.

Reimplemented from MasterPort.

Definition at line 197 of file coherent_xbar.hh.

References BaseXBar::recvRangeChange(), and xbar.

virtual void CoherentXBar::CoherentXBarMasterPort::recvReqRetry ( )
inlineprotectedvirtual

When reciving a retry from the peer port (at id), pass it to the crossbar.

Implements MasterPort.

Definition at line 202 of file coherent_xbar.hh.

References CoherentXBar::recvReqRetry(), and xbar.

virtual bool CoherentXBar::CoherentXBarMasterPort::recvTimingResp ( PacketPtr  pkt)
inlineprotectedvirtual

When receiving a timing response, pass it to the crossbar.

Implements MasterPort.

Definition at line 174 of file coherent_xbar.hh.

References CoherentXBar::recvTimingResp(), and xbar.

virtual void CoherentXBar::CoherentXBarMasterPort::recvTimingSnoopReq ( PacketPtr  pkt)
inlineprotectedvirtual

When receiving a timing snoop request, pass it to the crossbar.

Reimplemented from MasterPort.

Definition at line 180 of file coherent_xbar.hh.

References CoherentXBar::recvTimingSnoopReq(), and xbar.

Member Data Documentation

CoherentXBar& CoherentXBar::CoherentXBarMasterPort::xbar
private

A reference to the crossbar to which this port belongs.

Definition at line 151 of file coherent_xbar.hh.

Referenced by recvAtomicSnoop(), recvFunctionalSnoop(), recvRangeChange(), recvReqRetry(), recvTimingResp(), and recvTimingSnoopReq().


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

Generated on Fri Jun 9 2017 13:04:06 for gem5 by doxygen 1.8.6