Phase2Tracker::Phase2TrackerFEDHeader Class Reference

#include <Phase2TrackerFEDHeader.h>

Public Member Functions
std::vector< uint8_t >	CBCStatus () const
std::vector< bool >	frontendStatus () const
uint8_t	getConditionData () const
uint8_t	getDataFormatVersion () const
uint8_t	getDataType () const
READ_MODE	getDebugMode () const
uint8_t	getEventType () const
uint64_t	getGlibStatusCode () const
uint16_t	getNumberOfCBC () const
const uint8_t *	getPointerToData () const
FEDReadoutMode	getReadoutMode () const
uint8_t	getTrackerHeaderSize () const
	Phase2TrackerFEDHeader ()
	Phase2TrackerFEDHeader (const uint8_t *headerPointer)

Private Member Functions
uint8_t	conditionData () const
uint8_t	dataFormatVersion () const
uint8_t	dataType () const
READ_MODE	debugMode () const
uint8_t	eventType () const
uint64_t	glibStatusCode () const
void	init ()
uint16_t	numberOfCBC () const
const uint8_t *	pointerToData ()
FEDReadoutMode	readoutMode () const

Private Attributes
uint8_t	conditionData_
uint8_t	dataFormatVersion_
uint8_t	dataType_
READ_MODE	debugMode_
uint8_t	eventType_
uint64_t	glibStatusCode_
uint64_t	header_first_word_
uint64_t	header_second_word_
uint16_t	numberOfCBC_
const uint8_t *	pointerToData_
FEDReadoutMode	readoutMode_
const uint8_t *	trackerHeader_
uint8_t	trackerHeaderSize_

Detailed Description

Definition at line 12 of file Phase2TrackerFEDHeader.h.

Constructor & Destructor Documentation

Phase2Tracker::Phase2TrackerFEDHeader::Phase2TrackerFEDHeader ( )

inline

Definition at line 14 of file Phase2TrackerFEDHeader.h.

{}

Phase2Tracker::Phase2TrackerFEDHeader::Phase2TrackerFEDHeader ( const uint8_t *  headerPointer )

explicit

Definition at line 8 of file Phase2TrackerFEDHeader.cc.

References header_first_word_, header_second_word_, init(), Phase2Tracker::read64(), and trackerHeader_.

                                                                             : trackerHeader_(headerPointer) {
    header_first_word_ = read64(0, trackerHeader_);
    header_second_word_ = read64(8, trackerHeader_);
    // decode the Tracker Header and store info
    init();
  }

Member Function Documentation

std::vector< uint8_t > Phase2Tracker::Phase2TrackerFEDHeader::CBCStatus

(

)

const

Definition at line 127 of file Phase2TrackerFEDHeader.cc.

References Phase2Tracker::CBC_ERROR, debugMode_, Phase2Tracker::FULL_DEBUG, header_second_word_, numberOfCBC(), hltrates_dqm_sourceclient-live_cfg::offset, Phase2Tracker::read64(), and trackerHeader_.

Referenced by Phase2Tracker::Phase2TrackerDigiProducer::produce().

                                                             {
    // set offset and data to begining of second header 64 bit word
    int offset = 8;
    uint64_t data64 = header_second_word_;
    // number of CBC:
    uint16_t cbc_num = numberOfCBC();
    // size of data per CBC (in bits)
    int status_size = 0;
    if (debugMode_ == FULL_DEBUG) {
      status_size = 8;
    } else if (debugMode_ == CBC_ERROR) {
      status_size = 1;
    }
    // starting byte for CBC status bits
    std::vector<uint8_t> cbc_status;
    if (status_size == 8) {
      int num_bytes = cbc_num;
      int current_byte = 5;
      while (num_bytes > 0) {
        cbc_status.push_back(static_cast<uint8_t>((data64 >> current_byte * 8) & 0xFF));
        if (current_byte == 0) {
          current_byte = 8;
          offset += 8;
          data64 = read64(offset, trackerHeader_);
        }
        current_byte--;
        num_bytes--;
      }
    } else if (status_size == 1) {
      int current_bit = 47;
      int num_bits = cbc_num;
      while (num_bits > 0) {
        cbc_status.push_back(static_cast<uint8_t>((data64 >> current_bit) & 0x1));
        if (current_bit == 0) {
          current_bit = 64;
          offset += 8;
          data64 = read64(offset, trackerHeader_);
        }
        current_bit--;
        num_bits--;
      }
    }

    return cbc_status;
  }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::conditionData ( ) const

