ZdcPpmSubBlock Class Reference

Sub-Block class for PPM data. More...

#include <ZdcPpmSubBlock.h>

Inheritance diagram for ZdcPpmSubBlock:

Collaboration diagram for ZdcPpmSubBlock:

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
	ZdcPpmSubBlock ()
	~ZdcPpmSubBlock ()
void	clear ()
	Clear all data.
void	setPpmHeader (int version, int format, int seqno, int crate, int module, int slicesFadc, int slicesLut)
	Store PPM header.
void	setPpmErrorHeader (int version, int format, int crate, int module, int slicesFadc, int slicesLut)
	Store PPM error block header.
int	slicesFadc () const
int	slicesLut () const
void	fillPpmData (int chan, const std::vector< int > &lut, const std::vector< int > &fadc, const std::vector< int > &bcidLut, const std::vector< int > &bcidFadc)
	Store PPM data for later packing.
void	ppmData (int chan, std::vector< int > &lut, std::vector< int > &fadc, std::vector< int > &bcidLut, std::vector< int > &bcidFadc) const
	Return unpacked data for given channel.
void	fillPpmError (int chan, int errorWord)
	Store an error word corresponding to a data channel.
void	fillPpmPinError (int pin, int errorWord)
	Store an error word corresponding to a G-Link pin.
int	ppmError (int chan) const
	Return the error word for a data channel.
int	ppmPinError (int pin) const
	Return the error word for a G-Link pin.
bool	glinkPinParity (int chan) const
bool	fpgaCorrupt (int chan) const
bool	bunchMismatch (int chan) const
bool	eventMismatch (int chan) const
bool	asicFull (int chan) const
bool	timeout (int chan) const
bool	mcmAbsent (int chan) const
bool	channelDisabled (int chan) const
bool	channelDisabledA (int pin) const
bool	channelDisabledB (int pin) const
bool	channelDisabledC (int pin) const
bool	channelDisabledD (int pin) const
bool	glinkPinParity () const
bool	fpgaCorrupt () const
bool	bunchMismatch () const
bool	eventMismatch () const
bool	asicFull () const
bool	timeout () const
bool	mcmAbsent () const
bool	channelDisabledA () const
bool	channelDisabledB () const
bool	channelDisabledC () const
bool	channelDisabledD () const
void	setLutOffset (int offset)
void	setFadcOffset (int offset)
void	setPedestal (int pedval)
void	setFadcBaseline (int baseline)
void	setFadcThreshold (int threshold)
void	setRunNumber (int run)
int	lutOffset () const
int	fadcOffset () const
int	pedestal () const
int	fadcBaseline () const
int	fadcThreshold () const
int	runNumber () const
int	getPpmChannel (const int channel) const
bool	pack ()
	Pack data.
bool	unpack ()
	Unpack data.
int	channelsPerSubBlock () const
void	setCompStats (const std::vector< uint32_t > &stats)
	Set compression stats.
const std::vector< uint32_t > &	compStats () const
	Return reference to compression stats.
int	dataWords () const
	Return number of data words.
void	setHeader (int wordId, int version, int format, int seqno, int crate, int module, int slices2, int slices1)
	Store header data.
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.
void	setBunchCrossing (int bc)
	Set the Bunch Crossing number (neutral format only)
int	bunchCrossing () const
	Return the Bunch Crossing number (neutral format only)
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.
void	write (FullEventAssembler< ZdcSrcIdMap >::RODDATA *theROD) const
	Output complete packed sub-block to ROD vector.
void	setStatus (uint32_t failingBCN, bool glinkTimeout, bool glinkDown, bool upstreamError, bool daqOverflow, bool bcnMismatch, bool glinkProtocol, bool glinkParity)
	Store error status trailer.
void	setDaqOverflow (int bit=1)
	Set DAQ FIFO Overflow bit in Sub-status word.
void	setGlinkParity (int bit=1)
	Set G-Link Parity bit in Sub-status word.
void	setUnpackErrorCode (int code)
	Set the unpacking error code.
int	unpackErrorCode () const
	Return the unpacking error code.
std::string	unpackErrorMsg () const
	Return the unpacking error message for printing.
void	packer (uint32_t datum, int nbits)
	Pack given data into given number of bits.
void	packerFlush ()
	Flush the current data word padded with zeros.
void	setStreamed ()
	Set continuous bit streaming for compressed formats.
uint32_t	unpacker (int nbits)
	Unpack given number of bits of data.
void	unpackerInit ()
	Initialise unpacker.
bool	unpackerSuccess () const
	Return unpacker success flag.
void	packerNeutral (int pin, uint32_t datum, int nbits)
	Pack given neutral data from given pin.
void	packerNeutralParity (int pin)
	Pack current G-Link parity bit for given pin.
uint32_t	unpackerNeutral (int pin, int nbits)
	Unpack given number of bits of neutral data for given pin.
bool	unpackerNeutralParityError (int pin)
	Unpack and test G-Link parity bit for given pin.

Static Public Member Functions
static int	channelsPerSubBlock (int version, int format)
	Return the number of channels per sub-block.
static bool	errorBlock (uint32_t word)
	Check if a header word is for an error block.
static int	wordId (uint32_t word)
	Return wordID field from given header word.
static int	format (uint32_t word)
	Return data format from given header word.
static int	seqno (uint32_t word)
	Return seqno field from given header word.
static int	module (uint32_t word)
	Return module field from given header word.
static SubBlockWordType	wordType (uint32_t word)
	Word identification.
static int	minBits (uint32_t datum)
	Return the minimum number of bits needed for given data.
static int	parityBit (int init, uint32_t datum, int nbits)
	Return the parity bit for given data.

Private Member Functions
int	asic (int chan) const
	Return the ASIC channel corresponding to a data channel.
int	pin (int chan) const
	Return the G-Link pin corresponding to a data channel.
bool	errorBit (int pin, int bit) const
	Error bit extraction.
bool	errorBit (int bit) const
	Global error bit extraction.
bool	packNeutral ()
	Pack neutral data.
bool	packUncompressedData ()
	Pack uncompressed data.
bool	packUncompressedErrors ()
	Pack uncompressed error data.
bool	unpackNeutral ()
	Unpack neutral data.
bool	unpackUncompressedData ()
	Unpack uncompressed data.
bool	unpackUncompressedErrors ()
	Unpack uncompressed error data.

Private Attributes
uint32_t	m_globalError
int	m_lutOffset
int	m_fadcOffset
int	m_pedestal
int	m_fadcBaseline
int	m_fadcThreshold
int	m_runNumber
std::vector< uint32_t >	m_compStats
	Vector for compression statistics.
std::vector< uint32_t >	m_datamap
	Vector for intermediate data.
std::vector< uint32_t >	m_errormap
	Vector for intermediate error data.
