Handle debug register when running with the DG for the CRU

Author: kostorr

src/Cru/Constants.h

@@ -85,6 +85,11 @@ static constexpr uint32_t DATA_SOURCE_SELECT_INTERNAL = 0x1;
 /// * Write a 2 to reset data generator counter
 static constexpr Register RESET_CONTROL(0x00000400);
 
+/// Debug register
+/// * Write 0x2 to set debug mode
+/// * Write 0x0 to unset
+static constexpr Register DEBUG(0x00000c00);
+
 ///*** bar2 ***///
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////

src/Cru/CruBar.cxx

@@ -566,5 +566,24 @@ void CruBar::disableDataTaking()
   modifyRegister(Cru::Registers::BSP_USER_CONTROL.index, 0, 1, 0x0);
 }
 
+void CruBar::setDebugModeEnabled(bool enabled)
+{
+  if (enabled) {
+    writeRegister(Cru::Registers::DEBUG.index, 0x2);
+  } else {
+    writeRegister(Cru::Registers::DEBUG.index, 0x0);
+  }
+}
+
+bool CruBar::getDebugModeEnabled()
+{
+  uint32_t debugMode = readRegister(Cru::Registers::DEBUG.index);
+  if (debugMode == 0x0) {
+    return false;
+  } else {
+    return true;
+  }
+}
+
 } // namespace roc
 } // namespace AliceO2

src/Cru/CruBar.h

@@ -73,6 +73,9 @@ class CruBar final : public BarInterfaceBase
     void configure() override;
     Cru::ReportInfo report();
 
+    void setDebugModeEnabled(bool enabled);
+    bool getDebugModeEnabled();
+
   private:
     uint32_t getSerialNumber();
     uint32_t getTemperatureRaw();

src/Cru/CruDmaChannel.cxx

@@ -96,7 +96,13 @@ CruDmaChannel::~CruDmaChannel()
 {
   setBufferNonReady();
   if (mReadyQueue.size() > 0) {
-    log((format("Remaining superpages in the ready queue: %1%") % mReadyQueue.size()).str()); }
+    log((format("Remaining superpages in the ready queue: %1%") % mReadyQueue.size()).str());
+  }
+
+  if (mLoopbackMode == LoopbackMode::Internal) {
+    resetDebugMode();
+  }
+
 }
 
 void CruDmaChannel::deviceStartDma()
@@ -110,6 +116,7 @@ void CruDmaChannel::deviceStartDma()
   uint32_t dataSourceSelection = 0x0;
   if (mGeneratorEnabled) {
     if (mLoopbackMode == LoopbackMode::Internal) {
+      enableDebugMode();
       dataSourceSelection = Cru::Registers::DATA_SOURCE_SELECT_INTERNAL;
     } else if (mLoopbackMode == LoopbackMode::Ddg) {
       dataSourceSelection = Cru::Registers::DATA_SOURCE_SELECT_GBT;
@@ -337,6 +344,19 @@ bool CruDmaChannel::injectError()
   }
 }
 
+void CruDmaChannel::enableDebugMode() {
+  if(!getBar()->getDebugModeEnabled()) {
+    getBar()->setDebugModeEnabled(true);
+    mDebugRegisterReset = true;
+  }
+}
+
+void CruDmaChannel::resetDebugMode() {
+  if (mDebugRegisterReset) {
+    getBar()->setDebugModeEnabled(false);
+  }
+}
+
 boost::optional<int32_t> CruDmaChannel::getSerial()
 {
   if (mFeatures.serial) {

src/Cru/CruDmaChannel.h

@@ -106,6 +106,12 @@ class CruDmaChannel final : public DmaChannelPdaBase
     /// Mark the front superpage of a link ready and transfer it to the ready queue
     void transferSuperpageFromLinkToReady(Link& link);
 
+    /// Enable debug mode by writing to the appropriate CRU register
+    void enableDebugMode();
+
+    /// Reset debug mode to the state it was in prior to the start of execution
+    void resetDebugMode();
+
     /// BAR 0 is needed for DMA engine interaction and various other functions
     std::shared_ptr<CruBar> cruBar;
 
@@ -155,6 +161,9 @@ class CruDmaChannel final : public DmaChannelPdaBase
 
     /// Length of data written to each page
     const size_t mGeneratorDataSize;
+
+    /// Flag to know if we should reset the debug register after we fiddle with it
+    bool mDebugRegisterReset = false;
 };
 
 } // namespace roc