PXDRawDataStructs.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <pxd/dataobjects/PXDErrorFlags.h>
 
#include <boost/endian/arithmetic.hpp>
 
 
 
namespace Belle2 {
  namespace PXD {
 
    using ulittle16_t = boost::endian::little_uint16_t;
    using ulittle32_t = boost::endian::little_uint32_t;
    using ubig16_t = boost::endian::big_uint16_t;
    using ubig32_t = boost::endian::big_uint32_t;
 
    using Belle2::PXD::PXDError::PXDErrorFlags;
 
    struct dhc_frame_header_word0 {
      const ubig16_t data;
 
      inline ubig16_t getData(void) const
      {
        return data;
      };
      inline unsigned short getFrameType(void) const
      {
        return (data & 0x7800) >> 11;
      };
      inline unsigned short getErrorFlag(void) const
      {
        return (data & 0x8000) >> 15;
      };
      inline unsigned short getMisc(void) const
      {
        return data & 0x7FF;
      };
      void print(void) const;
    };
 
    struct dhc_start_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trigger_nr_lo; 
      const ubig16_t trigger_nr_hi; 
      const ubig16_t time_tag_lo_and_type; 
      const ubig16_t time_tag_mid; 
      const ubig16_t time_tag_hi; 
      const ubig16_t run_subrun; 
      const ubig16_t exp_run; 
      const unsigned int crc32; 
      // fixed length, only for reading
 
      inline unsigned short getRunSubrun(void) const
      {
        return run_subrun;
      };
      inline unsigned short getExpRun(void) const
      {
        return exp_run;
      };
      inline unsigned short getEventNrLo(void) const
      {
        return trigger_nr_lo;
      };
      inline unsigned short getEventNrHi(void) const
      {
        return trigger_nr_hi;
      };
 
      bool isFakedData(void) const;
      inline unsigned int getFixedSize(void) const
      {
        return 20;
      };
      void print(void) const;
      inline unsigned short get_active_dhe_mask(void) const
      {
        return word0.getMisc() & 0x1F;
      };
      inline unsigned short get_dhc_id(void) const
      {
        return (word0.getMisc() >> 5) & 0xF;
      };
      inline unsigned short get_subrun(void) const
      {
        return run_subrun & 0x00FF;
      };
      inline unsigned short get_run(void) const
      {
        return (((run_subrun & 0xFF00) >> 8)  | ((exp_run & 0x003F) << 8));
      };
      inline unsigned short get_experiment(void) const
      {
        return (exp_run & 0xFFC0) >> 6;
      };
      inline unsigned short get_gated_flag(void) const
      {
        return (word0.getMisc() & 0x200) != 0;
      };
      inline unsigned short get_gated_isher(void) const
      {
        return (word0.getMisc() & 0x400) != 0;
      };
    };
 
    struct dhc_dhe_start_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trigger_nr_lo; 
      const ubig16_t trigger_nr_hi; 
      const ubig16_t dhe_time_tag_lo; 
      const ubig16_t dhe_time_tag_hi; 
      const ubig16_t sfnr_offset; 
      const unsigned int crc32; 
      // fixed length
 