uint32_t	m_header {}
	Sub-Block Header.
uint32_t	m_trailer {}
	Sub-Block Status Trailer.
int	m_bunchCrossing {}
	Bunch Crossing number (neutral format only)
int	m_unpackError {}
	Unpacking error code.
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.
std::vector< uint32_t >	m_data
	Sub-Block data.

Static Private Attributes
static const uint32_t	s_wordIdVal = 0xc
	Sub-Block class for PPM data.
static const int	s_errorMarker = 63
static const int	s_wordLen = 16
static const int	s_lutBit = 0
static const int	s_bcidLutBit = 8
static const int	s_fadcBit = 1
static const int	s_bcidFadcBit = 0
static const uint32_t	s_lutMask = 0xff
static const uint32_t	s_bcidLutMask = 0x7
static const uint32_t	s_fadcMask = 0x3ff
static const uint32_t	s_bcidFadcMask = 0x1
static const int	s_channels = 64
static const int	s_glinkPins = 16
static const int	s_asicChannels = 4
static const int	s_dataBits = 11
static const int	s_errorBits = 10
static const int	s_bunchCrossingBits = 12
static const uint32_t	s_errorMask = 0x7ff
static const int	s_glinkPinParityBit = 10
static const int	s_fpgaCorruptBit = 9
static const int	s_bunchMismatchBit = 8
static const int	s_eventMismatchBit = 7
static const int	s_asicFullBit = 6
static const int	s_timeoutBit = 5
static const int	s_mcmAbsentBit = 4
static const int	s_channelDisabledBit = 0
static const int	s_ppmChannel []
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.
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

Sub-Block class for PPM data.

Author

Peter Faulkner

This may be link to the equivalent in LVL1 code, TRY_LINK_LVL1 Marco Leite

Definition at line 30 of file ZdcPpmSubBlock.h.

Member Enumeration Documentation

DataFormats

enum ZdcSubBlock::DataFormats

inherited

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

inherited

Enumerator
HEADER
DATA
STATUS

Definition at line 37 of file ZdcSubBlock.h.

                         { HEADER,
                            DATA,
                            STATUS };

UnpackErrorType

enum ZdcSubBlock::UnpackErrorType

inherited

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

ZdcPpmSubBlock()

ZdcPpmSubBlock::ZdcPpmSubBlock

(

)

Definition at line 58 of file ZdcPpmSubBlock.cxx.

                               :
        m_globalError(0),
        m_lutOffset(-1),
        m_fadcOffset(-1),
        m_pedestal(10),
        m_fadcBaseline(0),
        m_fadcThreshold(0),
        m_runNumber(0)
{
}

~ZdcPpmSubBlock()

ZdcPpmSubBlock::~ZdcPpmSubBlock

(

)

Definition at line 69 of file ZdcPpmSubBlock.cxx.

{
}

Member Function Documentation

asic()

int ZdcPpmSubBlock::asic ( int chan ) const

inlineprivate

Return the ASIC channel corresponding to a data channel.

Definition at line 399 of file ZdcPpmSubBlock.h.

{
  return chan / s_glinkPins;
}

asicFull() [1/2]

bool ZdcPpmSubBlock::asicFull ( ) const

inline

Definition at line 294 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_asicFullBit);
}

asicFull() [2/2]

bool ZdcPpmSubBlock::asicFull ( int chan ) const

inline

Definition at line 234 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin(chan), s_asicFullBit);
}

bcnMismatch()

bool ZdcSubBlock::bcnMismatch ( ) const

inlineinherited

Definition at line 310 of file ZdcSubBlock.h.

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

bunchCrossing()

int ZdcSubBlock::bunchCrossing ( ) const

inlineinherited

Return the Bunch Crossing number (neutral format only)

Definition at line 335 of file ZdcSubBlock.h.

{
  return m_bunchCrossing;
}

bunchMismatch() [1/2]

bool ZdcPpmSubBlock::bunchMismatch ( ) const

inline

Definition at line 284 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_bunchMismatchBit);
}

bunchMismatch() [2/2]

bool ZdcPpmSubBlock::bunchMismatch ( int chan ) const

inline

Definition at line 224 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin(chan), s_bunchMismatchBit);
}

channelDisabled()

bool ZdcPpmSubBlock::channelDisabled ( int chan ) const

inline

Definition at line 249 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin(chan), s_channelDisabledBit + asic(chan));
}

channelDisabledA() [1/2]

bool ZdcPpmSubBlock::channelDisabledA ( ) const

inline

Definition at line 309 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_channelDisabledBit);
}

channelDisabledA() [2/2]

bool ZdcPpmSubBlock::channelDisabledA ( int pin ) const

inline

Definition at line 254 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin, s_channelDisabledBit);
}

channelDisabledB() [1/2]

bool ZdcPpmSubBlock::channelDisabledB ( ) const

inline

Definition at line 314 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_channelDisabledBit + 1);
}

channelDisabledB() [2/2]

bool ZdcPpmSubBlock::channelDisabledB ( int pin ) const

inline

Definition at line 259 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin, s_channelDisabledBit + 1);
}

channelDisabledC() [1/2]

bool ZdcPpmSubBlock::channelDisabledC ( ) const

inline

Definition at line 319 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_channelDisabledBit + 2);
}

channelDisabledC() [2/2]

bool ZdcPpmSubBlock::channelDisabledC ( int pin ) const

inline

Definition at line 264 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin, s_channelDisabledBit + 2);
}

channelDisabledD() [1/2]

bool ZdcPpmSubBlock::channelDisabledD ( ) const

inline

Definition at line 324 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_channelDisabledBit + 3);
}

channelDisabledD() [2/2]

bool ZdcPpmSubBlock::channelDisabledD ( int pin ) const

inline

Definition at line 269 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin, s_channelDisabledBit + 3);
}

channelsPerSubBlock() [1/2]

int ZdcPpmSubBlock::channelsPerSubBlock

(

)

const

Definition at line 488 of file ZdcPpmSubBlock.cxx.

{
  return channelsPerSubBlock(version(), format());
}

channelsPerSubBlock() [2/2]

int ZdcPpmSubBlock::channelsPerSubBlock ( int version, int format )

static

Return the number of channels per sub-block.

Definition at line 464 of file ZdcPpmSubBlock.cxx.

{
  int chan = 0;
  switch (version) {
    case 1:
      switch (format) {
        case UNCOMPRESSED:
      chan = s_channels/s_asicChannels;
      break;
        case NEUTRAL:
        case COMPRESSED:
        case SUPERCOMPRESSED:
      chan = s_channels;
      break;
        default:
      break;
      }
      break;
    default:
      break;
  }
  return chan;
}

clear()

void ZdcPpmSubBlock::clear

(

)

Clear all data.

