added CRU option dropBadRdhEnabled

sy-c · sy-c · commit ba41becf3193 · 2024-05-28T16:00:27.000+02:00
diff --git a/README.md b/README.md
@@ -211,6 +211,8 @@ The Parameters that affect the configuration of the CRU, their possible values (
 
 `UserLogicEnabled (true | false) [false]`
 
+`DropBadRdhEnabled (true | false) [false]`
+
 To set any of the above parameters the usual template can be followed.
 
 ```
@@ -228,7 +230,7 @@ params.setClock(Parameters::Clock::type::Local);
 The above parameters will be set for the enabled links, as specified by the `LinkMask` parameter. See the [LinkMask](#linkmask) section
 for more info.
 
-Note that for `AllowRejection`, `LinkLoopbackEnabled`, `PonUpstreamEnabled`, `DynamicOffsetEnabled`, `GbtEnabled` and `UserLogicEnabled` it is sufficient to do the following, as they are simply booleans.
+Note that for `AllowRejection`, `LinkLoopbackEnabled`, `PonUpstreamEnabled`, `DynamicOffsetEnabled`, `GbtEnabled`, `UserLogicEnabled`, `DropBadRdhEnabled` it is sufficient to do the following, as they are simply booleans.
 
 ```
 params.setAllowRejection(true);
@@ -269,6 +271,7 @@ dynamicOffsetEnabled
 triggerWindowSize
 gbtEnabled
 UserLogicEnabled
+DropBadRdhEnabled
 ```
 
 The "per link" parameters are
diff --git a/cru_template.cfg b/cru_template.cfg
@@ -62,6 +62,9 @@ systemId=0xfd
 # Time Frame Length [0-255]
 timeFrameLength=255
 
+# Drop packets with bad RDH
+dropBadRdhEnabled=false
+
 #############################################
 # links
 #############################################
diff --git a/cru_template.json b/cru_template.json
@@ -16,7 +16,8 @@
           "runStatsEnabled": "false",
           "userAndCommonLogicEnabled": "false",
           "systemId": "0x0",
-          "timeFrameLength": "256"
+          "timeFrameLength": "256",
+	  "dropBadRdhEnabled": "false"
         },
       "links": {
             "enabled": "false",
diff --git a/include/ReadoutCard/Parameters.h b/include/ReadoutCard/Parameters.h
@@ -162,6 +162,9 @@ class Parameters
   // Type for the Time Frame Length parameter
   using TimeFrameLengthType = uint32_t;
 
+  /// Type for the Drop RDH enabled parameter
+  using DropBadRdhEnabledType = bool;
+
   /// Type for the Time Frame Detection enabled parameter
   using TimeFrameDetectionEnabledType = bool;
 
@@ -477,6 +480,12 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setTimeFrameLength(TimeFrameLengthType value) -> Parameters&;
 
+  /// Sets the DropBadRdhEnabled parameter
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setDropBadRdhEnabled(DropBadRdhEnabledType value) -> Parameters&;
+
   /// Sets the TimeFrameDetectionEnabled parameter
   ///
   /// \param value The value to set
@@ -634,6 +643,10 @@ class Parameters
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
   auto getTimeFrameLength() const -> boost::optional<TimeFrameLengthType>;
 
+  /// Gets the DropBadRdhEnabled parameter
+  /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
+  auto getDropBadRdhEnabled() const -> boost::optional<DropBadRdhEnabledType>;
+
   /// Gets the TimeFrameDetectionEnabled parameter
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
   auto getTimeFrameDetectionEnabled() const -> boost::optional<TimeFrameDetectionEnabledType>;
@@ -817,6 +830,11 @@ class Parameters
   /// \return The value
   auto getTimeFrameLengthRequired() const -> TimeFrameLengthType;
 
+  /// Gets the DropBadRdhEnabled parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getDropBadRdhEnabledRequired() const -> DropBadRdhEnabledType;
+
   /// Gets the TimeFrameDetectionEnabled parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value
diff --git a/src/CardConfigurator.cxx b/src/CardConfigurator.cxx
@@ -142,6 +142,7 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
   bool userAndCommonLogicEnabled = false;
   uint32_t systemId = 0x0;
   uint16_t timeFrameLength = 0x100;
+  bool dropBadRdhEnabled = false;
 
   bool enabled = false;
   std::string gbtMux = "ttc";
@@ -198,6 +199,7 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
         systemId = Hex::fromString(parsedString);
 
         timeFrameLength = subtree.get<int>("timeFrameLength");
+        dropBadRdhEnabled = subtree.get<bool>("dropBadRdhEnabled");
 
         parameters.setClock(clock);
         parameters.setDatapathMode(datapathMode);
@@ -216,6 +218,8 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
         parameters.setUserAndCommonLogicEnabled(userAndCommonLogicEnabled);
         parameters.setSystemId(systemId);
         parameters.setTimeFrameLength(timeFrameLength);
+	parameters.setDropBadRdhEnabled(dropBadRdhEnabled);
+
       } else if (group == "links") { // Configure all links with default values
 
         enabled = subtree.get<bool>("enabled");
diff --git a/src/CommandLineUtilities/ProgramConfig.cxx b/src/CommandLineUtilities/ProgramConfig.cxx
@@ -116,6 +116,7 @@ std::string getStatusReport(Parameters::CardIdType cardId)
     std::string userLogic = (reportInfo.userLogicEnabled ? "Enabled" : "Disabled");
     std::string runStats = (reportInfo.runStatsEnabled ? "Enabled" : "Disabled");
     std::string userAndCommonLogic = (reportInfo.userAndCommonLogicEnabled ? "Enabled" : "Disabled");
+    std::string dropBadRdh = (reportInfo.dropBadRdhEnabled ? "Enabled" : "Disabled");
 
     table << "-----------------------------" << std::endl;
     table << "CRU ID: " << reportInfo.cruId << std::endl;
@@ -130,6 +131,9 @@ std::string getStatusReport(Parameters::CardIdType cardId)
     if (reportInfo.runStatsEnabled) {
       table << "Run statistics enabled" << std::endl;
     }
+    if (reportInfo.dropBadRdhEnabled) {
+      table << "Drop packets with bad RDH enabled" << std::endl;
+    }
 
     Cru::OnuStatus onuStatus = cruBar2->reportOnuStatus(0);
 
@@ -315,6 +319,9 @@ class ProgramConfig : public Program
     options.add_options()("status-report",
                           po::value<std::string>(&mOptions.statusReport),
                           "Sets file where to output card status (similar to roc-status). Can be stdout, infologger, or a file name. The file name can be preceded with + for appending the file. Name can contain special escape sequences %t (timestamp) %T (date/time) or %i (card ID). Infologger reports are set with error code 4805.");
+    options.add_options()("drop-bad-rdh",
+                          po::bool_switch(&mOptions.dropBadRdhEnabled),
+                          "Flag to enable dropping of packets with bad RDH");
     Options::addOptionCardId(options);
   }
 
@@ -480,6 +487,7 @@ class ProgramConfig : public Program
       params.setTimeFrameDetectionEnabled(!mOptions.timeFrameDetectionDisabled);
       params.setSystemId(strtoul(mOptions.systemId.c_str(), NULL, 16));
       params.setFeeId(strtoul(mOptions.feeId.c_str(), NULL, 16));
+      params.setDropBadRdhEnabled(mOptions.dropBadRdhEnabled);
 
       // Generate a configuration file base on the parameters provided
       if (mOptions.genConfigFile != "") { //TODO: To be updated for the CRORC
@@ -506,6 +514,7 @@ class ProgramConfig : public Program
         //cfgFile << "timeFrameDetectionEnabled=" << std::boolalpha << !mOptions.timeFrameDetectionDisabled << "\n";
         cfgFile << "systemId=" << mOptions.systemId << "\n";
         cfgFile << "timeFrameLength=" << mOptions.timeFrameLength << "\n";
+        cfgFile << "dropBadRdhEnabled=" << std::boolalpha << mOptions.dropBadRdhEnabled << "\n";
 
         cfgFile << "[links]\n";
         cfgFile << "enabled=false\n";
@@ -589,6 +598,7 @@ class ProgramConfig : public Program
     std::string statusReport = ""; // when set, output roc status to file
     /*std::string systemId = "0x1ff"; // TODO: Default values that can be used to check if params have been specified
     std::string feeId = "0x1f";*/
+    bool dropBadRdhEnabled = false;
   } mOptions;
 
  private:
diff --git a/src/CommandLineUtilities/ProgramStatus.cxx b/src/CommandLineUtilities/ProgramStatus.cxx
@@ -211,6 +211,7 @@ class ProgramStatus : public Program
       std::string runStats = (reportInfo.runStatsEnabled ? "Enabled" : "Disabled");
       std::string userAndCommonLogic = (reportInfo.userAndCommonLogicEnabled ? "Enabled" : "Disabled");
       std::string dmaStatus = reportInfo.dmaStatus ? "Enabled" : "Disabled";
+      std::string dropBadRdh = (reportInfo.dropBadRdhEnabled ? "Enabled" : "Disabled");
 
       /* GENERAL PARAMETERS */
       if (mOptions.monitoring) {
@@ -240,6 +241,7 @@ class ProgramStatus : public Program
         root.put("userAndCommonLogic", userAndCommonLogic);
         root.put("timeFrameLength", reportInfo.timeFrameLength);
         root.put("dmaStatus", dmaStatus);
+	root.put("dropBadRdh", dropBadRdh);
       } else {
         std::cout << "-----------------------------" << std::endl;
         std::cout << "CRU ID: " << reportInfo.cruId << std::endl;
@@ -255,6 +257,9 @@ class ProgramStatus : public Program
           std::cout << "Run statistics enabled" << std::endl;
         }
          std::cout << "DMA: "<< dmaStatus << std::endl;
+	if (reportInfo.dropBadRdhEnabled) {
+	  std::cout << "Drop packets with bad RDH enabled" << std::endl;
+	}
       }
 
       /* ONU PARAMETERS */
diff --git a/src/Cru/Common.h b/src/Cru/Common.h
@@ -126,6 +126,7 @@ struct ReportInfo {
   bool userAndCommonLogicEnabled;
   uint16_t timeFrameLength;
   bool dmaStatus;
+  bool dropBadRdhEnabled;
 };
 
 struct OnuStickyStatus {
diff --git a/src/Cru/Constants.h b/src/Cru/Constants.h
@@ -327,6 +327,10 @@ static constexpr Register DWRAPPER_TOTAL_PACKETS_PER_SEC(0x0000002c);
 /// Register to set the trigger window size in gbt words
 static constexpr Register DWRAPPER_TRIGGER_SIZE(0x00000034);
 
+/// Register to enable dropping of packets with bad RDH
+static constexpr Register DWRAPPER_DROP_BAD_RDH(0x00000038);
+
+
 static constexpr Register DATALINK_PACKETS_REJECTED(0x00000008);
 static constexpr Register DATALINK_PACKETS_ACCEPTED(0x0000000c);
 static constexpr Register DATALINK_PACKETS_FORCED(0x00000010);
diff --git a/src/Cru/CruBar.cxx b/src/Cru/CruBar.cxx
@@ -68,7 +68,8 @@ CruBar::CruBar(const Parameters& parameters, std::unique_ptr<RocPciDevice> rocPc
     mGbtHighMask(parameters.getGbtHighMask().get_value_or(0xffffffff)),
     mGbtMedMask(parameters.getGbtMedMask().get_value_or(0xffffffff)),
     mGbtLowMask(parameters.getGbtLowMask().get_value_or(0xffffffff)),
-    mTimeFrameLength(parameters.getTimeFrameLength().get_value_or(0x100))
+    mTimeFrameLength(parameters.getTimeFrameLength().get_value_or(0x100)),
+    mDropBadRdhEnabled(parameters.getDropBadRdhEnabled().get_value_or(false))
 {
   if (getIndex() == 0) {
     mFeatures = parseFirmwareFeatures();
@@ -559,6 +560,7 @@ Cru::ReportInfo CruBar::report(bool forConfig)
 
   bool userAndCommonLogicEnabled = datapathWrapper.getUserAndCommonLogicEnabled(mEndpoint);
   uint16_t timeFrameLength = getTimeFrameLength();
+  bool dropBadRdhEnabled = datapathWrapper.getDropBadRdhEnabled(mEndpoint);
 
   bool dmaStatus = getDmaStatus();
 
@@ -579,6 +581,7 @@ Cru::ReportInfo CruBar::report(bool forConfig)
   reportInfo.userAndCommonLogicEnabled = userAndCommonLogicEnabled;
   reportInfo.timeFrameLength = timeFrameLength;
   reportInfo.dmaStatus = dmaStatus;
+  reportInfo.dropBadRdhEnabled = dropBadRdhEnabled;
 
   return reportInfo;
 }
@@ -744,6 +747,7 @@ void CruBar::configure(bool force)
       mRunStatsEnabled == reportInfo.runStatsEnabled &&
       mGbtEnabled == reportInfo.gbtEnabled &&
       mTimeFrameLength == reportInfo.timeFrameLength &&
+      mDropBadRdhEnabled == reportInfo.dropBadRdhEnabled &&
       !force) {
     log("No need to reconfigure further", LogInfoDevel_(4600));
     return;
@@ -875,6 +879,11 @@ void CruBar::configure(bool force)
     setTimeFrameLength(mTimeFrameLength);
   }
 
+  if (mDropBadRdhEnabled != reportInfo.dropBadRdhEnabled || force) {
+    log("Drop packets with bad RDH enabled: " + Utilities::toBoolString(mDropBadRdhEnabled), LogInfoDevel_(4605));
+    datapathWrapper.setDropBadRdhEnabled(mDropBadRdhEnabled, mEndpoint);
+  }
+
   log("CRU configuration done", LogInfoDevel_(4600));
 }
 
diff --git a/src/Cru/CruBar.h b/src/Cru/CruBar.h
@@ -186,6 +186,7 @@ class CruBar final : public BarInterfaceBase
   uint32_t mGbtLowMask;
   bool mGbtLoopbackReset;
   uint32_t mTimeFrameLength;
+  bool mDropBadRdhEnabled;
 
   int mSerial;
   int mEndpoint;
diff --git a/src/Cru/DatapathWrapper.cxx b/src/Cru/DatapathWrapper.cxx
@@ -347,5 +347,22 @@ uint32_t DatapathWrapper::getFeeId(Link link)
   return mPdaBar->readRegister(address / 4) & 0xffff;
 }
 
+void DatapathWrapper::setDropBadRdhEnabled(bool enable, int wrapper)
+{
+  uint32_t value = enable ? 0x1 : 0x0;
+  uint32_t address = getDatapathWrapperBaseAddress(wrapper) +
+                     Cru::Registers::DWRAPPER_GREGS.address +
+                     Cru::Registers::DWRAPPER_DROP_BAD_RDH.address;
+  mPdaBar->writeRegister(address / 4, value);
+}
+
+bool DatapathWrapper::getDropBadRdhEnabled(int wrapper)
+{
+  uint32_t address = getDatapathWrapperBaseAddress(wrapper) +
+                     Cru::Registers::DWRAPPER_GREGS.address +
+                     Cru::Registers::DWRAPPER_DROP_BAD_RDH.address;
+  return mPdaBar->readRegister(address / 4);
+}
+
 } // namespace roc
 } // namespace o2
diff --git a/src/Cru/DatapathWrapper.h b/src/Cru/DatapathWrapper.h
@@ -61,6 +61,8 @@ class DatapathWrapper
   uint32_t getSystemId(Link link);
   void setFeeId(Link link, uint32_t feeId);
   uint32_t getFeeId(Link link);
+  void setDropBadRdhEnabled(bool enable, int wrapper);
+  bool getDropBadRdhEnabled(int wrapper);
 
   // generic function to retrieve given register for given link
   // (to avoid defining one getter function per register...)
diff --git a/src/Parameters.cxx b/src/Parameters.cxx
@@ -154,6 +154,7 @@ _PARAMETER_FUNCTIONS(TimeFrameDetectionEnabled, "timeframe_detection_enabled")
 _PARAMETER_FUNCTIONS(SystemId, "system_id")
 _PARAMETER_FUNCTIONS(FeeId, "fee_id")
 _PARAMETER_FUNCTIONS(FeeIdMap, "fee_id_map")
+_PARAMETER_FUNCTIONS(DropBadRdhEnabled, "drop_bad_rdh_enabled")
 #undef _PARAMETER_FUNCTIONS
 
 Parameters::Parameters() : mPimpl(std::make_unique<ParametersPimpl>())
