Merge pull request #48559 from CMS-HGCAL/ECON_SLink_Diff

Read BX, L1A, and Orbit numbers from ECON-D, Capture Block, and S-Link headers

Author: cmsbuild

DataFormats/HGCalDigi/interface/HGCalECONDPacketInfoSoA.h

@@ -73,6 +73,15 @@ namespace hgcaldigi {
                       // If exception found before ECON-D, this would be 0
                       // Otherwise the payload length of the ECON-D
                       SOA_COLUMN(uint16_t, payloadLength),
+                      // BX,L1A,Orbit number of the ECON-D
+                      SOA_COLUMN(uint16_t, BX),
+                      SOA_COLUMN(uint8_t, L1A),
+                      SOA_COLUMN(uint8_t, Orbit),
+                      // BX,L1A,Orbit number of the Capture Block
+                      SOA_COLUMN(uint16_t, CBBX),
+                      SOA_COLUMN(uint8_t, CBL1A),
+                      SOA_COLUMN(uint8_t, CBOrbit),
+                      // Common modes
                       SOA_EIGEN_COLUMN(Matrix, cm))
   using HGCalECONDPacketInfoSoA = HGCalECONDPacketInfoSoALayout<>;
 }  // namespace hgcaldigi

DataFormats/HGCalDigi/interface/HGCalFEDPacketInfoSoA.h

@@ -57,7 +57,11 @@ namespace hgcaldigi {
                       // bit 1 : unable to unpack data
                       // bit 2 : at least one capture block has active flags
                       SOA_COLUMN(uint16_t, FEDUnpackingFlag),
-                      SOA_COLUMN(uint32_t, FEDPayload))  //number of words (char)
+                      SOA_COLUMN(uint32_t, FEDPayload),  //number of words (char)
+                      // BX,L1A,Orbit number of the SLink
+                      SOA_COLUMN(uint16_t, FEDBX),
+                      SOA_COLUMN(uint64_t, FEDL1A),
+                      SOA_COLUMN(uint32_t, FEDOrbit))
 
   using HGCalFEDPacketInfoSoA = HGCalFEDPacketInfoSoALayout<>;
 }  // namespace hgcaldigi

DataFormats/HGCalDigi/interface/HGCalRawDataDefinitions.h

@@ -32,7 +32,7 @@ namespace hgcal {
 
   namespace BACKEND_FRAME {
     constexpr uint32_t CAPTUREBLOCK_RESERVED_MASK = 0x7f, CAPTUREBLOCK_RESERVED_POS = 25, CAPTUREBLOCK_BC_MASK = 0xfff,
-                       CAPTUREBLOCK_BC_POS = 13, CAPTUREBLOCK_EC_MASK = 0x7f, CAPTUREBLOCK_EC_POS = 7,
+                       CAPTUREBLOCK_BC_POS = 13, CAPTUREBLOCK_EC_MASK = 0x3f, CAPTUREBLOCK_EC_POS = 7,
                        CAPTUREBLOCK_OC_MASK = 0x7, CAPTUREBLOCK_OC_POS = 4, SLINK_BOE_MASK = 0xff, SLINK_BOE_POS = 24,
                        SLINK_V_MASK = 0xf, SLINK_V_POS = 19, SLINK_R8_MASK = 0xff, SLINK_R8_POS = 11,
                        SLINK_GLOBAL_EVENTID_MSB_MASK = 0xfff, SLINK_GLOBAL_EVENTID_MSB_POS = 0,

EventFilter/HGCalRawToDigi/interface/HGCalUnpacker.h

@@ -14,6 +14,7 @@
 #include "DataFormats/HGCalDigi/interface/HGCalRawDataDefinitions.h"
 #include "DataFormats/FEDRawData/interface/FEDRawData.h"
 #include "DataFormats/HGCalDigi/interface/HGCalDigiHost.h"
+#include "DataFormats/HGCalDigi/interface/HGCalFEDPacketInfoHost.h"
 #include "DataFormats/HGCalDigi/interface/HGCalECONDPacketInfoHost.h"
 #include "CondFormats/HGCalObjects/interface/HGCalMappingModuleIndexer.h"
 #include "CondFormats/HGCalObjects/interface/HGCalConfiguration.h"
@@ -37,6 +38,7 @@ class HGCalUnpacker {
                         const HGCalMappingModuleIndexer& moduleIndexer,
                         const HGCalConfiguration& config,
                         hgcaldigi::HGCalDigiHost& digis,
+                        hgcaldigi::HGCalFEDPacketInfoHost& fedPacketInfo,
                         hgcaldigi::HGCalECONDPacketInfoHost& econdPacketInfo,
                         bool headerOnlyMode = false);
 

EventFilter/HGCalRawToDigi/plugins/HGCalRawToDigi.cc

@@ -33,6 +33,7 @@ class HGCalRawToDigi : public edm::stream::EDProducer<> {
                         const HGCalMappingModuleIndexer& moduleIndexer,
                         const HGCalConfiguration& config,
                         hgcaldigi::HGCalDigiHost& digis,
+                        hgcaldigi::HGCalFEDPacketInfoHost& fedPacketInfo,
                         hgcaldigi::HGCalECONDPacketInfoHost& econdPacketInfo);
   static void fillDescriptions(edm::ConfigurationDescriptions&);
 
@@ -113,7 +114,7 @@ void HGCalRawToDigi::produce(edm::Event& iEvent, const edm::EventSetup& iSetup)
       if (fed_data.size() == 0)
         continue;
       fedPacketInfo.view()[fedId].FEDUnpackingFlag() =
-          callUnpacker(fedId, fed_data, moduleIndexer, config, digis, econdPacketInfo);
+          callUnpacker(fedId, fed_data, moduleIndexer, config, digis, fedPacketInfo, econdPacketInfo);
     }
   }
   //parallel unpacking calls
