RawDataUnpacker.cc

Go to the documentation of this file.

/****************************************************************************
*
* This is a part of TOTEM offline software.
* Authors:
*   Jan Kašpar (jan.kaspar@gmail.com)
*   Nicola Minafra
*
****************************************************************************/

#include "EventFilter/CTPPSRawToDigi/interface/RawDataUnpacker.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "DataFormats/FEDRawData/interface/FEDNumbering.h"

//----------------------------------------------------------------------------------------------------

using namespace std;
using namespace edm;
using namespace ctpps;

//----------------------------------------------------------------------------------------------------

RawDataUnpacker::RawDataUnpacker(const edm::ParameterSet& iConfig) :
  verbosity(iConfig.getUntrackedParameter<unsigned int>("verbosity", 0))
{}

//----------------------------------------------------------------------------------------------------

int RawDataUnpacker::run(int fedId, const FEDRawData &data, vector<TotemFEDInfo> &fedInfoColl, SimpleVFATFrameCollection &coll) const
{
  unsigned int size_in_words = data.size() / 8; // bytes -> words
  if (size_in_words < 2)
  {
    if (verbosity)
      LogWarning("Totem") << "Error in RawDataUnpacker::run > " <<
        "Data in FED " << fedId << " too short (size = " << size_in_words << " words).";
    return 1;
  }

  fedInfoColl.push_back(TotemFEDInfo(fedId));

  return processOptoRxFrame((const word *) data.data(), size_in_words, fedInfoColl.back(), &coll);
}

//----------------------------------------------------------------------------------------------------

int RawDataUnpacker::processOptoRxFrame(const word *buf, unsigned int frameSize, TotemFEDInfo &fedInfo, SimpleVFATFrameCollection *fc) const
{
  // get OptoRx metadata
  unsigned long long head = buf[0];
  unsigned long long foot = buf[frameSize-1];

  fedInfo.setHeader(head);
  fedInfo.setFooter(foot);

  unsigned int boe = (head >> 60) & 0xF;
  unsigned int h0 = (head >> 0) & 0xF;

  unsigned long lv1 = (head >> 32) & 0xFFFFFF;
  unsigned long bx = (head >> 20) & 0xFFF;
  unsigned int optoRxId = (head >> 8) & 0xFFF;
  unsigned int fov = (head >> 4) & 0xF;

  unsigned int eoe = (foot >> 60) & 0xF;
  unsigned int f0 = (foot >> 0) & 0xF;
  unsigned int fSize = (foot >> 32) & 0x3FF;

  // check header and footer structure
  if (boe != 5 || h0 != 0 || eoe != 10 || f0 != 0 || fSize != frameSize)
  {
    if (verbosity)
      LogWarning("Totem") << "Error in RawDataUnpacker::processOptoRxFrame > " << "Wrong structure of OptoRx header/footer: "
        << "BOE=" << boe << ", H0=" << h0 << ", EOE=" << eoe << ", F0=" << f0
        << ", size (OptoRx)=" << fSize << ", size (DATE)=" << frameSize
        << ". OptoRxID=" << optoRxId << ". Skipping frame." << endl;
    return 0;
  }

  LogDebug( "Totem" ) << "RawDataUnpacker::processOptoRxFrame: "
    << "OptoRxId = " << optoRxId << ", BX = " << bx << ", LV1 = " << lv1 << ", frameSize = " << frameSize;

  if (optoRxId >= FEDNumbering::MINTotemRPTimingVerticalFEDID && optoRxId <= FEDNumbering::MAXTotemRPTimingVerticalFEDID)
  {
    processOptoRxFrameSampic(buf, frameSize, fedInfo, fc);
    return 0;
  }

  // parallel or serial transmission?
  switch (fov) {
    case 1:
      return processOptoRxFrameSerial(buf, frameSize, fc);
    case 2:
    case 3:
      return processOptoRxFrameParallel(buf, frameSize, fedInfo, fc);
    default: break;
  }

  if (verbosity)
    LogWarning("Totem") << "Error in RawDataUnpacker::processOptoRxFrame > " << "Unknown FOV = " << fov << endl;

  return 0;
}

//----------------------------------------------------------------------------------------------------

