RPixErrorChecker Class Reference

#include <RPixErrorChecker.h>

Public Types
typedef std::vector< CTPPSPixelDataError >	DetErrors
typedef std::map< uint32_t, DetErrors >	Errors
typedef uint32_t	Word32
typedef uint64_t	Word64

Public Member Functions
bool	checkCRC (bool &errorsInEvent, int fedId, const Word64 *trailer, Errors &errors) const
bool	checkHeader (bool &errorsInEvent, int fedId, const Word64 *header, Errors &errors) const
bool	checkROC (bool &errorsInEvent, int fedId, uint32_t iD, const Word32 &errorWord, Errors &errors) const
bool	checkTrailer (bool &errorsInEvent, int fedId, unsigned int nWords, const Word64 *trailer, Errors &errors) const
void	conversionError (int fedId, uint32_t iD, const State &state, const Word32 &errorWord, Errors &errors) const
	RPixErrorChecker ()
void	setErrorStatus (bool errorStatus)

Static Public Attributes
static constexpr int	ADC_bits = 8
static constexpr int	ADC_shift = 0
static constexpr int	CRC_bits = 1
static constexpr Word64	CRC_mask = ~(~RPixErrorChecker::Word64(0) << CRC_bits)
static constexpr int	CRC_shift = 2
static constexpr int	DCOL_bits = 5
static constexpr int	DCOL_shift = PXID_shift + PXID_bits
static constexpr Word32	dummyDetId = 0xffffffff
static constexpr Word32	ERROR_mask = ~(~RPixErrorChecker::Word32(0) << ROC_bits)
static constexpr int	OMIT_ERR_bits = 1
static constexpr Word32	OMIT_ERR_mask = ~(~RPixErrorChecker::Word32(0) << OMIT_ERR_bits)
static constexpr int	OMIT_ERR_shift = 20
static constexpr int	PXID_bits = 8
static constexpr int	PXID_shift = ADC_shift + ADC_bits
static constexpr int	ROC_bits = 5
static constexpr int	ROC_shift = DCOL_shift + DCOL_bits

Private Attributes
bool	includeErrors_

Detailed Description

RPix == CTPPS Pixel detector (Roman Pot Pixels)

Definition at line 17 of file RPixErrorChecker.h.

Member Typedef Documentation

DetErrors

typedef std::vector<CTPPSPixelDataError> RPixErrorChecker::DetErrors

Definition at line 22 of file RPixErrorChecker.h.

Errors

typedef std::map<uint32_t, DetErrors> RPixErrorChecker::Errors

Definition at line 23 of file RPixErrorChecker.h.

Word32

typedef uint32_t RPixErrorChecker::Word32

Definition at line 19 of file RPixErrorChecker.h.

Word64

typedef uint64_t RPixErrorChecker::Word64

Definition at line 20 of file RPixErrorChecker.h.

Constructor & Destructor Documentation

RPixErrorChecker()

RPixErrorChecker::RPixErrorChecker

(

)

Definition at line 12 of file RPixErrorChecker.cc.

{ includeErrors_ = false; }

Member Function Documentation

checkCRC()

bool RPixErrorChecker::checkCRC	(	bool &	errorsInEvent,
		int	fedId,
		const Word64 *	trailer,
		Errors &	errors
	)		const

Definition at line 16 of file RPixErrorChecker.cc.

References sipixelconstants::CRC_mask, sipixelconstants::CRC_shift, sipixelconstants::dummyDetId, l1tstage2_dqm_sourceclient-live_cfg::fedId, and LogDebug.

Referenced by CTPPSPixelDataFormatter::interpretRawData().

                                                                                                           {
  int CRC_BIT = (*trailer >> CRC_shift) & CRC_mask;
  if (CRC_BIT == 0)
    return true;
  errorsInEvent = true;
  LogDebug("CRCCheck") << "CRC check failed,  errorType = 39";
  if (includeErrors_) {
    int errorType = 39;
    errors[dummyDetId].emplace_back(*trailer, errorType, fedId);
  }
  return false;
}

checkHeader()

bool RPixErrorChecker::checkHeader	(	bool &	errorsInEvent,
		int	fedId,
		const Word64 *	header,
		Errors &	errors
	)		const

Definition at line 29 of file RPixErrorChecker.cc.

References FEDHeader::check(), sipixelconstants::dummyDetId, l1tstage2_dqm_sourceclient-live_cfg::fedId, RecoTauValidation_cfi::header, LogDebug, FEDHeader::moreHeaders(), and FEDHeader::sourceID().

