#include <SiStripFEDBuffer.h>

Inheritance diagram for sistrip::FEDBuffer:

Public Member Functions
bool	channelGood (const uint8_t internalFEDannelNum, const bool doAPVeCheck) const

bool	checkAllChannelStatusBits () const

bool	checkChannelLengths () const

bool	checkChannelLengthsMatchBufferLength () const

bool	checkChannelPacketCodes () const

bool	checkFEPayloadsPresent () const

bool	checkFEUnitAPVAddresses () const

bool	checkFEUnitLengths () const

bool	checkStatusBits (const uint8_t internalFEDChannelNum) const

bool	checkStatusBits (const uint8_t internalFEUnitNum, const uint8_t internalChannelNum) const

std::string	checkSummary () const override

bool	doChecks (bool doCRC) const

virtual bool	doCorruptBufferChecks () const

	FEDBuffer (const FEDRawData &fedBuffer, const bool allowBadBuffer=false)

bool	feGood (const uint8_t internalFEUnitNum) const

bool	feGoodWithoutAPVEmulatorCheck (const uint8_t internalFEUnitNum) const

const FEDFEHeader *	feHeader () const

bool	fePresent (uint8_t internalFEUnitNum) const

FEDBufferStatusCode	findChannels ()

void	print (std::ostream &os) const override

void	setLegacyMode (bool legacy)

	~FEDBuffer () override

Public Member Functions inherited from sistrip::FEDBufferBase
uint8_t	apveAddress () const

FEDBufferFormat	bufferFormat () const

size_t	bufferSize () const

uint16_t	calcCRC () const

const FEDChannel &	channel (const uint8_t internalFEDChannelNum) const

const FEDChannel &	channel (const uint8_t internalFEUnitNum, const uint8_t internalChannelNum) const

virtual bool	channelGood (const uint8_t internalFEDChannelNum) const

bool	channelGood (const uint8_t internalFEUnitNum, const uint8_t internalChannelNum) const

bool	checkAPVEAddressValid () const

bool	checkBufferFormat () const

bool	checkCRC () const

bool	checkHeaderType () const

bool	checkLengthFromTrailer () const

bool	checkMajorityAddresses () const

bool	checkNoExtraHeadersOrTrailers () const

bool	checkNoFEOverflows () const

bool	checkNoSlinkCRCError () const

bool	checkNoSLinkTransmissionError () const

bool	checkNoUnexpectedSourceID () const

bool	checkReadoutMode () const

bool	checkSourceIDs () const

uint16_t	daqBXID () const

uint16_t	daqCRC () const

uint32_t	daqEventLengthIn64bitWords () const

uint32_t	daqEventLengthInBytes () const

FEDDAQEventType	daqEventType () const

FEDDAQHeader	daqHeader () const

uint32_t	daqLvl1ID () const

uint16_t	daqSourceID () const

FEDDAQTrailer	daqTrailer () const

FEDTTSBits	daqTTSState () const

bool	doChecks () const

bool	doDAQHeaderAndTrailerChecks () const

bool	doTrackerSpecialHeaderChecks () const

void	dump (std::ostream &os) const

void	dumpOriginalBuffer (std::ostream &os) const

	FEDBufferBase (const FEDRawData &fedBuffer)

FEDStatusRegister	fedStatusRegister () const

bool	feEnabled (const uint8_t internalFEUnitNum) const

bool	feOverflow (const uint8_t internalFEUnitNum) const

FEDHeaderType	headerType () const

FEDLegacyReadoutMode	legacyReadoutMode () const

bool	majorityAddressErrorForFEUnit (const uint8_t internalFEUnitNum) const

uint8_t	nFEUnitsEnabled () const

uint8_t	packetCode (bool legacy=false, const uint8_t internalFEDChannelNum=0) const

FEDReadoutMode	readoutMode () const

uint16_t	sourceID () const

TrackerSpecialHeader	trackerSpecialHeader () const

virtual	~FEDBufferBase ()

Private Member Functions
uint16_t	calculateFEUnitLength (const uint8_t internalFEUnitNumber) const

uint8_t	getCorrectPacketCode () const

uint8_t	nFEUnitsPresent () const

Private Attributes
std::unique_ptr< FEDFEHeader >	feHeader_

bool	fePresent_ [FEUNITS_PER_FED]

bool	legacyUnpacker_ = false

uint16_t	payloadLength_

const uint8_t *	payloadPointer_

uint8_t	validChannels_

Additional Inherited Members
Protected Member Functions inherited from sistrip::FEDBufferBase
	FEDBufferBase (const FEDRawData &fedBuffer, const bool fillChannelVector)