int RawDataUnpacker::processOptoRxFrameSerial(const word *buf, unsigned int frameSize, SimpleVFATFrameCollection *fc) const
{
  // get OptoRx metadata
  unsigned int optoRxId = (buf[0] >> 8) & 0xFFF;

  // get number of subframes
  unsigned int subFrames = (frameSize - 2) / 194;

  // process all sub-frames
  unsigned int errorCounter = 0;
  for (unsigned int r = 0; r < subFrames; ++r)
  {
    for (unsigned int c = 0; c < 4; ++c)
    {
      unsigned int head = (buf[1 + 194 * r] >> (16 * c)) & 0xFFFF;
      unsigned int foot = (buf[194 + 194 * r] >> (16 * c)) & 0xFFFF;

      LogDebug( "Totem" )
        << "r = " << r << ", c = " << c << ": "
        << "S = " << ( head & 0x1 ) << ", BOF = " << ( head >> 12 ) << ", EOF = " << ( foot >> 12 )
        << ", ID = " << ( ( head >> 8 ) & 0xF ) << ", ID' = " << ( ( foot >> 8) & 0xF );

      // stop if this GOH is NOT active
      if ((head & 0x1) == 0)
        continue;

      LogDebug( "Totem" )
        << "Header active (" << head << " -> " << ( head & 0x1 ) << ").";

      // check structure
      if (head >> 12 != 0x4 || foot >> 12 != 0xB || ((head >> 8) & 0xF) != ((foot >> 8) & 0xF))
      {
        std::ostringstream oss;
        if (head >> 12 != 0x4)
          oss << "\n\tHeader is not 0x4 as expected (0x" << std::hex << head << ").";
        if (foot >> 12 != 0xB)
          oss << "\n\tFooter is not 0xB as expected (0x" << std::hex << foot << ").";
        if (((head >> 8) & 0xF) != ((foot >> 8) & 0xF))
          oss << "\n\tIncompatible GOH IDs in header (0x" << std::hex << ( ( head >> 8 ) & 0xF ) << ") and footer (0x" << std::hex << ( ( foot >> 8 ) & 0xF ) << ").";

        if (verbosity)
          LogWarning("Totem") << "Error in RawDataUnpacker::processOptoRxFrame > " << "Wrong payload structure (in GOH block row " << r <<
            " and column " << c << ") in OptoRx frame ID " << optoRxId << ". GOH block omitted." << oss.str() << endl;

        errorCounter++;
        continue;
      }

      // allocate memory for VFAT frames
      unsigned int goh = (head >> 8) & 0xF;
      vector<VFATFrame::word*> dataPtrs;
      for (unsigned int fi = 0; fi < 16; fi++)
      {
        TotemFramePosition fp(0, 0, optoRxId, goh, fi);
        dataPtrs.push_back( fc->InsertEmptyFrame(fp)->getData() );
      }

      LogDebug( "Totem" )
        << "transposing GOH block at prefix: " << ( optoRxId*192+goh*16 ) << ", dataPtrs = " << dataPtrs;

      // deserialization
      for (int i = 0; i < 192; i++)
      {
        int iword = 11 - i / 16;  // number of current word (11...0)
        int ibit = 15 - i % 16;   // number of current bit (15...0)
        unsigned int w = (buf[i + 2 + 194 * r] >> (16 * c)) & 0xFFFF;

        // Fill the current bit of the current word of all VFAT frames
        for (int idx = 0; idx < 16; idx++)
        {
          if (w & (1 << idx))
            dataPtrs[idx][iword] |= (1 << ibit);
        }
      }
    }
  }

  return errorCounter;
}

//----------------------------------------------------------------------------------------------------

int RawDataUnpacker::processOptoRxFrameParallel(const word *buf, unsigned int frameSize, TotemFEDInfo &fedInfo, SimpleVFATFrameCollection *fc) const
{
  // get OptoRx metadata
  unsigned long long head = buf[0];
  unsigned int optoRxId = (head >> 8) & 0xFFF;

  // recast data as buffer or 16bit words, skip header
  const uint16_t *payload = (const uint16_t *) (buf + 1);

  // read in OrbitCounter block
  const uint32_t *ocPtr = (const uint32_t *) payload;
  fedInfo.setOrbitCounter(*ocPtr);
  payload += 2;

  // size in 16bit words, without header, footer and orbit counter block
  unsigned int nWords = (frameSize-2) * 4 - 2;

  // process all VFAT data
  for (unsigned int offset = 0; offset < nWords;)
  {
    unsigned int wordsProcessed = processVFATDataParallel(payload + offset, nWords, optoRxId, fc);
    offset += wordsProcessed;
  }

  return 0;
}

//----------------------------------------------------------------------------------------------------

