o2::emcal::RCUTrailer Class Reference

Information stored in the RCU trailer. More...

#include <RCUTrailer.h>

Classes
class	Error
	Error handling of the RCU trailer. More...

Public Types
enum	BufferMode_t { NBUFFERS4 = 0 , NBUFFERS8 = 1 }
	Handler for encoding of the number of ALTRO buffers in the configuration. More...

Public Member Functions
	RCUTrailer ()=default
	Constructor.
	~RCUTrailer ()=default
	destructor
void	reset ()
	Reset the RCU trailer.
void	printStream (std::ostream &stream) const
	Prints the contents of the RCU trailer data.
void	constructFromRawPayload (const gsl::span< const uint32_t > payloadwords)
	Decode RCU trailer from the 32-bit words in the raw buffer.
int	getRCUID () const
	Get index of the RCU the trailer belongs to.
uint32_t	getTrailerSize () const
	Get the trailer size in number of DDL (32 bit) words.
uint32_t	getPayloadSize () const
	Get size of the payload as number of DDL (32-bit) words.
uint32_t	getTrailerWordCorruptions () const
	Get number of corrupted trailer words (undefined trailer word code)
uint8_t	getFirmwareVersion () const
	Get the firmware version.
void	setFirmwareVersion (uint8_t version)
	Set the firmware version.
void	setRCUID (int rcuid)
	Set the ID of the RCU.
void	setPayloadSize (uint32_t size)
	set the payload size in number of DDL (32-bit) words
double	getTimeSampleNS () const
	Access to the sampling time.
double	getL1PhaseNS () const
	Access to the L1 phase.
void	setTimeSamplePhaseNS (uint64_t triggertime, uint64_t timesample)
	Set the time sample length and L1 phase based on the trigger time.
uint16_t	getNumberOfChannelAddressMismatch () const
	Get the number of channels with address mismatch.
uint16_t	getNumberOfChannelLengthMismatch () const
	Get the number of channels with length mismatch.
void	setNumberOfChannelAddressMismatch (uint16_t nchannel)
	Set the number of channels with address mismatch.
void	setNumberOfChannelLengthMismatch (uint8_t nchannel)
	Set the number of channels with length mismatch.
uint32_t	getFECErrorsA () const
uint32_t	getFECErrorsB () const
uint16_t	getActiveFECsA () const
uint16_t	getActiveFECsB () const
void	setFECErrorsA (uint32_t value)
void	setFECErrorsB (uint32_t value)
void	setActiveFECsA (uint16_t value)
void	setActiveFECsB (uint16_t value)
uint16_t	getBaselineCorrection () const
	Get baseline correction method.
bool	getPolarity () const
	Check polarity setting.
uint16_t	getNumberOfPresamples () const
	Get the number of presamples (after zero suppression)
uint16_t	getNumberOfPostsamples () const
	Get the number of postsamples (after zero suppression)
bool	hasSecondBaselineCorr () const
	Check if second baseline correction is applied.
uint16_t	getGlitchFilter () const
	Get the glitch filter.
uint16_t	getNumberOfNonZeroSuppressedPostsamples () const
	Get the number of postsamples before zero suppression.
uint16_t	getNumberOfNonZeroSuppressedPresamples () const
	Get the number of presamples before zero suppression.
bool	hasZeroSuppression () const
	Check whether zero suppression has been applied.
uint16_t	getNumberOfPretriggerSamples () const
	Get the number of pretrigger samples.
uint16_t	getNumberOfSamplesPerChannel () const
	Get the number of samples per channel.
uint16_t	getNumberOfAltroBuffers () const
	Get the number of ALTRO buffers.
bool	isSparseReadout () const
	Check whether readout is in sparse mode.
void	setBaselineCorrection (uint16_t baselineCorrection)
	Set baseline correction method.
void	setPolarity (bool doSet)
	Set the polarity.
void	setNumberOfPresamples (uint16_t npresamples)
	Set the number of presamples (after zero suppression)
void	setNumberOfPostsamples (uint16_t npostsamples)
	Set the number of postsamples (after zero suppression)
void	setSecondBaselineCorrection (bool doHave)
	Specify whether second basedline correction has been applied.
void	setGlitchFilter (uint16_t glitchfilter)
	Set the glitch filter.
