[dma] Add a firmware check for the DMA channels

Author: kostorr

include/ReadoutCard/Parameters.h

@@ -122,6 +122,9 @@ class Parameters
   /// Type for the GBT enabled parameter
   using GbtEnabledType = bool;
 
+  /// Type for the GBT enabled parameter
+  using FirmwareCheckEnabledType = bool;
+
   /// Type for the ONU address parameter
   using OnuAddressType = Hex::type;
 
@@ -203,6 +206,14 @@ class Parameters
   /// \return Reference to this object for chaining calls
   auto setGbtEnabled(GbtEnabledType value) -> Parameters&;
 
+  /// Sets the FirmwareCheckEnabled parameter
+  ///
+  /// If enabled the Firmware check is enforced.
+  ///
+  /// \param value The value to set
+  /// \return Reference to this object for chaining calls
+  auto setFirmwareCheckEnabled(FirmwareCheckEnabledType value) -> Parameters&;
+
   /// Sets the UserLogicEnabled parameter
   ///
   /// If enabled the User Logic is used.
@@ -395,6 +406,10 @@ class Parameters
   /// \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 FirmwareCheckEnabled parameter
+  /// \return The value wrapped in an optional if it is present, or an empty optional if it was not
+  auto getFirmwareCheckEnabled() const -> boost::optional<FirmwareCheckEnabledType>;
+
   /// 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>;
@@ -488,6 +503,11 @@ class Parameters
   /// \return The value
   auto getGbtEnabledRequired() const -> GbtEnabledType;
 
+  /// Gets the FirmwareCheckEnabled parameter
+  /// \exception ParameterException The parameter was not present
+  /// \return The value
+  auto getFirmwareCheckEnabledRequired() const -> FirmwareCheckEnabledType;
+
   /// Gets the UserLogicEnabled parameter
   /// \exception ParameterException The parameter was not present
   /// \return The value

src/CommandLineUtilities/ProgramDmaBench.cxx

@@ -201,6 +201,9 @@ class ProgramDmaBench : public Program
     options.add_options()("to-file-bin",
                           po::value<std::string>(&mOptions.fileOutputPathBin),
                           "Read out to given file in binary format (only contains raw data from pages)");
+    options.add_options()("bypass-fw-check",
+                          po::bool_switch(&mOptions.bypassFirmwareCheck),
+                          "Flag to bypass the firmware checker");
   }
 
   virtual void run(const po::variables_map& map)
@@ -223,6 +226,7 @@ class ProgramDmaBench : public Program
     auto params = Parameters::makeParameters(cardId, mOptions.dmaChannel);
     params.setDmaPageSize(mOptions.dmaPageSize);
     params.setDataSource(DataSource::fromString(mOptions.dataSourceString));
+    params.setFirmwareCheckEnabled(!mOptions.bypassFirmwareCheck);
 
     mDataSource = params.getDataSourceRequired();
 
@@ -1105,6 +1109,7 @@ class ProgramDmaBench : public Program
     size_t maxRdhPacketCounter;
     bool stbrd = false;
     bool byteCountEnabled = false;
+    bool bypassFirmwareCheck = false;
   } mOptions;
 
   /// The DMA channel

src/DmaChannelBase.cxx

@@ -20,6 +20,7 @@
 //#include "ChannelPaths.h"
 #include "Common/System.h"
 #include "Pda/Util.h"
+#include "ReadoutCard/FirmwareChecker.h"
 #include "Utilities/SmartPointer.h"
 #include "Visitor.h"
 
@@ -59,6 +60,13 @@ DmaChannelBase::DmaChannelBase(CardDescriptor cardDescriptor, Parameters& parame
   // Check the channel number is allowed
   checkChannelNumber(allowedChannels);
 
+  // Check that the firmware is compatible with the software
+  auto parameters2 = parameters;
+  parameters2.setChannelNumber(2);
+  if (parameters.getFirmwareCheckEnabled().get_value_or(true)) {
+    FirmwareChecker().checkFirmwareCompatibility(parameters2);
+  }
+
   // Do some basic Parameters validity checks
   //checkParameters(parameters);
 

src/Parameters.cxx

@@ -133,6 +133,7 @@ _PARAMETER_FUNCTIONS(LinkLoopbackEnabled, "link_loopback_enabled")
 _PARAMETER_FUNCTIONS(PonUpstreamEnabled, "pon_upstream_enabled")
 _PARAMETER_FUNCTIONS(DynamicOffsetEnabled, "dynamic_offset_enabled")
 _PARAMETER_FUNCTIONS(GbtEnabled, "gbt_enabled")
+_PARAMETER_FUNCTIONS(FirmwareCheckEnabled, "firmware_check_enabled")
 _PARAMETER_FUNCTIONS(UserLogicEnabled, "user_logic_enabled")
 _PARAMETER_FUNCTIONS(OnuAddress, "onu_address")
 _PARAMETER_FUNCTIONS(StbrdEnabled, "stbrd_enabled")