Definition at line 75 of file ZdcPpmSubBlock.cxx.

{
  ZdcSubBlock::clear();
  m_globalError   = 0;
  m_lutOffset     = -1;
  m_fadcOffset    = -1;
  m_datamap.clear();
  m_errormap.clear();
}

compStats()

const std::vector< uint32_t > & ZdcPpmSubBlock::compStats ( ) const

inline

Return reference to compression stats.

Definition at line 389 of file ZdcPpmSubBlock.h.

{
  return m_compStats;
}

crate()

int ZdcSubBlock::crate ( ) const

inlineinherited

Definition at line 265 of file ZdcSubBlock.h.

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

daqOverflow()

bool ZdcSubBlock::daqOverflow ( ) const

inlineinherited

Definition at line 305 of file ZdcSubBlock.h.

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

dataWords()

int ZdcSubBlock::dataWords ( ) const

inlineinherited

Return number of data words.

Definition at line 235 of file ZdcSubBlock.h.

{
  return m_dataWords;
}

errorBit() [1/2]

bool ZdcPpmSubBlock::errorBit ( int bit ) const

private

Global error bit extraction.

Definition at line 255 of file ZdcPpmSubBlock.cxx.

{
  return m_globalError & (0x1 << bit);
}

errorBit() [2/2]

bool ZdcPpmSubBlock::errorBit ( int pin, int bit ) const

inlineprivate

Error bit extraction.

Definition at line 409 of file ZdcPpmSubBlock.h.

{
  return m_errormap[pin] & (0x1 << bit);
}

errorBlock()

bool ZdcPpmSubBlock::errorBlock ( uint32_t word )

static

Check if a header word is for an error block.

Definition at line 495 of file ZdcPpmSubBlock.cxx.

{
  bool rc = false;
  if (format(word) == UNCOMPRESSED &&
       seqno(word) == s_errorMarker) rc = true;
  return rc;
}

eventMismatch() [1/2]

bool ZdcPpmSubBlock::eventMismatch ( ) const

inline

Definition at line 289 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_eventMismatchBit);
}

eventMismatch() [2/2]

bool ZdcPpmSubBlock::eventMismatch ( int chan ) const

inline

Definition at line 229 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin(chan), s_eventMismatchBit);
}

fadcBaseline()

int ZdcPpmSubBlock::fadcBaseline ( ) const

inline

Definition at line 374 of file ZdcPpmSubBlock.h.

{
  return m_fadcBaseline;
}

fadcOffset()

int ZdcPpmSubBlock::fadcOffset ( ) const

inline

Definition at line 364 of file ZdcPpmSubBlock.h.

{
  return (m_fadcOffset < 0) ? slicesFadc()/2 : m_fadcOffset;
}

fadcThreshold()

int ZdcPpmSubBlock::fadcThreshold ( ) const

inline

Definition at line 379 of file ZdcPpmSubBlock.h.

{
  return m_fadcThreshold;
}

failingBCN()

uint32_t ZdcSubBlock::failingBCN ( ) const

inlineinherited

Definition at line 285 of file ZdcSubBlock.h.

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

fillPpmData()

void ZdcPpmSubBlock::fillPpmData	(	int	chan,
		const std::vector< int > &	lut,
		const std::vector< int > &	fadc,
		const std::vector< int > &	bcidLut,
		const std::vector< int > &	bcidFadc )

Store PPM data for later packing.

Definition at line 129 of file ZdcPpmSubBlock.cxx.

{
  const int sliceL = slicesLut();
  const int sliceF = slicesFadc();
  const int slices = sliceL + sliceF;
  const int chanPerSubBlock = channelsPerSubBlock();
  if (chanPerSubBlock == 0) {
    setUnpackErrorCode(ZdcSubBlock::UNPACK_FORMAT);
    m_datamap.clear();
    return;
  }
  int dataSize = m_datamap.size();
  if (dataSize == 0) {
    dataSize = slices * chanPerSubBlock;
    m_datamap.resize(dataSize);
  }
  int offset = (chan % chanPerSubBlock) * slices;
  if (offset + slices <= dataSize) {
    for (int pos = 0; pos < sliceL; ++pos) {
      uint32_t datum = (lut[pos] & s_lutMask) << s_lutBit;
      datum |= (bcidLut[pos] & s_bcidLutMask) << s_bcidLutBit;
      m_datamap[offset + pos] = datum;
    }
    offset += sliceL;
    for (int pos = 0; pos < sliceF; ++pos) {
      const int adc = (fadc[pos] > 0) ? fadc[pos] : 0;
      uint32_t datum = (adc & s_fadcMask) << s_fadcBit;
      datum |= (bcidFadc[pos] & s_bcidFadcMask) << s_bcidFadcBit;
      m_datamap[offset + pos] = datum;
    }
  }
}

fillPpmError()

void ZdcPpmSubBlock::fillPpmError	(	int	chan,
		int	errorWord )

Store an error word corresponding to a data channel.

Definition at line 207 of file ZdcPpmSubBlock.cxx.

{
  if (m_errormap.empty()) m_errormap.resize(s_glinkPins);
  // Expand one ASIC channel disabled bit to four
  const uint32_t chanDisabled = (errorWord & 0x1) << asic(chan);
  uint32_t word = (((errorWord >> 1) << s_asicChannels)
                   | chanDisabled) & s_errorMask;
  m_errormap[pin(chan)] |= word;
  m_globalError |= word;
}

fillPpmPinError()

void ZdcPpmSubBlock::fillPpmPinError	(	int	pin,
		int	errorWord )

Store an error word corresponding to a G-Link pin.

Definition at line 220 of file ZdcPpmSubBlock.cxx.

{
  if (m_errormap.empty()) m_errormap.resize(s_glinkPins);
  m_errormap[pin] = errorWord & s_errorMask;
  m_globalError = 0;
  for (uint32_t word : m_errormap) {
    m_globalError |= word;
  }
}

format() [1/2]

int ZdcSubBlock::format ( ) const

inlineinherited

Definition at line 250 of file ZdcSubBlock.h.

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

format() [2/2]

int ZdcSubBlock::format ( uint32_t word )

staticinherited

Return data format from given header word.

Definition at line 441 of file ZdcSubBlock.cxx.

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

fpgaCorrupt() [1/2]

bool ZdcPpmSubBlock::fpgaCorrupt ( ) const

inline

Definition at line 279 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_fpgaCorruptBit);
}

fpgaCorrupt() [2/2]

bool ZdcPpmSubBlock::fpgaCorrupt ( int chan ) const

inline

Definition at line 219 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin(chan), s_fpgaCorruptBit);
}

getPpmChannel()

int ZdcPpmSubBlock::getPpmChannel ( const int channel ) const

inline

Definition at line 415 of file ZdcPpmSubBlock.h.

