LVL1BS::L1CaloSubBlock Class Reference

L1Calo Sub-Block base class. More...

#include <L1CaloSubBlock.h>

Inherited by LVL1BS::CmmSubBlock, LVL1BS::CmxSubBlock, LVL1BS::CpmRoiSubBlock, LVL1BS::CpmRoiSubBlockV1, LVL1BS::CpmRoiSubBlockV2, LVL1BS::CpmSubBlock, LVL1BS::CpmSubBlockV1, LVL1BS::CpmSubBlockV2, LVL1BS::JemRoiSubBlock, LVL1BS::JemRoiSubBlockV1, LVL1BS::JemRoiSubBlockV2, LVL1BS::JemSubBlock, LVL1BS::JemSubBlockV1, LVL1BS::JemSubBlockV2, and LVL1BS::PpmSubBlockV1.

Collaboration diagram for LVL1BS::L1CaloSubBlock:

Public Types
enum	SubBlockWordType { HEADER, DATA, STATUS }
enum	DataFormats { NEUTRAL = 0, UNCOMPRESSED = 1, COMPRESSED = 2, SUPERCOMPRESSED = 3 }
enum	DataErrorType {   ERROR_NONE, ERROR_DUPLICATE_ROB, ERROR_ROD_ID, ERROR_ROD_NSTATUS,   ERROR_USER_HEADER, ERROR_MISSING_HEADER, ERROR_MISSING_SUBBLOCK, ERROR_CRATE_NUMBER,   ERROR_MODULE_NUMBER, ERROR_SLICES, ERROR_DUPLICATE_DATA, ERROR_ROI_TYPE,   ERROR_MAX }
enum	UnpackErrorType {   UNPACK_NONE = ERROR_NONE, UNPACK_VERSION = ERROR_MAX, UNPACK_FORMAT, UNPACK_COMPRESSION_VERSION,   UNPACK_COMPRESSION_SLICES, UNPACK_DATA_TRUNCATED, UNPACK_EXCESS_DATA, UNPACK_SOURCE_ID,   UNPACK_EXCESS_TOBS, UNPACK_DATA_ID }

Public Member Functions
	L1CaloSubBlock ()
	~L1CaloSubBlock ()
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< L1CaloSrcIdMap >::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...
int	minBits (uint32_t datum) const
	Return the minimum number of bits needed for given data. More...
int	parityBit (int init, uint32_t datum, int nbits) const
	Return the parity bit for given data. 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...
uint32_t	unpacker (int nbits, int align)
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...
int	currentPinBit (int pin) const
	Return current pin 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	version (uint32_t word)
	Return version number 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...

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...
std::vector< uint32_t >	m_unpackingMasks
	Unpacking masks. More...

Static Private Attributes
static const int	s_headerBit = 30
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_ppmCrates = 8
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

L1Calo Sub-Block base class.

Provides common functionality for all L1Calo Sub-Block derived types.

Author

Peter Faulkner

Definition at line 24 of file L1CaloSubBlock.h.

Member Enumeration Documentation

DataErrorType

enum LVL1BS::L1CaloSubBlock::DataErrorType

Enumerator
ERROR_NONE
ERROR_DUPLICATE_ROB
ERROR_ROD_ID
ERROR_ROD_NSTATUS
ERROR_USER_HEADER
ERROR_MISSING_HEADER
ERROR_MISSING_SUBBLOCK
ERROR_CRATE_NUMBER
ERROR_MODULE_NUMBER
ERROR_SLICES
ERROR_DUPLICATE_DATA
ERROR_ROI_TYPE
ERROR_MAX

Definition at line 31 of file L1CaloSubBlock.h.

                         { ERROR_NONE, ERROR_DUPLICATE_ROB, ERROR_ROD_ID,
                           ERROR_ROD_NSTATUS, ERROR_USER_HEADER,
                           ERROR_MISSING_HEADER, ERROR_MISSING_SUBBLOCK,
               ERROR_CRATE_NUMBER, ERROR_MODULE_NUMBER,
               ERROR_SLICES, ERROR_DUPLICATE_DATA,
               ERROR_ROI_TYPE, ERROR_MAX };

