gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PioPort Class Reference

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:
SimpleTimingPort QueuedSlavePort SlavePort BaseSlavePort Port

Public Member Functions

 PioPort (PioDevice *dev)
 
- Public Member Functions inherited from SimpleTimingPort
 SimpleTimingPort (const std::string &name, MemObject *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, MemObject *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, bool force_order=false)
 Schedule the sending of a timing response. More...
 
bool checkFunctional (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, MemObject *owner, PortID id=InvalidPortID)
 Slave port. More...
 
virtual ~SlavePort ()
 
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)
 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...
 
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...
 
- Public Member Functions inherited from BaseSlavePort
BaseMasterPortgetMasterPort () const
 
bool isConnected () const
 
- Public Member Functions inherited from Port
const std::string name () const
 Return port name (for DPRINTF). More...
 
PortID getId () const
 Get the port id. More...
 

Protected Member Functions

virtual Tick recvAtomic (PacketPtr pkt)
 Receive an atomic request packet from the master port. More...
 
virtual AddrRangeList getAddrRanges () const
 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 master port if sendTimingResp was called on this slave port (causing recvTimingResp to be called on the master port) and was unsuccesful. More...
 
- Protected Member Functions inherited from SlavePort
void unbind ()
 Called by the master port to unbind. More...
 
void bind (MasterPort &master_port)
 Called by the master port to bind. More...
 
virtual bool recvTimingSnoopResp (PacketPtr pkt)
 Receive a timing snoop response from the master port. More...
 
- Protected Member Functions inherited from BaseSlavePort
 BaseSlavePort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 
virtual ~BaseSlavePort ()
 
- Protected Member Functions inherited from Port
 Port (const std::string &_name, MemObject &_owner, PortID _id)
 Abstract base class for ports. More...
 
virtual ~Port ()
 Virtual destructor due to inheritance. More...
 

Protected Attributes

PioDevicedevice
 The device that this port serves. More...
 
- Protected Attributes inherited from SimpleTimingPort
std::unique_ptr< PacketpendingDelete
 Upstream caches need this packet until true is returned, so hold it for deletion until a subsequent call. More...
 
- Protected Attributes inherited from QueuedSlavePort
RespPacketQueuerespQueue
 Packet queue used to store outgoing responses. More...
 
- Protected Attributes inherited from BaseSlavePort
BaseMasterPort_baseMasterPort
 
- 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...
 
MemObjectowner
 A reference to the MemObject that owns this port. More...
 

Detailed Description

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 62 of file io_device.hh.

Constructor & Destructor Documentation

PioPort::PioPort ( PioDevice dev)

Definition at line 50 of file io_device.cc.

Member Function Documentation

AddrRangeList PioPort::getAddrRanges ( ) const
protectedvirtual

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 69 of file io_device.cc.

References device, and PioDevice::getAddrRanges().

Tick PioPort::recvAtomic ( PacketPtr  pkt)
protectedvirtual

Receive an atomic request packet from the master port.

Implements SimpleTimingPort.

Definition at line 56 of file io_device.cc.

References device, Packet::headerDelay, Packet::isError(), Packet::isRead(), Packet::isResponse(), Packet::payloadDelay, PioDevice::read(), and PioDevice::write().

Member Data Documentation

PioDevice* PioPort::device
protected

The device that this port serves.

Definition at line 66 of file io_device.hh.

Referenced by getAddrRanges(), and recvAtomic().


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

Generated on Fri Jun 9 2017 13:04:16 for gem5 by doxygen 1.8.6