[parameters] Rename 'LoopbackMode' to 'DataSource'

Author: kostorr

CMakeLists.txt

@@ -104,7 +104,7 @@ add_library(ReadoutCard SHARED
   src/ParameterTypes/GbtMode.cxx
   src/ParameterTypes/GbtMux.cxx
   src/ParameterTypes/Hex.cxx
-  src/ParameterTypes/LoopbackMode.cxx
+  src/ParameterTypes/DataSource.cxx
   src/ParameterTypes/PciAddress.cxx
   src/ParameterTypes/PciSequenceNumber.cxx
   src/ParameterTypes/ResetLevel.cxx

README.md

@@ -107,19 +107,19 @@ DMA can be paused and resumed at any time using `stopDma()` and `startDma()`
 
 #### CRU
 
-The loopback parameter for the CRU DMA Channel should be used as follows:
+The `Data Source` parameter for the CRU DMA Channel should be used as follows:
 
-| `GeneratorLoopback` | Data Source |
+| `DataSource`        | Data Source |
 | ------------------- | ----------- |
-| `None`              | FEE (GBT)   |
+| `Fee`               | FEE (GBT)   |
 | `Ddg`               | DDG (GBT)   |
 | `Internal`          | DG          |
 
 #### CRORC
 
-| `GeneratorLoopback` | Data Source |
+| `DataSource`        | Data Source |
 | ------------------- | ----------- |
-| `None`              | FEE (GBT)   |
+| `Fee`               | FEE (GBT)   |
 | `SIU`               | SIU         |
 | `DIU`               | DIU         |
 | `INTERNAL`          | DG          |

include/ReadoutCard/ParameterTypes/DataSource.h

@@ -0,0 +1,51 @@
+// 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 DataSource.h
+/// \brief Definition of the DataSource enum and supporting functions.
+///
+/// \author Pascal Boeschoten ([email protected])
+/// \author Kostas Alexopoulos ([email protected])
+
+#ifndef ALICEO2_INCLUDE_READOUTCARD_DATASOURCE_H_
+#define ALICEO2_INCLUDE_READOUTCARD_DATASOURCE_H_
+
+#include <string>
+
+namespace AliceO2
+{
+namespace roc
+{
+
+/// Namespace for the ReadoutCard data source enum, and supporting functions
+struct DataSource {
+  /// Data Source
+  enum type {
+    Fee = 0,      ///< FEE (CRU & CRORC)
+    Diu = 1,      ///< DIU (CRORC)
+    Siu = 2,      ///< SIU (CRORC)
+    Internal = 3, ///< DG  (CRU & CRORC)
+    Ddg = 4,      ///< DDG (CRU)
+  };
+
+  /// Converts a DataSource to a string
+  static std::string toString(const DataSource::type& mode);
+
+  /// Converts a string to a DataSource
+  static DataSource::type fromString(const std::string& string);
+
+  /// Returns true if the data source is external (FEE, DIU, SIU)
+  static bool isExternal(const DataSource::type& mode);
+};
+
+} // namespace roc
+} // namespace AliceO2
+
+#endif // ALICEO2_INCLUDE_READOUTCARD_DATASOURCE_H_

include/ReadoutCard/ParameterTypes/LoopbackMode.h

@@ -23,7 +23,7 @@
 #include <boost/optional.hpp>
 #include <boost/variant.hpp>
 #include "ReadoutCard/ParameterTypes/BufferParameters.h"
-#include "ReadoutCard/ParameterTypes/LoopbackMode.h"
+#include "ReadoutCard/ParameterTypes/DataSource.h"
 #include "ReadoutCard/ParameterTypes/PciAddress.h"
 #include "ReadoutCard/ParameterTypes/PciSequenceNumber.h"
 #include "ReadoutCard/ParameterTypes/Hex.h"
@@ -73,8 +73,8 @@ class Parameters
   /// Type for the DMA page size parameter
   using DmaPageSizeType = size_t;
 
-  /// Type for the LoopbackMode parameter
-  using GeneratorLoopbackType = LoopbackMode::type;
+  /// Type for the DataSource parameter
+  using DataSourceType = DataSource::type;
 
   /// Type for the link mask parameter
   using LinkMaskType = std::set<uint32_t>;
@@ -177,18 +177,18 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setOnuAddress(OnuAddressType value) -> Parameters&;
 
-  /// Sets the GeneratorLoopback parameter
+  /// Sets the DataSource parameter
   ///
   /// Controls the routing of the generated data.
-  /// Supported loopback modes:
+  /// Supported data source modes:
   /// * C-RORC: all modes
-  /// * CRU: internal, none (=external)
+  /// * CRU: internal, fee
   ///
   /// If not set, the driver will default to internal loopback.
   ///
   /// \param value The value to set
   /// \return Reference to this object for chaining calls
-  auto setGeneratorLoopback(GeneratorLoopbackType value) -> Parameters&;
+  auto setDataSource(DataSourceType value) -> Parameters&;
 
   /// Sets the BufferParameters parameter
   ///
@@ -336,7 +336,7 @@ class Parameters
   auto getOnuAddress() const -> boost::optional<OnuAddressType>;
 
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
-  auto getGeneratorLoopback() const -> boost::optional<GeneratorLoopbackType>;
+  auto getDataSource() const -> boost::optional<DataSourceType>;
 
   /// Gets the BufferParameters parameter
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
@@ -411,10 +411,10 @@ class Parameters
   /// \return The value
   auto getOnuAddressRequired() const -> OnuAddressType;
 
-  /// Gets the GeneratorLoopback parameter
+  /// Gets the DataSource parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value
-  auto getGeneratorLoopbackRequired() const -> GeneratorLoopbackType;
+  auto getDataSourceRequired() const -> DataSourceType;
 
   /// Gets the BufferParameters parameter
   /// \exception ParameterException The parameter was not present

include/ReadoutCard/Parameters.h

@@ -141,6 +141,9 @@ class ProgramDmaBench : public Program
                           SuffixOption<size_t>::make(&mBufferSize)->default_value("1Gi"),
                           "Buffer size in bytes. Rounded down to 2 MiB multiple. Minimum of 2 MiB. Use 2 MiB hugepage by default; |"
                           "if buffer size is a multiple of 1 GiB, will try to use GiB hugepages");
