gem5  v21.1.0.2
Public Member Functions | Public Attributes | List of all members
gem5::StubSlavePort Class Reference

Implement a ‘stub’ port which just responds to requests by printing a message. More...

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

Public Member Functions

void processResponseEvent ()
 
 StubSlavePort (const std::string &name_, ExternalSlave &owner_)
 
Tick recvAtomic (PacketPtr packet)
 Receive an atomic request packet from the peer. More...
 
void recvFunctional (PacketPtr packet)
 Receive a functional request packet from the peer. More...
 
bool recvTimingReq (PacketPtr packet)
 Receive a timing request from the peer. More...
 
bool recvTimingSnoopResp (PacketPtr packet)
 Receive a timing snoop response from the peer. More...
 
void recvRespRetry ()
 Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called on the peer) and was unsuccessful. More...
 
void recvFunctionalSnoop (PacketPtr packet)
 
- Public Member Functions inherited from gem5::ExternalSlave::ExternalPort
 ExternalPort (const std::string &name_, ExternalSlave &owner_)
 
 ~ExternalPort ()
 
AddrRangeList getAddrRanges () const
 Any or all of recv... More...
 
- Public Member Functions inherited from gem5::SlavePort
 SlavePort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 
- Public Member Functions inherited from gem5::ResponsePort
 ResponsePort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 Response port. More...
 
virtual ~ResponsePort ()
 
bool isSnooping () const
 Find out if the peer request 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 request 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 request port by calling its corresponding receive function. More...
 
void sendTimingSnoopReq (PacketPtr pkt)
 Attempt to send a timing snoop request packet to the request port by calling its corresponding receive function. More...
 
void sendRetryReq ()
 Send a retry to the request port that previously attempted a sendTimingReq to this response port and failed. More...
 
void sendRetrySnoopResp ()
 Send a retry to the request port that previously attempted a sendTimingSnoopResp to this response port and failed. More...
 
- Public Member Functions inherited from gem5::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...
 

Public Attributes

EventFunctionWrapper responseEvent
 
PacketPtr responsePacket
 Stub can handle a single request at a time. More...
 
bool mustRetry
 Received a new request while processing a first. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gem5::ResponsePort
void responderUnbind ()
 Called by the request port to unbind. More...
 
void responderBind (RequestPort &request_port)
 Called by the request 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 gem5::Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from gem5::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...
 
- Protected Member Functions inherited from gem5::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...
 
- Protected Member Functions inherited from gem5::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...
 
- Protected Attributes inherited from gem5::ExternalSlave::ExternalPort
ExternalSlaveowner
 
- Protected Attributes inherited from gem5::ResponsePort
SimObjectowner
 
- Protected Attributes inherited from gem5::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...
 

Detailed Description

Implement a ‘stub’ port which just responds to requests by printing a message.

The stub port can be used to configure and test a system where the external port is used for a peripheral before connecting the external port

Definition at line 54 of file external_slave.cc.

Constructor & Destructor Documentation

◆ StubSlavePort()

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

Definition at line 69 of file external_slave.cc.

References processResponseEvent().

Member Function Documentation

◆ processResponseEvent()

void gem5::StubSlavePort::processResponseEvent ( )

◆ recvAtomic()

Tick gem5::StubSlavePort::recvAtomic ( PacketPtr  pkt)
virtual

◆ recvFunctional()

void gem5::StubSlavePort::recvFunctional ( PacketPtr  pkt)
virtual

Receive a functional request packet from the peer.

Implements gem5::FunctionalResponseProtocol.

Definition at line 115 of file external_slave.cc.

References recvAtomic().

◆ recvFunctionalSnoop()

void gem5::StubSlavePort::recvFunctionalSnoop ( PacketPtr  packet)

Definition at line 171 of file external_slave.cc.

References fatal.

◆ recvRespRetry()

void gem5::StubSlavePort::recvRespRetry ( )
virtual

Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called on the peer) and was unsuccessful.

Implements gem5::TimingResponseProtocol.

Definition at line 161 of file external_slave.cc.

References gem5::EventFunctionWrapper::process(), responseEvent, and responsePacket.

◆ recvTimingReq()

bool gem5::StubSlavePort::recvTimingReq ( PacketPtr  pkt)
virtual

◆ recvTimingSnoopResp()

bool gem5::StubSlavePort::recvTimingSnoopResp ( PacketPtr  pkt)
virtual

Receive a timing snoop response from the peer.

Implements gem5::TimingResponseProtocol.

Definition at line 154 of file external_slave.cc.

References fatal.

Member Data Documentation

◆ mustRetry

bool gem5::StubSlavePort::mustRetry

Received a new request while processing a first.

Need to ask for a retry after completing this packet

Definition at line 67 of file external_slave.cc.

Referenced by processResponseEvent(), and recvTimingReq().

◆ responseEvent

EventFunctionWrapper gem5::StubSlavePort::responseEvent

Definition at line 59 of file external_slave.cc.

Referenced by recvRespRetry(), and recvTimingReq().

◆ responsePacket

PacketPtr gem5::StubSlavePort::responsePacket

Stub can handle a single request at a time.

This will be NULL when no packet is in flight

Definition at line 63 of file external_slave.cc.

Referenced by processResponseEvent(), recvRespRetry(), and recvTimingReq().


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

Generated on Tue Sep 21 2021 12:28:14 for gem5 by doxygen 1.8.17