Merge zizzer.eecs.umich.edu:/z/m5/Bitkeeper/newmem
[gem5.git] / src / dev / io_device.hh
index 74730ad92e5bca6a17e894a736ce3b13a4182c47..902cde909e72036eb0b251c60f505eb804605a26 100644 (file)
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Ali Saidi
+ *          Nathan Binkert
  */
 
 #ifndef __DEV_IO_DEVICE_HH__
 #define __DEV_IO_DEVICE_HH__
 
-#include "base/chunk_generator.hh"
 #include "mem/mem_object.hh"
-#include "mem/packet_impl.hh"
-#include "sim/eventq.hh"
+#include "mem/packet.hh"
+#include "mem/tport.hh"
 #include "sim/sim_object.hh"
 
+class Event;
 class Platform;
 class PioDevice;
 class DmaDevice;
@@ -45,141 +48,91 @@ class System;
  * 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 the addressRanges() function
- * with which it returns the address ranges it is interested in. An extra
- * sendTiming() function is implemented which takes an delay. In this way the
- * device can immediatly call sendTiming(pkt, time) after processing a request
- * and the request will be handled by the port even if the port bus the device
- * connects to is blocked.
+ * with which it returns the address ranges it is interested in.
  */
-class PioPort : public Port
+class PioPort : public SimpleTimingPort
 {
   protected:
     /** The device that this port serves. */
     PioDevice *device;
 
-    /** The platform that device/port are in. This is used to select which mode
-     * we are currently operating in. */
-    Platform *platform;
-
-    /** A list of outgoing timing response packets that haven't been serviced
-     * yet. */
-    std::list<Packet*> transmitList;
-
-    /** The current status of the peer(bus) that we are connected to. */
-    Status peerStatus;
-
-    virtual bool recvTiming(Packet *pkt);
+    virtual Tick recvAtomic(PacketPtr pkt);
 
-    virtual Tick recvAtomic(Packet *pkt);
+    virtual void getDeviceAddressRanges(AddrRangeList &resp,
+                                        AddrRangeList &snoop);
 
-    virtual void recvFunctional(Packet *pkt) ;
+  public:
 
-    virtual void recvStatusChange(Status status)
-    { peerStatus = status; }
+    PioPort(PioDevice *dev, System *s, std::string pname = "-pioport");
+};
 
-    virtual void getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop);
 
