[dma-channel] Interface for Superpage FIFO empty counters

Author: kostorr

include/ReadoutCard/DmaChannelInterface.h

@@ -96,6 +96,9 @@ class DmaChannelInterface
   // Returns the number of dropped packets, as reported by the BAR
   virtual int32_t getDroppedPackets() = 0;
 
+  // Reports the state of the Superpage FIFOs
+  virtual bool areSuperpageFifosHealthy() = 0;
+
   /// Stops DMA for the given channel.
   /// Called automatically on channel closure.
   /// This moves any remaining superpages to the "ready queue", even if they are not filled.

src/Crorc/CrorcDmaChannel.cxx

@@ -339,6 +339,11 @@ int32_t CrorcDmaChannel::getDroppedPackets()
   return -1;
 }
 
+bool CrorcDmaChannel::areSuperpageFifosHealthy()
+{
+  return true;
+}
+
 void CrorcDmaChannel::pushFreeFifoPage(int readyFifoIndex, uintptr_t pageBusAddress, int pageSize)
 {
   size_t pageWords = pageSize / 4; // Size in 32-bit words

src/Crorc/CrorcDmaChannel.h

@@ -59,6 +59,7 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
   virtual bool isTransferQueueEmpty() override;
   virtual bool isReadyQueueFull() override;
   virtual int32_t getDroppedPackets() override;
+  virtual bool areSuperpageFifosHealthy() override;
 
   AllowedChannels allowedChannels();
 

src/Cru/Constants.h

@@ -66,6 +66,9 @@ static constexpr IntervalRegister LINK_SUPERPAGE_COUNT(0x00000800, SUPERPAGES_RE
 // FIFO containing the size of the ready superpages
 static constexpr IntervalRegister LINK_SUPERPAGE_SIZE(0x00000840, SUPERPAGES_READY_INTERVAL);
 
+// Counter for the times a link's Superpage FIFO is empty
+static constexpr IntervalRegister LINK_SUPERPAGE_FIFO_EMPTY(0x00000880, SUPERPAGES_READY_INTERVAL);
+
 /// Enable/disable links
 /// Every bit represents a link. Set a bit to 0 to disable a link.
 //static constexpr Register LINKS_ENABLE = 0x604;

src/Cru/CruBar.cxx

@@ -165,6 +165,14 @@ uint32_t CruBar::getSuperpageSize(uint32_t link)
   return superpageSize;
 }
 
+uint32_t CruBar::getSuperpageFifoEmptyCounter(uint32_t link)
+{
+  if (link >= Cru::MAX_LINKS) {
+    BOOST_THROW_EXCEPTION(InvalidLinkId() << ErrorInfo::Message("Link ID out of range") << ErrorInfo::LinkId(link));
+  }
+  return readRegister(Cru::Registers::LINK_SUPERPAGE_FIFO_EMPTY.get(link).index);
+}
+
 /// Signals the CRU DMA engine to start
 void CruBar::startDmaEngine()
 {

src/Cru/CruBar.h

@@ -67,6 +67,7 @@ class CruBar final : public BarInterfaceBase
   void pushSuperpageDescriptor(uint32_t link, uint32_t pages, uintptr_t busAddress);
   uint32_t getSuperpageCount(uint32_t link);
   uint32_t getSuperpageSize(uint32_t link);
+  uint32_t getSuperpageFifoEmptyCounter(uint32_t link);
   void startDmaEngine();
   void stopDmaEngine();
   void resetDataGeneratorCounter();

src/Cru/CruDmaChannel.cxx

@@ -403,6 +403,24 @@ int32_t CruDmaChannel::getDroppedPackets()
   return getBar2()->getDroppedPackets(endpoint);
 }
 
+bool CruDmaChannel::areSuperpageFifosHealthy()
+{
+  bool ok = true;
+  static std::unordered_map<int, uint32_t> counters;
+
+  for (const auto& link : mLinks) {
+    uint32_t emptyCounter = getBar()->getSuperpageFifoEmptyCounter(link.id);
+    if (counters.count(link.id) && //only check after the counters map has been initialized
+        counters[link.id] != emptyCounter) {
+      log((format("Empty counter of Superpage FIFO of link %1% increased") % link.id).str(), LogWarningDevel);
+      ok = false;
+    }
+    counters[link.id] = emptyCounter;
+  }
+
+  return ok;
+}
+
 bool CruDmaChannel::injectError()
 {
   if (!mDataSource == DataSource::Fee) {

src/Cru/CruDmaChannel.h

@@ -52,6 +52,7 @@ class CruDmaChannel final : public DmaChannelPdaBase
   virtual bool isTransferQueueEmpty() override;
   virtual bool isReadyQueueFull() override;
   virtual int32_t getDroppedPackets() override;
+  virtual bool areSuperpageFifosHealthy() override;
 
   virtual bool injectError() override;
   virtual boost::optional<int32_t> getSerial() override;