[cru] Add support for Run Statistics links

Author: kostorr

cru_template.cfg

@@ -50,6 +50,9 @@ gbtEnabled=true
 # [true | false]
 userLogicEnabled=false
 
+# [true | false]
+runStatsEnabled=true
+
 #############################################
 # links
 #############################################

include/ReadoutCard/Parameters.h

@@ -119,6 +119,9 @@ class Parameters
   /// Type for the User Logic enabled parameter
   using UserLogicEnabledType = bool;
 
+  /// Type for the Run Statistics enabled parameter
+  using RunStatsEnabledType = bool;
+
   /// Type for the GBT enabled parameter
   using GbtEnabledType = bool;
 
@@ -228,6 +231,14 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setUserLogicEnabled(UserLogicEnabledType value) -> Parameters&;
 
+  /// Sets the RunStatsEnabled parameter
+  ///
+  /// If enabled the Run Statistics link is enabled
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setRunStatsEnabled(RunStatsEnabledType value) -> Parameters&;
+
   /// Sets the OnuAddress parameter
   ///
   /// \param value The value to set
@@ -432,6 +443,10 @@ class Parameters
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
   auto getUserLogicEnabled() const -> boost::optional<UserLogicEnabledType>;
 
+  /// Gets the RunStatsEnabled parameter
+  /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
+  auto getRunStatsEnabled() const -> boost::optional<RunStatsEnabledType>;
+
   /// Gets the OnuAddress parameter
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
   auto getOnuAddress() const -> boost::optional<OnuAddressType>;
@@ -539,6 +554,11 @@ class Parameters
   /// \return The value
   auto getUserLogicEnabledRequired() const -> UserLogicEnabledType;
 
+  /// Gets the RunStatsEnabled parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getRunStatsEnabledRequired() const -> RunStatsEnabledType;
+
   /// Gets the OnuAddress parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value

src/CardConfigurator.cxx

@@ -92,6 +92,7 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
   uint32_t triggerWindowSize = 1000;
   bool gbtEnabled = false;
   bool userLogicEnabled = false;
+  bool runStatsEnabled = false;
 
   bool enabled = false;
   std::string gbtMux = "ttc";
@@ -143,6 +144,7 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
 
         gbtEnabled = subtree.get<bool>("gbtEnabled");
         userLogicEnabled = subtree.get<bool>("userLogicEnabled");
+        runStatsEnabled = subtree.get<bool>("runStatsEnabled");
 
         parameters.setClock(clock);
         parameters.setDatapathMode(datapathMode);
@@ -157,7 +159,7 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
         parameters.setTriggerWindowSize(triggerWindowSize);
         parameters.setGbtEnabled(gbtEnabled);
         parameters.setUserLogicEnabled(userLogicEnabled);
-
+        parameters.setRunStatsEnabled(runStatsEnabled);
       } else if (group == "links") { // Configure all links with default values
 
         enabled = subtree.get<bool>("enabled");

src/CommandLineUtilities/ProgramConfig.cxx

@@ -111,6 +111,9 @@ class ProgramConfig : public Program
     options.add_options()("user-logic",
                           po::bool_switch(&mOptions.userLogicEnabled),
                           "Flag to enable the User Logic link");
+    options.add_options()("run-stats",
+                          po::bool_switch(&mOptions.runStatsEnabled),
+                          "Flag to enable the Run Statistics link");
     Options::addOptionCardId(options);
   }
 
@@ -171,6 +174,7 @@ class ProgramConfig : public Program
       params.setTriggerWindowSize(mOptions.triggerWindowSize);
       params.setGbtEnabled(!mOptions.noGbt);
       params.setUserLogicEnabled(mOptions.userLogicEnabled);
+      params.setRunStatsEnabled(mOptions.runStatsEnabled);
       params.setTimeFrameLength(mOptions.timeFrameLength);
       params.setTimeFrameDetectionEnabled(!mOptions.timeFrameDetectionDisabled);
 
@@ -247,6 +251,7 @@ class ProgramConfig : public Program
     uint32_t timeFrameLength = 0x100;
     bool timeFrameDetectionDisabled = false;
     bool userLogicEnabled = false;
+    bool runStatsEnabled = false;
     bool noGbt = false;
   } mOptions;
 

src/CommandLineUtilities/ProgramPacketMonitor.cxx

@@ -88,7 +88,6 @@ class ProgramPacketMonitor : public Program
     // initialize ptrees
     pt::ptree root;
     pt::ptree gbtLinks;
