Zdc Sub Block base class. More...

#include <ZdcSubBlock.h>

Inheritance diagram for ZdcSubBlock:

Collaboration diagram for ZdcSubBlock:

Public Types
enum	SubBlockWordType { HEADER, DATA, STATUS }

enum	DataFormats { NEUTRAL = 0, UNCOMPRESSED = 1, COMPRESSED = 2, SUPERCOMPRESSED = 3 }

enum	UnpackErrorType { UNPACK_NONE, UNPACK_VERSION, UNPACK_FORMAT, UNPACK_COMPRESSION_VERSION, UNPACK_COMPRESSION_SLICES, UNPACK_DATA_TRUNCATED, UNPACK_SOURCE_ID, UNPACK_WORD_ID }

Public Member Functions
	ZdcSubBlock ()

	~ZdcSubBlock ()

void	clear ()
	Clear all data. More...

int	dataWords () const
	Return number of data words. More...

void	setHeader (int wordId, int version, int format, int seqno, int crate, int module, int slices2, int slices1)
	Store header data. More...

int	wordId () const

int	version () const

int	format () const

int	seqno () const

int	slice () const

int	crate () const

int	module () const

int	slices2 () const

int	slices1 () const

uint32_t	failingBCN () const

bool	glinkTimeout () const

bool	glinkDown () const

bool	upstreamError () const

bool	daqOverflow () const

bool	bcnMismatch () const

bool	glinkProtocol () const

bool	glinkParity () const

uint32_t	subStatus () const
	Return Sub-status word. More...

void	setBunchCrossing (int bc)
	Set the Bunch Crossing number (neutral format only) More...

int	bunchCrossing () const
	Return the Bunch Crossing number (neutral format only) More...

OFFLINE_FRAGMENTS_NAMESPACE::PointerType	read (const OFFLINE_FRAGMENTS_NAMESPACE::PointerType beg, const OFFLINE_FRAGMENTS_NAMESPACE::PointerType end)
	Input complete packed sub-block from ROD array. More...

void	write (FullEventAssembler< ZdcSrcIdMap >::RODDATA *theROD) const
	Output complete packed sub-block to ROD vector. More...

void	setStatus (uint32_t failingBCN, bool glinkTimeout, bool glinkDown, bool upstreamError, bool daqOverflow, bool bcnMismatch, bool glinkProtocol, bool glinkParity)
	Store error status trailer. More...

void	setDaqOverflow (int bit=1)
	Set DAQ FIFO Overflow bit in Sub-status word. More...

void	setGlinkParity (int bit=1)
	Set G-Link Parity bit in Sub-status word. More...

void	setUnpackErrorCode (int code)
	Set the unpacking error code. More...

int	unpackErrorCode () const
	Return the unpacking error code. More...

std::string	unpackErrorMsg () const
	Return the unpacking error message for printing. More...

void	packer (uint32_t datum, int nbits)
	Pack given data into given number of bits. More...

void	packerFlush ()
	Flush the current data word padded with zeros. More...

void	setStreamed ()
	Set continuous bit streaming for compressed formats. More...

uint32_t	unpacker (int nbits)
	Unpack given number of bits of data. More...

void	unpackerInit ()
	Initialise unpacker. More...

bool	unpackerSuccess () const
	Return unpacker success flag. More...

void	packerNeutral (int pin, uint32_t datum, int nbits)
	Pack given neutral data from given pin. More...

void	packerNeutralParity (int pin)
	Pack current G-Link parity bit for given pin. More...

uint32_t	unpackerNeutral (int pin, int nbits)
	Unpack given number of bits of neutral data for given pin. More...

bool	unpackerNeutralParityError (int pin)
	Unpack and test G-Link parity bit for given pin. More...

Static Public Member Functions
static SubBlockWordType	wordType (uint32_t word)
	Word identification. More...

static int	wordId (uint32_t word)
	Return wordID field from given header word. More...

static int	format (uint32_t word)
	Return data format from given header word. More...

static int	seqno (uint32_t word)
	Return seqno field from given header word. More...

static int	module (uint32_t word)
	Return module field from given header word. More...

static int	minBits (uint32_t datum)
	Return the minimum number of bits needed for given data. More...

static int	parityBit (int init, uint32_t datum, int nbits)
	Return the parity bit for given data. More...

Private Attributes
uint32_t	m_header {}
	Sub-Block Header. More...

uint32_t	m_trailer {}
	Sub-Block Status Trailer. More...

int	m_bunchCrossing {}
	Bunch Crossing number (neutral format only) More...

int	m_unpackError {}
	Unpacking error code. More...

uint32_t	m_bitword {}

int	m_currentBit {}

int	m_maxBits {}

uint32_t	m_maxMask {}

bool	m_unpackerFlag {}

std::vector< uint32_t >::const_iterator	m_dataPos {}

std::vector< uint32_t >::const_iterator	m_dataPosEnd {}

std::vector< int >	m_currentPinBit

std::vector< int >	m_oddParity

int	m_dataWords {}
	Current number of data words. More...

std::vector< uint32_t >	m_data
	Sub-Block data. More...

