[roc-loopback] Introduce loopback tool

Author: kostorr

CMakeLists.txt

@@ -24,6 +24,9 @@ add_subdirectory(doc)
 # Add compiler flags for warnings and debug symbols
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -pedantic -Wextra -Werror")
 
+# Increase boost MPL maximum length to accommodate for a longer Parameters variant
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DBOOST_MPL_CFG_NO_PREPROCESSED_HEADERS -DBOOST_MPL_LIMIT_LIST_SIZE=30")
+
 # Set fPIC for all targets
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
@@ -126,8 +129,11 @@ add_library(ReadoutCard SHARED
   src/ParameterTypes/Clock.cxx
   src/ParameterTypes/DatapathMode.cxx
   src/ParameterTypes/DownstreamData.cxx
+  src/ParameterTypes/GbtCounterType.cxx
   src/ParameterTypes/GbtMode.cxx
   src/ParameterTypes/GbtMux.cxx
+  src/ParameterTypes/GbtPatternMode.cxx
+  src/ParameterTypes/GbtStatsMode.cxx
   src/ParameterTypes/Hex.cxx
   src/ParameterTypes/DataSource.cxx
   src/ParameterTypes/PciAddress.cxx
@@ -190,6 +196,7 @@ set(EXE_SRCS
   ProgramFlash.cxx
   ProgramFlashRead.cxx
   ProgramListCards.cxx
+  ProgramLoopback.cxx
   ProgramMetrics.cxx
   ProgramPacketMonitor.cxx
   ProgramPatternPlayer.cxx
@@ -215,6 +222,7 @@ set(EXE_NAMES
   o2-roc-flash
   o2-roc-flash-read
   o2-roc-list-cards
+  o2-roc-loopback
   o2-roc-metrics
   o2-roc-pkt-monitor
   o2-roc-pat-player

include/ReadoutCard/ParameterTypes/GbtCounterType.h

@@ -0,0 +1,44 @@
+// 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 GbtCounterType.h
+/// \brief Definition of the GbtCounterType enum and supporting functions.
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#ifndef O2_READOUTCARD_INCLUDE_CRU_GBTCOUNTERTYPE_H_
+#define O2_READOUTCARD_INCLUDE_CRU_GBTCOUNTERTYPE_H_
+
+#include "ReadoutCard/NamespaceAlias.h"
+#include <string>
+
+namespace o2
+{
+namespace roc
+{
+
+/// Namespace for the ROC GBT counter type enum, and supporting functions
+struct GbtCounterType {
+  enum type {
+    ThirtyBit, // can't have enum identifiers starting with a digit
+    EightBit,
+  };
+
+  /// Converts a GbtCounterType to an int
+  static std::string toString(const GbtCounterType::type& gbtCounterType);
+
+  /// Converts a string to a GbtCounterType
+  static GbtCounterType::type fromString(const std::string& string);
+};
+
+} // namespace roc
+} // namespace o2
+
+#endif // O2_READOUTCARD_INCLUDE_CRU_GBTCOUNTERTYPE_H_

include/ReadoutCard/ParameterTypes/GbtPatternMode.h

@@ -0,0 +1,44 @@
+// 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 GbtPatternMode.h
+/// \brief Definition of the GbtPatternMode enum and supporting functions.
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#ifndef O2_READOUTCARD_INCLUDE_CRU_GBTPATTERNMODE_H_
+#define O2_READOUTCARD_INCLUDE_CRU_GBTPATTERNMODE_H_
+
+#include "ReadoutCard/NamespaceAlias.h"
+#include <string>
+
+namespace o2
+{
+namespace roc
+{
+
+/// Namespace for the ROC GBT pattern mode enum, and supporting functions
+struct GbtPatternMode {
+  enum type {
+    Counter,
+    Static,
+  };
+
+  /// Converts a GbtPatternMode to an int
+  static std::string toString(const GbtPatternMode::type& gbtPatternMode);
+
+  /// Converts a string to a GbtPatternMode
+  static GbtPatternMode::type fromString(const std::string& string);
+};
+
+} // namespace roc
+} // namespace o2
+
+#endif // O2_READOUTCARD_INCLUDE_CRU_GBTPATTERNMODE_H_

include/ReadoutCard/ParameterTypes/GbtStatsMode.h

@@ -0,0 +1,45 @@
+// 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 GbtStatsMode.h
+/// \brief Definition of the GbtStatsMode enum and supporting functions.
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#ifndef O2_READOUTCARD_INCLUDE_CRU_GBTSTATSMODE_H_
+#define O2_READOUTCARD_INCLUDE_CRU_GBTSTATSMODE_H_
+
+#include "ReadoutCard/NamespaceAlias.h"
+#include <string>
+
+namespace o2
+{
+namespace roc
+{
+
+/// Namespace for the ROC GBT stats mode enum, and supporting functions
+struct GbtStatsMode {
+  enum type {
+    Count,
+    Fec,
+    All
+  };
+
+  /// Converts a GbtStatsMode to an int
+  static std::string toString(const GbtStatsMode::type& gbtStatsMode);
+
+  /// Converts a string to a GbtStatsMode
+  static GbtStatsMode::type fromString(const std::string& string);
+};
+
+} // namespace roc
+} // namespace o2
+
+#endif // O2_READOUTCARD_INCLUDE_CRU_GBTSTATSMODE_H_

include/ReadoutCard/Parameters.h

@@ -34,8 +34,11 @@
 #include "ReadoutCard/ParameterTypes/Clock.h"
 #include "ReadoutCard/ParameterTypes/DatapathMode.h"
 #include "ReadoutCard/ParameterTypes/DownstreamData.h"
+#include "ReadoutCard/ParameterTypes/GbtCounterType.h"
 #include "ReadoutCard/ParameterTypes/GbtMode.h"
 #include "ReadoutCard/ParameterTypes/GbtMux.h"
+#include "ReadoutCard/ParameterTypes/GbtPatternMode.h"
+#include "ReadoutCard/ParameterTypes/GbtStatsMode.h"
 
 namespace o2
 {
@@ -102,12 +105,26 @@ class Parameters
   /// Type for the downstream data parameter
   using DownstreamDataType = DownstreamData::type;
 
-  /// Type for the gbt mux parameter
-  using GbtMuxType = GbtMux::type;
+  /// Type for the gbt counter type parameter
+  using GbtCounterTypeType = GbtCounterType::type;
 
   /// Type for the gbt mode parameter
   using GbtModeType = GbtMode::type;
 
+  /// Type for the gbt mux parameter
+  using GbtMuxType = GbtMux::type;
+
+  /// Type for the gbt pattern mode parameter
+  using GbtPatternModeType = GbtPatternMode::type;
+
+  /// Type for the gbt stats mode parameter
+  using GbtStatsModeType = GbtStatsMode::type;
+
+  /// Types for the gbt masks
+  using GbtHighMaskType = uint32_t;
+  using GbtMedMaskType = uint32_t;
+  using GbtLowMaskType = uint32_t;
+
   /// Type for the link loopback enabled parameter
   using LinkLoopbackEnabledType = bool;
 
@@ -362,6 +379,15 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setDownstreamData(DownstreamDataType value) -> Parameters&;
 
+  /// Sets the GbtCounterType Parameter
+  ///
+  /// The GBT Counter Type parameter refers to the counter type used to collect loopback stats
+  /// The GBT Counter Type may be 30 or 8 bit
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setGbtCounterType(GbtCounterTypeType value) -> Parameters&;
+
   /// Sets the GbtMode Parameter
   ///
   /// The GBT Mode parameter refers to the selection of the GBT Mode for the CRU configuration
@@ -388,6 +414,48 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setGbtMuxMap(GbtMuxMapType value) -> Parameters&;
 
+  /// Sets the GbtPatternMode Parameter
+  ///
+  /// The GBT Pattern Mode parameter refers to the pattern mode used to collect loopback stats
+  /// The GBT Pattern Mode may be Counter or Static
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setGbtPatternMode(GbtPatternModeType value) -> Parameters&;
+
+  /// Sets the GbtStatsMode Parameter
+  ///
+  /// The GBT Stats Mode parameter refers to the selection of the GBT Loopback Stats to be reported
+  /// The GBT Stats Mode may be Counter, Fec, or All
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setGbtStatsMode(GbtStatsModeType value) -> Parameters&;
+
+  /// Sets the GbtHighMask Parameter
+  ///
+  /// The GBT High mask parameter is used to report GBT loopback stats
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setGbtHighMask(GbtHighMaskType value) -> Parameters&;
+
+  /// Sets the GbtMedMask Parameter
+  ///
+  /// The GBT Med mask parameter is used to report GBT loopback stats
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setGbtMedMask(GbtMedMaskType value) -> Parameters&;
+
+  /// Sets the GbtLowMask Parameter
+  ///
+  /// The GBT Low mask parameter is used to report GBT loopback stats
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setGbtLowMask(GbtLowMaskType value) -> Parameters&;
+
   /// Sets the StbrdEnabled parameter
   ///
   /// If enabled the STBRD command is used to start the CRORC trigger.
@@ -517,6 +585,10 @@ class Parameters
   /// \return The value
   auto getDownstreamData() const -> boost::optional<DownstreamDataType>;
 
+  /// Gets the GbtCounterType Parameter
+  /// \return The value
+  auto getGbtCounterType() const -> boost::optional<GbtCounterTypeType>;
+
   /// Gets the GbtMode Parameter
   /// \return The value
   auto getGbtMode() const -> boost::optional<GbtModeType>;
@@ -529,6 +601,26 @@ class Parameters
   /// \return The value
   auto getGbtMuxMap() const -> boost::optional<GbtMuxMapType>;
 
+  /// Gets the GbtPatternMode Parameter
+  /// \return The value
+  auto getGbtPatternMode() const -> boost::optional<GbtPatternModeType>;
+
+  /// Gets the GbtStatsMode Parameter
+  /// \return The value
+  auto getGbtStatsMode() const -> boost::optional<GbtStatsModeType>;
+
+  /// Gets the GbtHighMask Parameter
+  /// \return The value
+  auto getGbtHighMask() const -> boost::optional<GbtHighMaskType>;
+
+  /// Gets the GbtMedMask Parameter
+  /// \return The value
+  auto getGbtMedMask() const -> boost::optional<GbtMedMaskType>;
+
+  /// Gets the GbtLowMask Parameter
+  /// \return The value
+  auto getGbtLowMask() const -> boost::optional<GbtLowMaskType>;
+
   /// Gets the StbrdEnabled parameter
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
   auto getStbrdEnabled() const -> boost::optional<StbrdEnabledType>;
@@ -664,6 +756,11 @@ class Parameters
   /// \return The value
   auto getDownstreamDataRequired() const -> DownstreamDataType;
 
+  /// Gets the GbtCounterType Parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getGbtCounterTypeRequired() const -> GbtCounterTypeType;
+
   /// Gets the GbtMode Parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value
@@ -679,6 +776,31 @@ class Parameters
   /// \return The value
   auto getGbtMuxMapRequired() const -> GbtMuxMapType;
 
+  /// Gets the GbtPatternMode Parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getGbtPatternModeRequired() const -> GbtPatternModeType;
+
+  /// Gets the GbtStatsMode Parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getGbtStatsModeRequired() const -> GbtStatsModeType;
+
+  /// Gets the GbtHighMask Parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getGbtHighMaskRequired() const -> GbtHighMaskType;
+
+  /// Gets the GbtMedMask Parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getGbtMedMaskRequired() const -> GbtMedMaskType;
+
+  /// Gets the GbtLowMask Parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getGbtLowMaskRequired() const -> GbtLowMaskType;
+
   /// Gets the StbrdEnabled parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value