Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
//#include "Utilities/Configuration/interface/Architecture.h"
/*  
 *  \author J. Mans -- UMD
 */
#ifndef HTBDAQ_DATA_STANDALONE
#include "EventFilter/HcalRawToDigi/interface/HcalHTRData.h"
#else
#include "HcalHTRData.h"
const int HcalHTRData::CHANNELS_PER_SPIGOT = 24;
const int HcalHTRData::MAXIMUM_SAMPLES_PER_CHANNEL = 20;
#endif
#include <cstring>
#include <cstdio>

HcalHTRData::HcalHTRData() : m_formatVersion(-2), m_rawLength(0), m_rawConst(nullptr), m_ownData(nullptr) {}
HcalHTRData::HcalHTRData(const unsigned short* data, int length) {
  adoptData(data, length);
  m_ownData = nullptr;
}
HcalHTRData::HcalHTRData(const HcalHTRData& hd)
    : m_formatVersion(hd.m_formatVersion), m_rawLength(hd.m_rawLength), m_rawConst(hd.m_rawConst), m_ownData(nullptr) {}

HcalHTRData::HcalHTRData(int version_to_create) : m_formatVersion(version_to_create) { allocate(version_to_create); }

void HcalHTRData::allocate(int version_to_create) {
  m_formatVersion = version_to_create;
  // the needed space is for the biggest possible event...
  const int needed = 0x200;
  // create a buffer big enough...
  m_ownData = new unsigned short[needed];
  // clear isn't really necessary, but it makes valgrind happy
  memset(m_ownData, 0, sizeof(unsigned short) * needed);
  m_rawLength = 0;
  m_rawConst = m_ownData;
}

HcalHTRData& HcalHTRData::operator=(const HcalHTRData& hd) {
  if (m_ownData == nullptr) {
    m_formatVersion = hd.m_formatVersion;
    m_rawLength = hd.m_rawLength;
    m_rawConst = hd.m_rawConst;
  }
  return (*this);
}

void HcalHTRData::adoptData(const unsigned short* data, int length) {
  m_rawLength = length;
  m_rawConst = data;
  if (m_rawLength < 5) {
    m_formatVersion = -2;  // invalid!
  } else {
    // determine format version
    if ((m_rawConst[2] & 0x8000) == 0)
      m_formatVersion = -1;  // original format before versions
    else
      m_formatVersion = (m_rawConst[4] >> 12) & 0xF;
  }
}

// check :: not EE, length is reasonable, length matches wordcount
//          length required for tp+daq is correct

bool HcalHTRData::check() const {
  if (m_formatVersion == -1) {
    // length checks
    //  minimum length
    if (m_rawLength < 6 + 12)
      return false;
    //  matches wordcount
    if (m_rawLength != m_rawConst[m_rawLength - 3])
      return false;
    // empty event check
    if (m_rawConst[2] & 0x20)
      return false;
  } else {
    // length checks
    //  minimum length
    if (m_rawLength < 8 + 4)
      return false;
    if (m_formatVersion <= 3) {
      //  matches wordcount
      if (m_rawLength != m_rawConst[m_rawLength - 3]) {
        if (isHistogramEvent() && m_rawConst[m_rawLength - 3] == 786) {
          // known bug!
        } else
          return false;
      }
    } else {
      // eventually add CRC check
    }
    // empty event check (redundant...)
    if (m_rawConst[2] & 0x4)
      return false;
  }

  if (!isHistogramEvent()) {
    // daq/tp length check
    int tp, daq, header, trailer;
    determineSectionLengths(tp, daq, header, trailer);
    if (tp + daq + header + trailer > m_rawLength)
      return false;
  }

  return true;
}

bool HcalHTRData::isEmptyEvent() const {
  if (m_formatVersion == -1) {
    return (m_rawConst[2] & 0x20) != 0;
  } else {
    return (m_rawConst[2] & 0x4) != 0;
  }
}

bool HcalHTRData::isOverflowWarning() const {
  if (m_formatVersion == -1) {
    return false;  // too old to care.
  } else {
    return (m_rawConst[2] & 0x1) != 0;
  }
}

bool HcalHTRData::isBusy() const {
  if (m_formatVersion == -1) {
    return false;  // too old to care.
  } else {
    return (m_rawConst[2] & 0x2) != 0;
  }
}

