DHC frame wrapper class. More...

#include <PXDRawDataStructs.h>

Public Member Functions
	dhc_frames (void)
	set default values

int	getFrameType (void)
	get type of frame

void	set (const void *d, unsigned int t)
	set data and type (and length to 0)

void	set (const void *d, unsigned int t, unsigned int l)
	set data, type and length

void	set (const void *d)
	set data (get type from dhc_frame_header_word0 and set length to 0)

unsigned int	getEventNrLo (void) const
	get event nr lo (from data)

void	check_padding (PXDErrorFlags &errormask)
	check padding and return it

void	check_crc (PXDErrorFlags &errormask, bool ignore_crc_flag=false)
	check crc and return it

unsigned int	getFixedSize (void)
	get fixed size

Public Attributes
union {

const void * data
	no type More...

const dhc_onsen_trigger_frame * data_onsen_trigger_frame
	data_onsen_trigger_frame More...

const dhc_start_frame * data_dhc_start_frame
	data_dhc_start_frame More...

const dhc_end_frame * data_dhc_end_frame
	data_dhc_end_frame More...

const dhc_dhe_start_frame * data_dhe_start_frame
	data_dhe_start_frame More...

const dhc_dhe_end_frame * data_dhe_end_frame
	data_dhe_end_frame More...

const dhc_commode_frame * data_commode_frame
	data_commode_frame More...

const dhc_direct_readout_frame * data_direct_readout_frame
	data_direct_readout_frame More...

const dhc_direct_readout_frame_raw * data_direct_readout_frame_raw
	data_direct_readout_frame_raw More...

const dhc_direct_readout_frame_zsd * data_direct_readout_frame_zsd
	data_direct_readout_frame_zsd More...

const dhc_ghost_frame * data_ghost_frame
	data_ghost_frame More...

const dhc_onsen_roi_frame * data_onsen_roi_frame
	data_onsen_roi_frame More...

};

unsigned int	datasize
	datasize

int	type
	type

int	length
	length

Detailed Description

DHC frame wrapper class.

Contains functions common for all type of frames (CRC etc) Provides a union pointer to the different struct types See Data format definitions [BELLE2-NOTE-TE-2016-009] on https://docs.belle2.org/

Definition at line 550 of file PXDRawDataStructs.h.

Constructor & Destructor Documentation

◆ dhc_frames()

dhc_frames ( void )

inline

set default values

Definition at line 571 of file PXDRawDataStructs.h.

      {
        data = 0;
        datasize = 0;
        type = -1;
        length = 0;
      };

Member Function Documentation

◆ check_crc()

void check_crc	(	PXDErrorFlags &	errormask,
		bool	ignore_crc_flag = false )

check crc and return it

Definition at line 235 of file PXDRawDataStructs.cc.

    {
      dhc_crc_32_type bocrc;
 
      if (length > 65536 * 16) {
        if (!ignore_crc_flag) B2WARNING("DHC Data Frame CRC not calculated because of too large packet (>1MB)!");
        return; // such large packets should trigger an error elsewhere
      } else {
        bocrc.process_bytes(data, length - 4);
      }
      unsigned int c;
      c = bocrc.checksum();
 
      ubig32_t crc32;
      crc32 = *reinterpret_cast<const ubig32_t*>(((reinterpret_cast<const unsigned char*>(data)) + length - 4));
 
      if (c != crc32) {
        if (!ignore_crc_flag) {
          B2WARNING("DHC Data Frame CRC FAIL");
          B2DEBUG(1, "DHC Data Frame CRC FAIL: " << std::hex << c << "!=" << crc32 << " data "
                  << *reinterpret_cast<const unsigned int*>((reinterpret_cast<const unsigned char*>(data)) + length - 8) << " "
                  << *reinterpret_cast<const unsigned int*>((reinterpret_cast<const unsigned char*>(data)) + length - 6) << " "
                  << *reinterpret_cast<const unsigned int*>((reinterpret_cast<const unsigned char*>(data)) + length - 4) << " len $" << length);
        }
        errorMask[c_nrDHE_CRC] = true;
      }
    };

◆ check_padding()

void check_padding ( PXDErrorFlags & errormask )

check padding and return it

TODO many false positives, we should remove that check after we KNOW that it has been fixed in DHH Firmware

Definition at line 225 of file PXDRawDataStructs.cc.

    {
      unsigned int crc = *reinterpret_cast<const ubig32_t*>(((reinterpret_cast<const unsigned char*>(data)) + length - 4));
      if ((crc & 0xFFFF0000) == 0 || (crc & 0xFFFF) == 0) {
        B2INFO("Suspicious Padding $" << std::hex << crc);
        errorMask[c_nrSUSP_PADDING] = true;
      }
    };

◆ getEventNrLo()

unsigned int getEventNrLo ( void ) const

inline

get event nr lo (from data)

Definition at line 614 of file PXDRawDataStructs.h.

      {
        return (reinterpret_cast<const ubig16_t*>(data))[1];
      };

◆ getFixedSize()

unsigned int getFixedSize ( void )

get fixed size

size is not a fixed number

