sistrip::FEDBackendStatusRegister Class Reference

#include <SiStripFEDBufferComponents.h>

Public Member Functions
bool	backpressureFlag () const
	FEDBackendStatusRegister (const uint32_t backendStatusRegister)
	FEDBackendStatusRegister (const FEDBufferState qdrMemoryBufferState=BUFFER_STATE_UNSET, const FEDBufferState frameAddressFIFOBufferState=BUFFER_STATE_UNSET, const FEDBufferState totalLengthFIFOBufferState=BUFFER_STATE_UNSET, const FEDBufferState trackerHeaderFIFOBufferState=BUFFER_STATE_UNSET, const FEDBufferState l1aBxFIFOBufferState=BUFFER_STATE_UNSET, const FEDBufferState feEventLengthFIFOBufferState=BUFFER_STATE_UNSET, const FEDBufferState feFPGABufferState=BUFFER_STATE_UNSET, const bool backpressure=false, const bool slinkFull=false, const bool slinkDown=false, const bool internalFreeze=false, const bool trackerHeaderMonitorDataReady=false, const bool ttcReady=true)
FEDBufferState	feEventLengthFIFOState () const
FEDBufferState	feFPGABufferState () const
FEDBufferState	frameAddressFIFOState () const
bool	internalFreezeFlag () const
FEDBufferState	l1aBxFIFOState () const
	operator uint32_t () const
void	print (std::ostream &os) const
void	printFlags (std::ostream &os) const
FEDBufferState	qdrMemoryState () const
FEDBackendStatusRegister &	setBackpressureFlag (const bool bitSet)
FEDBackendStatusRegister &	setFEEventLengthFIFOState (const FEDBufferState state)
FEDBackendStatusRegister &	setFEFPGABufferState (const FEDBufferState state)
FEDBackendStatusRegister &	setFrameAddressFIFOState (const FEDBufferState state)
FEDBackendStatusRegister &	setInternalFreezeFlag (const bool bitSet)
FEDBackendStatusRegister &	setL1ABXFIFOState (const FEDBufferState state)
FEDBackendStatusRegister &	setQDRMemoryState (const FEDBufferState state)
FEDBackendStatusRegister &	setSLinkDownFlag (const bool bitSet)
FEDBackendStatusRegister &	setSLinkFullFlag (const bool bitSet)
FEDBackendStatusRegister &	setTotalLengthFIFOState (const FEDBufferState state)
FEDBackendStatusRegister &	setTrackerHeaderFIFOState (const FEDBufferState state)
FEDBackendStatusRegister &	setTrackerHeaderMonitorDataReadyFlag (const bool bitSet)
FEDBackendStatusRegister &	setTTCReadyFlag (const bool bitSet)
bool	slinkDownFlag () const
bool	slinkFullFlag () const
FEDBufferState	totalLengthFIFOState () const
FEDBufferState	trackerHeaderFIFOState () const
bool	trackerHeaderMonitorDataReadyFlag () const
bool	ttcReadyFlag () const

Private Types
enum	bufferPositions {   BUFFER_POSITION_QDR_MEMORY =0, BUFFER_POSITION_FRAME_ADDRESS_FIFO =1, BUFFER_POSITION_TOTAL_LENGTH_FIFO =2, BUFFER_POSITION_TRACKER_HEADER_FIFO =3,   BUFFER_POSITION_L1ABX_FIFO =4, BUFFER_POSITION_FE_EVENT_LENGTH_FIFO =5, BUFFER_POSITION_FE_FPGA_BUFFER =6 }
enum	stateOffsets { STATE_OFFSET_FULL =8, STATE_OFFSET_PARTIAL_FULL =16, STATE_OFFSET_EMPTY =24 }

Private Member Functions
bool	getBit (const uint8_t num) const
FEDBufferState	getBufferState (const uint8_t bufferPosition) const
void	printFlagsForBuffer (const FEDBufferState bufferState, const std::string name, std::ostream &os) const
void	setBit (const uint8_t num, const bool bitSet)
void	setBufferSate (const uint8_t bufferPosition, const FEDBufferState state)

