VFATFrame Class Reference

#include <VFATFrame.h>

Inheritance diagram for VFATFrame:

Public Types
typedef uint16_t	word

Public Member Functions
virtual bool	channelActive (unsigned char channel) const
virtual bool	checkCRC () const
bool	checkFootprint () const
virtual std::vector< unsigned char >	getActiveChannels () const
VFATFrame::word	getBC () const
	Returns Bunch Crossing number (BC<11:0>). More...
VFATFrame::word	getChipID () const
	Returns ChipID (ChipID<11:0>). More...
VFATFrame::word	getCRC () const
	Returns the CRC. More...
VFATFrame::word *	getData ()
const VFATFrame::word *	getData () const
VFATFrame::word	getEC () const
	Returns Event Counter (EV<7:0>). More...
VFATFrame::word	getFlags () const
	Returns flags. More...
uint8_t	getNumberOfClusters () const
bool	isBCPresent () const
	Returns true if the BC word is present in the frame. More...
bool	isCRCPresent () const
	Returns true if the CRC word is present in the frame. More...
bool	isECPresent () const
	Returns true if the EC word is present in the frame. More...
bool	isIDPresent () const
	Returns true if the ID word is present in the frame. More...
bool	isNumberOfClustersPresent () const
	Returns true if the CRC word is present in the frame. More...
void	Print (bool binary=false) const
void	setDAQErrorFlags (uint8_t v)
	Sets DAQ error flags. More...
void	setData (const word *_data)
	Copies a memory block to data buffer. More...
void	setNumberOfClusters (uint8_t v)
void	setPresenceFlags (uint8_t v)
	Sets presence flags. More...
	VFATFrame (const word *_data=nullptr)
	VFATFrame (const VFATFrame &copy)
virtual	~VFATFrame ()

Protected Attributes
word	data [12]

Static Private Member Functions
static word	calculateCRC (word crc_in, word dato)
	internaly used to check CRC More...

Private Attributes
uint8_t	daqErrorFlags
	Error flag as given by certain versions of DAQ. More...
uint8_t	numberOfClusters
uint8_t	presenceFlags

Detailed Description

Representation of VFAT frame plus extra info added by DAQ.

Definition at line 19 of file VFATFrame.h.

Member Typedef Documentation

typedef uint16_t VFATFrame::word

Definition at line 22 of file VFATFrame.h.

Constructor & Destructor Documentation

VFATFrame::VFATFrame

(

const word *

_data = nullptr

)

Definition at line 18 of file VFATFrame.cc.

References data, and setData().

                                               :
  presenceFlags(15),    // by default BC, EC, ID and CRC are present
  daqErrorFlags(0),     // by default, no DAQ error
  numberOfClusters(0)   // no clusters by default
{
  if (_data)
    setData(_data);
  else
    memset(data, 0, 12 * sizeof(word));
}

VFATFrame::VFATFrame ( const VFATFrame &  copy )

inline

Definition at line 26 of file VFATFrame.h.

References daqErrorFlags, data, numberOfClusters, presenceFlags, and setData().

    {
      setData(copy.data);
      presenceFlags = copy.presenceFlags;
      daqErrorFlags = copy.daqErrorFlags;
      numberOfClusters = copy.numberOfClusters;

    }

virtual VFATFrame::~VFATFrame ( )

inlinevirtual

Definition at line 35 of file VFATFrame.h.

References setData().

{}

Member Function Documentation

VFATFrame::word VFATFrame::calculateCRC ( VFATFrame::word  crc_in, VFATFrame::word  dato  )

staticprivate

internaly used to check CRC

Definition at line 100 of file VFATFrame.cc.

References edmIntegrityCheck::d, mps_fire::i, RecoTauDiscriminantConfiguration::mask, and findQualityFiles::v.

Referenced by checkCRC().

{
  word v = 0x0001;
  word mask = 0x0001;    
  bool d=false;
  word crc_temp = crc_in;
  unsigned char datalen = 16;

  for (int i = 0; i < datalen; i++)
  {
    if (dato & v)
      d = true;
    else
      d = false;
      
    if ((crc_temp & mask)^d)
      crc_temp = crc_temp>>1 ^ 0x8408;
    else
      crc_temp = crc_temp>>1;
       
    v <<= 1;
  }

  return crc_temp;
}