const uint8_t *	getPointerToByteAfterEndOfPayload () const

const uint8_t *	getPointerToDataAfterTrackerSpecialHeader () const

Protected Attributes inherited from sistrip::FEDBufferBase
std::vector< FEDChannel >	channels_

Detailed Description

Definition at line 24 of file SiStripFEDBuffer.h.

Constructor & Destructor Documentation

◆ FEDBuffer()

sistrip::FEDBuffer::FEDBuffer	(	const FEDRawData &	fedBuffer,
		const bool	allowBadBuffer = `false`
	)

explicit

constructor from a FEDRawData buffer

The sistrip::preconstructCheckFEDBuffer() method should be used (with the same value of allowBadBuffer) to check the validity of fedBuffer before constructing a sistrip::FEDBuffer. If allowBadBuffer is set to true, the initialization proceeds even if the event format is not recognized. To initialize also the channel information, the FEDBuffer::findChannels() method should be called as well, and its return status checked (unless bad buffers, with an unrecognized event format or channel lengths that do not make sense, should also be included).

See also: sistrip::preconstructCheckFEDBuffer() sistrip::FEDBuffer::findChannels()

Definition at line 13 of file SiStripFEDBuffer.cc.

                                                                              : FEDBufferBase(fedBuffer, false) {
     validChannels_ = 0;
     channels_.reserve(FEDCH_PER_FED);
     //build the correct type of FE header object
     if ((headerType() != HEADER_TYPE_INVALID) && (headerType() != HEADER_TYPE_NONE)) {
       feHeader_ = FEDFEHeader::newFEHeader(headerType(), getPointerToDataAfterTrackerSpecialHeader());
       payloadPointer_ = getPointerToDataAfterTrackerSpecialHeader() + feHeader_->lengthInBytes();
     } else {
       feHeader_ = std::unique_ptr<FEDFEHeader>();
       payloadPointer_ = getPointerToDataAfterTrackerSpecialHeader();
     }
     payloadLength_ = getPointerToByteAfterEndOfPayload() - payloadPointer_;
     //check if FE units are present in data
     //in Full Debug mode, use the lengths from the header
     const FEDFullDebugHeader* fdHeader = dynamic_cast<FEDFullDebugHeader*>(feHeader_.get());
     if (fdHeader) {
       for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
         if (fdHeader->fePresent(iFE))
           fePresent_[iFE] = true;
         else
           fePresent_[iFE] = false;
       }
     }
     //in APV error mode, use the FE present byte in the FED status register
     // a value of '1' means a FE unit's data is missing (in old firmware versions it is always 0)
     else {
       for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
         if (fedStatusRegister().feDataMissingFlag(iFE))
           fePresent_[iFE] = false;
         else
           fePresent_[iFE] = true;
       }
     }
   }

References sistrip::FEDBufferBase::channels_, sistrip::FEDStatusRegister::feDataMissingFlag(), sistrip::FEDCH_PER_FED, sistrip::FEDBufferBase::fedStatusRegister(), feHeader_, sistrip::FEDFullDebugHeader::fePresent(), fePresent_, sistrip::FEUNITS_PER_FED, sistrip::FEDBufferBase::getPointerToByteAfterEndOfPayload(), sistrip::FEDBufferBase::getPointerToDataAfterTrackerSpecialHeader(), sistrip::HEADER_TYPE_INVALID, sistrip::HEADER_TYPE_NONE, sistrip::FEDBufferBase::headerType(), sistrip::FEDFEHeader::newFEHeader(), payloadLength_, payloadPointer_, and validChannels_.

◆ ~FEDBuffer()

sistrip::FEDBuffer::~FEDBuffer ( )

inlineoverride

Definition at line 42 of file SiStripFEDBuffer.h.

42 {}

Member Function Documentation

◆ calculateFEUnitLength()

uint16_t sistrip::FEDBuffer::calculateFEUnitLength ( const uint8_t internalFEUnitNumber ) const

private

Definition at line 257 of file SiStripFEDBuffer.cc.

                                                                                     {
     //get length from channels
     uint16_t lengthFromChannels = 0;
     for (uint8_t iCh = 0; iCh < FEDCH_PER_FEUNIT; iCh++) {
       lengthFromChannels += channels_[internalFEDChannelNum(internalFEUnitNumber, iCh)].length();
     }
     return lengthFromChannels;
   }

References sistrip::FEDBufferBase::channels_, sistrip::FEDCH_PER_FEUNIT, and sistrip::internalFEDChannelNum().

Referenced by checkFEUnitLengths(), and checkSummary().

◆ channelGood()