@@ -129,7 +130,7 @@ void HGCalRawToDigi::produce(edm::Event& iEvent, const edm::EventSetup& iSetup)
         if (fed_data.size() == 0)
           return;
         fedPacketInfo.view()[fedId].FEDUnpackingFlag() =
-            callUnpacker(fedId, fed_data, moduleIndexer, config, digis, econdPacketInfo);
+            callUnpacker(fedId, fed_data, moduleIndexer, config, digis, fedPacketInfo, econdPacketInfo);
         return;
       });
     });
@@ -147,9 +148,10 @@ uint16_t HGCalRawToDigi::callUnpacker(unsigned fedId,
                                       const HGCalMappingModuleIndexer& moduleIndexer,
                                       const HGCalConfiguration& config,
                                       hgcaldigi::HGCalDigiHost& digis,
+                                      hgcaldigi::HGCalFEDPacketInfoHost& fedPacketInfo,
                                       hgcaldigi::HGCalECONDPacketInfoHost& econdPacketInfo) {
-  uint16_t status =
-      unpacker_.parseFEDData(fedId, fed_data, moduleIndexer, config, digis, econdPacketInfo, headersOnly_);
+  uint16_t status = unpacker_.parseFEDData(
+      fedId, fed_data, moduleIndexer, config, digis, fedPacketInfo, econdPacketInfo, headersOnly_);
   return status;
 }
 

EventFilter/HGCalRawToDigi/src/HGCalUnpacker.cc