+    options.add_options()("data-source",
+                          po::value<std::string>(&mOptions.dataSourceString)->default_value("INTERNAL"),
+                          "Data source [FEE, INTERNAL, DIU, SIU, DDG]");
     options.add_options()("dma-channel",
                           po::value<int>(&mOptions.dmaChannel)->default_value(0),
                           "DMA channel selection (note: C-RORC has channels 0 to 5, CRU only 0)");
@@ -154,9 +157,6 @@ class ProgramDmaBench : public Program
     options.add_options()("links",
                           po::value<std::string>(&mOptions.links)->default_value("0"),
                           "Links to open. A comma separated list of integers or ranges, e.g. '0,2,5-10'");
-    options.add_options()("loopback",
-                          po::value<std::string>(&mOptions.loopbackModeString)->default_value("INTERNAL"),
-                          "Generator loopback mode [NONE, INTERNAL, DIU, SIU, DDG]");
     options.add_options()("max-rdh-packetcount",
                           po::value<size_t>(&mOptions.maxRdhPacketCounter)->default_value(255),
                           "Maximum packet counter expected in the RDH");
@@ -224,9 +224,9 @@ class ProgramDmaBench : public Program
     auto cardId = Options::getOptionCardId(map);
     auto params = Parameters::makeParameters(cardId, mOptions.dmaChannel);
     params.setDmaPageSize(mOptions.dmaPageSize);
-    params.setGeneratorLoopback(LoopbackMode::fromString(mOptions.loopbackModeString));
+    params.setDataSource(DataSource::fromString(mOptions.dataSourceString));
 
-    mLoopback = params.getGeneratorLoopbackRequired();
+    mDataSource = params.getDataSourceRequired();
 
     params.setStbrdEnabled(mOptions.stbrd); //Set STBRD for the CRORC
 
