#include <token_port.hh>

Inheritance diagram for TokenSlavePort:

Public Member Functions
	TokenSlavePort (const std::string &name, ClockedObject *owner, PortID id=InvalidPortID)

	~TokenSlavePort ()

void	bind (Port &peer) override
	Bind this slave port to a master port. More...

void	unbind () override
	Unbind this slave port and associated master port. More...

void	sendTokens (int num_tokens)
	Return num_tokens tokens back to the master port. More...

bool	sendTimingResp (PacketPtr pkt)

bool	trySatisfyFunctional (PacketPtr)

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

virtual AddrRangeList	getAddrRanges () const =0
	Get a list of the non-overlapping address ranges the owner is responsible for. 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...

Port &	getPeer ()
	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...

Private Member Functions
void	recvRespRetry () override
	Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called on the peer) and was unsuccessful. More...

Private Attributes
TokenMasterPort *	tokenMasterPort

std::deque< PacketPtr >	respQueue

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

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

Protected Attributes inherited from SlavePort
SimObject &	owner

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

Detailed Description

Definition at line 90 of file token_port.hh.

Constructor & Destructor Documentation

◆ TokenSlavePort()

TokenSlavePort::TokenSlavePort	(	const std::string &	name,
		ClockedObject *	owner,
		PortID	id = `InvalidPortID`
	)

inline

Definition at line 100 of file token_port.hh.

◆ ~TokenSlavePort()

TokenSlavePort::~TokenSlavePort ( )

inline

Definition at line 104 of file token_port.hh.

References TokenMasterPort::bind(), and TokenMasterPort::unbind().

Member Function Documentation

◆ bind()

void TokenSlavePort::bind ( Port & peer )

overridevirtual

Bind this slave port to a master port.

This also does the mirror action and bainds the master port to the slave port as well as binding the base class types.

Reimplemented from SlavePort.

Definition at line 88 of file token_port.cc.

References fatal, and Port::name().

◆ recvRespRetry()

void TokenSlavePort::recvRespRetry ( )

overrideprivatevirtual

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

Implements TimingResponseProtocol.

Definition at line 117 of file token_port.cc.

References panic_if, and SlavePort::sendTimingResp().

◆ sendTimingResp()

bool TokenSlavePort::sendTimingResp ( PacketPtr pkt )

Definition at line 132 of file token_port.cc.

References SlavePort::sendTimingResp().

◆ sendTokens()

void TokenSlavePort::sendTokens ( int num_tokens )

Return num_tokens tokens back to the master port.

Definition at line 79 of file token_port.cc.

References fatal_if.

◆ trySatisfyFunctional()

bool TokenSlavePort::trySatisfyFunctional ( PacketPtr )

inline

Definition at line 126 of file token_port.hh.

◆ unbind()

void TokenSlavePort::unbind ( )

overridevirtual

Unbind this slave port and associated master port.

Reimplemented from SlavePort.

Definition at line 110 of file token_port.cc.

References SlavePort::slaveUnbind().

Member Data Documentation

◆ respQueue

std::deque<PacketPtr> TokenSlavePort::respQueue

private

Definition at line 95 of file token_port.hh.

◆ tokenMasterPort

TokenMasterPort* TokenSlavePort::tokenMasterPort

private

Definition at line 93 of file token_port.hh.

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

mem/token_port.hh
mem/token_port.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TokenSlavePort()

◆ ~TokenSlavePort()

Member Function Documentation

◆ bind()

◆ recvRespRetry()

◆ sendTimingResp()

◆ sendTokens()

◆ trySatisfyFunctional()

◆ unbind()

Member Data Documentation

◆ respQueue

◆ tokenMasterPort