PXDUnpackerModule.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 <framework/core/Module.h>
#include <framework/datastore/StoreArray.h>
#include <framework/datastore/StoreObjPtr.h>
 
#include <pxd/dataobjects/PXDDAQStatus.h>
#include <pxd/dataobjects/PXDErrorFlags.h>
 
#include <framework/database/DBObjPtr.h>
 
namespace Belle2 {
  class RawPXD;
  class EventMetaData;
  class PXDRawHit;
  class PXDRawROIs;
  class PXDRawAdc;
  class PXDDHHFirmwareVersionPar;
  class VxdID;
 
  namespace PXD {


    class PXDUnpackerModule : public Module {
 
    public:
      PXDUnpackerModule();
 
    private:

      void initialize() override final;
      void beginRun() override final;
      void event() override final;
      void terminate() override final;
 
      std::string m_RawPXDsName;  
      std::string m_PXDDAQEvtStatsName;  
      std::string m_PXDRawHitsName;  
      std::string m_PXDRawAdcsName;  
      std::string m_PXDRawROIsName;  

      bool m_doNotStore{false};
      bool m_checkPaddingCRC{false};
      bool m_forceMapping{false};
      bool m_forceNoMapping{false};
      unsigned int m_maxDHPFrameDiff{0};

      int m_firmware{0};

      PXDError::PXDErrorFlags m_criticalErrorMask{};
      PXDError::PXDErrorFlags m_suppressErrorMask{};
      PXDError::PXDErrorFlags m_errorSkipPacketMask{};

      unsigned long m_meta_event_nr{0};
      unsigned long m_meta_run_nr{0};
      unsigned long m_meta_subrun_nr{0};
      unsigned long m_meta_experiment{0};
      unsigned long long int m_meta_time{0};
      unsigned int m_meta_sec{0};
      unsigned int m_meta_ticks{0};

      unsigned int m_unpackedEventsCount{0};
      unsigned int m_errorCounter[PXDError::ONSEN_MAX_TYPE_ERR] {};
      bool m_verbose{false};
      bool m_continueOnError{false};

      StoreArray<RawPXD> m_storeRawPXD;
      StoreObjPtr<EventMetaData> m_eventMetaData;
      StoreArray<PXDRawHit> m_storeRawHits;
      StoreArray<PXDRawROIs> m_storeROIs;
      StoreObjPtr<PXDDAQStatus> m_storeDAQEvtStats;
      StoreArray<PXDRawAdc> m_storeRawAdc;

      PXDError::PXDErrorFlags m_errorMask{0};
      PXDError::PXDErrorFlags m_errorMaskDHE{0};
      PXDError::PXDErrorFlags m_errorMaskDHC{0};
      PXDError::PXDErrorFlags m_errorMaskPacket{0};
      PXDError::PXDErrorFlags m_errorMaskEvent{0};

      unsigned int m_notaccepted{0};
      unsigned int m_sendrois{0};
      unsigned int m_sendunfiltered{0};
      bool m_formatBonnDAQ{false};

      int m_last_dhp_readout_frame_lo[4] { -1}; // signed because -1 means undefined

      OptionalDBObjPtr<PXDDHHFirmwareVersionPar> m_firmwareFromDB{"PXDDHHFirmwareVersion"};
      int m_overrideFirmwareVersion{0};

      void unpack_rawpxd(RawPXD& px, int inx);


      void unpack_dhc_frame_v01(void* data, const int length, const int Frame_Number, const int Frames_in_event,
                                PXDDAQPacketStatus& daqpktstat);

      void unpack_dhp_v01(void* data, unsigned int length, unsigned int dhe_first_readout_frame_lo, unsigned int dhe_ID,
                          unsigned dhe_DHPport,
                          unsigned dhe_reformat, VxdID vxd_id, PXDDAQPacketStatus& daqpktstat);


      void unpack_dhc_frame_v10(void* data, const int length, const int Frame_Number, const int Frames_in_event,
                                PXDDAQPacketStatus& daqpktstat);

      void unpack_dhp_v10(void* data, unsigned int length, unsigned int dhe_first_readout_frame_lo, unsigned int dhe_ID,
                          unsigned dhe_DHPport,
                          unsigned dhe_reformat, VxdID vxd_id, PXDDAQPacketStatus& daqpktstat);


      void unpack_dhp_raw(void* data, unsigned int length, unsigned int dhe_ID, unsigned dhe_DHPport, VxdID vxd_id);

      void unpack_fce(unsigned short* data, unsigned int length, VxdID vxd_id);
 
    public:
      static int nr5bits(int i);

      static void dump_dhp(void* data, unsigned int frame_len);

      static void dump_roi(void* data, unsigned int frame_len);
 
    };//end class declaration
 
 
  } //end PXD namespace;
} // end namespace Belle2