[parameters] Remove the generator enabled param

Author: kostorr

README.md

@@ -105,13 +105,25 @@ DMA can be paused and resumed at any time using `stopDma()` and `startDma()`
 
 ### Data Source
 
-In order to set the data source for the CRU, the generator & loopback parameters for the CRU DMA Channel should now be used as follows:
+#### CRU
+
+The loopback parameter for the CRU DMA Channel should be used as follows:
+
+| `GeneratorLoopback` | Data Source |
+| ------------------- | ----------- |
+| `None`              | FEE (GBT)   |
+| `Ddg`               | DDG (GBT)   |
+| `Internal`          | DG          |
+
+#### CRORC
+
+| `GeneratorLoopback` | Data Source |
+| ------------------- | ----------- |
+| `None`              | FEE (GBT)   |
+| `SIU`               | SIU         |
+| `DIU`               | DIU         |
+| `INTERNAL`          | DG          |
 
-| `GeneratorEnabled` | `GeneratorLoopback` | Data Source |
-| ------------------ | ------------------- | ----------- |
-| `false`            | `None`              | FEE (GBT)   |
-| `true`             | `Ddg`               | DDG (GBT)   |
-| `true`             | `Internal`          | DG          |
 
 Card Configurator
 -------------------

include/ReadoutCard/Parameters.h

@@ -73,18 +73,9 @@ class Parameters
   /// Type for the DMA page size parameter
   using DmaPageSizeType = size_t;
 
-  /// Type for the generator enabled parameter
-  using GeneratorEnabledType = bool;
-
-  /// Type for the generator data size parameter
-  using GeneratorDataSizeType = size_t;
-
   /// Type for the LoopbackMode parameter
   using GeneratorLoopbackType = LoopbackMode::type;
 
-  /// Type for the generator data size parameter
-  using GeneratorRandomSizeEnabledType = bool;
-
   /// Type for the link mask parameter
   using LinkMaskType = std::set<uint32_t>;
 
@@ -164,16 +155,6 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setDmaPageSize(DmaPageSizeType value) -> Parameters&;
 
-  /// Sets the GeneratorEnabled parameter
-  ///
-  /// If enabled, the card will generate data internally.
-  /// The format and content of this data is controlled by the other generator parameters.
-  /// 'None' loopback mode is not allowed in conjunction with the data generator (see setGeneratorLoopback()).
-  ///
-  /// \param value The value to set
-  /// \return Reference to this object for chaining calls
-  auto setGeneratorEnabled(GeneratorEnabledType value) -> Parameters&;
-
   /// Sets the LinkLoopbackEnabled parameter
   ///
   /// If enabled the link is on loopback mode  enabling the use of the DDG.
@@ -196,20 +177,6 @@ class Parameters
   /// \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.
-  ///
-  /// Supported values:
-  /// * C-RORC: multiples of 4 bytes, up to 2097152 bytes.
-  /// * CRU: multiples of 32 bytes, minimum 64 bytes, up to 8 KiB.
-  ///
-  /// If not set, the driver will default to the DMA page size, i.e. the pages will be filled completely.
-  ///
-  /// \param value The value to set
-  /// \return Reference to this object for chaining calls
-  auto setGeneratorDataSize(GeneratorDataSizeType value) -> Parameters&;
-
   /// Sets the GeneratorLoopback parameter
   ///
   /// Controls the routing of the generated data.
@@ -223,16 +190,6 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setGeneratorLoopback(GeneratorLoopbackType value) -> Parameters&;
 
-  /// Sets the GeneratorRandomSizeEnabled parameter.
-  ///
-  /// If enabled, the content of the DMA pages will have a random size.
-  /// * C-RORC: currently unsupported
-  /// * CRU: Size varies between 32 bytes and the DMA page size
-  ///
-  /// \param value The value to set
-  /// \return Reference to this object for chaining calls
-  auto setGeneratorRandomSizeEnabled(GeneratorRandomSizeEnabledType value) -> Parameters&;
-
   /// Sets the BufferParameters parameter
   ///
   /// Registers a memory (with BufferParameters::Memory) or file (with BufferParameters::File) buffer with the