@@ -24,6 +24,7 @@ uint16_t HGCalUnpacker::parseFEDData(unsigned fedId,
                                      const HGCalMappingModuleIndexer& moduleIndexer,
                                      const HGCalConfiguration& config,
                                      hgcaldigi::HGCalDigiHost& digis,
+                                     hgcaldigi::HGCalFEDPacketInfoHost& fedPacketInfo,
                                      hgcaldigi::HGCalECONDPacketInfoHost& econdPacketInfo,
                                      bool headerOnlyMode) {
   // ReadoutSequence object for this FED
@@ -54,7 +55,20 @@ uint16_t HGCalUnpacker::parseFEDData(unsigned fedId,
   LogDebug("[HGCalUnpacker]") << "fedId = " << fedId << ", nwords (64b) = " << std::distance(header, trailer);
   const auto* ptr = header;
 
+  // read L1A number from the SLink header
+  uint64_t SLinkL1Amask = (uint64_t(BACKEND_FRAME::SLINK_GLOBAL_EVENTID_MSB_MASK) << 32) |
+                          uint64_t(BACKEND_FRAME::SLINK_GLOBAL_EVENTID_LSB_MASK);
+  uint64_t L1ASLink = ((*(header + 1) >> BACKEND_FRAME::SLINK_GLOBAL_EVENTID_LSB_POS) & SLinkL1Amask);
+  // read BX number and Orbit number from the SLink trailer
+  uint16_t BXSLink = ((*(trailer - 1) >> BACKEND_FRAME::SLINK_BXID_POS) & BACKEND_FRAME::SLINK_BXID_MASK);
+  uint32_t OrbitSLink = ((*(trailer - 2) >> (BACKEND_FRAME::SLINK_ORBID_POS + 32)) & BACKEND_FRAME::SLINK_ORBID_MASK);
+  fedPacketInfo.view()[fedId].FEDL1A() = L1ASLink;
+  fedPacketInfo.view()[fedId].FEDBX() = BXSLink;
+  fedPacketInfo.view()[fedId].FEDOrbit() = OrbitSLink;
 #ifdef EDM_ML_DEBUG
+  LogDebug("[HGCalUnpacker]") << "S-Link BX number:" << std::dec << BXSLink << ", L1A number:" << std::dec
+                              << (int)L1ASLink << ", Orbit ID:" << std::dec << (int)OrbitSLink;
+
   for (unsigned iword = 0; ptr < trailer; ++iword) {
     LogDebug("[HGCalUnpacker]") << std::setw(8) << iword << ": 0x" << std::hex << std::setfill('0') << std::setw(16)
                                 << *ptr << " (" << std::setfill('0') << std::setw(8)
@@ -65,7 +79,6 @@ uint16_t HGCalUnpacker::parseFEDData(unsigned fedId,
   LogDebug("[HGCalUnpacker]") << "@@@\n";
   ptr = header;
 #endif
-
   // check SLink header (128b)
   // sanity check
   auto slink_header = *(ptr + 1);
@@ -92,6 +105,7 @@ uint16_t HGCalUnpacker::parseFEDData(unsigned fedId,
   for (uint32_t captureblockIdx = 0; captureblockIdx < HGCalMappingModuleIndexer::maxCBperFED_ && ptr < trailer - 2;
        captureblockIdx++) {
     // check capture block header (64b)
+
     LogDebug("[HGCalUnpacker]") << "@" << std::setw(8) << std::distance(header, ptr) << ": 0x" << std::hex
                                 << std::setfill('0') << std::setw(16) << *ptr << std::dec;
     auto cb_header = *ptr;
@@ -126,11 +140,21 @@ uint16_t HGCalUnpacker::parseFEDData(unsigned fedId,
                                          << " from 0x" << cb_header << ".";
       return (0x1 << hgcaldigi::FEDUnpackingFlags::ErrorCaptureBlockHeader);
     }
+    uint16_t BXCaptureBlock =
+        ((cb_header >> (BACKEND_FRAME::CAPTUREBLOCK_BC_POS + 32)) & BACKEND_FRAME::CAPTUREBLOCK_BC_MASK);
+    uint8_t L1ACaptureBlock =
+        ((cb_header >> (BACKEND_FRAME::CAPTUREBLOCK_EC_POS + 32)) & BACKEND_FRAME::CAPTUREBLOCK_EC_MASK);
+    uint8_t OrbitCaptureBlock =
+        ((cb_header >> (BACKEND_FRAME::CAPTUREBLOCK_OC_POS + 32)) & BACKEND_FRAME::CAPTUREBLOCK_OC_MASK);
+    LogDebug("[HGCalUnpacker]") << "CB BX number:" << std::dec << BXCaptureBlock << ", L1A number:" << std::dec
+                                << (int)L1ACaptureBlock << ", Orbit number:" << std::dec << (int)OrbitCaptureBlock;
     ++ptr;
 
     // parse Capture Block body (ECON-Ds)
     for (uint32_t econdIdx = 0; econdIdx < HGCalMappingModuleIndexer::maxECONDperCB_; econdIdx++) {
       auto econd_pkt_status = (cb_header >> (3 * econdIdx)) & 0b111;
+      LogDebug("[HGCalUnpacker]") << "fedId = " << fedId << ", captureblockIdx = " << captureblockIdx
+                                  << ", econdIdx = " << econdIdx << ", econd_pkt_status = " << econd_pkt_status;
       if (econd_pkt_status != backend::ECONDPacketStatus::InactiveECOND) {
         // always increment the global ECON-D index (unless inactive/unconnected)
         globalECONDIdx++;
@@ -157,6 +181,19 @@ uint16_t HGCalUnpacker::parseFEDData(unsigned fedId,
       econdPacketInfo.view()[ECONDdenseIdx].location() = (uint32_t)(ptr - header);
       const auto econd_payload_length = ((econd_headers[0] >> ECOND_FRAME::PAYLOAD_POS) & ECOND_FRAME::PAYLOAD_MASK);
 
+      // read BX, L1A, and Orbit number from the ECON-D header
+      uint16_t BXECOND = ((econd_headers[1] >> ECOND_FRAME::BX_POS) & ECOND_FRAME::BX_MASK);
+      uint8_t L1AECOND = ((econd_headers[1] >> ECOND_FRAME::L1A_POS) & ECOND_FRAME::L1A_MASK);
+      uint8_t OrbitECOND = ((econd_headers[1] >> ECOND_FRAME::ORBIT_POS) & ECOND_FRAME::ORBIT_MASK);
+      econdPacketInfo.view()[ECONDdenseIdx].BX() = BXECOND;
+      econdPacketInfo.view()[ECONDdenseIdx].L1A() = L1AECOND;
+      econdPacketInfo.view()[ECONDdenseIdx].Orbit() = OrbitECOND;
+      econdPacketInfo.view()[ECONDdenseIdx].CBBX() = BXCaptureBlock;
+      econdPacketInfo.view()[ECONDdenseIdx].CBL1A() = L1ACaptureBlock;
+      econdPacketInfo.view()[ECONDdenseIdx].CBOrbit() = OrbitCaptureBlock;
+      LogDebug("[HGCalUnpacker]") << "ECON-D BX number:" << std::dec << BXECOND << ", L1A number:" << std::dec
+                                  << (int)L1AECOND << ", Orbit number:" << std::dec << (int)OrbitECOND;
+      // sanity check
       // ECON-D header marker check
       if (((econd_headers[0] >> ECOND_FRAME::HEADER_POS) & ECOND_FRAME::HEADER_MASK) !=
           fedConfig.econds[globalECONDIdx].headerMarker) {
@@ -213,7 +250,6 @@ uint16_t HGCalUnpacker::parseFEDData(unsigned fedId,
                                   << ", E/B/O = 0b"
                                   << std::bitset<2>((econd_headers[0] >> ECOND_FRAME::EBO_POS) & ECOND_FRAME::EBO_MASK)
                                   << ", M = " << ((econd_headers[0] >> ECOND_FRAME::BITM_POS) & 0b1);
-
       //quality check for ECON-D (check econd_pkt_status here for error in trailer CRC)
       if ((((econd_headers[0] >> ECOND_FRAME::HT_POS) & ECOND_FRAME::HT_MASK) >= 0b10) ||
           (((econd_headers[0] >> ECOND_FRAME::EBO_POS) & ECOND_FRAME::EBO_MASK) >= 0b10) ||
@@ -240,7 +276,6 @@ uint16_t HGCalUnpacker::parseFEDData(unsigned fedId,
           }
           LogDebug("[HGCalUnpacker]") << "fedId = " << fedId << ", captureblockIdx = " << captureblockIdx
                                       << ", econdIdx = " << econdIdx << ", erxIdx = " << erxIdx;
-
           econdPacketInfo.view()[ECONDdenseIdx].cm()(erxIdx, 0) =
               (econd_payload[iword] >> ECOND_FRAME::COMMONMODE0_POS) & ECOND_FRAME::COMMONMODE0_MASK;
           econdPacketInfo.view()[ECONDdenseIdx].cm()(erxIdx, 1) =