[ul] Introduce tool to control the dummy UL

Author: kostorr

CMakeLists.txt

@@ -225,6 +225,7 @@ list(APPEND EXE_SRCS
   ProgramSiuStatus.cxx
   ProgramStatus.cxx
   ProgramTriggerMonitor.cxx
+  ProgramUserLogic.cxx
 )
 
 list(APPEND EXE_NAMES
@@ -242,6 +243,7 @@ list(APPEND EXE_NAMES
   roc-siu-status
   roc-status
   roc-trig-monitor
+  roc-ul
 )
 
 

src/CommandLineUtilities/ProgramUserLogic.cxx

@@ -0,0 +1,89 @@
+// 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 ProgramUserLogic.cxx
+/// \brief Tool to control and report on the dummy(!) User Logic
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#include <iostream>
+#include "Cru/CruBar.h"
+#include "ReadoutCard/ChannelFactory.h"
+#include "CommandLineUtilities/Options.h"
+#include "CommandLineUtilities/Program.h"
+
+using namespace AliceO2::roc::CommandLineUtilities;
+using namespace AliceO2::roc;
+namespace po = boost::program_options;
+
+class ProgramUserLogic : public Program
+{
+ public:
+  virtual Description getDescription()
+  {
+    return { "User Logic", "Control the dummy User Logic",
+             "roc-ul --id 0042:0 --event-size=128 \n"
+             "roc-ul --id 0042:0 --random-event-size \n"
+             "roc-ul --id 0042:0 --status \n" };
+  }
+
+  virtual void addOptions(boost::program_options::options_description& options)
+  {
+    Options::addOptionCardId(options);
+    options.add_options()("random-event-size",
+                          po::bool_switch(&mOptions.randomEventSize),
+                          "Toggle random event size");
+    options.add_options()("event-size",
+                          po::value<uint32_t>(&mOptions.eventSize)->default_value(100),
+                          "Set the event size (in GBT words = 128bits)");
+    options.add_options()("status",
+                          po::bool_switch(&mOptions.status),
+                          "Print UL status only");
+  }
+
+  virtual void run(const boost::program_options::variables_map& map)
+  {
+
+    auto cardId = Options::getOptionCardId(map);
+    auto card = RocPciDevice(cardId).getCardDescriptor();
+    auto cardType = card.cardType;
+    if (cardType != CardType::type::Cru) {
+      std::cerr << "Unsupported card type, only CRU supported." << std::endl;
+      return;
+    }
+
+    Parameters params = Parameters::makeParameters(cardId, 2);
+    auto bar = ChannelFactory().getBar(params);
+    auto cruBar2 = std::dynamic_pointer_cast<CruBar>(bar);
+    if (mOptions.status) {
+      Cru::UserLogicInfo ulInfo = cruBar2->reportUserLogic();
+      std::cout << "==========================" << std::endl;
+      std::cout << "Event size: " << ulInfo.eventSize << " GBT words" << std::endl;
+      std::cout << "Event size: " << (ulInfo.eventSize * 128) / 1024.0 << "Kb" << std::endl;
+      std::cout << "Event size: " << (ulInfo.eventSize * 128) / (1024.0 * 8) << "KB" << std::endl;
+      std::cout << "Randomized: " << std::boolalpha << ulInfo.random << std::endl;
+      std::cout << "==========================" << std::endl;
+    } else {
+      cruBar2->controlUserLogic(mOptions.eventSize, mOptions.randomEventSize);
+    }
+  }
+
+ private:
+  struct OptionsStruct {
+    uint32_t eventSize;
+    bool randomEventSize;
+    bool status;
+  } mOptions;
+};
+
+int main(int argc, char** argv)
+{
+  return ProgramUserLogic().execute(argc, argv);
+}

src/Cru/Common.h

@@ -174,6 +174,11 @@ struct CtpInfo {
   uint32_t orbitInit;
 };
 
+struct UserLogicInfo {
+  uint32_t eventSize;
+  bool random;
+};
+
 uint32_t getWrapperBaseAddress(int wrapper);
 uint32_t getXcvrRegisterAddress(int wrapper, int bank, int link, int reg = 0);
 void atxcal0(std::shared_ptr<BarInterface> bar, uint32_t baseAddress);

src/Cru/Constants.h

@@ -338,6 +338,11 @@ static constexpr Register SI5345_1(0x00030500);
 static constexpr Register SI5345_2(0x00030600);
 static constexpr Register SI5344(0x00030400);
 
+/// User Logic related addresses
+static constexpr Register USER_LOGIC_RESET(0x00c80000);
+static constexpr Register USER_LOGIC_EVSIZE(0x00c80004);
+static constexpr Register USER_LOGIC_EVSIZE_RAND(0x00c80008);
+
 } // namespace Registers
 } // namespace Cru
 } // namespace roc

src/Cru/CruBar.cxx

@@ -1094,5 +1094,26 @@ boost::optional<std::string> CruBar::getUserLogicVersion()
   return (boost::format("%x") % firmwareHash).str();
 }
 
+void CruBar::controlUserLogic(uint32_t eventSize, bool random)
+{
+  // reset UL
+  writeRegister(Cru::Registers::USER_LOGIC_RESET.index, 0x0);
+
+  // set event size
+  writeRegister(Cru::Registers::USER_LOGIC_EVSIZE.index, eventSize);
+
+  bool randomEventSize = readRegister(Cru::Registers::USER_LOGIC_EVSIZE_RAND.index) == 0x1;
+  if (random != randomEventSize) { // toggle random evsize
+    writeRegister(Cru::Registers::USER_LOGIC_EVSIZE_RAND.index, 0x1);
+  }
+}
+
+Cru::UserLogicInfo CruBar::reportUserLogic()
+{
+  bool randomEventSize = readRegister(Cru::Registers::USER_LOGIC_EVSIZE_RAND.index) == 0x1;
+  uint32_t eventSize = readRegister(Cru::Registers::USER_LOGIC_EVSIZE.index);
+  return { eventSize, randomEventSize };
+}
+
 } // namespace roc
 } // namespace AliceO2

src/Cru/CruBar.h

@@ -98,6 +98,10 @@ class CruBar final : public BarInterfaceBase
 
   Cru::OnuStatus reportOnuStatus();
   Cru::FecStatus reportFecStatus();
+
+  void controlUserLogic(uint32_t eventSize, bool random);
+  Cru::UserLogicInfo reportUserLogic();
+
   std::map<int, Link> initializeLinkMap();
 
   std::shared_ptr<Pda::PdaBar> getPdaBar()

src/Cru/cru_constants_populate.py

@@ -137,7 +137,12 @@
 
 'add_gbt_swt_cmd':'SWT_CMD',
 'add_gbt_swt_mon':'SWT_MON',
-'add_gbt_swt_word_mon':'SWT_WORD_MON'
+'add_gbt_swt_word_mon':'SWT_WORD_MON',
+
+### USER LOGIC ###
+'add_user_logic_reset':'USER_LOGIC_RESET',
+'add_user_logic_eventsize':'USER_LOGIC_EVSIZE',
+'add_user_logic_rand_eventsize_toggle':'USER_LOGIC_EVSIZE_RAND'
 }
 
 # e.g. 'TEMPERATURE':0x00010008