@@ -366,10 +323,6 @@ class Parameters
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
   auto getDmaPageSize() const -> boost::optional<DmaPageSizeType>;
 
-  /// Gets the GeneratorEnabled parameter
-  /// \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 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>;
@@ -382,18 +335,9 @@ class Parameters
   /// \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>;
-
-  /// Gets the GeneratorLoopback parameter
   /// \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>;
 
-  /// Gets the GeneratorRandomSizeEnabled parameter
-  /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
-  auto getGeneratorRandomSizeEnabled() const -> boost::optional<GeneratorRandomSizeEnabledType>;
-
   /// Gets the BufferParameters parameter
   /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
   auto getBufferParameters() const -> boost::optional<BufferParametersType>;
@@ -452,11 +396,6 @@ class Parameters
   /// \return The value
   auto getDmaPageSizeRequired() const -> DmaPageSizeType;
 
-  /// Gets the GeneratorEnabled parameter
-  /// \exception ParameterException The parameter was not present
-  /// \return The value
-  auto getGeneratorEnabledRequired() const -> GeneratorEnabledType;
-
   /// Gets the LinkLoopbackEnabled parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value
@@ -472,21 +411,11 @@ class Parameters
   /// \return The value
   auto getOnuAddressRequired() const -> OnuAddressType;
 
-  /// Gets the GeneratorDataSize parameter
-  /// \exception ParameterException The parameter was not present
-  /// \return The value
-  auto getGeneratorDataSizeRequired() const -> GeneratorDataSizeType;
-
   /// Gets the GeneratorLoopback parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value
   auto getGeneratorLoopbackRequired() const -> GeneratorLoopbackType;
 
-  /// Gets the GeneratorRandomSizeEnabled parameter
-  /// \exception ParameterException The parameter was not present
-  /// \return The value
-  auto getGeneratorRandomSizeEnabledRequired() const -> GeneratorRandomSizeEnabledType;
-
   /// Gets the BufferParameters parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value

src/CommandLineUtilities/ProgramDmaBench.cxx

@@ -150,9 +150,6 @@ class ProgramDmaBench : public Program
     options.add_options()("fast-check",
                           po::bool_switch(&mOptions.fastCheckEnabled),
                           "Enable fast error checking");