virtual bool VFATFrame::channelActive ( unsigned char  channel ) const

inlinevirtual

Checks if channel number 'channel' was active. Returns positive number if it was active, 0 otherwise.

Definition at line 147 of file VFATFrame.h.

References data, getActiveChannels(), and Print().

    {
      return ( data[1 + (channel / 16)] & (1 << (channel % 16)) ) ? true : false;
    }

bool VFATFrame::checkCRC ( ) const

virtual

Checks the validity of frame (CRC and daqErrorFlags). Returns false if daqErrorFlags is non-zero. Returns false if the CRC is present and invalid.

Definition at line 79 of file VFATFrame.cc.

References calculateCRC(), daqErrorFlags, data, mps_fire::i, and isCRCPresent().

Referenced by getNumberOfClusters(), Print(), and RawToDigiConverter::runCommon().

{
  // check DAQ error flags
  if (daqErrorFlags != 0)
    return false;

  // return true if CRC not present
  if (! isCRCPresent())
    return true;

  // compare CRC
  word crc_fin = 0xffff;

  for (int i = 11; i >= 1; i--)
    crc_fin = calculateCRC(crc_fin, data[i]);
  
  return (crc_fin == data[0]);
}

bool VFATFrame::checkFootprint

(

)

const

Checks the fixed bits in the frame. Returns false if any of the groups (in BC, EC and ID words) is present but wrong.

Definition at line 63 of file VFATFrame.cc.

References data, isBCPresent(), isECPresent(), and isIDPresent().

Referenced by getNumberOfClusters(), Print(), and RawToDigiConverter::runCommon().

{
  if (isIDPresent() && (data[9] & 0xF000) != 0xE000)
    return false;

  if (isECPresent() && (data[10] & 0xF000) != 0xC000)
    return false;

  if (isBCPresent() && (data[11] & 0xF000) != 0xA000)
    return false;

  return true;
}

std::vector< unsigned char > VFATFrame::getActiveChannels ( ) const

virtual

Returns list of active channels. It's more efficient than the channelActive(char) for events with low channel occupancy.

Definition at line 38 of file VFATFrame.cc.

References data, mps_fire::i, RecoTauDiscriminantConfiguration::mask, and PFRecoTauDiscriminationByIsolation_cfi::offset.

Referenced by channelActive(), and RawToDigiConverter::run().

{
  std::vector<unsigned char> channels;

  for (int i = 0; i < 8; i++)
  {
    // quick check
    if (!data[1 + i])
      continue;

    // go throug bits
    word mask;
    char offset;
    for (mask = 1 << 15, offset = 15; mask; mask >>= 1, offset--)
    {
      if (data[1 + i] & mask)
        channels.push_back( i * 16 + offset );
    }
  }

  return channels;
}

VFATFrame::word VFATFrame::getBC ( ) const

inline

Returns Bunch Crossing number (BC<11:0>).

Definition at line 51 of file VFATFrame.h.

References data.

Referenced by Print().

    {
      return data[11] & 0x0FFF;
    }

VFATFrame::word VFATFrame::getChipID ( ) const

inline

Returns ChipID (ChipID<11:0>).

Definition at line 69 of file VFATFrame.h.

References data.

Referenced by VFATFrameCollection::GetFrameByIndexID(), Print(), and RawToDigiConverter::runCommon().

    {
      return data[9] & 0x0FFF;
    }

VFATFrame::word VFATFrame::getCRC ( ) const

inline

Returns the CRC.

Definition at line 75 of file VFATFrame.h.

References data.

Referenced by Print().

    {
      return data[0];
    }

VFATFrame::word* VFATFrame::getData ( void  )

inline

Definition at line 40 of file VFATFrame.h.

References data.

Referenced by ctpps::RawDataUnpacker::processOptoRxFrameSerial(), ctpps::RawDataUnpacker::processVFATDataParallel(), and RawToDigiConverter::run().

    {
      return data;
    }

const VFATFrame::word* VFATFrame::getData ( void  ) const

inline

Definition at line 45 of file VFATFrame.h.

References data.

    {
      return data;
    }

VFATFrame::word VFATFrame::getEC ( ) const

inline

Returns Event Counter (EV<7:0>).

Definition at line 57 of file VFATFrame.h.

References data.