Private Attributes
uint32_t	data_

Detailed Description

Definition at line 338 of file SiStripFEDBufferComponents.h.

Member Enumeration Documentation

enum sistrip::FEDBackendStatusRegister::bufferPositions

private

Enumerator
BUFFER_POSITION_QDR_MEMORY
BUFFER_POSITION_FRAME_ADDRESS_FIFO
BUFFER_POSITION_TOTAL_LENGTH_FIFO
BUFFER_POSITION_TRACKER_HEADER_FIFO
BUFFER_POSITION_L1ABX_FIFO
BUFFER_POSITION_FE_EVENT_LENGTH_FIFO
BUFFER_POSITION_FE_FPGA_BUFFER

Definition at line 394 of file SiStripFEDBufferComponents.h.

                           { BUFFER_POSITION_QDR_MEMORY=0,
                             BUFFER_POSITION_FRAME_ADDRESS_FIFO=1,
                             BUFFER_POSITION_TOTAL_LENGTH_FIFO=2,
                             BUFFER_POSITION_TRACKER_HEADER_FIFO=3,
                             BUFFER_POSITION_L1ABX_FIFO=4,
                             BUFFER_POSITION_FE_EVENT_LENGTH_FIFO=5,
                             BUFFER_POSITION_FE_FPGA_BUFFER=6 };

enum sistrip::FEDBackendStatusRegister::stateOffsets

private

Enumerator
STATE_OFFSET_FULL
STATE_OFFSET_PARTIAL_FULL
STATE_OFFSET_EMPTY

Definition at line 401 of file SiStripFEDBufferComponents.h.

                        { STATE_OFFSET_FULL=8,
                          STATE_OFFSET_PARTIAL_FULL=16,
                          STATE_OFFSET_EMPTY=24 };

Constructor & Destructor Documentation

sistrip::FEDBackendStatusRegister::FEDBackendStatusRegister ( const uint32_t  backendStatusRegister )

inline

Definition at line 888 of file SiStripFEDBufferComponents.h.

Referenced by sistrip::FEDFullDebugHeader::beStatusRegister().

    : data_(backendStatusRegister) { }

sistrip::FEDBackendStatusRegister::FEDBackendStatusRegister	(	const FEDBufferState	qdrMemoryBufferState = BUFFER_STATE_UNSET,
		const FEDBufferState	frameAddressFIFOBufferState = BUFFER_STATE_UNSET,
		const FEDBufferState	totalLengthFIFOBufferState = BUFFER_STATE_UNSET,
		const FEDBufferState	trackerHeaderFIFOBufferState = BUFFER_STATE_UNSET,
		const FEDBufferState	l1aBxFIFOBufferState = BUFFER_STATE_UNSET,
		const FEDBufferState	feEventLengthFIFOBufferState = BUFFER_STATE_UNSET,
		const FEDBufferState	feFPGABufferState = BUFFER_STATE_UNSET,
		const bool	backpressure = false,
		const bool	slinkFull = false,
		const bool	slinkDown = false,
		const bool	internalFreeze = false,
		const bool	trackerHeaderMonitorDataReady = false,
		const bool	ttcReady = true
	)

Definition at line 672 of file SiStripFEDBufferComponents.cc.

