SCT_ByteStreamErrors.h

Go to the documentation of this file.

// -*- C++ -*-
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

 
#ifndef SCT_ByteStreamErrors_h
#define SCT_ByteStreamErrors_h
 
#include <array>
#include <vector>
#include <cstdint>


#ifndef SCT_ERRORTYPELIST
#define SCT_ERRORTYPELIST(XYZ) \
  XYZ(ByteStreamParseError)    \
  XYZ(TimeOutError)            \
  XYZ(BCIDError)               \
  XYZ(LVL1IDError)             \
  XYZ(PreambleError)           \
  XYZ(FormatterError)          \
  XYZ(TrailerError)            \
  XYZ(TrailerOverflowError)    \
  XYZ(HeaderTrailerLimitError) \
  XYZ(ABCDError)               \
  XYZ(RawError)                \
  XYZ(MaskedLink)              \
  XYZ(RODClockError)           \
  XYZ(TruncatedROD)            \
  XYZ(ROBFragmentError)        \
  XYZ(MissingLinkHeaderError)  \
  XYZ(MaskedROD)               \
  XYZ(ABCDError_Chip0)         \
  XYZ(ABCDError_Chip1)         \
  XYZ(ABCDError_Chip2)         \
  XYZ(ABCDError_Chip3)         \
  XYZ(ABCDError_Chip4)         \
  XYZ(ABCDError_Chip5)         \
  XYZ(ABCDError_Error1)        \
  XYZ(ABCDError_Error2)        \
  XYZ(ABCDError_Error4)        \
  XYZ(TempMaskedChip0)         \
  XYZ(TempMaskedChip1)         \
  XYZ(TempMaskedChip2)         \
  XYZ(TempMaskedChip3)         \
  XYZ(TempMaskedChip4)         \
  XYZ(TempMaskedChip5)         \
  XYZ(ABCDError_Error7)        \
  XYZ(ABCDError_Invalid)       \
  XYZ(RODSimulatedData)        \
  XYZ(NUM_ERROR_TYPES) // always have this one last, so we can use it as a loop index
#endif // SCT_ERRORTYPELIST
 
#ifndef SCT_DO_ENUM
#define SCT_DO_ENUM(e) e,
#endif // SCT_DO_ENUM
 
#ifndef SCT_DO_DESCRIPTION
#define SCT_DO_DESCRIPTION(e) #e,
#endif // SCT_DO_DESCRIPTION
 
namespace SCT_ByteStreamErrors {
  enum ErrorType {
    SCT_ERRORTYPELIST(SCT_DO_ENUM)
  };

  static const std::vector<std::string> ErrorTypeDescription = {
    SCT_ERRORTYPELIST(SCT_DO_DESCRIPTION)
  };

  static const std::vector<ErrorType> BadErrors = {
    TimeOutError,
    BCIDError,
    LVL1IDError,
    HeaderTrailerLimitError,
    MaskedLink,
    TruncatedROD,
    ROBFragmentError,
    MissingLinkHeaderError,
    MaskedROD
  };

  static const std::vector<ErrorType> LinkLevelBadErrors = {
    TimeOutError,
    BCIDError,
    LVL1IDError,
    HeaderTrailerLimitError,
    MaskedLink
  };

  static const std::vector<ErrorType> RodLevelBadErrors = {
    TruncatedROD,
    ROBFragmentError,
    MissingLinkHeaderError, 
    // We cannot know which FE-link does not have header. We assign this error
    // to all the FE-links without hit, ABCD error or raw data of the ROD.
    MaskedROD
  };

  static const std::vector<ErrorType> LinkLevelErrors = {
    ByteStreamParseError,
    TimeOutError,
    BCIDError,
    LVL1IDError,
    PreambleError,
    FormatterError,
    TrailerError,
    TrailerOverflowError,
    HeaderTrailerLimitError,
    ABCDError,
    RawError,
    MaskedLink,
    ABCDError_Chip0,
    ABCDError_Chip1,
    ABCDError_Chip2,
    ABCDError_Chip3,
    ABCDError_Chip4,
    ABCDError_Chip5,
    ABCDError_Error1,
    ABCDError_Error2,
    ABCDError_Error4,
    TempMaskedChip0,
    TempMaskedChip1,
    TempMaskedChip2,
    TempMaskedChip3,
    TempMaskedChip4,
    TempMaskedChip5,
    ABCDError_Error7
  };

  static const std::vector<ErrorType> RodLevelErrors = {
    RODClockError,
    TruncatedROD,
    ROBFragmentError,
    MissingLinkHeaderError, // We cannot know which FE-link does not have header. We assign this error to all the FE-links of the ROD.
    MaskedROD
  };
 
  template<ErrorType et> static constexpr uint64_t maskUpTo() { return  ( uint64_t(1) << et ) - 1; }
  // Bit mask for ABCDError_Chip0, ABCDError_Chip1, ..., ABCDError_Chip5
  static constexpr uint64_t ABCDErrorMask() { return maskUpTo<static_cast<ErrorType>(ABCDError_Chip5 + 1)>() & ~(maskUpTo<ABCDError_Chip0>()); }
  // Bit mask for TempMaskedChip0, TempMaskedChip1, ..., TempMaskedChip5
  static constexpr uint64_t TempMaskedChipsMask() { return maskUpTo<static_cast<ErrorType>(TempMaskedChip5 + 1)>() & ~(maskUpTo<TempMaskedChip0>()); }
  inline ErrorType TempMaskedChipToBit(const int chip){ return std::array<ErrorType, 6>{{
         TempMaskedChip0,
         TempMaskedChip1,
         TempMaskedChip2,
         TempMaskedChip3,
         TempMaskedChip4,
         TempMaskedChip5}}[chip]; }
 
}
 
#endif // SCT_ByteStreamErrors_h