DataFormats

enum LVL1BS::L1CaloSubBlock::DataFormats

Enumerator
NEUTRAL
UNCOMPRESSED
COMPRESSED
SUPERCOMPRESSED

Definition at line 28 of file L1CaloSubBlock.h.

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

SubBlockWordType

enum LVL1BS::L1CaloSubBlock::SubBlockWordType

Enumerator
HEADER
DATA
STATUS

Definition at line 27 of file L1CaloSubBlock.h.

{ HEADER, DATA, STATUS };

UnpackErrorType

enum LVL1BS::L1CaloSubBlock::UnpackErrorType

Enumerator
UNPACK_NONE
UNPACK_VERSION
UNPACK_FORMAT
UNPACK_COMPRESSION_VERSION
UNPACK_COMPRESSION_SLICES
UNPACK_DATA_TRUNCATED
UNPACK_EXCESS_DATA
UNPACK_SOURCE_ID
UNPACK_EXCESS_TOBS
UNPACK_DATA_ID

Definition at line 38 of file L1CaloSubBlock.h.

                         { UNPACK_NONE = ERROR_NONE, UNPACK_VERSION = ERROR_MAX,
                           UNPACK_FORMAT, UNPACK_COMPRESSION_VERSION,
               UNPACK_COMPRESSION_SLICES, UNPACK_DATA_TRUNCATED,
               UNPACK_EXCESS_DATA, UNPACK_SOURCE_ID,
               UNPACK_EXCESS_TOBS, UNPACK_DATA_ID };

Constructor & Destructor Documentation

L1CaloSubBlock()

LVL1BS::L1CaloSubBlock::L1CaloSubBlock

(

)

Definition at line 57 of file L1CaloSubBlock.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)
{
    // Initialize unpacking masks
    m_unpackingMasks.assign(s_maxWordBits + 1, 0);
    for (int i = 1; i <= s_maxWordBits; ++i)
    {
        m_unpackingMasks[i] = (m_unpackingMasks[i - 1] << 1) | 0x1;
    }
}

~L1CaloSubBlock()

LVL1BS::L1CaloSubBlock::~L1CaloSubBlock

(

)

Definition at line 76 of file L1CaloSubBlock.cxx.

{
}

Member Function Documentation

bcnMismatch()

bool LVL1BS::L1CaloSubBlock::bcnMismatch ( ) const

inline

Definition at line 308 of file L1CaloSubBlock.h.

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

bunchCrossing()

int LVL1BS::L1CaloSubBlock::bunchCrossing ( ) const

inline

Return the Bunch Crossing number (neutral format only)

Definition at line 333 of file L1CaloSubBlock.h.

{
  return m_bunchCrossing;
}

clear()

void LVL1BS::L1CaloSubBlock::clear

(

)

Clear all data.

Definition at line 82 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::crate ( ) const

inline

Definition at line 263 of file L1CaloSubBlock.h.

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

currentPinBit()

int LVL1BS::L1CaloSubBlock::currentPinBit ( int  pin ) const

inline

Return current pin bit for given pin.

Definition at line 359 of file L1CaloSubBlock.h.

{
  return m_currentPinBit[pin];
}

daqOverflow()

bool LVL1BS::L1CaloSubBlock::daqOverflow ( ) const

inline

Definition at line 303 of file L1CaloSubBlock.h.

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

dataWords()

int LVL1BS::L1CaloSubBlock::dataWords ( ) const

inline

Return number of data words.

Definition at line 233 of file L1CaloSubBlock.h.

{
  return m_dataWords;
}

failingBCN()

uint32_t LVL1BS::L1CaloSubBlock::failingBCN ( ) const

inline

Definition at line 283 of file L1CaloSubBlock.h.

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

format() [1/2]

int LVL1BS::L1CaloSubBlock::format ( ) const

inline

Definition at line 248 of file L1CaloSubBlock.h.

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

format() [2/2]