-    /**
-     * This class is used to implemented sendTiming() with a delay. When a delay
-     * is requested a new event is created. When the event time expires it
-     * attempts to send the packet. If it cannot, the packet is pushed onto the
-     * transmit list to be sent when recvRetry() is called. */
-    class SendEvent : public Event
+class DmaPort : public Port
+{
+  protected:
+    struct DmaReqState : public Packet::SenderState
     {
-        PioPort *port;
-        Packet *packet;
+        /** Event to call on the device when this transaction (all packets)
+         * complete. */
+        Event *completionEvent;
 
-        SendEvent(PioPort *p, Packet *pkt, Tick t)
-            : Event(&mainEventQueue), port(p), packet(pkt)
-        { schedule(curTick + t); }
+        /** Where we came from for some sanity checking. */
+        Port *outPort;
 
-        virtual void process();
+        /** Total number of bytes that this transaction involves. */
+        Addr totBytes;
 
-        virtual const char *description()
-        { return "Future scheduled sendTiming event"; }
+        /** Number of bytes that have been acked for this transaction. */
+        Addr numBytes;
 
-        friend class PioPort;
+        DmaReqState(Event *ce, Port *p, Addr tb)
+            : completionEvent(ce), outPort(p), totBytes(tb), numBytes(0)
+        {}
     };
 
-    /** Schedule a sendTiming() event to be called in the future. */
-    void sendTiming(Packet *pkt, Tick time)
-    { new PioPort::SendEvent(this, pkt, time); }
-
-    /** This function pops the last element off the transmit list and sends it.*/
-    virtual Packet *recvRetry();
-
-  public:
-    PioPort(PioDevice *dev, Platform *p);
-
-  friend class PioPort::SendEvent;
-};
-
-
-struct DmaReqState : public Packet::SenderState
-{
-    Event *completionEvent;
-    bool final;
-    DmaReqState(Event *ce, bool f)
-        : completionEvent(ce), final(f)
-    {}
-};
-
-class DmaPort : public Port
-{
-  protected:
     DmaDevice *device;
-    std::list<Packet*> transmitList;
+    std::list<PacketPtr> transmitList;
 
-    /** The platform that device/port are in. This is used to select which mode
+    /** The system that device/port are in. This is used to select which mode
      * we are currently operating in. */
-    Platform *platform;
+    System *sys;
 
     /** Number of outstanding packets the dma port has. */
     int pendingCount;
 
-    virtual bool recvTiming(Packet *pkt);
-    virtual Tick recvAtomic(Packet *pkt)
-    { panic("dma port shouldn't be used for pio access."); }
-    virtual void recvFunctional(Packet *pkt)
+    /** If a dmaAction is in progress. */
+    int actionInProgress;
+
+    /** If we need to drain, keep the drain event around until we're done
+     * here.*/
+    Event *drainEvent;
+
+    virtual bool recvTiming(PacketPtr pkt);
+    virtual Tick recvAtomic(PacketPtr pkt)
+    { panic("dma port shouldn't be used for pio access."); M5_DUMMY_RETURN }
+    virtual void recvFunctional(PacketPtr pkt)
     { panic("dma port shouldn't be used for pio access."); }
 
     virtual void recvStatusChange(Status status)
     { ; }
 
-    virtual Packet *recvRetry() ;
+    virtual void recvRetry() ;
 
-    virtual void getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop)
+    virtual void getDeviceAddressRanges(AddrRangeList &resp,
+                                        AddrRangeList &snoop)
     { resp.clear(); snoop.clear(); }
 
-    class SendEvent : public Event
-    {
-        DmaPort *port;
-        Packet *packet;
-
-        SendEvent(PioPort *p, Packet *pkt, Tick t)
-            : Event(&mainEventQueue), packet(pkt)
-        { schedule(curTick + t); }
-
-        virtual void process();
-
-        virtual const char *description()
-        { return "Future scheduled sendTiming event"; }
-
-        friend class DmaPort;
-    };
-
-    void sendDma(Packet *pkt);
+    void sendDma(PacketPtr pkt, bool front = false);
 
   public:
-    DmaPort(DmaDevice *dev, Platform *p);
+    DmaPort(DmaDevice *dev, System *s);
 
     void dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
                    uint8_t *data = NULL);
 
     bool dmaPending() { return pendingCount > 0; }
 
-  friend class DmaPort::SendEvent;
-
+    unsigned int drain(Event *de);
 };
 
 /**
@@ -189,7 +142,6 @@ class DmaPort : public Port
  * mode we are in, etc is handled by the PioPort so the device doesn't have to
  * bother.
  */