Referenced by CTPPSPixelDataFormatter::interpretRawData().

                                                                                                             {
  FEDHeader fedHeader(reinterpret_cast<const unsigned char*>(header));
  if (!fedHeader.check())
    return false;
  if (fedHeader.sourceID() != fedId) {
    LogDebug("CTPPSPixelDataFormatter::interpretRawData, fedHeader.sourceID() != fedId")
        << ", sourceID = " << fedHeader.sourceID() << ", fedId = " << fedId << ", errorType = 32";
    errorsInEvent = true;
    if (includeErrors_) {
      int errorType = 32;
      errors[dummyDetId].emplace_back(*header, errorType, fedId);
    }
  }
  return fedHeader.moreHeaders();
}

checkROC()

bool RPixErrorChecker::checkROC	(	bool &	errorsInEvent,
		int	fedId,
		uint32_t	iD,
		const Word32 &	errorWord,
		Errors &	errors
	)		const

check to see if overflow error for type 30, change type to 40 if so

store error

Definition at line 68 of file RPixErrorChecker.cc.

References sipixelconstants::ERROR_mask, l1tstage2_dqm_sourceclient-live_cfg::fedId, LIKELY, LogDebug, sipixelconstants::OMIT_ERR_mask, sipixelconstants::OMIT_ERR_shift, and sipixelconstants::ROC_shift.

Referenced by CTPPSPixelDataFormatter::interpretRawData().

                                                                                                {
  int errorType = (errorWord >> ROC_shift) & ERROR_mask;
  if LIKELY (errorType < 25)
    return true;

  switch (errorType) {
    case (25): {
      LogDebug("") << "  invalid ROC=25 found (errorType=25)";
      errorsInEvent = true;
      break;
    }
    case (26): {
      LogDebug("") << "  gap word found (errorType=26)";
      return false;
    }
    case (27): {
      LogDebug("") << "  dummy word found (errorType=27)";
      return false;
    }
    case (28): {
      LogDebug("") << "  error fifo nearly full (errorType=28)";
      errorsInEvent = true;
      break;
    }
    case (29): {
      LogDebug("") << "  timeout on a channel (errorType=29)";
      errorsInEvent = true;
      if ((errorWord >> OMIT_ERR_shift) & OMIT_ERR_mask) {
        LogDebug("") << "  ...first errorType=29 error, this gets masked out";
        return false;
      }
      break;
    }
    case (30): {
      LogDebug("") << "  TBM error trailer (errorType=30)";
      errorsInEvent = true;
      break;
    }
    case (31): {
      LogDebug("") << "  event number error (errorType=31)";
      errorsInEvent = true;
      break;
    }
    default:
      return true;
  };

  if (includeErrors_) {
    if (errorType == 30) {
      uint32_t stateMach_bits = 4;
      uint32_t stateMach_shift = 8;
      uint32_t stateMach_mask = ~(~uint32_t(0) << stateMach_bits);
      uint32_t stateMach = (errorWord >> stateMach_shift) & stateMach_mask;
      if (stateMach == 4 || stateMach == 9)
        errorType = 40;
    }

    errors[iD].emplace_back(errorWord, errorType, fedId);
  }

  return false;
}

checkTrailer()

bool RPixErrorChecker::checkTrailer	(	bool &	errorsInEvent,
		int	fedId,
		unsigned int	nWords,
		const Word64 *	trailer,
		Errors &	errors
	)		const

Definition at line 45 of file RPixErrorChecker.cc.

References FEDTrailer::check(), sipixelconstants::dummyDetId, l1tstage2_dqm_sourceclient-live_cfg::fedId, FEDTrailer::fragmentLength(), LogDebug, FEDTrailer::moreTrailers(), and l1ctLayer2EG_cff::nWords.

Referenced by CTPPSPixelDataFormatter::interpretRawData().

                                                                                                      {
  FEDTrailer fedTrailer(reinterpret_cast<const unsigned char*>(trailer));
  if (!fedTrailer.check()) {
    if (includeErrors_) {
      int errorType = 33;
      errors[dummyDetId].emplace_back(*trailer, errorType, fedId);
    }
    errorsInEvent = true;
    LogDebug("FedTrailerCheck") << "fedTrailer.check failed, Fed: " << fedId << ", errorType = 33";
    return false;
  }
  if (fedTrailer.fragmentLength() != nWords) {
    LogDebug("FedTrailerLenght") << "fedTrailer.fragmentLength()!= nWords !! Fed: " << fedId << ", errorType = 34";
    errorsInEvent = true;
    if (includeErrors_) {
      int errorType = 34;
      errors[dummyDetId].emplace_back(*trailer, errorType, fedId);
    }
  }
  return fedTrailer.moreTrailers();
}

conversionError()

