[fw-check | roc-list-cards] Publish firmware checker & print fw tag in roc-list-cards

Author: kostorr

CMakeLists.txt

@@ -96,6 +96,7 @@ add_library(ReadoutCard SHARED
   src/Dummy/DummyDmaChannel.cxx
   src/Dummy/DummyBar.cxx
   src/ExceptionInternal.cxx
+  src/FirmwareChecker.cxx
   src/MemoryMappedFile.cxx
   src/Parameters.cxx
   src/ParameterTypes/Clock.cxx

include/ReadoutCard/FirmwareChecker.h

@@ -0,0 +1,47 @@
+// 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 FirmwareChecker.h
+/// \brief Helper functions to check a card's firmware compatibilty
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#ifndef ALICEO2_INCLUDE_READOUTCARD_FIRMWARECHECKER_H_
+#define ALICEO2_INCLUDE_READOUTCARD_FIRMWARECHECKER_H_
+
+#include "unordered_map"
+#include "ReadoutCard/ChannelFactory.h"
+#include "ReadoutCard/Parameters.h"
+
+namespace AliceO2
+{
+namespace roc
+{
+
+class FirmwareChecker
+{
+ public:
+  FirmwareChecker();
+  ~FirmwareChecker();
+
+  std::string resolveFirmwareTag(std::string firmware);
+  void checkFirmwareCompatibility(Parameters params);
+  void checkFirmwareCompatibility(Parameters::CardIdType cardId);
+
+ private:
+  void checkFirmwareCompatibilityWrapped(std::shared_ptr<BarInterface> bar2);
+  std::string getFirmwareCompatibilityList();
+  std::unordered_map<std::string, std::string> mCompatibleFirmwareList;
+};
+
+} // namespace roc
+} // namespace AliceO2
+
+#endif // ALICEO2_INCLUDE_READOUTCARD_FIRMWARECHECKER_H_

src/CommandLineUtilities/ProgramConfig.cxx

@@ -17,10 +17,10 @@
 #include "CommandLineUtilities/Options.h"
 #include "CommandLineUtilities/Program.h"
 #include "Cru/CruBar.h"
-#include "FirmwareChecker.h"
 #include "ReadoutCard/CardConfigurator.h"
 #include "ReadoutCard/ChannelFactory.h"
 #include "ReadoutCard/Exception.h"
+#include "ReadoutCard/FirmwareChecker.h"
 #include "RocPciDevice.h"
 
 using namespace AliceO2::roc::CommandLineUtilities;
@@ -106,7 +106,7 @@ class ProgramConfig : public Program
         auto params = Parameters::makeParameters(card.pciAddress, 2);
         if (!mOptions.bypassFirmwareCheck) {
           try {
-            checkFirmwareCompatibility(params);
+            FirmwareChecker().checkFirmwareCompatibility(params);
             CardConfigurator(card.pciAddress, mOptions.configFile, mOptions.forceConfig);
           } catch (const Exception& e) {
             std::cout << boost::diagnostic_information(e) << std::endl;
@@ -120,7 +120,7 @@ class ProgramConfig : public Program
     auto cardId = Options::getOptionCardId(map);
     if (!mOptions.bypassFirmwareCheck) {
       try {
-        checkFirmwareCompatibility(cardId);
+        FirmwareChecker().checkFirmwareCompatibility(cardId);
       } catch (const Exception& e) {
         std::cout << boost::diagnostic_information(e) << std::endl;
         return;

src/CommandLineUtilities/ProgramListCards.cxx

@@ -20,6 +20,7 @@
 #include "CommandLineUtilities/Program.h"
 #include "RocPciDevice.h"
 #include "ReadoutCard/ChannelFactory.h"
+#include "ReadoutCard/FirmwareChecker.h"
 #include "ReadoutCard/MemoryMappedFile.h"
 #include <boost/format.hpp>
 
@@ -69,6 +70,8 @@ class ProgramListCards : public Program
         Parameters params2 = Parameters::makeParameters(card.pciAddress, 2);
         auto bar2 = ChannelFactory().getBar(params2);
         firmware = bar2->getFirmwareInfo().value_or(na);
+        // Check if the firmware is tagged
+        firmware = FirmwareChecker().resolveFirmwareTag(firmware);
         cardId = bar2->getCardId().value_or(na);
         endpointNumber = bar0->getEndpointNumber();
       } catch (const Exception& e) {

src/FirmwareChecker.h src/FirmwareChecker.cxxsrc/FirmwareChecker.h renamed to src/FirmwareChecker.cxx

@@ -13,33 +13,48 @@
 ///
 /// \author Kostas Alexopoulos ([email protected])
 
-#include "unordered_map"
-#include "ReadoutCard/ChannelFactory.h"
-#include "ReadoutCard/Parameters.h"
+#include "ReadoutCard/FirmwareChecker.h"
+#include "ExceptionInternal.h"
 
 namespace AliceO2
 {
 namespace roc
 {
 
-inline std::unordered_map<std::string, std::string> compatibleFirmwareList({ { "20190911-150139-3f5e11b3", "CRU v3.3.0" },
-                                                                             { "20190718-120712-4c8e6c48", "CRU v3.2.0" },
-                                                                             { "0.0:2000-0-0", "CRORC alpha" } });
+FirmwareChecker::FirmwareChecker() : mCompatibleFirmwareList({ { "20191014-115705-51882687", "v3.4.0" },
+                                                               { "20190911-150139-3f5e11b3", "v3.3.0" },
+                                                               { "20190718-120712-4c8e6c48", "v3.2.0" },
+                                                               { "0.0:2000-0-0", "alpha" } })
+{
+}
+
+FirmwareChecker::~FirmwareChecker()
+{
+}
+
+std::string FirmwareChecker::resolveFirmwareTag(std::string firmware)
+{
+  if (mCompatibleFirmwareList.find(firmware) != mCompatibleFirmwareList.end()) {
+    return mCompatibleFirmwareList.at(firmware);
+  } else {
+    return firmware;
+  }
+}
 
-inline std::string getFirmwareCompatibilityList()
+std::string FirmwareChecker::getFirmwareCompatibilityList()
 {
   std::string fwStrings;
-  for (auto fwString : compatibleFirmwareList) {
+  for (auto fwString : mCompatibleFirmwareList) {
     fwStrings += "\n" + fwString.second + " - " + fwString.first;
   }
   return fwStrings;
 }
 
-inline void checkFirmwareCompatibilityWrapped(std::shared_ptr<BarInterface> bar2)
+void FirmwareChecker::checkFirmwareCompatibilityWrapped(std::shared_ptr<BarInterface> bar2)
 {
   auto firmware = bar2->getFirmwareInfo().value_or("");
   auto serial = bar2->getSerial().value_or(-1);
-  if (compatibleFirmwareList.find(firmware) == compatibleFirmwareList.end()) {
+  if (mCompatibleFirmwareList.find(firmware) == mCompatibleFirmwareList.end()) {
     BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message(
                             std::string("Firmware compatibility check failed.\n") +
                             std::string("Serial: " + std::to_string(serial) + "\n") +
@@ -49,13 +64,13 @@ inline void checkFirmwareCompatibilityWrapped(std::shared_ptr<BarInterface> bar2
   }
 }
 
-inline void checkFirmwareCompatibility(Parameters params)
+void FirmwareChecker::checkFirmwareCompatibility(Parameters params)
 {
   auto bar2 = ChannelFactory().getBar(params);
   checkFirmwareCompatibilityWrapped(bar2);
 }
 
-inline void checkFirmwareCompatibility(Parameters::CardIdType cardId)
+void FirmwareChecker::checkFirmwareCompatibility(Parameters::CardIdType cardId)
 {
   auto params = Parameters::makeParameters(cardId, 2); // access bar2 to check the firmware release
   auto bar2 = ChannelFactory().getBar(params);