Definition at line 264 of file PXDRawDataStructs.cc.

    {
      unsigned int s = 0;
      switch (getFrameType()) {
        case EDHCFrameHeaderDataType::c_DHP_RAW:
          s = 0; 
          break;
        case EDHCFrameHeaderDataType::c_ONSEN_DHP:
        case EDHCFrameHeaderDataType::c_DHP_ZSD:
          s = 0; 
          break;
        case EDHCFrameHeaderDataType::c_ONSEN_FCE:
        case EDHCFrameHeaderDataType::c_FCE_RAW:
          s = 0; 
          break;
        case EDHCFrameHeaderDataType::c_COMMODE:
          s = data_commode_frame->getFixedSize();
          break;
        case EDHCFrameHeaderDataType::c_GHOST:
          s = data_ghost_frame->getFixedSize();
          break;
        case EDHCFrameHeaderDataType::c_DHE_START:
          s = data_dhe_start_frame->getFixedSize();
          break;
        case EDHCFrameHeaderDataType::c_DHE_END:
          s = data_dhe_end_frame->getFixedSize();
          break;
        case EDHCFrameHeaderDataType::c_DHC_START:
          s = data_dhc_start_frame->getFixedSize();
          break;
        case EDHCFrameHeaderDataType::c_DHC_END:
          s = data_dhc_end_frame->getFixedSize();
          break;
        case EDHCFrameHeaderDataType::c_ONSEN_ROI:
          s = 0; 
          break;
        case EDHCFrameHeaderDataType::c_ONSEN_TRG:
          s = data_onsen_trigger_frame->getFixedSize();
          break;
        default:
          B2INFO("Error: not a valid data frame!");
          // Error will be set elsewhere in another check
          s = 0;
          break;
      }
      datasize = s;
      return s;
    };

◆ getFrameType()

int getFrameType ( void )

inline

get type of frame

Definition at line 579 of file PXDRawDataStructs.h.

      {
        return type;
      };

◆ set() [1/3]

void set ( const void * d )

inline

set data (get type from dhc_frame_header_word0 and set length to 0)

Parameters

d data

Definition at line 607 of file PXDRawDataStructs.h.

      {
        data = d;
        type = reinterpret_cast <const dhc_frame_header_word0*>(data)->getFrameType();
        length = 0;
      };

◆ set() [2/3]

void set	(	const void *	d,
		unsigned int	t )

inline

set data and type (and length to 0)

Parameters

d	data
t	type

Definition at line 587 of file PXDRawDataStructs.h.

      {
        data = d;
        type = t;
        length = 0;
      };

◆ set() [3/3]

void set	(	const void *	d,
		unsigned int	t,
		unsigned int	l )

inline

set data, type and length

Parameters

d	data
t	type
l	length

Definition at line 598 of file PXDRawDataStructs.h.

      {
        data = d;
        type = t;
        length = l;
      };

Member Data Documentation

◆ data

const void* data

no type

Definition at line 553 of file PXDRawDataStructs.h.

◆ data_commode_frame

const dhc_commode_frame* data_commode_frame

data_commode_frame

Definition at line 559 of file PXDRawDataStructs.h.

◆ data_dhc_end_frame

const dhc_end_frame* data_dhc_end_frame

data_dhc_end_frame

Definition at line 556 of file PXDRawDataStructs.h.

◆ data_dhc_start_frame

const dhc_start_frame* data_dhc_start_frame

data_dhc_start_frame

Definition at line 555 of file PXDRawDataStructs.h.

◆ data_dhe_end_frame

const dhc_dhe_end_frame* data_dhe_end_frame

data_dhe_end_frame

Definition at line 558 of file PXDRawDataStructs.h.

◆ data_dhe_start_frame

const dhc_dhe_start_frame* data_dhe_start_frame

data_dhe_start_frame

Definition at line 557 of file PXDRawDataStructs.h.

◆ data_direct_readout_frame

const dhc_direct_readout_frame* data_direct_readout_frame

data_direct_readout_frame

Definition at line 560 of file PXDRawDataStructs.h.

◆ data_direct_readout_frame_raw

const dhc_direct_readout_frame_raw* data_direct_readout_frame_raw

data_direct_readout_frame_raw

Definition at line 561 of file PXDRawDataStructs.h.

◆ data_direct_readout_frame_zsd

const dhc_direct_readout_frame_zsd* data_direct_readout_frame_zsd

data_direct_readout_frame_zsd

Definition at line 562 of file PXDRawDataStructs.h.

◆ data_ghost_frame

const dhc_ghost_frame* data_ghost_frame

data_ghost_frame

Definition at line 563 of file PXDRawDataStructs.h.

◆ data_onsen_roi_frame

const dhc_onsen_roi_frame* data_onsen_roi_frame

data_onsen_roi_frame

Definition at line 564 of file PXDRawDataStructs.h.

◆ data_onsen_trigger_frame

const dhc_onsen_trigger_frame* data_onsen_trigger_frame

data_onsen_trigger_frame

Definition at line 554 of file PXDRawDataStructs.h.

◆ datasize

unsigned int datasize

datasize

Definition at line 566 of file PXDRawDataStructs.h.

◆ length

int length

length

Definition at line 568 of file PXDRawDataStructs.h.

◆ type

int type

type

Definition at line 567 of file PXDRawDataStructs.h.

The documentation for this class was generated from the following files:

pxd/unpacking/include/PXDRawDataStructs.h
pxd/unpacking/src/PXDRawDataStructs.cc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ dhc_frames()

Member Function Documentation

◆ check_crc()

◆ check_padding()

◆ getEventNrLo()

◆ getFixedSize()

◆ getFrameType()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

Member Data Documentation

◆ data

◆ data_commode_frame

◆ data_dhc_end_frame

◆ data_dhc_start_frame

◆ data_dhe_end_frame

◆ data_dhe_start_frame

◆ data_direct_readout_frame

◆ data_direct_readout_frame_raw

◆ data_direct_readout_frame_zsd

◆ data_ghost_frame

◆ data_onsen_roi_frame

◆ data_onsen_trigger_frame

◆ datasize

◆ length

◆ type