bool sistrip::FEDBuffer::channelGood	(	const uint8_t	internalFEDannelNum,
		const bool	doAPVeCheck
	)		const

inline

Definition at line 156 of file SiStripFEDBuffer.h.

                                                                                                       {
     return ((internalFEDChannelNum < validChannels_) &&
             ((doAPVeCheck && feGood(internalFEDChannelNum / FEDCH_PER_FEUNIT)) ||
              (!doAPVeCheck && feGoodWithoutAPVEmulatorCheck(internalFEDChannelNum / FEDCH_PER_FEUNIT))) &&
             (this->readoutMode() == sistrip::READOUT_MODE_SCOPE || checkStatusBits(internalFEDChannelNum)));
   }

References checkStatusBits(), sistrip::FEDCH_PER_FEUNIT, feGood(), feGoodWithoutAPVEmulatorCheck(), sistrip::internalFEDChannelNum(), sistrip::READOUT_MODE_SCOPE, sistrip::FEDBufferBase::readoutMode(), and validChannels_.

Referenced by checkChannelPacketCodes().

◆ checkAllChannelStatusBits()

bool sistrip::FEDBuffer::checkAllChannelStatusBits ( ) const

Definition at line 149 of file SiStripFEDBuffer.cc.

                                                   {
     for (uint8_t iCh = 0; iCh < FEDCH_PER_FED; iCh++) {
       //if FE unit is disabled then skip all channels on it
       if (!feGood(iCh / FEDCH_PER_FEUNIT)) {
         iCh += FEDCH_PER_FEUNIT;
         continue;
       }
       //channel is bad then return false
       if (!checkStatusBits(iCh))
         return false;
     }
     //if no bad channels have been found then they are all fine
     return true;
   }

References checkStatusBits(), sistrip::FEDCH_PER_FED, sistrip::FEDCH_PER_FEUNIT, and feGood().

Referenced by checkSummary().

◆ checkChannelLengths()

bool sistrip::FEDBuffer::checkChannelLengths ( ) const

Definition at line 164 of file SiStripFEDBuffer.cc.

164 { return (validChannels_ == FEDCH_PER_FED); }

References sistrip::FEDCH_PER_FED, and validChannels_.

Referenced by checkChannelLengthsMatchBufferLength().

◆ checkChannelLengthsMatchBufferLength()

bool sistrip::FEDBuffer::checkChannelLengthsMatchBufferLength ( ) const

Definition at line 166 of file SiStripFEDBuffer.cc.

                                                              {
     //check they fit into buffer
     if (!checkChannelLengths())
       return false;
  
     //payload length from length of data buffer
     const uint16_t payloadLengthInWords = payloadLength_ / 8;
  
     //find channel length
     //find last enabled FE unit
     uint8_t lastEnabledFeUnit = 7;
     while (!(fePresent(lastEnabledFeUnit) && feEnabled(lastEnabledFeUnit)) && lastEnabledFeUnit != 0)
       lastEnabledFeUnit--;
     //last channel is last channel on last enabled FE unit
     const FEDChannel& lastChannel = channels_[internalFEDChannelNum(lastEnabledFeUnit, FEDCH_PER_FEUNIT - 1)];
     const uint16_t offsetLastChannel = lastChannel.offset();
     const uint16_t offsetEndOfChannelData = offsetLastChannel + lastChannel.length();
     const uint16_t channelDataLength = offsetEndOfChannelData;
     //channel length in words is length in bytes rounded up to nearest word
     uint16_t channelDataLengthInWords = channelDataLength / 8;
     if (channelDataLength % 8)
       channelDataLengthInWords++;
  
     //check lengths match
     if (channelDataLengthInWords == payloadLengthInWords) {
       return true;
     } else {
       return false;
     }
   }

References sistrip::FEDBufferBase::channels_, checkChannelLengths(), sistrip::FEDCH_PER_FEUNIT, sistrip::FEDBufferBase::feEnabled(), fePresent(), sistrip::internalFEDChannelNum(), sistrip::FEDChannel::length(), sistrip::FEDChannel::offset(), and payloadLength_.

Referenced by checkSummary(), and doCorruptBufferChecks().

◆ checkChannelPacketCodes()

bool sistrip::FEDBuffer::checkChannelPacketCodes ( ) const