References setBackpressureFlag(), setFEEventLengthFIFOState(), setFEFPGABufferState(), setFrameAddressFIFOState(), setInternalFreezeFlag(), setL1ABXFIFOState(), setQDRMemoryState(), setSLinkDownFlag(), setSLinkFullFlag(), setTotalLengthFIFOState(), setTrackerHeaderFIFOState(), setTrackerHeaderMonitorDataReadyFlag(), and setTTCReadyFlag().

    : data_(0)
  {
    setInternalFreezeFlag(internalFreeze);
    setSLinkDownFlag(slinkDown);
    setSLinkFullFlag(slinkFull);
    setBackpressureFlag(backpressure);
    setTTCReadyFlag(ttcReady);
    setTrackerHeaderMonitorDataReadyFlag(trackerHeaderMonitorDataReady);
    setQDRMemoryState(qdrMemoryBufferState);
    setFrameAddressFIFOState(frameAddressFIFOBufferState);
    setTotalLengthFIFOState(totalLengthFIFOBufferState);
    setTrackerHeaderFIFOState(trackerHeaderFIFOBufferState);
    setL1ABXFIFOState(l1aBxFIFOBufferState);
    setFEEventLengthFIFOState(feEventLengthFIFOBufferState);
    setFEFPGABufferState(feFPGABufferState);
  }

Member Function Documentation

bool sistrip::FEDBackendStatusRegister::backpressureFlag ( ) const

inline

Definition at line 909 of file SiStripFEDBufferComponents.h.

References getBit().

    { return getBit(4); }

FEDBufferState sistrip::FEDBackendStatusRegister::feEventLengthFIFOState ( ) const

inline

Definition at line 961 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_FE_EVENT_LENGTH_FIFO, and getBufferState().

    {
      return getBufferState(BUFFER_POSITION_FE_EVENT_LENGTH_FIFO);
    }

FEDBufferState sistrip::FEDBackendStatusRegister::feFPGABufferState ( ) const

inline

Definition at line 966 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_FE_FPGA_BUFFER, and getBufferState().

    {
      return getBufferState(BUFFER_POSITION_FE_FPGA_BUFFER);
    }

FEDBufferState sistrip::FEDBackendStatusRegister::frameAddressFIFOState ( ) const

inline

Definition at line 941 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_FRAME_ADDRESS_FIFO, and getBufferState().

    {
      return getBufferState(BUFFER_POSITION_FRAME_ADDRESS_FIFO);
    }

bool sistrip::FEDBackendStatusRegister::getBit ( const uint8_t  num ) const

inlineprivate

Definition at line 897 of file SiStripFEDBufferComponents.h.

References data_, and globals_cff::x1.

Referenced by sistrip::FEDFullDebugHeader::apvAddressErrorFromBit(), sistrip::FEDFullDebugHeader::apvErrorFromBit(), backpressureFlag(), internalFreezeFlag(), sistrip::FEDFullDebugHeader::outOfSyncFromBit(), slinkDownFlag(), slinkFullFlag(), trackerHeaderMonitorDataReadyFlag(), ttcReadyFlag(), and sistrip::FEDFullDebugHeader::unlockedFromBit().

    { return ( (0x1<<num) & (data_) ); }  

FEDBufferState sistrip::FEDBackendStatusRegister::getBufferState ( const uint8_t  bufferPosition ) const

private

Definition at line 637 of file SiStripFEDBufferComponents.cc.

References sistrip::BUFFER_STATE_EMPTY, sistrip::BUFFER_STATE_FULL, sistrip::BUFFER_STATE_PARTIAL_FULL, sistrip::FEDStatusRegister::getBit(), and mps_fire::result.

Referenced by feEventLengthFIFOState(), feFPGABufferState(), frameAddressFIFOState(), l1aBxFIFOState(), qdrMemoryState(), totalLengthFIFOState(), and trackerHeaderFIFOState().

  {
    uint8_t result = 0x00;
    if (getBit(bufferPosition+STATE_OFFSET_EMPTY)) result |= BUFFER_STATE_EMPTY;
    if (getBit(bufferPosition+STATE_OFFSET_PARTIAL_FULL)) result |= BUFFER_STATE_PARTIAL_FULL;
    if (getBit(bufferPosition+STATE_OFFSET_FULL)) result |= BUFFER_STATE_FULL;
    return FEDBufferState(result);
  }