private

Definition at line 101 of file Phase2TrackerFEDHeader.cc.

References eventType_.

Referenced by init().

{ return static_cast<uint8_t>(eventType_ >> 1) & 0x1; }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::dataFormatVersion ( ) const

private

Definition at line 44 of file Phase2TrackerFEDHeader.cc.

References Exception, Phase2Tracker::extract64(), header_first_word_, Phase2Tracker::printHex(), contentValuesCheck::ss, Phase2Tracker::VERSION_M, and Phase2Tracker::VERSION_S.

Referenced by init().

                                                          {
    uint8_t Version = static_cast<uint8_t>(extract64(VERSION_M, VERSION_S, header_first_word_));
    if (Version != 1) {
      std::ostringstream ss;
      ss << "[Phase2Tracker::Phase2TrackerFEDHeader::" << __func__ << "] ";
      ss << "Invalid Data Format Version in Traker Header : ";
      printHex(&header_first_word_, 1, ss);
      throw cms::Exception("Phase2TrackerFEDBuffer") << ss.str();
    }
    return Version;
  }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::dataType ( ) const

private

Definition at line 103 of file Phase2TrackerFEDHeader.cc.

References eventType_.

Referenced by init().

{ return static_cast<uint8_t>(eventType_) & 0x1; }

READ_MODE Phase2Tracker::Phase2TrackerFEDHeader::debugMode ( ) const

private

Definition at line 56 of file Phase2TrackerFEDHeader.cc.

References Phase2Tracker::CBC_ERROR, Exception, Phase2Tracker::extract64(), Phase2Tracker::FULL_DEBUG, header_first_word_, Phase2Tracker::HEADER_FORMAT_M, Phase2Tracker::HEADER_FORMAT_S, universalConfigTemplate::mode, Phase2Tracker::printHex(), Phase2Tracker::READ_MODE_INVALID, contentValuesCheck::ss, and Phase2Tracker::SUMMARY.

Referenced by init().

                                                    {
    // Read debugMode in Tracker Header
    uint8_t mode = static_cast<uint8_t>(extract64(HEADER_FORMAT_M, HEADER_FORMAT_S, header_first_word_));

    switch (mode) {  // check if it is one of correct modes
      case SUMMARY:
        return READ_MODE(SUMMARY);
      case FULL_DEBUG:
        return READ_MODE(FULL_DEBUG);
      case CBC_ERROR:
        return READ_MODE(CBC_ERROR);
      default:  // else create Exception
        std::ostringstream ss;
        ss << "[Phase2Tracker::Phase2TrackerFEDHeader::" << __func__ << "] ";
        ss << "Invalid Header Format in Traker Header : ";
        printHex(&header_first_word_, 1, ss);
        throw cms::Exception("Phase2TrackerFEDBuffer") << ss.str();
    }

    return READ_MODE(READ_MODE_INVALID);
  }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::eventType ( ) const

private

Definition at line 78 of file Phase2TrackerFEDHeader.cc.

References Phase2Tracker::EVENT_TYPE_M, Phase2Tracker::EVENT_TYPE_S, Phase2Tracker::extract64(), and header_first_word_.

Referenced by init().

                                                  {
    return static_cast<uint8_t>(extract64(EVENT_TYPE_M, EVENT_TYPE_S, header_first_word_));
  }

std::vector< bool > Phase2Tracker::Phase2TrackerFEDHeader::frontendStatus

(

)

const

Definition at line 109 of file Phase2TrackerFEDHeader.cc.