Definition at line 197 of file SiStripFEDBuffer.cc.

                                                 {
     const uint8_t correctPacketCode = getCorrectPacketCode();
     //if the readout mode if not one which has a packet code then this is set to zero. in this case return true
     if (!correctPacketCode)
       return true;
     for (uint8_t iCh = 0; iCh < FEDCH_PER_FED; iCh++) {
       //if FE unit is disabled then skip all channels on it
       if (!feGood(iCh / FEDCH_PER_FEUNIT)) {
         iCh += FEDCH_PER_FEUNIT;
         continue;
       }
       //only check enabled, working channels
       if (FEDBuffer::channelGood(iCh, true)) {
         //if a channel is bad then return false
         if (channels_[iCh].packetCode() != correctPacketCode)
           return false;
       }
     }
     //if no bad channels were found the they are all ok
     return true;
   }

References channelGood(), sistrip::FEDBufferBase::channels_, sistrip::FEDCH_PER_FED, sistrip::FEDCH_PER_FEUNIT, feGood(), getCorrectPacketCode(), and sistrip::FEDBufferBase::packetCode().

Referenced by checkSummary(), and doCorruptBufferChecks().

◆ checkFEPayloadsPresent()

bool sistrip::FEDBuffer::checkFEPayloadsPresent ( ) const

Definition at line 266 of file SiStripFEDBuffer.cc.

                                                {
     for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
       if (!fePresent(iFE))
         return false;
     }
     return true;
   }

References fePresent(), and sistrip::FEUNITS_PER_FED.

Referenced by checkSummary().

◆ checkFEUnitAPVAddresses()

bool sistrip::FEDBuffer::checkFEUnitAPVAddresses ( ) const

Definition at line 219 of file SiStripFEDBuffer.cc.

                                                 {
     //get golden address
     const uint8_t goldenAddress = apveAddress();
     //don't check if the address is 00 since APVe is probably not connected
     if (goldenAddress == 0x00)
       return true;
     //check can only be done for full debug headers
     const FEDFullDebugHeader* fdHeader = dynamic_cast<FEDFullDebugHeader*>(feHeader_.get());
     if (!fdHeader)
       return true;
     //check all enabled FE units
     for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
       if (!feGood(iFE))
         continue;
       //if address is bad then return false
       if (fdHeader->feUnitMajorityAddress(iFE) != goldenAddress)
         return false;
     }
     //if no bad addresses were found then return true
     return true;
   }

References sistrip::FEDBufferBase::apveAddress(), feGood(), feHeader_, sistrip::FEDFullDebugHeader::feUnitMajorityAddress(), and sistrip::FEUNITS_PER_FED.

Referenced by checkSummary().

◆ checkFEUnitLengths()

bool sistrip::FEDBuffer::checkFEUnitLengths ( ) const

Definition at line 241 of file SiStripFEDBuffer.cc.

                                            {
     //check can only be done for full debug headers
     const FEDFullDebugHeader* fdHeader = dynamic_cast<FEDFullDebugHeader*>(feHeader_.get());
     if (!fdHeader)
       return true;
     //check lengths for enabled FE units
     for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
       if (!feGood(iFE))
         continue;
       if (calculateFEUnitLength(iFE) != fdHeader->feUnitLength(iFE))
         return false;
     }
     //if no errors were encountered then return true
     return true;
   }

References calculateFEUnitLength(), feGood(), feHeader_, sistrip::FEDFullDebugHeader::feUnitLength(), and sistrip::FEUNITS_PER_FED.

Referenced by checkSummary(), and doCorruptBufferChecks().

◆ checkStatusBits() [1/2]

bool sistrip::FEDBuffer::checkStatusBits ( const uint8_t internalFEDChannelNum ) const

inline

Definition at line 174 of file SiStripFEDBuffer.h.

                                                                                   {
     return feHeader_->checkChannelStatusBits(internalFEDChannelNum);
   }

References feHeader_, and sistrip::internalFEDChannelNum().

Referenced by channelGood(), checkAllChannelStatusBits(), checkStatusBits(), and checkSummary().

◆ checkStatusBits() [2/2]

bool sistrip::FEDBuffer::checkStatusBits	(	const uint8_t	internalFEUnitNum,
		const uint8_t	internalChannelNum
	)		const

inline

Definition at line 178 of file SiStripFEDBuffer.h.

                                                                                                                 {
     return checkStatusBits(internalFEDChannelNum(internalFEUnitNum, internalChannelNum));
   }

References checkStatusBits(), and sistrip::internalFEDChannelNum().

◆ checkSummary()

std::string sistrip::FEDBuffer::checkSummary ( ) const

overridevirtual

Reimplemented from sistrip::FEDBufferBase.