void	setNumberOfNonZeroSuppressedPostsamples (uint16_t npostsamples)
	Set the number of postsamples before zero suppression.
void	setNumberOfNonZeroSuppressedPresamples (uint16_t npresamples)
	Set the number of presamples after zero suppression.
void	setNumberOfPretriggerSamples (uint16_t nsamples)
	Set the number of pretrigger samples.
void	setNumberOfSamplesPerChannel (uint16_t nsamples)
	Set the number of samples per channel.
void	setZeroSuppression (bool doHave)
	Specify whether zero suppression has been applied.
void	setSparseReadout (bool isSparse)
	Set sparse readout mode.
void	setNumberOfAltroBuffers (BufferMode_t bufmode)
	Set the number of ALTRO buffers.
uint16_t	getErrorsG2 () const
	Get value stored in error counter register 2.
uint32_t	getErrorsG3 () const
	Get value stored in error counter register 3.
uint32_t	getAltroCFGReg1 () const
	Get value stored in ALTRO config register 1.
uint32_t	getAltroCFGReg2 () const
	Get value stored in ALTRO config register 1.
void	setErrorsG2 (uint16_t value)
	Set error counter register 2.
void	setErrorsG3 (uint32_t value)
	Set error counter register 3.
void	setAltroCFGReg1 (uint32_t value)
	Set ALTRO config register 1.
void	setAltroCFGReg2 (uint32_t value)
	Set ALTRO config register 2.
bool	isInitialized () const
	checlks whether the RCU trailer is initialzied
std::vector< uint32_t >	encode () const
	Encode RCU trailer as array of DDL (32-bit) words.

Static Public Member Functions
static RCUTrailer	constructFromPayloadWords (const gsl::span< const uint32_t > payloadwords)
	Decode RCU trailer from payload.
static bool	checkLastTrailerWord (uint32_t trailerword)
	Check whether the word is a valid last trailer word.

Detailed Description

Information stored in the RCU trailer.

The RCU trailer can be found at the end of the payload and contains general information sent by the SRU.

Definition of the trailer words:

• mFirmwareVersion: Firmware version
• mTrailerSize: Size of the trailer in DDL words (32-bit)
• mPayloadSize: Size of the payload in DDL words (32-bit)
• mFECERRA
• mFECERRB
• mERRREG2
• mERRREG3

  Bits	Error type
  0 - 11	Number of channels with address mismatch
  12 - 24	Number of channels with length mismatch
  25 - 31	Zeroed (used for trailer word markers)

• mActiveFECsA
• mActiveFECsB
• mAltroCFG1 (32 bit)

  Bits	Setting
  0-3	Baseline correction
  4	Polarity
  5-6	Number of presamples
  7-10	Number of postsamples
  11	Second baseline correction
  12-13	Glitch filter
  14-16	Number of postsamples before zero suppression
  17-18	Number of presamples before zero suppression
  19	Zero suppression on / off
  20 - 31	Zeroed (used for trailer word markers)

• mAltroCFG2 (32 bit)

  Bits	Setting
  0 - 4	L1 phase
  5 - 9	Length of the time sample
  9	Sparse readout on / off
  10 - 19	Number of samples per channel
  20 - 23	Number of pretrigger samples
  24	ALTRO buffers (0 - 4 buffers, 1 - 8 buffers)
  25 - 31	Zeroed (used for trailer word markers)

Definition at line 74 of file RCUTrailer.h.

Member Enumeration Documentation

BufferMode_t

enum o2::emcal::RCUTrailer::BufferMode_t

Handler for encoding of the number of ALTRO buffers in the configuration.

Enumerator
NBUFFERS4	4 ALTRO buffers
NBUFFERS8	8 ALTRO buffers

Definition at line 117 of file RCUTrailer.h.

Constructor & Destructor Documentation

RCUTrailer()

o2::emcal::RCUTrailer::RCUTrailer ( )

default

Constructor.

~RCUTrailer()

o2::emcal::RCUTrailer::~RCUTrailer ( )

default

destructor

Member Function Documentation

checkLastTrailerWord()

bool RCUTrailer::checkLastTrailerWord ( uint32_t  trailerword )

static

Check whether the word is a valid last trailer word.

