CSCDMBTrailer2013.h

Go to the documentation of this file.

#ifndef EventFilter_CSCRawToDigi_CSCDMBTrailer2013_h
#define EventFilter_CSCRawToDigi_CSCDMBTrailer2013_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 <iostream>
#include "DataFormats/CSCDigi/interface/CSCDMBStatusDigi.h"
#include "EventFilter/CSCRawToDigi/interface/CSCDMBHeader.h"
#include "EventFilter/CSCRawToDigi/interface/CSCVDMBTrailerFormat.h"

struct CSCDMBTrailer2013 : public CSCVDMBTrailerFormat {
  // public:
  CSCDMBTrailer2013() {
    bzero(data(), sizeInWords() * 2);
    bits.ddu_code_1 = bits.ddu_code_2 = bits.ddu_code_3 = bits.ddu_code_4 = 0xF;
    bits.ddu_code_5 = bits.ddu_code_6 = bits.ddu_code_7 = bits.ddu_code_8 = 0xE;
  }

  CSCDMBTrailer2013(const uint16_t *buf) { memcpy(data(), buf, sizeInWords() * 2); }

  /*  
  CSCDMBTrailer2013(const CSCDMBStatusDigi & digi) 
    {
      memcpy(this, digi.trailer(), sizeInWords()*2);
    }
*/

  void setEventInformation(const CSCDMBHeader &dmbHeader) override {
    bits.dmb_id = dmbHeader.dmbID();
    bits.crate_id = dmbHeader.crateID();
    bits.dmb_l1a = dmbHeader.l1a();
    bits.dmb_bxn = dmbHeader.bxn();
  };

  unsigned crateID() const override { return bits.crate_id; };
  unsigned dmbID() const override { return bits.dmb_id; };

  unsigned dmb_l1a() const override { return bits.dmb_l1a; };
  unsigned dmb_bxn() const override { return bits.dmb_bxn; };

  unsigned alct_endtimeout() const override { return bits.alct_endtimeout; };
  unsigned tmb_endtimeout() const override { return bits.tmb_endtimeout; };
  unsigned cfeb_endtimeout() const override { return bits.cfeb_endtimeout; };

  unsigned alct_starttimeout() const override { return bits.alct_starttimeout; };
  unsigned tmb_starttimeout() const override { return bits.tmb_starttimeout; };
  unsigned cfeb_starttimeout() const override { return bits.cfeb_starttimeout; };

  unsigned cfeb_movlp() const override { return bits.cfeb_movlp; };
  unsigned dmb_l1pipe() const override { return bits.dmb_l1pipe; };

  unsigned alct_empty() const override { return 0; };
  unsigned tmb_empty() const override { return 0; };
  unsigned cfeb_empty() const override { return 0; };

  unsigned alct_half() const override { return bits.alct_half; };
  unsigned tmb_half() const override { return bits.tmb_half; };
  unsigned cfeb_half() const override { return bits.cfeb_half; };

  unsigned alct_full() const override { return bits.alct_full; };
  unsigned tmb_full() const override { return bits.tmb_full; };
  unsigned cfeb_full() const override { return (bits.cfeb_full_lowo | (bits.cfeb_full_hiwo << 3)); };

  unsigned crc22() const override { return (bits.dmb_crc_1 | (bits.dmb_crc_2 << 11)); };
  unsigned crc_lo_parity() const override { return bits.dmb_parity_1; };
  unsigned crc_hi_parity() const override { return bits.dmb_parity_2; };

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

  bool check() const override {
    return bits.ddu_code_1 == 0xF && bits.ddu_code_2 == 0xF && bits.ddu_code_3 == 0xF && bits.ddu_code_4 == 0xF &&
           bits.ddu_code_5 == 0xE && bits.ddu_code_6 == 0xE && bits.ddu_code_7 == 0xE && bits.ddu_code_8 == 0xE;
  }

  unsigned sizeInWords() const override { return 8; }

  struct {
    unsigned dmb_l1a : 6;          
    unsigned dmb_bxn : 5;          
    unsigned alct_endtimeout : 1;  
    unsigned ddu_code_1 : 4;       

    unsigned cfeb_endtimeout : 7;  
    unsigned cfeb_movlp : 5;       
    unsigned ddu_code_2 : 4;       

    unsigned dmb_l1pipe : 8;        
    unsigned tmb_starttimeout : 1;  
    unsigned cfeb_full_lowo : 3;    
    unsigned ddu_code_3 : 4;        

    unsigned cfeb_full_hiwo : 4;     
    unsigned cfeb_starttimeout : 7;  
    unsigned alct_starttimeout : 1;  
    unsigned ddu_code_4 : 4;         

    unsigned cfeb_half : 7;       
    unsigned tmb_endtimeout : 1;  
    unsigned tmb_half : 1;        
    unsigned alct_half : 1;       
    unsigned tmb_full : 1;        
    unsigned alct_full : 1;       
    unsigned ddu_code_5 : 4;      

    unsigned dmb_id : 4;      
    unsigned crate_id : 8;    
    unsigned ddu_code_6 : 4;  

    unsigned dmb_crc_1 : 11;    
    unsigned dmb_parity_1 : 1;  
    unsigned ddu_code_7 : 4;    

    unsigned dmb_crc_2 : 11;    
    unsigned dmb_parity_2 : 1;  
    unsigned ddu_code_8 : 4;    
  } bits;
};

#endif