[cru] Update CRU DMA engine control

Author: kostorr

src/CommandLineUtilities/ProgramDmaBench.cxx

@@ -346,6 +346,8 @@ class ProgramDmaBench : public Program
 
     std::cout << "\n\n";
     mChannel->stopDma();
+    int numPopped = freeExcessPages(10ms);
+    getLogger() << "Popped " << numPopped << " remaining superpages" << endm;
 
     outputErrors();
     outputStats();
@@ -548,6 +550,39 @@ class ProgramDmaBench : public Program
     lowPriorityFuture.get();
   }
 
+  /// Free the pages that remain after stopping DMA (these may not be filled)
+  int freeExcessPages(std::chrono::milliseconds timeout)
+  {
+    auto start = std::chrono::steady_clock::now();
+    int popped = 0;
+    while ((std::chrono::steady_clock::now() - start) < timeout) {
+      auto size = mChannel->getReadyQueueSize();
+      for (int i = 0; i < size; ++i) {
+        auto superpage = mChannel->popSuperpage();
+        fetchAddSuperpagesReadOut();
+        if ((mDataSource == DataSource::Fee) || (mDataSource == DataSource::Ddg)) {
+          auto superpageAddress = mBufferBaseAddress + superpage.getOffset();
+          size_t readoutBytes = 0;
+          bool atStartOfSuperpage = true;
+          while ((readoutBytes < superpage.getReceived())) { // At least one more dma page fits in the superpage
+            auto pageAddress = superpageAddress + readoutBytes;
+            auto readoutCount = fetchAddDmaPagesReadOut();
+            size_t pageSize = readoutPage(pageAddress, readoutCount, atStartOfSuperpage);
+            atStartOfSuperpage = false; // Update the boolean value as soon as we move...
+            readoutBytes += pageSize;
+          }
+
+          if (readoutBytes > mSuperpageSize) {
+            BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message("RDH reports cumulative dma page sizes that exceed the superpage size"));
+          }
+        }
+        std::cout << "[popped superpage " << i << " ], size= " << superpage.getSize() << " received= " << superpage.getReceived() << " isFilled=" << superpage.isFilled() << " isReady=" << superpage.isReady() << std::endl;
+      }
+      popped += size;
+    }
+    return popped;
+  }
+
   uint32_t getDataGeneratorCounterFromPage(uintptr_t pageAddress, size_t headerSize)
   {
     auto payload = reinterpret_cast<const volatile uint32_t*>(pageAddress + headerSize);

src/Cru/CruBar.cxx

@@ -152,14 +152,19 @@ uint32_t CruBar::getSuperpageSize(uint32_t link)
   return superpageSize;
 }
 
-/// Enables the data emulator
-/// \param enabled true for enabled
-void CruBar::setDataEmulatorEnabled(bool enabled)
+/// Signals the CRU DMA engine to start
+void CruBar::startDmaEngine()
 {
-  writeRegister(Cru::Registers::DMA_CONTROL.index, enabled ? 0x1 : 0x0);
-  uint32_t bits = readRegister(Cru::Registers::DATA_GENERATOR_CONTROL.index);
-  setDataGeneratorEnableBits(bits, enabled);
-  writeRegister(Cru::Registers::DATA_GENERATOR_CONTROL.index, bits);
+  writeRegister(Cru::Registers::DMA_CONTROL.index, 0x11);                  // send DMA start (bit #0)
+                                                                           // dyn offset enabled (bit #4)
+  modifyRegister(Cru::Registers::DATA_GENERATOR_CONTROL.index, 0, 1, 0x1); // enable data generator
+}
+
+/// Signals the CRU DMA engine to stop
+void CruBar::stopDmaEngine()
+{
+  modifyRegister(Cru::Registers::DMA_CONTROL.index, 8, 1, 0x1);            // send DMA flush to the CRU
+  modifyRegister(Cru::Registers::DATA_GENERATOR_CONTROL.index, 0, 1, 0x0); // disable data generator
 }
 
 /// Resets the data generator counter
@@ -387,14 +392,6 @@ FirmwareFeatures CruBar::convertToFirmwareFeatures(uint32_t reg)
   return features;
 }
 
-/// Sets the bits for the data generator enabled in the given integer
-/// \param bits Integer with bits to set
-/// \param enabled Generator enabled or not
-void CruBar::setDataGeneratorEnableBits(uint32_t& bits, bool enabled)
-{
-  Utilities::setBit(bits, 0, enabled);
-}
-
 /// Reports the CRU status
 Cru::ReportInfo CruBar::report()
 {

src/Cru/CruBar.h

@@ -66,7 +66,8 @@ 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);
-  void setDataEmulatorEnabled(bool enabled);
+  void startDmaEngine();
+  void stopDmaEngine();
   void resetDataGeneratorCounter();
   void resetCard();
   void dataGeneratorInjectError();
@@ -75,9 +76,6 @@ class CruBar final : public BarInterfaceBase
 
   static FirmwareFeatures convertToFirmwareFeatures(uint32_t reg);
 
-  static void setDataGeneratorEnableBits(uint32_t& bits, bool enabled);
-  static void setDataGeneratorRandomSizeBits(uint32_t& bits, bool enabled);
-
   void setWrapperCount();
   void configure() override;
   void reconfigure() override;

src/Cru/CruDmaChannel.cxx

@@ -147,14 +147,14 @@ void CruDmaChannel::deviceStartDma()
 /// Set buffer to ready
 void CruDmaChannel::setBufferReady()
 {
-  getBar()->setDataEmulatorEnabled(true);
+  getBar()->startDmaEngine();
   std::this_thread::sleep_for(10ms);
 }
 
 /// Set buffer to non-ready
 void CruDmaChannel::setBufferNonReady()
 {
-  getBar()->setDataEmulatorEnabled(false);
+  getBar()->stopDmaEngine();
 }
 
 void CruDmaChannel::deviceStopDma()
@@ -171,7 +171,7 @@ void CruDmaChannel::deviceStopDma()
         break;
       }
 
-      if (!link.queue.empty()) {    // care for the extra filled superpage
+      if (!link.queue.empty()) { // care for the extra filled superpage
         transferSuperpageFromLinkToReady(link);
         moved++;
       }

test/TestCruBar.cxx

@@ -50,14 +50,3 @@ BOOST_AUTO_TEST_CASE(TestFirmwareFeatures)
     BOOST_CHECK(!CruBar::convertToFirmwareFeatures(0x40005AFE + (1 << 19)).firmwareInfo);
   }
 }
-
-BOOST_AUTO_TEST_CASE(TestDataGeneratorConfiguration)
-{
-  {
-    uint32_t bits = 0;
-    CruBar::setDataGeneratorEnableBits(bits, true);
-    BOOST_CHECK(bits == 0x1);
-    CruBar::setDataGeneratorEnableBits(bits, false);
-    BOOST_CHECK(bits == 0x0);
-  }
-}