Static Private Attributes
static const int	s_headerBit = 30
	ZdcSubBlock.cxx this is a base class derived (copyed) from LVL1 I do not think we need this this way; either implement directly on PpmSubBlock or link to LVL1. More...

static const int	s_statusBit = 28

static const uint32_t	s_headerMask = 0x3

static const uint32_t	s_statusMask = 0x1

static const uint32_t	s_headerVal = 0x3

static const uint32_t	s_statusVal = 0x1

static const int	s_wordIdBit = 28

static const int	s_versionBit = 25

static const int	s_formatBit = 22

static const int	s_seqnoBit = 16

static const int	s_crateBit = 12

static const int	s_moduleBit = 8

static const int	s_slices2Bit = 3

static const int	s_slices1Bit = 0

static const uint32_t	s_wordIdMask = 0xf

static const uint32_t	s_versionMask = 0x7

static const uint32_t	s_formatMask = 0x7

static const uint32_t	s_seqnoMask = 0x3f

static const uint32_t	s_crateMask = 0xf

static const uint32_t	s_moduleMask = 0xf

static const uint32_t	s_slices2Mask = 0x1f

static const uint32_t	s_slices1Mask = 0x7

static const int	s_failingBcnBit = 22

static const int	s_glinkTimeoutBit = 7

static const int	s_glinkDownBit = 6

static const int	s_upstreamErrorBit = 4

static const int	s_daqOverflowBit = 3

static const int	s_bcnMismatchBit = 2

static const int	s_glinkProtocolBit = 1

static const int	s_glinkParityBit = 0

static const uint32_t	s_failingBcnMask = 0x3f

static const int	s_maxWordBits = 32

static const int	s_maxStreamedBits = 31

static const uint32_t	s_maxWordMask = 0xffffffff

static const uint32_t	s_maxStreamedMask = 0x7fffffff

static const int	s_maxPins = 20

static const uint32_t	s_glinkDavSet = 0x400000

Detailed Description

Zdc Sub Block base class.

Author: Peter Faulkner

Derived (copied !) from L1Calo Sub-Block base class.

Don't think we need this, as there is only one type of subblock (only PPM) being used by ZDC. Implement at once inside ZdcPpmSubBlock

Marco Leite

TRY_LINK_LVL1

Definition at line 34 of file ZdcSubBlock.h.

Member Enumeration Documentation

◆ DataFormats

enum ZdcSubBlock::DataFormats

Enumerator
NEUTRAL
UNCOMPRESSED
COMPRESSED
SUPERCOMPRESSED

Definition at line 41 of file ZdcSubBlock.h.

                          { NEUTRAL         = 0,
                             UNCOMPRESSED    = 1,
                             COMPRESSED      = 2,
                             SUPERCOMPRESSED = 3 };

◆ SubBlockWordType

enum ZdcSubBlock::SubBlockWordType

Enumerator
HEADER
DATA
STATUS

Definition at line 37 of file ZdcSubBlock.h.

                          { HEADER,
                             DATA,
                             STATUS };

◆ UnpackErrorType

enum ZdcSubBlock::UnpackErrorType

Enumerator
UNPACK_NONE
UNPACK_VERSION
UNPACK_FORMAT
UNPACK_COMPRESSION_VERSION
UNPACK_COMPRESSION_SLICES
UNPACK_DATA_TRUNCATED
UNPACK_SOURCE_ID
UNPACK_WORD_ID

Definition at line 46 of file ZdcSubBlock.h.

                          { UNPACK_NONE,
                             UNPACK_VERSION,
                             UNPACK_FORMAT,
                             UNPACK_COMPRESSION_VERSION,
                             UNPACK_COMPRESSION_SLICES,
                             UNPACK_DATA_TRUNCATED,
                             UNPACK_SOURCE_ID,
                             UNPACK_WORD_ID };

Constructor & Destructor Documentation

◆ ZdcSubBlock()

ZdcSubBlock::ZdcSubBlock ( )

Definition at line 66 of file ZdcSubBlock.cxx.

                          : m_header(0), m_trailer(0),
                                    m_bunchCrossing(0),
                    m_unpackError(UNPACK_NONE),
                                    m_bitword(0), m_currentBit(0),
                    m_maxBits(s_maxWordBits),
                    m_maxMask(s_maxWordMask),
                    m_unpackerFlag(false),
                    m_currentPinBit(s_maxPins),
                    m_oddParity(s_maxPins, 1),
                    m_dataWords(0)
 {
 }

◆ ~ZdcSubBlock()

ZdcSubBlock::~ZdcSubBlock ( )

Definition at line 79 of file ZdcSubBlock.cxx.

80 {

81 }

Member Function Documentation

◆ bcnMismatch()

bool ZdcSubBlock::bcnMismatch ( ) const

inline

Definition at line 310 of file ZdcSubBlock.h.

 {
   return m_trailer & (0x1 << s_bcnMismatchBit);
 }

◆ bunchCrossing()

int ZdcSubBlock::bunchCrossing ( ) const

inline

Return the Bunch Crossing number (neutral format only)

Definition at line 335 of file ZdcSubBlock.h.

 {
   return m_bunchCrossing;
 }