{
    return s_ppmChannel[channel];
}

glinkDown()

bool ZdcSubBlock::glinkDown ( ) const

inlineinherited

Definition at line 295 of file ZdcSubBlock.h.

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

glinkParity()

bool ZdcSubBlock::glinkParity ( ) const

inlineinherited

Definition at line 320 of file ZdcSubBlock.h.

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

glinkPinParity() [1/2]

bool ZdcPpmSubBlock::glinkPinParity ( ) const

inline

Definition at line 274 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_glinkPinParityBit);
}

glinkPinParity() [2/2]

bool ZdcPpmSubBlock::glinkPinParity ( int chan ) const

inline

Definition at line 214 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin(chan), s_glinkPinParityBit);
}

glinkProtocol()

bool ZdcSubBlock::glinkProtocol ( ) const

inlineinherited

Definition at line 315 of file ZdcSubBlock.h.

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

glinkTimeout()

bool ZdcSubBlock::glinkTimeout ( ) const

inlineinherited

Definition at line 290 of file ZdcSubBlock.h.

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

lutOffset()

int ZdcPpmSubBlock::lutOffset ( ) const

inline

Definition at line 359 of file ZdcPpmSubBlock.h.

{
  return (m_lutOffset < 0) ? slicesLut()/2 : m_lutOffset;
}

mcmAbsent() [1/2]

bool ZdcPpmSubBlock::mcmAbsent ( ) const

inline

Definition at line 304 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_mcmAbsentBit);
}

mcmAbsent() [2/2]

bool ZdcPpmSubBlock::mcmAbsent ( int chan ) const

inline

Definition at line 244 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin(chan), s_mcmAbsentBit);
}

minBits()

int ZdcSubBlock::minBits ( uint32_t datum )

staticinherited

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

inlineinherited

Definition at line 270 of file ZdcSubBlock.h.

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

module() [2/2]

int ZdcSubBlock::module ( uint32_t word )

staticinherited

Return module field from given header word.

Definition at line 455 of file ZdcSubBlock.cxx.

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

pack()

bool ZdcPpmSubBlock::pack

(

)

Pack data.

Definition at line 262 of file ZdcPpmSubBlock.cxx.

{
  bool rc = false;
  switch (version()) {
    case 1:
      switch (format()) {
        case NEUTRAL:
      rc = packNeutral();
      break;
        case UNCOMPRESSED:
      switch (seqno()) {
        case s_errorMarker:
          rc = packUncompressedErrors();
          break;
            default:
          rc = packUncompressedData();
          break;
          }
      break;
        case COMPRESSED:
        case SUPERCOMPRESSED:
      rc = ZdcPpmCompression::pack(*this);
      break;
        default:
      break;
      }
      break;
    default:
      break;
  }
  return rc;
}

packer()

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

inherited

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 ( )

inherited

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 )

inherited

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 )

inherited

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;
  }
}

packNeutral()

bool ZdcPpmSubBlock::packNeutral ( )

private

Pack neutral data.

Definition at line 332 of file ZdcPpmSubBlock.cxx.

{
  const int slices   = slicesLut() + slicesFadc();
  const int channels = channelsPerSubBlock();
  if (m_datamap.empty()) m_datamap.resize(slices * channels);
  // Bunch crossing number
  for (int pin = 0; pin < s_glinkPins; ++pin) {
    uint32_t bc = 0;
    if (pin < s_bunchCrossingBits) bc = (bunchCrossing() >> pin) & 0x1;
    packerNeutral(pin, bc, 1);
  }
  // Data
  std::vector<uint32_t>::const_iterator pos = m_datamap.begin();
  for (int asic = 0; asic < s_asicChannels; ++asic) {
    for (int pin = 0; pin < s_glinkPins; ++pin) {
      for (int sl = 0; sl < slices; ++sl) {
        packerNeutral(pin, *pos, s_dataBits);
    ++pos;
      }
    }
  }
  // Errors, including GP
  if (m_errormap.empty()) m_errormap.resize(s_glinkPins);
  pos = m_errormap.begin();
  for (int pin = 0; pin < s_glinkPins; ++pin) {
    packerNeutral(pin, *pos, s_errorBits);
    packerNeutralParity(pin);
    ++pos;
  }
  return true;
}

packUncompressedData()

bool ZdcPpmSubBlock::packUncompressedData ( )

private

Pack uncompressed data.

Definition at line 366 of file ZdcPpmSubBlock.cxx.

{
  const int slices   = slicesLut() + slicesFadc();
  const int channels = channelsPerSubBlock();
  if (m_datamap.empty()) m_datamap.resize(slices * channels);
  for (int sl = 0; sl < slices; ++sl) {
    for (int chan = 0; chan < channels; ++chan) {
      packer(m_datamap[sl + chan*slices], s_wordLen);
    }
  }
  packerFlush();
  return true;
}

packUncompressedErrors()

bool ZdcPpmSubBlock::packUncompressedErrors ( )

private

Pack uncompressed error data.

Definition at line 382 of file ZdcPpmSubBlock.cxx.

{
  if (m_errormap.empty()) m_errormap.resize(s_glinkPins);
  for (int pin = 0; pin < s_glinkPins; ++pin) {
    packer(m_errormap[pin], s_wordLen);
  }
  packerFlush();
  return true;
}

parityBit()

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

staticinherited

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;
}

pedestal()

int ZdcPpmSubBlock::pedestal ( ) const

inline

Definition at line 369 of file ZdcPpmSubBlock.h.

{
  return m_pedestal;
}

pin()

int ZdcPpmSubBlock::pin ( int chan ) const

inlineprivate

Return the G-Link pin corresponding to a data channel.

Definition at line 404 of file ZdcPpmSubBlock.h.

{
  return chan % s_glinkPins;
}

ppmData()

void ZdcPpmSubBlock::ppmData	(	int	chan,
		std::vector< int > &	lut,
		std::vector< int > &	fadc,
		std::vector< int > &	bcidLut,
		std::vector< int > &	bcidFadc ) const

Return unpacked data for given channel.

Definition at line 167 of file ZdcPpmSubBlock.cxx.

{
  lut.clear();
  fadc.clear();
  bcidLut.clear();
  bcidFadc.clear();
  const int sliceL = slicesLut();
  const int sliceF = slicesFadc();
  const int chans = channelsPerSubBlock();
  if (chans == 0) {
    return;
  }
  int beg = (chan % chans) * (sliceL + sliceF);
  int end = beg + sliceL;
  if (size_t(end + sliceF) <= m_datamap.size()) {
    for (int pos = beg; pos < end; ++pos) {
      const uint32_t word = m_datamap[pos];
      lut.push_back((word >> s_lutBit) & s_lutMask);
      bcidLut.push_back((word >> s_bcidLutBit) & s_bcidLutMask);
    }
    beg += sliceL;
    end += sliceF;
    for (int pos = beg; pos < end; ++pos) {
      const uint32_t word = m_datamap[pos];
      fadc.push_back((word >> s_fadcBit) & s_fadcMask);
      bcidFadc.push_back((word >> s_bcidFadcBit) & s_bcidFadcMask);
    }
  } else {
    lut.resize(sliceL);
    fadc.resize(sliceF);
    bcidLut.resize(sliceL);
    bcidFadc.resize(sliceF);
  }
}

