Add PON upstream and ONU address CRU config params

Author: kostorr

CMakeLists.txt

@@ -99,6 +99,7 @@ add_library(ReadoutCard SHARED
   src/ExceptionInternal.cxx
   src/MemoryMappedFile.cxx
   src/Parameters.cxx
+  src/ParameterTypes/Address.cxx
   src/ParameterTypes/Clock.cxx
   src/ParameterTypes/DatapathMode.cxx
   src/ParameterTypes/DownstreamData.cxx

README.md

@@ -139,6 +139,10 @@ The Parameters that affect the configuration of the CRU and their possible value
 
 `LinkLoopbackEnabled (true | false)`
 
+`PonUpstreamEnabled (true | false)`
+
+`OnuAddress (0x01234567)`
+
 To set any of the above parameters the usual template can be followed.
 
 ```
@@ -156,10 +160,17 @@ 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 `LinkLoopbackEnabled` it is sufficient to do the following, as it is simply a boolean.
+Note that for `LinkLoopbackEnabled` and `PonUpstreamEnabled` it is sufficient to do the following, as they are simply booleans.
 
 ```
 params.setLinkLoopbackEnabled(true);
+params.setPonUpstreamEnabled(true);
+```
+
+Likewise for `OnuAddress`, passing the hex is enough.
+
+```
+params.setOnuAddress(0x0badcafe)
 ```
 
 ### Configuration File
@@ -175,6 +186,7 @@ datapathmode
 loopback
 gbtmode
 downstreamdata
+ponupstream
 ```
 
 The "per link" parameters are

include/ReadoutCard/ParameterTypes/Address.h

@@ -0,0 +1,37 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/// \file Address.h
+/// \brief Definition of the Address struct
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#ifndef ALICEO2_INCLUDE_READOUTCARD_CRU_ADDRESS_H_
+#define ALICEO2_INCLUDE_READOUTCARD_CRU_ADDRESS_H_
+
+#include <string>
+#include "ReadoutCard/Cru.h"
+
+namespace AliceO2 {
+namespace roc {
+
+//Ugly for consistency reasons
+struct Address
+{
+    using type = uint32_t;
+
+    /// Converts a string to an Address
+    static Address::type fromString(const std::string& string);
+};
+
+} // namespace roc
+} // namespace AliceO2
+
+#endif // ALICEO2_INCLUDE_READOUTCARD_CRU_ADDRESS_H_

include/ReadoutCard/Parameters.h

@@ -28,6 +28,7 @@
 #include "ReadoutCard/ParameterTypes/PciAddress.h"
 #include "ReadoutCard/ParameterTypes/PciSequenceNumber.h"
 #include "ReadoutCard/ParameterTypes/ReadoutMode.h"
+#include "ReadoutCard/ParameterTypes/Address.h"
 
 // CRU Specific
 #include "ReadoutCard/ParameterTypes/Clock.h"
@@ -115,6 +116,12 @@ class Parameters
     /// Type for the link loopback enabled parameter
     using LinkLoopbackEnabledType = bool;
 
+    /// Type for the PON upstream enabled parameter
+    using PonUpstreamEnabledType = bool;
+
+    /// Type for the ONU address parameter
+    using OnuAddressType = Address::type;
+
     /// Type for the STBRD enabled parameter
     using StbrdEnabledType = bool;
 
@@ -176,6 +183,20 @@ class Parameters
     /// \return Reference to this object for chaining calls
     auto setLinkLoopbackEnabled(LinkLoopbackEnabledType value) -> Parameters&;
 
+    /// Sets the PonUpstreamEnabled parameter
+    ///
+    /// If enabled the PON upstream is used.
+    ///
+    /// \param value The value to set
+    /// \return Reference to this object for chaining calls
+    auto setPonUpstreamEnabled(PonUpstreamEnabledType value) -> Parameters&;
+
+    /// Sets the OnuAddress parameter
+    /// 
+    /// \param value The value to set
+    /// \return Reference to this object for chaining calls
+    auto setOnuAddress(OnuAddressType value) -> Parameters&;
+
     /// Sets the GeneratorDataSize parameter
     ///
     /// It controls the size in bytes of the generated data per DMA page.
@@ -351,10 +372,18 @@ class Parameters
     /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
     auto getGeneratorEnabled() const -> boost::optional<GeneratorEnabledType>;
 
-    /// Gets the LinkLoopbacknabled parameter
+    /// Gets the LinkLoopbackEnabled parameter
     /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
     auto getLinkLoopbackEnabled() const -> boost::optional<LinkLoopbackEnabledType>;
 
+    /// Gets the PonUpstreamEnabled parameter
+    /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
+    auto getPonUpstreamEnabled() const -> boost::optional<PonUpstreamEnabledType>;
+
+    /// 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>;
+
     /// Gets the GeneratorDataSize parameter
     /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
     auto getGeneratorDataSize() const -> boost::optional<GeneratorDataSizeType>;
@@ -438,6 +467,16 @@ class Parameters
     /// \return The value
     auto getLinkLoopbackEnabledRequired() const -> LinkLoopbackEnabledType;
 
+    /// Gets the PonUpstreamEnabled parameter
+    /// \exception ParameterException The parameter was not present
+    /// \return The value
+    auto getPonUpstreamEnabledRequired() const -> PonUpstreamEnabledType;
+
+    /// Gets the OnuAddress parameter
+    /// \exception ParameterException The parameter was not present
+    /// \return The value
+    auto getOnuAddressRequired() const -> OnuAddressType;
+
     /// Gets the GeneratorDataSize parameter
     /// \exception ParameterException The parameter was not present
     /// \return The value

roc_example.cfg

@@ -26,6 +26,12 @@ gbtmode=WB
 # [CTP | PATTERN | MIDTRG]
 downstreamdata=MIDTRG
 
+# [true | false]
+ponupstream=false
+
+# [0x0badcafe]
+onuaddress=0x0badcafe
+
 #############################################
 # links
 #############################################

src/CardConfigurator.cxx

@@ -14,7 +14,11 @@ namespace roc {
 CardConfigurator::CardConfigurator(Parameters::CardIdType cardId, std::string pathToConfigFile, bool forceConfigure)
 { 
   auto parameters = Parameters::makeParameters(cardId, 2); //have to make parameters for this case, bar2
-  parseConfigFile(pathToConfigFile, parameters);
+  try {
+    parseConfigFile(pathToConfigFile, parameters);
+  } catch (std::string e) {
+    throw std::runtime_error(e);
+  }
 
   auto bar2 = ChannelFactory().getBar(parameters);
   if (forceConfigure) {
@@ -45,6 +49,8 @@ void CardConfigurator::parseConfigFile(std::string pathToConfigFile, Parameters&
   Clock::type clock = Clock::type::Local;
   DatapathMode::type datapathMode = DatapathMode::type::Packet;
   bool loopback = false;
+  bool ponUpstream = false;
+  uint32_t onuAddress = 0x0;
   GbtMode::type gbtMode = GbtMode::type::Gbt;
   DownstreamData::type downstreamData = DownstreamData::type::Ctp;
 
@@ -97,13 +103,28 @@ void CardConfigurator::parseConfigFile(std::string pathToConfigFile, Parameters&
     } catch(...) {
       throw("Invalid or missing loopback property");
     }
+
+    try {
+      ponUpstream = configFile.getValue<bool>(globalGroup + ".ponupstream");
+    } catch(...) {
+      throw("Invalid or missing ponupstream property");
+    }
+
+    try {
+      parsedString = configFile.getValue<std::string>(globalGroup + ".onuaddress");
+      onuAddress = Address::fromString(parsedString);
+    } catch(...) {
+      throw("Invalid or missing onuAddress property");
+    }
   }
 
-  parameters.setLinkLoopbackEnabled(loopback);
   parameters.setClock(clock);
   parameters.setDatapathMode(datapathMode);
   parameters.setGbtMode(gbtMode);
   parameters.setDownstreamData(downstreamData);
+  parameters.setLinkLoopbackEnabled(loopback);
+  parameters.setPonUpstreamEnabled(ponUpstream);
+  parameters.setOnuAddress(onuAddress);
 
   //* Per link *//
   for (auto configGroup: ConfigFileBrowser(&configFile, "link")) {

src/CommandLineUtilities/ProgramConfig.cxx

@@ -64,6 +64,12 @@ class ProgramConfig: public Program
       ("loopback",
        po::bool_switch(&mOptions.linkLoopbackEnabled),
        "Flag to enable link loopback for DDG")
+      ("pon-upstream",
+       po::bool_switch(&mOptions.ponUpstreamEnabled),
+       "Flag to enable use of the PON upstream")
+      ("onu-address",
+       po::value<uint32_t>(&mOptions.onuAddress)->default_value(0x0),
+       "ONU address for PON upstream")
       ("config-all",
        po::bool_switch(&mOptions.configAll),
        "Flag to configure all cards with default parameters on startup")
@@ -90,7 +96,7 @@ class ProgramConfig: public Program
         std::cout << " __== " << card.pciAddress.toString() << " ==__ " << std::endl;
         auto params = Parameters::makeParameters(card.pciAddress, 2);
         try {
-          auto cardConfigurator = CardConfigurator(card.pciAddress, mOptions.configFile, mOptions.forceConfig);
+          CardConfigurator(card.pciAddress, mOptions.configFile, mOptions.forceConfig);
         } catch(...) {
           std::cout << "Something went badly reading the configuration file..." << std::endl;
         }
@@ -111,12 +117,14 @@ class ProgramConfig: public Program
       params.setGbtMode(GbtMode::fromString(mOptions.gbtMode));
       params.setGbtMux(GbtMux::fromString(mOptions.gbtMux));
       params.setLinkLoopbackEnabled(mOptions.linkLoopbackEnabled);
+      params.setPonUpstreamEnabled(mOptions.ponUpstreamEnabled);
+      params.setOnuAddress(mOptions.onuAddress);
 
-      auto cardConfigurator = CardConfigurator(params, mOptions.forceConfig);
+      CardConfigurator(params, mOptions.forceConfig);
     } else if (!strncmp(mOptions.configFile.c_str(), "file:", 5)) {
       std::cout << "Configuring with config file" << std::endl;
       try {
-        auto cardConfigurator = CardConfigurator(cardId, mOptions.configFile, mOptions.forceConfig);
+        CardConfigurator(cardId, mOptions.configFile, mOptions.forceConfig);
       } catch(std::runtime_error e) {
         std::cout << "Something went badly reading the configuration file..." << e.what() << std::endl;
       }
@@ -139,6 +147,8 @@ class ProgramConfig: public Program
     bool linkLoopbackEnabled = false;
     bool configAll= false;
     bool forceConfig = false;
+    bool ponUpstreamEnabled = false;
+    uint32_t onuAddress = 0x0;
   }mOptions;
 
   private:

src/Cru/CruBar.cxx

@@ -41,7 +41,9 @@ CruBar::CruBar(const Parameters& parameters)
       mGbtMode(parameters.getGbtMode().get_value_or(GbtMode::Gbt)),
       mGbtMux(parameters.getGbtMux().get_value_or(GbtMux::Ttc)),
       mLinkMask(parameters.getLinkMask().get_value_or(std::set<uint32_t>{0})),
-      mGbtMuxMap(parameters.getGbtMuxMap().get_value_or(std::map<uint32_t, GbtMux::type>{}))
+      mGbtMuxMap(parameters.getGbtMuxMap().get_value_or(std::map<uint32_t, GbtMux::type>{})),
+      mPonUpstream(parameters.getPonUpstreamEnabled().get_value_or(false)),
+      mOnuAddress(parameters.getOnuAddress().get_value_or(0x0))
 {
   if (getIndex() == 0) {
     mFeatures = parseFirmwareFeatures(); 
@@ -425,11 +427,15 @@ Cru::ReportInfo CruBar::report()
   // setClock: 2 for Local clock, 0 for TTC clock
   uint32_t clock = (ttc.getPllClock() == 0 ? Clock::Local : Clock::Ttc);
   uint32_t downstreamData = ttc.getDownstreamData();
+  //bool ponUpstream = true; //TODO: ponUpstream currently irrelevant for configuration
+  //uint32_t onuAddress = 0xdeadbeef; //TODO: onuAddress currently irrelevant for configuration
 
   Cru::ReportInfo reportInfo = {
     linkMap,
     clock,
-    downstreamData
+    downstreamData,
+    //ponUpstream
+    //onuAddress
   };
 
   return reportInfo;
@@ -455,9 +461,6 @@ void CruBar::reconfigure()
 /// Configures the CRU according to the parameters passed on init
 void CruBar::configure()
 {
-  bool ponUpstream = false;
-  uint32_t onuAddress = 0xbadcafe;
-  
   if (mLinkMap.empty()) {
     populateLinkMap(mLinkMap);
   }
@@ -476,10 +479,10 @@ void CruBar::configure()
   log("Calibrating TTC");
   ttc.calibrateTtc();
 
-  if (ponUpstream) {
-    //ttc.resetFpll();
-    if(!ttc.configurePonTx(onuAddress)) {
-      BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message("PON TX fPLL phase scan failed."));
+  if (mPonUpstream) {
+    ttc.resetFpll();
+    if(!ttc.configurePonTx(mOnuAddress)) {
+      log("PON TX fPLL phase scan failed", InfoLogger::InfoLogger::Error);
     }
   }
 

src/Cru/CruBar.h

@@ -123,6 +123,8 @@ class CruBar final : public BarInterfaceBase
     std::map<int, Link> mLinkMap;
     std::map<uint32_t, uint32_t> mRegisterMap;
     std::map<uint32_t, GbtMux::type> mGbtMuxMap;
+    bool mPonUpstream;
+    uint32_t mOnuAddress;
 
     /// Checks if this is the correct BAR. Used to check for BAR 2 for special functions.
     void assertBarIndex(int index, std::string message) const

src/ParameterTypes/Address.cxx

@@ -0,0 +1,28 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/// \file Address.cxx
+/// \brief Implementation of the Address struct and supporting functions
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#include "ReadoutCard/ParameterTypes/Address.h"
+#include "Utilities/Enum.h"
+
+namespace AliceO2 {
+namespace roc {
+
+Address::type Address::fromString(const std::string& string)
+{
+  return std::stoul(string, nullptr, 16);
+}
+
+} // namespace roc
+} // namespace AliceO2