Definition at line 274 of file SiStripFEDBuffer.cc.

                                           {
     std::ostringstream summary;
     summary << FEDBufferBase::checkSummary();
     summary << "Check FE unit payloads are all present: " << (checkFEPayloadsPresent() ? "passed" : "FAILED")
             << std::endl;
     if (!checkFEPayloadsPresent()) {
       summary << "FE units missing payloads: ";
       for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
         if (!fePresent(iFE))
           summary << uint16_t(iFE) << " ";
       }
       summary << std::endl;
     }
     summary << "Check channel status bits: " << (checkAllChannelStatusBits() ? "passed" : "FAILED") << std::endl;
     if (!checkAllChannelStatusBits()) {
       unsigned int badChannels = 0;
       if (headerType() == HEADER_TYPE_FULL_DEBUG) {
         const FEDFullDebugHeader* fdHeader = dynamic_cast<FEDFullDebugHeader*>(feHeader_.get());
         if (fdHeader) {
           for (uint8_t iCh = 0; iCh < FEDCH_PER_FED; iCh++) {
             if (!feGood(iCh / FEDCH_PER_FEUNIT))
               continue;
             if (!checkStatusBits(iCh)) {
               summary << uint16_t(iCh) << ": " << fdHeader->getChannelStatus(iCh) << std::endl;
               badChannels++;
             }
           }
         }
       } else {
         summary << "Channels with errors: ";
         for (uint8_t iCh = 0; iCh < FEDCH_PER_FED; iCh++) {
           if (!feGood(iCh / FEDCH_PER_FEUNIT))
             continue;
           if (!checkStatusBits(iCh)) {
             summary << uint16_t(iCh) << " ";
             badChannels++;
           }
         }
         summary << std::endl;
       }
       summary << "Number of channels with bad status bits: " << badChannels << std::endl;
     }
     summary << "Check channel lengths match buffer length: "
             << (checkChannelLengthsMatchBufferLength() ? "passed" : "FAILED") << std::endl;
     summary << "Check channel packet codes: " << (checkChannelPacketCodes() ? "passed" : "FAILED") << std::endl;
     if (!checkChannelPacketCodes()) {
       summary << "Channels with bad packet codes: ";
       for (uint8_t iCh = 0; iCh < FEDCH_PER_FED; iCh++) {
         if (!feGood(iCh / FEDCH_PER_FEUNIT))
           continue;
         if (channels_[iCh].packetCode() != getCorrectPacketCode())
           summary << uint16_t(iCh) << " ";
       }
     }
     summary << "Check FE unit lengths: " << (checkFEUnitLengths() ? "passed" : "FAILED") << std::endl;
     if (!checkFEUnitLengths()) {
       const FEDFullDebugHeader* fdHeader = dynamic_cast<FEDFullDebugHeader*>(feHeader_.get());
       if (fdHeader) {
         summary << "Bad FE units:" << std::endl;
         for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
           if (!feGood(iFE))
             continue;
           uint16_t lengthFromChannels = calculateFEUnitLength(iFE);
           uint16_t lengthFromHeader = fdHeader->feUnitLength(iFE);
           if (lengthFromHeader != lengthFromChannels) {
             summary << "FE unit: " << uint16_t(iFE) << " length in header: " << lengthFromHeader
                     << " length from channel lengths: " << lengthFromChannels << std::endl;
           }
         }
       }
     }
     summary << "Check FE unit APV addresses match APVe: " << (checkFEUnitAPVAddresses() ? "passed" : "FAILED")
             << std::endl;
     if (!checkFEUnitAPVAddresses()) {
       const FEDFullDebugHeader* fdHeader = dynamic_cast<FEDFullDebugHeader*>(feHeader_.get());
       if (fdHeader) {
         const uint8_t goldenAddress = apveAddress();
         summary << "Address from APVe:" << uint16_t(goldenAddress) << std::endl;
         summary << "Bad FE units:" << std::endl;
         for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
           if (!feGood(iFE))
             continue;
           if (fdHeader->feUnitMajorityAddress(iFE) != goldenAddress) {
             summary << "FE unit: " << uint16_t(iFE)
                     << " majority address: " << uint16_t(fdHeader->feUnitMajorityAddress(iFE)) << std::endl;
           }
         }
       }
     }
     return summary.str();
   }

References sistrip::FEDBufferBase::apveAddress(), calculateFEUnitLength(), sistrip::FEDBufferBase::channels_, checkAllChannelStatusBits(), checkChannelLengthsMatchBufferLength(), checkChannelPacketCodes(), checkFEPayloadsPresent(), checkFEUnitAPVAddresses(), checkFEUnitLengths(), checkStatusBits(), sistrip::FEDBufferBase::checkSummary(), sistrip::FEDCH_PER_FED, sistrip::FEDCH_PER_FEUNIT, feGood(), feHeader_, fePresent(), sistrip::FEDFullDebugHeader::feUnitLength(), sistrip::FEDFullDebugHeader::feUnitMajorityAddress(), sistrip::FEUNITS_PER_FED, sistrip::FEDFullDebugHeader::getChannelStatus(), getCorrectPacketCode(), sistrip::HEADER_TYPE_FULL_DEBUG, sistrip::FEDBufferBase::headerType(), sistrip::FEDBufferBase::packetCode(), and edmLumisInFiles::summary.

