/*
- * 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
#define __MEM_PORT_HH__
#include "base/addr_range.hh"
+#include "mem/backdoor.hh"
#include "mem/packet.hh"
+#include "sim/port.hh"
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, an owner, and an identifier.
- */
-class Port
-{
-
- private:
-
- /** Descriptive name (for DPRINTF output) */
- std::string portName;
-
- protected:
-
- /**
- * 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;
-
- /**
- * Abstract base class for ports
- *
- * @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, PortID _id);
-
- /**
- * Virtual destructor due to inheritance.
- */
- virtual ~Port();
-
- public:
-
- /** Return port name (for DPRINTF). */
- const std::string name() const { return portName; }
-
- /** Get the port id. */
- PortID getId() const { return id; }
-
-};
-
/** Forward declaration */
class BaseSlavePort;
BaseSlavePort* _baseSlavePort;
- BaseMasterPort(const std::string& name, MemObject* owner,
- PortID id = InvalidPortID);
+ BaseMasterPort(const std::string& name, PortID id=InvalidPortID);
virtual ~BaseMasterPort();
public:
- virtual void bind(BaseSlavePort& slave_port) = 0;
- virtual void unbind() = 0;
BaseSlavePort& getSlavePort() const;
- bool isConnected() const;
};
BaseMasterPort* _baseMasterPort;
- BaseSlavePort(const std::string& name, MemObject* owner,
- PortID id = InvalidPortID);
+ BaseSlavePort(const std::string& name, PortID id=InvalidPortID);
virtual ~BaseSlavePort();
public:
BaseMasterPort& getMasterPort() const;
- bool isConnected() const;
};
SlavePort* _slavePort;
+ protected:
+
+ MemObject& owner;
+
public:
- MasterPort(const std::string& name, MemObject* owner,
- PortID id = InvalidPortID);
+ MasterPort(const std::string& name, MemObject* _owner,
+ PortID id=InvalidPortID);
virtual ~MasterPort();
/**
* 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);
+ void bind(Port &peer) override;
/**
* Unbind this master port and the associated slave port.
*/
- void unbind();
+ void unbind() override;
/**
* Send an atomic request packet, where the data is moved and the
*/
Tick sendAtomic(PacketPtr pkt);
+ /**
+ * Send an atomic request packet like above, but also request a backdoor
+ * to the data being accessed.
+ *
+ * @param pkt Packet to send.
+ * @param backdoor Can be set to a back door pointer by the target to let
+ * caller have direct access to the requested data.
+ *
+ * @return Estimated latency of access.
+ */
+ Tick sendAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor);
+
/**
* Send a functional request packet, where the data is instantly
* updated everywhere in the memory system, without affecting the
* 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 recvRetry at which point it can re-issue a
+ * wait for a recvReqRetry at which point it can re-issue a
* sendTimingReq.
*
* @param pkt Packet to send.
*/
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.
+ */
+ bool tryTiming(PacketPtr pkt) const;
+
/**
* 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 recvRetry at which point it can re-issue
- * a sendTimingSnoopResp.
+ * sender must wait for a recvRetrySnoop at which point it can
+ * re-issue a sendTimingSnoopResp.
*
* @param pkt Packet to send.
*/
/**
* Send a retry to the slave port that previously attempted a
- * sendTimingResp to this master port and failed.
+ * 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 sendRetry();
+ virtual void sendRetryResp();
/**
* Determine if this master port is snooping or not. The default
}
/**
- * Called by the slave port if sendTimingReq or
- * sendTimingSnoopResp was called on this master port (causing
- * recvTimingReq and recvTimingSnoopResp to be called on the
- * slave port) and was unsuccesful.
+ * 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 recvRetry() = 0;
+ 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
private:
MasterPort* _masterPort;
+ bool defaultBackdoorWarned;
+
+ protected:
+
+ MemObject& owner;
public:
- SlavePort(const std::string& name, MemObject* owner,
- PortID id = InvalidPortID);
+ SlavePort(const std::string& name, MemObject* _owner,
+ PortID id=InvalidPortID);
virtual ~SlavePort();
/**
* 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 recvRetry at which point it can re-issue a
+ * wait for a recvRespRetry at which point it can re-issue a
* sendTimingResp.
*
* @param pkt Packet to send.
/**
* Send a retry to the master port that previously attempted a
- * sendTimingReq or sendTimingSnoopResp to this slave port and
- * failed.
+ * sendTimingReq to this slave port and failed.
*/
- void sendRetry();
+ void sendRetryReq();
+
+ /**
+ * Send a retry to the master port that previously attempted a
+ * sendTimingSnoopResp to this slave port and failed.
+ */
+ void sendRetrySnoopResp();
/**
* Find out if the peer master port is snooping or not.
*/
virtual AddrRangeList getAddrRanges() const = 0;
+ /**
+ * We let the master port do the work, so these don't do anything.
+ */
+ void unbind() override {}
+ void bind(Port &peer) override {}
+
protected:
/**
* Called by the master port to unbind. Should never be called
* directly.
*/
- void unbind();
+ void slaveUnbind();
/**
* Called by the master port to bind. Should never be called
* directly.
*/
- void bind(MasterPort& master_port);
+ void slaveBind(MasterPort& master_port);
/**
* Receive an atomic request packet from the master port.
*/
virtual Tick recvAtomic(PacketPtr pkt) = 0;
+ /**
+ * Receive an atomic request packet from the master port, and optionally
+ * provide a backdoor to the data being accessed.
+ */
+ virtual Tick recvAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor);
+
/**
* Receive a functional request packet 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.
*/
* slave port (causing recvTimingResp to be called on the master
* port) and was unsuccesful.
*/
- virtual void recvRetry() = 0;
+ virtual void recvRespRetry() = 0;
};
projects / gem5.git / blobdiff