int LVL1BS::L1CaloSubBlock::format ( uint32_t  word )

static

Return data format from given header word.

Definition at line 506 of file L1CaloSubBlock.cxx.

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

glinkDown()

bool LVL1BS::L1CaloSubBlock::glinkDown ( ) const

inline

Definition at line 293 of file L1CaloSubBlock.h.

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

glinkParity()

bool LVL1BS::L1CaloSubBlock::glinkParity ( ) const

inline

Definition at line 318 of file L1CaloSubBlock.h.

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

glinkProtocol()

bool LVL1BS::L1CaloSubBlock::glinkProtocol ( ) const

inline

Definition at line 313 of file L1CaloSubBlock.h.

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

glinkTimeout()

bool LVL1BS::L1CaloSubBlock::glinkTimeout ( ) const

inline

Definition at line 288 of file L1CaloSubBlock.h.

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

minBits()

int LVL1BS::L1CaloSubBlock::minBits

(

uint32_t

datum

)

const

Return the minimum number of bits needed for given data.

Definition at line 274 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::module ( ) const

inline

Definition at line 268 of file L1CaloSubBlock.h.

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

module() [2/2]

int LVL1BS::L1CaloSubBlock::module ( uint32_t  word )

static

Return module field from given header word.

Definition at line 520 of file L1CaloSubBlock.cxx.

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

packer()

void LVL1BS::L1CaloSubBlock::packer	(	uint32_t	datum,
		int	nbits
	)

Pack given data into given number of bits.

Definition at line 302 of file L1CaloSubBlock.cxx.

{
    if (nbits > 0)
    {
        uint32_t mask = m_unpackingMasks[nbits];
        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 LVL1BS::L1CaloSubBlock::packerFlush

(

)

Flush the current data word padded with zeros.

Definition at line 331 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::packerNeutral	(	int	pin,
		uint32_t	datum,
		int	nbits
	)

Pack given neutral data from given pin.

Definition at line 413 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::packerNeutralParity

(

int

pin

)

Pack current G-Link parity bit for given pin.

Definition at line 434 of file L1CaloSubBlock.cxx.

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

parityBit()

int LVL1BS::L1CaloSubBlock::parityBit	(	int	init,
		uint32_t	datum,
		int	nbits
	)		const

Return the parity bit for given data.

Definition at line 291 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::read	(	const OFFLINE_FRAGMENTS_NAMESPACE::PointerType	beg,
		const OFFLINE_FRAGMENTS_NAMESPACE::PointerType	end
	)

Input complete packed sub-block from ROD array.

Definition at line 118 of file L1CaloSubBlock.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)
        {
            // Word ID should be consistent with header
            if (m_trailer || (wordId(word) != wordId() + 1)) return pos;
            m_trailer = word;
        }
        else
        {
            // Check data word IDs
            const int id = wordId(word);
            bool badId = false;
            // All neutral format '0000'
            if (format() == NEUTRAL)        badId = (id != 0);
            // Other PPM '0xxx'
            else if (crate() < s_ppmCrates) badId = ((id & 0x8) != 0);
            // Other CPM/JEM '01xx' or '10xx'
            else if (wordId() == 0xc)       badId = (((id & 0xc) != 0x4) &&
                                                        ((id & 0xc) != 0x8));
            // Other CMM/CMX '00xx'
            else                            badId = ((id & 0xc) != 0);
            if (m_trailer || badId) return pos;
            m_data.push_back(word);
            ++m_dataWords;
        }
    }
    return pose;
}

seqno() [1/2]

int LVL1BS::L1CaloSubBlock::seqno ( ) const

inline

Definition at line 253 of file L1CaloSubBlock.h.

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

seqno() [2/2]

int LVL1BS::L1CaloSubBlock::seqno ( uint32_t  word )

static

Return seqno field from given header word.

Definition at line 513 of file L1CaloSubBlock.cxx.

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

setBunchCrossing()

void LVL1BS::L1CaloSubBlock::setBunchCrossing ( int  bc )

inline

Set the Bunch Crossing number (neutral format only)

