summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael LeBeane <michael.lebeane@amd.com>2016-09-13 23:14:24 -0400
committerMichael LeBeane <michael.lebeane@amd.com>2016-09-13 23:14:24 -0400
commit6e4c51fa99ec14c5f1dc41fc308a666e59f9ec9c (patch)
tree2d83d6fe3f9f808a04d16345d9a94dd22c6fb724
parentf17a5faf44b01a07a2f97ff98fad01f974ec427b (diff)
downloadgem5-6e4c51fa99ec14c5f1dc41fc308a666e59f9ec9c.tar.xz
dev: Add a DmaCallback class to DmaDevice
This patch introduces the DmaCallback helper class, which registers a callback to fire after a sequence of (potentially non-contiguous) DMA transfers on a DmaPort completes.
-rw-r--r--src/dev/dma_device.hh85
1 files changed, 85 insertions, 0 deletions
diff --git a/src/dev/dma_device.hh b/src/dev/dma_device.hh
index 782fe4648..4e66b3456 100644
--- a/src/dev/dma_device.hh
+++ b/src/dev/dma_device.hh
@@ -185,6 +185,91 @@ class DmaDevice : public PioDevice
};
/**
+ * DMA callback class.
+ *
+ * Allows one to register for a callback event after a sequence of (potentially
+ * non-contiguous) DMA transfers on a DmaPort completes. Derived classes must
+ * implement the process() method and use getChunkEvent() to allocate a
+ * callback event for each participating DMA.
+ */
+class DmaCallback : public Drainable
+{
+ public:
+ virtual const std::string name() const { return "DmaCallback"; }
+
+ /**
+ * DmaPort ensures that all oustanding DMA accesses have completed before
+ * it finishes draining. However, DmaChunkEvents scheduled with a delay
+ * might still be sitting on the event queue. Therefore, draining is not
+ * complete until count is 0, which ensures that all outstanding
+ * DmaChunkEvents associated with this DmaCallback have fired.
+ */
+ DrainState drain() override
+ {
+ return count ? DrainState::Draining : DrainState::Drained;
+ }
+
+ protected:
+ int count;
+
+ DmaCallback()
+ : count(0)
+ { }
+
+ virtual ~DmaCallback() { }
+
+ /**
+ * Callback function invoked on completion of all chunks.
+ */
+ virtual void process() = 0;
+
+ private:
+ /**
+ * Called by DMA engine completion event on each chunk completion.
+ * Since the object may delete itself here, callers should not use
+ * the object pointer after calling this function.
+ */
+ void chunkComplete()
+ {
+ if (--count == 0) {
+ process();
+ // Need to notify DrainManager that this object is finished
+ // draining, even though it is immediately deleted.
+ signalDrainDone();
+ delete this;
+ }
+ }
+
+ /**
+ * Event invoked by DmaDevice on completion of each chunk.
+ */
+ class DmaChunkEvent : public Event
+ {
+ private:
+ DmaCallback *callback;
+
+ public:
+ DmaChunkEvent(DmaCallback *cb)
+ : Event(Default_Pri, AutoDelete), callback(cb)
+ { }
+
+ void process() { callback->chunkComplete(); }
+ };
+
+ public:
+
+ /**
+ * Request a chunk event. Chunks events should be provided to each DMA
+ * request that wishes to participate in this DmaCallback.
+ */
+ Event *getChunkEvent()
+ {
+ ++count;
+ return new DmaChunkEvent(this);
+ }
+};
+
+/**
* Buffered DMA engine helper class
*
* This class implements a simple DMA engine that feeds a FIFO