TPC ZS: Use 8 bit magic word at end of TPC ZS Meta header, to be compatible with old linkzs

davidrohr · davidrohr · commit 29cf7243bc93 · 2022-05-19T08:29:56.000+02:00
diff --git a/DataFormats/Detectors/TPC/include/DataFormatsTPC/ZeroSuppression.h b/DataFormats/Detectors/TPC/include/DataFormatsTPC/ZeroSuppression.h
@@ -44,10 +44,11 @@ struct TPCZSHDR {
 };
 struct TPCZSHDRV2 : public TPCZSHDR {
   static constexpr unsigned int TPC_ZS_NBITS_V3 = 12;
-  unsigned short magicWord;         // Magic word
   unsigned short firstZSDataOffset; // Offset (after the TPCZSHDRV2 header) in 128bit words to first ZS data (in between can be trigger words, etc.)
   unsigned short nTimebinHeaders;   // Number of timebin headers
-  unsigned short reserved;          // 16 reserved bits, header is 128 bit
+  unsigned short reserved1;         // 16 reserved bits, header is 128 bit
+  unsigned char reserved2;          // 8 reserved bits, header is 128 bit
+  unsigned char magicWord;          // Magic word
 };
 struct TPCZSTBHDR {
   unsigned short rowMask;
diff --git a/DataFormats/Detectors/TPC/include/DataFormatsTPC/ZeroSuppressionLinkBased.h b/DataFormats/Detectors/TPC/include/DataFormatsTPC/ZeroSuppressionLinkBased.h
@@ -31,6 +31,7 @@ static constexpr uint32_t DataWordSizeBytes = DataWordSizeBits / 8; ///< size of
 /// common header definition of the zero suppressed link based data
 struct CommonHeader {
   static constexpr uint32_t MagicWordLinkZS = 0xFC;
+  static constexpr uint32_t MagicWordLinkZSMetaHeader = 0xFD;
   static constexpr uint32_t MagicWordTrigger = 0xAA;
   static constexpr uint32_t MagicWordTriggerV2 = 0xAB;
 
@@ -53,8 +54,9 @@ struct CommonHeader {
     };
   };
 
-  bool hasCorrectMagicWord() const { return (magicWord == MagicWordLinkZS) || (magicWord == MagicWordTrigger) || (magicWord == MagicWordTriggerV2); }
+  bool hasCorrectMagicWord() const { return (magicWord == MagicWordLinkZS) || (magicWord == MagicWordLinkZSMetaHeader) || (magicWord == MagicWordTrigger) || (magicWord == MagicWordTriggerV2); }
   bool isLinkZS() const { return (magicWord == MagicWordLinkZS); }
+  bool isMetaHeader() const { return (magicWord == MagicWordLinkZSMetaHeader); }
   bool isTriggerInfo() const { return (magicWord == MagicWordTrigger); }
   bool isTriggerInfoV2() const { return (magicWord == MagicWordTriggerV2); }
 };
diff --git a/Detectors/TPC/reconstruction/src/RawProcessingHelpers.cxx b/Detectors/TPC/reconstruction/src/RawProcessingHelpers.cxx
@@ -80,6 +80,8 @@ bool raw_processing_helpers::processZSdata(const char* data, size_t size, rdh_ut
       LOGP(debug, "orbit: {}, triggerOrbit: {}, triggerBC: {}, triggerBCOffset: {}", orbit, triggerOrbit, triggerBC, triggerBCOffset);
       zsdata = zsdata->next();
       continue;
+    } else if (header.isMetaHeader()) {
+      continue;
     }
 
     const auto channelBits = zsdata->getChannelBits();
diff --git a/GPU/GPUTracking/Base/GPUReconstructionConvert.cxx b/GPU/GPUTracking/Base/GPUReconstructionConvert.cxx
@@ -507,7 +507,7 @@ void zsEncoderImprovedLinkBased::init()
 
 void zsEncoderImprovedLinkBased::initPage()
 {
-  hdr->magicWord = 0x1234;
+  hdr->magicWord = o2::tpc::zerosupp_link_based::CommonHeader::MagicWordLinkZSMetaHeader;
   hdr->nTimebinHeaders = 0;
   hdr->firstZSDataOffset = 0;
 }
@@ -638,7 +638,7 @@ void zsEncoderImprovedLinkBased::decodePage(std::vector<o2::tpc::Digit>& outputB
   if (decHDR->version != 3) {
     throw std::runtime_error("invalid ZS version");
   }
-  if (decHDR->magicWord != 0x1234) {
+  if (decHDR->magicWord != o2::tpc::zerosupp_link_based::CommonHeader::MagicWordLinkZSMetaHeader) {
     throw std::runtime_error("Magic word missing");
   }
   const float decodeBitsFactor = 1.f / (1 << (encodeBits - 10));

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,8 @@ bool raw_processing_helpers::processZSdata(const char* data, size_t size, rdh_ut`
`80`	`80`	`LOGP(debug, "orbit: {}, triggerOrbit: {}, triggerBC: {}, triggerBCOffset: {}", orbit, triggerOrbit, triggerBC, triggerBCOffset);`
`81`	`81`	`zsdata = zsdata->next();`
`82`	`82`	`continue;`
	`83`	`+ } else if (header.isMetaHeader()) {`
	`84`	`+ continue;`
`83`	`85`	`}`
`84`	`86`
`85`	`87`	`const auto channelBits = zsdata->getChannelBits();`
Original file line number	Diff line number	Diff line change
`@@ -507,7 +507,7 @@ void zsEncoderImprovedLinkBased::init()`
`507`	`507`
`508`	`508`	`void zsEncoderImprovedLinkBased::initPage()`
`509`	`509`	`{`
`510`		`- hdr->magicWord = 0x1234;`
	`510`	`+ hdr->magicWord = o2::tpc::zerosupp_link_based::CommonHeader::MagicWordLinkZSMetaHeader;`
`511`	`511`	`hdr->nTimebinHeaders = 0;`
`512`	`512`	`hdr->firstZSDataOffset = 0;`
`513`	`513`	`}`
`@@ -638,7 +638,7 @@ void zsEncoderImprovedLinkBased::decodePage(std::vector<o2::tpc::Digit>& outputB`
`638`	`638`	`if (decHDR->version != 3) {`
`639`	`639`	`throw std::runtime_error("invalid ZS version");`
`640`	`640`	`}`
`641`		`- if (decHDR->magicWord != 0x1234) {`
	`641`	`+ if (decHDR->magicWord != o2::tpc::zerosupp_link_based::CommonHeader::MagicWordLinkZSMetaHeader) {`
`642`	`642`	`throw std::runtime_error("Magic word missing");`
`643`	`643`	`}`
`644`	`644`	`const float decodeBitsFactor = 1.f / (1 << (encodeBits - 10));`