References Phase2Tracker::extract64(), Phase2Tracker::FRONTEND_STAT_M, Phase2Tracker::FRONTEND_STAT_S, header_first_word_, mps_fire::i, and mps_update::status.

Referenced by Phase2Tracker::Phase2TrackerFEDBuffer::findChannels(), and Phase2Tracker::Phase2TrackerDigiProducer::produce().

                                                               {
    uint16_t FE_status = static_cast<uint16_t>(extract64(FRONTEND_STAT_M, FRONTEND_STAT_S, header_first_word_));
    std::vector<bool> status(16, false);
    for (int i = 0; i < 16; i++) {
      status[i] = (FE_status >> i) & 0x1;
    }
    return status;
  }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::getConditionData ( ) const

inline

Definition at line 24 of file Phase2TrackerFEDHeader.h.

References conditionData_.

Referenced by Phase2Tracker::Phase2TrackerFEDBuffer::findChannels(), and Phase2Tracker::Phase2TrackerDigiProducer::produce().

{ return conditionData_; }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::getDataFormatVersion ( ) const

inline

Definition at line 19 of file Phase2TrackerFEDHeader.h.

References dataFormatVersion_.

Referenced by Phase2Tracker::Phase2TrackerDigiProducer::produce().

{ return dataFormatVersion_; }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::getDataType ( ) const

inline

Definition at line 25 of file Phase2TrackerFEDHeader.h.

References dataType_.

Referenced by Phase2Tracker::Phase2TrackerDigiProducer::produce().

{ return dataType_; }

READ_MODE Phase2Tracker::Phase2TrackerFEDHeader::getDebugMode ( ) const

inline

Definition at line 20 of file Phase2TrackerFEDHeader.h.

References debugMode_.

Referenced by Phase2Tracker::Phase2TrackerDigiProducer::produce().

{ return debugMode_; }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::getEventType ( ) const

inline

Definition at line 22 of file Phase2TrackerFEDHeader.h.

References eventType_.

Referenced by Phase2Tracker::Phase2TrackerDigiProducer::produce().

{ return eventType_; }

uint64_t Phase2Tracker::Phase2TrackerFEDHeader::getGlibStatusCode ( ) const

inline

Definition at line 27 of file Phase2TrackerFEDHeader.h.

References glibStatusCode_.

Referenced by Phase2Tracker::Phase2TrackerDigiProducer::produce().

{ return glibStatusCode_; }

uint16_t Phase2Tracker::Phase2TrackerFEDHeader::getNumberOfCBC ( ) const

inline

Definition at line 28 of file Phase2TrackerFEDHeader.h.

References numberOfCBC_.

Referenced by Phase2Tracker::Phase2TrackerDigiProducer::produce().

{ return numberOfCBC_; }

const uint8_t* Phase2Tracker::Phase2TrackerFEDHeader::getPointerToData ( ) const

inline

Definition at line 31 of file Phase2TrackerFEDHeader.h.

References pointerToData_.

Referenced by Phase2Tracker::Phase2TrackerFEDBuffer::getPointerToPayload().

{ return pointerToData_; }

FEDReadoutMode Phase2Tracker::Phase2TrackerFEDHeader::getReadoutMode ( ) const

inline

Definition at line 23 of file Phase2TrackerFEDHeader.h.

References readoutMode_.

Referenced by Phase2Tracker::Phase2TrackerDigiProducer::produce(), and Phase2Tracker::Phase2TrackerFEDBuffer::readoutMode().

{ return readoutMode_; }

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::getTrackerHeaderSize ( ) const

inline

Definition at line 35 of file Phase2TrackerFEDHeader.h.

References trackerHeaderSize_.

Referenced by Phase2Tracker::Phase2TrackerFEDBuffer::findChannels().

{ return trackerHeaderSize_; }

uint64_t Phase2Tracker::Phase2TrackerFEDHeader::glibStatusCode ( ) const

private

Definition at line 105 of file Phase2TrackerFEDHeader.cc.

References Phase2Tracker::extract64(), Phase2Tracker::GLIB_STATUS_M, Phase2Tracker::GLIB_STATUS_S, and header_first_word_.