◆ doChecks()

bool sistrip::FEDBuffer::doChecks ( bool doCRC ) const

inline

Definition at line 182 of file SiStripFEDBuffer.h.

                                                   {
     //check that all channels were unpacked properly
     return (validChannels_ == FEDCH_PER_FED) &
            //do checks from base class
            (FEDBufferBase::doChecks()) &
            // check crc if required
            (!doCRC || checkCRC());
   }

References sistrip::FEDBufferBase::checkCRC(), sistrip::FEDBufferBase::doChecks(), sistrip::FEDCH_PER_FED, and validChannels_.

◆ doCorruptBufferChecks()

bool sistrip::FEDBuffer::doCorruptBufferChecks ( ) const

virtual

Definition at line 142 of file SiStripFEDBuffer.cc.

                                               {
     return (checkCRC() && checkChannelLengthsMatchBufferLength() && checkChannelPacketCodes() &&
             //checkClusterLengths() &&
             checkFEUnitLengths());
     //checkFEUnitAPVAddresses() );
   }

References checkChannelLengthsMatchBufferLength(), checkChannelPacketCodes(), sistrip::FEDBufferBase::checkCRC(), and checkFEUnitLengths().

◆ feGood()

bool sistrip::FEDBuffer::feGood ( const uint8_t internalFEUnitNum ) const

inline

Definition at line 163 of file SiStripFEDBuffer.h.

                                                                      {
     return (!majorityAddressErrorForFEUnit(internalFEUnitNum) && !feOverflow(internalFEUnitNum) &&
             fePresent(internalFEUnitNum));
   }

References sistrip::FEDBufferBase::feOverflow(), fePresent(), and sistrip::FEDBufferBase::majorityAddressErrorForFEUnit().

Referenced by channelGood(), checkAllChannelStatusBits(), checkChannelPacketCodes(), checkFEUnitAPVAddresses(), checkFEUnitLengths(), and checkSummary().

◆ feGoodWithoutAPVEmulatorCheck()

bool sistrip::FEDBuffer::feGoodWithoutAPVEmulatorCheck ( const uint8_t internalFEUnitNum ) const

inline

Definition at line 168 of file SiStripFEDBuffer.h.

                                                                                             {
     return (!feOverflow(internalFEUnitNum) && fePresent(internalFEUnitNum));
   }

References sistrip::FEDBufferBase::feOverflow(), and fePresent().

Referenced by channelGood().

◆ feHeader()

const FEDFEHeader * sistrip::FEDBuffer::feHeader ( ) const

inline

Definition at line 154 of file SiStripFEDBuffer.h.

154 { return feHeader_.get(); }

References feHeader_.

Referenced by print(), and sistrip::RawToDigiUnpacker::updateEventSummary().

◆ fePresent()

bool sistrip::FEDBuffer::fePresent ( uint8_t internalFEUnitNum ) const

inline

Definition at line 172 of file SiStripFEDBuffer.h.

172 { return fePresent_[internalFEUnitNum]; }

References fePresent_.

Referenced by checkChannelLengthsMatchBufferLength(), checkFEPayloadsPresent(), checkSummary(), feGood(), feGoodWithoutAPVEmulatorCheck(), findChannels(), and nFEUnitsPresent().

◆ findChannels()

FEDBufferStatusCode sistrip::FEDBuffer::findChannels ( )

Read the channel lengths from the payload

This method should be called to after the constructor (and should not be called more than once for the same sistrip::FEDBuffer). In case any check fails, a value different from sistrip::FEDBufferStatusCode::SUCCESS is returned, and detailed information printed to LogDebug("FEDBuffer"), if relevant.

See also: sistrip::FEDBuffer::FEDBuffer()

