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

#include <serial_link.hh>

Inheritance diagram for gem5::SerialLink::SerialLinkRequestPort:

Public Member Functions
	SerialLinkRequestPort (const std::string &_name, SerialLink &_serial_link, SerialLinkResponsePort &_cpu_side_port, Cycles _delay, int _req_limit)
	Constructor for the SerialLinkRequestPort.

bool	reqQueueFull () const
	Is this side blocked from accepting new request packets.

void	schedTimingReq (PacketPtr pkt, Tick when)
	Queue a request packet to be sent out later and also schedule a send if necessary.

bool	trySatisfyFunctional (PacketPtr pkt)
	Check a functional request against the packets in our request queue.

Public Member Functions inherited from gem5::RequestPort
	RequestPort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
	Request port.

	RequestPort (const std::string &name, PortID id=InvalidPortID)

virtual	~RequestPort ()

void	bind (Port &peer) override
	Bind this request port to a response port.

void	unbind () override
	Unbind this request port and the associated response port.

virtual bool	isSnooping () const
	Determine if this request port is snooping or not.

AddrRangeList	getAddrRanges () const
	Get the address ranges of the connected responder port.

void	printAddr (Addr a)
	Inject a PrintReq for the given address to print the state of that address throughout the memory system.

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.

Tick	sendAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor)
	Send an atomic request packet like above, but also request a backdoor to the data being accessed.

void	sendFunctional (PacketPtr pkt) const
	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.

void	sendMemBackdoorReq (const MemBackdoorReq &req, MemBackdoorPtr &backdoor)
	Send a request for a back door to a range of memory.

bool	sendTimingReq (PacketPtr pkt)
	Attempt to send a timing request to the responder port by calling its corresponding receive function.

bool	tryTiming (PacketPtr pkt) const
	Check if the responder can handle a timing request.

bool	sendTimingSnoopResp (PacketPtr pkt)
	Attempt to send a timing snoop response packet to the response port by calling its corresponding receive function.

virtual void	sendRetryResp ()
	Send a retry to the response port that previously attempted a sendTimingResp to this request port and failed.

Public Member Functions inherited from gem5::Port
virtual	~Port ()
	Virtual destructor due to inheritance.

Port &	getPeer ()
	Return a reference to this port's peer.

const std::string	name () const
	Return port name (for DPRINTF).

PortID	getId () const
	Get the port id.

bool	isConnected () const
	Is this port currently connected to a peer?

void	takeOverFrom (Port *old)
	A utility function to make it easier to swap out ports.

Protected Member Functions
bool	recvTimingResp (PacketPtr pkt)
	When receiving a timing request from the peer port, pass it to the serial_link.

void	recvReqRetry ()
	When receiving a retry request from the peer port, pass it to the serial_link.

Protected Member Functions inherited from gem5::RequestPort
virtual void	recvRangeChange ()
	Called to receive an address range change from the peer response port.

Tick	recvAtomicSnoop (PacketPtr pkt) override
	Default implementations.

void	recvFunctionalSnoop (PacketPtr pkt) override
	Receive a functional snoop request packet from the peer.

void	recvTimingSnoopReq (PacketPtr pkt) override
	Receive a timing snoop request from the peer.

void	recvRetrySnoopResp () override
	Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to be called on the peer) and was unsuccessful.

Protected Member Functions inherited from gem5::Port
void	reportUnbound () const

	Port (const std::string &_name, PortID _id)
	Abstract base class for ports.

Protected Member Functions inherited from gem5::AtomicRequestProtocol
Tick	send (AtomicResponseProtocol *peer, 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.

Tick	sendBackdoor (AtomicResponseProtocol *peer, PacketPtr pkt, MemBackdoorPtr &backdoor)
	Send an atomic request packet like above, but also request a backdoor to the data being accessed.

Protected Member Functions inherited from gem5::TimingRequestProtocol
bool	sendReq (TimingResponseProtocol *peer, PacketPtr pkt)
	Attempt to send a timing request to the peer by calling its corresponding receive function.

bool	trySend (TimingResponseProtocol *peer, PacketPtr pkt) const
	Check if the peer can handle a timing request.

bool	sendSnoopResp (TimingResponseProtocol *peer, PacketPtr pkt)
	Attempt to send a timing snoop response packet to it's peer by calling its corresponding receive function.

void	sendRetryResp (TimingResponseProtocol *peer)
	Send a retry to the peer that previously attempted a sendTimingResp to this protocol and failed.

Protected Member Functions inherited from gem5::FunctionalRequestProtocol
void	send (FunctionalResponseProtocol *peer, PacketPtr pkt) const
	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.

void	sendMemBackdoorReq (FunctionalResponseProtocol *peer, const MemBackdoorReq &req, MemBackdoorPtr &backdoor)
	Send a request for a back door to a range of memory.

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).

Private Attributes
SerialLink &	serial_link
	The serial_link to which this port belongs.

SerialLinkResponsePort &	cpu_side_port
	The response (CPU-side port) port on the other side of the serial_link.

const Cycles	delay
	Minimum delay though this serial_link.

std::deque< DeferredPacket >	transmitList
	Request packet queue.

const unsigned int	reqQueueLimit
	Max queue size for request packets.

EventFunctionWrapper	sendEvent
	Send event for the request queue.