int RawDataUnpacker::processVFATDataParallel(const uint16_t *buf, unsigned int maxWords, unsigned int optoRxId, SimpleVFATFrameCollection *fc) const
{
  // start counting processed words
  unsigned int wordsProcessed = 1;

  // padding word? skip it
  if (buf[0] == 0xFFFF)
    return wordsProcessed;

  // check header flag
  unsigned int hFlag = (buf[0] >> 8) & 0xFF;
  if (hFlag != vmCluster && hFlag != vmRaw && hFlag != vmDiamondCompact)
  {
    if (verbosity)
      LogWarning("Totem") << "Error in RawDataUnpacker::processVFATDataParallel > "
        << "Unknown header flag " << hFlag << ". Skipping this word." << endl;
    return wordsProcessed;
  }

  // compile frame position
  // NOTE: DAQ group uses terms GOH and fiber in the other way
  unsigned int gohIdx = (buf[0] >> 4) & 0xF;
  unsigned int fiberIdx = (buf[0] >> 0) & 0xF;
  TotemFramePosition fp(0, 0, optoRxId, gohIdx, fiberIdx);

  // prepare temporary VFAT frame
  VFATFrame f;
  VFATFrame::word *fd = f.getData();

  // copy footprint, BC, EC, Flags, ID, if they exist
  uint8_t presenceFlags = 0;

  if (((buf[wordsProcessed] >> 12) & 0xF) == 0xA)  // BC
  {
    presenceFlags |= 0x1;
    fd[11] = buf[wordsProcessed];
    wordsProcessed++;
  }

  if (((buf[wordsProcessed] >> 12) & 0xF) == 0xC)  // EC, flags
  {
    presenceFlags |= 0x2;
    fd[10] = buf[wordsProcessed];
    wordsProcessed++;
  }

  if (((buf[wordsProcessed] >> 12) & 0xF) == 0xE)  // ID
  {
    presenceFlags |= 0x4;
    fd[9] = buf[wordsProcessed];
    wordsProcessed++;
  }

  // save offset where channel data start
  unsigned int dataOffset = wordsProcessed;

  // find trailer
  switch (hFlag) {
    case vmCluster: {
      unsigned int nCl = 0;
      while ( (buf[wordsProcessed + nCl] >> 12) != 0xF && ( wordsProcessed + nCl < maxWords ) ) nCl++;
      wordsProcessed += nCl;
    } break;
    case vmRaw:
      wordsProcessed += 9;
      break;
    case vmDiamondCompact: {
      wordsProcessed--;
      while ( (buf[wordsProcessed] & 0xFFF0)!= 0xF000 && ( wordsProcessed < maxWords ) ) wordsProcessed++;
    } break;
  }

  // process trailer
  unsigned int tSig = buf[wordsProcessed] >> 12;
  unsigned int tErrFlags = (buf[wordsProcessed] >> 8) & 0xF;
  unsigned int tSize = buf[wordsProcessed] & 0xFF;

  f.setDAQErrorFlags(tErrFlags);

  // consistency checks
  bool skipFrame = false;
  stringstream ess;

  if (tSig != 0xF)
  {
    if (verbosity)
      ess << "    Wrong trailer signature (" << tSig << ")." << endl;
    skipFrame = true;
  }

  if (tErrFlags != 0)
  {
    if (verbosity)
      ess << "    Error flags not zero (" << tErrFlags << ")." << endl;
    skipFrame = true;
  }

  wordsProcessed++;

  if (tSize != wordsProcessed)
  {
    if (verbosity)
        ess << "    Trailer size (" << tSize << ") does not match with words processed (" << wordsProcessed << ")." << endl;
    skipFrame = true;
  }

  if (skipFrame)
  {
    if (verbosity)
      LogWarning("Totem") << "Error in RawDataUnpacker::processVFATDataParallel > Frame at " << fp
        << " has the following problems and will be skipped.\n" << endl << ess.rdbuf();

    return wordsProcessed;
  }

  // get channel data - cluster mode
  if (hFlag == vmCluster)
  {
    for (unsigned int nCl = 0; (buf[dataOffset + nCl] >> 12) != 0xF && ( dataOffset + nCl < maxWords ); ++nCl)
    {
      const uint16_t &w = buf[dataOffset + nCl];
      unsigned int upperBlock = w >> 8;
      unsigned int clSize = upperBlock & 0x7F;
      unsigned int clPos = (w >> 0) & 0xFF;

      // special case: upperBlock=0xD0 => numberOfClusters
      if (upperBlock == 0xD0)
      {
        presenceFlags |= 0x10;
        f.setNumberOfClusters(clPos);
        continue;
      }

      // special case: size=0 means chip full
      if (clSize == 0)
        clSize = 128;

      // activate channels
      //  convention - range <pos, pos-size+1>
      signed int chMax = clPos;
      signed int chMin = clPos - clSize + 1;
      if (chMax < 0 || chMax > 127 || chMin < 0 || chMin > 127 || chMin > chMax)
      {
        if (verbosity)
          LogWarning("Totem") << "Error in RawDataUnpacker::processVFATDataParallel > "
            << "Invalid cluster (pos=" << clPos
            << ", size=" << clSize << ", min=" << chMin << ", max=" << chMax << ") at " << fp
            <<". Skipping this cluster." << endl;
        continue;
      }

      for (signed int ch = chMin; ch <= chMax; ch++)
      {
        unsigned int wi = ch / 16;
        unsigned int bi = ch % 16;
        fd[wi + 1] |= (1 << bi);
      }
    }
  }

  // get channel data and CRC - raw mode
  if (hFlag == vmRaw)
  {
    for (unsigned int i = 0; i < 8; i++)
      fd[8 - i] = buf[dataOffset + i];

    // copy CRC
    presenceFlags |= 0x8;
    fd[0] = buf[dataOffset + 8];
  }

  // get channel data for diamond compact mode
  if (hFlag == vmDiamondCompact)
  {
    for (unsigned int i = 1; (buf[i+1] & 0xFFF0)!= 0xF000 && ( i+1 < maxWords ); i++) {
      if ( ( buf[i] & 0xF000 ) == VFAT_HEADER_OF_EC ) {
        // Event Counter word is found
        fd[10] = buf[i];
        continue;
      }
      switch ( buf[i] & 0xF800 ) {
        case VFAT_DIAMOND_HEADER_OF_WORD_2:
          // word 2 of the diamond VFAT frame is found
          fd[1] = buf[i + 1];
          fd[2] = buf[i];
          break;
        case VFAT_DIAMOND_HEADER_OF_WORD_3:
          // word 3 of the diamond VFAT frame is found
          fd[3] = buf[i];
          fd[4] = buf[i - 1];
          break;
        case VFAT_DIAMOND_HEADER_OF_WORD_5:
          // word 5 of the diamond VFAT frame is found
          fd[5] = buf[i];
          fd[6] = buf[i - 1];
          break;
        case VFAT_DIAMOND_HEADER_OF_WORD_7:
          // word 7 of the diamond VFAT frame is found
          fd[7] = buf[i];
          fd[8] = buf[i - 1];
          break;
        default:
          break;
      }
      presenceFlags |= 0x8;
    }
  }

  // save frame to output
  f.setPresenceFlags(presenceFlags);
  fc->Insert(fp, f);

  return wordsProcessed;
}

