GEMVFAT

VFATfirst

VFATsecond

VFATthird

Macros

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
#ifndef DataFormats_GEMDigi_GEMVFAT_h
#define DataFormats_GEMDigi_GEMVFAT_h
#include <cstdint>

class GEMVFAT {
public:
  /// VFAT data structure - 3 words of 64 bits each
  union VFATfirst {
    uint64_t word;
    // v3 dataformat
    struct {
      uint64_t msData1 : 16;  ///<channels from 65to128
      uint64_t bc : 16;       ///<Bunch Crossing number, 16 bits
      uint64_t ec : 8;        ///<Event Counter, 8 bits
      uint64_t header : 8;    ///<normally 0x1E. 0x5E indicates that the VFAT3 internal buffer
      // is half-full, so it's like a warning
      uint64_t vc : 1;   /// VFAT CRC Error
      uint64_t : 7;      // unused
      uint64_t pos : 5;  // VFAT position on chamber, 5 used in GE11 but more is needed for phase2
      uint64_t : 3;      // unused
    };
    // v2 dataformat
    struct {
      uint64_t msData1v2 : 16;  ///<channels from 65to128 - placeholder since msData1 reads same info
      uint64_t chipID : 12;     ///<Chip ID, 12 bits
      uint64_t b1110 : 4;       ///<1110:4 Control bits, shoud be 1110
      uint64_t flag : 4;        ///<Control Flags: 4 bits, Hamming Error/AFULL/SEUlogic/SUEI2C
      uint64_t ecV2 : 8;        ///<Event Counter, 8 bits
      uint64_t b1100 : 4;       ///<1100:4, Control bits, shoud be 1100
      uint64_t bcV2 : 12;       ///<Bunch Crossing number, 12 bits
      uint64_t b1010 : 4;       ///<1010:4 Control bits, shoud be 1010
    };
  };
  union VFATsecond {
    uint64_t word;
    struct {
      uint64_t lsData1 : 16;  ///<channels from 1to64
      uint64_t msData2 : 48;  ///<channels from 65to128
    };
  };
  union VFATthird {
    uint64_t word;
    struct {
      uint64_t crc : 16;      ///<Check Sum value, 16 bits
      uint64_t lsData2 : 48;  ///<channels from 1to64
    };
  };

  GEMVFAT();
  // this constructor only used for packing sim digis
  GEMVFAT(const int vfatVer,
          const uint16_t BC,
          const uint32_t EC,
          const uint16_t chipID,
          const uint64_t lsDatas,
          const uint64_t msDatas);
  ~GEMVFAT() {}

  //!Read first word from the block.
  void read_fw(uint64_t word) { fw_ = word; }
  uint64_t get_fw() const { return fw_; }

  //!Read second word from the block.
  void read_sw(uint64_t word) { sw_ = word; }
  uint64_t get_sw() const { return sw_; }

  //!Read third word from the block.
  void read_tw(uint64_t word) { tw_ = word; }
  uint64_t get_tw() const { return tw_; }

  // local phi in chamber
  void setPhi(int i) { phiPos_ = i; }
  int phi() const { return phiPos_; }

  uint64_t lsData() const { return uint64_t(VFATsecond{sw_}.lsData1) << 48 | VFATthird{tw_}.lsData2; }
  uint64_t msData() const { return uint64_t(VFATfirst{fw_}.msData1) << 48 | VFATsecond{sw_}.msData2; }

  uint16_t bc() const {
    if (ver_ == 2)
      return VFATfirst{fw_}.bcV2;
    return VFATfirst{fw_}.bc;
  }
  uint8_t ec() const {
    if (ver_ == 2)
      return VFATfirst{fw_}.ecV2;
    return VFATfirst{fw_}.ec;
  }
  uint16_t vfatId() const {
    if (ver_ == 2)
      return VFATfirst{fw_}.chipID;
    return VFATfirst{fw_}.pos;
  }

  void setVersion(int i) { ver_ = i; }
  int version() const { return ver_; }

  /// quality flag - bit: 0 good, 1 crc fail, 2 b1010 fail, 3 b1100 fail, 4 b1110
  uint8_t quality();

  /// v3
  uint8_t header() const { return VFATfirst{fw_}.header; }
  bool vc() const { return VFATfirst{fw_}.vc; }
  uint8_t position() const { return VFATfirst{fw_}.pos; }
  uint8_t crcCheck() const { return VFATfirst{fw_}.vc; }  // to be removed

  /// v2
  uint8_t b1010() const { return VFATfirst{fw_}.b1010; }
  uint8_t b1100() const { return VFATfirst{fw_}.b1100; }
  uint8_t b1110() const { return VFATfirst{fw_}.b1110; }
  uint8_t flag() const { return VFATfirst{fw_}.flag; }
  uint16_t chipID() const { return VFATfirst{fw_}.chipID; }
  uint16_t crc() const { return VFATthird{tw_}.crc; }

  uint16_t crc_cal(uint16_t crc_in, uint16_t dato);
  uint16_t checkCRC();

  static const int nChannels = 128;
  static const int sizeChipID = 12;

private:
  int ver_;     /// vfat version
  int phiPos_;  /// phi position of vfat in chamber

  uint64_t fw_;  // VFAT first word
  uint64_t sw_;  // VFAT second word
  uint64_t tw_;  // VFAT third word
};

#endif