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

Port on the side that forwards requests and receives responses. More...

#include <serial_link.hh>

Inheritance diagram for SerialLink::SerialLinkMasterPort:
MasterPort BaseMasterPort Port

Public Member Functions

 SerialLinkMasterPort (const std::string &_name, SerialLink &_serial_link, SerialLinkSlavePort &_slavePort, Cycles _delay, int _req_limit)
 Constructor for the SerialLinkMasterPort. More...
 
bool reqQueueFull () const
 Is this side blocked from accepting new request packets. More...
 
void schedTimingReq (PacketPtr pkt, Tick when)
 Queue a request packet to be sent out later and also schedule a send if necessary. More...
 
bool checkFunctional (PacketPtr pkt)
 Check a functional request against the packets in our request queue. More...
 
- 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...
 
virtual bool isSnooping () const
 Determine if this master port is snooping or not. 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

bool recvTimingResp (PacketPtr pkt)
 When receiving a timing request from the peer port, pass it to the serial_link. More...
 
void recvReqRetry ()
 When receiving a retry request from the peer port, pass it to the serial_link. More...
 
- Protected Member Functions inherited from MasterPort
virtual Tick recvAtomicSnoop (PacketPtr pkt)
 Receive an atomic snoop request packet from the slave port. More...
 
virtual void recvFunctionalSnoop (PacketPtr pkt)
 Receive a functional snoop request packet from the slave port. More...
 
virtual void recvTimingSnoopReq (PacketPtr pkt)
 Receive a timing snoop request from the slave port. More...
 
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...
 
virtual void recvRangeChange ()
 Called to receive an address range change from the peer slave port. 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 Member Functions

void trySendTiming ()
 Handle send event, scheduled when the packet at the head of the outbound queue is ready to transmit (for timing accesses only). More...
 

Private Attributes

SerialLinkserial_link
 The serial_link to which this port belongs. More...
 
SerialLinkSlavePortslavePort
 The slave port on the other side of the serial_link. More...
 
const Cycles delay
 Minimum delay though this serial_link. More...
 
std::deque< DeferredPackettransmitList
 Request packet queue. More...
 
const unsigned int reqQueueLimit
 Max queue size for request packets. More...
 
EventWrapper
< SerialLinkMasterPort,&SerialLinkMasterPort::trySendTiming
sendEvent
 Send event for the request queue. 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

Port on the side that forwards requests and receives responses.

The master port has a buffer for the requests not yet sent.

Definition at line 215 of file serial_link.hh.

Constructor & Destructor Documentation

SerialLink::SerialLinkMasterPort::SerialLinkMasterPort ( const std::string &  _name,
SerialLink _serial_link,
SerialLinkSlavePort _slavePort,
Cycles  _delay,
int  _req_limit 
)

Constructor for the SerialLinkMasterPort.

Parameters
_namethe port name including the owner
_serial_linkthe structural owner
_slavePortthe slave port on the other side of the serial_link
_delaythe delay in cycles from receiving to sending
_req_limitthe size of the request queue

Definition at line 73 of file serial_link.cc.

Member Function Documentation

bool SerialLink::SerialLinkMasterPort::checkFunctional ( PacketPtr  pkt)

Check a functional request against the packets in our request queue.

Parameters
pktpacket to check against
Returns
true if we find a match

Definition at line 413 of file serial_link.cc.

References Packet::checkFunctional(), ArmISA::i, and Packet::makeResponse().

Referenced by SerialLink::SerialLinkSlavePort::recvFunctional().

void SerialLink::SerialLinkMasterPort::recvReqRetry ( )
protectedvirtual

When receiving a retry request from the peer port, pass it to the serial_link.

Implements MasterPort.

Definition at line 371 of file serial_link.cc.

bool SerialLink::SerialLinkMasterPort::recvTimingResp ( PacketPtr  pkt)
protectedvirtual

When receiving a timing request from the peer port, pass it to the serial_link.

Implements MasterPort.

Definition at line 139 of file serial_link.cc.

References Packet::cmdString(), divCeil(), DPRINTF, Packet::getAddr(), Packet::getSize(), Packet::headerDelay, Packet::payloadDelay, SerialLink::SerialLinkSlavePort::schedTimingResp(), SerialLink::slavePort, and ArmISA::t.

bool SerialLink::SerialLinkMasterPort::reqQueueFull ( ) const

Is this side blocked from accepting new request packets.

Returns
true if the occupied space has reached the set limit

Definition at line 133 of file serial_link.cc.

Referenced by SerialLink::SerialLinkSlavePort::recvTimingReq(), and SerialLink::SerialLinkSlavePort::trySendTiming().

void SerialLink::SerialLinkMasterPort::schedTimingReq ( PacketPtr  pkt,
Tick  when 
)

Queue a request packet to be sent out later and also schedule a send if necessary.

Parameters
pkta request to send out after a delay
whentick when response packet should be sent

Definition at line 249 of file serial_link.cc.

Referenced by SerialLink::SerialLinkSlavePort::recvTimingReq().

void SerialLink::SerialLinkMasterPort::trySendTiming ( )
private

Handle send event, scheduled when the packet at the head of the outbound queue is ready to transmit (for timing accesses only).

Definition at line 280 of file serial_link.cc.

References curTick(), divCeil(), DPRINTF, Packet::getAddr(), Packet::getSize(), SerialLink::SerialLinkSlavePort::retryStalledReq(), SerialLink::slavePort, ArmISA::t, and SerialLink::DeferredPacket::tick.

Member Data Documentation

const Cycles SerialLink::SerialLinkMasterPort::delay
private

Minimum delay though this serial_link.

Definition at line 229 of file serial_link.hh.

const unsigned int SerialLink::SerialLinkMasterPort::reqQueueLimit
private

Max queue size for request packets.

Definition at line 240 of file serial_link.hh.

EventWrapper<SerialLinkMasterPort, &SerialLinkMasterPort::trySendTiming> SerialLink::SerialLinkMasterPort::sendEvent
private

Send event for the request queue.

Definition at line 251 of file serial_link.hh.

SerialLink& SerialLink::SerialLinkMasterPort::serial_link
private

The serial_link to which this port belongs.

Definition at line 221 of file serial_link.hh.

SerialLinkSlavePort& SerialLink::SerialLinkMasterPort::slavePort
private

The slave port on the other side of the serial_link.

Definition at line 226 of file serial_link.hh.

std::deque<DeferredPacket> SerialLink::SerialLinkMasterPort::transmitList
private

Request packet queue.

Request packets are held in this queue for a specified delay to model the processing delay of the serial_link. We use a deque as we need to iterate over the items for functional accesses.

Definition at line 237 of file serial_link.hh.


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

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