sim: Include some required headers in the syscall debug macros header.
[gem5.git] / src / dev / io_device.hh
index 99b207595f8a83e9794fbd9f56557510aba4ae38..804133893275e694d81c5c5186c6501546efc158 100644 (file)
 #ifndef __DEV_IO_DEVICE_HH__
 #define __DEV_IO_DEVICE_HH__
 
-#include "base/fast_alloc.hh"
-#include "mem/mem_object.hh"
-#include "mem/packet.hh"
 #include "mem/tport.hh"
 #include "params/BasicPioDevice.hh"
-#include "params/DmaDevice.hh"
 #include "params/PioDevice.hh"
-#include "sim/sim_object.hh"
+#include "sim/clocked_object.hh"
 
-class Event;
 class PioDevice;
-class DmaDevice;
 class System;
 
 /**
@@ -65,129 +59,37 @@ class System;
  * must respond to. The device must also provide getAddrRanges() function
  * with which it returns the address ranges it is interested in.
  */
+template <class Device>
 class PioPort : public SimpleTimingPort
 {
   protected:
     /** The device that this port serves. */
-    PioDevice *device;
+    Device *device;
 
-    virtual Tick recvAtomic(PacketPtr pkt);
-
-    virtual AddrRangeList getAddrRanges();
-
-  public:
-
-    PioPort(PioDevice *dev);
-};
-
-
-class DmaPort : public MasterPort
-{
-  protected:
-    struct DmaReqState : public Packet::SenderState, public FastAlloc
-    {
-        /** Event to call on the device when this transaction (all packets)
-         * complete. */
-        Event *completionEvent;
-
-        /** Where we came from for some sanity checking. */
-        Port *outPort;
-
-        /** Total number of bytes that this transaction involves. */
-        Addr totBytes;
-
-        /** Number of bytes that have been acked for this transaction. */
-        Addr numBytes;
-
-        /** Amount to delay completion of dma by */
-        Tick delay;
-
-
-        DmaReqState(Event *ce, Port *p, Addr tb, Tick _delay)
-            : completionEvent(ce), outPort(p), totBytes(tb), numBytes(0),
-              delay(_delay)
-        {}
-    };
-
-    MemObject *device;
-    std::list<PacketPtr> transmitList;
-
-    /** The system that device/port are in. This is used to select which mode
-     * we are currently operating in. */
-    System *sys;
-
-    /** Id for all requests */
-    MasterID masterId;
-
-    /** Number of outstanding packets the dma port has. */
-    int pendingCount;
-
-    /** 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;
-
-    /** time to wait between sending another packet, increases as NACKs are
-     * recived, decreases as responses are recived. */
-    Tick backoffTime;
-
-    /** Minimum time that device should back off for after failed sendTiming */
-    Tick minBackoffDelay;
-
-    /** Maximum time that device should back off for after failed sendTiming */
-    Tick maxBackoffDelay;
-
-    /** If the port is currently waiting for a retry before it can send whatever
-     * it is that it's sending. */
-    bool inRetry;
-
-    /** Port accesses a cache which requires snooping */
-    bool recvSnoops;
-
-    virtual bool recvTimingResp(PacketPtr pkt);
-
-    virtual void recvTimingSnoopReq(PacketPtr pkt)
-    {
-        if (!recvSnoops)
-            panic("%s was not expecting a snoop\n", name());
-    }
-
-    virtual Tick recvAtomicSnoop(PacketPtr pkt)
+    Tick
+    recvAtomic(PacketPtr pkt) override
     {
-        if (!recvSnoops)
-            panic("%s was not expecting a snoop\n", name());
-        return 0;
+        // Technically the packet only reaches us after the header delay,
+        // and typically we also need to deserialise any payload.
+        Tick receive_delay = pkt->headerDelay + pkt->payloadDelay;
+        pkt->headerDelay = pkt->payloadDelay = 0;
+
+        const Tick delay =
+            pkt->isRead() ? device->read(pkt) : device->write(pkt);
+        assert(pkt->isResponse() || pkt->isError());
+        return delay + receive_delay;
     }
 
-    virtual void recvFunctionalSnoop(PacketPtr pkt)
+    AddrRangeList
+    getAddrRanges() const override
     {
-        if (!recvSnoops)
-            panic("%s was not expecting a snoop\n", name());
+        return device->getAddrRanges();
     }
 
-    virtual void recvRetry() ;
-
-    virtual bool isSnooping() const { return recvSnoops; }
-
-    void queueDma(PacketPtr pkt, bool front = false);
-    void sendDma();
-
-    /** event to give us a kick every time we backoff time is reached. */
-    EventWrapper<DmaPort, &DmaPort::sendDma> backoffEvent;
-
   public:
-    DmaPort(MemObject *dev, System *s, Tick min_backoff, Tick max_backoff,
-            bool recv_snoops = false);
-
-    void dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
-                   uint8_t *data, Tick delay, Request::Flags flag = 0);
-
-    bool dmaPending() { return pendingCount > 0; }
-
-    unsigned cacheBlockSize() const { return peerBlockSize(); }
-    unsigned int drain(Event *de);
+    PioPort(Device *dev) :
+        SimpleTimingPort(dev->name() + ".pio", dev), device(dev)
+    {}
 };
 
 /**
@@ -197,14 +99,14 @@ class DmaPort : public MasterPort
  * mode we are in, etc is handled by the PioPort so the device doesn't have to
  * bother.
  */