Parameters

trailerword

Word to be checked

Returns

True if the word is a valid last trailer word, false if there are inconsistencies

Definition at line 38 of file RCUTrailer.cxx.

constructFromPayloadWords()

RCUTrailer RCUTrailer::constructFromPayloadWords ( const gsl::span< const uint32_t >  payloadwords )

static

Decode RCU trailer from payload.

Returns

RCU trailer found at the end of the given payload

The trailer is expected at the end of the paylaod. Trailer words are identified via their trailer marker (bits 30 and 31), and are assigned based on the trailer word marker.

Definition at line 267 of file RCUTrailer.cxx.

constructFromRawPayload()

void RCUTrailer::constructFromRawPayload

(

const gsl::span< const uint32_t >

payloadwords

)

Decode RCU trailer from the 32-bit words in the raw buffer.

Parameters

buffer

Raw buffer from which to read the trailer

Read the RCU trailer according to the RCU formware version specified in CDH.

Definition at line 61 of file RCUTrailer.cxx.

encode()

std::vector< uint32_t > RCUTrailer::encode

(

)

const

Encode RCU trailer as array of DDL (32-bit) words.

Returns

array of trailer words after encoding

Encoded trailer words always contain the trailer pattern (bit 30 and bit 31 set)

Definition at line 192 of file RCUTrailer.cxx.

getActiveFECsA()

uint16_t o2::emcal::RCUTrailer::getActiveFECsA ( ) const

inline

Definition at line 215 of file RCUTrailer.h.

getActiveFECsB()

uint16_t o2::emcal::RCUTrailer::getActiveFECsB ( ) const

inline

Definition at line 216 of file RCUTrailer.h.

getAltroCFGReg1()

uint32_t o2::emcal::RCUTrailer::getAltroCFGReg1 ( ) const

inline

Get value stored in ALTRO config register 1.

Returns

Value of the register

Deprecated:

Use dedicated getters for ALTRO configuration

Definition at line 346 of file RCUTrailer.h.

getAltroCFGReg2()

uint32_t o2::emcal::RCUTrailer::getAltroCFGReg2 ( ) const

inline

Get value stored in ALTRO config register 1.

Returns

Value of the register

Deprecated:

Use dedicated getters for ALTRO configuration

Definition at line 351 of file RCUTrailer.h.

getBaselineCorrection()

uint16_t o2::emcal::RCUTrailer::getBaselineCorrection ( ) const

inline

Get baseline correction method.

Returns

baseline correction method

Definition at line 228 of file RCUTrailer.h.

getErrorsG2()

uint16_t o2::emcal::RCUTrailer::getErrorsG2 ( ) const

inline

Get value stored in error counter register 2.

Direct access to RCU trailer registers (not recommended)

Returns

Value of the register

Definition at line 336 of file RCUTrailer.h.

getErrorsG3()

uint32_t o2::emcal::RCUTrailer::getErrorsG3 ( ) const

inline

Get value stored in error counter register 3.

Returns

Value of the register

Deprecated:

Use dedicated getters for error counters

Definition at line 341 of file RCUTrailer.h.

getFECErrorsA()

uint32_t o2::emcal::RCUTrailer::getFECErrorsA ( ) const

inline

Definition at line 213 of file RCUTrailer.h.

getFECErrorsB()

uint32_t o2::emcal::RCUTrailer::getFECErrorsB ( ) const

inline

Definition at line 214 of file RCUTrailer.h.

getFirmwareVersion()

uint8_t o2::emcal::RCUTrailer::getFirmwareVersion ( ) const

inline

Get the firmware version.

Returns

Firmware version

Definition at line 162 of file RCUTrailer.h.

getGlitchFilter()

uint16_t o2::emcal::RCUTrailer::getGlitchFilter ( ) const

inline

Get the glitch filter.

Returns

Glitch filter setting

Definition at line 248 of file RCUTrailer.h.

getL1PhaseNS()

double RCUTrailer::getL1PhaseNS

(

)

const

Access to the L1 phase.

Returns

L1 phase w.r.t to the LHC clock

Definition at line 182 of file RCUTrailer.cxx.

getNumberOfAltroBuffers()

uint16_t o2::emcal::RCUTrailer::getNumberOfAltroBuffers ( ) const