void RPixErrorChecker::conversionError	(	int	fedId,
		uint32_t	iD,
		const State &	state,
		const Word32 &	errorWord,
		Errors &	errors
	)		const

Definition at line 134 of file RPixErrorChecker.cc.

References l1tstage2_dqm_sourceclient-live_cfg::fedId, InvalidLinkId, InvalidPixelId, InvalidROCId, and LogDebug.

Referenced by CTPPSPixelDataFormatter::interpretRawData().

                                                                                               {
  int errorType = 0;

  switch (state) {
    case (InvalidLinkId): {
      LogDebug("ErrorChecker::conversionError") << " Fed: " << fedId << "  invalid channel Id (errorType=35)";
      errorType = 35;
      break;
    }
    case (InvalidROCId): {
      LogDebug("ErrorChecker::conversionError") << " Fed: " << fedId << "  invalid ROC Id (errorType=36)";
      errorType = 36;
      break;
    }
    case (InvalidPixelId): {
      LogDebug("ErrorChecker::conversionError") << " Fed: " << fedId << "  invalid dcol/pixel value (errorType=37)";
      errorType = 37;
      break;
    }

    default:
      LogDebug("ErrorChecker::conversionError") << "  cabling check returned unexpected result, status = " << state;
  };

  if (includeErrors_ && errorType > 0)
    errors[iD].emplace_back(errorWord, errorType, fedId);
}

setErrorStatus()

void RPixErrorChecker::setErrorStatus

(

bool

errorStatus

)

Definition at line 14 of file RPixErrorChecker.cc.

Referenced by CTPPSPixelDataFormatter::setErrorStatus().

{ includeErrors_ = errorStatus; }

Member Data Documentation

ADC_bits

constexpr int RPixErrorChecker::ADC_bits = 8

static

Definition at line 29 of file RPixErrorChecker.h.

ADC_shift

constexpr int RPixErrorChecker::ADC_shift = 0

static

Definition at line 33 of file RPixErrorChecker.h.

CRC_bits

constexpr int RPixErrorChecker::CRC_bits = 1

static

Definition at line 25 of file RPixErrorChecker.h.

CRC_mask

constexpr Word64 RPixErrorChecker::CRC_mask = ~(~RPixErrorChecker::Word64(0) << CRC_bits)

static

Definition at line 41 of file RPixErrorChecker.h.

CRC_shift

constexpr int RPixErrorChecker::CRC_shift = 2

static

Definition at line 32 of file RPixErrorChecker.h.

DCOL_bits

constexpr int RPixErrorChecker::DCOL_bits = 5

static

Definition at line 27 of file RPixErrorChecker.h.

DCOL_shift

constexpr int RPixErrorChecker::DCOL_shift = PXID_shift + PXID_bits

static

Definition at line 35 of file RPixErrorChecker.h.

dummyDetId

constexpr RPixErrorChecker::Word32 RPixErrorChecker::dummyDetId = 0xffffffff

static

Definition at line 39 of file RPixErrorChecker.h.

Referenced by CTPPSPixelDataFormatter::interpretRawData(), and CTPPSPixelRawToDigi::produce().

ERROR_mask

constexpr Word32 RPixErrorChecker::ERROR_mask = ~(~RPixErrorChecker::Word32(0) << ROC_bits)

static

Definition at line 42 of file RPixErrorChecker.h.

includeErrors_

bool RPixErrorChecker::includeErrors_

private

Definition at line 61 of file RPixErrorChecker.h.

OMIT_ERR_bits

constexpr int RPixErrorChecker::OMIT_ERR_bits = 1

static

Definition at line 30 of file RPixErrorChecker.h.

OMIT_ERR_mask

constexpr Word32 RPixErrorChecker::OMIT_ERR_mask = ~(~RPixErrorChecker::Word32(0) << OMIT_ERR_bits)

static

Definition at line 43 of file RPixErrorChecker.h.

OMIT_ERR_shift

constexpr int RPixErrorChecker::OMIT_ERR_shift = 20

static

Definition at line 37 of file RPixErrorChecker.h.

PXID_bits

constexpr int RPixErrorChecker::PXID_bits = 8

static

Definition at line 28 of file RPixErrorChecker.h.

PXID_shift

constexpr int RPixErrorChecker::PXID_shift = ADC_shift + ADC_bits

static

Definition at line 34 of file RPixErrorChecker.h.

ROC_bits

constexpr int RPixErrorChecker::ROC_bits = 5

static

Definition at line 26 of file RPixErrorChecker.h.

ROC_shift

constexpr int RPixErrorChecker::ROC_shift = DCOL_shift + DCOL_bits

static

Definition at line 36 of file RPixErrorChecker.h.