/*
- * Copyright (c) 2011-2012 ARM Limited
+ * Copyright (c) 2011-2012,2015,2017 ARM Limited
* All rights reserved
*
* The license below extends only to copyright in the software and shall
#ifndef __MEM_PORT_HH__
#define __MEM_PORT_HH__
-#include <list>
-
-#include "base/range.hh"
+#include "base/addr_range.hh"
#include "mem/packet.hh"
-/**
- * This typedef is used to clean up getAddrRanges(). It's declared
- * outside the Port object since it's also used by some mem objects.
- * Eventually we should move this typedef to wherever Addr is
- * defined.
- */
-
-typedef std::list<Range<Addr> > AddrRangeList;
-typedef std::list<Range<Addr> >::iterator AddrRangeIter;
-
class MemObject;
/**
* Ports are used to interface memory objects to each other. A port is
* either a master or a slave and the connected peer is always of the
- * opposite role.
- *
- * Each port has a name and an owner, and enables three basic types of
- * accesses to the peer port: sendFunctional, sendAtomic and
- * sendTiming.
+ * opposite role. Each port has a name, an owner, and an identifier.
*/
class Port
{
protected:
- /** A pointer to the peer port. */
- Port* peer;
+ /**
+ * A numeric identifier to distinguish ports in a vector, and set
+ * to InvalidPortID in case this port is not part of a vector.
+ */
+ const PortID id;
/** A reference to the MemObject that owns this port. */
MemObject& owner;
*
* @param _name Port name including the owners name
* @param _owner The MemObject that is the structural owner of this port
+ * @param _id A port identifier for vector ports
*/
- Port(const std::string& _name, MemObject& _owner);
+ Port(const std::string& _name, MemObject& _owner, PortID _id);
/**
* Virtual destructor due to inheritance.
/** Return port name (for DPRINTF). */
const std::string name() const { return portName; }
- protected:
+ /** Get the port id. */
+ PortID getId() const { return id; }
- /** These functions are protected because they should only be
- * called by a peer port, never directly by any outside object. */
+};
- /**
- * Receive a timing request or response packet from the peer port.
- */
- virtual bool recvTiming(PacketPtr pkt) = 0;
+/** Forward declaration */
+class BaseSlavePort;
- /**
- * Receive a timing snoop request or snoop response packet from
- * the peer port.
- */
- virtual bool recvTimingSnoop(PacketPtr pkt)
- {
- panic("%s was not expecting a timing snoop\n", name());
- return false;
- }
+/**
+ * A BaseMasterPort is a protocol-agnostic master port, responsible
+ * only for the structural connection to a slave port. The final
+ * master port that inherits from the base class must override the
+ * bind member function for the specific slave port class.
+ */
+class BaseMasterPort : public Port
+{
- /**
- * Called by a peer port if sendTiming or sendTimingSnoop was
- * unsuccesful, and had to wait.
- */
- virtual void recvRetry() = 0;
+ protected:
+
+ BaseSlavePort* _baseSlavePort;
+
+ BaseMasterPort(const std::string& name, MemObject* owner,
+ PortID id = InvalidPortID);
+ virtual ~BaseMasterPort();
public:
- /**
- * Attempt to send a timing request or response packet to the peer
- * port by calling its receive function. If the send does not
- * succeed, as indicated by the return value, then the sender must
- * wait for a recvRetry at which point it can re-issue a
- * sendTiming.
- *
- * @param pkt Packet to send.
- *
- * @return If the send was succesful or not.
- */
- bool sendTiming(PacketPtr pkt) { return peer->recvTiming(pkt); }
+ virtual void bind(BaseSlavePort& slave_port) = 0;
+ virtual void unbind() = 0;
+ BaseSlavePort& getSlavePort() const;
+ bool isConnected() const;
- /**
- * Attempt to send a timing snoop request or snoop response packet
- * to the peer port by calling its receive function. If the send
- * does not succeed, as indicated by the return value, then the
- * sender must wait for a recvRetry at which point it can re-issue
- * a sendTimingSnoop.
- *
- * @param pkt Packet to send.
- *
- * @return If the send was succesful or not.
- */
- bool sendTimingSnoop(PacketPtr pkt) { return peer->recvTimingSnoop(pkt); }
+};
- /**
- * Send a retry to a peer port that previously attempted a
- * sendTiming or sendTimingSnoop which was unsuccessful.
- */
- void sendRetry() { return peer->recvRetry(); }
+/**
+ * A BaseSlavePort is a protocol-agnostic slave port, responsible
+ * only for the structural connection to a master port.
+ */
+class BaseSlavePort : public Port
+{
+
+ protected:
+
+ BaseMasterPort* _baseMasterPort;
+
+ BaseSlavePort(const std::string& name, MemObject* owner,
+ PortID id = InvalidPortID);
+ virtual ~BaseSlavePort();
+
+ public:
+
+ BaseMasterPort& getMasterPort() const;
+ bool isConnected() const;
};
class SlavePort;
/**
- * A MasterPort is a specialisation of a port. In addition to the
- * basic functionality of sending packets to its slave peer, it also
- * has functions specific to a master, e.g. to receive range changes
- * or determine if the port is snooping or not.
+ * A MasterPort is a specialisation of a BaseMasterPort, which
+ * implements the default protocol for the three different level of
+ * transport functions. In addition to the basic functionality of
+ * sending packets, it also has functions to receive range changes or
+ * determine if the port is snooping or not.
*/
-class MasterPort : public Port
+class MasterPort : public BaseMasterPort
{
+ friend class SlavePort;
+
private:
SlavePort* _slavePort;
public:
- MasterPort(const std::string& name, MemObject* owner);
+ MasterPort(const std::string& name, MemObject* owner,
+ PortID id = InvalidPortID);
virtual ~MasterPort();
- void bind(SlavePort& slave_port);
- SlavePort& getSlavePort() const;
- bool isConnected() const;
+ /**
+ * Bind this master port to a slave port. This also does the
+ * mirror action and binds the slave port to the master port.
+ */
+ void bind(BaseSlavePort& slave_port);
+
+ /**
+ * Unbind this master port and the associated slave port.
+ */
+ void unbind();
/**
* Send an atomic request packet, where the data is moved and the
void sendFunctional(PacketPtr pkt);
/**
- * Receive an atomic snoop request packet from the slave port.
+ * Attempt to send a timing request to the slave port by calling
+ * its corresponding receive function. If the send does not
+ * succeed, as indicated by the return value, then the sender must
+ * wait for a recvReqRetry at which point it can re-issue a
+ * sendTimingReq.
+ *
+ * @param pkt Packet to send.
+ *
+ * @return If the send was succesful or not.
+ */
+ bool sendTimingReq(PacketPtr pkt);
+
+ /**
+ * Check if the slave can handle a timing request.
+ *
+ * If the send cannot be handled at the moment, as indicated by
+ * the return value, then the sender will receive a recvReqRetry
+ * at which point it can re-issue a sendTimingReq.
+ *
+ * @param pkt Packet to send.
+ *
+ * @return If the send was succesful or not.
*/
- virtual Tick recvAtomicSnoop(PacketPtr pkt)
- {
- panic("%s was not expecting an atomic snoop\n", name());
- return 0;
- }
+ bool tryTiming(PacketPtr pkt) const;
/**
- * Receive a functional snoop request packet from the slave port.
+ * Attempt to send a timing snoop response packet to the slave
+ * port by calling its corresponding receive function. If the send
+ * does not succeed, as indicated by the return value, then the
+ * sender must wait for a recvRetrySnoop at which point it can
+ * re-issue a sendTimingSnoopResp.
+ *
+ * @param pkt Packet to send.
*/
- virtual void recvFunctionalSnoop(PacketPtr pkt)
- {
- panic("%s was not expecting a functional snoop\n", name());
- }
+ bool sendTimingSnoopResp(PacketPtr pkt);
/**
- * Called to receive an address range change from the peer slave
- * port. the default implementation ignored the change and does
- * nothing. Override this function in a derived class if the owner
- * needs to be aware of he laesddress ranges, e.g. in an
- * interconnect component like a bus.
+ * Send a retry to the slave port that previously attempted a
+ * sendTimingResp to this master port and failed. Note that this
+ * is virtual so that the "fake" snoop response port in the
+ * coherent crossbar can override the behaviour.
*/
- virtual void recvRangeChange() { }
+ virtual void sendRetryResp();
/**
* Determine if this master port is snooping or not. The default
virtual bool isSnooping() const { return false; }
/**
- * Called by a peer port in order to determine the block size of
- * the owner of this port.
+ * Get the address ranges of the connected slave port.
*/
- virtual unsigned deviceBlockSize() const { return 0; }
-
- /** Called by the associated device if it wishes to find out the blocksize
- of the device on attached to the peer port.
- */
- unsigned peerBlockSize() const;
+ AddrRangeList getAddrRanges() const;
/** Inject a PrintReq for the given address to print the state of
* that address throughout the memory system. For debugging.
*/
void printAddr(Addr a);
+
+ protected:
+
+ /**
+ * Receive an atomic snoop request packet from the slave port.
+ */
+ virtual Tick recvAtomicSnoop(PacketPtr pkt)
+ {
+ panic("%s was not expecting an atomic snoop request\n", name());
+ return 0;
+ }
+
+ /**
+ * Receive a functional snoop request packet from the slave port.
+ */
+ virtual void recvFunctionalSnoop(PacketPtr pkt)
+ {
+ panic("%s was not expecting a functional snoop request\n", name());
+ }
+
+ /**
+ * Receive a timing response from the slave port.
+ */
+ virtual bool recvTimingResp(PacketPtr pkt) = 0;
+
+ /**
+ * Receive a timing snoop request from the slave port.
+ */
+ virtual void recvTimingSnoopReq(PacketPtr pkt)
+ {
+ panic("%s was not expecting a timing snoop request\n", name());
+ }
+
+ /**
+ * Called by the slave port if sendTimingReq was called on this
+ * master port (causing recvTimingReq to be called on the slave
+ * port) and was unsuccesful.
+ */
+ virtual void recvReqRetry() = 0;
+
+ /**
+ * Called by the slave port if sendTimingSnoopResp was called on this
+ * master port (causing recvTimingSnoopResp to be called on the slave
+ * port) and was unsuccesful.
+ */
+ virtual void recvRetrySnoopResp()
+ {
+ panic("%s was not expecting a snoop retry\n", name());
+ }
+
+ /**
+ * Called to receive an address range change from the peer slave
+ * port. The default implementation ignores the change and does
+ * nothing. Override this function in a derived class if the owner
+ * needs to be aware of the address ranges, e.g. in an
+ * interconnect component like a bus.
+ */
+ virtual void recvRangeChange() { }
};
/**
* has functions specific to a slave, e.g. to send range changes
* and get the address ranges that the port responds to.
*/
-class SlavePort : public Port
+class SlavePort : public BaseSlavePort
{
+ friend class MasterPort;
+
private:
MasterPort* _masterPort;
public:
- SlavePort(const std::string& name, MemObject* owner);
+ SlavePort(const std::string& name, MemObject* owner,
+ PortID id = InvalidPortID);
virtual ~SlavePort();
- void bind(MasterPort& master_port);
- MasterPort& getMasterPort() const;
- bool isConnected() const;
-
/**
* Send an atomic snoop request packet, where the data is moved
* and the state is updated in zero time, without interleaving
void sendFunctionalSnoop(PacketPtr pkt);
/**
- * Receive an atomic request packet from the master port.
+ * Attempt to send a timing response to the master port by calling
+ * its corresponding receive function. If the send does not
+ * succeed, as indicated by the return value, then the sender must
+ * wait for a recvRespRetry at which point it can re-issue a
+ * sendTimingResp.
+ *
+ * @param pkt Packet to send.
+ *
+ * @return If the send was succesful or not.
+ */
+ bool sendTimingResp(PacketPtr pkt);
+
+ /**
+ * Attempt to send a timing snoop request packet to the master port
+ * by calling its corresponding receive function. Snoop requests
+ * always succeed and hence no return value is needed.
+ *
+ * @param pkt Packet to send.
*/
- virtual Tick recvAtomic(PacketPtr pkt) = 0;
+ void sendTimingSnoopReq(PacketPtr pkt);
/**
- * Receive a functional request packet from the master port.
+ * Send a retry to the master port that previously attempted a
+ * sendTimingReq to this slave port and failed.
*/
- virtual void recvFunctional(PacketPtr pkt) = 0;
+ void sendRetryReq();
/**
- * Called by a peer port in order to determine the block size of
- * the owner of this port.
+ * Send a retry to the master port that previously attempted a
+ * sendTimingSnoopResp to this slave port and failed.
*/
- virtual unsigned deviceBlockSize() const { return 0; }
+ void sendRetrySnoopResp();
- /** Called by the associated device if it wishes to find out the blocksize
- of the device on attached to the peer port.
- */
- unsigned peerBlockSize() const;
+ /**
+ * Find out if the peer master port is snooping or not.
+ *
+ * @return true if the peer master port is snooping
+ */
+ bool isSnooping() const { return _masterPort->isSnooping(); }
/**
* Called by the owner to send a range change
*/
- void sendRangeChange() const { _masterPort->recvRangeChange(); }
+ void sendRangeChange() const {
+ if (!_masterPort)
+ fatal("%s cannot sendRangeChange() without master port", name());
+ _masterPort->recvRangeChange();
+ }
/**
* Get a list of the non-overlapping address ranges the owner is
*
* @return a list of ranges responded to
*/
- virtual AddrRangeList getAddrRanges() = 0;
+ virtual AddrRangeList getAddrRanges() const = 0;
+
+ protected:
+
+ /**
+ * Called by the master port to unbind. Should never be called
+ * directly.
+ */
+ void unbind();
+
+ /**
+ * Called by the master port to bind. Should never be called
+ * directly.
+ */
+ void bind(MasterPort& master_port);
+
+ /**
+ * Receive an atomic request packet from the master port.
+ */
+ virtual Tick recvAtomic(PacketPtr pkt) = 0;
+
+ /**
+ * Receive a functional request packet from the master port.
+ */
+ virtual void recvFunctional(PacketPtr pkt) = 0;
+
+ /**
+ * Receive a timing request from the master port.
+ */
+ virtual bool recvTimingReq(PacketPtr pkt) = 0;
+
+ /**
+ * Availability request from the master port.
+ */
+ virtual bool tryTiming(PacketPtr pkt) {
+ panic("%s was not expecting a %s\n", name(), __func__);
+ }
+
+ /**
+ * Receive a timing snoop response from the master port.
+ */
+ virtual bool recvTimingSnoopResp(PacketPtr pkt)
+ {
+ panic("%s was not expecting a timing snoop response\n", name());
+ }
+
+ /**
+ * 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.
+ */
+ virtual void recvRespRetry() = 0;
+
};
#endif //__MEM_PORT_HH__
projects / gem5.git / blobdiff