//----------------------------------------------------------------------------------------------------

int RawDataUnpacker::processOptoRxFrameSampic(const word *buf, unsigned int frameSize, TotemFEDInfo &fedInfo, SimpleVFATFrameCollection *fc) const
{
  unsigned int optoRxId = (buf[0] >> 8) & 0xFFF;

  LogDebug( "RawDataUnpacker::processOptoRxFrameSampic" )
    << "Processing sampic frame: OptoRx " << optoRxId << "   framesize: " << frameSize;

  unsigned int orbitCounterVFATFrameWords = 6;
  unsigned int sizeofVFATPayload = 12;

  const VFATFrame::word *VFATFrameWordPtr = (const VFATFrame::word *) buf;
  VFATFrameWordPtr += orbitCounterVFATFrameWords - 1;

  LogDebug( "RawDataUnpacker::processOptoRxFrameSampic" )
    << "Framesize: " << frameSize << "\tframes: " << frameSize/(sizeofVFATPayload+2);

  unsigned int nWords = (frameSize-2) * 4 - 2;

  for (unsigned int i=1; i*(sizeofVFATPayload+2)<nWords; ++i) {
    // compile frame position
    // NOTE: DAQ group uses terms GOH and fiber in the other way
    unsigned int fiberIdx = (*(++VFATFrameWordPtr)) & 0xF;
    unsigned int gohIdx = (*VFATFrameWordPtr >> 4) & 0xF;
    TotemFramePosition fp(0, 0, optoRxId, gohIdx, fiberIdx);

    LogDebug( "RawDataUnpacker::processOptoRxFrameSampic" )
      << "OptoRx: " << optoRxId << " Goh: " << gohIdx << " Idx: " << fiberIdx;

    // prepare temporary VFAT frame
    VFATFrame frame(++VFATFrameWordPtr);
    VFATFrameWordPtr += sizeofVFATPayload;

    if ( *(VFATFrameWordPtr) != 0xf00e ) {
      edm::LogError( "RawDataUnpacker::processOptoRxFrameSampic" )
        << "Wrong trailer " << *VFATFrameWordPtr;
      continue;
    }
    // save frame to output
    frame.setPresenceFlags(1);
    fc->Insert(fp, frame);

    LogDebug( "RawDataUnpacker::processOptoRxFrameSampic" )
      << "Trailer: " << std::hex << *VFATFrameWordPtr;
  }

  return 0;
}