Merge pull request #279 from sy-c/master

readout v2.24.0

Author: sy-c

doc/configurationParameters.md

@@ -192,6 +192,8 @@ The parameters related to 3rd-party libraries are described here for convenience
 | equipment-rorc-* | dataSource | string | Internal | This parameter selects the data source used by ReadoutCard, c.f. AliceO2::roc::Parameters. It can be for CRU one of Fee, Ddg, Internal and for CRORC one of Fee, SIU, DIU, Internal. |
 | equipment-rorc-* | debugStatsEnabled | int | 0 | If set, enable extra statistics about internal buffers status. (printed to stdout when stopping) |
 | equipment-rorc-* | firmwareCheckEnabled | int | 1 | If set, RORC driver checks compatibility with detected firmware. Use 0 to bypass this check (eg new fw version not yet recognized by ReadoutCard version). |
+| equipment-rorc-* | firmwareVersionsAllowed | string | | Comma-separated list of ROC firmware versions allowed (6-digit hash). If empty, all are allowed. |
+| equipment-rorc-* | firmwareVersionsDenied | string | e4a5a46e | Comma-separated list of ROC firmware versions denied  (6-digit hash), i.e. which would cause configuration to abort. |
 | equipment-zmq-* | address | string | | Address of remote server to connect, eg tcp://remoteHost:12345. |
 | equipment-zmq-* | mode | string | stream | Possible values: stream (1 input ZMQ message = 1 output data page), snapshot (last ZMQ message = one output data page per TF). |
 | equipment-zmq-* | timeframeClientUrl | string | | The address to be used to retrieve current timeframe. When set, data is published only once for each TF id published by remote server. |

doc/releaseNotes.md

@@ -624,3 +624,7 @@ This file describes the main feature changes for each readout.exe released versi
 
 ## v2.23.3 - 21/05/2024
 - Bookkeeping: updates are now disabled after 3 failures (1 before). Log messages changed (logbook -> bookkeeping).
+
+## v2.24.0 - 18/06/2024
+- Updated configuration parameters:
+  - equipment-rorc-*: added parameters firmwareVersionsDenied and firmwareVersionsAllowed, to enforce the check of firmware for specific versions. By default, v3.10.0 (e4a5a46e) is denied and all other allowed: it is the default version in CRU flash and should be updated to a more recent one at boot time.

src/ReadoutEquipmentRORC.cxx

@@ -112,6 +112,22 @@ ReadoutEquipmentRORC::ReadoutEquipmentRORC(ConfigFile& cfg, std::string name) :
       theLog.log(LogInfoDevel_(3002), "Bypassing RORC firmware compatibility check");
     }
 
+    // configuration parameter: | equipment-rorc-* | firmwareVersionsDenied | string | e4a5a46e | Comma-separated list of ROC firmware versions denied  (6-digit hash), i.e. which would cause configuration to abort. |
+    std::string cfgFirmwareVersionsDenied = "e4a5a46e";
+    std::vector<std::string> cfgFirmwareVersionsDeniedList;
+    cfg.getOptionalValue<std::string>(name + ".firmwareVersionsDenied", cfgFirmwareVersionsDenied);
+    if (cfgFirmwareVersionsDenied != "") {
+      getListFromString(cfgFirmwareVersionsDenied, cfgFirmwareVersionsDeniedList);
+    }
+
+    // configuration parameter: | equipment-rorc-* | firmwareVersionsAllowed | string | | Comma-separated list of ROC firmware versions allowed (6-digit hash). If empty, all are allowed. |
+    std::string cfgFirmwareVersionsAllowed = "";
+    std::vector<std::string> cfgFirmwareVersionsAllowedList;
+    cfg.getOptionalValue<std::string>(name + ".firmwareVersionsAllowed", cfgFirmwareVersionsAllowed);
+    if (cfgFirmwareVersionsAllowed != "") {
+      getListFromString(cfgFirmwareVersionsAllowed, cfgFirmwareVersionsAllowedList);
+    }
+
     // configuration parameter: | equipment-rorc-* | debugStatsEnabled | int | 0 | If set, enable extra statistics about internal buffers status. (printed to stdout when stopping) |
     cfg.getOptionalValue<int>(name + ".debugStatsEnabled", cfgDebugStatsEnabled);
 
@@ -179,6 +195,27 @@ ReadoutEquipmentRORC::ReadoutEquipmentRORC(ConfigFile& cfg, std::string name) :
     std::string infoCardId = channel->getCardId().value_or("unknown");
     theLog.log(LogInfoDevel_(3010), "Equipment %s : PCI %s @ NUMA node %d, serial number %s, firmware version %s, card id %s", name.c_str(), infoPciAddress.c_str(), infoNumaNode, infoSerialNumber.c_str(), infoFirmwareVersion.c_str(), infoCardId.c_str());
 
+    // check firmware version ok
+    bool isFwOk = true;
+    for(const auto &fw: cfgFirmwareVersionsDeniedList) {
+      if (infoFirmwareVersion == fw) {
+        isFwOk = false;
+        break;
+      }
+    }
+    if (cfgFirmwareVersionsAllowedList.size() && isFwOk) {
+      isFwOk = false;
+      for(const auto &fw: cfgFirmwareVersionsAllowedList) {
+	if (infoFirmwareVersion == fw) {
+          isFwOk = true;
+	  break;
+	}
+      }
+    }
+    if (!isFwOk) {
+      BOOST_THROW_EXCEPTION(ReadoutEquipmentRORCException() << ErrorInfo::Message("This firmware version is not allowed"));
+    }
+
     // todo: log parameters ?
 
     if (logRocCallsEnable) {

src/ReadoutVersion.h

@@ -9,5 +9,5 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-#define READOUT_VERSION "2.23.3"
+#define READOUT_VERSION "2.24.0"
 

src/readoutConfigEditor.tcl

@@ -138,6 +138,8 @@ set configurationParametersDescriptor {
 | equipment-rorc-* | dataSource | string | Internal | This parameter selects the data source used by ReadoutCard, c.f. AliceO2::roc::Parameters. It can be for CRU one of Fee, Ddg, Internal and for CRORC one of Fee, SIU, DIU, Internal. |
 | equipment-rorc-* | debugStatsEnabled | int | 0 | If set, enable extra statistics about internal buffers status. (printed to stdout when stopping) |
 | equipment-rorc-* | firmwareCheckEnabled | int | 1 | If set, RORC driver checks compatibility with detected firmware. Use 0 to bypass this check (eg new fw version not yet recognized by ReadoutCard version). |
+| equipment-rorc-* | firmwareVersionsAllowed | string | | Comma-separated list of ROC firmware versions allowed (6-digit hash). If empty, all are allowed. |
+| equipment-rorc-* | firmwareVersionsDenied | string | e4a5a46e | Comma-separated list of ROC firmware versions denied  (6-digit hash), i.e. which would cause configuration to abort. |
 | equipment-zmq-* | address | string | | Address of remote server to connect, eg tcp://remoteHost:12345. |
 | equipment-zmq-* | mode | string | stream | Possible values: stream (1 input ZMQ message = 1 output data page), snapshot (last ZMQ message = one output data page per TF). |
 | equipment-zmq-* | timeframeClientUrl | string | | The address to be used to retrieve current timeframe. When set, data is published only once for each TF id published by remote server. |