[config] Add user-and-common-logic option

Author: kostorr

README.md

@@ -464,12 +464,14 @@ metric format for the CRORC and the CRU is different, as different parameters ar
 
 ###### Metric: `"CRU"`
 
-| Value name        | Value                   | Type   | 
-| ----------------- | ----------------------- | ------ | 
-| `"pciAddress"`    | -                       | string |
-| `"clock"`         | "TTC" or "Local"        | string |
-| `"dynamicOffset"` | 0/1 (Disabled/Enabled)  | int    |
-| `"userLogic"`     | 0/1 (Disabled/Enabled)  | int    |
+| Value name                  | Value                   | Type   | 
+| --------------------------- | ----------------------- | ------ | 
+| `"pciAddress"`              | -                       | string |
+| `"clock"`                   | "TTC" or "Local"        | string |
+| `"dynamicOffset"`           | 0/1 (Disabled/Enabled)  | int    |
+| `"userLogic"`               | 0/1 (Disabled/Enabled)  | int    |
+| `"runStats"`                | 0/1 (Disabled/Enabled)  | int    |
+| `"commonAndUserLogic"`      | 0/1 (Disabled/Enabled)  | int    |
 
 | Tag key           | Value              |
 | ----------------- | ------------------ |

cru_template.cfg

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

include/ReadoutCard/Parameters.h

@@ -122,6 +122,9 @@ class Parameters
   /// Type for the Run Statistics enabled parameter
   using RunStatsEnabledType = bool;
 
+  /// Type for the User and Common Logic enabled parameter
+  using UserAndCommonLogicEnabledType = bool;
+
   /// Type for the GBT enabled parameter
   using GbtEnabledType = bool;
 
@@ -239,6 +242,14 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setRunStatsEnabled(RunStatsEnabledType value) -> Parameters&;
 
+  /// Sets the UserAndCommonLogicEnabled parameter
+  ///
+  /// If enabled both User and Common Logic is enabled
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setUserAndCommonLogicEnabled(UserAndCommonLogicEnabledType value) -> Parameters&;
+
   /// Sets the OnuAddress parameter
   ///
   /// \param value The value to set
@@ -447,6 +458,10 @@ class Parameters
   /// \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 UserAndCommonLogicEnabled parameter
+  /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
+  auto getUserAndCommonLogicEnabled() const -> boost::optional<UserAndCommonLogicEnabledType>;
+
   /// 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>;
@@ -559,6 +574,11 @@ class Parameters
   /// \return The value
   auto getRunStatsEnabledRequired() const -> RunStatsEnabledType;
 
+  /// Gets the UserAndCommonLogicEnabled parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getUserAndCommonLogicEnabledRequired() const -> UserAndCommonLogicEnabledType;
+
   /// Gets the OnuAddress parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value

src/CardConfigurator.cxx

@@ -93,6 +93,7 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
   bool gbtEnabled = false;
   bool userLogicEnabled = false;
   bool runStatsEnabled = false;
+  bool userAndCommonLogicEnabled = false;
 
   bool enabled = false;
   std::string gbtMux = "ttc";
@@ -145,6 +146,7 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
         gbtEnabled = subtree.get<bool>("gbtEnabled");
         userLogicEnabled = subtree.get<bool>("userLogicEnabled");
         runStatsEnabled = subtree.get<bool>("runStatsEnabled");
+        userAndCommonLogicEnabled = subtree.get<bool>("userAndCommonLogicEnabled");
 
         parameters.setClock(clock);
         parameters.setDatapathMode(datapathMode);
@@ -160,6 +162,7 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
         parameters.setGbtEnabled(gbtEnabled);
         parameters.setUserLogicEnabled(userLogicEnabled);
         parameters.setRunStatsEnabled(runStatsEnabled);
