TFperiod default changed to 32

Author: sy-c

doc/configurationParameters.md

@@ -161,7 +161,7 @@ The parameters related to 3rd-party libraries are described here for convenience
 | equipment-* | saveErrorPagesMax | int | 0 | If set, pages found with data error are saved to disk up to given maximum. |
 | equipment-* | saveErrorPagesPath | string |  | Path where to save data pages with errors (when feature enabled). |
 | equipment-* | stopOnError | int | 0 | If 1, readout will stop automatically on equipment error. |
-| equipment-* | TFperiod | int | 128 | Duration of a timeframe, in number of LHC orbits. |
+| equipment-* | TFperiod | int | 32 | Duration of a timeframe, in number of LHC orbits. |
 | equipment-* | verbose | int | 0 | If set, extra debug messages may be logged. |
 | equipment-cruemulator-* | cruBlockSize | int | 8192 | Size of a RDH block. |
 | equipment-cruemulator-* | cruId | int | 0 | CRU Id, used for CRU Id field in RDH. |

doc/releaseNotes.md

@@ -655,3 +655,7 @@ This file describes the main feature changes for each readout.exe released versi
 
 ## v2.27.1 - 12/02/2025
 - Path of configuration file from which defaults are loaded on startup has been changed to /etc/o2.d/readout/readout-defaults.cfg (it was in /etc/o2.d before, now changing to standard subdirectory location).
+
+## next version
+- Updated configuration parameters:
+  - equipment.TFperiod is now set to 32 by default, instead of 128 previously. This is the duration of a timeframe, in number of LHC orbits. The new value corresponds to what is used in production.

src/ReadoutEquipment.cxx

@@ -161,8 +161,8 @@ ReadoutEquipment::ReadoutEquipment(ConfigFile& cfg, std::string cfgEntryPoint, b
   cfg.getOptionalValue<int>(cfgEntryPoint + ".verbose", cfgVerbose);
 
   if (!cfgDisableTimeframes) {
-    // configuration parameter: | equipment-* | TFperiod | int | 128 | Duration of a timeframe, in number of LHC orbits. |
-    int cfgTFperiod = 128;
+    // configuration parameter: | equipment-* | TFperiod | int | 32 | Duration of a timeframe, in number of LHC orbits. |
+    int cfgTFperiod = 32;
     cfg.getOptionalValue<int>(cfgEntryPoint + ".TFperiod", cfgTFperiod);
     timeframePeriodOrbits = cfgTFperiod;
 

src/ReadoutEquipment.h

@@ -165,7 +165,7 @@ class ReadoutEquipment
 
   //const unsigned int LHCBunches = 3564;    // number of bunches in LHC
   const unsigned int LHCOrbitRate = 11246; // LHC orbit rate, in Hz. 299792458 / 26659
-  uint32_t timeframePeriodOrbits = 128;    // timeframe interval duration in number of LHC orbits
+  uint32_t timeframePeriodOrbits = 32;     // timeframe interval duration in number of LHC orbits
   double timeframeRate = 0;                // timeframe rate, when generated internally
 
   // RDH-related configuration parameters

src/readRaw.cxx

@@ -76,7 +76,7 @@ int main(int argc, const char* argv[])
       "    dumpDataInline=(int) : if set, each packet raw content is printed (hex dump style).\n"
       "    dumpStats=(int) : if set, some statistics are printed on HBF/TF size.\n"
       "    fileReadVerbose=(int) : if set, more information is printed when reading/decoding file.\n"
-      "    timeframePeriodOrbits=(int) : if set, TF id computed (and printed, when dump enabled) for each RDH. Typically, 128 or 256.\n"
+      "    timeframePeriodOrbits=(int) : if set, TF id computed (and printed, when dump enabled) for each RDH. Typically, 32 or 128.\n"
       "    logOff=(int) : if set, logs disabled.\n"
       "    dumpOrbitStats=(int) : if set, first / min / max orbits are printed after file read.\n"
       "    \n",

src/readoutConfigEditor.tcl

@@ -107,7 +107,7 @@ set configurationParametersDescriptor {
 | equipment-* | saveErrorPagesMax | int | 0 | If set, pages found with data error are saved to disk up to given maximum. |
 | equipment-* | saveErrorPagesPath | string |  | Path where to save data pages with errors (when feature enabled). |
 | equipment-* | stopOnError | int | 0 | If 1, readout will stop automatically on equipment error. |
-| equipment-* | TFperiod | int | 128 | Duration of a timeframe, in number of LHC orbits. |
+| equipment-* | TFperiod | int | 32 | Duration of a timeframe, in number of LHC orbits. |
 | equipment-* | verbose | int | 0 | If set, extra debug messages may be logged. |
 | equipment-cruemulator-* | cruBlockSize | int | 8192 | Size of a RDH block. |
 | equipment-cruemulator-* | cruId | int | 0 | CRU Id, used for CRU Id field in RDH. |