Definition at line 328 of file L1CaloSubBlock.h.

{
  if (bc) m_bunchCrossing = bc;
}

setDaqOverflow()

void LVL1BS::L1CaloSubBlock::setDaqOverflow

(

int

bit = 1

)

Set DAQ FIFO Overflow bit in Sub-status word.

Definition at line 206 of file L1CaloSubBlock.cxx.

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

setGlinkParity()

void LVL1BS::L1CaloSubBlock::setGlinkParity

(

int

bit = 1

)

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

Definition at line 217 of file L1CaloSubBlock.cxx.

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

setHeader()

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

Store header data.

Definition at line 99 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::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 179 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::setStreamed ( )

inline

Set continuous bit streaming for compressed formats.

Definition at line 348 of file L1CaloSubBlock.h.

{
  m_maxBits = s_maxStreamedBits;
  m_maxMask = s_maxStreamedMask;
}

setUnpackErrorCode()

void LVL1BS::L1CaloSubBlock::setUnpackErrorCode ( int  code )

inline

Set the unpacking error code.

Definition at line 338 of file L1CaloSubBlock.h.

{
  m_unpackError = code;
}

slice()

int LVL1BS::L1CaloSubBlock::slice ( ) const

inline

Definition at line 258 of file L1CaloSubBlock.h.

{
  return seqno();
}

slices1()

int LVL1BS::L1CaloSubBlock::slices1 ( ) const

inline

Definition at line 278 of file L1CaloSubBlock.h.

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

slices2()

int LVL1BS::L1CaloSubBlock::slices2 ( ) const

inline

Definition at line 273 of file L1CaloSubBlock.h.

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

subStatus()

uint32_t LVL1BS::L1CaloSubBlock::subStatus ( ) const

inline

Return Sub-status word.

Definition at line 323 of file L1CaloSubBlock.h.

{
  return m_trailer;
}

unpacker() [1/2]

uint32_t LVL1BS::L1CaloSubBlock::unpacker

(

int

nbits

)

Unpack given number of bits of data.

Definition at line 345 of file L1CaloSubBlock.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;
        }
        word = (m_bitword >> m_currentBit) & m_unpackingMasks[nbitsDone];
        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;
                }
                word |= (m_bitword & m_unpackingMasks[bitsLeft]) << nbitsDone;
                m_currentBit = bitsLeft;
            }
        }
    }  
    return word;
}

unpacker() [2/2]

uint32_t LVL1BS::L1CaloSubBlock::unpacker	(	int	nbits,
		int	align
	)

unpackerInit()

void LVL1BS::L1CaloSubBlock::unpackerInit

(

)

Initialise unpacker.

Definition at line 393 of file L1CaloSubBlock.cxx.

{
    m_bitword = 0;
    m_currentBit = 0;
    m_unpackerFlag = true;
    m_dataPos = m_data.begin();
    m_dataPosEnd = m_data.end();
    // std::cout << "SASHA4 m_dataPosEnd - m_dataPos=" << (m_dataPosEnd - m_dataPos) << std::endl;
    // uint16_t a = (*m_dataPos) & 0xFF;
    // uint16_t b = (*m_dataPos >> 11) & 0xFF;
    
    // std::cout << "SASHA5 first " << a << std::endl;
    // std::cout << "SASHA5 second " << b << std::endl;
    // std::cout << "SASHA5 datawords " << m_data.size() << std::endl;
 
    if (m_dataPos != m_dataPosEnd) m_bitword = *m_dataPos;
}

unpackerNeutral()

uint32_t LVL1BS::L1CaloSubBlock::unpackerNeutral	(	int	pin,
		int	nbits
	)

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

Definition at line 445 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::unpackerNeutralParityError

(

int

pin

)

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

Definition at line 464 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::unpackErrorCode ( ) const

inline

Return the unpacking error code.

Definition at line 343 of file L1CaloSubBlock.h.

{
  return m_unpackError;
}

unpackErrorMsg()

std::string LVL1BS::L1CaloSubBlock::unpackErrorMsg