+        parameters.setUserAndCommonLogicEnabled(userAndCommonLogicEnabled);
       } else if (group == "links") { // Configure all links with default values
 
         enabled = subtree.get<bool>("enabled");

src/CommandLineUtilities/ProgramConfig.cxx

@@ -114,6 +114,9 @@ class ProgramConfig : public Program
     options.add_options()("run-stats",
                           po::bool_switch(&mOptions.runStatsEnabled),
                           "Flag to enable the Run Statistics link");
+    options.add_options()("user-and-common-logic",
+                          po::bool_switch(&mOptions.userAndCommonLogicEnabled),
+                          "Flag to enable the User and Common Logic");
     Options::addOptionCardId(options);
   }
 
@@ -175,6 +178,7 @@ class ProgramConfig : public Program
       params.setGbtEnabled(!mOptions.noGbt);
       params.setUserLogicEnabled(mOptions.userLogicEnabled);
       params.setRunStatsEnabled(mOptions.runStatsEnabled);
+      params.setUserAndCommonLogicEnabled(mOptions.userAndCommonLogicEnabled);
       params.setTimeFrameLength(mOptions.timeFrameLength);
       params.setTimeFrameDetectionEnabled(!mOptions.timeFrameDetectionDisabled);
 
@@ -196,6 +200,10 @@ class ProgramConfig : public Program
         cfgFile << "onuAddress=" << mOptions.onuAddress << "\n";
         cfgFile << "dynamicOffset=" << std::boolalpha << mOptions.dynamicOffsetEnabled << "\n";
         cfgFile << "triggerWindowSize=" << mOptions.triggerWindowSize << "\n";
+        cfgFile << "gbtEnabled=" << std::boolalpha << !mOptions.noGbt << "\n";
+        cfgFile << "userLogicEnabled=" << std::boolalpha << mOptions.userLogicEnabled << "\n";
+        cfgFile << "runStatsEnabled=" << std::boolalpha << mOptions.runStatsEnabled << "\n";
+        cfgFile << "userAndCommonLogicEnabled=" << std::boolalpha << mOptions.userAndCommonLogicEnabled << "\n";
 
         cfgFile << "[links]\n";
         cfgFile << "enabled=false\n";
@@ -252,6 +260,7 @@ class ProgramConfig : public Program
     bool timeFrameDetectionDisabled = false;
     bool userLogicEnabled = false;
     bool runStatsEnabled = false;
+    bool userAndCommonLogicEnabled = false;
     bool noGbt = false;
   } mOptions;
 

src/CommandLineUtilities/ProgramStatus.cxx

@@ -193,6 +193,7 @@ class ProgramStatus : public Program
       std::string offset = (reportInfo.dynamicOffset ? "Dynamic" : "Fixed");
       std::string userLogic = (reportInfo.userLogicEnabled ? "Enabled" : "Disabled");
       std::string runStats = (reportInfo.runStatsEnabled ? "Enabled" : "Disabled");
+      std::string userAndCommonLogic = (reportInfo.userAndCommonLogicEnabled ? "Enabled" : "Disabled");
 
       /* GENERAL PARAMETERS */
       if (mOptions.monitoring) {
@@ -202,13 +203,15 @@ class ProgramStatus : public Program
                            .addValue(reportInfo.dynamicOffset, "dynamicOffset")
                            .addValue(reportInfo.userLogicEnabled, "userLogic")
                            .addValue(reportInfo.runStatsEnabled, "runStats")
+                           .addValue(reportInfo.userAndCommonLogicEnabled, "userAndCommonLogic")
                            .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);
+        root.put("userAndCommonLogic", userAndCommonLogic);
       } else if (mOptions.csvOut) {
         auto csvLine = ",,,,,,,,,," + clock + "," + offset + "," + userLogic + "," + runStats + "\n";
         std::cout << csvLine;
@@ -218,6 +221,7 @@ class ProgramStatus : public Program
         std::cout << offset << " offset" << std::endl;
         std::cout << "User Logic " << userLogic << std::endl;
         std::cout << "Run statistics " << runStats << std::endl;
+        std::cout << "User and Common logic " << runStats << std::endl;
         std::cout << "----------------------------" << std::endl;
       }
 