void HcalHTRData::determineSectionLengths(int& tpWords, int& daqWords, int& headerWords, int& trailerWords) const {
  if (m_formatVersion == -1) {
    tpWords = m_rawConst[5] >> 8;
    daqWords = CHANNELS_PER_SPIGOT * (m_rawConst[m_rawLength - 4] >> 8);  // always 24 channels, no zero suppresion
    headerWords = 6;
    trailerWords = 12;
  } else {
    tpWords = m_rawConst[5] >> 8;
    if (m_rawLength > 4)
      daqWords = m_rawConst[m_rawLength - 4] & 0x7FF;  // zero suppression supported
    else
      daqWords = 0;  //should there be a warning as well?
    headerWords = 8;
    trailerWords = 4;  // minimum, may be more...
  }
}

void HcalHTRData::determineStaticLengths(int& headerWords, int& trailerWords) const {
  if (m_formatVersion == -1) {
    headerWords = 6;
    trailerWords = 12;
  } else if (m_formatVersion < 5) {
    headerWords = 8;
    trailerWords = 4;  // minimum, may be more...
  } else {
    headerWords = 8;
    trailerWords = 12;  // minimum, may be more...
  }
}

void HcalHTRData::dataPointers(const unsigned short** daq_first,
                               const unsigned short** daq_last,
                               const unsigned short** tp_first,
                               const unsigned short** tp_last) const {
  int tp_words_total, daq_words_total, headerLen, trailerLen;
  determineSectionLengths(tp_words_total, daq_words_total, headerLen, trailerLen);

  *tp_first = m_rawConst + headerLen;
  *tp_last = *tp_first + (tp_words_total - 1);
  *daq_first = *tp_last + 1;
  *daq_last = *daq_first + (daq_words_total - 1);
}

/* using FiberAd[2:0] ChanId[1:0] */
static const int channelDecoder[32] = {0,  1,  2,  99, 3,  4,  5,  99, 6,  7,  8,  99, 9,  10, 11, 99,
                                       12, 13, 14, 99, 15, 16, 17, 99, 18, 19, 20, 99, 21, 22, 23, 99};

void HcalHTRData::unpack(unsigned char* daq_lengths,
                         unsigned short* daq_samples,
                         unsigned char* tp_lengths,
                         unsigned short* tp_samples) const {
  if (daq_lengths != nullptr)
    memset(daq_lengths, 0, CHANNELS_PER_SPIGOT);
  if (tp_lengths != nullptr)
    memset(tp_lengths, 0, CHANNELS_PER_SPIGOT);

  // currently, the major differences between the versions are
  //  -1 : 6 word header, no zero suppression, trailer setup
  //   0 : 8 word header, zero suppression,

  int tp_words_total, daq_words_total, headerLen, trailerLen;
  determineSectionLengths(tp_words_total, daq_words_total, headerLen, trailerLen);

  //  printf("%d %d %d %d\n",tp_words_total,daq_words_total,headerLen,trailerLen);
  int wordPtr;
  const unsigned short* tpBase = m_rawConst + headerLen;
  // process the trigger primitive words
  if (tp_lengths != nullptr) {
    for (wordPtr = 0; wordPtr < tp_words_total; wordPtr++) {
      int ichan = channelDecoder[tpBase[wordPtr] >> 11];
      if (ichan >= 24)
        continue;
      tp_samples[ichan * MAXIMUM_SAMPLES_PER_CHANNEL + tp_lengths[ichan]] = tpBase[wordPtr] & 0x3ff;
      tp_lengths[ichan]++;
    }
  }

  const unsigned short* daqBase = m_rawConst + headerLen + tp_words_total;
  // process the DAQ words [ assumes that data from one channel will always be together ]
  int lastChan = -1;
  int lastCapid = 0;
  if (daq_lengths != nullptr) {
    for (wordPtr = 0; wordPtr < daq_words_total; wordPtr++) {
      int ichan = channelDecoder[daqBase[wordPtr] >> 11];
      if (ichan >= 24)
        continue;
      int capid = (daqBase[wordPtr] & 0x180) >> 7;
      int erdv = (daqBase[wordPtr] & 0x600) >> 9;
      if (erdv != 0x1 || (lastChan == ichan && (capid != ((lastCapid + 1) % 4)))) {
        daq_lengths[ichan] |= 0x80;
      }
      lastChan = ichan;
      lastCapid = capid;

      int useLength = daq_lengths[ichan] & 0x1F;
      //     printf("%d %d\n",ichan,useLength);
      daq_samples[ichan * MAXIMUM_SAMPLES_PER_CHANNEL + useLength] = daqBase[wordPtr] & 0x3ff;
      daq_lengths[ichan] = (useLength + 1) | (daq_lengths[ichan] & 0xE0);  // keep the error bits
    }
  }
}

