HcalDCCHeader.h

Go to the documentation of this file.

/* -*- C++ -*- */
#ifndef HcalDCCHeader_H
#define HcalDCCHeader_H

#include <iostream>
#include "DataFormats/HcalDigi/interface/HcalCalibrationEventTypes.h"
class HcalHTRData;

class HcalDCCHeader {
 public:
  static const int SPIGOT_COUNT;

  HcalDCCHeader();

  unsigned int getTotalLengthBytes() const; 


  inline bool thereIsASecondCDFHeaderWord() const {return ((commondataformat0>>3) & 0x0001); }
  inline short getCDFversionNumber() const {return ((commondataformat0>>4) & 0x0F); }
  inline int getSourceId() const { return (commondataformat0>>8)&0xFFF; }
  inline int getBunchId() const { return (commondataformat0>>20)&0xFFF; }
  inline unsigned long getDCCEventNumber() const { return (commondataformat1 & 0x00FFFFFF); }
  inline unsigned short getCDFEventType() const { return ( (commondataformat1>>24) & 0x0F ); }
  inline unsigned short BOEshouldBe5Always() const { return ( (commondataformat1>>28) & 0x0F ); }


  inline bool thereIsAThirdCDFHeaderWord() const {return ((commondataformat2>>3) & 0x0001); }
  inline unsigned int getOrbitNumber() const { return ( ((commondataformat3 & 0xF) << 28) + ( commondataformat2>>4) ); }
  inline unsigned int getSlink64ReservedBits() const { return (  (commondataformat3>>4)&0x00FFFFFF ); }
  inline short BOEshouldBeZeroAlways() const { return ( (commondataformat3>>28) & 0x0F); }

  inline bool isCalibType() const { return ( 0 != getCalibType ());}
  inline HcalCalibrationEventType  getCalibType() const { return HcalCalibrationEventType ((commondataformat3>>24)&0x0000000F);}

  inline short getDCCDataFormatVersion() const { return (dcch0 & 0xFF); }
  inline int getAcceptTimeTTS() const { return ((dcch0>>8)& 0x0000000F); }
  inline int getByte1Zeroes() const {  return ((dcch0>>12)& 0x00000003); }
  inline int getHTRStatusBits () const { return ((dcch0>>14)& 0x00007FFF); }
  inline int getByte3Zeroes() const {  return ((dcch0>>29)& 0x00000007); }
  inline int getDCCStatus() const {return (dcch1 & 0x000003FF);}
  inline int getByte567Zeroes() const {  return (dcch1 & 0xFF00FC00); }

  inline bool getSpigotErrorFlag(int nspigot) const { 
    return (( dcch0>>(14+nspigot) )&0x0001);  }

  inline bool SawTTS_OFW()        const { return ((getDCCStatus()>>0) & 0x00000001);}
  inline bool SawTTS_BSY()        const { return ((getDCCStatus()>>1) & 0x00000001);}
  inline bool SawTTS_SYN()        const { return ((getDCCStatus()>>2) & 0x00000001);}
  inline bool SawL1A_EvN_MxMx()   const { return ((getDCCStatus()>>3) & 0x00000001);}
  inline bool SawL1A_BcN_MxMx()   const { return ((getDCCStatus()>>4) & 0x00000001);}
  inline bool SawCT_EvN_MxMx()    const { return ((getDCCStatus()>>5) & 0x00000001);}
  inline bool SawCT_BcN_MxMx()    const { return ((getDCCStatus()>>6) & 0x00000001);}
  inline bool SawOrbitLengthErr() const { return ((getDCCStatus()>>7) & 0x00000001);}
  inline bool SawTTC_SingErr()    const { return ((getDCCStatus()>>8) & 0x00000001);}
  inline bool SawTTC_DoubErr()    const { return ((getDCCStatus()>>9) & 0x00000001);}

  inline int getSpigotSummary(int nspigot) const { return spigotInfo[nspigot]; }

  int getSpigotData(int nspigot, HcalHTRData& decodeTool, int validSize) const;

  void getSpigotData(int nspigot, HcalHTRData& decodeTool) const;

  inline unsigned int getSpigotDataLength(int nspigot) const { return (nspigot>=15)?(0):(spigotInfo[nspigot]&0x3ff); }

  inline bool getSpigotEnabled(unsigned int nspigot) const { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x8000); }
  inline bool getSpigotPresent(unsigned int nspigot) const { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x4000); }
  inline bool getBxMismatchWithDCC(unsigned int nspigot) const { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x2000); }
  inline bool getSpigotValid(unsigned int nspigot) const { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x1000); }
  inline bool getSpigotDataTruncated(unsigned int nspigot) const { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x0800); }
  inline bool getSpigotCRCError(unsigned int nspigot) const { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x0400); }
  inline unsigned char getSpigotErrorBits(unsigned int nspigot) const { return (nspigot>=15)?(0):((unsigned char)(spigotInfo[nspigot]>>24)); }
  inline unsigned char getLRBErrorBits(unsigned int nspigot) const { return (nspigot>=15)?(0):((unsigned char)(spigotInfo[nspigot]>>16)); }

  /* (for packing only) */
  void copySpigotData(unsigned int spigot_id, const HcalHTRData& data, bool valid=true, unsigned char LRB_error_word=0);

  void clear();
  void setHeader(int sourceid, int bcn, int l1aN, int orbN);

 private:
  // CURRENTLY VALID FOR LITTLE-ENDIAN (LINUX/x86) ONLY
  uint32_t commondataformat0;
  uint32_t commondataformat1;
  uint32_t commondataformat2;
  uint32_t commondataformat3;
  uint32_t dcch0;
  uint32_t dcch1;
  uint32_t spigotInfo[18];   //The last three of these 32bit words should always be zero!

};

std::ostream& operator<<(std::ostream&, const HcalDCCHeader& head);

#endif