Merge pull request #403 from sy-c/master

sy-c · web-flow · commit ad28fe8513c6 · 2023-02-23T12:20:03.000+01:00
v0.41.0
diff --git a/doc/releaseNotes.md b/doc/releaseNotes.md
@@ -24,3 +24,8 @@ This file describes the main feature changes for released versions of ReadoutCar
 
 ## v0.40.2 - 16/02/2023
 - Fixed bug with o2-roc-ctp-emulator failing to parse hexadecimal values of the init-orbit option.
+
+## v0.41.0 - 23/02/2023
+- Added glitchCounter to roc-status (monitoring + JSON output).
+- Added DMA status (enabled / disabled) to roc-status (all output styles, including monitoring).
+- Added FEC counter per link to roc-status (stdout + JSON output).
diff --git a/src/CommandLineUtilities/ProgramStatus.cxx b/src/CommandLineUtilities/ProgramStatus.cxx
@@ -72,7 +72,8 @@ class ProgramStatus : public Program
     std::ostringstream table;
     std::string formatHeader;
     std::string formatRow;
-    std::string header;
+    std::string header1;
+    std::string header2;
     std::string lineFat;
     std::string lineThin;
 
@@ -91,14 +92,15 @@ class ProgramStatus : public Program
     }
 
     if (cardType == CardType::type::Crorc) {
-      formatHeader = "  %-9s %-8s %-19s\n";
-      formatRow = "  %-9s %-8s %-19.1f\n";
-      header = (boost::format(formatHeader) % "Link ID" % "Status" % "Optical power(uW)").str();
-      lineFat = std::string(header.length(), '=') + '\n';
-      lineThin = std::string(header.length(), '-') + '\n';
+      formatHeader = "  %-6s %-8s %-11s\n";
+      formatRow = "  %-6s %-8s %-11.1f\n";
+      header1 = (boost::format(formatHeader) % "Link" % "Status" % "Optical").str();
+      header2 = (boost::format(formatHeader) % "ID"   % ""       % "power (uW)").str();
+      lineFat = std::string(header1.length(), '=') + '\n';
+      lineThin = std::string(header1.length(), '-') + '\n';
 
       if (!mOptions.jsonOut) {
-        table << lineFat << header << lineThin;
+        table << lineFat << header1 << header2 << lineThin;
       }
 
       auto params = Parameters::makeParameters(cardId, 0); //status available on BAR0
@@ -176,19 +178,25 @@ class ProgramStatus : public Program
         }
       }
     } else if (cardType == CardType::type::Cru) {
-      formatHeader = "  %-9s %-16s %-10s %-14s %-15s %-10s %-14s %-14s %-8s %-19s %-11s %-7s\n";
-      formatRow = "  %-9s %-16s %-10s %-14s %-15s %-10s %-14.2f %-14.2f %-8s %-19.1f %-11s %-7s\n";
-      header = (boost::format(formatHeader) % "Link ID" % "GBT Mode Tx/Rx" % "Loopback" % "GBT MUX" % "Datapath Mode" % "Datapath" % "RX freq(MHz)" % "TX freq(MHz)" % "Status" % "Optical power(uW)" % "System ID" % "FEE ID").str();
-      lineFat = std::string(header.length(), '=') + '\n';
-      lineThin = std::string(header.length(), '-') + '\n';
+      if (mOptions.fec) {
+        formatHeader = "  %-6s %-10s %-10s %-14s %-10s %-10s %-8s %-8s %-7s %-7s %-11s %-7s %-7s\n";
+        formatRow = "  %-6s %-10s %-10s %-14s %-10s %-10s %-8.2f %-8.2f %-7s %-7s %-11.1f %-7s %-7s\n";
+      } else {
+        formatHeader = "  %-6s %-10s %-10s %-14s %-10s %-10s %-8s %-8s %-7s%-0s %-11s %-7s %-7s\n";
+        formatRow = "  %-6s %-10s %-10s %-14s %-10s %-10s %-8.2f %-8.2f %-7s%-0s %-11.1f %-7s %-7s\n";
+      }
+      header1 = (boost::format(formatHeader) % "Link" % "GBT Mode" % "Loopback" % "GBT MUX" % "Datapath" % "Datapath" % "RX freq" % "TX freq" % "Status" % (mOptions.fec ? "FEC" : "" ) % "Optical"    % "System" % "FEE").str();
+      header2 = (boost::format(formatHeader) % "ID"   % "Tx/Rx"    % ""         % ""        % "mode"     % "status"   % "(MHz)"   % "(MHz)"   % ""       % ""                           % "power (uW)" % "ID"     % "ID").str();
+      lineFat = std::string(header1.length(), '=') + '\n';
+      lineThin = std::string(header2.length(), '-') + '\n';
 
       auto params = Parameters::makeParameters(cardId, 2); //status available on BAR2
       params.setLinkMask(Parameters::linkMaskFromString(mOptions.links));
       auto bar2 = ChannelFactory().getBar(params);
       auto cruBar2 = std::dynamic_pointer_cast<CruBar>(bar2);
 
       if (!mOptions.jsonOut) {
-        table << lineFat << header << lineThin;
+        table << lineFat << header1 << header2 << lineThin;
       }
 
       Cru::ReportInfo reportInfo = cruBar2->report();
@@ -198,6 +206,7 @@ class ProgramStatus : public Program
       std::string userLogic = (reportInfo.userLogicEnabled ? "Enabled" : "Disabled");
       std::string runStats = (reportInfo.runStatsEnabled ? "Enabled" : "Disabled");
       std::string userAndCommonLogic = (reportInfo.userAndCommonLogicEnabled ? "Enabled" : "Disabled");
+      std::string dmaStatus = reportInfo.dmaStatus ? "Enabled" : "Disabled";
 
       /* GENERAL PARAMETERS */
       if (mOptions.monitoring) {
@@ -210,6 +219,7 @@ class ProgramStatus : public Program
                            .addValue(reportInfo.runStatsEnabled, "runStats")
                            .addValue(reportInfo.userAndCommonLogicEnabled, "userAndCommonLogic")
                            .addValue(reportInfo.timeFrameLength, "timeFrameLength")
+                           .addValue(reportInfo.dmaStatus, "dmaStatus")
                            .addTag(tags::Key::SerialId, card.serialId.getSerial())
                            .addTag(tags::Key::Endpoint, card.serialId.getEndpoint())
                            .addTag(tags::Key::ID, card.sequenceId)
@@ -225,6 +235,7 @@ class ProgramStatus : public Program
         root.put("runStats", runStats);
         root.put("userAndCommonLogic", userAndCommonLogic);
         root.put("timeFrameLength", reportInfo.timeFrameLength);
+        root.put("dmaStatus", dmaStatus);
       } else {
         std::cout << "-----------------------------" << std::endl;
         std::cout << "CRU ID: " << reportInfo.cruId << std::endl;
@@ -239,6 +250,7 @@ class ProgramStatus : public Program
         if (reportInfo.runStatsEnabled) {
           std::cout << "Run statistics enabled" << std::endl;
         }
+         std::cout << "DMA: "<< dmaStatus << std::endl;
       }
 
       /* ONU PARAMETERS */
@@ -379,6 +391,11 @@ class ProgramStatus : public Program
 
         float rxFreq = link.rxFreq;
         float txFreq = link.txFreq;
+        uint32_t glitchCounter = link.glitchCounter;
+        std::string fecCounter;
+        if (mOptions.fec) {
+          fecCounter = Utilities::toHexString(link.fecCounter);
+        }
 
         std::string linkStatus;
         if (link.stickyBit == Cru::LinkStatus::Up) {
@@ -407,6 +424,7 @@ class ProgramStatus : public Program
                              .addValue(opticalPower, "opticalPower")
                              .addValue(systemId, "systemId")
                              .addValue(feeId, "feeId")
+                             .addValue((int)glitchCounter, "glitchCounter")
                              .addTag(tags::Key::SerialId, card.serialId.getSerial())
                              .addTag(tags::Key::Endpoint, card.serialId.getEndpoint())
                              .addTag(tags::Key::CRU, card.sequenceId)
@@ -427,11 +445,15 @@ class ProgramStatus : public Program
           linkNode.put("opticalPower", Utilities::toPreciseString(opticalPower));
           linkNode.put("systemId", systemId);
           linkNode.put("feeId", feeId);
+          linkNode.put("glitchCounter", glitchCounter);
+          if (mOptions.fec) {
+            linkNode.put("fecCounter", fecCounter);
+          }
 
           // add the link node to the tree
           root.add_child(std::to_string(globalId), linkNode);
         } else {
-          auto format = boost::format(formatRow) % globalId % gbtTxRxMode % loopback % gbtMux % datapathMode % enabled % rxFreq % txFreq % linkStatus % opticalPower % systemId % feeId;
+          auto format = boost::format(formatRow) % globalId % gbtTxRxMode % loopback % gbtMux % datapathMode % enabled % rxFreq % txFreq % linkStatus % fecCounter % opticalPower % systemId % feeId;
           table << format;
         }
       }
