The PioPort class is a programmed i/o port that all devices that are sensitive to an address range use. More...

#include <io_device.hh>

Inheritance diagram for gem5::PioPort< Device >:

Public Member Functions
	PioPort (Device *dev)

Public Member Functions inherited from gem5::SimpleTimingPort
	SimpleTimingPort (const std::string &name, SimObject *owner)
	Create a new SimpleTimingPort that relies on a packet queue to hold responses, and implements recvTimingReq and recvFunctional through calls to recvAtomic.

virtual	~SimpleTimingPort ()

Public Member Functions inherited from gem5::QueuedResponsePort
	QueuedResponsePort (const std::string &name, RespPacketQueue &resp_queue, PortID id=InvalidPortID)
	Create a QueuedPort with a given name, owner, and a supplied implementation of a packet queue.

virtual	~QueuedResponsePort ()

void	schedTimingResp (PacketPtr pkt, Tick when)
	Schedule the sending of a timing response.

bool	trySatisfyFunctional (PacketPtr pkt)
	Check the list of buffered packets against the supplied functional request.

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 Member Functions
Tick	recvAtomic (PacketPtr pkt) override
	Receive an atomic request packet from the peer.

AddrRangeList	getAddrRanges () const override
	Get a list of the non-overlapping address ranges the owner is responsible for.

Protected Member Functions inherited from gem5::SimpleTimingPort
void	recvFunctional (PacketPtr pkt)
	Implemented using recvAtomic().

bool	recvTimingReq (PacketPtr pkt)
	Implemented using recvAtomic().

Protected Member Functions inherited from gem5::QueuedResponsePort
void	recvRespRetry ()
	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::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.

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.

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.

Protected Attributes
Device *	device
	The device that this port serves.

Protected Attributes inherited from gem5::SimpleTimingPort
std::unique_ptr< Packet >	pendingDelete
	Upstream caches need this packet until true is returned, so hold it for deletion until a subsequent call.

Protected Attributes inherited from gem5::QueuedResponsePort
RespPacketQueue &	respQueue
	Packet queue used to store outgoing responses.

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.

Detailed Description

template<class Device>
class gem5::PioPort< Device >

The PioPort class is a programmed i/o port that all devices that are sensitive to an address range use.

The port takes all the memory access types and roles them into one read() and write() call that the device must respond to. The device must also provide getAddrRanges() function with which it returns the address ranges it is interested in.

Definition at line 63 of file io_device.hh.

Constructor & Destructor Documentation

◆ PioPort()

template<class Device >

gem5::PioPort< Device >::PioPort ( Device * dev )

inline

Definition at line 90 of file io_device.hh.

Member Function Documentation

◆ getAddrRanges()

template<class Device >

AddrRangeList gem5::PioPort< Device >::getAddrRanges ( ) const

inlineoverrideprotectedvirtual

Get a list of the non-overlapping address ranges the owner is responsible for.

All response ports must override this function and return a populated list with at least one item.

Returns: a list of ranges responded to

Implements gem5::ResponsePort.

Definition at line 84 of file io_device.hh.

References gem5::PioPort< Device >::device.

◆ recvAtomic()

template<class Device >

Tick gem5::PioPort< Device >::recvAtomic ( PacketPtr pkt )

inlineoverrideprotectedvirtual

Receive an atomic request packet from the peer.

Implements gem5::SimpleTimingPort.

Definition at line 70 of file io_device.hh.

References gem5::PioPort< Device >::device, gem5::Packet::headerDelay, gem5::Packet::isError(), gem5::Packet::isRead(), gem5::Packet::isResponse(), and gem5::Packet::payloadDelay.

Member Data Documentation

◆ device

template<class Device >

Device* gem5::PioPort< Device >::device

protected

The device that this port serves.

Definition at line 67 of file io_device.hh.

Referenced by gem5::PioPort< Device >::getAddrRanges(), and gem5::PioPort< Device >::recvAtomic().

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

dev/io_device.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PioPort()

Member Function Documentation

◆ getAddrRanges()

◆ recvAtomic()

Member Data Documentation

◆ device