bool sistrip::FEDBackendStatusRegister::internalFreezeFlag ( ) const

inline

Definition at line 900 of file SiStripFEDBufferComponents.h.

References getBit().

    { return getBit(1); }

FEDBufferState sistrip::FEDBackendStatusRegister::l1aBxFIFOState ( ) const

inline

Definition at line 956 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_L1ABX_FIFO, and getBufferState().

    {
      return getBufferState(BUFFER_POSITION_L1ABX_FIFO);
    }

sistrip::FEDBackendStatusRegister::operator uint32_t ( ) const

inline

Definition at line 891 of file SiStripFEDBufferComponents.h.

References data_.

    { return data_; }

void sistrip::FEDBackendStatusRegister::print ( std::ostream &  os ) const

inline

Definition at line 894 of file SiStripFEDBufferComponents.h.

References data_, and sistrip::printHex().

    { printHex(&data_,4,os); }

void sistrip::FEDBackendStatusRegister::printFlags

(

std::ostream &

os

)

const

Definition at line 612 of file SiStripFEDBufferComponents.cc.

References sistrip::FEDStatusRegister::l1aBxFIFOState(), sistrip::FEDStatusRegister::qdrMemoryState(), sistrip::FEDStatusRegister::slinkFullFlag(), and sistrip::FEDStatusRegister::trackerHeaderMonitorDataReadyFlag().

  {
    if (internalFreezeFlag()) os << "INTERNAL_FREEZE ";
    if (slinkDownFlag()) os << "SLINK_DOWN ";
    if (slinkFullFlag()) os << "SLINK_FULL ";
    if (backpressureFlag()) os << "BACKPRESSURE ";
    if (ttcReadyFlag()) os << "TTC_READY ";
    if (trackerHeaderMonitorDataReadyFlag()) os << "HEADER_MONITOR_READY ";
    printFlagsForBuffer(qdrMemoryState(),"QDR",os);
    printFlagsForBuffer(frameAddressFIFOState(),"FRAME_ADDRESS",os);
    printFlagsForBuffer(totalLengthFIFOState(),"TOTAL_LENGTH",os);
    printFlagsForBuffer(trackerHeaderFIFOState(),"TRACKER_HEADER",os);
    printFlagsForBuffer(l1aBxFIFOState(),"L1ABX",os);
    printFlagsForBuffer(feEventLengthFIFOState(),"FE_LENGTH",os);
    printFlagsForBuffer(feFPGABufferState(),"FE",os);
  }

void sistrip::FEDBackendStatusRegister::printFlagsForBuffer ( const FEDBufferState  bufferState, const std::string  name, std::ostream &  os  ) const

private

Definition at line 629 of file SiStripFEDBufferComponents.cc.

References sistrip::BUFFER_STATE_EMPTY, sistrip::BUFFER_STATE_FULL, sistrip::BUFFER_STATE_PARTIAL_FULL, and sistrip::BUFFER_STATE_UNSET.

  {
    if (bufferState&BUFFER_STATE_EMPTY) os << name << "_EMPTY ";
    if (bufferState&BUFFER_STATE_PARTIAL_FULL) os << name << "_PARTIAL_FULL ";
    if (bufferState&BUFFER_STATE_FULL) os << name << "_FULL ";
    if (bufferState == BUFFER_STATE_UNSET) os << name << "_UNSET ";
  }

FEDBufferState sistrip::FEDBackendStatusRegister::qdrMemoryState ( ) const

inline

Definition at line 936 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_QDR_MEMORY, and getBufferState().

    {
      return getBufferState(BUFFER_POSITION_QDR_MEMORY);
    }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setBackpressureFlag ( const bool  bitSet )

inline

Definition at line 927 of file SiStripFEDBufferComponents.h.

References setBit().

Referenced by FEDBackendStatusRegister().

    { setBit(4,bitSet); return *this; }

void sistrip::FEDBackendStatusRegister::setBit ( const uint8_t  num, const bool  bitSet  )