void HcalHTRData::pack(unsigned char* daq_lengths,
                       unsigned short* daq_samples,
                       unsigned char* tp_lengths,
                       unsigned short* tp_samples,
                       bool do_capid) {
  int tp_words_total = 0, daq_words_total = 0, headerLen, trailerLen;
  determineStaticLengths(headerLen, trailerLen);

  tp_words_total = 0;
  daq_words_total = 0;
  int ichan, isample;

  // trigger primitive words
  unsigned short* ptr = m_ownData + headerLen;
  if (tp_samples != nullptr && tp_lengths != nullptr) {
    for (ichan = 0; ichan < 24; ichan++) {
      unsigned short chanid = ((ichan % 4) + (((ichan / 4) + 1) << 2)) << 11;
      for (isample = 0; isample < tp_lengths[ichan] && isample < MAXIMUM_SAMPLES_PER_CHANNEL; isample++) {
        ptr[tp_words_total] = chanid | (tp_samples[ichan * MAXIMUM_SAMPLES_PER_CHANNEL + isample] & 0x3FF);
        tp_words_total++;
      }
    }
  }

  // daq words
  ptr = m_ownData + headerLen + tp_words_total;
  for (ichan = 0; ichan < 24; ichan++) {
    unsigned short chanid = ((ichan % 3) + ((ichan / 3) << 2)) << 11;
    for (isample = 0; isample < daq_lengths[ichan] && isample < MAXIMUM_SAMPLES_PER_CHANNEL; isample++) {
      unsigned short basedata = daq_samples[ichan * MAXIMUM_SAMPLES_PER_CHANNEL + isample] & 0x7FF;
      if (do_capid)
        basedata = (basedata & 0x7F) | (0x200) | ((isample % 4) << 7);
      ptr[daq_words_total] = chanid | basedata;
      daq_words_total++;
    }
  }
  unsigned short totalLen;
  if (m_formatVersion == -1) {
    m_ownData[5] = (tp_words_total << 8) | 0x1;
    totalLen = headerLen + tp_words_total + daq_words_total + trailerLen;
    m_rawLength = totalLen;
    m_ownData[totalLen - 3] = totalLen;
    m_ownData[totalLen - 4] = (tp_words_total / CHANNELS_PER_SPIGOT) | ((daq_words_total / CHANNELS_PER_SPIGOT) << 8);
  } else {
    m_ownData[5] = (tp_words_total << 8) | 0x1;
    totalLen = headerLen + tp_words_total + daq_words_total + trailerLen;
    if ((totalLen % 2) == 1) {
      m_ownData[totalLen - 4] = 0xFFFF;  // parity word
      totalLen++;                        // round to even number of 16-bit words
    }
    m_rawLength = totalLen;
    m_ownData[totalLen - 2] = totalLen / 2;  // 32-bit words
    m_ownData[totalLen - 3] = totalLen;
    m_ownData[totalLen - 4] = daq_words_total;
  }
  if (trailerLen == 12) {  // initialize extra trailer words if present
    for (int i = 12; i > 4; i--)
      m_ownData[totalLen - i] = 0;
  }
}