-    options.add_options()("generator",
-                          po::value<bool>(&mOptions.generatorEnabled)->default_value(true),
-                          "Enable data generator");
     Options::addOptionCardId(options);
     options.add_options()("links",
                           po::value<std::string>(&mOptions.links)->default_value("0"),
@@ -227,13 +224,9 @@ class ProgramDmaBench : public Program
     auto cardId = Options::getOptionCardId(map);
     auto params = Parameters::makeParameters(cardId, mOptions.dmaChannel);
     params.setDmaPageSize(mOptions.dmaPageSize);
-    params.setGeneratorEnabled(mOptions.generatorEnabled);
-    if (!mOptions.generatorEnabled) { // if generator is not enabled, force loopbackMode=NONE
-      params.setGeneratorLoopback(LoopbackMode::None);
-    } else {
-      params.setGeneratorLoopback(LoopbackMode::fromString(mOptions.loopbackModeString));
-    }
-    mLoopback = params.getGeneratorLoopback().get_value_or(LoopbackMode::None);
+    params.setGeneratorLoopback(LoopbackMode::fromString(mOptions.loopbackModeString));
+
+    mLoopback = params.getGeneratorLoopbackRequired();
 
     params.setStbrdEnabled(mOptions.stbrd); //Set STBRD for the CRORC
 
@@ -1083,7 +1076,6 @@ class ProgramDmaBench : public Program
     std::string fileOutputPathBin;
     std::string fileOutputPathAscii;
     std::string links;
-    bool generatorEnabled = false;
     bool bufferFullCheck = false;
     size_t dmaPageSize;
     std::string loopbackModeString;

src/Crorc/CrorcDmaChannel.cxx

@@ -40,13 +40,12 @@ namespace roc
 {
 
 CrorcDmaChannel::CrorcDmaChannel(const Parameters& parameters)
-  : DmaChannelPdaBase(parameters, allowedChannels()),                                      //
-    mPageSize(parameters.getDmaPageSize().get_value_or(DMA_PAGE_SIZE)),                    // 8 kB default for uniformity with CRU
-    mInitialResetLevel(ResetLevel::Internal),                                              // It's good to reset at least the card channel in general
-    mSTBRD(parameters.getStbrdEnabled().get_value_or(false)),                              //TODO: Set as a parameter
-    mUseFeeAddress(false),                                                                 // Not sure
-    mLoopbackMode(parameters.getGeneratorLoopback().get_value_or(LoopbackMode::Internal)), // Internal loopback by default
-    mGeneratorEnabled(parameters.getGeneratorEnabled().get_value_or(true))                 // Use data generator by default
+  : DmaChannelPdaBase(parameters, allowedChannels()),                                     //
+    mPageSize(parameters.getDmaPageSize().get_value_or(DMA_PAGE_SIZE)),                   // 8 kB default for uniformity with CRU
+    mInitialResetLevel(ResetLevel::Internal),                                             // It's good to reset at least the card channel in general
+    mSTBRD(parameters.getStbrdEnabled().get_value_or(false)),                             //TODO: Set as a parameter
+    mUseFeeAddress(false),                                                                // Not sure
+    mLoopbackMode(parameters.getGeneratorLoopback().get_value_or(LoopbackMode::Internal)) // Internal loopback by default
 {
   // Check that the DMA page is valid
   if (mPageSize != DMA_PAGE_SIZE) {
@@ -60,6 +59,8 @@ CrorcDmaChannel::CrorcDmaChannel(const Parameters& parameters)
                                          << ErrorInfo::LoopbackMode(mLoopbackMode));
   }
 
+  mGeneratorEnabled = (mLoopbackMode == LoopbackMode::None) ? false : true;
+
   // Set mRDYRX if generator is disabled and mSTBRD is false
   if (!mGeneratorEnabled) {
     mRDYRX = mSTBRD ? false : true;

src/Crorc/CrorcDmaChannel.h

@@ -198,7 +198,7 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
   const LoopbackMode::type mLoopbackMode;
 
   /// Enables the data generator
-  const bool mGeneratorEnabled;
+  bool mGeneratorEnabled;
 
   Crorc::Crorc::DiuConfig mDiuConfig;
 };

src/Cru/CruDmaChannel.cxx

@@ -32,7 +32,6 @@ CruDmaChannel::CruDmaChannel(const Parameters& parameters)
   : DmaChannelPdaBase(parameters, allowedChannels()),                                      //
     mInitialResetLevel(ResetLevel::Internal),                                              // It's good to reset at least the card channel in general
     mLoopbackMode(parameters.getGeneratorLoopback().get_value_or(LoopbackMode::Internal)), // DG loopback mode by default
-    mGeneratorEnabled(parameters.getGeneratorEnabled().get_value_or(true)),                // Use data generator by default
     mDmaPageSize(parameters.getDmaPageSize().get_value_or(Cru::DMA_PAGE_SIZE))
 {
 
@@ -86,10 +85,6 @@ CruDmaChannel::CruDmaChannel(const Parameters& parameters)
     }
     log(stream.str());
   }
-
-  std::stringstream stream;
-  stream << "Generator enabled: " << mGeneratorEnabled << " | Loopback mode: " << LoopbackMode::toString(mLoopbackMode);
-  log(stream.str());
 }
 
 auto CruDmaChannel::allowedChannels() -> AllowedChannels