Definition at line 48 of file SiStripFEDBuffer.cc.

                                               {
     auto st = FEDBufferStatusCode::SUCCESS;
     //set min length to 2 for ZSLite, 7 for ZS and 3 for raw
     uint16_t minLength;
     switch (readoutMode()) {
       case READOUT_MODE_ZERO_SUPPRESSED:
       case READOUT_MODE_ZERO_SUPPRESSED_FAKE:
         minLength = 7;
         break;
       case READOUT_MODE_PREMIX_RAW:
         minLength = 2;
         break;
       case READOUT_MODE_ZERO_SUPPRESSED_LITE10:
       case READOUT_MODE_ZERO_SUPPRESSED_LITE10_CMOVERRIDE:
       case READOUT_MODE_ZERO_SUPPRESSED_LITE8:
       case READOUT_MODE_ZERO_SUPPRESSED_LITE8_CMOVERRIDE:
       case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT:
       case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT_CMOVERRIDE:
       case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT:
       case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT_CMOVERRIDE:
         minLength = 2;
         break;
       default:
         minLength = 3;
         break;
     }
     uint16_t offsetBeginningOfChannel = 0;
     for (uint16_t i = 0; i < FEDCH_PER_FED; i++) {
       //if FE unit is not enabled then skip rest of FE unit adding NULL pointers
       if UNLIKELY (!(fePresent(i / FEDCH_PER_FEUNIT) && feEnabled(i / FEDCH_PER_FEUNIT))) {
         channels_.insert(channels_.end(), uint16_t(FEDCH_PER_FEUNIT), FEDChannel(payloadPointer_, 0, 0));
         i += FEDCH_PER_FEUNIT - 1;
         validChannels_ += FEDCH_PER_FEUNIT;
         continue;
       }
       //if FE unit is enabled
       //check that channel length bytes fit into buffer
       if UNLIKELY (offsetBeginningOfChannel + 1 >= payloadLength_) {
         const SiStripFedKey key(0, i / FEDCH_PER_FEUNIT, i % FEDCH_PER_FEUNIT);
         LogDebug("FEDBuffer") << "Channel " << uint16_t(i) << " (FE unit " << key.feUnit() << " channel "
                               << key.feChan() << " according to external numbering scheme) "
                               << "does not fit into buffer. "
                               << "Channel starts at " << uint16_t(offsetBeginningOfChannel) << " in payload. "
                               << "Payload length is " << uint16_t(payloadLength_) << ". ";
         st = FEDBufferStatusCode::CHANNEL_BEGIN_BEYOND_PAYLOAD;
         break;
       }
  
       channels_.emplace_back(payloadPointer_, offsetBeginningOfChannel);
       //get length and check that whole channel fits into buffer
       uint16_t channelLength = channels_.back().length();
  
       //check that the channel length is long enough to contain the header
       if UNLIKELY (channelLength < minLength) {
         const SiStripFedKey key(0, i / FEDCH_PER_FEUNIT, i % FEDCH_PER_FEUNIT);
         LogDebug("FEDBuffer") << "Channel " << uint16_t(i) << " (FE unit " << key.feUnit() << " channel "
                               << key.feChan() << " according to external numbering scheme)"
                               << " is too short. "
                               << "Channel starts at " << uint16_t(offsetBeginningOfChannel) << " in payload. "
                               << "Channel length is " << uint16_t(channelLength) << ". "
                               << "Min length is " << uint16_t(minLength) << ". ";
         st = FEDBufferStatusCode::CHANNEL_TOO_SHORT;
         break;
       }
       if UNLIKELY (offsetBeginningOfChannel + channelLength > payloadLength_) {
         const SiStripFedKey key(0, i / FEDCH_PER_FEUNIT, i % FEDCH_PER_FEUNIT);
         LogDebug("FEDBuffer") << "Channel " << uint16_t(i) << " (FE unit " << key.feUnit() << " channel "
                               << key.feChan() << " according to external numbering scheme)"
                               << "does not fit into buffer. "
                               << "Channel starts at " << uint16_t(offsetBeginningOfChannel) << " in payload. "
                               << "Channel length is " << uint16_t(channelLength) << ". "
                               << "Payload length is " << uint16_t(payloadLength_) << ". ";
         st = FEDBufferStatusCode::CHANNEL_END_BEYOND_PAYLOAD;
         break;
       }
  
       validChannels_++;
       const uint16_t offsetEndOfChannel = offsetBeginningOfChannel + channelLength;
       //add padding if necessary and calculate offset for begining of next channel
       if (!((i + 1) % FEDCH_PER_FEUNIT)) {
         uint8_t numPaddingBytes = 8 - (offsetEndOfChannel % 8);
         if (numPaddingBytes == 8)
           numPaddingBytes = 0;
         offsetBeginningOfChannel = offsetEndOfChannel + numPaddingBytes;
       } else {
         offsetBeginningOfChannel = offsetEndOfChannel;
       }
     }
     if UNLIKELY (FEDBufferStatusCode::SUCCESS != st) {  // for the allowBadBuffer case
       channels_.insert(channels_.end(), uint16_t(FEDCH_PER_FED - validChannels_), FEDChannel(payloadPointer_, 0, 0));
     }
     return st;
   }

