Add STBRD trigger command for the CRORC

Author: kostorr

include/ReadoutCard/Parameters.h

@@ -87,14 +87,27 @@ class Parameters
     /// Type for the gbt mux map parameter
     using GbtMuxMapType = std::map<uint32_t, GbtMux::type>;
 
+    /// Type for the clock parameter
     using ClockType = Clock::type;
+
+    /// Type for the datapath mode parameter
     using DatapathModeType = DatapathMode::type;
+
+    /// Type for the downstream data parameter
     using DownstreamDataType = DownstreamData::type;
+
+    /// Type for the gbt mux parameter
     using GbtMuxType = GbtMux::type;
+
+    /// Type for the gbt mode parameter
     using GbtModeType = GbtMode::type;
 
+    /// Type for the link loopback enabled parameter
     using LinkLoopbackEnabledType = bool;
 
+    /// Type for the STBRD enabled parameter
+    using StbrdEnabledType = bool;
+
     // Setters
 
     /// Sets the CardId parameter
@@ -301,6 +314,14 @@ class Parameters
     /// \return Reference to this object for chaining calls 
     auto setGbtMuxMap(GbtMuxMapType value) -> Parameters&;
 
+    /// Sets the StbrdEnabled parameter
+    ///
+    /// If enabled the STBRD command is used to start the CRORC trigger.
+    ///
+    /// \param value The value to set
+    /// \return Reference to this object for chaining calls
+    auto setStbrdEnabled(StbrdEnabledType value) -> Parameters&;
+
 
     // on-throwing getters
 
@@ -376,6 +397,10 @@ class Parameters
     /// \return The value
     auto getGbtMuxMap() const -> boost::optional<GbtMuxMapType>;
 
+    /// 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>;
+
     // Throwing getters
 
     /// Gets the CardId parameter
@@ -468,6 +493,11 @@ class Parameters
     /// \return The value
     auto getGbtMuxMapRequired() const -> GbtMuxMapType;
 
+    /// Gets the StbrdEnabled parameter
+    /// \exception ParameterException The parameter was not present
+    /// \return The value
+    auto getStbrdEnabledRequired() const -> StbrdEnabledType;
+
     // Helper functions
 
     /// Convenience function to make a Parameters object with card ID and channel number, since these are the most

src/CommandLineUtilities/ProgramDmaBench.cxx

@@ -186,6 +186,9 @@ class ProgramDmaBench: public Program
           ("readout-mode",
               po::value<std::string>(&mOptions.readoutModeString),
               "Set readout mode [CONTINUOUS]")
+          ("stbrd",
+              po::value<bool>(&mOptions.stbrd),
+              "Set the STBRD trigger command for the CRORC")
           ("superpage-size",
               SuffixOption<size_t>::make(&mSuperpageSize)->default_value("1Mi"),
               "Superpage size in bytes. Note that it can't be larger than the buffer. If the IOMMU is not enabled, the "
@@ -225,6 +228,7 @@ class ProgramDmaBench: public Program
       if (!mOptions.generatorEnabled) // if generator is not enabled, force loopbackMode=NONE for proper errorchecking
         mOptions.loopbackModeString = "NONE";
       params.setGeneratorLoopback(LoopbackMode::fromString(mOptions.loopbackModeString));
+      params.setStbrdEnabled(mOptions.stbrd); //Set STBRD for the CRORC
 
       // Handle file output options
       {
@@ -1192,6 +1196,7 @@ class ProgramDmaBench: public Program
         uint64_t pausePush;
         uint64_t pauseRead;
         size_t maxRdhPacketCounter;
+        bool stbrd = false;
     } mOptions;
 
     /// The DMA channel

src/Crorc/Crorc.cxx

@@ -886,10 +886,14 @@ void Crorc::setDiuLoopback(const DiuConfig& diuConfig)
   ddlSetDiuLoopBack(diuConfig);
 }
 