Referenced by init().

                                                        {
    return extract64(GLIB_STATUS_M, GLIB_STATUS_S, header_first_word_);
  }

void Phase2Tracker::Phase2TrackerFEDHeader::init ( void  )

private

Definition at line 15 of file Phase2TrackerFEDHeader.cc.

References conditionData(), conditionData_, dataFormatVersion(), dataFormatVersion_, dataType(), dataType_, debugMode(), debugMode_, TauDecayModes::dec, eventType(), eventType_, glibStatusCode(), glibStatusCode_, LogTrace, numberOfCBC(), numberOfCBC_, pointerToData(), pointerToData_, readoutMode(), and readoutMode_.

Referenced by Phase2TrackerFEDHeader().

                                    {
    dataFormatVersion_ = dataFormatVersion();
    debugMode_ = debugMode();
    // WARNING: eventType must be called before
    // readoutMode, conditionData and dataType
    // as this info is stored in eventType
    eventType_ = eventType();
    readoutMode_ = readoutMode();
    conditionData_ = conditionData();
    dataType_ = dataType();

    glibStatusCode_ = glibStatusCode();
    // numberOfCBC must be called before pointerToData
    numberOfCBC_ = numberOfCBC();
    pointerToData_ = pointerToData();

    LogTrace("Phase2TrackerFEDBuffer") << "[Phase2Tracker::Phase2TrackerFEDHeader::" << __func__ << "]: \n"
                                       << " Tracker Header contents:\n"
                                       << "  -- Data Format Version : " << uint32_t(dataFormatVersion_) << "\n"
                                       << "  -- Debug Level         : " << debugMode_ << "\n"
                                       << "  -- Operating Mode      : " << readoutMode_ << "\n"
                                       << "  -- Condition Data      : " << (conditionData_ ? "Present" : "Absent")
                                       << "\n"
                                       << "  -- Data Type           : " << (dataType_ ? "Real" : "Fake") << "\n"
                                       << "  -- Glib Stat registers : " << std::hex << std::setw(16) << glibStatusCode_
                                       << "\n"
                                       << "  -- connected CBC       : " << std::dec << numberOfCBC_ << "\n";
  }

uint16_t Phase2Tracker::Phase2TrackerFEDHeader::numberOfCBC ( ) const

private

Definition at line 118 of file Phase2TrackerFEDHeader.cc.

References Phase2Tracker::CBC_NUMBER_M, Phase2Tracker::CBC_NUMBER_S, debugMode_, Phase2Tracker::extract64(), header_second_word_, and Phase2Tracker::SUMMARY.

Referenced by CBCStatus(), init(), and pointerToData().

                                                     {
    if (debugMode_ != SUMMARY) {
      return static_cast<uint16_t>(extract64(CBC_NUMBER_M, CBC_NUMBER_S, header_second_word_));
    } else {
      return 0;
    }
  }

const uint8_t * Phase2Tracker::Phase2TrackerFEDHeader::pointerToData ( )

private

Definition at line 173 of file Phase2TrackerFEDHeader.cc.

References Phase2Tracker::CBC_ERROR, debugMode_, Phase2Tracker::FULL_DEBUG, numberOfCBC(), trackerHeader_, and trackerHeaderSize_.

Referenced by init().

                                                       {
    int status_size = 0;
    int cbc_num = numberOfCBC();
    // CAUTION: we express all sizes in bits here
    if (debugMode_ == FULL_DEBUG) {
      status_size = 8;
    } else if (debugMode_ == CBC_ERROR) {
      status_size = 1;
    }
    // compute number of additional 64 bit words before payload
    int num_add_words64 = (cbc_num * status_size - 48 + 64 - 1) / 64;
    // back to bytes
    trackerHeaderSize_ = (2 + num_add_words64) * 8;
    return &trackerHeader_[trackerHeaderSize_];
  }

FEDReadoutMode Phase2Tracker::Phase2TrackerFEDHeader::readoutMode ( ) const

private