ppmError()

int ZdcPpmSubBlock::ppmError

(

int

chan

)

const

Return the error word for a data channel.

Definition at line 232 of file ZdcPpmSubBlock.cxx.

{
  int err = 0;
  if ( !m_errormap.empty()) {
    // Replace the four ASIC channel disabled bits with just the one
    // corresponding to the data channel
    err = (((m_errormap[pin(chan)] & s_errorMask) >> s_asicChannels) << 1)
                                                  | channelDisabled(chan);
  }
  return err;
}

ppmPinError()

int ZdcPpmSubBlock::ppmPinError

(

int

pin

)

const

Return the error word for a G-Link pin.

Definition at line 246 of file ZdcPpmSubBlock.cxx.

{
  int err = 0;
  if ( !m_errormap.empty()) err = m_errormap[pin] & s_errorMask;
  return err;
}

read()

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

inherited

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;
}

runNumber()

int ZdcPpmSubBlock::runNumber ( ) const

inline

Definition at line 384 of file ZdcPpmSubBlock.h.

{
  return m_runNumber;
}

seqno() [1/2]

int ZdcSubBlock::seqno ( ) const

inlineinherited

Definition at line 255 of file ZdcSubBlock.h.

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

seqno() [2/2]

int ZdcSubBlock::seqno ( uint32_t word )

staticinherited

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 )

inlineinherited

Set the Bunch Crossing number (neutral format only)

Definition at line 330 of file ZdcSubBlock.h.

{
  if (bc) m_bunchCrossing = bc;
}

setCompStats()

void ZdcPpmSubBlock::setCompStats ( const std::vector< uint32_t > & stats )

inline

Set compression stats.

Definition at line 394 of file ZdcPpmSubBlock.h.

{
  m_compStats = stats;
}

setDaqOverflow()

void ZdcSubBlock::setDaqOverflow ( int bit = 1 )

inherited

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);
  }
}

setFadcBaseline()

void ZdcPpmSubBlock::setFadcBaseline ( int baseline )

inline

Definition at line 344 of file ZdcPpmSubBlock.h.

{
  m_fadcBaseline = baseline;
}

setFadcOffset()

void ZdcPpmSubBlock::setFadcOffset ( int offset )

inline

Definition at line 334 of file ZdcPpmSubBlock.h.

{
  m_fadcOffset = offset;
}

setFadcThreshold()

void ZdcPpmSubBlock::setFadcThreshold ( int threshold )

inline

Definition at line 349 of file ZdcPpmSubBlock.h.

{
  m_fadcThreshold = threshold;
}

setGlinkParity()

void ZdcSubBlock::setGlinkParity ( int bit = 1 )

inherited

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 )

inherited

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;
}

setLutOffset()

void ZdcPpmSubBlock::setLutOffset ( int offset )

inline

Definition at line 329 of file ZdcPpmSubBlock.h.

{
  m_lutOffset = offset;
}

setPedestal()

void ZdcPpmSubBlock::setPedestal ( int pedval )

inline

Definition at line 339 of file ZdcPpmSubBlock.h.

{
  m_pedestal = pedval;
}

setPpmErrorHeader()

void ZdcPpmSubBlock::setPpmErrorHeader	(	int	version,
		int	format,
		int	crate,
		int	module,
		int	slicesFadc,
		int	slicesLut )

Store PPM error block header.

Definition at line 98 of file ZdcPpmSubBlock.cxx.

{
  setHeader(s_wordIdVal, version, format, s_errorMarker, crate, module,
                                                 slicesFadc, slicesLut);
}

setPpmHeader()

void ZdcPpmSubBlock::setPpmHeader	(	int	version,
		int	format,
		int	seqno,
		int	crate,
		int	module,
		int	slicesFadc,
		int	slicesLut )

Store PPM header.

Definition at line 87 of file ZdcPpmSubBlock.cxx.

{
  setHeader(s_wordIdVal, version, format, seqno, crate, module,
                                                 slicesFadc, slicesLut);
}

setRunNumber()

void ZdcPpmSubBlock::setRunNumber ( int run )

inline

Definition at line 354 of file ZdcPpmSubBlock.h.

{
  m_runNumber = run;
}

setStatus()

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

inherited

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 ( )

inlineinherited

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 )

inlineinherited

Set the unpacking error code.

Definition at line 340 of file ZdcSubBlock.h.

{
  m_unpackError = code;
}

slice()

int ZdcSubBlock::slice ( ) const

inlineinherited

Definition at line 260 of file ZdcSubBlock.h.

{
  return seqno();
}

slices1()

int ZdcSubBlock::slices1 ( ) const

inlineinherited

Definition at line 280 of file ZdcSubBlock.h.

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

slices2()

int ZdcSubBlock::slices2 ( ) const

inlineinherited

Definition at line 275 of file ZdcSubBlock.h.

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

slicesFadc()

int ZdcPpmSubBlock::slicesFadc

(

)

const

Definition at line 108 of file ZdcPpmSubBlock.cxx.

{
  int slices = slices2();
  if (slices == 0 && format() == NEUTRAL) {
    slices = dataWords()/(s_asicChannels*s_dataBits) - slicesLut();
  }
  if (slices <= 0) slices = 1;
  return slices;
}

slicesLut()

int ZdcPpmSubBlock::slicesLut

(

)

const

Definition at line 120 of file ZdcPpmSubBlock.cxx.

{
  int slices = slices1();
  if (slices == 0) slices = 1;
  return slices;
}

subStatus()

uint32_t ZdcSubBlock::subStatus ( ) const

inlineinherited

Return Sub-status word.

Definition at line 325 of file ZdcSubBlock.h.

{
  return m_trailer;
}

timeout() [1/2]

bool ZdcPpmSubBlock::timeout ( ) const

inline

Definition at line 299 of file ZdcPpmSubBlock.h.

{
  return errorBit(s_timeoutBit);
}

timeout() [2/2]

bool ZdcPpmSubBlock::timeout ( int chan ) const

inline

Definition at line 239 of file ZdcPpmSubBlock.h.

{
  return errorBit(pin(chan), s_timeoutBit);
}

unpack()

bool ZdcPpmSubBlock::unpack

(

)

Unpack data.