Referenced by Print(), and RawToDigiConverter::run().

    {
      return (data[10] & 0x0FF0) >> 4;
    }

VFATFrame::word VFATFrame::getFlags ( ) const

inline

Returns flags.

Definition at line 63 of file VFATFrame.h.

References data.

Referenced by Print().

    {
      return data[10] & 0x000F;
    }

uint8_t VFATFrame::getNumberOfClusters ( ) const

inline

Returns the number of clusters as given by the "0xD0 frame". Returns 0, if not available.

Definition at line 130 of file VFATFrame.h.

References checkCRC(), checkFootprint(), and numberOfClusters.

Referenced by RawToDigiConverter::runCommon().

    {
      return numberOfClusters;
    }

bool VFATFrame::isBCPresent ( ) const

inline

Returns true if the BC word is present in the frame.

Definition at line 88 of file VFATFrame.h.

References presenceFlags.

Referenced by checkFootprint().

    {
      return presenceFlags & 0x1;
    }

bool VFATFrame::isCRCPresent ( ) const

inline

Returns true if the CRC word is present in the frame.

Definition at line 106 of file VFATFrame.h.

References presenceFlags.

Referenced by checkCRC().

    {
      return presenceFlags & 0x8;
    }

bool VFATFrame::isECPresent ( ) const

inline

Returns true if the EC word is present in the frame.

Definition at line 94 of file VFATFrame.h.

References presenceFlags.

Referenced by checkFootprint().

    {
      return presenceFlags & 0x2;
    }

bool VFATFrame::isIDPresent ( ) const

inline

Returns true if the ID word is present in the frame.

Definition at line 100 of file VFATFrame.h.

References presenceFlags.

Referenced by checkFootprint(), and RawToDigiConverter::runCommon().

    {
      return presenceFlags & 0x4;
    }

bool VFATFrame::isNumberOfClustersPresent ( ) const

inline

Returns true if the CRC word is present in the frame.

Definition at line 112 of file VFATFrame.h.

References presenceFlags.

Referenced by RawToDigiConverter::runCommon().

    {
      return presenceFlags & 0x10;
    }

void VFATFrame::Print

(

bool

binary = false

)

const

Prints the frame. If binary is true, binary format is used.

Definition at line 128 of file VFATFrame.cc.

References checkCRC(), checkFootprint(), daqErrorFlags, data, getBC(), getChipID(), getCRC(), getEC(), getFlags(), mps_fire::i, RecoTauDiscriminantConfiguration::mask, presenceFlags, and w.

Referenced by channelActive().

{
  if (binary)
  {
    for (int i = 0; i < 12; i++)
    {
      const word &w = data[11 - i];
      word mask = (1 << 15);
      for (int j = 0; j < 16; j++)
      {
        if (w & mask)
          printf("1");
        else
          printf("0");
        mask = (mask >> 1);
        if ((j + 1) % 4 == 0)
          printf("|");
      }
      printf("\n");
    }
  } else {
    printf("ID = %03x, BC = %04u, EC = %03u, flags = %2u, CRC = %04x ", getChipID(), getBC(), getEC(), getFlags(), getCRC());

    if (checkCRC())
      printf("(  OK), footprint ");
    else
      printf("(FAIL), footprint ");

    if (checkFootprint())
      printf("  OK");
    else
      printf("FAIL");

    printf(", frame = %04x|%04x|%04x|", data[11], data[10], data[9]);
    for (int i = 8; i > 0; i--)
      printf("%04x", data[i]);
    printf("|%04x", data[0]);

    printf(", presFl=%x", presenceFlags);
    printf(", daqErrFl=%x", daqErrorFlags);

    printf("\n");
  }
}

void VFATFrame::setDAQErrorFlags ( uint8_t  v )

inline

Sets DAQ error flags.

Definition at line 118 of file VFATFrame.h.

References daqErrorFlags, and findQualityFiles::v.

Referenced by ctpps::RawDataUnpacker::processVFATDataParallel().

    {
      daqErrorFlags = v;
    }

void VFATFrame::setData

(

const word *

_data

)

Copies a memory block to data buffer.

Definition at line 31 of file VFATFrame.cc.

References data.

Referenced by VFATFrame(), and ~VFATFrame().

{
  memcpy(data, _data, 24);
}

