[fw-check] Firmware compatibility table may be overwritten by local file

Author: kostorr

README.md

@@ -738,6 +738,10 @@ Both _PDA_ packages can also be installed from source as described on the next s
 
 For the _CRU firmware_ see the [gitlab](https://gitlab.cern.ch/alice-cru/cru-fw) repo.
 
+Note: The CRU firmware compatibility table has lower precedence to an (optionally present) firmware compatibility json file, which
+is always searched for in `/etc/o2.d/readoutcard/o2-roc-fw-list.json`. This is a flat json map, as seen in the example file
+[o2-roc-fw-list.json](o2-roc-fw-list.json).
+
 ### PDA
 The module depends on the PDA (Portable Driver Architecture) library and driver.
 If PDA is not detected on the system, only a dummy implementation of the interface will be compiled.

include/ReadoutCard/FirmwareChecker.h

@@ -41,6 +41,7 @@ class FirmwareChecker
   void checkFirmwareCompatibilityWrapped(Parameters::CardIdType cardId);
   std::string getFirmwareCompatibilityList();
   std::unordered_map<std::string, std::string> mCompatibleFirmwareList;
+  static constexpr char kFirmwareListFile[] = "json:///etc/o2.d/readoutcard/o2-roc-fw-list.json";
 };
 
 } // namespace roc

o2-roc-fw-list.json

@@ -0,0 +1,5 @@
+{
+  "14ccd414": "v3.14.1",
+  "2058c933": "v3.14.0",
+  "ed43b5d": "free string"
+}

src/CommandLineUtilities/ProgramListCards.cxx

@@ -70,6 +70,7 @@ class ProgramListCards : public Program
     pt::ptree root;
 
     auto cardsFound = o2::roc::RocPciDevice::findSystemDevices();
+    auto firmwareChecker = FirmwareChecker();
 
     int i = 0;
     for (const auto& card : cardsFound) {
@@ -85,7 +86,7 @@ class ProgramListCards : public Program
           userLogicVersion = std::dynamic_pointer_cast<CruBar>(bar2)->getUserLogicVersion().value_or(na);
         }
         // Check if the firmware is tagged
-        firmware = FirmwareChecker().resolveFirmwareTag(firmware);
+        firmware = firmwareChecker.resolveFirmwareTag(firmware);
       } catch (const Exception& e) {
         std::cerr << "Error parsing card information through BAR\n"
                   << boost::diagnostic_information(e) << '\n';

src/FirmwareChecker.cxx

@@ -16,6 +16,7 @@
 
 #include "ReadoutCard/FirmwareChecker.h"
 #include "ExceptionInternal.h"
+#include <Configuration/ConfigurationFactory.h>
 
 namespace o2
 {
@@ -49,6 +50,19 @@ FirmwareChecker::FirmwareChecker() : mCompatibleFirmwareList({
                                                                { "72cdb92", "v2.4.1" }*/
                                      })
 {
+  std::unordered_map<std::string, std::string> parsedList;
+  try {
+    auto conf = configuration::ConfigurationFactory::getConfiguration(kFirmwareListFile);
+    parsedList = conf->getRecursiveMap();
+  } catch (const std::runtime_error& e) {
+    /* on error bail out */
+    return;
+  }
+
+  // if the parsed list is not empty update the compatible fimrware list
+  if (!parsedList.empty()) {
+    mCompatibleFirmwareList = parsedList;
+  }
 }
 
 FirmwareChecker::~FirmwareChecker()