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

Implement a `stub' port which just responds to requests by printing a message. More...

Inheritance diagram for StubSlavePort:
ExternalSlave::Port SlavePort BaseSlavePort Port

Classes

class  ResponseEvent
 

Public Member Functions

 StubSlavePort (const std::string &name_, ExternalSlave &owner_)
 
Tick recvAtomic (PacketPtr packet)
 Receive an atomic request packet from the master port. More...
 
void recvFunctional (PacketPtr packet)
 Receive a functional request packet from the master port. More...
 
bool recvTimingReq (PacketPtr packet)
 Receive a timing request from the master port. More...
 
bool recvTimingSnoopResp (PacketPtr packet)
 Receive a timing snoop response from the master port. More...
 
void recvRespRetry ()
 Called by the master port if sendTimingResp was called on this slave port (causing recvTimingResp to be called on the master port) and was unsuccesful. More...
 
void recvFunctionalSnoop (PacketPtr packet)
 
- Public Member Functions inherited from ExternalSlave::Port
 Port (const std::string &name_, ExternalSlave &owner_)
 
 ~Port ()
 Virtual destructor due to inheritance. More...
 
AddrRangeList getAddrRanges () const
 Any or all of recv... More...
 
- Public Member Functions inherited from SlavePort
 SlavePort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 Slave port. More...
 
virtual ~SlavePort ()
 
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)
 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...
 
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...
 
- Public Member Functions inherited from BaseSlavePort
BaseMasterPortgetMasterPort () 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...
 

Public Attributes

ResponseEvent 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 SlavePort
void unbind ()
 Called by the master port to unbind. More...
 
void bind (MasterPort &master_port)
 Called by the master port to bind. More...
 
- Protected Member Functions inherited from BaseSlavePort
 BaseSlavePort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 
virtual ~BaseSlavePort ()
 
- Protected Member Functions inherited from Port
 Port (const std::string &_name, MemObject &_owner, PortID _id)
 Abstract base class for ports. More...
 
- Protected Attributes inherited from ExternalSlave::Port
ExternalSlaveowner
 
- Protected Attributes inherited from BaseSlavePort
BaseMasterPort_baseMasterPort
 
- 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

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 52 of file external_slave.cc.

Constructor & Destructor Documentation

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

Definition at line 75 of file external_slave.cc.

Member Function Documentation

Tick StubSlavePort::recvAtomic ( PacketPtr  pkt)
virtual

Receive an atomic request packet from the master port.

Implements SlavePort.

Definition at line 106 of file external_slave.cc.

References DDUMP, DPRINTF, DTRACE, Packet::getAddr(), Packet::getConstPtr(), Packet::getSize(), M5_VAR_USED, and X86ISA::size().

Referenced by recvFunctional(), and recvTimingReq().

void StubSlavePort::recvFunctional ( PacketPtr  pkt)
virtual

Receive a functional request packet from the master port.

Implements SlavePort.

Definition at line 120 of file external_slave.cc.

References recvAtomic().

void StubSlavePort::recvFunctionalSnoop ( PacketPtr  packet)

Definition at line 176 of file external_slave.cc.

References fatal.

void StubSlavePort::recvRespRetry ( )
virtual

Called by the master port if sendTimingResp was called on this slave port (causing recvTimingResp to be called on the master port) and was unsuccesful.

Implements SlavePort.

Definition at line 166 of file external_slave.cc.

References StubSlavePort::ResponseEvent::process(), responseEvent, and responsePacket.

bool StubSlavePort::recvTimingReq ( PacketPtr  pkt)
virtual

Receive a timing request from the master port.

Implements SlavePort.

Definition at line 142 of file external_slave.cc.

References curTick(), mustRetry, ExternalSlave::Port::owner, recvAtomic(), responseEvent, responsePacket, and EventManager::schedule().

bool StubSlavePort::recvTimingSnoopResp ( PacketPtr  pkt)
virtual

Receive a timing snoop response from the master port.

Reimplemented from SlavePort.

Definition at line 159 of file external_slave.cc.

References fatal.

Member Data Documentation

bool StubSlavePort::mustRetry

Received a new request while processing a first.

Need to ask for a retry after completing this packet

Definition at line 73 of file external_slave.cc.

Referenced by StubSlavePort::ResponseEvent::process(), and recvTimingReq().

ResponseEvent StubSlavePort::responseEvent

Definition at line 65 of file external_slave.cc.

Referenced by recvRespRetry(), and recvTimingReq().

PacketPtr StubSlavePort::responsePacket

Stub can handle a single request at a time.

This will be NULL when no packet is in flight

Definition at line 69 of file external_slave.cc.

Referenced by StubSlavePort::ResponseEvent::process(), recvRespRetry(), and recvTimingReq().


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

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