inline

Get the number of ALTRO buffers.

Returns

Number of Altro Buffers

Definition at line 272 of file RCUTrailer.h.

getNumberOfChannelAddressMismatch()

uint16_t o2::emcal::RCUTrailer::getNumberOfChannelAddressMismatch ( ) const

inline

Get the number of channels with address mismatch.

Returns

Number of channels

Definition at line 199 of file RCUTrailer.h.

getNumberOfChannelLengthMismatch()

uint16_t o2::emcal::RCUTrailer::getNumberOfChannelLengthMismatch ( ) const

inline

Get the number of channels with length mismatch.

Returns

Number of channels

Definition at line 203 of file RCUTrailer.h.

getNumberOfNonZeroSuppressedPostsamples()

uint16_t o2::emcal::RCUTrailer::getNumberOfNonZeroSuppressedPostsamples ( ) const

inline

Get the number of postsamples before zero suppression.

Returns

Number of postsamples

Definition at line 252 of file RCUTrailer.h.

getNumberOfNonZeroSuppressedPresamples()

uint16_t o2::emcal::RCUTrailer::getNumberOfNonZeroSuppressedPresamples ( ) const

inline

Get the number of presamples before zero suppression.

Returns

Number of presamples

Definition at line 256 of file RCUTrailer.h.

getNumberOfPostsamples()

uint16_t o2::emcal::RCUTrailer::getNumberOfPostsamples ( ) const

inline

Get the number of postsamples (after zero suppression)

Returns

Number of postsamples

Definition at line 240 of file RCUTrailer.h.

getNumberOfPresamples()

uint16_t o2::emcal::RCUTrailer::getNumberOfPresamples ( ) const

inline

Get the number of presamples (after zero suppression)

Returns

Number of presamples

Definition at line 236 of file RCUTrailer.h.

getNumberOfPretriggerSamples()

uint16_t o2::emcal::RCUTrailer::getNumberOfPretriggerSamples ( ) const

inline

Get the number of pretrigger samples.

Returns

Number of samples

Definition at line 264 of file RCUTrailer.h.

getNumberOfSamplesPerChannel()

uint16_t o2::emcal::RCUTrailer::getNumberOfSamplesPerChannel ( ) const

inline

Get the number of samples per channel.

Returns

Number of samples per channel

Definition at line 268 of file RCUTrailer.h.

getPayloadSize()

uint32_t o2::emcal::RCUTrailer::getPayloadSize ( ) const

inline

Get size of the payload as number of DDL (32-bit) words.

Returns

Size of the payload as number of 32 bit workds

Definition at line 154 of file RCUTrailer.h.

getPolarity()

bool o2::emcal::RCUTrailer::getPolarity ( ) const

inline

Check polarity setting.

Returns

Polarity setting

Definition at line 232 of file RCUTrailer.h.

getRCUID()

int o2::emcal::RCUTrailer::getRCUID ( ) const

inline

Get index of the RCU the trailer belongs to.

Returns

RCU index

Definition at line 146 of file RCUTrailer.h.

getTimeSampleNS()

double RCUTrailer::getTimeSampleNS

(

)

const

Access to the sampling time.

Returns

Sampling time in seconds.

Exceptions

Error

if the RCU trailer was not properly initializied

Definition at line 137 of file RCUTrailer.cxx.

getTrailerSize()

uint32_t o2::emcal::RCUTrailer::getTrailerSize ( ) const

inline

Get the trailer size in number of DDL (32 bit) words.

Returns

Size of the RCU trailer

Definition at line 150 of file RCUTrailer.h.

getTrailerWordCorruptions()

uint32_t o2::emcal::RCUTrailer::getTrailerWordCorruptions ( ) const

inline

Get number of corrupted trailer words (undefined trailer word code)

Returns

Number of trailer word corruptions

Definition at line 158 of file RCUTrailer.h.

hasSecondBaselineCorr()

bool o2::emcal::RCUTrailer::hasSecondBaselineCorr ( ) const

inline

Check if second baseline correction is applied.

Returns

True if second baseline correction has been applied, false otherwise

Definition at line 244 of file RCUTrailer.h.

hasZeroSuppression()