@@ -443,7 +465,7 @@ class ProgramStatus : public Program
     if (mOptions.jsonOut) {
       pt::write_json(std::cout, root);
     } else if (!mOptions.monitoring) {
-      auto lineFat = std::string(header.length(), '=') + '\n';
+      auto lineFat = std::string(header1.length(), '=') + '\n';
       table << lineFat;
       std::cout << table.str();
     }
diff --git a/src/Cru/Common.h b/src/Cru/Common.h
@@ -71,6 +71,8 @@ struct Link {
   uint32_t feeId = 0x0;
   /*uint32_t systemId = 0x1ff; // invalid, used as "unset" placeholder
   uint32_t feeId = 0x1f; // invalid, used as "unset" placeholder*/
+  uint32_t glitchCounter = 0;
+  uint32_t fecCounter = 0;
 
   bool operator==(const Link& dlink) const
   {
@@ -115,6 +117,7 @@ struct ReportInfo {
   bool runStatsEnabled;
   bool userAndCommonLogicEnabled;
   uint16_t timeFrameLength;
+  bool dmaStatus;
 };
 
 struct OnuStickyStatus {
diff --git a/src/Cru/Constants.h b/src/Cru/Constants.h
@@ -254,6 +254,12 @@ static constexpr Register GBT_LINK_CLEAR_ERRORS(0x00000038);
 static constexpr Register GBT_LINK_RX_CLOCK(0x00000008);
 static constexpr Register GBT_LINK_TX_CLOCK(0x00000004);
 
+/// Register for getting the glitch counter
+static constexpr Register GBT_LINK_GLITCH_COUNTER(0x00000044);
+
+/// Register for getting the FEC counter
+static constexpr Register GBT_LINK_FEC_COUNTER(0x0000001C);
+
 /// Register for selecting the the GBT Multiplexer
 static constexpr Register GBT_MUX_SELECT(0x0000001c);
 /*static constexpr uint32_t GBT_MUX_TTC(0x0);
diff --git a/src/Cru/CruBar.cxx b/src/Cru/CruBar.cxx
@@ -406,6 +406,12 @@ uint32_t CruBar::getPonStatusRegister()
   return readRegister((Cru::Registers::ONU_USER_LOGIC.address + 0x0c) / 4);
 }
 
+bool CruBar::getDmaStatus()
+{
+  mPdaBar->assertBarIndex(2, "Can only get DMA status register from BAR 2");
+  return readRegister(Cru::Registers::BSP_USER_CONTROL.index) & 0x1; // DMA enabled = bit 0
+}
+
 uint32_t CruBar::getOnuAddress()
 {
   mPdaBar->assertBarIndex(2, "Can only get PON status register from BAR 2");
@@ -503,6 +509,8 @@ Cru::ReportInfo CruBar::report(bool forConfig)
     link.stickyBit = gbt.getStickyBit(link);
     link.rxFreq = gbt.getRxClockFrequency(link) / 1e6; // Hz -> Mhz
     link.txFreq = gbt.getTxClockFrequency(link) / 1e6; // Hz -> Mhz
+    link.glitchCounter = gbt.getGlitchCounter(link);
+    link.fecCounter = gbt.getFecCounter(link);
     link.systemId = datapathWrapper.getSystemId(link);
     link.feeId = datapathWrapper.getFeeId(link);
 
@@ -544,6 +552,8 @@ Cru::ReportInfo CruBar::report(bool forConfig)
   bool userAndCommonLogicEnabled = datapathWrapper.getUserAndCommonLogicEnabled(mEndpoint);
   uint16_t timeFrameLength = getTimeFrameLength();
 
+  bool dmaStatus = getDmaStatus();
+
   Cru::ReportInfo reportInfo = {
     linkMap,
     clock,
@@ -557,7 +567,8 @@ Cru::ReportInfo CruBar::report(bool forConfig)
     userLogicEnabled,
     runStatsEnabled,
     userAndCommonLogicEnabled,
-    timeFrameLength
+    timeFrameLength,
+    dmaStatus
   };
 
   return reportInfo;
diff --git a/src/Cru/CruBar.h b/src/Cru/CruBar.h
@@ -135,6 +135,7 @@ class CruBar final : public BarInterfaceBase
   uint32_t getFpgaChipLow();
   uint32_t getPonStatusRegister();
   uint32_t getOnuAddress();
+  bool getDmaStatus();
   bool checkPonUpstreamStatusExpected(uint32_t ponUpstreamRegister, uint32_t onuAddress);
   bool checkClockConsistent(std::map<int, Link> linkMap);
   void populateLinkMap(std::map<int, Link>& linkMap);
diff --git a/src/Cru/Gbt.cxx b/src/Cru/Gbt.cxx
@@ -315,6 +315,28 @@ uint32_t Gbt::getTxClockFrequency(Link link) //In Hz
   return mPdaBar->readRegister(address / 4);
 }
 
+uint32_t Gbt::getGlitchCounter(Link link)
+{
+  uint32_t address = Cru::getWrapperBaseAddress(link.wrapper) +
+                     Cru::Registers::GBT_WRAPPER_BANK_OFFSET.address * (link.bank + 1) +
+                     Cru::Registers::GBT_BANK_LINK_OFFSET.address * (link.id + 1) +
+                     Cru::Registers::GBT_LINK_REGS_OFFSET.address +
+                     Cru::Registers::GBT_LINK_GLITCH_COUNTER.address;
+
+  return mPdaBar->readRegister(address / 4);
+}
+
+uint32_t Gbt::getFecCounter(Link link)
+{
+  uint32_t address = Cru::getWrapperBaseAddress(link.wrapper) +
+                     Cru::Registers::GBT_WRAPPER_BANK_OFFSET.address * (link.bank + 1) +
+                     Cru::Registers::GBT_BANK_LINK_OFFSET.address * (link.id + 1) +
+                     Cru::Registers::GBT_LINK_REGS_OFFSET.address +
+                     Cru::Registers::GBT_LINK_FEC_COUNTER.address;
+
+  return mPdaBar->readRegister(address / 4);
+}
+
 void Gbt::resetFifo()
 {
   mPdaBar->modifyRegister(Cru::Registers::BSP_USER_CONTROL.index, 7, 1, 0x1); // reset TX
diff --git a/src/Cru/Gbt.h b/src/Cru/Gbt.h
@@ -51,6 +51,8 @@ class Gbt
   LinkStatus getStickyBit(Link link);
   uint32_t getRxClockFrequency(Link link);
   uint32_t getTxClockFrequency(Link link);
+  uint32_t getGlitchCounter(Link link);
+  uint32_t getFecCounter(Link link);
   void resetFifo();
   std::map<int, LoopbackStats> getLoopbackStats(bool reset, GbtPatternMode::type patternMode = GbtPatternMode::type::Counter,
                                                 GbtCounterType::type counterType = GbtCounterType::type::ThirtyBit,
diff --git a/src/FirmwareChecker.cxx b/src/FirmwareChecker.cxx
@@ -30,6 +30,8 @@ FirmwareChecker::FirmwareChecker() : mCompatibleFirmwareList({
                                        { "2058c933", "v3.14.0" },
                                        { "4a412c71", "v3.13.0" },
                                        { "82b4662d", "MFT PSU" },
+                                       { "6838510f", "v3.17.0" },
+                                       { "8e74a7f8", "v3.17.1" },
                                        /*{ "6a85d30c", "v3.12.0" },
                                        { "7be5aa1c", "v3.11.0" },
                                        { "e4a5a46e", "v3.10.0" },
@@ -45,6 +47,8 @@ FirmwareChecker::FirmwareChecker() : mCompatibleFirmwareList({
                                        { "267f8e5", "v2.9.1" },
                                        { "cecc295", "v2.9.0" },
                                        { "221ff280", "v2.10.0" },
+                                       { "cfa0bc9c", "2.10.1" },
+                                       { "2d4c9028", "2.11.0" },
                                        /*{ "59e9955", "v2.8.1" },
                                        { "f086417", "v2.8.0" },
                                        { "474f9e1", "v2.7.0" }
diff --git a/src/ReadoutCardVersion.cxx b/src/ReadoutCardVersion.cxx
@@ -11,7 +11,7 @@
 
 #include "ReadoutCard/Version.h"
 
-#define O2_READOUTCARD_VERSION "0.40.2"
+#define O2_READOUTCARD_VERSION "0.41.0"
 
 namespace o2
 {

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`#include "ReadoutCard/Version.h"`
`13`	`13`
`14`		`-#define O2_READOUTCARD_VERSION "0.40.2"`
	`14`	`+#define O2_READOUTCARD_VERSION "0.41.0"`
`15`	`15`
`16`	`16`	`namespace o2`
`17`	`17`	`{`