@@ -114,23 +109,12 @@ void CruDmaChannel::deviceStartDma()
 {
   // Set data source
   uint32_t dataSourceSelection = 0x0;
-  if (mGeneratorEnabled) {
-    if (mLoopbackMode == LoopbackMode::Internal) {
-      enableDebugMode();
-      dataSourceSelection = Cru::Registers::DATA_SOURCE_SELECT_INTERNAL;
-    } else if (mLoopbackMode == LoopbackMode::Ddg) {
-      dataSourceSelection = Cru::Registers::DATA_SOURCE_SELECT_GBT;
-    } else {
-      BOOST_THROW_EXCEPTION(CruException()
-                            << ErrorInfo::Message("CRU only support 'Internal' or 'Ddg' for data generator"));
-    }
-  } else {
-    if (mLoopbackMode == LoopbackMode::None) {
-      dataSourceSelection = Cru::Registers::DATA_SOURCE_SELECT_GBT;
-    } else {
-      BOOST_THROW_EXCEPTION(CruException()
-                            << ErrorInfo::Message("CRU only supports 'None' loopback mode when operating without a data generator"));
-    }
+
+  if (mLoopbackMode == LoopbackMode::Internal) {
+    enableDebugMode();
+    dataSourceSelection = Cru::Registers::DATA_SOURCE_SELECT_INTERNAL;
+  } else { // loopback mode == NONE or DDG
+    dataSourceSelection = Cru::Registers::DATA_SOURCE_SELECT_GBT;
   }
 
   if (mFeatures.dataSelection) {
@@ -362,7 +346,7 @@ int32_t CruDmaChannel::getDroppedPackets()
 
 bool CruDmaChannel::injectError()
 {
-  if (mGeneratorEnabled) {
+  if (!mLoopbackMode == LoopbackMode::None) {
     getBar()->dataGeneratorInjectError();
     return true;
   } else {

src/Cru/CruDmaChannel.h

@@ -149,9 +149,6 @@ class CruDmaChannel final : public DmaChannelPdaBase
   /// Gives the type of loopback
   const LoopbackMode::type mLoopbackMode;
 
-  /// Enables the data generator
-  const bool mGeneratorEnabled;
-
   /// Flag to know if we should reset the debug register after we fiddle with it
   bool mDebugRegisterReset = false;
 

src/DmaChannelBase.cxx

@@ -43,21 +43,8 @@ void DmaChannelBase::checkChannelNumber(const AllowedChannels& allowedChannels)
   }
 }
 
-void DmaChannelBase::checkParameters(Parameters& parameters)
+void DmaChannelBase::checkParameters(Parameters& /*parameters*/) //TODO: Possible use case?
 {
-  // Generator enabled is not allowed in conjunction with none loopback mode: default to Internal
-  auto enabled = parameters.getGeneratorEnabled();
-  auto loopback = parameters.getGeneratorLoopback();
-  if (enabled && loopback && (*enabled && (*loopback == LoopbackMode::None))) {
-    log("Generator enabled, defaulting to LoopbackMode = Internal", InfoLogger::InfoLogger::Warning);
-    parameters.setGeneratorLoopback(LoopbackMode::Internal);
-  }
-
-  // Generator disabled. Loopback mode should be set to None
-  if (enabled && loopback && (!*enabled && (*loopback != LoopbackMode::None))) {
-    log("Generator disabled, defaulting to LoopbackMode = None", InfoLogger::InfoLogger::Warning);
-    parameters.setGeneratorLoopback(LoopbackMode::None);
-  }
 }
 
 void DmaChannelBase::freeUnusedChannelBuffer()
@@ -118,7 +105,7 @@ DmaChannelBase::DmaChannelBase(CardDescriptor cardDescriptor, Parameters& parame
   checkChannelNumber(allowedChannels);
 
   // Do some basic Parameters validity checks
-  checkParameters(parameters);
+  //checkParameters(parameters);
 
   //try to acquire lock
   log("Acquiring DMA channel lock", InfoLogger::InfoLogger::Debug);

src/Parameters.cxx

@@ -118,10 +118,7 @@ _PARAMETER_FUNCTIONS(BufferParameters, "buffer_parameters")
 _PARAMETER_FUNCTIONS(CardId, "card_id")
 _PARAMETER_FUNCTIONS(ChannelNumber, "channel_number")
 _PARAMETER_FUNCTIONS(DmaPageSize, "dma_page_size")
-_PARAMETER_FUNCTIONS(GeneratorEnabled, "generator_enabled")
 _PARAMETER_FUNCTIONS(GeneratorLoopback, "generator_loopback")
-_PARAMETER_FUNCTIONS(GeneratorDataSize, "generator_data_size")
-_PARAMETER_FUNCTIONS(GeneratorRandomSizeEnabled, "generator_random_size_enabled")
 _PARAMETER_FUNCTIONS(LinkMask, "link_mask")
 _PARAMETER_FUNCTIONS(AllowRejection, "allow_rejection")
 _PARAMETER_FUNCTIONS(Clock, "clock")

test/TestParameters.cxx

@@ -18,7 +18,6 @@ constexpr auto SERIAL_NUMBER = 1;
 constexpr auto CHANNEL_NUMBER = 2;
 //constexpr auto DMA_BUFFER_SIZE = 3ul;
 constexpr auto DMA_PAGE_SIZE = 4ul;
-constexpr auto GENERATOR_ENABLED = true;
 constexpr auto GENERATOR_LOOPBACK_MODE = LoopbackMode::Internal;
 
 BOOST_AUTO_TEST_CASE(ParametersConstructors)
@@ -33,20 +32,17 @@ BOOST_AUTO_TEST_CASE(ParametersPutGetTest)
 {
   Parameters p = Parameters::makeParameters(SERIAL_NUMBER, CHANNEL_NUMBER)
                    .setDmaPageSize(DMA_PAGE_SIZE)
-                   .setGeneratorEnabled(GENERATOR_ENABLED)
                    .setGeneratorLoopback(GENERATOR_LOOPBACK_MODE)
                    .setBufferParameters(buffer_parameters::File{ "/my/file.shm", 0 });
 
   BOOST_REQUIRE(boost::get<int>(p.getCardId().get()) == SERIAL_NUMBER);
   BOOST_REQUIRE(p.getChannelNumber().get_value_or(0) == CHANNEL_NUMBER);
   BOOST_REQUIRE(p.getDmaPageSize().get_value_or(0) == DMA_PAGE_SIZE);
-  BOOST_REQUIRE(p.getGeneratorEnabled().get_value_or(false) == GENERATOR_ENABLED);
   BOOST_REQUIRE(p.getGeneratorLoopback().get_value_or(LoopbackMode::None) == GENERATOR_LOOPBACK_MODE);
 
   BOOST_REQUIRE(boost::get<int>(p.getCardIdRequired()) == SERIAL_NUMBER);
   BOOST_REQUIRE(p.getChannelNumberRequired() == CHANNEL_NUMBER);
   BOOST_REQUIRE(p.getDmaPageSizeRequired() == DMA_PAGE_SIZE);
-  BOOST_REQUIRE(p.getGeneratorEnabledRequired() == GENERATOR_ENABLED);
   BOOST_REQUIRE(p.getGeneratorLoopbackRequired() == GENERATOR_LOOPBACK_MODE);
 
   BOOST_REQUIRE(boost::get<buffer_parameters::File>(p.getBufferParametersRequired()).path == "/my/file.shm");
@@ -56,7 +52,6 @@ BOOST_AUTO_TEST_CASE(ParametersPutGetTest)
 BOOST_AUTO_TEST_CASE(ParametersThrowTest)
 {
   auto p = Parameters::makeParameters(SERIAL_NUMBER, CHANNEL_NUMBER);
-  BOOST_CHECK_THROW(p.getGeneratorEnabledRequired(), ParameterException);
 }
 
 BOOST_AUTO_TEST_CASE(ParametersLinkMaskFromString)