bool o2::emcal::RCUTrailer::hasZeroSuppression ( ) const

inline

Check whether zero suppression has been applied.

Returns

True if zero suppression has been applied, false otherwise

Definition at line 260 of file RCUTrailer.h.

isInitialized()

bool o2::emcal::RCUTrailer::isInitialized ( ) const

inline

checlks whether the RCU trailer is initialzied

Returns

True if the trailer is initialized, false otherwise

Definition at line 374 of file RCUTrailer.h.

isSparseReadout()

bool o2::emcal::RCUTrailer::isSparseReadout ( ) const

inline

Check whether readout is in sparse mode.

Returns

True if the readout is in sparse mode, false otherwise

Definition at line 276 of file RCUTrailer.h.

printStream()

void RCUTrailer::printStream

(

std::ostream &

stream

)

const

Prints the contents of the RCU trailer data.

Parameters

stream

stream the trailer has to be put on

Definition at line 210 of file RCUTrailer.cxx.

reset()

void RCUTrailer::reset

(

)

Reset the RCU trailer.

Setting all values to 0

Definition at line 21 of file RCUTrailer.cxx.

setActiveFECsA()

void o2::emcal::RCUTrailer::setActiveFECsA ( uint16_t  value )

inline

Definition at line 219 of file RCUTrailer.h.

setActiveFECsB()

void o2::emcal::RCUTrailer::setActiveFECsB ( uint16_t  value )

inline

Definition at line 220 of file RCUTrailer.h.

setAltroCFGReg1()

void o2::emcal::RCUTrailer::setAltroCFGReg1 ( uint32_t  value )

inline

Set ALTRO config register 1.

Parameters

value

Value for register

Deprecated:

Use dedicated setters for configuration

Definition at line 365 of file RCUTrailer.h.

setAltroCFGReg2()

void o2::emcal::RCUTrailer::setAltroCFGReg2 ( uint32_t  value )

inline

Set ALTRO config register 2.

Parameters

value

Value for register

Deprecated:

Use dedicated setters for configuration

Definition at line 370 of file RCUTrailer.h.

setBaselineCorrection()

void o2::emcal::RCUTrailer::setBaselineCorrection ( uint16_t  baselineCorrection )

inline

Set baseline correction method.

Parameters

baselineCorrection

Baseline correction method

Definition at line 280 of file RCUTrailer.h.

setErrorsG2()

void o2::emcal::RCUTrailer::setErrorsG2 ( uint16_t  value )

inline

Set error counter register 2.

Parameters

value

Value for register

Definition at line 355 of file RCUTrailer.h.

setErrorsG3()

void o2::emcal::RCUTrailer::setErrorsG3 ( uint32_t  value )

inline

Set error counter register 3.

Parameters

value

Value for register

Deprecated:

Use dedicated setters for error counters

Definition at line 360 of file RCUTrailer.h.

setFECErrorsA()

void o2::emcal::RCUTrailer::setFECErrorsA ( uint32_t  value )

inline

Definition at line 217 of file RCUTrailer.h.

setFECErrorsB()

void o2::emcal::RCUTrailer::setFECErrorsB ( uint32_t  value )

inline

Definition at line 218 of file RCUTrailer.h.

setFirmwareVersion()

void o2::emcal::RCUTrailer::setFirmwareVersion ( uint8_t  version )

inline

Set the firmware version.

Parameters

version

Firmware version

Definition at line 166 of file RCUTrailer.h.

setGlitchFilter()

void o2::emcal::RCUTrailer::setGlitchFilter ( uint16_t  glitchfilter )

inline

Set the glitch filter.

Parameters

glitchfilter

Glitch filter

Definition at line 300 of file RCUTrailer.h.

setNumberOfAltroBuffers()

void o2::emcal::RCUTrailer::setNumberOfAltroBuffers ( BufferMode_t  bufmode )

inline

Set the number of ALTRO buffers.

Parameters

bufmode

Number of ALTRO buffers (4 or 8 buffers)

Definition at line 328 of file RCUTrailer.h.

setNumberOfChannelAddressMismatch()

void o2::emcal::RCUTrailer::setNumberOfChannelAddressMismatch ( uint16_t  nchannel )

inline

Set the number of channels with address mismatch.

Parameters

nchannel