◆ getCorrectPacketCode()

uint8_t sistrip::FEDBuffer::getCorrectPacketCode ( ) const

inlineprivate

Definition at line 104 of file SiStripFEDBuffer.h.

104 { return packetCode(legacyUnpacker_); }

References legacyUnpacker_, and sistrip::FEDBufferBase::packetCode().

Referenced by checkChannelPacketCodes(), and checkSummary().

◆ nFEUnitsPresent()

uint8_t sistrip::FEDBuffer::nFEUnitsPresent ( ) const

private

Definition at line 366 of file SiStripFEDBuffer.cc.

                                            {
     uint8_t result = 0;
     for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
       if (fePresent(iFE))
         result++;
     }
     return result;
   }

References fePresent(), sistrip::FEUNITS_PER_FED, and mps_fire::result.

Referenced by print().

◆ print()

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

overridevirtual

Reimplemented from sistrip::FEDBufferBase.

Definition at line 375 of file SiStripFEDBuffer.cc.

                                             {
     FEDBufferBase::print(os);
     if (headerType() == HEADER_TYPE_FULL_DEBUG) {
       os << "FE units with data: " << uint16_t(nFEUnitsPresent()) << std::endl;
       os << "BE status register flags: ";
       dynamic_cast<const FEDFullDebugHeader*>(feHeader())->beStatusRegister().printFlags(os);
       os << std::endl;
     }
   }

References feHeader(), sistrip::HEADER_TYPE_FULL_DEBUG, sistrip::FEDBufferBase::headerType(), nFEUnitsPresent(), and sistrip::FEDBufferBase::print().

◆ setLegacyMode()

void sistrip::FEDBuffer::setLegacyMode ( bool legacy )

inline

Definition at line 68 of file SiStripFEDBuffer.h.

68 { legacyUnpacker_ = legacy; }

References legacyUnpacker_.

Member Data Documentation

◆ feHeader_

std::unique_ptr<FEDFEHeader> sistrip::FEDBuffer::feHeader_

private

Definition at line 106 of file SiStripFEDBuffer.h.

Referenced by checkFEUnitAPVAddresses(), checkFEUnitLengths(), checkStatusBits(), checkSummary(), FEDBuffer(), and feHeader().

◆ fePresent_

bool sistrip::FEDBuffer::fePresent_[FEUNITS_PER_FED]

private

Definition at line 110 of file SiStripFEDBuffer.h.

Referenced by FEDBuffer(), and fePresent().

◆ legacyUnpacker_

bool sistrip::FEDBuffer::legacyUnpacker_ = false

private

Definition at line 111 of file SiStripFEDBuffer.h.

Referenced by getCorrectPacketCode(), and setLegacyMode().

◆ payloadLength_

uint16_t sistrip::FEDBuffer::payloadLength_

private

Definition at line 108 of file SiStripFEDBuffer.h.

Referenced by checkChannelLengthsMatchBufferLength(), FEDBuffer(), and findChannels().

◆ payloadPointer_

const uint8_t* sistrip::FEDBuffer::payloadPointer_

private

Definition at line 107 of file SiStripFEDBuffer.h.

Referenced by FEDBuffer(), and findChannels().

◆ validChannels_

uint8_t sistrip::FEDBuffer::validChannels_

private

Definition at line 109 of file SiStripFEDBuffer.h.

Referenced by channelGood(), checkChannelLengths(), doChecks(), FEDBuffer(), and findChannels().

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FEDBuffer()

◆ ~FEDBuffer()

Member Function Documentation

◆ calculateFEUnitLength()

◆ channelGood()

◆ checkAllChannelStatusBits()

◆ checkChannelLengths()

◆ checkChannelLengthsMatchBufferLength()

◆ checkChannelPacketCodes()

◆ checkFEPayloadsPresent()

◆ checkFEUnitAPVAddresses()

◆ checkFEUnitLengths()

◆ checkStatusBits() [1/2]

◆ checkStatusBits() [2/2]

◆ checkSummary()

◆ doChecks()

◆ doCorruptBufferChecks()

◆ feGood()

◆ feGoodWithoutAPVEmulatorCheck()

◆ feHeader()

◆ fePresent()

◆ findChannels()

◆ getCorrectPacketCode()

◆ nFEUnitsPresent()

◆ print()

◆ setLegacyMode()

Member Data Documentation

◆ feHeader_

◆ fePresent_

◆ legacyUnpacker_

◆ payloadLength_

◆ payloadPointer_

◆ validChannels_