-
 class PioDevice : public MemObject
 {
   protected:
@@ -198,36 +150,32 @@ class PioDevice : public MemObject
      * transaction we should perform. */
     Platform *platform;
 
+    System *sys;
+
     /** The pioPort that handles the requests for us and provides us requests
      * that it sees. */
     PioPort *pioPort;
 
     virtual void addressRanges(AddrRangeList &range_list) = 0;
 
-    /** As far as the devices are concerned they only accept atomic transactions
-     * which are converted to either a write or a read. */
-    Tick recvAtomic(Packet *pkt)
-    { return pkt->isRead() ? this->read(pkt) : this->write(pkt); }
-
-    /** Pure virtual function that the device must implement. Called when a read
-     * command is recieved by the port.
+    /** Pure virtual function that the device must implement. Called
+     * when a read command is recieved by the port.
      * @param pkt Packet describing this request
      * @return number of ticks it took to complete
      */
-    virtual Tick read(Packet *pkt) = 0;
+    virtual Tick read(PacketPtr pkt) = 0;
 
     /** Pure virtual function that the device must implement. Called when a
      * write command is recieved by the port.
      * @param pkt Packet describing this request
      * @return number of ticks it took to complete
      */
-    virtual Tick write(Packet *pkt) = 0;
+    virtual Tick write(PacketPtr pkt) = 0;
 
   public:
-    /** Params struct which is extended through each device based on the
-     * parameters it needs. Since we are re-writing everything, we might as well
-     * start from the bottom this time. */
-
+    /** Params struct which is extended through each device based on
+     * the parameters it needs. Since we are re-writing everything, we
+     * might as well start from the bottom this time. */
     struct Params
     {
         std::string name;
@@ -242,20 +190,22 @@ class PioDevice : public MemObject
     const Params *params() const { return _params; }
 
     PioDevice(Params *p)
-              : MemObject(p->name),  platform(p->platform), pioPort(NULL),
-                _params(p)
+              : MemObject(p->name),  platform(p->platform), sys(p->system),
+              pioPort(NULL), _params(p)
               {}
 
     virtual ~PioDevice();
 
     virtual void init();
 
-    virtual Port *getPort(const std::string &if_name)
+    virtual unsigned int drain(Event *de);
+
+    virtual Port *getPort(const std::string &if_name, int idx = -1)
     {
         if (if_name == "pio") {
             if (pioPort != NULL)
                 panic("pio port already connected to.");
-            pioPort = new PioPort(this, params()->platform);
+            pioPort = new PioPort(this, sys);
             return pioPort;
         } else
             return NULL;
@@ -285,11 +235,12 @@ class BasicPioDevice : public PioDevice
 
   public:
     BasicPioDevice(Params *p)
-        : PioDevice(p), pioAddr(p->pio_addr), pioSize(0), pioDelay(p->pio_delay)
+        : PioDevice(p), pioAddr(p->pio_addr), pioSize(0),
+          pioDelay(p->pio_delay)
     {}
 
     /** return the address ranges that this device responds to.
-     * @params range_list range list to populate with ranges
+     * @param range_list range list to populate with ranges
      */
     void addressRanges(AddrRangeList &range_list);
 
@@ -305,24 +256,29 @@ class DmaDevice : public PioDevice
     virtual ~DmaDevice();
 
     void dmaWrite(Addr addr, int size, Event *event, uint8_t *data)
-    { dmaPort->dmaAction(Packet::WriteReq, addr, size, event, data) ; }
+    {
+        dmaPort->dmaAction(MemCmd::WriteInvalidateReq,
+                           addr, size, event, data);
+    }
 
     void dmaRead(Addr addr, int size, Event *event, uint8_t *data = NULL)
-    { dmaPort->dmaAction(Packet::ReadReq, addr, size, event, data); }
+    { dmaPort->dmaAction(MemCmd::ReadReq, addr, size, event, data); }
 
     bool dmaPending() { return dmaPort->dmaPending(); }
 
-    virtual Port *getPort(const std::string &if_name)
+    virtual unsigned int drain(Event *de);
+
+    virtual Port *getPort(const std::string &if_name, int idx = -1)
     {
         if (if_name == "pio") {
             if (pioPort != NULL)
                 panic("pio port already connected to.");
-            pioPort = new PioPort(this, params()->platform);
+            pioPort = new PioPort(this, sys);
             return pioPort;
         } else if (if_name == "dma") {
             if (dmaPort != NULL)
                 panic("dma port already connected to.");
-            dmaPort = new DmaPort(this, params()->platform);
+            dmaPort = new DmaPort(this, sys);
             return dmaPort;
         } else
             return NULL;