◆ clear()

void ZdcSubBlock::clear ( )

Clear all data.

Definition at line 85 of file ZdcSubBlock.cxx.

 {
   m_header = 0;
   m_trailer = 0;
   m_bunchCrossing = 0;
   m_unpackError = UNPACK_NONE;
   m_bitword = 0;
   m_currentBit = 0;
   m_unpackerFlag = false;
   m_currentPinBit.assign(s_maxPins, 0);
   m_oddParity.assign(s_maxPins, 1);
   m_dataWords = 0;
   m_data.clear();
 }

◆ crate()

int ZdcSubBlock::crate ( ) const

inline

Definition at line 265 of file ZdcSubBlock.h.

 {
   return (m_header >> s_crateBit) & s_crateMask;
 }

◆ daqOverflow()

bool ZdcSubBlock::daqOverflow ( ) const

inline

Definition at line 305 of file ZdcSubBlock.h.

 {
   return m_trailer & (0x1 << s_daqOverflowBit);
 }

◆ dataWords()

int ZdcSubBlock::dataWords ( ) const

inline

Return number of data words.

Definition at line 235 of file ZdcSubBlock.h.

 {
   return m_dataWords;
 }

◆ failingBCN()

uint32_t ZdcSubBlock::failingBCN ( ) const

inline

Definition at line 285 of file ZdcSubBlock.h.

 {
   return (m_trailer >> s_failingBcnBit) & s_failingBcnMask;
 }

◆ format() [1/2]

int ZdcSubBlock::format ( ) const

inline

Definition at line 250 of file ZdcSubBlock.h.

 {
   return (m_header >> s_formatBit) & s_formatMask;
 }

◆ format() [2/2]

int ZdcSubBlock::format ( uint32_t word )

static

Return data format from given header word.

Definition at line 441 of file ZdcSubBlock.cxx.

 {
   return (word >> s_formatBit) & s_formatMask;
 }

◆ glinkDown()

bool ZdcSubBlock::glinkDown ( ) const

inline

Definition at line 295 of file ZdcSubBlock.h.

 {
   return m_trailer & (0x1 << s_glinkDownBit);
 }

◆ glinkParity()

bool ZdcSubBlock::glinkParity ( ) const

inline

Definition at line 320 of file ZdcSubBlock.h.

 {
   return m_trailer & (0x1 << s_glinkParityBit);
 }

◆ glinkProtocol()

bool ZdcSubBlock::glinkProtocol ( ) const

inline

Definition at line 315 of file ZdcSubBlock.h.

 {
   return m_trailer & (0x1 << s_glinkProtocolBit);
 }

◆ glinkTimeout()

bool ZdcSubBlock::glinkTimeout ( ) const

inline

Definition at line 290 of file ZdcSubBlock.h.

 {
   return m_trailer & (0x1 << s_glinkTimeoutBit);
 }

◆ minBits()

int ZdcSubBlock::minBits ( uint32_t datum )

static

Return the minimum number of bits needed for given data.

Definition at line 245 of file ZdcSubBlock.cxx.

 {
   const int maxBits = 32;
   int nbits = maxBits;
   for (int i = 0; i < maxBits; ++i) {
     if ( !(datum >> i)) {
       nbits = i;
       break;
     }
   }
   return nbits;
 }

◆ module() [1/2]

int ZdcSubBlock::module ( ) const

inline

Definition at line 270 of file ZdcSubBlock.h.

 {
   return (m_header >> s_moduleBit) & s_moduleMask;
 }

◆ module() [2/2]

int ZdcSubBlock::module ( uint32_t word )

static

Return module field from given header word.

Definition at line 455 of file ZdcSubBlock.cxx.

 {
   return (word >> s_moduleBit) & s_moduleMask;
 }

◆ packer()

void ZdcSubBlock::packer	(	uint32_t	datum,
		int	nbits
	)

Pack given data into given number of bits.

Definition at line 271 of file ZdcSubBlock.cxx.

 {
   if (nbits > 0) {
     uint32_t mask = 0x1;
     for (int i = 1; i < nbits; ++i) mask |= (mask << 1);
     m_bitword |= (datum & mask) << m_currentBit;
     m_currentBit += nbits;
     if (m_currentBit >= m_maxBits) {
       m_bitword &= m_maxMask;
       m_data.push_back(m_bitword);
       ++m_dataWords;
       const int bitsLeft = m_currentBit - m_maxBits;
       if (bitsLeft > 0) {
         m_bitword = (datum & mask) >> (nbits - bitsLeft);
     m_currentBit = bitsLeft;
       } else {
         m_bitword = 0;
     m_currentBit = 0;
       }
     }
   }
 }

◆ packerFlush()

void ZdcSubBlock::packerFlush ( )

Flush the current data word padded with zeros.

Definition at line 296 of file ZdcSubBlock.cxx.

 {
   if (m_currentBit > 0) {
     m_bitword &= m_maxMask;
     m_data.push_back(m_bitword);
     ++m_dataWords;
     m_bitword = 0;
     m_currentBit = 0;
   }
 }

◆ packerNeutral()