void HcalHTRData::packHeaderTrailer(int L1Anumber,
                                    int bcn,
                                    int submodule,
                                    int orbitn,
                                    int pipeline,
                                    int ndd,
                                    int nps,
                                    int firmwareRev,
                                    int firmwareFlav) {
  m_ownData[0] = L1Anumber & 0xFF;
  m_ownData[1] = (L1Anumber & 0xFFFF00) >> 8;
  if (m_formatVersion == -1) {
    m_ownData[2] = ((pipeline & 0x7F) << 8);  // no error bits
    m_ownData[3] = ((orbitn & 0xFF) << 8) | (submodule & 0xFF);
    m_ownData[4] = bcn & 0xFFF;
    //    m_ownData[5]&=0xFF01;
  } else {
    m_ownData[2] = 0x8000;  // Version is valid, no error bits
    if (m_formatVersion == 0)
      m_ownData[3] = ((orbitn & 0x3F) << 10) | (submodule & 0x3FF);
    else
      m_ownData[3] = ((orbitn & 0x1F) << 11) | (submodule & 0x7FF);
    m_ownData[4] = ((m_formatVersion & 0xF) << 12) | (bcn & 0xFFF);
    m_ownData[5] |= ((nps & 0x1F) << 3) | 0x1;
    m_ownData[6] = ((firmwareRev & 0x70000) >> 3) | (firmwareRev & 0x1FFF);
    m_ownData[7] = (pipeline & 0xFF) | ((firmwareFlav & 0x3F) << 8);
    m_ownData[m_rawLength - 4] &= 0x7FF;
    m_ownData[m_rawLength - 4] |= (ndd & 0x1F) << 11;
  }
  m_ownData[m_rawLength - 2] = m_rawLength / 2;  // 32-bit words
  m_ownData[m_rawLength - 1] = (L1Anumber & 0xFF) << 8;
}

void HcalHTRData::packUnsuppressed(const bool* mp) {
  if (m_formatVersion < 4)
    return;

  for (int fiber = 1; fiber <= 8; fiber++) {
    for (int fiberchan = 0; fiberchan <= 2; fiberchan++) {
      int linchan = (fiber - 1) * 3 + fiberchan;

      unsigned short& val = m_ownData[m_rawLength - 12 + (linchan / 8)];
      if (mp[linchan])
        val |= 1 << (linchan % 8);
    }
  }

  // set the unsupressed bit
  m_ownData[6] |= 0x8000;
}

unsigned int HcalHTRData::getOrbitNumber() const {
  switch (m_formatVersion) {
    case (-1):
      return (m_rawConst[3] >> 8);
    case (0):
      return (m_rawConst[3] >> 10);
    default:
      return (m_rawConst[3] >> 11);
  }
}
unsigned int HcalHTRData::getSubmodule() const {
  switch (m_formatVersion) {
    case (-1):
      return (m_rawConst[3] & 0xFF);
    case (0):
      return (m_rawConst[3] & 0x3FF);
    default:
      return (m_rawConst[3] & 0x7FF);
  }
}
unsigned int HcalHTRData::htrSlot() const {
  const unsigned int smid = getSubmodule();
  return ((smid >> 1) & 0x1F);
}
unsigned int HcalHTRData::htrTopBottom() const {
  const unsigned int smid = getSubmodule();
  return (smid & 0x01);
}
unsigned int HcalHTRData::readoutVMECrateId() const {
  const unsigned int smid = getSubmodule();
  return ((smid >> 6) & 0x1F);
}
bool HcalHTRData::isCalibrationStream() const { return (m_formatVersion == -1) ? (false) : (m_rawConst[2] & 0x4000); }
bool HcalHTRData::isUnsuppressed() const { return (m_formatVersion < 4) ? (false) : (m_rawConst[6] & 0x8000); }
bool HcalHTRData::wasMarkAndPassZS(int fiber, int fiberchan) const {
  if (fiber < 1 || fiber > 8 || fiberchan < 0 || fiberchan > 2)
    return false;
  if (!isUnsuppressed() || m_formatVersion < 5)
    return false;
  int linchan = (fiber - 1) * 3 + fiberchan;

  unsigned short val = m_rawConst[m_rawLength - 12 + (linchan / 8)];
  return ((val >> (linchan % 8)) & 0x1) != 0;
}
bool HcalHTRData::wasMarkAndPassZSTP(int slb, int slbchan) const {
  if (slb < 1 || slb > 6 || slbchan < 0 || slbchan > 3)
    return false;
  if (!isUnsuppressed() || m_formatVersion < 5)
    return false;
  int linchan = (slb - 1) * 4 + slbchan;

  unsigned short val = m_rawConst[m_rawLength - 12 + (linchan / 8)];
  return ((val >> (linchan % 8)) & 0x100) != 0;
}

