LVL1::DataError Class Reference

Error data. More...

#include <DataError.h>

Collaboration diagram for LVL1::DataError:

Public Types
enum	ErrorBit {   Overflow = 0, Parity = 1, LinkDown = 2, ChannelDisabled = 4,   MCMAbsent = 5, Timeout = 6, ASICFull = 7, EventMismatch = 8,   BunchMismatch = 9, FIFOCorrupt = 10, PinParity = 11, ParityMerge = 4,   ParityPhase0 = 5, ParityPhase1 = 6, ParityPhase2 = 7, ParityPhase3 = 8,   GLinkParity = 16, GLinkProtocol = 17, BCNMismatch = 18, FIFOOverflow = 19,   ModuleError = 20, GLinkDown = 22, GLinkTimeout = 23, FailingBCN = 24,   PPMErrorWord = 32, SubStatusWord = 33 }

Public Member Functions
	DataError ()
	DataError (int error)
	~DataError ()
void	set (ErrorBit bit, int value=1)
	Set an error bit or data. More...
int	get (ErrorBit bit) const
	Return an error bit or data. More...
int	get (int bit) const
	Return an error bit or data. More...
std::string	bitName (int bit) const
	Return the name of an error bit or data. More...
int	error () const
	Return the full error word. More...

Private Attributes
int	m_error
	Error word. More...

Static Private Attributes
static const int	s_failingBcnMask = 0x3f
	Mask for Failing BCN. More...
static const int	s_ppmErrorMask = 0xff
	Mask for PPM error bits. More...
static const int	s_subStatusMask = 0xff
	Mask for error bits from sub-status word. More...
static const int	s_subStatusBcn = 22
	Bit position of failing BCN in sub-status word. More...

Detailed Description

Error data.

Defines the error data bits unpacked from bytestream subdivided as follows:

Bits 0-2 CP/JEP specific error bits Bits 4-11 PP specific error bits Bits 4-8 CMX specific error bits Bits 16-29 Sub-status word error bits and failing BCN

Other bits are spare. Uses an int for backwards compatibility reasons so probably bit 31 should not be used.

Author

Peter Faulkner

Definition at line 27 of file DataError.h.

Member Enumeration Documentation

ErrorBit

enum LVL1::DataError::ErrorBit

Enumerator
Overflow
Parity
LinkDown
ChannelDisabled
MCMAbsent
Timeout
ASICFull
EventMismatch
BunchMismatch
FIFOCorrupt
PinParity
ParityMerge
ParityPhase0
ParityPhase1
ParityPhase2
ParityPhase3
GLinkParity
GLinkProtocol
BCNMismatch
FIFOOverflow
ModuleError
GLinkDown
GLinkTimeout
FailingBCN
PPMErrorWord
SubStatusWord

Definition at line 31 of file DataError.h.

                 { Overflow = 0, Parity = 1, LinkDown = 2,
 
                   ChannelDisabled = 4, MCMAbsent = 5, Timeout = 6,
                   ASICFull = 7, EventMismatch = 8, BunchMismatch = 9,
                   FIFOCorrupt = 10, PinParity = 11,
 
           ParityMerge = 4, ParityPhase0 = 5, ParityPhase1 = 6,
           ParityPhase2 = 7, ParityPhase3 = 8,
 
                   GLinkParity = 16, GLinkProtocol = 17, BCNMismatch = 18,
                   FIFOOverflow = 19, ModuleError = 20, GLinkDown = 22,
                   GLinkTimeout = 23, FailingBCN = 24,
           
           PPMErrorWord = 32, SubStatusWord = 33 };

Constructor & Destructor Documentation

DataError() [1/2]

LVL1::DataError::DataError

(

)

Definition at line 14 of file DataError.cxx.

                     : m_error(0)
{
}

DataError() [2/2]

LVL1::DataError::DataError ( int  error )

explicit

Definition at line 18 of file DataError.cxx.

                              : m_error(error)
{
}

~DataError()

LVL1::DataError::~DataError

(

)

Definition at line 22 of file DataError.cxx.

{
}

Member Function Documentation

bitName()

std::string LVL1::DataError::bitName

(

int

bit

)

const