Definition at line 83 of file Phase2TrackerFEDHeader.cc.

References eventType_, Exception, header_first_word_, universalConfigTemplate::mode, Phase2Tracker::printHex(), Phase2Tracker::READOUT_MODE_PROC_RAW, Phase2Tracker::READOUT_MODE_ZERO_SUPPRESSED, and contentValuesCheck::ss.

Referenced by init().

                                                           {
    // readout mode is first bit of event type
    uint8_t mode = static_cast<uint8_t>(eventType_ >> 2) & 0x3;

    switch (mode) {  // check if it is one of correct modes
      case 2:
        return FEDReadoutMode(READOUT_MODE_PROC_RAW);
      case 1:
        return FEDReadoutMode(READOUT_MODE_ZERO_SUPPRESSED);
      default:  // else create Exception
        std::ostringstream ss;
        ss << "[Phase2Tracker::Phase2TrackerFEDHeader::" << __func__ << "] ";
        ss << "Invalid Readout Mode in Traker Header : ";
        printHex(&header_first_word_, 1, ss);
        throw cms::Exception("Phase2TrackerFEDBuffer") << ss.str();
    }
  }

Member Data Documentation

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::conditionData_

private

Definition at line 74 of file Phase2TrackerFEDHeader.h.

Referenced by getConditionData(), and init().

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::dataFormatVersion_

private

Definition at line 70 of file Phase2TrackerFEDHeader.h.

Referenced by getDataFormatVersion(), and init().

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::dataType_

private

Definition at line 75 of file Phase2TrackerFEDHeader.h.

Referenced by getDataType(), and init().

READ_MODE Phase2Tracker::Phase2TrackerFEDHeader::debugMode_

private

Definition at line 71 of file Phase2TrackerFEDHeader.h.

Referenced by CBCStatus(), getDebugMode(), init(), numberOfCBC(), and pointerToData().

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::eventType_

private

Definition at line 72 of file Phase2TrackerFEDHeader.h.

Referenced by conditionData(), dataType(), getEventType(), init(), and readoutMode().

uint64_t Phase2Tracker::Phase2TrackerFEDHeader::glibStatusCode_

private

Definition at line 76 of file Phase2TrackerFEDHeader.h.

Referenced by getGlibStatusCode(), and init().

uint64_t Phase2Tracker::Phase2TrackerFEDHeader::header_first_word_

private

Definition at line 68 of file Phase2TrackerFEDHeader.h.

Referenced by dataFormatVersion(), debugMode(), eventType(), frontendStatus(), glibStatusCode(), Phase2TrackerFEDHeader(), and readoutMode().

uint64_t Phase2Tracker::Phase2TrackerFEDHeader::header_second_word_

private

Definition at line 69 of file Phase2TrackerFEDHeader.h.

Referenced by CBCStatus(), numberOfCBC(), and Phase2TrackerFEDHeader().

uint16_t Phase2Tracker::Phase2TrackerFEDHeader::numberOfCBC_

private

Definition at line 77 of file Phase2TrackerFEDHeader.h.

Referenced by getNumberOfCBC(), and init().

const uint8_t* Phase2Tracker::Phase2TrackerFEDHeader::pointerToData_

private

Definition at line 66 of file Phase2TrackerFEDHeader.h.

Referenced by getPointerToData(), and init().

FEDReadoutMode Phase2Tracker::Phase2TrackerFEDHeader::readoutMode_

private

Definition at line 73 of file Phase2TrackerFEDHeader.h.

Referenced by getReadoutMode(), and init().

const uint8_t* Phase2Tracker::Phase2TrackerFEDHeader::trackerHeader_

private

Definition at line 65 of file Phase2TrackerFEDHeader.h.

Referenced by CBCStatus(), Phase2TrackerFEDHeader(), and pointerToData().

uint8_t Phase2Tracker::Phase2TrackerFEDHeader::trackerHeaderSize_

private

Definition at line 67 of file Phase2TrackerFEDHeader.h.

Referenced by getTrackerHeaderSize(), and pointerToData().