src/Cru/Common.h

@@ -92,6 +92,7 @@ struct ReportInfo {
   bool gbtEnabled;
   bool userLogicEnabled;
   bool runStatsEnabled;
+  bool userAndCommonLogicEnabled;
 };
 
 struct OnuStatus {

src/Cru/CruBar.cxx

@@ -55,7 +55,8 @@ CruBar::CruBar(const Parameters& parameters, std::unique_ptr<RocPciDevice> rocPc
     mTriggerWindowSize(parameters.getTriggerWindowSize().get_value_or(1000)),
     mGbtEnabled(parameters.getGbtEnabled().get_value_or(true)),
     mUserLogicEnabled(parameters.getUserLogicEnabled().get_value_or(false)),
-    mRunStatsEnabled(parameters.getRunStatsEnabled().get_value_or(false))
+    mRunStatsEnabled(parameters.getRunStatsEnabled().get_value_or(false)),
+    mUserAndCommonLogicEnabled(parameters.getUserAndCommonLogicEnabled().get_value_or(false))
 {
   if (getIndex() == 0) {
     mFeatures = parseFirmwareFeatures();
@@ -502,6 +503,8 @@ Cru::ReportInfo CruBar::report()
   runStatsLink.dwrapperId = (mEndpoint == 0) ? 13 : 14;
   bool runStatsEnabled = datapathWrapper.getLinkEnabled(runStatsLink);
 
+  bool userAndCommonLogicEnabled = datapathWrapper.getUserAndCommonLogicEnabled(mEndpoint);
+
   Cru::ReportInfo reportInfo = {
     linkMap,
     clock,
@@ -513,7 +516,8 @@ Cru::ReportInfo CruBar::report()
     triggerWindowSize,
     gbtEnabled,
     userLogicEnabled,
-    runStatsEnabled
+    runStatsEnabled,
+    userAndCommonLogicEnabled
   };
 
   return reportInfo;
@@ -670,6 +674,12 @@ void CruBar::configure(bool force)
     toggleRunStatsLink(mRunStatsEnabled);
   }
 
+  /* UL + CL */
+  if (mUserAndCommonLogicEnabled != reportInfo.userAndCommonLogicEnabled || force) {
+    log("Enabling User and Common Logic");
+    datapathWrapper.enableUserAndCommonLogic(mUserAndCommonLogicEnabled, mEndpoint);
+  }
+
   /* BSP */
   if (mCruId != reportInfo.cruId || force) {
     log("Setting the CRU ID");

src/Cru/CruBar.h

@@ -150,6 +150,7 @@ class CruBar final : public BarInterfaceBase
   bool mGbtEnabled;
   bool mUserLogicEnabled;
   bool mRunStatsEnabled;
+  bool mUserAndCommonLogicEnabled;
 
   int mEndpoint;
 

src/Cru/DatapathWrapper.cxx

@@ -284,5 +284,19 @@ uint32_t DatapathWrapper::getTriggerWindowSize(int wrapper)
   return mPdaBar->readRegister(address / 4);
 }
 
+void DatapathWrapper::enableUserAndCommonLogic(bool enable, int wrapper)
+{
+  uint32_t value = enable ? 0x1 : 0x0;
+  uint32_t address = (wrapper == 0) ? Cru::Registers::DWRAPPER_BASE0.index : Cru::Registers::DWRAPPER_BASE1.index;
+
+  mPdaBar->modifyRegister(address, 30, 1, value);
+}
+
+bool DatapathWrapper::getUserAndCommonLogicEnabled(int wrapper)
+{
+  uint32_t address = (wrapper == 0) ? Cru::Registers::DWRAPPER_BASE0.index : Cru::Registers::DWRAPPER_BASE1.index;
+  return (Utilities::getBit(mPdaBar->readRegister(address), 30) == 0x1);
+}
+
 } // namespace roc
 } // namespace AliceO2