uint32_t HcalHTRData::zsBunchMask() const {
  uint32_t mask = 0;
  if (isUnsuppressed() && m_formatVersion >= 5) {
    mask = m_rawConst[m_rawLength - 5] | ((m_rawConst[m_rawLength - 6] & 0xF000) << 4);
  }
  return mask;
}

bool HcalHTRData::isPatternRAMEvent() const { return (m_formatVersion == -1) ? (false) : (m_rawConst[2] & 0x1000); }
bool HcalHTRData::isHistogramEvent() const {
  return (m_formatVersion == -1) ? (m_rawConst[2] & 0x2) : (m_rawConst[2] & 0x2000);
}
int HcalHTRData::getNDD() const {
  return (m_formatVersion == -1) ? (m_rawConst[m_rawLength - 4] >> 8) : (m_rawConst[m_rawLength - 4] >> 11);
}
int HcalHTRData::getNTP() const {
  int retval = -1;
  if (m_formatVersion == -1)
    retval = m_rawConst[m_rawLength - 4] & 0xFF;
  else if (m_formatVersion < 3)
    retval = m_rawConst[m_rawLength - 4] >> 11;
  return retval;
}
int HcalHTRData::getNPrecisionWords() const {
  return (m_formatVersion == -1) ? (m_rawConst[m_rawLength - 4] & 0xFF) : (m_rawConst[m_rawLength - 4] & 0x7FF);
}
int HcalHTRData::getNPS() const { return (m_formatVersion == -1) ? (0) : ((m_rawConst[5] >> 3) & 0x1F); }
unsigned int HcalHTRData::getPipelineLength() const {
  return (m_formatVersion == -1) ? (m_rawConst[2] >> 8) : (m_rawConst[7] & 0xFF);
}
unsigned int HcalHTRData::getFirmwareRevision() const {
  return (m_formatVersion == -1) ? (0) : ((m_rawConst[6] & 0x1FFF) + ((m_rawConst[6] & 0xE000) << 3));
}
int HcalHTRData::getFirmwareFlavor() const { return (m_formatVersion < 2) ? (-1) : ((m_rawConst[7] >> 8) & 0xFF); }

void HcalHTRData::getHistogramFibers(int& a, int& b) const {
  a = -1;
  b = -1;
  if (m_formatVersion == -1) {
    a = ((m_rawConst[2] & 0x0F00) >> 8);
    b = ((m_rawConst[2] & 0xF000) >> 12);
  } else {
    a = ((m_rawConst[5] & 0x0F00) >> 8) + 1;
    b = ((m_rawConst[5] & 0xF000) >> 12) + 1;
  }
}

bool HcalHTRData::wasHistogramError(int ifiber) const {
  bool retval = !isHistogramEvent();
  if (!retval) {
    retval = ((m_rawConst[7]) & (1 << ifiber)) != 0;
  }
  return retval;
}

bool HcalHTRData::unpack_per_channel_header(
    unsigned short header, int& flav, int& error_flags, int& capid0, int& channelid) {
  flav = (header >> 12) & 0x7;
  error_flags = (header >> 10) & 0x3;
  capid0 = (header >> 8) & 0x3;
  channelid = (header) & 0xFF;
  return (header & 0x8000) != 0;
}

bool HcalHTRData::unpackHistogram(int myfiber, int mysc, int capid, unsigned short* histogram) const {
  // check for histogram mode
  if (!isHistogramEvent())
    return false;

  int fiber1, fiber2;
  getHistogramFibers(fiber1, fiber2);
  if (fiber1 != myfiber && fiber2 != myfiber)
    return false;

  if (m_formatVersion == -1) {
    int offset = 6 + mysc * 4 * 32 + capid * 32;
    if (myfiber == fiber2)
      offset += 3 * 4 * 32;  // skip to the second half...
    for (int i = 0; i < 32; i++)
      histogram[i] = m_rawConst[offset + i];
    return true;
  } else {
    int offset = 8 + mysc * 4 * 32 + capid * 32;
    if (myfiber == fiber2)
      offset += 3 * 4 * 32;  // skip to the second half...
    for (int i = 0; i < 32; i++)
      histogram[i] = m_rawConst[offset + i];
    return true;
  }
}