Number of channels

Definition at line 207 of file RCUTrailer.h.

setNumberOfChannelLengthMismatch()

void o2::emcal::RCUTrailer::setNumberOfChannelLengthMismatch ( uint8_t  nchannel )

inline

Set the number of channels with length mismatch.

Parameters

nchannel

Number of channels

Definition at line 211 of file RCUTrailer.h.

setNumberOfNonZeroSuppressedPostsamples()

void o2::emcal::RCUTrailer::setNumberOfNonZeroSuppressedPostsamples ( uint16_t  npostsamples )

inline

Set the number of postsamples before zero suppression.

Parameters

npostsamples

Number of postsamples

Definition at line 304 of file RCUTrailer.h.

setNumberOfNonZeroSuppressedPresamples()

void o2::emcal::RCUTrailer::setNumberOfNonZeroSuppressedPresamples ( uint16_t  npresamples )

inline

Set the number of presamples after zero suppression.

Parameters

npresamples

Number of presamples

Definition at line 308 of file RCUTrailer.h.

setNumberOfPostsamples()

void o2::emcal::RCUTrailer::setNumberOfPostsamples ( uint16_t  npostsamples )

inline

Set the number of postsamples (after zero suppression)

Parameters

Definition at line 292 of file RCUTrailer.h.

setNumberOfPresamples()

void o2::emcal::RCUTrailer::setNumberOfPresamples ( uint16_t  npresamples )

inline

Set the number of presamples (after zero suppression)

Parameters

npresamples

Number of presamples

Definition at line 288 of file RCUTrailer.h.

setNumberOfPretriggerSamples()

void o2::emcal::RCUTrailer::setNumberOfPretriggerSamples ( uint16_t  nsamples )

inline

Set the number of pretrigger samples.

Parameters

nsamples

Number of samples

Definition at line 312 of file RCUTrailer.h.

setNumberOfSamplesPerChannel()

void o2::emcal::RCUTrailer::setNumberOfSamplesPerChannel ( uint16_t  nsamples )

inline

Set the number of samples per channel.

Parameters

nsamples

Number of samples

Definition at line 316 of file RCUTrailer.h.

setPayloadSize()

void o2::emcal::RCUTrailer::setPayloadSize ( uint32_t  size )

inline

set the payload size in number of DDL (32-bit) words

Parameters

size	Payload size

Definition at line 174 of file RCUTrailer.h.

setPolarity()

void o2::emcal::RCUTrailer::setPolarity ( bool  doSet )

inline

Set the polarity.

Parameters

doSet

If true polarity is set

Definition at line 284 of file RCUTrailer.h.

setRCUID()

void o2::emcal::RCUTrailer::setRCUID ( int  rcuid )

inline

Set the ID of the RCU.

Parameters

rcuid

ID of the RCU

Definition at line 170 of file RCUTrailer.h.

setSecondBaselineCorrection()

void o2::emcal::RCUTrailer::setSecondBaselineCorrection ( bool  doHave )

inline

Specify whether second basedline correction has been applied.

Parameters

doHave

If true a second baseline correction has bben applied

Definition at line 296 of file RCUTrailer.h.

setSparseReadout()

void o2::emcal::RCUTrailer::setSparseReadout ( bool  isSparse )

inline

Set sparse readout mode.

Parameters

isSparse

True if readout is in sparse mode, false otherwise

Definition at line 324 of file RCUTrailer.h.

setTimeSamplePhaseNS()

void RCUTrailer::setTimeSamplePhaseNS	(	uint64_t	triggertime,
		uint64_t	timesample
	)

Set the time sample length and L1 phase based on the trigger time.

Parameters

time	Trigger time (in ns)
timesample	Time sample (in ns)

L1 phase: Collision time with respect to the sample length. Number of phases: Sample length / bunch spacing (25 ns)

Definition at line 161 of file RCUTrailer.cxx.

setZeroSuppression()

void o2::emcal::RCUTrailer::setZeroSuppression ( bool  doHave )

inline

Specify whether zero suppression has been applied.

Parameters

doHave

If true zero suppression has been applied

Definition at line 320 of file RCUTrailer.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/base/include/EMCALBase/RCUTrailer.h
• /home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/base/src/RCUTrailer.cxx