Return the name of an error bit or data.

Definition at line 70 of file DataError.cxx.

{
  std::string name;
  switch (bit) {
    case Overflow:        name = "Overflow";        break;
    case Parity:          name = "Parity";          break;
    case LinkDown:        name = "LinkDown";        break;
    case ChannelDisabled: name = "ChannelDisabled"; break;
    case MCMAbsent:       name = "MCMAbsent";       break;
    case Timeout:         name = "Timeout";         break;
    case ASICFull:        name = "ASICFull";        break;
    case EventMismatch:   name = "EventMismatch";   break;
    case BunchMismatch:   name = "BunchMismatch";   break;
    case FIFOCorrupt:     name = "FIFOCorrupt";     break;
    case PinParity:       name = "PinParity";       break;
    //case ParityMerge:     name = "ParityMerge";     break;
    //case ParityPhase0:    name = "ParityPhase0";    break;
    //case ParityPhase1:    name = "ParityPhase1";    break;
    //case ParityPhase2:    name = "ParityPhase2";    break;
    //case ParityPhase3:    name = "ParityPhase3";    break;
    case GLinkParity:     name = "GLinkParity";     break;
    case GLinkProtocol:   name = "GLinkProtocol";   break;
    case BCNMismatch:     name = "BCNMismatch";     break;
    case FIFOOverflow:    name = "FIFOOverflow";    break;
    case ModuleError:     name = "ModuleError";     break;
    case GLinkDown:       name = "GLinkDown";       break;
    case GLinkTimeout:    name = "GLinkTimeout";    break;
    default:              name = "";                break;
  }
  return name;
}

error()

int LVL1::DataError::error ( ) const

inline

Return the full error word.

Definition at line 78 of file DataError.h.

{
  return m_error;
}

get() [1/2]

int LVL1::DataError::get

(

ErrorBit

bit

)

const

Return an error bit or data.

Definition at line 48 of file DataError.cxx.

{
  if (bit == SubStatusWord) return 0;
  int mask = 0x1;
  if (bit == FailingBCN) mask = s_failingBcnMask;
  else if (bit == PPMErrorWord) {
    bit  = ChannelDisabled;
    mask = s_ppmErrorMask;
  }
  return (m_error >> bit) & mask;
}

get() [2/2]

int LVL1::DataError::get

(

int

bit

)

const

Return an error bit or data.

Definition at line 62 of file DataError.cxx.

{
  int mask = (bit == FailingBCN) ? s_failingBcnMask : 0x1;
  return (m_error >> bit) & mask;
}

set()

void LVL1::DataError::set	(	ErrorBit	bit,
		int	value = 1
	)

Set an error bit or data.

Definition at line 28 of file DataError.cxx.

{
  if (bit == SubStatusWord) {
    m_error &= ~(s_subStatusMask << GLinkParity);
    m_error |= (value & s_subStatusMask) << GLinkParity;
    bit = FailingBCN;
    value >>= s_subStatusBcn;
  }
  int mask = 0x1;
  if (bit == FailingBCN) mask = s_failingBcnMask;
  else if (bit == PPMErrorWord) {
    bit  = ChannelDisabled;
    mask = s_ppmErrorMask;
  }
  m_error &= ~(mask << bit);
  m_error |= (value & mask) << bit;
}

Member Data Documentation

m_error

int LVL1::DataError::m_error

private

Error word.

Definition at line 74 of file DataError.h.

s_failingBcnMask

const int LVL1::DataError::s_failingBcnMask = 0x3f

staticprivate

Mask for Failing BCN.

Definition at line 65 of file DataError.h.

s_ppmErrorMask

const int LVL1::DataError::s_ppmErrorMask = 0xff

staticprivate

Mask for PPM error bits.

Definition at line 67 of file DataError.h.

s_subStatusBcn

const int LVL1::DataError::s_subStatusBcn = 22

staticprivate

Bit position of failing BCN in sub-status word.

Definition at line 71 of file DataError.h.

s_subStatusMask

const int LVL1::DataError::s_subStatusMask = 0xff

staticprivate

Mask for error bits from sub-status word.

Definition at line 69 of file DataError.h.

---

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

• DataError.h
• DataError.cxx