void ZdcSubBlock::packerNeutral	(	int	pin,
		uint32_t	datum,
		int	nbits
	)

Pack given neutral data from given pin.

Definition at line 364 of file ZdcSubBlock.cxx.

 {
   if (pin >= 0 && pin < s_maxPins && nbits > 0) {
     if (m_currentPinBit[pin] + nbits > m_dataWords) {
       m_dataWords = m_currentPinBit[pin] + nbits;
       m_data.resize(m_dataWords, s_glinkDavSet);
     }
     for (int bit = 0; bit < nbits; ++bit) {
       m_data[m_currentPinBit[pin] + bit] |= ((datum >> bit) & 0x1) << pin;
     }
     m_currentPinBit[pin] += nbits;
     m_oddParity[pin] = parityBit(m_oddParity[pin], datum, nbits);
   }
 }

◆ packerNeutralParity()

void ZdcSubBlock::packerNeutralParity ( int pin )

Pack current G-Link parity bit for given pin.

Definition at line 382 of file ZdcSubBlock.cxx.

 {
   if (pin >= 0 && pin < s_maxPins) {
     packerNeutral(pin, m_oddParity[pin], 1);
     m_oddParity[pin] = 1;
   }
 }

◆ parityBit()

int ZdcSubBlock::parityBit	(	int	init,
		uint32_t	datum,
		int	nbits
	)

static

Return the parity bit for given data.

Definition at line 260 of file ZdcSubBlock.cxx.

 {
   // set init to 0/1 for even/odd parity
   int parity = init;
   for (int bit = 0; bit < nbits; ++bit) parity ^= (datum >> bit) & 0x1;
   return parity;
 }

◆ read()

OFFLINE_FRAGMENTS_NAMESPACE::PointerType ZdcSubBlock::read	(	const OFFLINE_FRAGMENTS_NAMESPACE::PointerType	beg,
		const OFFLINE_FRAGMENTS_NAMESPACE::PointerType	end
	)

Input complete packed sub-block from ROD array.

Definition at line 121 of file ZdcSubBlock.cxx.

 {
   m_dataWords = 0;
   m_unpackerFlag = true;
   OFFLINE_FRAGMENTS_NAMESPACE::PointerType pos(beg);
   OFFLINE_FRAGMENTS_NAMESPACE::PointerType pose(end);
   for (; pos != pose; ++pos) {
     const uint32_t word = *pos;
     const SubBlockWordType type = wordType(word);
     if (type == HEADER) {
       if (m_header) return pos;
       m_header = word;
     }
     else if (type == STATUS) m_trailer = word;
     else {
       m_data.push_back(word);
       ++m_dataWords;
     }
   }
   return pose;
 }

◆ seqno() [1/2]

int ZdcSubBlock::seqno ( ) const

inline

Definition at line 255 of file ZdcSubBlock.h.

 {
   return (m_header >> s_seqnoBit) & s_seqnoMask;
 }

◆ seqno() [2/2]

int ZdcSubBlock::seqno ( uint32_t word )

static

Return seqno field from given header word.

Definition at line 448 of file ZdcSubBlock.cxx.

 {
   return (word >> s_seqnoBit) & s_seqnoMask;
 }

◆ setBunchCrossing()

void ZdcSubBlock::setBunchCrossing ( int bc )

inline

Set the Bunch Crossing number (neutral format only)

Definition at line 330 of file ZdcSubBlock.h.

 {
   if (bc) m_bunchCrossing = bc;
 }

◆ setDaqOverflow()

void ZdcSubBlock::setDaqOverflow ( int bit = 1 )

Set DAQ FIFO Overflow bit in Sub-status word.

Definition at line 186 of file ZdcSubBlock.cxx.

 {
   if (bit) {
     if (m_trailer) m_trailer |= (1 << s_daqOverflowBit);
     else setStatus(0, false, false, false, true, false, false, false);
   }
 }

◆ setGlinkParity()

void ZdcSubBlock::setGlinkParity ( int bit = 1 )

Set G-Link Parity bit in Sub-status word.

Definition at line 196 of file ZdcSubBlock.cxx.

 {
   if (bit) {
     if (m_trailer) m_trailer |= (1 << s_glinkParityBit);
     else setStatus(0, false, false, false, false, false, false, true);
   }
 }

◆ setHeader()

void ZdcSubBlock::setHeader	(	int	wordId,
		int	version,
		int	format,
		int	seqno,
		int	crate,
		int	module,
		int	slices2,
		int	slices1
	)

Store header data.

Definition at line 102 of file ZdcSubBlock.cxx.

 {
   uint32_t word = 0;
   word |= (wordId  & s_wordIdMask)  << s_wordIdBit;
   word |= (version & s_versionMask) << s_versionBit;
   word |= (format  & s_formatMask)  << s_formatBit;
   word |= (seqno   & s_seqnoMask)   << s_seqnoBit;
   word |= (crate   & s_crateMask)   << s_crateBit;
   word |= (module  & s_moduleMask)  << s_moduleBit;
   word |= (slices2 & s_slices2Mask) << s_slices2Bit;
   word |= (slices1 & s_slices1Mask) << s_slices1Bit;
   m_header = word;
 }

