Derive from this class to create an external port interface. More...

#include <external_slave.hh>

Inheritance diagram for gem5::ExternalSlave::ExternalPort:

Public Member Functions
	ExternalPort (const std::string &name_, ExternalSlave &owner_)

	~ExternalPort ()

AddrRangeList	getAddrRanges () const
	Any or all of recv... can be overloaded to provide the port's functionality.

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

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

virtual	~ResponsePort ()

bool	isSnooping () const
	Find out if the peer request port is snooping or not.

void	sendRangeChange () const
	Called by the owner to send a range change.

void	unbind () override
	We let the request port do the work, so these don't do anything.

void	bind (Port &peer) override
	Attach to a peer port.

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.

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.

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

void	sendTimingSnoopReq (PacketPtr pkt)
	Attempt to send a timing snoop request packet to the request port by calling its corresponding receive function.

void	sendRetryReq ()
	Send a retry to the request port that previously attempted a sendTimingReq to this response port and failed.

void	sendRetrySnoopResp ()
	Send a retry to the request port that previously attempted a sendTimingSnoopResp to this response 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 Attributes
ExternalSlave &	owner

Protected Attributes inherited from gem5::ResponsePort
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.

Additional Inherited Members
Protected Member Functions inherited from gem5::ResponsePort
void	responderUnbind ()
	Called by the request port to unbind.

void	responderBind (RequestPort &request_port)
	Called by the request port to bind.

Tick	recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor) override
	Default implementations.

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

bool	tryTiming (PacketPtr pkt) override
	Availability request from the peer.

bool	recvTimingSnoopResp (PacketPtr pkt) override
	Receive a timing snoop response from the peer.

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

virtual Tick	recvAtomic (PacketPtr pkt)=0
	Receive an atomic request packet from the peer.

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.

void	sendSnoopReq (TimingRequestProtocol *peer, PacketPtr pkt)
	Attempt to send a timing snoop request packet to the peer by calling its corresponding receive function.

void	sendRetryReq (TimingRequestProtocol *peer)
	Send a retry to the peer that previously attempted a sendTimingReq to this protocol and failed.

void	sendRetrySnoopResp (TimingRequestProtocol *peer)
	Send a retry to the peer that previously attempted a sendTimingSnoopResp to this peer and failed.

virtual bool	recvTimingReq (PacketPtr pkt)=0
	Receive a timing request from the peer.

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

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.

virtual void	recvFunctional (PacketPtr pkt)=0
	Receive a functional request packet from the peer.

Detailed Description

Derive from this class to create an external port interface.

Definition at line 72 of file external_slave.hh.

Constructor & Destructor Documentation

◆ ExternalPort()

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

inline

Definition at line 78 of file external_slave.hh.

Referenced by gem5::StubSlavePort::recvAtomic().

◆ ~ExternalPort()

gem5::ExternalSlave::ExternalPort::~ExternalPort ( )

inline

Definition at line 83 of file external_slave.hh.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::ExternalSlave::ExternalPort::getAddrRanges ( ) const

virtual

Any or all of recv... can be overloaded to provide the port's functionality.

Implements gem5::ResponsePort.

Definition at line 180 of file external_slave.cc.

References gem5::ExternalSlave::addrRanges, and owner.

Member Data Documentation

◆ owner

ExternalSlave& gem5::ExternalSlave::ExternalPort::owner

protected

Definition at line 75 of file external_slave.hh.

Referenced by getAddrRanges(), and gem5::StubSlavePort::recvTimingReq().

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

mem/external_slave.hh
mem/external_slave.cc

Public Member Functions

Protected Attributes

Additional Inherited Members