(

)

const

Return the unpacking error message for printing.

Definition at line 228 of file L1CaloSubBlock.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_EXCESS_DATA:
        msg = "Excess Data in Sub-block";
        break;
    case UNPACK_SOURCE_ID:
        msg = "Invalid Source ID in Sub-block Data";
        break;
    case UNPACK_EXCESS_TOBS:
        msg = "Excess TOBs in Sub-block Data";
        break;
    case UNPACK_DATA_ID:
        msg = "Invalid word ID in Sub-block Data";
        break;
    default:
        msg = "Unknown Error Code";
        break;
    }
    return msg;
}

unpackerSuccess()

bool LVL1BS::L1CaloSubBlock::unpackerSuccess ( ) const

inline

Return unpacker success flag.

Definition at line 354 of file L1CaloSubBlock.h.

{
  return m_unpackerFlag;
}

upstreamError()

bool LVL1BS::L1CaloSubBlock::upstreamError ( ) const

inline

Definition at line 298 of file L1CaloSubBlock.h.

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

version() [1/2]

int LVL1BS::L1CaloSubBlock::version ( ) const

inline

Definition at line 243 of file L1CaloSubBlock.h.

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

version() [2/2]

int LVL1BS::L1CaloSubBlock::version ( uint32_t  word )

static

Return version number from given header word.

Definition at line 499 of file L1CaloSubBlock.cxx.

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

wordId() [1/2]

int LVL1BS::L1CaloSubBlock::wordId ( ) const

inline

Definition at line 238 of file L1CaloSubBlock.h.

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

wordId() [2/2]

int LVL1BS::L1CaloSubBlock::wordId ( uint32_t  word )

static

Return wordID field from given header word.

Definition at line 492 of file L1CaloSubBlock.cxx.

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

wordType()

L1CaloSubBlock::SubBlockWordType LVL1BS::L1CaloSubBlock::wordType ( uint32_t  word )

static

Word identification.

Definition at line 479 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::write

(

FullEventAssembler< L1CaloSrcIdMap >::RODDATA *

theROD

)

const

Output complete packed sub-block to ROD vector.

Definition at line 165 of file L1CaloSubBlock.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 LVL1BS::L1CaloSubBlock::m_bitword

private

Definition at line 214 of file L1CaloSubBlock.h.

m_bunchCrossing

int LVL1BS::L1CaloSubBlock::m_bunchCrossing

private

Bunch Crossing number (neutral format only)

Definition at line 210 of file L1CaloSubBlock.h.

m_currentBit

int LVL1BS::L1CaloSubBlock::m_currentBit

private

Definition at line 215 of file L1CaloSubBlock.h.

m_currentPinBit

std::vector<int> LVL1BS::L1CaloSubBlock::m_currentPinBit

private

Definition at line 222 of file L1CaloSubBlock.h.

m_data

std::vector<uint32_t> LVL1BS::L1CaloSubBlock::m_data

private

Sub-Block data.

Definition at line 227 of file L1CaloSubBlock.h.

m_dataPos

std::vector<uint32_t>::const_iterator LVL1BS::L1CaloSubBlock::m_dataPos

private

Definition at line 219 of file L1CaloSubBlock.h.

m_dataPosEnd

std::vector<uint32_t>::const_iterator LVL1BS::L1CaloSubBlock::m_dataPosEnd

private

Definition at line 220 of file L1CaloSubBlock.h.

m_dataWords

int LVL1BS::L1CaloSubBlock::m_dataWords

private

Current number of data words.

Definition at line 225 of file L1CaloSubBlock.h.

m_header

uint32_t LVL1BS::L1CaloSubBlock::m_header

private

Sub-Block Header.

Definition at line 206 of file L1CaloSubBlock.h.

m_maxBits

int LVL1BS::L1CaloSubBlock::m_maxBits

private

Definition at line 216 of file L1CaloSubBlock.h.

m_maxMask

uint32_t LVL1BS::L1CaloSubBlock::m_maxMask

private

Definition at line 217 of file L1CaloSubBlock.h.