private

Definition at line 665 of file SiStripFEDBufferComponents.cc.

References sistrip::FEDStatusRegister::data_, RecoTauDiscriminantConfiguration::mask, and pileupDistInMC::num.

Referenced by sistrip::FEDFullDebugHeader::setAPVAddressError(), sistrip::FEDFullDebugHeader::setAPVError(), setBackpressureFlag(), setInternalFreezeFlag(), sistrip::FEDFullDebugHeader::setOutOfSync(), setSLinkDownFlag(), setSLinkFullFlag(), setTrackerHeaderMonitorDataReadyFlag(), setTTCReadyFlag(), and sistrip::FEDFullDebugHeader::setUnlocked().

  {
    const uint32_t mask = (0x00000001 << num);
    if (bitSet) data_ |= mask;
    else data_ &= (~mask);
  }

void sistrip::FEDBackendStatusRegister::setBufferSate ( const uint8_t  bufferPosition, const FEDBufferState  state  )

private

Definition at line 646 of file SiStripFEDBufferComponents.cc.

References sistrip::BUFFER_STATE_EMPTY, sistrip::BUFFER_STATE_FULL, sistrip::BUFFER_STATE_PARTIAL_FULL, sistrip::BUFFER_STATE_UNSET, Exception, sistrip::printHex(), and sistrip::FEDStatusRegister::setBit().

Referenced by setFEEventLengthFIFOState(), setFEFPGABufferState(), setFrameAddressFIFOState(), setL1ABXFIFOState(), setQDRMemoryState(), setTotalLengthFIFOState(), and setTrackerHeaderFIFOState().

  {
    switch (state) {
    case BUFFER_STATE_FULL:
    case BUFFER_STATE_PARTIAL_FULL:
    case BUFFER_STATE_EMPTY:
    case BUFFER_STATE_UNSET:
      break;
    default:
      std::ostringstream ss;
      ss << "Invalid buffer state: ";
      printHex(&state,1,ss);
      throw cms::Exception("FEDBuffer") << ss.str();
    }
    setBit(bufferPosition+STATE_OFFSET_EMPTY, state&BUFFER_STATE_EMPTY);
    setBit(bufferPosition+STATE_OFFSET_PARTIAL_FULL, state&BUFFER_STATE_PARTIAL_FULL);
    setBit(bufferPosition+STATE_OFFSET_FULL, state&BUFFER_STATE_FULL);
  }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setFEEventLengthFIFOState ( const FEDBufferState  state )

inline

Definition at line 1001 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_FE_EVENT_LENGTH_FIFO, and setBufferSate().

Referenced by FEDBackendStatusRegister().

    {
      setBufferSate(BUFFER_POSITION_FE_EVENT_LENGTH_FIFO,state);
      return *this;
    }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setFEFPGABufferState ( const FEDBufferState  state )

inline

Definition at line 1007 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_FE_FPGA_BUFFER, and setBufferSate().

Referenced by FEDBackendStatusRegister().

    {
      setBufferSate(BUFFER_POSITION_FE_FPGA_BUFFER,state);
      return *this;
    }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setFrameAddressFIFOState ( const FEDBufferState  state )

inline

Definition at line 977 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_FRAME_ADDRESS_FIFO, and setBufferSate().

Referenced by FEDBackendStatusRegister().

    {
      setBufferSate(BUFFER_POSITION_FRAME_ADDRESS_FIFO,state);
      return *this;
    }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setInternalFreezeFlag ( const bool  bitSet )

inline

Definition at line 918 of file SiStripFEDBufferComponents.h.

References setBit().

Referenced by FEDBackendStatusRegister().

    { setBit(1,bitSet); return *this; }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setL1ABXFIFOState ( const FEDBufferState  state )

inline

Definition at line 995 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_L1ABX_FIFO, and setBufferSate().

