Provide transfer, ready queue and dropped packets status funcs through the DMA channel

Author: kostorr

include/ReadoutCard/DmaChannelInterface.h

@@ -84,6 +84,17 @@ class DmaChannelInterface
     /// superpage can be inspected with getSuperpage() or popped with popSuperpage().
     virtual int getReadyQueueSize() = 0;
 
+    // Returns true if the Transfer Queue is empty
+    // i.e. no free pages to send to the card
+    virtual bool isTransferQueueEmpty() = 0;
+
+    // Returns true if the Ready Queue is full
+    // i.e. queue filled by the card
+    virtual bool isReadyQueueFull() = 0;
+
+    // Returns the number of dropped packets, as reported by the BAR
+    virtual int32_t getDroppedPackets() = 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

@@ -428,6 +428,26 @@ void CrorcDmaChannel::fillSuperpages()
   }
 }
 
+// Return a boolean that denotes whether the transfer queue is empty
+// The transfer queue is empty when all its slots are available
+bool CrorcDmaChannel::isTransferQueueEmpty()
+{
+  return mTransferQueue.empty();
+}
+
+// Return a boolean that denotes whether the ready queue is full
+// The ready queue is full when the CRORC has filled it up
+bool CrorcDmaChannel::isReadyQueueFull()
+{
+  return mReadyQueue.size() == READY_QUEUE_CAPACITY;
+}
+
+int32_t CrorcDmaChannel::getDroppedPackets()
+{
+  log("No support for dropped packets in CRORC yet", InfoLogger::InfoLogger::Warning);
+  return -1;
+}
+
 void CrorcDmaChannel::pushFreeFifoPage(int readyFifoIndex, uintptr_t pageBusAddress)
 {
   size_t pageWords = mPageSize / 4; // Size in 32-bit words

src/Crorc/CrorcDmaChannel.h

@@ -56,6 +56,9 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
     virtual Superpage getSuperpage() override;
     virtual Superpage popSuperpage() override;
     virtual void fillSuperpages() override;
+    virtual bool isTransferQueueEmpty() override;
+    virtual bool isReadyQueueFull() override;
+    virtual int32_t getDroppedPackets() override;
 
     AllowedChannels allowedChannels();
 

src/Cru/CruDmaChannel.cxx

@@ -348,11 +348,30 @@ int CruDmaChannel::getTransferQueueAvailable()
   return mLinkQueuesTotalAvailable;
 }
 
+// Return a boolean that denotes whether the transfer queue is empty
+// The transfer queue is empty when all its slots are available
+bool CruDmaChannel::isTransferQueueEmpty()
+{
+  return mLinkQueuesTotalAvailable == (LINK_QUEUE_CAPACITY * mLinks.size());
+}
+
 int CruDmaChannel::getReadyQueueSize()
 {
   return mReadyQueue.size();
 }
 
+// Return a boolean that denotes whether the ready queue is full
+// The ready queue is full when the CRU has filled it up
+bool CruDmaChannel::isReadyQueueFull()
+{
+  return mReadyQueue.size() == READY_QUEUE_CAPACITY;
+}
+
+int32_t CruDmaChannel::getDroppedPackets()
+{
+  return getBar()->getDroppedPackets();
+}
+
 bool CruDmaChannel::injectError()
 {
   if (mGeneratorEnabled) {

src/Cru/CruDmaChannel.h

@@ -47,6 +47,9 @@ class CruDmaChannel final : public DmaChannelPdaBase
     virtual Superpage getSuperpage() override;
     virtual Superpage popSuperpage() override;
     virtual void fillSuperpages() override;
+    virtual bool isTransferQueueEmpty() override;
+    virtual bool isReadyQueueFull() override;
+    virtual int32_t getDroppedPackets() override;
 
     virtual bool injectError() override;
     virtual boost::optional<int32_t> getSerial() override;

src/Dummy/DummyDmaChannel.cxx

@@ -27,15 +27,15 @@ CardDescriptor makeDummyDescriptor()
   return {CardType::Dummy, ChannelFactory::getDummySerialNumber(), PciId {"dummy", "dummy"}, PciAddress {0,0,0}, -1};
 }
 
-constexpr size_t TRANSFER_QUEUE_SIZE = 16;
-constexpr size_t READY_QUEUE_SIZE = 32;
+constexpr size_t TRANSFER_QUEUE_CAPACITY = 16;
+constexpr size_t READY_QUEUE_CAPACITY = 32;
 }
 
 constexpr auto endm = InfoLogger::InfoLogger::StreamOps::endm;
 
 DummyDmaChannel::DummyDmaChannel(const Parameters& params)
     : DmaChannelBase(makeDummyDescriptor(), const_cast<Parameters&>(params), { 0, 1, 2, 3, 4, 5, 6, 7 }),
-      mTransferQueue(TRANSFER_QUEUE_SIZE), mReadyQueue(READY_QUEUE_SIZE)
+      mTransferQueue(TRANSFER_QUEUE_CAPACITY), mReadyQueue(READY_QUEUE_CAPACITY)
 {
   getLogger() << "DummyDmaChannel::DummyDmaChannel(channel:" << params.getChannelNumberRequired() << ")"
       << InfoLogger::InfoLogger::endm;
@@ -152,6 +152,22 @@ void DummyDmaChannel::fillSuperpages()
   }
 }
 
+bool DummyDmaChannel::isTransferQueueEmpty()
+{
+  return mTransferQueue.empty();
+}
+
+bool DummyDmaChannel::isReadyQueueFull()
+{
+  return mReadyQueue.size() == READY_QUEUE_CAPACITY;
+}
+
+int32_t DummyDmaChannel::getDroppedPackets()
+{
+  return 0; // No dropped packets on the Dummy DMA Channel
+}
+
+
 boost::optional<int32_t> DummyDmaChannel::getSerial()
 {
   return ChannelFactory::getDummySerialNumber();

src/Dummy/DummyDmaChannel.h

@@ -40,6 +40,10 @@ class DummyDmaChannel final : public DmaChannelBase
     virtual Superpage getSuperpage() override;
     virtual Superpage popSuperpage() override;
     virtual void fillSuperpages() override;
+    virtual bool isTransferQueueEmpty() override;
+    virtual bool isReadyQueueFull() override;
+    virtual int32_t getDroppedPackets() override;
+
     virtual bool injectError() override
     {
       return false;