Merge pull request #47276 from cramonal/CRCatUnpacker

HGCAL: ECON D CRC (trailer) computation in the Unpacker

Author: cmsbuild

DataFormats/HGCalDigi/interface/HGCalECONDPacketInfoSoA.h

@@ -41,7 +41,8 @@ namespace hgcaldigi {
                       // 0b100: No ECOND packet. The event builder state machine timed-out.
                       // 0b101: No ECOND packet due to BCID and/or OrbitID mismatch.
                       // 0b110: No ECOND packet. Packet was detected but was discarded due to Main Buffer overflow.
-                      SOA_COLUMN(uint8_t, cbFlag),  //cbflag
+                      // 0b111: ECOND CRC trailer error.
+                      SOA_COLUMN(uint16_t, cbFlag),  //cbflag
                       // ECON-D header information
                       // bit 0: Truncation flag
                       // bit 1: Match flag

DataFormats/HGCalDigi/interface/HGCalRawDataDefinitions.h

@@ -13,7 +13,8 @@ namespace hgcal {
   namespace backend {
     namespace ECONDPacketStatus {
       constexpr uint8_t Normal = 0x0, PayloadTooLarge = 0x1, PayloadCRCError = 0x2, EventIDMismatch = 0x3,
-                        EBTimeout = 0x4, BCIDOrbitIDMismatch = 0x5, MainBufferOverflow = 0x6, InactiveECOND = 0x7;
+                        EBTimeout = 0x4, BCIDOrbitIDMismatch = 0x5, MainBufferOverflow = 0x6, InactiveECOND = 0x7,
+                        OfflinePayloadCRCError = 0x8;
     }  // namespace ECONDPacketStatus
   }  // namespace backend
 
@@ -25,7 +26,8 @@ namespace hgcal {
                        EHCRC_MASK = 0xff, EHCRC_POS = 0, ERXSTAT_POS = 29, ERXSTAT_MASK = 0x7, ERXHAM_POS = 26,
                        ERXHAM_MASK = 0x7, ERXFORMAT_POS = 25, ERXFORMAT_MASK = 0x1, COMMONMODE0_POS = 15,
                        COMMONMODE0_MASK = 0x3ff, COMMONMODE1_POS = 5, COMMONMODE1_MASK = 0x3ff, CHMAP32_POS = 0,
-                       CHMAP32_MASK = 0x1f, CHMAP0_POS = 0, CHMAP0_MASK = 0xffffffff, ERX_E_POS = 4, ERX_E_MASK = 1;
+                       CHMAP32_MASK = 0x1f, CHMAP0_POS = 0, CHMAP0_MASK = 0xffffffff, ERX_E_POS = 4, ERX_E_MASK = 1,
+                       CRC_POL = 0x4c11db7, CRC_INITREM = 0x0, CRC_FINALXOR = 0x0;
   }  // namespace ECOND_FRAME
 
   namespace BACKEND_FRAME {

EventFilter/HGCalRawToDigi/BuildFile.xml

@@ -4,6 +4,7 @@
 <use name="DataFormats/HGCalDigi"/>
 <use name="FWCore/ParameterSet"/>
 <use name="clhep"/>
+<use name="boost"/>
 <export>
   <lib name="1"/>
 </export>

EventFilter/HGCalRawToDigi/interface/HGCalUnpacker.h

@@ -18,6 +18,7 @@
 #include "CondFormats/HGCalObjects/interface/HGCalMappingModuleIndexer.h"
 #include "CondFormats/HGCalObjects/interface/HGCalConfiguration.h"
 #include "FWCore/Utilities/interface/Exception.h"
+#include "EventFilter/HGCalRawToDigi/interface/UnpackerTools.h"
 
 #include <cstdint>
 #include <functional>

EventFilter/HGCalRawToDigi/interface/UnpackerTools.h

@@ -0,0 +1,17 @@
+#ifndef EventFilter_HGCalRawToDigi_interface_UnpackerTools_h
+#define EventFilter_HGCalRawToDigi_interface_UnpackerTools_h
+#include "DataFormats/HGCalDigi/interface/HGCalRawDataDefinitions.h"
+
+#include <string>
+
+namespace hgcal {
+
+  /**
+     @short this function re-computes the CRC of the ECON-D packet and compares it with the trailer of the packet
+     false is returned if there is a mismatch
+   */
+  bool econdCRCAnalysis(const uint64_t *header, const uint32_t pos, const uint32_t payloadLength);
+
+}  // namespace hgcal
+
+#endif

EventFilter/HGCalRawToDigi/src/HGCalUnpacker.cc

@@ -7,7 +7,7 @@
 #include "CondFormats/HGCalObjects/interface/HGCalMappingCellIndexer.h"
 #include "FWCore/MessageLogger/interface/MessageLogger.h"
 #include "FWCore/Utilities/interface/Exception.h"
-
+#include "EventFilter/HGCalRawToDigi/interface/UnpackerTools.h"
 #include <array>
 
 using namespace hgcal;
@@ -152,12 +152,21 @@ uint8_t HGCalUnpacker::parseFEDData(unsigned fedId,
             << "), got 0x" << econd_headers[0] << ".";
         return UNPACKER_STAT::WrongECONDHeader;
       }
+      const auto econd_payload_length = ((econd_headers[0] >> ECOND_FRAME::PAYLOAD_POS) & ECOND_FRAME::PAYLOAD_MASK);
+      // Compute ECON-D trailer CRC
+      bool crcvalid = hgcal::econdCRCAnalysis(ptr, 0, econd_payload_length);
+      LogDebug("[HGCalUnpacker]") << "crc value " << crcvalid;
       ++ptr;
 
-      econdPacketInfo.view()[ECONDdenseIdx].cbFlag() = (uint8_t)(econd_pkt_status);
+      if (!crcvalid) {
+        econd_pkt_status |=
+            backend::ECONDPacketStatus::OfflinePayloadCRCError;  //If CRC errors in the trailer, update the pkt status
+      }
+
+      econdPacketInfo.view()[ECONDdenseIdx].cbFlag() = (uint16_t)(econd_pkt_status);
+
       // ECON-D payload length (num of 32b words)
       // NOTE: in the capture blocks, ECON-D packets do not have the trailing IDLE word
-      const auto econd_payload_length = ((econd_headers[0] >> ECOND_FRAME::PAYLOAD_POS) & ECOND_FRAME::PAYLOAD_MASK);
       if (econd_payload_length > 469) {
         econdPacketInfo.view()[ECONDdenseIdx].exception() = 4;
         edm::LogWarning("[HGCalUnpacker]")
@@ -180,12 +189,13 @@ uint8_t HGCalUnpacker::parseFEDData(unsigned fedId,
                                   << ", econdIdx = " << econdIdx << ", econd_headers = " << std::hex
                                   << std::setfill('0') << std::setw(8) << econd_headers[0] << " " << econd_headers[1]
                                   << std::dec << ", econd_payload_length = " << econd_payload_length;
-
-      //quality check for ECON-D (no need to check again econd_pkt_status here again)
+      //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) ||
           (((econd_headers[0] >> ECOND_FRAME::BITM_POS) & 0b1) == 0) ||
-          (((econd_headers[0] >> ECOND_FRAME::BITM_POS) & 0b1) == 0) || econd_payload_length == 0 || headerOnlyMode) {
+          (((econd_headers[0] >> ECOND_FRAME::BITM_POS) & 0b1) == 0) || econd_payload_length == 0 ||
+          econd_pkt_status == backend::ECONDPacketStatus::OfflinePayloadCRCError ||
+          econd_pkt_status == backend::ECONDPacketStatus::InactiveECOND || headerOnlyMode) {
         continue;
       }
 

EventFilter/HGCalRawToDigi/src/UnpackerTools.cc

@@ -0,0 +1,42 @@
+#include "EventFilter/HGCalRawToDigi/interface/UnpackerTools.h"
+#include "DataFormats/HGCalDigi/interface/HGCalRawDataDefinitions.h"
+#include <boost/crc.hpp>
+#include <vector>
+#include <iostream>
+//
+//
+
+bool hgcal::econdCRCAnalysis(const uint64_t *header, const uint32_t pos, const uint32_t payloadLength) {
+  int index = 0;
+  std::vector<uint32_t> data32b;  //  reading 32-bit words, input is 64b
+
+  while (data32b.size() < payloadLength + 2) {
+    uint64_t word = *(header + pos + index);  // move to ECOND header
+    data32b.push_back(word >> 32);            // Reading first 32b
+
+    if (data32b.size() == payloadLength + 2)
+      break;
+    data32b.push_back(word & 0xFFFFFFFF);  //read second 32b
+    ++index;
+  }
+
+  auto target = data32b.back();  // CRC in ECOND trailer
+
+  //Compute CRC using all eRx subpackets but not the event paket header (two first words)
+  std::vector<uint32_t> crcvec(data32b.begin() + 2, data32b.end() - 1);
+  std::transform(crcvec.begin(), crcvec.end(), crcvec.begin(), [](uint32_t w) {
+    return ((w << 24) & 0xFF000000) | ((w << 8) & 0x00FF0000) | ((w >> 8) & 0x0000FF00) |
+           ((w >> 24) & 0x000000FF);  //swapping endianness
+  });
+
+  auto array = &(crcvec[0]);
+  auto bytes = reinterpret_cast<const unsigned char *>(array);
+  auto crc32 = boost::crc<32,
+                          hgcal::ECOND_FRAME::CRC_POL,
+                          hgcal::ECOND_FRAME::CRC_INITREM,
+                          hgcal::ECOND_FRAME::CRC_FINALXOR,
+                          false,
+                          false>(bytes, (payloadLength - 1) * 4);  //32-bit words, hence need to parse 4 bytes
+
+  return crc32 == target;
+}