◆ setStatus()

void ZdcSubBlock::setStatus	(	uint32_t	failingBCN,
		bool	glinkTimeout,
		bool	glinkDown,
		bool	upstreamError,
		bool	daqOverflow,
		bool	bcnMismatch,
		bool	glinkProtocol,
		bool	glinkParity
	)

Store error status trailer.

Definition at line 160 of file ZdcSubBlock.cxx.

 {
   uint32_t word = 0;
   word |= (failingBCN & s_failingBcnMask) << s_failingBcnBit;
   word |= glinkTimeout  << s_glinkTimeoutBit;
   word |= glinkDown     << s_glinkDownBit;
   word |= upstreamError << s_upstreamErrorBit;
   word |= daqOverflow   << s_daqOverflowBit;
   word |= bcnMismatch   << s_bcnMismatchBit;
   word |= glinkProtocol << s_glinkProtocolBit;
   word |= glinkParity   << s_glinkParityBit;
   if (word) {
     word |= (wordId()    & s_wordIdMask) << s_wordIdBit;
     word |= (s_statusVal & s_statusMask) << s_statusBit;
     word |= (seqno()     & s_seqnoMask)  << s_seqnoBit;
     word |= (crate()     & s_crateMask)  << s_crateBit;
     word |= (module()    & s_moduleMask) << s_moduleBit;
   }
   m_trailer = word;
 }

◆ setStreamed()

void ZdcSubBlock::setStreamed ( )

inline

Set continuous bit streaming for compressed formats.

Definition at line 350 of file ZdcSubBlock.h.

 {
   m_maxBits = s_maxStreamedBits;
   m_maxMask = s_maxStreamedMask;
 }

◆ setUnpackErrorCode()

void ZdcSubBlock::setUnpackErrorCode ( int code )

inline

Set the unpacking error code.

Definition at line 340 of file ZdcSubBlock.h.

 {
   m_unpackError = code;
 }

◆ slice()

int ZdcSubBlock::slice ( ) const

inline

Definition at line 260 of file ZdcSubBlock.h.

 {
   return seqno();
 }

◆ slices1()

int ZdcSubBlock::slices1 ( ) const

inline

Definition at line 280 of file ZdcSubBlock.h.

 {
   return (m_header >> s_slices1Bit) & s_slices1Mask;
 }

◆ slices2()

int ZdcSubBlock::slices2 ( ) const

inline

Definition at line 275 of file ZdcSubBlock.h.

 {
   return (m_header >> s_slices2Bit) & s_slices2Mask;
 }

◆ subStatus()

uint32_t ZdcSubBlock::subStatus ( ) const

inline

Return Sub-status word.

Definition at line 325 of file ZdcSubBlock.h.

 {
   return m_trailer;
 }

◆ unpacker()

uint32_t ZdcSubBlock::unpacker ( int nbits )

Unpack given number of bits of data.

Definition at line 309 of file ZdcSubBlock.cxx.

 {
   uint32_t word = 0;
   if (nbits > 0) {
     if (m_dataPos == m_dataPosEnd) {
       m_unpackerFlag = false;
       return 0;
     }
     int nbitsDone = nbits;
     if (nbitsDone > m_maxBits - m_currentBit) {
       nbitsDone = m_maxBits - m_currentBit;
     }
     uint32_t mask = 0x1;
     for (int i = 1; i < nbitsDone; ++i) mask |= (mask << 1);
     word = (m_bitword >> m_currentBit) & mask;
     m_currentBit += nbits;
     if (m_currentBit >= m_maxBits) {
       m_bitword = 0;
       if (m_dataPos != m_dataPosEnd) {
         ++m_dataPos;
         if (m_dataPos != m_dataPosEnd) {
           m_bitword = *m_dataPos;
         }
       }
       m_currentBit = 0;
       const int bitsLeft = nbits - nbitsDone;
       if (bitsLeft > 0) {
         if (m_dataPos == m_dataPosEnd) {
           m_unpackerFlag = false;
           return word;
         }
     mask = 0x1;
     for (int i = 1; i < bitsLeft; ++i) mask |= (mask << 1);
     word |= (m_bitword & mask) << nbitsDone;
     m_currentBit = bitsLeft;
       }
     }
   }
   return word;
 }

◆ unpackerInit()

void ZdcSubBlock::unpackerInit ( )

Initialise unpacker.

Definition at line 352 of file ZdcSubBlock.cxx.

 {
   m_bitword = 0;
   m_currentBit = 0;
   m_unpackerFlag = true;
   m_dataPos = m_data.begin();
   m_dataPosEnd = m_data.end();
   if (m_dataPos != m_dataPosEnd) m_bitword = *m_dataPos;
 }

◆ unpackerNeutral()

uint32_t ZdcSubBlock::unpackerNeutral	(	int	pin,
		int	nbits
	)

Unpack given number of bits of neutral data for given pin.

