Merge pull request #422 from sy-c/master

v0.45.2

Author: sy-c

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

cru_template.cfg

@@ -62,6 +62,9 @@ systemId=0xfd
 # Time Frame Length [0-255]
 timeFrameLength=255
 
+# Drop packets with bad RDH
+dropBadRdhEnabled=false
+
 #############################################
 # links
 #############################################

cru_template.json

@@ -16,7 +16,8 @@
           "runStatsEnabled": "false",
           "userAndCommonLogicEnabled": "false",
           "systemId": "0x0",
-          "timeFrameLength": "256"
+          "timeFrameLength": "256",
+	  "dropBadRdhEnabled": "false"
         },
       "links": {
             "enabled": "false",

doc/releaseNotes.md

@@ -73,3 +73,7 @@ This file describes the main feature changes for released versions of ReadoutCar
 
 ## v0.45.1 - 24/01/2024
 - o2-roc-list-cards:  get NUMA card info from system instead of PDA PciDevice_getNumaNode() function, which reports wrong node for RH8. Fix also applies to field in RocPciDevice internal class.
+
+## v0.45.2 - 29/05/2024
+- Updated list of firmwares.
+- Added CRU option dropBadRdhEnabled.

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

src/BarInterfaceBase.h

@@ -131,6 +131,11 @@ class BarInterfaceBase : public BarInterface
   /// Convenience function for InfoLogger
   void log(const std::string& logMessage, ILMessageOption = LogInfoDevel);
 
+  /// Get a string descriptor, to be used for logs or exceptions
+  const std::string &getLoggerPrefix() {
+    return mLoggerPrefix;
+  };
+
  private:
   /// Inheriting classes must implement this to check whether a given read is safe.
   /// If it is not safe, it should throw an UnsafeReadAccess exception

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");

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:

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 */

src/Crorc/CrorcBar.cxx

@@ -191,7 +191,7 @@ void CrorcBar::assertLinkUp()
   }
 
   if (!checkLinkUp()) {
-    BOOST_THROW_EXCEPTION(CrorcCheckLinkException() << ErrorInfo::Message("Link was not up"));
+    BOOST_THROW_EXCEPTION(CrorcCheckLinkException() << ErrorInfo::Message(getLoggerPrefix() + "Link was not up"));
   }
 }
 
@@ -238,7 +238,7 @@ bool CrorcBar::getDynamicOffsetEnabled()
 void CrorcBar::setTimeFrameLength(uint16_t timeFrameLength)
 {
   if (timeFrameLength > 256) {
-    BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message("BAD TF LENGTH, should be less or equal to 256") << ErrorInfo::ConfigValue(timeFrameLength));
+    BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message(getLoggerPrefix() + "BAD TF LENGTH, should be less or equal to 256") << ErrorInfo::ConfigValue(timeFrameLength));
   }
   modifyRegister(Crorc::Registers::CFG_CONTROL_B.index, 0, 11, timeFrameLength);
 }
@@ -299,7 +299,7 @@ void CrorcBar::sendDdlCommand(uint32_t address, uint32_t command)
   while ((std::chrono::steady_clock::now() < timeOut) && !checkFifoEmpty()) {
   }
   if (!checkFifoEmpty()) {
-    BOOST_THROW_EXCEPTION(CrorcCheckLinkException() << ErrorInfo::Message("Link was not up"));
+    BOOST_THROW_EXCEPTION(CrorcCheckLinkException() << ErrorInfo::Message(getLoggerPrefix() + "Link was not up"));
   } else {
     readRegister(Crorc::Registers::DDL_STATUS.index);
   }