m_oddParity

std::vector<int> LVL1BS::L1CaloSubBlock::m_oddParity

private

Definition at line 223 of file L1CaloSubBlock.h.

m_trailer

uint32_t LVL1BS::L1CaloSubBlock::m_trailer

private

Sub-Block Status Trailer.

Definition at line 208 of file L1CaloSubBlock.h.

m_unpackerFlag

bool LVL1BS::L1CaloSubBlock::m_unpackerFlag

private

Definition at line 218 of file L1CaloSubBlock.h.

m_unpackError

int LVL1BS::L1CaloSubBlock::m_unpackError

private

Unpacking error code.

Definition at line 212 of file L1CaloSubBlock.h.

m_unpackingMasks

std::vector<uint32_t> LVL1BS::L1CaloSubBlock::m_unpackingMasks

private

Unpacking masks.

Definition at line 229 of file L1CaloSubBlock.h.

s_bcnMismatchBit

const int LVL1BS::L1CaloSubBlock::s_bcnMismatchBit = 2

staticprivate

Definition at line 192 of file L1CaloSubBlock.h.

s_crateBit

const int LVL1BS::L1CaloSubBlock::s_crateBit = 12

staticprivate

Definition at line 174 of file L1CaloSubBlock.h.

s_crateMask

const uint32_t LVL1BS::L1CaloSubBlock::s_crateMask = 0xf

staticprivate

Definition at line 182 of file L1CaloSubBlock.h.

s_daqOverflowBit

const int LVL1BS::L1CaloSubBlock::s_daqOverflowBit = 3

staticprivate

Definition at line 191 of file L1CaloSubBlock.h.

s_failingBcnBit

const int LVL1BS::L1CaloSubBlock::s_failingBcnBit = 22

staticprivate

Definition at line 187 of file L1CaloSubBlock.h.

s_failingBcnMask

const uint32_t LVL1BS::L1CaloSubBlock::s_failingBcnMask = 0x3f

staticprivate

Definition at line 195 of file L1CaloSubBlock.h.

s_formatBit

const int LVL1BS::L1CaloSubBlock::s_formatBit = 22

staticprivate

Definition at line 172 of file L1CaloSubBlock.h.

s_formatMask

const uint32_t LVL1BS::L1CaloSubBlock::s_formatMask = 0x7

staticprivate

Definition at line 180 of file L1CaloSubBlock.h.

s_glinkDavSet

const uint32_t LVL1BS::L1CaloSubBlock::s_glinkDavSet = 0x400000

staticprivate

Definition at line 203 of file L1CaloSubBlock.h.

s_glinkDownBit

const int LVL1BS::L1CaloSubBlock::s_glinkDownBit = 6

staticprivate

Definition at line 189 of file L1CaloSubBlock.h.

s_glinkParityBit

const int LVL1BS::L1CaloSubBlock::s_glinkParityBit = 0

staticprivate

Definition at line 194 of file L1CaloSubBlock.h.

s_glinkProtocolBit

const int LVL1BS::L1CaloSubBlock::s_glinkProtocolBit = 1

staticprivate

Definition at line 193 of file L1CaloSubBlock.h.

s_glinkTimeoutBit

const int LVL1BS::L1CaloSubBlock::s_glinkTimeoutBit = 7

staticprivate

Definition at line 188 of file L1CaloSubBlock.h.

s_headerBit

const int LVL1BS::L1CaloSubBlock::s_headerBit = 30

staticprivate

Definition at line 161 of file L1CaloSubBlock.h.

s_headerMask

const uint32_t LVL1BS::L1CaloSubBlock::s_headerMask = 0x3

staticprivate

Definition at line 163 of file L1CaloSubBlock.h.

s_headerVal

const uint32_t LVL1BS::L1CaloSubBlock::s_headerVal = 0x3

staticprivate

Definition at line 165 of file L1CaloSubBlock.h.

s_maxPins

const int LVL1BS::L1CaloSubBlock::s_maxPins = 20

staticprivate