Definition at line 392 of file ZdcSubBlock.cxx.

 {
   uint32_t word = 0;
   if (pin >= 0 && pin < s_maxPins && nbits > 0
                && m_currentPinBit[pin] + nbits <= m_dataWords) {
     for (int bit = 0; bit < nbits; ++bit) {
       word |= ((m_data[m_currentPinBit[pin] + bit] >> pin) & 0x1) << bit;
     }
     m_currentPinBit[pin] += nbits;
     m_oddParity[pin] = parityBit(m_oddParity[pin], word, nbits);
   } else m_unpackerFlag = false;
   return word;
 }

◆ unpackerNeutralParityError()

bool ZdcSubBlock::unpackerNeutralParityError ( int pin )

Unpack and test G-Link parity bit for given pin.

Definition at line 408 of file ZdcSubBlock.cxx.

 {
   bool error = true;
   if (pin >= 0 && pin < s_maxPins) {
     int parity = m_oddParity[pin];
     int bit    = unpackerNeutral(pin, 1);
     m_oddParity[pin] = 1;
     error = !(bit == parity);
   }
   return error;
 }

◆ unpackErrorCode()

int ZdcSubBlock::unpackErrorCode ( ) const

inline

Return the unpacking error code.

Definition at line 345 of file ZdcSubBlock.h.

 {
   return m_unpackError;
 }

◆ unpackErrorMsg()

std::string ZdcSubBlock::unpackErrorMsg ( ) const

Return the unpacking error message for printing.

Definition at line 206 of file ZdcSubBlock.cxx.

 {
   std::string msg;
   switch (m_unpackError) {
     case UNPACK_NONE:
       msg = "No error";
       break;
     case UNPACK_VERSION:
       msg = "Unsupported Data Version";
       break;
     case UNPACK_FORMAT:
       msg = "Unsupported Data Format";
       break;
     case UNPACK_COMPRESSION_VERSION:
       msg = "Unsupported Compression Version";
       break;
     case UNPACK_COMPRESSION_SLICES:
       msg = "Unsupported Number of Slices for Compression Version";
       break;
     case UNPACK_DATA_TRUNCATED:
       msg = "Premature End of Sub-block Data";
       break;
     case UNPACK_SOURCE_ID:
       msg = "Invalid Source ID in Sub-block Data";
       break;
     case UNPACK_WORD_ID:
       msg = "Invalid Word ID in Sub-block Data";
       break;
     default:
       msg = "Unknown Error Code";
       break;
   }
   return msg;
 }

◆ unpackerSuccess()

bool ZdcSubBlock::unpackerSuccess ( ) const

inline

Return unpacker success flag.

Definition at line 356 of file ZdcSubBlock.h.

 {
   return m_unpackerFlag;
 }

◆ upstreamError()

bool ZdcSubBlock::upstreamError ( ) const

inline

Definition at line 300 of file ZdcSubBlock.h.

 {
   return m_trailer & (0x1 << s_upstreamErrorBit);
 }

◆ version()

int ZdcSubBlock::version ( ) const

inline

Definition at line 245 of file ZdcSubBlock.h.

 {
   return (m_header >> s_versionBit) & s_versionMask;
 }

◆ wordId() [1/2]

int ZdcSubBlock::wordId ( ) const

inline

Definition at line 240 of file ZdcSubBlock.h.

 {
   return (m_header >> s_wordIdBit) & s_wordIdMask;
 }

◆ wordId() [2/2]

int ZdcSubBlock::wordId ( uint32_t word )

static

Return wordID field from given header word.

Definition at line 434 of file ZdcSubBlock.cxx.

 {
   return (word >> s_wordIdBit) & s_wordIdMask;
 }

◆ wordType()

ZdcSubBlock::SubBlockWordType ZdcSubBlock::wordType ( uint32_t word )

static

Word identification.

Definition at line 422 of file ZdcSubBlock.cxx.

 {
   SubBlockWordType type = DATA;
   if (((word >> s_headerBit) & s_headerMask) == s_headerVal) {
     if (((word >> s_statusBit) & s_statusMask) == s_statusVal) type = STATUS;
     else type = HEADER;
   }
   return type;
 }

◆ write()

void ZdcSubBlock::write ( FullEventAssembler< ZdcSrcIdMap >::RODDATA * theROD ) const

Output complete packed sub-block to ROD vector.

Definition at line 147 of file ZdcSubBlock.cxx.

 {
   theROD->push_back(m_header);
   std::vector<uint32_t>::const_iterator pos;
   for (pos = m_data.begin(); pos != m_data.end(); ++pos) {
     theROD->push_back(*pos);
   }
   if (m_trailer) theROD->push_back(m_trailer);
 }

Member Data Documentation

◆ m_bitword

uint32_t ZdcSubBlock::m_bitword {}

private

Definition at line 218 of file ZdcSubBlock.h.

◆ m_bunchCrossing

int ZdcSubBlock::m_bunchCrossing {}

private

Bunch Crossing number (neutral format only)

Definition at line 214 of file ZdcSubBlock.h.

◆ m_currentBit

int ZdcSubBlock::m_currentBit {}

private

Definition at line 219 of file ZdcSubBlock.h.

◆ m_currentPinBit

std::vector<int> ZdcSubBlock::m_currentPinBit

private

Definition at line 226 of file ZdcSubBlock.h.