Referenced by FEDBackendStatusRegister().

    {
      setBufferSate(BUFFER_POSITION_L1ABX_FIFO,state);
      return *this;
    }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setQDRMemoryState ( const FEDBufferState  state )

inline

Definition at line 971 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_QDR_MEMORY, and setBufferSate().

Referenced by FEDBackendStatusRegister().

    {
      setBufferSate(BUFFER_POSITION_QDR_MEMORY,state);
      return *this;
    }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setSLinkDownFlag ( const bool  bitSet )

inline

Definition at line 921 of file SiStripFEDBufferComponents.h.

References setBit().

Referenced by FEDBackendStatusRegister().

    { setBit(2,bitSet); return *this; }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setSLinkFullFlag ( const bool  bitSet )

inline

Definition at line 924 of file SiStripFEDBufferComponents.h.

References setBit().

Referenced by FEDBackendStatusRegister().

    { setBit(3,bitSet); return *this; }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setTotalLengthFIFOState ( const FEDBufferState  state )

inline

Definition at line 983 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_TOTAL_LENGTH_FIFO, and setBufferSate().

Referenced by FEDBackendStatusRegister().

    {
      setBufferSate(BUFFER_POSITION_TOTAL_LENGTH_FIFO,state);
      return *this;
    }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setTrackerHeaderFIFOState ( const FEDBufferState  state )

inline

Definition at line 989 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_TRACKER_HEADER_FIFO, and setBufferSate().

Referenced by FEDBackendStatusRegister().

    {
      setBufferSate(BUFFER_POSITION_TRACKER_HEADER_FIFO,state);
      return *this;
    }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setTrackerHeaderMonitorDataReadyFlag ( const bool  bitSet )

inline

Definition at line 933 of file SiStripFEDBufferComponents.h.

References setBit().

Referenced by FEDBackendStatusRegister().

    { setBit(7,bitSet); return *this; }

FEDBackendStatusRegister & sistrip::FEDBackendStatusRegister::setTTCReadyFlag ( const bool  bitSet )

inline

Definition at line 930 of file SiStripFEDBufferComponents.h.

References setBit().

Referenced by FEDBackendStatusRegister().

    { setBit(6,bitSet); return *this; }

bool sistrip::FEDBackendStatusRegister::slinkDownFlag ( ) const

inline

Definition at line 903 of file SiStripFEDBufferComponents.h.

References getBit().

    { return getBit(2); }

bool sistrip::FEDBackendStatusRegister::slinkFullFlag ( ) const

inline

Definition at line 906 of file SiStripFEDBufferComponents.h.

References getBit().

    { return getBit(3); }

FEDBufferState sistrip::FEDBackendStatusRegister::totalLengthFIFOState ( ) const

inline

Definition at line 946 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_TOTAL_LENGTH_FIFO, and getBufferState().

    {
      return getBufferState(BUFFER_POSITION_TOTAL_LENGTH_FIFO);
    }

FEDBufferState sistrip::FEDBackendStatusRegister::trackerHeaderFIFOState ( ) const

inline

Definition at line 951 of file SiStripFEDBufferComponents.h.

References BUFFER_POSITION_TRACKER_HEADER_FIFO, and getBufferState().

    {
      return getBufferState(BUFFER_POSITION_TRACKER_HEADER_FIFO);
    }

bool sistrip::FEDBackendStatusRegister::trackerHeaderMonitorDataReadyFlag ( ) const

inline

Definition at line 915 of file SiStripFEDBufferComponents.h.

References getBit().

    { return getBit(7); }

bool sistrip::FEDBackendStatusRegister::ttcReadyFlag ( ) const

inline

Definition at line 912 of file SiStripFEDBufferComponents.h.

References getBit().

    { return getBit(6); }

Member Data Documentation

uint32_t sistrip::FEDBackendStatusRegister::data_

private

Definition at line 404 of file SiStripFEDBufferComponents.h.

Referenced by getBit(), operator uint32_t(), and print().