[config] Add discrete options to enable UL link 15 & disable GBT

Author: kostorr

README.md

@@ -163,6 +163,10 @@ The Parameters that affect the configuration of the CRU, their possible values (
 
 `TriggerWindowSize (0 - 4095) [1000]`
 
+`GbtEnabled (true | false) [true]`
+
+`UserLogicEnabled (true | false) [false]`
+
 To set any of the above parameters the usual template can be followed.
 
 ```
@@ -180,13 +184,14 @@ 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` and `DynamicOffsetEnabled` it is sufficient to do the following, as they are simply booleans.
+Note that for `AllowRejection`, `LinkLoopbackEnabled`, `PonUpstreamEnabled`, `DynamicOffsetEnabled`, `GbtEnabled` and `UserLogicEnabled` it is sufficient to do the following, as they are simply booleans.
 
 ```
 params.setAllowRejection(true);
 params.setLinkLoopbackEnabled(true);
 params.setPonUpstreamEnabled(true);
 params.setDynamicOffsetEnabled(true);
+...
 ```
 
 Likewise for `OnuAddress`, passing the hex is enough.
@@ -213,6 +218,8 @@ ponUpstream
 onuAddress
 dynamicOffsetEnabled
 triggerWindowSize
+gbtEnabled
+UserLogicEnabled
 ```
 
 The "per link" parameters are

cru_template.cfg

@@ -44,6 +44,12 @@ dynamicOffset=false
 # [<4096]
 triggerWindowSize=1000
 
+# [true | false]
+gbtEnabled=true
+
+# [true | false]
+userLogicEnabled=false
+
 #############################################
 # links
 #############################################

include/ReadoutCard/Parameters.h

@@ -116,6 +116,12 @@ class Parameters
   /// Type for the Dynamic Offset enabled parameter
   using DynamicOffsetEnabledType = bool;
 
+  /// Type for the User Logic enabled parameter
+  using UserLogicEnabledType = bool;
+
+  /// Type for the GBT enabled parameter
+  using GbtEnabledType = bool;
+
   /// Type for the ONU address parameter
   using OnuAddressType = Hex::type;
 
@@ -183,12 +189,28 @@ class Parameters
 
   /// Sets the DynamicOffsetEnabled parameter
   ///
-  /// If enabled the PON upstream is used.
+  /// If enabled the Dynamic Offset is used.
   ///
   /// \param value The value to set
   /// \return Reference to this object for chaining calls
   auto setDynamicOffsetEnabled(DynamicOffsetEnabledType value) -> Parameters&;
 
+  /// Sets the GbtEnabled parameter
+  ///
+  /// If enabled the GBT is used.
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setGbtEnabled(GbtEnabledType value) -> Parameters&;
+
+  /// Sets the UserLogicEnabled parameter
+  ///
+  /// If enabled the User Logic is used.
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setUserLogicEnabled(UserLogicEnabledType value) -> Parameters&;
+
   /// Sets the OnuAddress parameter
   ///
   /// \param value The value to set
@@ -369,6 +391,14 @@ class Parameters
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
   auto getDynamicOffsetEnabled() const -> boost::optional<DynamicOffsetEnabledType>;
 
+  /// Gets the GbtEnabled parameter
+  /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
+  auto getGbtEnabled() const -> boost::optional<GbtEnabledType>;
+
+  /// Gets the UserLogicEnabled parameter
+  /// \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 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>;
@@ -453,6 +483,16 @@ class Parameters
   /// \return The value
   auto getDynamicOffsetEnabledRequired() const -> DynamicOffsetEnabledType;
 
+  /// Gets the GbtEnabled parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getGbtEnabledRequired() const -> GbtEnabledType;
+
+  /// Gets the UserLogicEnabled parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getUserLogicEnabledRequired() const -> UserLogicEnabledType;
+
   /// Gets the OnuAddress parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value

src/CardConfigurator.cxx

@@ -90,6 +90,8 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
   GbtMode::type gbtMode = GbtMode::type::Gbt;
   DownstreamData::type downstreamData = DownstreamData::type::Ctp;
   uint32_t triggerWindowSize = 1000;
+  bool gbtEnabled = false;
+  bool userLogicEnabled = false;
 
   bool enabled = false;
   std::string gbtMux = "ttc";
@@ -139,6 +141,9 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
 
         triggerWindowSize = conf->get<int>("triggerWindowSize");
 
+        gbtEnabled = conf->get<bool>("gbtEnabled");
+        userLogicEnabled = conf->get<bool>("userLogicEnabled");
+
         conf->setPrefix("");
 
         parameters.setClock(clock);
@@ -152,6 +157,8 @@ void CardConfigurator::parseConfigUriCru(std::string configUri, Parameters& para
         parameters.setCruId(cruId);
         parameters.setAllowRejection(allowRejection);
         parameters.setTriggerWindowSize(triggerWindowSize);
+        parameters.setGbtEnabled(gbtEnabled);
+        parameters.setUserLogicEnabled(userLogicEnabled);
 
       } else if (group == "links") { // Configure all links with default values
 

src/CommandLineUtilities/ProgramConfig.cxx

@@ -99,6 +99,12 @@ class ProgramConfig : public Program
     options.add_options()("gen-cfg-file",
                           po::value<std::string>(&mOptions.genConfigFile),
                           "If set generates a configuration file from the command line options. [DOES NOT CONFIGURE]");
+    options.add_options()("no-gbt",
+                          po::bool_switch(&mOptions.noGbt),
+                          "Flag to switch off GBT");
+    options.add_options()("user-logic",
+                          po::bool_switch(&mOptions.userLogicEnabled),
+                          "Flag to enable the User Logic link");
     Options::addOptionCardId(options);
   }
 
@@ -157,6 +163,8 @@ class ProgramConfig : public Program
       params.setDynamicOffsetEnabled(mOptions.dynamicOffsetEnabled);
       params.setOnuAddress(mOptions.onuAddress);
       params.setTriggerWindowSize(mOptions.triggerWindowSize);
+      params.setGbtEnabled(!mOptions.noGbt);
+      params.setUserLogicEnabled(mOptions.userLogicEnabled);
 
       // Generate a configuration file base on the parameters provided
       if (mOptions.genConfigFile != "") { //TODO: To be updated for the CRORC
@@ -228,6 +236,8 @@ class ProgramConfig : public Program
     std::string cruId = "0x0";
     std::string crorcId = "0x0";
     uint32_t triggerWindowSize = 1000;
+    bool userLogicEnabled = false;
+    bool noGbt = false;
   } mOptions;
 
  private:

src/CommandLineUtilities/ProgramStatus.cxx

@@ -187,6 +187,11 @@ class ProgramStatus : public Program
         } else {
           std::cout << "Fixed offset" << std::endl;
         }
+        if (reportInfo.userLogicEnabled) {
+          std::cout << "User Logic Enabled" << std::endl;
+        } else {
+          std::cout << "User Logic Disabled" << std::endl;
+        }
         std::cout << "----------------------------" << std::endl;
       }
 

src/Cru/Common.h

@@ -92,6 +92,8 @@ struct ReportInfo {
   uint16_t cruId;
   bool dynamicOffset;
   uint32_t triggerWindowSize;
+  bool gbtEnabled;
+  bool userLogicEnabled;
 };
 
 struct OnuStatus {

src/Cru/Constants.h

@@ -27,7 +27,7 @@ namespace Cru
 {
 
 /// Maximum amount of available links
-static constexpr int MAX_LINKS = 12;
+static constexpr int MAX_LINKS = 16;
 
 /// Amount of available superpage descriptors per link
 static constexpr int MAX_SUPERPAGE_DESCRIPTORS = 128;

src/Cru/CruBar.cxx

@@ -50,7 +50,9 @@ CruBar::CruBar(const Parameters& parameters, std::unique_ptr<RocPciDevice> rocPc
     mPonUpstream(parameters.getPonUpstreamEnabled().get_value_or(false)),
     mOnuAddress(parameters.getOnuAddress().get_value_or(0x0)),
     mDynamicOffset(parameters.getDynamicOffsetEnabled().get_value_or(false)),
-    mTriggerWindowSize(parameters.getTriggerWindowSize().get_value_or(1000))
+    mTriggerWindowSize(parameters.getTriggerWindowSize().get_value_or(1000)),
+    mGbtEnabled(parameters.getGbtEnabled().get_value_or(true)),
+    mUserLogicEnabled(parameters.getUserLogicEnabled().get_value_or(false))
 {
   if (getIndex() == 0) {
     mFeatures = parseFirmwareFeatures();
@@ -406,6 +408,7 @@ Cru::ReportInfo CruBar::report()
 {
   std::map<int, Link> linkMap = initializeLinkMap();
 
+  bool gbtEnabled = false;
   // Update linkMap
   Gbt gbt = Gbt(mPdaBar, linkMap, mWrapperCount);
   gbt.getGbtModes();
@@ -422,6 +425,10 @@ Cru::ReportInfo CruBar::report()
     link.stickyBit = gbt.getStickyBit(link);
     link.rxFreq = gbt.getRxClockFrequency(link) / 1e6; // Hz -> Mhz
     link.txFreq = gbt.getTxClockFrequency(link) / 1e6; // Hz -> Mhz
+
+    if (link.enabled) {
+      gbtEnabled = true;
+    }
   }
 
   // Update the link map with optical power information through I2C
@@ -440,6 +447,12 @@ Cru::ReportInfo CruBar::report()
   bool dynamicOffset = datapathWrapper.getDynamicOffsetEnabled(mEndpoint);
   uint32_t triggerWindowSize = datapathWrapper.getTriggerWindowSize(mEndpoint);
 
+  Link userLogicLink;
+  userLogicLink.dwrapper = mEndpoint;
+  userLogicLink.dwrapperId = 15;
+
+  bool userLogicEnabled = datapathWrapper.getLinkEnabled(userLogicLink);
+
   Cru::ReportInfo reportInfo = {
     linkMap,
     clock,
@@ -448,7 +461,9 @@ Cru::ReportInfo CruBar::report()
     onuAddress,
     cruId,
     dynamicOffset,
-    triggerWindowSize
+    triggerWindowSize,
+    gbtEnabled,
+    userLogicEnabled
   };
 
   return reportInfo;
@@ -500,6 +515,8 @@ void CruBar::configure(bool force)
       mCruId == reportInfo.cruId &&
       mDynamicOffset == reportInfo.dynamicOffset &&
       mTriggerWindowSize == reportInfo.triggerWindowSize &&
+      mUserLogicEnabled == reportInfo.userLogicEnabled &&
+      mGbtEnabled == reportInfo.gbtEnabled &&
       !force) {
     log("No need to reconfigure further");
     return;
@@ -527,11 +544,13 @@ void CruBar::configure(bool force)
       }
     }
 
-    log("Calibrating the fPLLs");
-    Gbt gbt = Gbt(mPdaBar, mLinkMap, mWrapperCount);
-    gbt.calibrateGbt(mLinkMap);
-    Cru::fpllref(mLinkMap, mPdaBar, 2);
-    Cru::fpllcal(mLinkMap, mPdaBar);
+    if (mGbtEnabled) {
+      log("Calibrating the fPLLs");
+      Gbt gbt = Gbt(mPdaBar, mLinkMap, mWrapperCount);
+      gbt.calibrateGbt(mLinkMap);
+      Cru::fpllref(mLinkMap, mPdaBar, 2);
+      Cru::fpllcal(mLinkMap, mPdaBar);
+    }
   }
 
   if (static_cast<uint32_t>(mDownstreamData) != reportInfo.downstreamData || force) {
@@ -540,11 +559,11 @@ void CruBar::configure(bool force)
   }
 
   /* GBT */
-  if (!std::equal(mLinkMap.begin(), mLinkMap.end(), reportInfo.linkMap.begin()) || force) {
-    //log("Calibrating GBT");
-    //Gbt gbt = Gbt(mPdaBar, mLinkMap, mWrapperCount);
-    //gbt.calibrateGbt({ std::pair<int, Link>(el.first, el.second) });
-
+  if (!mGbtEnabled && ((mGbtEnabled != reportInfo.gbtEnabled) || force)) {
+    // Disable all links
+    datapathWrapper.setLinksEnabled(mEndpoint, 0x0);
+    toggleUserLogicLink(reportInfo.userLogicEnabled); // Make sure the user logic link retains its state
+  } else if (mGbtEnabled && (!std::equal(mLinkMap.begin(), mLinkMap.end(), reportInfo.linkMap.begin()) || force)) {
     /* BSP */
     disableDataTaking();
 
@@ -577,8 +596,15 @@ void CruBar::configure(bool force)
     }
   }
 
+  /* USER LOGIC */
+  if (mUserLogicEnabled != reportInfo.userLogicEnabled || force) {
+    log("Toggling the User Logic link");
+    toggleUserLogicLink(mUserLogicEnabled);
+  }
+
   /* BSP */
   if (mCruId != reportInfo.cruId || force) {
+    log("Setting the CRU ID");
     setCruId(mCruId);
   }
 
@@ -625,7 +651,7 @@ std::map<int, Link> CruBar::initializeLinkMap()
     uint32_t address = Cru::getWrapperBaseAddress(wrapper) + Cru::Registers::GBT_WRAPPER_CONF0.address;
     uint32_t wrapperConfig = readRegister(address / 4);
 
-    for (int bank = mEndpoint * 2; bank < (mEndpoint * 2 + 2); bank++) {
+    for (int bank = mEndpoint * 2; bank < (mEndpoint * 2 + 4); bank++) {
       //for (int bank = 0; bank < 4; bank++) { //for 0-23 range
       // endpoint 0 -> banks {0,1}
       // endpoint 1 -> banks {2,3}
@@ -860,5 +886,20 @@ Cru::OnuStatus CruBar::reportOnuStatus()
   return ttc.onuStatus();
 }
 
+void CruBar::toggleUserLogicLink(bool userLogicEnabled)
+{
+  Link userLogicLink;
+  userLogicLink.dwrapper = mEndpoint;
+  userLogicLink.dwrapperId = 15;
+
+  DatapathWrapper datapathWrapper = DatapathWrapper(mPdaBar);
+  if (userLogicEnabled) {
+    datapathWrapper.setLinkEnabled(userLogicLink);
+  } else {
+    datapathWrapper.setLinkDisabled(userLogicLink);
+  }
+  datapathWrapper.setDatapathMode(userLogicLink, mDatapathMode);
+}
+
 } // namespace roc
 } // namespace AliceO2

src/Cru/CruBar.h

@@ -90,6 +90,8 @@ class CruBar final : public BarInterfaceBase
   void setDebugModeEnabled(bool enabled);
   bool getDebugModeEnabled();
 
+  void toggleUserLogicLink(bool mUserLogicEnabled);
+
   Cru::OnuStatus reportOnuStatus();
   std::map<int, Link> initializeLinkMap();
 
@@ -141,6 +143,8 @@ class CruBar final : public BarInterfaceBase
   uint32_t mOnuAddress;
   bool mDynamicOffset;
   uint32_t mTriggerWindowSize;
+  bool mGbtEnabled;
+  bool mUserLogicEnabled;
 
   int mEndpoint;