◆ m_data

std::vector<uint32_t> ZdcSubBlock::m_data

private

Sub-Block data.

Definition at line 231 of file ZdcSubBlock.h.

◆ m_dataPos

std::vector<uint32_t>::const_iterator ZdcSubBlock::m_dataPos {}

private

Definition at line 223 of file ZdcSubBlock.h.

◆ m_dataPosEnd

std::vector<uint32_t>::const_iterator ZdcSubBlock::m_dataPosEnd {}

private

Definition at line 224 of file ZdcSubBlock.h.

◆ m_dataWords

int ZdcSubBlock::m_dataWords {}

private

Current number of data words.

Definition at line 229 of file ZdcSubBlock.h.

◆ m_header

uint32_t ZdcSubBlock::m_header {}

private

Sub-Block Header.

Definition at line 210 of file ZdcSubBlock.h.

◆ m_maxBits

int ZdcSubBlock::m_maxBits {}

private

Definition at line 220 of file ZdcSubBlock.h.

◆ m_maxMask

uint32_t ZdcSubBlock::m_maxMask {}

private

Definition at line 221 of file ZdcSubBlock.h.

◆ m_oddParity

std::vector<int> ZdcSubBlock::m_oddParity

private

Definition at line 227 of file ZdcSubBlock.h.

◆ m_trailer

uint32_t ZdcSubBlock::m_trailer {}

private

Sub-Block Status Trailer.

Definition at line 212 of file ZdcSubBlock.h.

◆ m_unpackerFlag

bool ZdcSubBlock::m_unpackerFlag {}

private

Definition at line 222 of file ZdcSubBlock.h.

◆ m_unpackError

int ZdcSubBlock::m_unpackError {}

private

Unpacking error code.

Definition at line 216 of file ZdcSubBlock.h.

◆ s_bcnMismatchBit

const int ZdcSubBlock::s_bcnMismatchBit = 2

staticprivate

Definition at line 196 of file ZdcSubBlock.h.

◆ s_crateBit

const int ZdcSubBlock::s_crateBit = 12

staticprivate

Definition at line 178 of file ZdcSubBlock.h.

◆ s_crateMask

const uint32_t ZdcSubBlock::s_crateMask = 0xf

staticprivate

Definition at line 186 of file ZdcSubBlock.h.

◆ s_daqOverflowBit

const int ZdcSubBlock::s_daqOverflowBit = 3

staticprivate

Definition at line 195 of file ZdcSubBlock.h.

◆ s_failingBcnBit

const int ZdcSubBlock::s_failingBcnBit = 22

staticprivate

Definition at line 191 of file ZdcSubBlock.h.

◆ s_failingBcnMask

const uint32_t ZdcSubBlock::s_failingBcnMask = 0x3f

staticprivate

Definition at line 199 of file ZdcSubBlock.h.

◆ s_formatBit

const int ZdcSubBlock::s_formatBit = 22

staticprivate

Definition at line 176 of file ZdcSubBlock.h.

◆ s_formatMask

const uint32_t ZdcSubBlock::s_formatMask = 0x7

staticprivate

Definition at line 184 of file ZdcSubBlock.h.

◆ s_glinkDavSet

const uint32_t ZdcSubBlock::s_glinkDavSet = 0x400000

staticprivate

Definition at line 207 of file ZdcSubBlock.h.

◆ s_glinkDownBit

const int ZdcSubBlock::s_glinkDownBit = 6

staticprivate

Definition at line 193 of file ZdcSubBlock.h.

◆ s_glinkParityBit

const int ZdcSubBlock::s_glinkParityBit = 0

staticprivate

Definition at line 198 of file ZdcSubBlock.h.

◆ s_glinkProtocolBit

const int ZdcSubBlock::s_glinkProtocolBit = 1

staticprivate

Definition at line 197 of file ZdcSubBlock.h.

◆ s_glinkTimeoutBit

const int ZdcSubBlock::s_glinkTimeoutBit = 7

staticprivate

Definition at line 192 of file ZdcSubBlock.h.

◆ s_headerBit

const int ZdcSubBlock::s_headerBit = 30

staticprivate

ZdcSubBlock.cxx this is a base class derived (copyed) from LVL1 I do not think we need this this way; either implement directly on PpmSubBlock or link to LVL1.

TRY_LINK_LVL1

Marco Leite 27 May 2009

Definition at line 167 of file ZdcSubBlock.h.

◆ s_headerMask

const uint32_t ZdcSubBlock::s_headerMask = 0x3

staticprivate

Definition at line 169 of file ZdcSubBlock.h.

◆ s_headerVal

const uint32_t ZdcSubBlock::s_headerVal = 0x3

staticprivate

Definition at line 171 of file ZdcSubBlock.h.

◆ s_maxPins

const int ZdcSubBlock::s_maxPins = 20

staticprivate

Definition at line 206 of file ZdcSubBlock.h.

◆ s_maxStreamedBits

const int ZdcSubBlock::s_maxStreamedBits = 31

staticprivate

Definition at line 202 of file ZdcSubBlock.h.

◆ s_maxStreamedMask