Additional Inherited Members
Protected Attributes inherited from gem5::RequestPort
SimObject &	owner

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.

Port *	_peer
	A pointer to this port's peer.

bool	_connected
	Whether this port is currently connected to a peer port.

Detailed Description

Port on the side that forwards requests and receives responses.

The memory-side port has a buffer for the requests not yet sent.

Definition at line 213 of file serial_link.hh.

Constructor & Destructor Documentation

◆ SerialLinkRequestPort()

gem5::SerialLink::SerialLinkRequestPort::SerialLinkRequestPort	(	const std::string &	_name,
		SerialLink &	_serial_link,
		SerialLinkResponsePort &	_cpu_side_port,
		Cycles	_delay,
		int	_req_limit )

Constructor for the SerialLinkRequestPort.

Parameters

_name	the port name including the owner
_serial_link	the structural owner
_cpu_side_port	the CPU-side port on the other side of the serial_link
_delay	the delay in cycles from receiving to sending
_req_limit	the size of the request queue

Definition at line 73 of file serial_link.cc.

References trySendTiming().

Member Function Documentation

◆ recvReqRetry()

void gem5::SerialLink::SerialLinkRequestPort::recvReqRetry ( )

protectedvirtual

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

Implements gem5::TimingRequestProtocol.

Definition at line 363 of file serial_link.cc.

◆ recvTimingResp()

bool gem5::SerialLink::SerialLinkRequestPort::recvTimingResp ( PacketPtr pkt )

protectedvirtual

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

Implements gem5::TimingRequestProtocol.

Definition at line 131 of file serial_link.cc.

References gem5::Packet::cmdString(), gem5::SerialLink::cpu_side_port, gem5::divCeil(), DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::headerDelay, gem5::Packet::payloadDelay, gem5::SerialLink::SerialLinkResponsePort::schedTimingResp(), and gem5::ArmISA::t.

◆ reqQueueFull()

bool gem5::SerialLink::SerialLinkRequestPort::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 125 of file serial_link.cc.

Referenced by gem5::SerialLink::SerialLinkResponsePort::recvTimingReq(), and gem5::SerialLink::SerialLinkResponsePort::trySendTiming().

◆ schedTimingReq()

void gem5::SerialLink::SerialLinkRequestPort::schedTimingReq	(	PacketPtr	pkt,
		Tick	when )

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

Parameters

pkt	a request to send out after a delay
when	tick when response packet should be sent

Definition at line 241 of file serial_link.cc.

References gem5::ArmISA::sendEvent().

Referenced by gem5::SerialLink::SerialLinkResponsePort::recvTimingReq().

◆ trySatisfyFunctional()

bool gem5::SerialLink::SerialLinkRequestPort::trySatisfyFunctional ( PacketPtr pkt )

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

Parameters

pkt	packet to check against

Returns: true if we find a match

Definition at line 405 of file serial_link.cc.

References gem5::ArmISA::i, gem5::Packet::makeResponse(), and gem5::Packet::trySatisfyFunctional().

Referenced by gem5::SerialLink::SerialLinkResponsePort::recvFunctional().

◆ trySendTiming()

void gem5::SerialLink::SerialLinkRequestPort::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 272 of file serial_link.cc.

References gem5::SerialLink::cpu_side_port, gem5::curTick(), gem5::divCeil(), DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::SerialLink::DeferredPacket::pkt, gem5::SerialLink::SerialLinkResponsePort::retryStalledReq(), gem5::ArmISA::sendEvent(), gem5::ArmISA::t, and gem5::SerialLink::DeferredPacket::tick.

Referenced by SerialLinkRequestPort().

Member Data Documentation

◆ cpu_side_port

SerialLinkResponsePort& gem5::SerialLink::SerialLinkRequestPort::cpu_side_port

private

The response (CPU-side port) port on the other side of the serial_link.

Definition at line 225 of file serial_link.hh.

◆ delay

const Cycles gem5::SerialLink::SerialLinkRequestPort::delay

private

Minimum delay though this serial_link.

Definition at line 228 of file serial_link.hh.

◆ reqQueueLimit

const unsigned int gem5::SerialLink::SerialLinkRequestPort::reqQueueLimit

private

Max queue size for request packets.

Definition at line 239 of file serial_link.hh.

◆ sendEvent

EventFunctionWrapper gem5::SerialLink::SerialLinkRequestPort::sendEvent

private

Send event for the request queue.

Definition at line 249 of file serial_link.hh.

◆ serial_link

SerialLink& gem5::SerialLink::SerialLinkRequestPort::serial_link

private

The serial_link to which this port belongs.

Definition at line 219 of file serial_link.hh.

◆ transmitList

std::deque<DeferredPacket> gem5::SerialLink::SerialLinkRequestPort::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 236 of file serial_link.hh.

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

mem/serial_link.hh
mem/serial_link.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SerialLinkRequestPort()

Member Function Documentation

◆ recvReqRetry()

◆ recvTimingResp()

◆ reqQueueFull()

◆ schedTimingReq()

◆ trySatisfyFunctional()

◆ trySendTiming()

Member Data Documentation

◆ cpu_side_port

◆ delay

◆ reqQueueLimit

◆ sendEvent

◆ serial_link

◆ transmitList