db/daa/CSCDMBHeader2013_8h_source.html

#ifndef EventFilter_CSCRawToDigi_CSCDMBHeader2013_h

#define EventFilter_CSCRawToDigi_CSCDMBHeader2013_h


/*

 DMB-DDU 2013 Header/Trailer bit definitions (some bits get repeated for bit error mitigation)


    DMB_L1A:    L1A Event Number, count from DMB

    DMB_BXN:    Bunch Crossing Number, count from DMB

    TMB_DAV:    non-zero indicates TMB data exists for this event

    ALCT_DAV:    non-zero indicates ALCT data exists for this event

    CFEB_CLCT_SENT:    indicates which CFEBs should have sent data to DMB

    CFEB_DAV:    indicates which CFEBs have sent data to DMB

    CLCT-DAV-Mismatch:    the CFEB_DAVs do not match the CLCTs sent

    DMB_CRATE:    peripheral crate ID from DMB

    DMB_ID:    board number of DMB

    CFEB_MOVLP:    the time sample for this event has multiple overlaps with samples from previous events

    DMB-CFEB-Sync:    bits used for DMB-CFEB synchronization check

    ALCT_HALF:    zero indicates that the ALCT FIFO on the DMB is half-full

    TMB_HALF:    zero indicates that the TMB FIFO on the DMB is half-full

    CFEB_HALF:    zero indicates that the CFEB FIFO on the DMB is half-full

    DMB_L1PIPE:    number of L1A Events backed-up in the DMB

    ALCT_EMPTY:    one indicates that the ALCT FIFO on the DMB is empty

    TMB_EMPTY:    one indicates that the TMB FIFO on the DMB is empty

    CFEB_EMPTY:    one indicates that the CFEB FIFO on the DMB is empty

    ALCT_Start_Timeout:    indicates that the start of ALCT data was not detected within the time-out period

    TMB_Start_Timeout:    indicates that the start of TMB data was not detected within the time-out period

    CFEB_Start_Timeout:    indicates that the start of CFEB data was not detected within the time-out period.

    CFEB_End_Timeout:    indicates that the end of CFEB data was not detected within the time-out period

    ALCT_End_Timeout:    indicates that the end of ALCT data was not detected within the time-out period

    TMB_End_Timeout:    indicates that the end of TMB data was not detected within the time-out period

    ALCT_FULL:    one indicates that the ALCT FIFO on the DMB is full

    TMB_FULL:    one indicates that the TMB FIFO on the DMB is full

    CFEB_FULL:    one indicates that the CFEB FIFO on the DMB is full

    DMB_CRC:    each DMB generates a 22-bit CRC that encompasses all CSC data from the first 9-code to the last F-code in the event

 */


#include <cassert>

#include <iosfwd>

#include <cstring>  // bzero

#include "DataFormats/CSCDigi/interface/CSCDMBStatusDigi.h"

#include "EventFilter/CSCRawToDigi/interface/CSCVDMBHeaderFormat.h"


struct CSCDMBHeader2013 : public CSCVDMBHeaderFormat {

  // public:


  CSCDMBHeader2013();


  CSCDMBHeader2013(const uint16_t *buf);

  /*

  CSCDMBHeader2013(const CSCDMBStatusDigi & digi)

    {

      memcpy(this, digi.header(), sizeInWords()*2);

    }

*/

  bool cfebAvailable(unsigned icfeb) override;


  void addCFEB(int icfeb) override;

  void addNCLCT() override;

  void addNALCT() override;

  void setBXN(int bxn) override;

  void setL1A(int l1a) override;

  void setL1A24(int l1a) override;

  void setCrateAddress(int crate, int dmbId) override;

  void setdmbID(int newDMBID) override { bits.dmb_id = newDMBID; }

  void setdmbVersion(unsigned int version) override { bits.fmt_version = (version < 4) ? version : 0; }


  unsigned cfebActive() const override { return bits.cfeb_clct_sent; }

  unsigned crateID() const override;

  unsigned dmbID() const override;

  unsigned bxn() const override;

  unsigned bxn12() const override;

  unsigned l1a() const override;

  unsigned l1a24() const override;

  unsigned cfebAvailable() const override;

  unsigned nalct() const override;

  unsigned nclct() const override;

  unsigned cfebMovlp() const override;

  unsigned dmbCfebSync() const override;

  unsigned activeDavMismatch() const override;

  unsigned format_version() const override;


  unsigned sizeInWords() const override;


  bool check() const override;


  unsigned short *data() override { return (unsigned short *)(&bits); }

  unsigned short *data() const override { return (unsigned short *)(&bits); }


  //ostream & operator<<(ostream &, const CSCDMBHeader &);


  // private:


  struct {

    unsigned dmb_l1a_lowo : 12;

    unsigned newddu_code_1 : 4;


    unsigned dmb_l1a_hiwo : 12;

    unsigned newddu_code_2 : 4;


    unsigned cfeb_clct_sent : 7;

    unsigned clct_dav_mismatch : 1;

    unsigned fmt_version : 2;

    unsigned tmb_dav : 1;

    unsigned alct_dav : 1;

    unsigned newddu_code_3 : 4;


    unsigned dmb_bxn1 : 12;

    unsigned newddu_code_4 : 4;


    unsigned cfeb_dav : 7;

    unsigned clct_dav_mismatch_copy : 1;

    unsigned fmt_version_copy : 2;

    unsigned tmb_dav_copy : 1;

    unsigned alct_dav_copy : 1;

    unsigned ddu_code_1 : 4;


    unsigned dmb_id : 4;

    unsigned dmb_crate : 8;

    unsigned ddu_code_2 : 4;


    unsigned dmb_bxn : 5;

    unsigned cfeb_movlp : 5;

    unsigned tmb_dav_copy2 : 1;

    unsigned alct_dav_copy2 : 1;

    unsigned ddu_code_3 : 4;


    unsigned dmb_l1a : 5;

    unsigned clct_dav_mismatch_copy2 : 1;

    unsigned fmt_version_copy2 : 2;

    unsigned dmb_cfeb_sync : 4;

    unsigned ddu_code_4 : 4;

  } bits;

};


#endif