void VFATFrame::setNumberOfClusters ( uint8_t  v )

inline

Definition at line 123 of file VFATFrame.h.

References numberOfClusters, and findQualityFiles::v.

Referenced by ctpps::RawDataUnpacker::processVFATDataParallel().

    {
      numberOfClusters = v;
    }

void VFATFrame::setPresenceFlags ( uint8_t  v )

inline

Sets presence flags.

Definition at line 82 of file VFATFrame.h.

References presenceFlags, and findQualityFiles::v.

Referenced by ctpps::RawDataUnpacker::processOptoRxFrameSampic(), and ctpps::RawDataUnpacker::processVFATDataParallel().

    {
      presenceFlags = v;
    }

Member Data Documentation

uint8_t VFATFrame::daqErrorFlags

private

Error flag as given by certain versions of DAQ.

Definition at line 184 of file VFATFrame.h.

Referenced by checkCRC(), Print(), setDAQErrorFlags(), and VFATFrame().

word VFATFrame::data[12]

protected

Raw data frame as sent by electronics. The container is organized as follows (reversed Figure 8 at page 23 of VFAT2 manual):

* buffer index   content       size
* ---------------------------------------------------------------
*   0            CRC           16 bits
*   1->8         Channel data  128 bits, channel 0 first
*   9            ChipID        4 constant bits (1110) + 12 bits
*   10           EC, Flags     4 constant bits (1100) + 8, 4 bits
*   11           BC            4 constant bits (1010) + 12 bits
* 

Definition at line 173 of file VFATFrame.h.

Referenced by data_sources.node::__str__(), confdb.HLTProcess::_fix_parameter(), confdb.HLTProcess::addEras(), confdb.HLTProcess::addGlobalOptions(), confdb.HLTProcess::append_filenames(), data_sources.json_list::as_dicts(), data_sources.json_list::as_table(), confdb.HLTProcess::build_source(), channelActive(), checkCRC(), checkFootprint(), confdb.HLTProcess::customize(), confdb.HLTProcess::dump(), confdb.HLTProcess::fixPrescales(), data_sources.json_list::get_members(), getActiveChannels(), getBC(), getChipID(), getCRC(), getData(), getEC(), getFlags(), DiamondVFATFrame::getHptdcErrorFlag(), DiamondVFATFrame::getLeadingEdgeTime(), DiamondVFATFrame::getMultihit(), confdb.HLTProcess::getRawConfigurationFromDB(), DiamondVFATFrame::getThresholdVoltage(), DiamondVFATFrame::getTrailingEdgeTime(), confdb.HLTProcess::instrumentDQM(), confdb.HLTProcess::instrumentOpenMode(), confdb.HLTProcess::instrumentTiming(), data_sources.json_list::last(), confdb.HLTProcess::loadAdditionalConditions(), confdb.HLTProcess::loadCff(), confdb.HLTProcess::loadSetupCff(), confdb.HLTProcess::overrideGlobalTag(), confdb.HLTProcess::overrideL1MenuXml(), confdb.HLTProcess::overrideOutput(), confdb.HLTProcess::overrideParameters(), confdb.HLTProcess::overrideProcessName(), Print(), confdb.HLTProcess::runL1Emulator(), setData(), confdb.HLTProcess::specificCustomize(), cuy.FindIssue::startElement(), edmStreamStallGrapher.Stack::update(), confdb.HLTProcess::updateMessageLogger(), and VFATFrame().

uint8_t VFATFrame::numberOfClusters

private

Number of clusters. Only available in cluster mode and if the number of clusters exceeds a limit (10).

Definition at line 188 of file VFATFrame.h.

Referenced by getNumberOfClusters(), setNumberOfClusters(), and VFATFrame().

uint8_t VFATFrame::presenceFlags

private

Flag indicating the presence of various components. bit 1: "BC word" (buffer index 11) bit 2: "EC word" (buffer index 10) bit 3: "ID word" (buffer index 9) bit 4: "CRC word" (buffer index 0) bit 5: "number of clusters word" (prefix 0xD0)

Definition at line 181 of file VFATFrame.h.

Referenced by isBCPresent(), isCRCPresent(), isECPresent(), isIDPresent(), isNumberOfClustersPresent(), Print(), setPresenceFlags(), and VFATFrame().