@@ -516,7 +516,7 @@ class ProgramDmaBench : public Program
             auto readoutCount = fetchAddDmaPagesReadOut();
             size_t pageSize = readoutPage(pageAddress, readoutCount);
 
-            if (mOptions.byteCountEnabled && !(mOptions.loopbackModeString == "INTERNAL")) {
+            if (mOptions.byteCountEnabled && !(mOptions.dataSourceString == "INTERNAL")) {
               mByteCount.fetch_add(pageSize, std::memory_order_relaxed);
             }
             readoutBytes += pageSize;
@@ -557,7 +557,7 @@ class ProgramDmaBench : public Program
       for (int i = 0; i < size; ++i) {
         auto superpage = mChannel->popSuperpage();
         fetchAddSuperpagesReadOut();
-        if ((mLoopback == LoopbackMode::None) || (mLoopback == LoopbackMode::Ddg)) {
+        if ((mDataSource == DataSource::Fee) || (mDataSource == DataSource::Ddg)) {
           auto superpageAddress = mBufferBaseAddress + superpage.getOffset();
           size_t readoutBytes = 0;
           while ((readoutBytes < superpage.getReceived()) && !isSigInt()) { // At least one more dma page fits in the superpage
@@ -586,7 +586,7 @@ class ProgramDmaBench : public Program
 
   size_t readoutPage(uintptr_t pageAddress, int64_t readoutCount)
   {
-    size_t pageSize = (mLoopback == LoopbackMode::Internal) ? mPageSize : DataFormat::getOffset(reinterpret_cast<const char*>(pageAddress));
+    size_t pageSize = (mDataSource == DataSource::Internal) ? mPageSize : DataFormat::getOffset(reinterpret_cast<const char*>(pageAddress));
 
     // Read out to file
     printToFile(pageAddress, pageSize, readoutCount);
@@ -596,7 +596,7 @@ class ProgramDmaBench : public Program
 
       // Get link ID if needed
       uint32_t linkId = 0; // Use 0 for non-CRU cards
-      if (mCardType == CardType::Cru && mLoopback != LoopbackMode::Internal) {
+      if (mCardType == CardType::Cru && mDataSource != DataSource::Internal) {
         linkId = DataFormat::getLinkId(reinterpret_cast<const char*>(pageAddress));
         if (linkId >= mDataGeneratorCounters.size()) {
           BOOST_THROW_EXCEPTION(Exception()
@@ -635,12 +635,12 @@ class ProgramDmaBench : public Program
 
   bool checkErrorsCru(uintptr_t pageAddress, size_t pageSize, int64_t eventNumber, int linkId)
   {
-    if (mLoopback == LoopbackMode::Ddg) {
+    if (mDataSource == DataSource::Ddg) {
       return checkErrorsCruDdg(pageAddress, pageSize, eventNumber, linkId);
-    } else if (mLoopback == LoopbackMode::Internal) {
+    } else if (mDataSource == DataSource::Internal) {
       return checkErrorsCruInternal(pageAddress, pageSize, eventNumber, linkId);
     } else {
-      BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message("CRU error check: Loopback Mode " + LoopbackMode::toString(mLoopback) + " not supported"));
+      BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message("CRU error check: Data Source " + DataSource::toString(mDataSource) + " not supported"));
     }
   }
 
@@ -1078,7 +1078,7 @@ class ProgramDmaBench : public Program
     std::string links;
     bool bufferFullCheck = false;
     size_t dmaPageSize;
-    std::string loopbackModeString;
+    std::string dataSourceString;
     std::string timeLimitString;
     uint64_t pausePush;
     uint64_t pauseRead;
@@ -1187,8 +1187,8 @@ class ProgramDmaBench : public Program
   /// Flag to test how quickly the readout buffer gets full in case of error
   bool mBufferFullCheck;
 
-  /// Loopback mode
-  LoopbackMode::type mLoopback;
+  /// Data Source
+  DataSource::type mDataSource;
 };
 
 int main(int argc, char** argv)