-    pt::ptree ulLink;
 
     /* TABLE */
     for (const auto& el : packetMonitoringInfo.linkPacketInfoMap) {
@@ -98,20 +97,6 @@ class ProgramPacketMonitor : public Program
       uint32_t rejected = linkMonitoringInfoMap.rejected;
       uint32_t forced = linkMonitoringInfoMap.forced;
 
-      /* UL HEADER */
-      if (globalId == 15) {
-        auto uLHeader = (boost::format(formatHeader) % "ULL ID " % "Accepted" % "Rejected" % "Forced").str();
-
-        if (mOptions.jsonOut) {
-
-        } else if (mOptions.csvOut) {
-          auto uLHeader = "Link ID,Accepted,Rejected,Forced\n";
-          std::cout << uLHeader;
-        } else {
-          table << lineFat << uLHeader << lineThin;
-        }
-      }
-
       if (mOptions.jsonOut) {
         pt::ptree linkNode;
 
@@ -121,12 +106,7 @@ class ProgramPacketMonitor : public Program
         linkNode.put("rejected", std::to_string(rejected));
         linkNode.put("forced", std::to_string(forced));
 
-        // append to the links (or UL link)
-        if (globalId == 15) {
-          ulLink.add_child(std::to_string(globalId), linkNode);
-        } else {
-          gbtLinks.add_child(std::to_string(globalId), linkNode);
-        }
+        gbtLinks.add_child(std::to_string(globalId), linkNode);
       } else if (mOptions.csvOut) {
         auto csvLine = std::to_string(globalId) + "," + std::to_string(accepted) + "," + std::to_string(rejected) + "," + std::to_string(forced) + "\n";
         std::cout << csvLine;
@@ -138,7 +118,6 @@ class ProgramPacketMonitor : public Program
 
     // add links nodes to the tree
     root.add_child("gbtLinks", gbtLinks);
-    root.add_child("userLogicLink", ulLink);
 
     /* PRINT */
     if (!mOptions.csvOut) {

src/CommandLineUtilities/ProgramStatus.cxx

@@ -181,7 +181,7 @@ class ProgramStatus : public Program
       auto cruBar2 = std::dynamic_pointer_cast<CruBar>(bar2);
 
       if (mOptions.csvOut) {
-        auto csvHeader = "Link ID,GBT Mode,Loopback,GBT Mux,Datapath Mode,Datapath,RX Freq(MHz),TX Freq(MHz),Status,Optical Power(uW),Clock,Offset,UserLogic\n";
+        auto csvHeader = "Link ID,GBT Mode,Loopback,GBT Mux,Datapath Mode,Datapath,RX Freq(MHz),TX Freq(MHz),Status,Optical Power(uW),Clock,Offset,UserLogic,RunStats\n";
         std::cout << csvHeader;
       } else if (!mOptions.jsonOut) {
         table << lineFat << header << lineThin;
@@ -192,6 +192,7 @@ class ProgramStatus : public Program
       std::string clock = (reportInfo.ttcClock == 0 ? "TTC" : "Local");
       std::string offset = (reportInfo.dynamicOffset ? "Dynamic" : "Fixed");
       std::string userLogic = (reportInfo.userLogicEnabled ? "Enabled" : "Disabled");
+      std::string runStats = (reportInfo.runStatsEnabled ? "Enabled" : "Disabled");
 
       /* GENERAL PARAMETERS */
       if (mOptions.monitoring) {
@@ -200,20 +201,23 @@ class ProgramStatus : public Program
                            .addValue(clock, "clock")
                            .addValue(reportInfo.dynamicOffset, "dynamicOffset")
                            .addValue(reportInfo.userLogicEnabled, "userLogic")
+                           .addValue(reportInfo.runStatsEnabled, "runStats")
                            .addTag(tags::Key::ID, card.sequenceId)
                            .addTag(tags::Key::Type, tags::Value::CRU));
       } else if (mOptions.jsonOut) {
         root.put("clock", clock);
         root.put("offset", offset);
         root.put("userLogic", userLogic);
+        root.put("runStats", runStats);
       } else if (mOptions.csvOut) {
-        auto csvLine = ",,,,,,,,,," + clock + "," + offset + "," + userLogic + "\n";
+        auto csvLine = ",,,,,,,,,," + clock + "," + offset + "," + userLogic + "," + runStats + "\n";
         std::cout << csvLine;
       } else {
         std::cout << "----------------------------" << std::endl;
         std::cout << clock << " clock | ";
         std::cout << offset << " offset" << std::endl;
         std::cout << "User Logic " << userLogic << std::endl;
+        std::cout << "Run statistics " << runStats << std::endl;
         std::cout << "----------------------------" << std::endl;
       }
 

src/Cru/Common.h

@@ -91,6 +91,7 @@ struct ReportInfo {
   uint32_t triggerWindowSize;
   bool gbtEnabled;
   bool userLogicEnabled;
+  bool runStatsEnabled;
 };
 
 struct OnuStatus {

src/Cru/CruBar.cxx

@@ -54,7 +54,8 @@ CruBar::CruBar(const Parameters& parameters, std::unique_ptr<RocPciDevice> rocPc
     mDynamicOffset(parameters.getDynamicOffsetEnabled().get_value_or(false)),
     mTriggerWindowSize(parameters.getTriggerWindowSize().get_value_or(1000)),
     mGbtEnabled(parameters.getGbtEnabled().get_value_or(true)),
-    mUserLogicEnabled(parameters.getUserLogicEnabled().get_value_or(false))
+    mUserLogicEnabled(parameters.getUserLogicEnabled().get_value_or(false)),
+    mRunStatsEnabled(parameters.getRunStatsEnabled().get_value_or(false))
 {
   if (getIndex() == 0) {
     mFeatures = parseFirmwareFeatures();
@@ -494,9 +495,13 @@ Cru::ReportInfo CruBar::report()
   Link userLogicLink;
   userLogicLink.dwrapper = mEndpoint;
   userLogicLink.dwrapperId = 15;
-
   bool userLogicEnabled = datapathWrapper.getLinkEnabled(userLogicLink);
 
+  Link runStatsLink;
+  runStatsLink.dwrapper = mEndpoint;
+  runStatsLink.dwrapperId = (mEndpoint == 0) ? 13 : 14;
+  bool runStatsEnabled = datapathWrapper.getLinkEnabled(runStatsLink);
+
   Cru::ReportInfo reportInfo = {
     linkMap,
     clock,
@@ -507,7 +512,8 @@ Cru::ReportInfo CruBar::report()
     dynamicOffset,
     triggerWindowSize,
     gbtEnabled,
-    userLogicEnabled
+    userLogicEnabled,
+    runStatsEnabled
   };
 
   return reportInfo;
@@ -527,14 +533,23 @@ Cru::PacketMonitoringInfo CruBar::monitorPackets()
     linkPacketInfoMap.insert({ el.first, { accepted, rejected, forced } });
   }
 
+  // Insert the Run Statistics link
+  Link runStatsLink = {};
+  runStatsLink.dwrapper = mEndpoint;
+  runStatsLink.dwrapperId = (mEndpoint == 0) ? 13 : 14;
+  uint32_t accepted = datapathWrapper.getAcceptedPackets(runStatsLink);
+  uint32_t rejected = datapathWrapper.getRejectedPackets(runStatsLink);
+  uint32_t forced = datapathWrapper.getForcedPackets(runStatsLink);
+  linkPacketInfoMap.insert({ runStatsLink.dwrapperId, { accepted, rejected, forced } });
+
   // Insert the UL link at 15
   Link uLLink = {};
   // dwrapper 0 on endpoint 0, dwrapper 1 on endpoint 1
   uLLink.dwrapper = mEndpoint;
   uLLink.dwrapperId = 15;
-  uint32_t accepted = datapathWrapper.getAcceptedPackets(uLLink);
-  uint32_t rejected = datapathWrapper.getRejectedPackets(uLLink);
-  uint32_t forced = datapathWrapper.getForcedPackets(uLLink);
+  accepted = datapathWrapper.getAcceptedPackets(uLLink);
+  rejected = datapathWrapper.getRejectedPackets(uLLink);
+  forced = datapathWrapper.getForcedPackets(uLLink);
   linkPacketInfoMap.insert({ 15, { accepted, rejected, forced } });
 
   int wrapper = mEndpoint;
@@ -561,6 +576,7 @@ void CruBar::configure(bool force)
       mDynamicOffset == reportInfo.dynamicOffset &&
       mTriggerWindowSize == reportInfo.triggerWindowSize &&
       mUserLogicEnabled == reportInfo.userLogicEnabled &&
+      mRunStatsEnabled == reportInfo.runStatsEnabled &&
       mGbtEnabled == reportInfo.gbtEnabled &&
       !force) {
     log("No need to reconfigure further");
@@ -608,6 +624,7 @@ void CruBar::configure(bool force)
     // Disable all links
     datapathWrapper.setLinksEnabled(mEndpoint, 0x0);
     toggleUserLogicLink(reportInfo.userLogicEnabled); // Make sure the user logic link retains its state
+    toggleRunStatsLink(reportInfo.runStatsEnabled);   // Make sure the run stats link retains its state
   } else if (mGbtEnabled && (!std::equal(mLinkMap.begin(), mLinkMap.end(), reportInfo.linkMap.begin()) || force)) {
     /* BSP */
     disableDataTaking();
@@ -647,6 +664,12 @@ void CruBar::configure(bool force)
     toggleUserLogicLink(mUserLogicEnabled);
   }
 
+  /* RUN STATS */
+  if (mRunStatsEnabled != reportInfo.runStatsEnabled || force) {
+    log("Toggling the Run Statistics link");
+    toggleRunStatsLink(mRunStatsEnabled);
+  }
+
   /* BSP */
   if (mCruId != reportInfo.cruId || force) {
     log("Setting the CRU ID");
@@ -915,6 +938,20 @@ void CruBar::toggleUserLogicLink(bool userLogicEnabled)
   datapathWrapper.setDatapathMode(userLogicLink, mDatapathMode);
 }
 
+void CruBar::toggleRunStatsLink(bool runStatsLinkEnabled)
+{
+  Link runStatsLink;
+  runStatsLink.dwrapper = mEndpoint;
+  runStatsLink.dwrapperId = (mEndpoint == 0) ? 13 : 14;
+
+  DatapathWrapper datapathWrapper = DatapathWrapper(mPdaBar);
+  if (runStatsLinkEnabled) {
+    datapathWrapper.setLinkEnabled(runStatsLink);
+  } else {
+    datapathWrapper.setLinkDisabled(runStatsLink);
+  }
+}
+
 boost::optional<std::string> CruBar::getUserLogicVersion()
 {
   uint32_t firmwareHash = readRegister(Cru::Registers::USERLOGIC_GIT_HASH.index);

src/Cru/CruBar.h

@@ -92,6 +92,7 @@ class CruBar final : public BarInterfaceBase
   bool getDebugModeEnabled();
 
   void toggleUserLogicLink(bool mUserLogicEnabled);
+  void toggleRunStatsLink(bool mRunStatsLinkEnabled);
   boost::optional<std::string> getUserLogicVersion();
 
   Cru::OnuStatus reportOnuStatus();
@@ -148,6 +149,7 @@ class CruBar final : public BarInterfaceBase
   uint32_t mTriggerWindowSize;
   bool mGbtEnabled;
   bool mUserLogicEnabled;
+  bool mRunStatsEnabled;
 
   int mEndpoint;
 

src/Cru/CruDmaChannel.cxx

@@ -74,16 +74,27 @@ CruDmaChannel::CruDmaChannel(const Parameters& parameters)
     DatapathWrapper dwrapper = DatapathWrapper(getBar2()->getPdaBar());
     auto linkMap = getBar2()->initializeLinkMap();
 
-    std::stringstream stream;
-    stream << "Using link(s): ";
+    int endpoint = getBar()->getEndpointNumber();
+
+    Cru::Link newLink;
+    newLink.dwrapper = endpoint;
 
-    Cru::Link userLogicLink;
-    userLogicLink.dwrapper = getBar()->getEndpointNumber();
-    userLogicLink.dwrapperId = 15;
-    if (dwrapper.getLinkEnabled(userLogicLink)) {
-      linkMap.insert({ 15, userLogicLink });
+    // Insert UL link
+    newLink.dwrapperId = 15;
+    if (dwrapper.getLinkEnabled(newLink)) {
+      linkMap.insert({ 15, newLink });
     }
 
+    // Insert Run Statistics link
+    newLink.dwrapperId = (endpoint == 0) ? 13 : 14;
+
+    if (dwrapper.getLinkEnabled(newLink)) {
+      linkMap.insert({ newLink.dwrapperId, newLink });
+    }
+
+    std::stringstream stream;
+    stream << "Using link(s): ";
+
     for (const auto& el : linkMap) {
       auto id = el.first;
       auto link = el.second;