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 PioPort< Device >:

Public Member Functions
	PioPort (Device *dev)

Public Member Functions inherited from 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. More...

virtual	~SimpleTimingPort ()

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

virtual	~QueuedSlavePort ()

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

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

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

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

void	bind (Port &peer) override
	Attach to a peer port. 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...

Protected Member Functions
Tick	recvAtomic (PacketPtr pkt) override
	Receive an atomic request packet from the peer. More...

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

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

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

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

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

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

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

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

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

Protected Attributes inherited from QueuedSlavePort
RespPacketQueue &	respQueue
	Packet queue used to store outgoing responses. 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

template<class Device>
class 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>

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

inline

Definition at line 90 of file io_device.hh.

Member Function Documentation

◆ getAddrRanges()

template<class Device>

AddrRangeList PioPort< Device >::getAddrRanges ( ) const

inlineoverrideprotectedvirtual

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

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

Returns: a list of ranges responded to

Implements SlavePort.

Definition at line 84 of file io_device.hh.

Referenced by BasicPioDevice::params().

◆ recvAtomic()

template<class Device>

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

inlineoverrideprotectedvirtual

Receive an atomic request packet from the peer.

Implements SimpleTimingPort.

Definition at line 70 of file io_device.hh.

Member Data Documentation

◆ device

template<class Device>

Device* PioPort< Device >::device

protected

The device that this port serves.

Definition at line 67 of file io_device.hh.

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

template<class Device> class PioPort< Device >

Constructor & Destructor Documentation

◆ PioPort()

Member Function Documentation

◆ getAddrRanges()

◆ recvAtomic()

Member Data Documentation

◆ device

template<class Device>
class PioPort< Device >