      inline unsigned short getEventNrLo(void) const
      {
        return trigger_nr_lo;
      };
      inline unsigned short getEventNrHi(void) const
      {
        return trigger_nr_hi;
      };
      inline unsigned short getStartFrameNr(void) const
      {
        return (sfnr_offset & 0xFC00) >> 10;
      };
      inline unsigned short getTriggerGate(void) const
      {
        return sfnr_offset & 0xFF;
      };
      inline unsigned int getFixedSize(void) const
      {
        return 16;
      };
      void print(void) const;
      inline unsigned int getActiveDHPMask(void) const
      {
        return word0.getMisc() & 0xF;
      };
      inline unsigned int getDHEId(void) const
      {
        return (word0.getMisc() >> 4) & 0x3F;
      };
    };
 
    struct dhc_commode_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trigger_nr_lo; 
      const ubig16_t data[96]; 
      const unsigned int crc32; 
      // fixed length
 
      inline unsigned short getEventNrLo(void) const
      {
        return trigger_nr_lo;
      };
      inline unsigned int getFixedSize(void) const
      {
        return (4 + 96) * 2;
      };
      inline unsigned int getDHEId(void) const
      {
        return (word0.getMisc() >> 4) & 0x3F;
      };
    };
 
    struct dhc_direct_readout_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trigger_nr_lo; 
      // an unbelievable amount of words may follow
      // and finally a 32 bit checksum
 
      inline unsigned short getEventNrLo(void) const
      {
        return trigger_nr_lo;
      };
      void print(void) const;
      inline unsigned short getDHEId(void) const
      {
        return (word0.getMisc() >> 4) & 0x3F;
      };
      inline unsigned short getDHPPort(void) const
      {
        return (word0.getMisc()) & 0x3;
      };
      inline bool getDataReformattedFlag(void) const
      {
        return (word0.getMisc() >> 3) & 0x1;
      };
    };
 
    struct dhc_direct_readout_frame_raw : public dhc_direct_readout_frame {
    };
 
    struct dhc_direct_readout_frame_zsd : public dhc_direct_readout_frame {
    };
 
    struct dhc_onsen_trigger_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trignr0; 
      const ubig32_t magic1; 
      const ubig32_t trignr1; 
      const ubig32_t trigtag1; 
      const ubig32_t magic2; 
      const ubig32_t trignr2; 
      const ubig32_t trigtag2; 
      const unsigned int crc32; 
 
      inline unsigned int getFixedSize(void) const
      {
        return 32;
      };
      inline unsigned short get_trig_nr0(void) const
      {
        return trignr0;
      };
      inline unsigned int get_trig_nr1(void) const
      {
        return trignr1;
      };
      inline unsigned int get_trig_nr2(void) const
      {
        return trignr2;
      };
      inline unsigned int get_trig_tag1(void) const
      {
        return trigtag1;
      };
      inline unsigned int get_trig_tag2(void) const
      {
        return trigtag2;
      };
      inline unsigned short get_subrun1(void) const
      {
        return trigtag1 & 0xFF;
      };
      inline unsigned short get_run1(void) const
      {
        return ((trigtag1 & 0x003FFF00) >> 8);
      };
      inline unsigned short get_experiment1(void) const
      {
        return (trigtag1 & 0xFFC00000) >> 22;
      };
      inline unsigned short get_subrun2(void) const
      {
        return trigtag2 & 0xFF;
      };
      inline unsigned short get_run2(void) const
      {
        return ((trigtag2 & 0x003FFF00) >> 8);
      };
      inline unsigned short get_experiment2(void) const
      {
        return (trigtag2 & 0xFFC00000) >> 22;
      };
      void print(void) const;
 
      void check_error(
        PXDErrorFlags& errormask,
        bool ignore_datcon_flag = false,
        bool ignore_hltroi_magic_flag = false,
        bool ignore_merger_mm_flag = false
      ) const;
 
      inline bool is_fake_datcon(void) const
      {
        return (magic2 == 0xCAFE0000 && trignr2 == 0x00000000 && trigtag2 == 0x00000000);
      };
      inline bool is_Accepted(void) const
      {
        return (magic1 & 0x8000) != 0;
      };
      inline bool is_SendROIs(void) const
      {
        return (magic1 & 0x2000) != 0;
      };
      inline bool is_SendUnfiltered(void) const
      {
        return (magic1 & 0x4000) != 0;
      };
    };
 
    struct dhc_onsen_roi_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trignr0; 
      // plus n* ROIs (64 bit)
      // plus inner checksum 32bit
      // plus checksum 32bit
 
      inline unsigned short get_trig_nr0(void) const
      {
        return trignr0;
      };
      void check_error(
        PXDErrorFlags& errormask,
        int length,
        bool ignore_inv_size_flag = false
      ) const;
      void print(void) const;
      inline int getMinSize(void) const {return 4 + 4 + 4;};
      unsigned int check_inner_crc(PXDErrorFlags& /*errormask*/, unsigned int /*length*/) const
      {
        // Parts of the data are now in the ONSEN Trigger frame,
        // therefore the inner CRC cannot be checked that easily!
        // TODO can be re-implemented if needed
        return 0;
      };
    };
 
    struct dhc_ghost_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trigger_nr_lo; 
      const unsigned int crc32; 
 
      inline unsigned int getFixedSize(void) const
      {
        return 8;
      };
      void print(void) const;
      inline unsigned short getDHEId(void) const
      {
        return (word0.getMisc() >> 4) & 0x3F;
      };
      inline unsigned short getDHPPort(void) const
      {
        return (word0.getMisc()) & 0x3;
      };
      unsigned short getErrorBits(void) const;
    };
 
    struct dhc_end_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trigger_nr_lo; 
      const ubig32_t wordsinevent; 
      const ubig32_t errorinfo; 
      const unsigned int crc32; 
      // fixed length
 
      unsigned int get_words(void) const
      {
        return wordsinevent;
      }
      inline unsigned int getFixedSize(void) const
      {
        return 16;
      };
      bool isFakedData(void) const;
      void print(void) const;
      inline unsigned int get_dhc_id(void) const
      {
        return (word0.getMisc() >> 5) & 0xF;
      };
      inline unsigned int getErrorInfo(void) const
      {
        return errorinfo;
      };
    };
 
    struct dhc_dhe_end_frame {
      const dhc_frame_header_word0 word0; 
      const ubig16_t trigger_nr_lo; 
      const ubig16_t wordsineventlo; 
      const ubig16_t wordsineventhi; 
      const ubig32_t errorinfo; 
      const unsigned int crc32; 
      // fixed length
 
      unsigned int get_words(void) const
      {
        return wordsineventlo | ((unsigned int)wordsineventhi << 16);
      }
      inline unsigned int getFixedSize(void) const
      {
        return 16;
      };
      void print(void) const;
      inline unsigned int getDHEId(void) const
      {
        return (word0.getMisc() >> 4) & 0x3F;
      };
      inline unsigned int getErrorInfo(void) const
      {
        return errorinfo;
      };
      unsigned int getErrorStateMachineDHP(int dhpid) const;
      unsigned int getErrorStateMachineStartDHP(int dhpid) const;
      unsigned int getErrorStateMachineEndDHP(int dhpid) const;
    };
 
 
 
    class dhc_frames {
    public:
      union {
        const void* data; 
        const dhc_onsen_trigger_frame* data_onsen_trigger_frame; 
        const dhc_start_frame* data_dhc_start_frame; 
        const dhc_end_frame* data_dhc_end_frame; 
        const dhc_dhe_start_frame* data_dhe_start_frame; 
        const dhc_dhe_end_frame* data_dhe_end_frame; 
        const dhc_commode_frame* data_commode_frame; 
        const dhc_direct_readout_frame* data_direct_readout_frame; 
        const dhc_direct_readout_frame_raw* data_direct_readout_frame_raw; 
        const dhc_direct_readout_frame_zsd* data_direct_readout_frame_zsd; 
        const dhc_ghost_frame* data_ghost_frame; 
        const dhc_onsen_roi_frame* data_onsen_roi_frame; 
      };
      unsigned int datasize; 
      int type; 
      int length; 
 
      dhc_frames(void)
      {
        data = 0;
        datasize = 0;
        type = -1;
        length = 0;
      };
      int getFrameType(void)
      {
        return type;
      };
      void set(const void* d, unsigned int t)
      {
        data = d;
        type = t;
        length = 0;
      };
      void set(const void* d, unsigned int t, unsigned int l)
      {
        data = d;
        type = t;
        length = l;
      };
      void set(const void* d)
      {
        data = d;
        type = reinterpret_cast <const dhc_frame_header_word0*>(data)->getFrameType();
        length = 0;
      };
      inline unsigned int getEventNrLo(void) const
      {
        return ((ubig16_t*)data)[1];
      };
      void check_padding(PXDErrorFlags& errormask);
      void check_crc(PXDErrorFlags& errormask, bool ignore_crc_flag = false);
 
      unsigned int getFixedSize(void);
 
    };
  };
};