HGCalUnpacker.h

Go to the documentation of this file.

/****************************************************************************
 *
 * This is a part of HGCAL offline software.
 * Authors:
 *   Yulun Miao, Northwestern University
 *   Huilin Qu, CERN
 *   Laurent Forthomme, CERN
 *
 ****************************************************************************/

#ifndef EventFilter_HGCalRawToDigi_HGCalUnpacker_h
#define EventFilter_HGCalRawToDigi_HGCalUnpacker_h

#include "DataFormats/HGCalDigi/interface/HGCROCChannelDataFrame.h"
#include "DataFormats/HGCalDigi/interface/HGCalElectronicsId.h"

#include <cstdint>
#include <functional>
#include <vector>

struct HGCalUnpackerConfig {
  uint32_t sLinkBOE{0x0};               
  uint32_t captureBlockReserved{0x3f};  
  uint32_t econdHeaderMarker{0x154};    
  uint32_t sLinkCaptureBlockMax{10};    
  uint32_t captureBlockECONDMax{12};    
  uint32_t econdERXMax{12};             
  uint32_t erxChannelMax{37};           
  uint32_t payloadLengthMax{469};       
  uint32_t channelMax{7000000};         
  uint32_t commonModeMax{4000000};      
};

template <class D>
class HGCalUnpacker {
public:
  enum SLinkHeaderShift {
    kSLinkBOEShift = 24,
  };
  enum SLinkHeaderMask {
    kSLinkBOEMask = 0b11111111,
  };
  enum CaptureBlockHeaderShift {
    kCaptureBlockReservedShift = 26,
  };
  enum CaptureBlockMask {
    kCaptureBlockReservedMask = 0b111111,
    kCaptureBlockECONDStatusMask = 0b111,
  };
  enum ECONDHeaderShift {
    kHeaderShift = 23,
    kPayloadLengthShift = 14,
    kPassThroughShift = 13,
    kHTShift = 10,
    kEBOShift = 8,
    kMatchShift = 7,
    kTruncatedShift = 6,
  };
  enum ECONDHeaderMask {
    kHeaderMask = 0b111111111,
    kPayloadLengthMask = 0b111111111,
    kPassThroughMask = 0b1,
    kHTMask = 0b11,
    kEBOMask = 0b11,
    kMatchMask = 0b1,
    kTruncatedMask = 0b1,
  };
  enum ERXHeaderShift {
    kFormatShift = 25,
    kCommonmode0Shift = 15,
    kCommonmode1Shift = 5,
  };
  enum ERXHeaderMask {
    kFormatMask = 0b1,
    kCommonmode0Mask = 0b1111111111,
    kCommonmode1Mask = 0b1111111111,
  };

  explicit HGCalUnpacker(HGCalUnpackerConfig config);

  void parseSLink(const std::vector<uint32_t>& inputArray,
                  const std::function<uint16_t(uint16_t sLink, uint8_t captureBlock, uint8_t econd)>& enabledERXMapping,
                  const std::function<D(HGCalElectronicsId elecID)>& logicalMapping);
  void parseCaptureBlock(
      const std::vector<uint32_t>& inputArray,
      const std::function<uint16_t(uint16_t sLink, uint8_t captureBlock, uint8_t econd)>& enabledERXMapping,
      const std::function<D(HGCalElectronicsId elecID)>& logicalMapping);
  void parseECOND(const std::vector<uint32_t>& inputArray,
                  const std::function<uint16_t(uint16_t sLink, uint8_t captureBlock, uint8_t econd)>& enabledERXMapping,
                  const std::function<D(HGCalElectronicsId elecID)>& logicalMapping);

  const std::vector<HGCROCChannelDataFrame<D> >& channelData() const { return channelData_; }
  const std::vector<uint32_t>& commonModeIndex() const { return commonModeIndex_; }
  const std::vector<uint16_t>& commonModeData() const { return commonModeData_; }
  const std::vector<uint32_t>& badECOND() const { return badECOND_; }

private:
  const uint32_t erxBodyLeftShift_[16] = {2, 0, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
  const uint32_t erxBodyRightShift_[16] = {0, 8, 0, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
  const uint32_t erxBodyMask_[16] = {0b00111111111111111111110000000000,
                                     0b00000000000011111111110000000000,
                                     0b00111111111111111111110000000000,
                                     0b00000000000011111111111111111111,
                                     0b00111111111111111111111111111111,
                                     0b00111111111111111111111111111111,
                                     0b00111111111111111111111111111111,
                                     0b00111111111111111111111111111111,
                                     0b11111111111111111111111111111111,
                                     0b11111111111111111111111111111111,
                                     0b11111111111111111111111111111111,
                                     0b11111111111111111111111111111111,
                                     0b11111111111111111111111111111111,
                                     0b11111111111111111111111111111111,
                                     0b11111111111111111111111111111111,
                                     0b11111111111111111111111111111111};
  const uint32_t erxBodyBits_[16] = {24, 16, 24, 24, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32};
  HGCalUnpackerConfig config_;
  size_t channelDataSize_{0};                            
  size_t commonModeDataSize_{0};                         
  std::vector<HGCROCChannelDataFrame<D> > channelData_;  
  std::vector<uint32_t> commonModeIndex_;  
  std::vector<uint16_t> commonModeData_;   
  std::vector<uint32_t> badECOND_;         
};

#endif