const uint32_t ZdcSubBlock::s_maxStreamedMask = 0x7fffffff

staticprivate

Definition at line 204 of file ZdcSubBlock.h.

◆ s_maxWordBits

const int ZdcSubBlock::s_maxWordBits = 32

staticprivate

Definition at line 201 of file ZdcSubBlock.h.

◆ s_maxWordMask

const uint32_t ZdcSubBlock::s_maxWordMask = 0xffffffff

staticprivate

Definition at line 203 of file ZdcSubBlock.h.

◆ s_moduleBit

const int ZdcSubBlock::s_moduleBit = 8

staticprivate

Definition at line 179 of file ZdcSubBlock.h.

◆ s_moduleMask

const uint32_t ZdcSubBlock::s_moduleMask = 0xf

staticprivate

Definition at line 187 of file ZdcSubBlock.h.

◆ s_seqnoBit

const int ZdcSubBlock::s_seqnoBit = 16

staticprivate

Definition at line 177 of file ZdcSubBlock.h.

◆ s_seqnoMask

const uint32_t ZdcSubBlock::s_seqnoMask = 0x3f

staticprivate

Definition at line 185 of file ZdcSubBlock.h.

◆ s_slices1Bit

const int ZdcSubBlock::s_slices1Bit = 0

staticprivate

Definition at line 181 of file ZdcSubBlock.h.

◆ s_slices1Mask

const uint32_t ZdcSubBlock::s_slices1Mask = 0x7

staticprivate

Definition at line 189 of file ZdcSubBlock.h.

◆ s_slices2Bit

const int ZdcSubBlock::s_slices2Bit = 3

staticprivate

Definition at line 180 of file ZdcSubBlock.h.

◆ s_slices2Mask

const uint32_t ZdcSubBlock::s_slices2Mask = 0x1f

staticprivate

Definition at line 188 of file ZdcSubBlock.h.

◆ s_statusBit

const int ZdcSubBlock::s_statusBit = 28

staticprivate

Definition at line 168 of file ZdcSubBlock.h.

◆ s_statusMask

const uint32_t ZdcSubBlock::s_statusMask = 0x1

staticprivate

Definition at line 170 of file ZdcSubBlock.h.

◆ s_statusVal

const uint32_t ZdcSubBlock::s_statusVal = 0x1

staticprivate

Definition at line 172 of file ZdcSubBlock.h.

◆ s_upstreamErrorBit

const int ZdcSubBlock::s_upstreamErrorBit = 4

staticprivate

Definition at line 194 of file ZdcSubBlock.h.

◆ s_versionBit

const int ZdcSubBlock::s_versionBit = 25

staticprivate

Definition at line 175 of file ZdcSubBlock.h.

◆ s_versionMask

const uint32_t ZdcSubBlock::s_versionMask = 0x7

staticprivate

Definition at line 183 of file ZdcSubBlock.h.

◆ s_wordIdBit

const int ZdcSubBlock::s_wordIdBit = 28

staticprivate

Definition at line 174 of file ZdcSubBlock.h.

◆ s_wordIdMask

const uint32_t ZdcSubBlock::s_wordIdMask = 0xf

staticprivate

Definition at line 182 of file ZdcSubBlock.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ DataFormats

◆ SubBlockWordType

◆ UnpackErrorType

Constructor & Destructor Documentation

◆ ZdcSubBlock()

◆ ~ZdcSubBlock()

Member Function Documentation

◆ bcnMismatch()

◆ bunchCrossing()

◆ clear()

◆ crate()

◆ daqOverflow()

◆ dataWords()

◆ failingBCN()

◆ format() [1/2]

◆ format() [2/2]

◆ glinkDown()

◆ glinkParity()

◆ glinkProtocol()

◆ glinkTimeout()

◆ minBits()

◆ module() [1/2]

◆ module() [2/2]

◆ packer()

◆ packerFlush()

◆ packerNeutral()

◆ packerNeutralParity()

◆ parityBit()

◆ read()

◆ seqno() [1/2]

◆ seqno() [2/2]

◆ setBunchCrossing()

◆ setDaqOverflow()

◆ setGlinkParity()

◆ setHeader()

◆ setStatus()

◆ setStreamed()

◆ setUnpackErrorCode()

◆ slice()

◆ slices1()

◆ slices2()

◆ subStatus()

◆ unpacker()

◆ unpackerInit()

◆ unpackerNeutral()

◆ unpackerNeutralParityError()

◆ unpackErrorCode()

◆ unpackErrorMsg()

◆ unpackerSuccess()

◆ upstreamError()

◆ version()

◆ wordId() [1/2]

◆ wordId() [2/2]

◆ wordType()

◆ write()

Member Data Documentation

◆ m_bitword

◆ m_bunchCrossing

◆ m_currentBit

◆ m_currentPinBit

◆ m_data

◆ m_dataPos

◆ m_dataPosEnd

◆ m_dataWords

◆ m_header

◆ m_maxBits

◆ m_maxMask

◆ m_oddParity

◆ m_trailer

◆ m_unpackerFlag

◆ m_unpackError

◆ s_bcnMismatchBit

◆ s_crateBit