gem5  v19.0.0.0
Public Member Functions | Protected Attributes | List of all members
ExternalSlave::ExternalPort Class Reference

Derive from this class to create an external port interface. More...

#include <external_slave.hh>

Inheritance diagram for ExternalSlave::ExternalPort:
SlavePort Port AtomicResponseProtocol TimingResponseProtocol FunctionalResponseProtocol StubSlavePort

Public Member Functions

 ExternalPort (const std::string &name_, ExternalSlave &owner_)
 
 ~ExternalPort ()
 
AddrRangeList getAddrRanges () const
 Any or all of recv... More...
 
- Public Member Functions inherited from SlavePort
 SlavePort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 Slave port. More...
 
virtual ~SlavePort ()
 
bool isSnooping () const
 Find out if the peer master port is snooping or not. More...
 
void sendRangeChange () const
 Called by the owner to send a range change. More...
 
void unbind () override
 We let the master port do the work, so these don't do anything. More...
 
void bind (Port &peer) override
 Attach to a peer port. More...
 
Tick sendAtomicSnoop (PacketPtr pkt)
 Send an atomic snoop request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
void sendFunctionalSnoop (PacketPtr pkt) const
 Send a functional snoop 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 sendTimingResp (PacketPtr pkt)
 Attempt to send a timing response to the master port by calling its corresponding receive function. More...
 
void sendTimingSnoopReq (PacketPtr pkt)
 Attempt to send a timing snoop request packet to the master port by calling its corresponding receive function. More...
 
void sendRetryReq ()
 Send a retry to the master port that previously attempted a sendTimingReq to this slave port and failed. More...
 
void sendRetrySnoopResp ()
 Send a retry to the master port that previously attempted a sendTimingSnoopResp to this slave port and failed. More...
 
- Public Member Functions inherited from Port
virtual ~Port ()
 Virtual destructor due to inheritance. More...
 
PortgetPeer ()
 Return a reference to this port's peer. More...
 
const std::string name () const
 Return port name (for DPRINTF). More...
 
PortID getId () const
 Get the port id. More...
 
bool isConnected () const
 Is this port currently connected to a peer? More...
 
void takeOverFrom (Port *old)
 A utility function to make it easier to swap out ports. More...
 

Protected Attributes

ExternalSlaveowner
 
- Protected Attributes inherited from SlavePort
SimObjectowner
 
- 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...
 
Port_peer
 A pointer to this port's peer. More...
 
bool _connected
 Whether this port is currently connected to a peer port. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SlavePort
void slaveUnbind ()
 Called by the master port to unbind. More...
 
void slaveBind (MasterPort &master_port)
 Called by the master port to bind. More...
 
Tick recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor) override
 Default implementations. More...
 
bool tryTiming (PacketPtr pkt) override
 Availability request from the peer. More...
 
bool recvTimingSnoopResp (PacketPtr pkt) override
 Receive a timing snoop response from the peer. More...
 
- Protected Member Functions inherited from Port
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from AtomicResponseProtocol
Tick sendSnoop (AtomicRequestProtocol *peer, PacketPtr pkt)
 Send an atomic snoop request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
virtual Tick recvAtomic (PacketPtr pkt)=0
 Receive an atomic request packet from the peer. More...
 
- Protected Member Functions inherited from TimingResponseProtocol
bool sendResp (TimingRequestProtocol *peer, PacketPtr pkt)
 Attempt to send a timing response to the peer by calling its corresponding receive function. More...
 
void sendSnoopReq (TimingRequestProtocol *peer, PacketPtr pkt)
 Attempt to send a timing snoop request packet to the peer by calling its corresponding receive function. More...
 
void sendRetryReq (TimingRequestProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingReq to this protocol and failed. More...
 
void sendRetrySnoopResp (TimingRequestProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingSnoopResp to this peer and failed. More...
 
virtual bool recvTimingReq (PacketPtr pkt)=0
 Receive a timing request from the peer. More...
 
virtual void recvRespRetry ()=0
 Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called on the peer) and was unsuccessful. More...
 
- Protected Member Functions inherited from FunctionalResponseProtocol
void sendSnoop (FunctionalRequestProtocol *peer, PacketPtr pkt) const
 Send a functional snoop 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...
 
virtual void recvFunctional (PacketPtr pkt)=0
 Receive a functional request packet from the peer. More...
 

Detailed Description

Derive from this class to create an external port interface.

Definition at line 71 of file external_slave.hh.

Constructor & Destructor Documentation

◆ ExternalPort()

ExternalSlave::ExternalPort::ExternalPort ( const std::string &  name_,
ExternalSlave owner_ 
)
inline

◆ ~ExternalPort()

ExternalSlave::ExternalPort::~ExternalPort ( )
inline

Definition at line 82 of file external_slave.hh.

References getAddrRanges().

Member Function Documentation

◆ getAddrRanges()

AddrRangeList ExternalSlave::ExternalPort::getAddrRanges ( ) const
virtual

Any or all of recv...

can be overloaded to provide the port's functionality

Implements SlavePort.

Definition at line 178 of file external_slave.cc.

References ExternalSlave::addrRanges, and owner.

Referenced by ~ExternalPort().

Member Data Documentation

◆ owner

ExternalSlave& ExternalSlave::ExternalPort::owner
protected

Definition at line 74 of file external_slave.hh.

Referenced by getAddrRanges(), and StubSlavePort::recvTimingReq().


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

Generated on Fri Feb 28 2020 16:27:11 for gem5 by doxygen 1.8.13