Definition at line 295 of file ZdcPpmSubBlock.cxx.

{
  bool rc = false;
  switch (version()) {
    case 1:
      switch (format()) {
        case NEUTRAL:
      rc = unpackNeutral();
      break;
        case UNCOMPRESSED:
      switch (seqno()) {
        case s_errorMarker:
          rc = unpackUncompressedErrors();
          break;
            default:
          rc = unpackUncompressedData();
          break;
          }
      break;
        case COMPRESSED:
        case SUPERCOMPRESSED:
      rc = ZdcPpmCompression::unpack(*this);
      break;
        default:
      setUnpackErrorCode(ZdcSubBlock::UNPACK_FORMAT);
      break;
      }
      break;
    default:
      setUnpackErrorCode(ZdcSubBlock::UNPACK_VERSION);
      break;
  }
  return rc;
}

unpacker()

uint32_t ZdcSubBlock::unpacker ( int nbits )

inherited

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 ( )

inherited

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 )

inherited

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 )

inherited

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

inlineinherited

Return the unpacking error code.

Definition at line 345 of file ZdcSubBlock.h.

{
  return m_unpackError;
}

unpackErrorMsg()

std::string ZdcSubBlock::unpackErrorMsg ( ) const

inherited

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

inlineinherited

Return unpacker success flag.

Definition at line 356 of file ZdcSubBlock.h.

{
  return m_unpackerFlag;
}

unpackNeutral()

bool ZdcPpmSubBlock::unpackNeutral ( )

private

Unpack neutral data.

Definition at line 394 of file ZdcPpmSubBlock.cxx.

{
  const int slices = slicesLut() + slicesFadc();
  m_datamap.clear();
  // Bunch Crossing number
  int bunchCrossing = 0;
  for (int pin = 0; pin < s_glinkPins; ++pin) {
    const int bc = unpackerNeutral(pin, 1);
    if (pin < s_bunchCrossingBits) bunchCrossing |= bc << pin;
  }
  setBunchCrossing(bunchCrossing);
  // Data
  for (int asic = 0; asic < s_asicChannels; ++asic) {
    for (int pin = 0; pin < s_glinkPins; ++pin) {
      for (int sl = 0; sl < slices; ++sl) {
        m_datamap.push_back(unpackerNeutral(pin, s_dataBits));
      }
    }
  }
  const bool rc = unpackerSuccess();
  if (!rc) setUnpackErrorCode(ZdcSubBlock::UNPACK_DATA_TRUNCATED);
  // Errors
  m_errormap.clear();
  m_globalError = 0;
  for (int pin = 0; pin < s_glinkPins; ++pin) {
    uint32_t error = unpackerNeutral(pin, s_errorBits);
    error |= unpackerNeutralParityError(pin) << s_errorBits;
    m_errormap.push_back(error);
    m_globalError |= error;
  }
  return rc;
}

unpackUncompressedData()

bool ZdcPpmSubBlock::unpackUncompressedData ( )

private

Unpack uncompressed data.

Definition at line 429 of file ZdcPpmSubBlock.cxx.

{
  const int slices = slicesLut() + slicesFadc();
  const int channels = channelsPerSubBlock();
  m_datamap.resize(slices * channels);
  unpackerInit();
  for (int sl = 0; sl < slices; ++sl) {
    for (int chan = 0; chan < channels; ++chan) {
      m_datamap[sl + chan*slices] = unpacker(s_wordLen);
    }
  }
  const bool rc = unpackerSuccess();
  if (!rc) setUnpackErrorCode(ZdcSubBlock::UNPACK_DATA_TRUNCATED);
  return rc;
}

unpackUncompressedErrors()

bool ZdcPpmSubBlock::unpackUncompressedErrors ( )

private

Unpack uncompressed error data.

Definition at line 447 of file ZdcPpmSubBlock.cxx.

{
  unpackerInit();
  m_errormap.clear();
  m_globalError = 0;
  for (int pin = 0; pin < s_glinkPins; ++pin) {
    uint32_t word = unpacker(s_wordLen);
    m_errormap.push_back(word);
    m_globalError |= word;
  }
  const bool rc = unpackerSuccess();
  if (!rc) setUnpackErrorCode(ZdcSubBlock::UNPACK_DATA_TRUNCATED);
  return rc;
}

upstreamError()

bool ZdcSubBlock::upstreamError ( ) const

inlineinherited

Definition at line 300 of file ZdcSubBlock.h.

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

version()

int ZdcSubBlock::version ( ) const

inlineinherited

Definition at line 245 of file ZdcSubBlock.h.

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

wordId() [1/2]

int ZdcSubBlock::wordId ( ) const

inlineinherited

Definition at line 240 of file ZdcSubBlock.h.

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

wordId() [2/2]

int ZdcSubBlock::wordId ( uint32_t word )

staticinherited

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 )

staticinherited

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

inherited

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 {}

privateinherited

Definition at line 218 of file ZdcSubBlock.h.

{};

m_bunchCrossing

int ZdcSubBlock::m_bunchCrossing {}

privateinherited

Bunch Crossing number (neutral format only)

Definition at line 214 of file ZdcSubBlock.h.

{};

m_compStats

std::vector<uint32_t> ZdcPpmSubBlock::m_compStats

private

Vector for compression statistics.

Definition at line 204 of file ZdcPpmSubBlock.h.

m_currentBit

int ZdcSubBlock::m_currentBit {}

privateinherited

Definition at line 219 of file ZdcSubBlock.h.

{};

m_currentPinBit

std::vector<int> ZdcSubBlock::m_currentPinBit

privateinherited

Definition at line 226 of file ZdcSubBlock.h.

m_data

std::vector<uint32_t> ZdcSubBlock::m_data

privateinherited

Sub-Block data.

Definition at line 231 of file ZdcSubBlock.h.

m_datamap

std::vector<uint32_t> ZdcPpmSubBlock::m_datamap

private

Vector for intermediate data.

Definition at line 207 of file ZdcPpmSubBlock.h.

m_dataPos

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

privateinherited

Definition at line 223 of file ZdcSubBlock.h.

{};

m_dataPosEnd

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

privateinherited

Definition at line 224 of file ZdcSubBlock.h.

{};

m_dataWords

int ZdcSubBlock::m_dataWords {}

privateinherited

Current number of data words.

Definition at line 229 of file ZdcSubBlock.h.

{};

m_errormap

std::vector<uint32_t> ZdcPpmSubBlock::m_errormap

private

Vector for intermediate error data.

Definition at line 210 of file ZdcPpmSubBlock.h.

m_fadcBaseline

int ZdcPpmSubBlock::m_fadcBaseline

private

Definition at line 199 of file ZdcPpmSubBlock.h.

m_fadcOffset

int ZdcPpmSubBlock::m_fadcOffset

