[dma] Update pushSuperpage interface to block pushing of pages when dma stopped

Author: kostorr

include/ReadoutCard/DmaChannelInterface.h

@@ -67,7 +67,7 @@ class DmaChannelInterface
   /// driver once it is pushed.
   ///
   /// \param superpage Superpage to push
-  virtual void pushSuperpage(Superpage superpage) = 0;
+  virtual bool pushSuperpage(Superpage superpage) = 0;
 
   /// Gets the superpage at the front of the "ready queue". Does not pop it.
   /// Note that it returns a copy of the Superpage's values.

src/Crorc/CrorcDmaChannel.cxx

@@ -328,8 +328,12 @@ auto CrorcDmaChannel::getSuperpage() -> Superpage
   return mReadyQueue.front();
 }
 
-void CrorcDmaChannel::pushSuperpage(Superpage superpage)
+bool CrorcDmaChannel::pushSuperpage(Superpage superpage)
 {
+  if (mDmaState != DmaState::STARTED) {
+    return false;
+  }
+
   checkSuperpage(superpage);
 
   if (mTransferQueue.size() >= TRANSFER_QUEUE_CAPACITY) {
@@ -347,6 +351,8 @@ void CrorcDmaChannel::pushSuperpage(Superpage superpage)
   mFreeFifoFront = (mFreeFifoFront + 1) % MAX_SUPERPAGE_DESCRIPTORS;
 
   mTransferQueue.push_back(superpage);
+
+  return true;
 }
 
 auto CrorcDmaChannel::popSuperpage() -> Superpage

src/Crorc/CrorcDmaChannel.h

@@ -49,7 +49,7 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
   virtual boost::optional<int32_t> getSerial() override;
   virtual boost::optional<std::string> getFirmwareInfo() override;
 
-  virtual void pushSuperpage(Superpage superpage) override;
+  virtual bool pushSuperpage(Superpage superpage) override;
 
   virtual int getTransferQueueAvailable() override;
   virtual int getReadyQueueSize() override;

src/Cru/CruDmaChannel.cxx

@@ -239,8 +239,12 @@ auto CruDmaChannel::getNextLinkIndex() -> LinkIndex
   return smallestQueueIndex;
 }
 
-void CruDmaChannel::pushSuperpage(Superpage superpage)
+bool CruDmaChannel::pushSuperpage(Superpage superpage)
 {
+  if (mDmaState != DmaState::STARTED) {
+    return false;
+  }
+
   checkSuperpage(superpage);
 
   if (mLinkQueuesTotalAvailable == 0) {
@@ -263,6 +267,8 @@ void CruDmaChannel::pushSuperpage(Superpage superpage)
   auto dmaPages = superpage.getSize() / mDmaPageSize;
   auto busAddress = getBusOffsetAddress(superpage.getOffset());
   getBar()->pushSuperpageDescriptor(link.id, dmaPages, busAddress);
+
+  return true;
 }
 
 auto CruDmaChannel::getSuperpage() -> Superpage

src/Cru/CruDmaChannel.h

@@ -40,7 +40,7 @@ class CruDmaChannel final : public DmaChannelPdaBase
 
   virtual CardType::type getCardType() override;
 
-  virtual void pushSuperpage(Superpage) override;
+  virtual bool pushSuperpage(Superpage) override;
 
   virtual int getTransferQueueAvailable() override;
   virtual int getReadyQueueSize() override;

src/DmaChannelPdaBase.cxx

@@ -140,6 +140,7 @@ void DmaChannelPdaBase::startDma()
 // Checks DMA state and forwards call to subclass if necessary
 void DmaChannelPdaBase::stopDma()
 {
+  mDmaState = DmaState::STOPPED;
   if (mDmaState == DmaState::UNKNOWN) {
     log("Unknown DMA state");
   } else if (mDmaState == DmaState::STOPPED) {
@@ -148,7 +149,6 @@ void DmaChannelPdaBase::stopDma()
     log("Stopping DMA", InfoLogger::InfoLogger::Debug);
     deviceStopDma();
   }
-  mDmaState = DmaState::STOPPED;
 }
 
 void DmaChannelPdaBase::resetChannel(ResetLevel::type resetLevel)

src/DmaChannelPdaBase.h

@@ -113,13 +113,14 @@ class DmaChannelPdaBase : public DmaChannelBase
     return *(mRocPciDevice.get());
   }
 
+ protected:
+  /// Current state of the DMA
+  DmaState::type mDmaState;
+
  private:
   /// Contains addresses & size of the buffer
   std::unique_ptr<DmaBufferProviderInterface> mBufferProvider;
 
-  /// Current state of the DMA
-  DmaState::type mDmaState;
-
   /// PDA device objects
   boost::scoped_ptr<RocPciDevice> mRocPciDevice;
 };

src/Dummy/DummyDmaChannel.cxx

@@ -98,7 +98,7 @@ boost::optional<std::string> DummyDmaChannel::getFirmwareInfo()
   return std::string("Dummy");
 }
 
-void DummyDmaChannel::pushSuperpage(Superpage superpage)
+bool DummyDmaChannel::pushSuperpage(Superpage superpage)
 {
   if (getTransferQueueAvailable() == 0) {
     BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message("Could not push superpage, transfer queue was full"));
@@ -124,6 +124,7 @@ void DummyDmaChannel::pushSuperpage(Superpage superpage)
   }
 
   mTransferQueue.push_back(superpage);
+  return true;
 }
 
 Superpage DummyDmaChannel::getSuperpage()

src/Dummy/DummyDmaChannel.h

@@ -37,7 +37,7 @@ class DummyDmaChannel final : public DmaChannelBase
   DummyDmaChannel(const Parameters& parameters);
   virtual ~DummyDmaChannel();
 
-  virtual void pushSuperpage(Superpage) override;
+  virtual bool pushSuperpage(Superpage) override;
   virtual Superpage getSuperpage() override;
   virtual Superpage popSuperpage() override;
   virtual void fillSuperpages() override;