Definition at line 202 of file L1CaloSubBlock.h.

s_maxStreamedBits

const int LVL1BS::L1CaloSubBlock::s_maxStreamedBits = 31

staticprivate

Definition at line 198 of file L1CaloSubBlock.h.

s_maxStreamedMask

const uint32_t LVL1BS::L1CaloSubBlock::s_maxStreamedMask = 0x7fffffff

staticprivate

Definition at line 200 of file L1CaloSubBlock.h.

s_maxWordBits

const int LVL1BS::L1CaloSubBlock::s_maxWordBits = 32

staticprivate

Definition at line 197 of file L1CaloSubBlock.h.

s_maxWordMask

const uint32_t LVL1BS::L1CaloSubBlock::s_maxWordMask = 0xffffffff

staticprivate

Definition at line 199 of file L1CaloSubBlock.h.

s_moduleBit

const int LVL1BS::L1CaloSubBlock::s_moduleBit = 8

staticprivate

Definition at line 175 of file L1CaloSubBlock.h.

s_moduleMask

const uint32_t LVL1BS::L1CaloSubBlock::s_moduleMask = 0xf

staticprivate

Definition at line 183 of file L1CaloSubBlock.h.

s_ppmCrates

const int LVL1BS::L1CaloSubBlock::s_ppmCrates = 8

staticprivate

Definition at line 168 of file L1CaloSubBlock.h.

s_seqnoBit

const int LVL1BS::L1CaloSubBlock::s_seqnoBit = 16

staticprivate

Definition at line 173 of file L1CaloSubBlock.h.

s_seqnoMask

const uint32_t LVL1BS::L1CaloSubBlock::s_seqnoMask = 0x3f

staticprivate

Definition at line 181 of file L1CaloSubBlock.h.

s_slices1Bit

const int LVL1BS::L1CaloSubBlock::s_slices1Bit = 0

staticprivate

Definition at line 177 of file L1CaloSubBlock.h.

s_slices1Mask

const uint32_t LVL1BS::L1CaloSubBlock::s_slices1Mask = 0x7

staticprivate

Definition at line 185 of file L1CaloSubBlock.h.

s_slices2Bit

const int LVL1BS::L1CaloSubBlock::s_slices2Bit = 3

staticprivate

Definition at line 176 of file L1CaloSubBlock.h.

s_slices2Mask

const uint32_t LVL1BS::L1CaloSubBlock::s_slices2Mask = 0x1f

staticprivate

Definition at line 184 of file L1CaloSubBlock.h.

s_statusBit

const int LVL1BS::L1CaloSubBlock::s_statusBit = 28

staticprivate

Definition at line 162 of file L1CaloSubBlock.h.

s_statusMask

const uint32_t LVL1BS::L1CaloSubBlock::s_statusMask = 0x1

staticprivate

Definition at line 164 of file L1CaloSubBlock.h.

s_statusVal

const uint32_t LVL1BS::L1CaloSubBlock::s_statusVal = 0x1

staticprivate

Definition at line 166 of file L1CaloSubBlock.h.

s_upstreamErrorBit

const int LVL1BS::L1CaloSubBlock::s_upstreamErrorBit = 4

staticprivate

Definition at line 190 of file L1CaloSubBlock.h.

s_versionBit

const int LVL1BS::L1CaloSubBlock::s_versionBit = 25

staticprivate

Definition at line 171 of file L1CaloSubBlock.h.

s_versionMask

const uint32_t LVL1BS::L1CaloSubBlock::s_versionMask = 0x7

staticprivate

Definition at line 179 of file L1CaloSubBlock.h.

s_wordIdBit

const int LVL1BS::L1CaloSubBlock::s_wordIdBit = 28

staticprivate

Definition at line 170 of file L1CaloSubBlock.h.

s_wordIdMask

const uint32_t LVL1BS::L1CaloSubBlock::s_wordIdMask = 0xf

staticprivate

Definition at line 178 of file L1CaloSubBlock.h.

---

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

• L1CaloSubBlock.h
• L1CaloSubBlock.cxx