private

Definition at line 197 of file ZdcPpmSubBlock.h.

m_fadcThreshold

int ZdcPpmSubBlock::m_fadcThreshold

private

Definition at line 200 of file ZdcPpmSubBlock.h.

m_globalError

uint32_t ZdcPpmSubBlock::m_globalError

private

Definition at line 193 of file ZdcPpmSubBlock.h.

m_header

uint32_t ZdcSubBlock::m_header {}

privateinherited

Sub-Block Header.

Definition at line 210 of file ZdcSubBlock.h.

{};

m_lutOffset

int ZdcPpmSubBlock::m_lutOffset

private

Definition at line 196 of file ZdcPpmSubBlock.h.

m_maxBits

int ZdcSubBlock::m_maxBits {}

privateinherited

Definition at line 220 of file ZdcSubBlock.h.

{};

m_maxMask

uint32_t ZdcSubBlock::m_maxMask {}

privateinherited

Definition at line 221 of file ZdcSubBlock.h.

{};

m_oddParity

std::vector<int> ZdcSubBlock::m_oddParity

privateinherited

Definition at line 227 of file ZdcSubBlock.h.

m_pedestal

int ZdcPpmSubBlock::m_pedestal

private

Definition at line 198 of file ZdcPpmSubBlock.h.

m_runNumber

int ZdcPpmSubBlock::m_runNumber

private

Definition at line 201 of file ZdcPpmSubBlock.h.

m_trailer

uint32_t ZdcSubBlock::m_trailer {}

privateinherited

Sub-Block Status Trailer.

Definition at line 212 of file ZdcSubBlock.h.

{};

m_unpackerFlag

bool ZdcSubBlock::m_unpackerFlag {}

privateinherited

Definition at line 222 of file ZdcSubBlock.h.

{};

m_unpackError

int ZdcSubBlock::m_unpackError {}

privateinherited

Unpacking error code.

Definition at line 216 of file ZdcSubBlock.h.

{};

s_asicChannels

const int ZdcPpmSubBlock::s_asicChannels = 4

staticprivate

Definition at line 150 of file ZdcPpmSubBlock.h.

s_asicFullBit

const int ZdcPpmSubBlock::s_asicFullBit = 6

staticprivate

Definition at line 160 of file ZdcPpmSubBlock.h.

s_bcidFadcBit

const int ZdcPpmSubBlock::s_bcidFadcBit = 0

staticprivate

Definition at line 142 of file ZdcPpmSubBlock.h.

s_bcidFadcMask

const uint32_t ZdcPpmSubBlock::s_bcidFadcMask = 0x1

staticprivate

Definition at line 146 of file ZdcPpmSubBlock.h.

s_bcidLutBit

const int ZdcPpmSubBlock::s_bcidLutBit = 8

staticprivate

Definition at line 140 of file ZdcPpmSubBlock.h.

s_bcidLutMask

const uint32_t ZdcPpmSubBlock::s_bcidLutMask = 0x7

staticprivate

Definition at line 144 of file ZdcPpmSubBlock.h.

s_bcnMismatchBit

const int ZdcSubBlock::s_bcnMismatchBit = 2

staticprivateinherited

Definition at line 196 of file ZdcSubBlock.h.

s_bunchCrossingBits

const int ZdcPpmSubBlock::s_bunchCrossingBits = 12

staticprivate

Definition at line 153 of file ZdcPpmSubBlock.h.

s_bunchMismatchBit

const int ZdcPpmSubBlock::s_bunchMismatchBit = 8

staticprivate

Definition at line 158 of file ZdcPpmSubBlock.h.

s_channelDisabledBit

const int ZdcPpmSubBlock::s_channelDisabledBit = 0

staticprivate

Definition at line 163 of file ZdcPpmSubBlock.h.

s_channels

const int ZdcPpmSubBlock::s_channels = 64

staticprivate

Definition at line 148 of file ZdcPpmSubBlock.h.

s_crateBit

const int ZdcSubBlock::s_crateBit = 12

staticprivateinherited

Definition at line 178 of file ZdcSubBlock.h.

s_crateMask

const uint32_t ZdcSubBlock::s_crateMask = 0xf

staticprivateinherited

Definition at line 186 of file ZdcSubBlock.h.

s_daqOverflowBit

const int ZdcSubBlock::s_daqOverflowBit = 3

staticprivateinherited

Definition at line 195 of file ZdcSubBlock.h.

s_dataBits

const int ZdcPpmSubBlock::s_dataBits = 11

staticprivate

Definition at line 151 of file ZdcPpmSubBlock.h.

s_errorBits

const int ZdcPpmSubBlock::s_errorBits = 10

staticprivate

Definition at line 152 of file ZdcPpmSubBlock.h.

s_errorMarker

const int ZdcPpmSubBlock::s_errorMarker = 63

staticprivate

Definition at line 136 of file ZdcPpmSubBlock.h.

s_errorMask

const uint32_t ZdcPpmSubBlock::s_errorMask = 0x7ff

staticprivate

Definition at line 155 of file ZdcPpmSubBlock.h.

s_eventMismatchBit

const int ZdcPpmSubBlock::s_eventMismatchBit = 7

staticprivate

Definition at line 159 of file ZdcPpmSubBlock.h.

s_fadcBit

const int ZdcPpmSubBlock::s_fadcBit = 1

staticprivate

Definition at line 141 of file ZdcPpmSubBlock.h.

s_fadcMask

const uint32_t ZdcPpmSubBlock::s_fadcMask = 0x3ff

staticprivate

Definition at line 145 of file ZdcPpmSubBlock.h.

s_failingBcnBit

const int ZdcSubBlock::s_failingBcnBit = 22

staticprivateinherited

Definition at line 191 of file ZdcSubBlock.h.

s_failingBcnMask

const uint32_t ZdcSubBlock::s_failingBcnMask = 0x3f

staticprivateinherited

Definition at line 199 of file ZdcSubBlock.h.

s_formatBit

const int ZdcSubBlock::s_formatBit = 22

staticprivateinherited

Definition at line 176 of file ZdcSubBlock.h.

s_formatMask

const uint32_t ZdcSubBlock::s_formatMask = 0x7

staticprivateinherited

Definition at line 184 of file ZdcSubBlock.h.

s_fpgaCorruptBit

const int ZdcPpmSubBlock::s_fpgaCorruptBit = 9

staticprivate

Definition at line 157 of file ZdcPpmSubBlock.h.

s_glinkDavSet

const uint32_t ZdcSubBlock::s_glinkDavSet = 0x400000

staticprivateinherited

Definition at line 207 of file ZdcSubBlock.h.

s_glinkDownBit

const int ZdcSubBlock::s_glinkDownBit = 6

staticprivateinherited

