VFATFrame Class Reference

#include <VFATFrame.h>

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 ()
VFATFrame::word	getEC () const
	Returns Event Counter (EV<7:0>). More...
VFATFrame::word	getFlags () const
	Returns flags. More...
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...
void	Print (bool binary=false) const
void	setData (const word *_data)
	Copies a memory block to data buffer. More...
	VFATFrame (const word *_data=NULL)
	VFATFrame (const VFATFrame &copy)
virtual	~VFATFrame ()

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

Public Attributes
word	daqErrorFlags
	Error flag as given by certain versions of DAQ. More...
word	data [12]
word	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 = NULL

)

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
{
  if (_data)
    setData(_data);
  else
    memset(data, 0, 12 * sizeof(word));
}

VFATFrame::VFATFrame ( const VFATFrame &  copy )

inline

Definition at line 27 of file VFATFrame.h.

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

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

virtual VFATFrame::~VFATFrame ( )

inlinevirtual

Definition at line 34 of file VFATFrame.h.

{}

Member Function Documentation

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

static

internaly used to check CRC

Definition at line 99 of file VFATFrame.cc.

References ztail::d, i, and findQualityFiles::v.

Referenced by checkCRC().

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

  for (int i = 0; i < datalen; i++)
  {
    if (dato & v)
      d = 1;
    else
      d = 0;
      
    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 109 of file VFATFrame.h.

References data.

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

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 78 of file VFATFrame.cc.

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

Referenced by 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 62 of file VFATFrame.cc.

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

Referenced by 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 37 of file VFATFrame.cc.

References data, i, and hltrates_dqm_sourceclient-live_cfg::offset.

Referenced by 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 45 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 63 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 69 of file VFATFrame.h.

References data.

Referenced by Print().

    {
      return data[0];
    }

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

inline

Definition at line 39 of file VFATFrame.h.

References data.

Referenced by RawDataUnpacker::ProcessOptoRxFrameSerial(), and RawDataUnpacker::ProcessVFATDataParallel().

    {
      return data;
    }

VFATFrame::word VFATFrame::getEC ( ) const

inline

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

Definition at line 51 of file VFATFrame.h.

References data.

Referenced by Print().

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

VFATFrame::word VFATFrame::getFlags ( ) const

inline

Returns flags.

Definition at line 57 of file VFATFrame.h.

References data.

Referenced by Print().

    {
      return data[10] & 0x000F;
    }

bool VFATFrame::isBCPresent ( ) const

inline

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

Definition at line 75 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 93 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 81 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 87 of file VFATFrame.h.

References presenceFlags.

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

    {
      return presenceFlags & 0x4;
    }

void VFATFrame::Print

(

bool

binary = false

)

const

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

Definition at line 127 of file VFATFrame.cc.

References checkCRC(), checkFootprint(), daqErrorFlags, data, getBC(), getChipID(), getCRC(), getEC(), getFlags(), i, j, presenceFlags, and w.

{
  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::setData

(

const word *

_data

)

Copies a memory block to data buffer.

Definition at line 30 of file VFATFrame.cc.

References data.

Referenced by VFATFrame().

{
  memcpy(data, _data, 24);
}

Member Data Documentation

word VFATFrame::daqErrorFlags

Error flag as given by certain versions of DAQ.

Definition at line 145 of file VFATFrame.h.

Referenced by checkCRC(), Print(), RawDataUnpacker::ProcessVFATDataParallel(), and VFATFrame().

word VFATFrame::data[12]

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 135 of file VFATFrame.h.

Referenced by cuy.FindIssue::__init__(), data_sources.node::__str__(), confdb.HLTProcess::_fix_parameter(), 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(), getActiveChannels(), getBC(), getChipID(), getCRC(), getData(), getEC(), getFlags(), confdb.HLTProcess::getRawConfigurationFromDB(), confdb.HLTProcess::instrumentDQM(), confdb.HLTProcess::instrumentOpenMode(), confdb.HLTProcess::instrumentTiming(), data_sources.json_list::last(), confdb.HLTProcess::loadAdditionalConditions(), confdb.HLTProcess::loadCff(), confdb.HLTProcess::overrideGlobalTag(), confdb.HLTProcess::overrideL1MenuXml(), confdb.HLTProcess::overrideOutput(), confdb.HLTProcess::overrideParameters(), confdb.HLTProcess::overrideProcessName(), Print(), confdb.HLTProcess::runL1Emulator(), setData(), confdb.HLTProcess::specificCustomize(), confdb.HLTProcess::updateMessageLogger(), and VFATFrame().

word VFATFrame::presenceFlags

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)

Definition at line 142 of file VFATFrame.h.

Referenced by isBCPresent(), isCRCPresent(), isECPresent(), isIDPresent(), Print(), RawDataUnpacker::ProcessVFATDataParallel(), and VFATFrame().