-class PioDevice : public MemObject
+class PioDevice : public ClockedObject
 {
   protected:
     System *sys;
 
     /** The pioPort that handles the requests for us and provides us requests
      * that it sees. */
-    PioPort pioPort;
+    PioPort<PioDevice> pioPort;
 
     /**
      * Every PIO device is obliged to provide an implementation that
@@ -212,7 +114,7 @@ class PioDevice : public MemObject
      *
      * @return a list of non-overlapping address ranges
      */
-    virtual AddrRangeList getAddrRanges() = 0;
+    virtual AddrRangeList getAddrRanges() const = 0;
 
     /** Pure virtual function that the device must implement. Called
      * when a read command is recieved by the port.
@@ -239,13 +141,12 @@ class PioDevice : public MemObject
         return dynamic_cast<const Params *>(_params);
     }
 
-    virtual void init();
+    void init() override;
 
-    virtual unsigned int drain(Event *de);
+    Port &getPort(const std::string &if_name,
+            PortID idx=InvalidPortID) override;
 
-    virtual SlavePort &getSlavePort(const std::string &if_name, int idx = -1);
-
-    friend class PioPort;
+    friend class PioPort<PioDevice>;
 
 };
 
@@ -263,7 +164,7 @@ class BasicPioDevice : public PioDevice
 
   public:
     typedef BasicPioDeviceParams Params;
-    BasicPioDevice(const Params *p);
+    BasicPioDevice(const Params *p, Addr size);
 
     const Params *
     params() const
@@ -276,51 +177,7 @@ class BasicPioDevice : public PioDevice
      *
      * @return a list of non-overlapping address ranges
      */
-    virtual AddrRangeList getAddrRanges();
-
+    AddrRangeList getAddrRanges() const override;
 };
 
-class DmaDevice : public PioDevice
-{
-   protected:
-    DmaPort dmaPort;
-
-  public:
-    typedef DmaDeviceParams Params;
-    DmaDevice(const Params *p);
-    virtual ~DmaDevice();
-
-    const Params *
-    params() const
-    {
-        return dynamic_cast<const Params *>(_params);
-    }
-
-    void dmaWrite(Addr addr, int size, Event *event, uint8_t *data,
-                  Tick delay = 0)
-    {
-        dmaPort.dmaAction(MemCmd::WriteReq, addr, size, event, data, delay);
-    }
-
-    void dmaRead(Addr addr, int size, Event *event, uint8_t *data,
-                 Tick delay = 0)
-    {
-        dmaPort.dmaAction(MemCmd::ReadReq, addr, size, event, data, delay);
-    }
-
-    bool dmaPending() { return dmaPort.dmaPending(); }
-
-    virtual void init();
-
-    virtual unsigned int drain(Event *de);
-
-    unsigned cacheBlockSize() const { return dmaPort.cacheBlockSize(); }
-
-    virtual MasterPort &getMasterPort(const std::string &if_name,
-                                      int idx = -1);
-
-    friend class DmaPort;
-};
-
-
 #endif // __DEV_IO_DEVICE_HH__