Definition at line 193 of file ZdcSubBlock.h.

s_glinkParityBit

const int ZdcSubBlock::s_glinkParityBit = 0

staticprivateinherited

Definition at line 198 of file ZdcSubBlock.h.

s_glinkPinParityBit

const int ZdcPpmSubBlock::s_glinkPinParityBit = 10

staticprivate

Definition at line 156 of file ZdcPpmSubBlock.h.

s_glinkPins

const int ZdcPpmSubBlock::s_glinkPins = 16

staticprivate

Definition at line 149 of file ZdcPpmSubBlock.h.

s_glinkProtocolBit

const int ZdcSubBlock::s_glinkProtocolBit = 1

staticprivateinherited

Definition at line 197 of file ZdcSubBlock.h.

s_glinkTimeoutBit

const int ZdcSubBlock::s_glinkTimeoutBit = 7

staticprivateinherited

Definition at line 192 of file ZdcSubBlock.h.

s_headerBit

const int ZdcSubBlock::s_headerBit = 30

staticprivateinherited

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

staticprivateinherited

Definition at line 169 of file ZdcSubBlock.h.

s_headerVal

const uint32_t ZdcSubBlock::s_headerVal = 0x3

staticprivateinherited

Definition at line 171 of file ZdcSubBlock.h.

s_lutBit

const int ZdcPpmSubBlock::s_lutBit = 0

staticprivate

Definition at line 139 of file ZdcPpmSubBlock.h.

s_lutMask

const uint32_t ZdcPpmSubBlock::s_lutMask = 0xff

staticprivate

Definition at line 143 of file ZdcPpmSubBlock.h.

s_maxPins

const int ZdcSubBlock::s_maxPins = 20

staticprivateinherited

Definition at line 206 of file ZdcSubBlock.h.

s_maxStreamedBits

const int ZdcSubBlock::s_maxStreamedBits = 31

staticprivateinherited

Definition at line 202 of file ZdcSubBlock.h.

s_maxStreamedMask

const uint32_t ZdcSubBlock::s_maxStreamedMask = 0x7fffffff

staticprivateinherited

Definition at line 204 of file ZdcSubBlock.h.

s_maxWordBits

const int ZdcSubBlock::s_maxWordBits = 32

staticprivateinherited

Definition at line 201 of file ZdcSubBlock.h.

s_maxWordMask

const uint32_t ZdcSubBlock::s_maxWordMask = 0xffffffff

staticprivateinherited

Definition at line 203 of file ZdcSubBlock.h.

s_mcmAbsentBit

const int ZdcPpmSubBlock::s_mcmAbsentBit = 4

staticprivate

Definition at line 162 of file ZdcPpmSubBlock.h.

s_moduleBit

const int ZdcSubBlock::s_moduleBit = 8

staticprivateinherited

Definition at line 179 of file ZdcSubBlock.h.

s_moduleMask

const uint32_t ZdcSubBlock::s_moduleMask = 0xf

staticprivateinherited

Definition at line 187 of file ZdcSubBlock.h.

s_ppmChannel

const int ZdcPpmSubBlock::s_ppmChannel

staticprivate

Initial value:

= {0,  4,  8,  12,  16,  20,  24,  28,  32,  36,  40,  44,  48,  52,  56,  60,
                                                    3,  7, 11,  15,  19,  23,  27,  31,  35,  39,  43,  47,  51,  55,  59,  63,
                                                    1,  5,  9,  13,  17,  21,  25,  29,  33,  37,  41,  45,  49,  53,  57,  61,
                                                    2,  6, 10,  14,  18,  22,  26,  30,  34,  38,  42,  46,  50,  54,  58,  62 }

Definition at line 52 of file ZdcPpmSubBlock.h.

s_seqnoBit

const int ZdcSubBlock::s_seqnoBit = 16

staticprivateinherited

Definition at line 177 of file ZdcSubBlock.h.

s_seqnoMask

const uint32_t ZdcSubBlock::s_seqnoMask = 0x3f

staticprivateinherited

Definition at line 185 of file ZdcSubBlock.h.

s_slices1Bit

const int ZdcSubBlock::s_slices1Bit = 0

staticprivateinherited

Definition at line 181 of file ZdcSubBlock.h.

s_slices1Mask

const uint32_t ZdcSubBlock::s_slices1Mask = 0x7

staticprivateinherited

Definition at line 189 of file ZdcSubBlock.h.

s_slices2Bit

const int ZdcSubBlock::s_slices2Bit = 3

staticprivateinherited

Definition at line 180 of file ZdcSubBlock.h.

s_slices2Mask

const uint32_t ZdcSubBlock::s_slices2Mask = 0x1f

staticprivateinherited

Definition at line 188 of file ZdcSubBlock.h.

s_statusBit

const int ZdcSubBlock::s_statusBit = 28

staticprivateinherited

Definition at line 168 of file ZdcSubBlock.h.

s_statusMask

const uint32_t ZdcSubBlock::s_statusMask = 0x1

staticprivateinherited

Definition at line 170 of file ZdcSubBlock.h.

s_statusVal

const uint32_t ZdcSubBlock::s_statusVal = 0x1

staticprivateinherited

Definition at line 172 of file ZdcSubBlock.h.

s_timeoutBit

const int ZdcPpmSubBlock::s_timeoutBit = 5

staticprivate

Definition at line 161 of file ZdcPpmSubBlock.h.

s_upstreamErrorBit

const int ZdcSubBlock::s_upstreamErrorBit = 4

staticprivateinherited

Definition at line 194 of file ZdcSubBlock.h.

s_versionBit

const int ZdcSubBlock::s_versionBit = 25

staticprivateinherited

Definition at line 175 of file ZdcSubBlock.h.

s_versionMask

const uint32_t ZdcSubBlock::s_versionMask = 0x7

staticprivateinherited

Definition at line 183 of file ZdcSubBlock.h.

s_wordIdBit

const int ZdcSubBlock::s_wordIdBit = 28

staticprivateinherited

Definition at line 174 of file ZdcSubBlock.h.

s_wordIdMask

const uint32_t ZdcSubBlock::s_wordIdMask = 0xf

staticprivateinherited

Definition at line 182 of file ZdcSubBlock.h.

s_wordIdVal

const uint32_t ZdcPpmSubBlock::s_wordIdVal = 0xc

staticprivate

Sub-Block class for PPM data.

This may be link to the equivalent in LVL1 code, TRY_LINK_LVL1 Marco Leite

Definition at line 135 of file ZdcPpmSubBlock.h.

s_wordLen

const int ZdcPpmSubBlock::s_wordLen = 16

staticprivate

Definition at line 138 of file ZdcPpmSubBlock.h.

---

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

• ZdcPpmSubBlock.h
• ZdcPpmSubBlock.cxx