-void Crorc::startTrigger(const DiuConfig& diuConfig)
+void Crorc::startTrigger(const DiuConfig& diuConfig, uint32_t command)
 {
+  if ((command != Fee::RDYRX) && (command != Fee::STBRD)) {
+    BOOST_THROW_EXCEPTION(Exception() <<
+      ErrorInfo::Message("Trigger can only be started with RDYRX or STBRD."));
+  }
   uint64_t timeout = Ddl::RESPONSE_TIME * diuConfig.pciLoopPerUsec;
-  ddlSendCommand(Ddl::Destination::FEE, Fee::RDYRX, 0, 0, timeout);
+  ddlSendCommand(Ddl::Destination::FEE, command, 0, 0, timeout);
   ddlWaitStatus(timeout);
   ddlReadStatus();
 }

src/Crorc/Crorc.h

@@ -92,8 +92,8 @@ class Crorc
     /// Checks if the C-RORC's Free FIFO is empty
     void assertFreeFifoEmpty();
 
-    /// Starts the trigger
-    void startTrigger(const DiuConfig& diuConfig);
+    /// Starts the trigger (RDYRX or STBRD)
+    void startTrigger(const DiuConfig& diuConfig, uint32_t command);
 
     /// Stops the trigger
     void stopTrigger(const DiuConfig& diuConfig);

src/Crorc/CrorcDmaChannel.cxx

@@ -31,7 +31,7 @@ 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
-    mNoRDYRX(false), // Not sure
+    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
@@ -55,6 +55,11 @@ CrorcDmaChannel::CrorcDmaChannel(const Parameters& parameters)
     BOOST_THROW_EXCEPTION(CruException() << ErrorInfo::Message("CRORC does not support given loopback mode")
       << ErrorInfo::LoopbackMode(mLoopbackMode));
   }
+
+  // Set mRDYRX if generator is disabled and mSTBRD is false
+  if (!mGeneratorEnabled) {
+    mRDYRX = mSTBRD ? false : true;
+  }
 
   // Prep for BAR
   auto bar = ChannelFactory().getBar(parameters);
@@ -145,16 +150,18 @@ void CrorcDmaChannel::startPendingDma()
     log("Starting data generator");
     startDataGenerator();
   } else {
-    if (!mNoRDYRX) {
+    if (mRDYRX || mSTBRD) {
       log("Starting trigger");
 
       // Clearing SIU/DIU status.
       getCrorc().assertLinkUp();
       getCrorc().siuCommand(Ddl::RandCIFST);
       getCrorc().diuCommand(Ddl::RandCIFST);
 
+      uint32_t command = (mRDYRX) ? Fee::RDYRX : Fee::STBRD;
+
       // RDYRX command to FEE
-      getCrorc().startTrigger(mDiuConfig);
+      getCrorc().startTrigger(mDiuConfig, command);
     }
   }
 
@@ -169,7 +176,7 @@ void CrorcDmaChannel::deviceStopDma()
   if (mGeneratorEnabled) {
     getCrorc().stopDataGenerator();
   } else {
-    if (!mNoRDYRX) {
+    if (mRDYRX || mSTBRD) {
       // Sending EOBTR to FEE.
       getCrorc().stopTrigger(mDiuConfig);
     }

src/Crorc/CrorcDmaChannel.h

@@ -171,9 +171,11 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
     /// Reset level on initialization of channel
     const ResetLevel::type mInitialResetLevel;
 
-    /// Prevents sending the RDYRX and EOBTR commands. TODO This switch is implicitly set when data generator or the
-    /// STBRD command is used (???)
-    const bool mNoRDYRX;
+    /// Allows sending the RDYRX and EOBTR commands.
+    bool mRDYRX;
+
+    /// Allows sending the STBRD and EOBTR commands for FEE configuration
+    const bool mSTBRD;
 
     /// Enforces that the data reading is carried out with the Start Block Read (STBRD) command
     /// XXX Not sure if this should be a parameter...

src/Parameters.cxx

@@ -119,6 +119,7 @@ _PARAMETER_FUNCTIONS(GbtMode, "gbt_mode")
 _PARAMETER_FUNCTIONS(GbtMux, "gbt_mux")
 _PARAMETER_FUNCTIONS(GbtMuxMap, "gbt_mux_map")
 _PARAMETER_FUNCTIONS(LinkLoopbackEnabled, "link_loopback_enabled")
+_PARAMETER_FUNCTIONS(StbrdEnabled, "stbrd_enabled")
 #undef _PARAMETER_FUNCTIONS
 
 Parameters::Parameters() : mPimpl(std::make_unique<ParametersPimpl>())