PXDPackerErrModule.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#include <pxd/unpacking/PXDRawDataDefinitions.h>
#include <pxd/modules/pxdUnpacking/PXDPackerErrModule.h>
#include <rawdata/dataobjects/RawPXD.h>
#include <pxd/dataobjects/PXDDAQStatus.h>
#include <framework/datastore/DataStore.h>
#include <framework/logging/Logger.h>
#include <framework/dataobjects/EventMetaData.h>
#include <framework/datastore/StoreObjPtr.h>
#include <framework/core/ModuleParam.templateDetails.h>
 
#include <boost/crc.hpp>
 
#include <numeric>
 
#include <TRandom.h>
 
using namespace std;
using namespace Belle2;
using namespace Belle2::PXD;
using namespace Belle2::PXD::PXDError;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(PXDPackerErr);
 
 
using boost::crc_optimal;
typedef crc_optimal<32, 0x04C11DB7, 0, 0, false, false> dhc_crc_32_type;

std::vector <PXDErrorFlags> PXDPackerErrModule::m_errors =  {
  // Event 0 does not exist...
  c_NO_ERROR,
  /*  1 - HLT-Onsen Trigger differs from Meta (meta changed! thus all differ)
   *  2 - HLT-Onsen Trigger is zero
   *  3 - Run Nr differs between HLT-Onsen and Meta
   *  4 - Subrun Nr differs between HLT-Onsen and Meta
   *  5 - Exp differs between HLT-Onsen and Meta */
  c_META_MM | c_META_MM_DHC | c_META_MM_DHE | c_META_MM_ONS_HLT | c_META_MM_ONS_DC,
  c_META_MM | c_META_MM_DHC | c_META_MM_DHE | c_META_MM_ONS_HLT | c_META_MM_ONS_DC,
  c_META_MM_DHC_ERS | c_META_MM_ONS_HLT | c_META_MM_ONS_DC,
  c_META_MM_DHC_ERS | c_META_MM_ONS_HLT | c_META_MM_ONS_DC,
  c_META_MM_DHC_ERS | c_META_MM_ONS_HLT | c_META_MM_ONS_DC,
  /*  6 - Wrong ONS Trigger frame length
   *  7 - Wrong DHC Start frame length
   *  8 - Wrong DHC End frame length
   *  9 - Wrong DHE Start frame length
   * 10 - Wrong DHE End frame length */
  c_FIX_SIZE, // TODO why mismatch?
  c_FIX_SIZE, // TODO Problem
  c_FIX_SIZE, // TODO why is DHC End missing not detected?
  c_FIX_SIZE, // TODO why is DHE Start missing not detected?
  c_FIX_SIZE, // TODO why is DHE End missing not detected?
  /* 11 - Wrong DHE Start frame length (by 2 bytes), unalign 32 bit frame
   * 12 - Missing ONS Trig frame
   * 13 - Missing DHC Start frame
   * 14 - Missing DHC End frame
   * 15 - Missing DHE Start frame */
  c_FRAME_SIZE, // TODO can check more errors
  c_ONSEN_TRG_FIRST | c_DHC_START_SECOND | c_DHE_START_THIRD | c_EVENT_STRUCT, // TODO
  c_DHC_START_SECOND, // TODO
  c_DHC_END_MISS,
  c_DHE_END_WO_START | c_DHE_START_THIRD, // TODO
  /* 16 - Missing DHE End frame
   * 17 - Double ONS Trig frame
   * 18 - Double DHC Start frame
   * 19 - Double DHC End frame
   * 20 - Double DHE Start frame*/
  c_DHE_START_WO_END, // TODO if two DHE, another error condition should trigger, too
  c_ONSEN_TRG_FIRST | c_DHC_START_SECOND | c_DHE_START_THIRD | c_EVENT_STRUCT, // TODO why data outside of ...
  c_DHC_START_SECOND | c_DHE_START_THIRD, // TODO why data outside of ...
  c_DHC_END_DBL, // TODO
  c_DHE_WRONG_ID_SEQ | c_DHE_START_WO_END, // TODO
  /* 21 - Double DHE End frame
   * 22 - DATCON triggernr+1
   * 23 - HLT Magic broken
   * 24 - DATCON Magic broken
   * 25 - HLT with Accepted not set */
  c_DHE_END_WO_START | c_DHE_START_END_ID, // TODO
  c_MERGER_TRIGNR | c_META_MM_ONS_DC,
  c_HLTROI_MAGIC,
  c_HLTROI_MAGIC,
  c_NO_ERROR | c_NOTSENDALL_TYPE, // TODO =============================================== CHECK TODO Unpacker is not detecting this yet
  /* 26 - HLT triggernr+1
   * 27 - CRC error in second frame (DHC start)
   * 28 - data for all DHE even if disabled in mask
   * 29 - no DHE at all, even so mask tell us otherwise
   * 30 - no DHC at all */
  c_MERGER_TRIGNR | c_META_MM_ONS_HLT,
  c_DHE_CRC, // TODO why DHE start missing not detected?
  c_DHE_ACTIVE, // TODO  why  | c_DHE_WRONG_ID_SEQ | c_DHE_ID_INVALID,
  c_DHE_START_THIRD | c_DHE_ACTIVE,
  c_DHC_END_MISS, // TODO need some better checks
  /* 31 - DHC end has wrong DHC id
   * 32 - DHE end has wrong DHE id
   * 33 - DHC wordcount wrong by 4 bytes
   * 34 - DHE wordcount wrong by 4 bytes
   * 35 - DHE Trigger Nr Hi word messed up */
  c_DHC_DHCID_START_END_MM,
  c_DHE_START_END_ID,
  c_DHC_WIE,
  c_DHE_WIE,
  c_META_MM_DHE,
  /* 36 - ONS Trigger Nr Hi word messed up
   * 37 - DHP data, even if mask says no DHP TODO Check
   * 38 - No DHP data, even if mask tell otherwise
   * 39 - DHE id differ in DHE and DHP header
   * 40 - Chip ID differ in DHE and DHP header */
  c_META_MM_ONS_HLT | c_MERGER_TRIGNR,
  c_NO_ERROR, // TODO ===========================================TODO Unpacker is not detecting this
  c_DHP_ACTIVE,
  c_DHE_DHP_DHEID,
  c_DHE_DHP_PORT,
  /* 41 - Row overflow by 1
   * 42 - Col overflow by 1
   * 43 - Missing Start Row (Pixel w/o row)
   * 44 - No PXD raw packet at all
   * 45 - No DATCON data */
  c_ROW_OVERFLOW,
  c_COL_OVERFLOW,
  c_DHP_PIX_WO_ROW,
  c_NO_PXD,
  c_NO_DATCON,
  /* 46 - unused frame type: common mode
   * 47 - unused frame type: FCE
   * 48 - unused frame type: ONS FCE
   * 49 - unused frame type: 0x7
   * 50 - unused frame type: 0x8 */
  c_UNEXPECTED_FRAME_TYPE,
  c_UNEXPECTED_FRAME_TYPE,
  c_UNEXPECTED_FRAME_TYPE,
  c_DHC_UNKNOWN,
  c_DHC_UNKNOWN,
  /* 51 - unused frame type: 0xA
   * 52 - Rows w/o Pixel (several rows after each other)
   * 53 - no frames in packet (this should be an error)
   * 54 - broken PXD packet magic
   * 55 - exceeding allowed nr of frames by far  */
  c_DHC_UNKNOWN,
  c_DHP_ROW_WO_PIX,
  c_NR_FRAMES_TO_SMALL,
  c_MAGIC,
  c_FRAME_NR,
  /* 56 - more frames than actual available, exceeding packet size
   * 57 - one frame payload exceeding packet size
   * 58 - DHC Start frame has wrong trigger Nr HI
   * 59 - DHC Start frame has wrong trigger Nr LO
   * 60 - DHE Start frame has wrong trigger Nr LO */
  c_FRAME_SIZE,
  c_FRAME_SIZE,
  c_META_MM_DHC,
  c_FRAME_TNR_MM | c_META_MM | c_META_MM_DHC,
  c_FRAME_TNR_MM | c_META_MM | c_META_MM_DHE,
  /* 61 - DHE End frame has wrong trigger Nr LO
   * 62 - DHE End has different DHE Id
   * 63 - DHE Z_DHP Header DHE ID differ from Start
   * 64 - Set ERROR Flag in DHE END
   * 65 - Invalid DHE ID ($3F) in DHE */
  c_FRAME_TNR_MM | c_META_MM, // TODO why not  |c_META_MM_DHE
  c_DHE_START_END_ID, // TODO why not c_DHE_START_ID,
  c_DHE_START_ID | c_DHE_DHP_DHEID,
  c_HEADER_ERR,
  c_DHE_ID_INVALID,
  /* 66 - Doubled DHP Header
   * 67 - 'FAKE' DHC START/END (=no data)
   * 68 - wrong readout frame number in DHP header TODO
   * 69 - DHP frame with too small size
   * 70 - TimeTag Mismatch for DHC/Meta */
  c_DHP_DBL_HEADER,
  c_FAKE_NO_DATA_TRIG,
  c_NO_ERROR,// TODO ===========================================TODO Unpacker is not detecting this
  c_DHP_SIZE,
  c_META_MM_DHC_TT,
  /*
   * 71 data outside of DHE
   * 72 Fake no Fake mix, plus a second DHC
   * 73 Fake no Fake mix, plus double DHC End
   * 74 Fake no Fake mix, plus double DHC Start
   * 75 Fake no Fake mix, replaced DHC End
   */
  c_DATA_OUTSIDE,
  c_FAKE_NO_FAKE_DATA,
  c_FAKE_NO_FAKE_DATA,
  c_FAKE_NO_FAKE_DATA,
  c_FAKE_NO_FAKE_DATA,
  /*
   * 76 Fake no Fake mix, replaced DHC Start
   * 77 ROI Frame without header/content, inside DHC Start/End
   * 78 ROI Frame without header/content, outside DHC Start/End ... this is not allowed (ONSEN)
   * 79 TODO ROI Frame with header & content
   * 80 TODO ROI Frame with header & content but errors
   */
  c_FAKE_NO_FAKE_DATA,
  c_ROI_PACKET_INV_SIZE,
  c_ROI_PACKET_INV_SIZE,// no error flag for this?
  c_NO_ERROR,
  c_NO_ERROR, // not error bit for this?
};
 
bool PXDPackerErrModule::CheckErrorMaskInEvent(unsigned int eventnr, PXDErrorFlags mask)
{
 
  PXDErrorFlags expected; // constructed to no error
  if (eventnr > 0 && eventnr < m_errors.size()) {
    expected = m_errors[eventnr];
  }
  B2INFO("-- PXD Packer Error Check for Event Nr: " << eventnr);
  for (int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) {
    PXDErrorFlags m;
    m[i] = true;
    if ((m & (mask | expected)) == m) {
      if ((m & expected) == m && (m & mask) != m) {
        B2ERROR("Bit " << i << ": Was NOT Set: " << getPXDBitErrorName(i));
        m_found_fatal = true;
      } else if ((m & expected) != m && (m & mask) == m) {
        B2RESULT("Bit " << i << ": Optional   : " << getPXDBitErrorName(i));
      } else if ((m & expected) == m && (m & mask) == m) {
        B2INFO("Bit " << i << ": As Expected: " << getPXDBitErrorName(i));
      }
    }
  }
  bool flag = (mask & expected) == expected;
  if (expected == PXDErrorFlags(0)) {
    // special check, this event should not contain any error!
    if (mask != PXDErrorFlags(0)) {
      B2ERROR("There should be no error in this event, but there were (see above)!");
      m_found_fatal = true;
    }
    flag = (mask == PXDErrorFlags(0));
  }
  B2INFO("-- PXD Packer Error Check END --- ");
  // Bail out on the first check which fails.
  if (m_found_fatal) B2FATAL("This check failed (see details above)!");
  return flag;
}
 
PXDPackerErrModule::PXDPackerErrModule() :
  Module(),
  m_storeRaws()
{
  m_trigger_nr = 0;
  m_packed_events = 0;
  m_run_nr_word1 = 0;
  m_run_nr_word2 = 0;
  //Set module properties
  setDescription("Create 'broken' PXD raw data to challenge Unpacker");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("RawPXDsName", m_RawPXDsName, "The name of the StoreArray of generated RawPXDs", std::string(""));
  addParam("dhe_to_dhc", m_dhe_to_dhc,  "DHE to DHC mapping (DHC_ID, DHE1, DHE2, ..., DHE5) ; -1 disable port");
  addParam("InvertMapping",  m_InvertMapping, "Use inverse mapping to DHP row/col instead of \"remapped\" coordinates", false);
  addParam("Clusterize",  m_Clusterize, "Use clusterizer (FCE format)", false);
  addParam("Check",  m_Check, "Check the result of Unpacking", false);
  addParam("PXDDAQEvtStatsName", m_PXDDAQEvtStatsName, "The name of the StoreObjPtr of read PXDDAQEvtStats", std::string(""));
 
}
 
void PXDPackerErrModule::initialize()
{
  m_found_fatal = false;
  B2DEBUG(27, "PXD Packer Err --> Init");
  if (m_Check) {
    B2WARNING("=== Important! A lot of intentional errors will follow. To find the reason for a failing test, check the lines before the FATAL. ====");
    m_daqStatus.isRequired();
  } else {
    //Register output collections
    m_storeRaws.registerInDataStore(m_RawPXDsName, DataStore::EStoreFlags::c_ErrorIfAlreadyRegistered);
    m_packed_events = 0;

    for (auto& it : m_dhe_to_dhc) {
      bool flag;
      int dhc_id;
      B2DEBUG(27, "PXD Packer Err --> DHC/DHE");
      flag = false;
      if (it.size() != 6) {
        B2WARNING("PXD Packer Err --> DHC/DHE maps 1 dhc to 5 dhe (1+5 values), but I found " << it.size());
      }
      for (auto& it2 : it) {
        if (flag) {
          int v;
          v = it2;
          B2DEBUG(27, "PXD Packer Err --> ... DHE " << it2);
          if (it2 < -1 || it2 >= 64) {
            if (it2 != -1) B2ERROR("PXD Packer Err --> DHC id " << it2 << " is out of range (0-64 or -1)! disable channel.");
            v = -1;
          }
          m_dhc_mapto_dhe[dhc_id].push_back(v);
        } else {
          dhc_id = it2;
          B2DEBUG(27, "PXD Packer Err --> DHC .. " << it2);
          if (dhc_id < 0 || dhc_id >= 16) {
            B2ERROR("PXD Packer Err --> DHC id " << it2 << " is out of range (0-15)! skip");
            break;
          }
        }
        flag = true;
      }
    }
    B2DEBUG(27, "PXD Packer Err --> DHC/DHE done");
 
    for (auto& it : m_dhc_mapto_dhe) {
      int port = 0;
      B2DEBUG(27, "PXD Packer Err --> DHC " << it.first);
      for (auto& it2 : it.second) {
        B2DEBUG(27, "PXD Packer Err --> .. connects to DHE " << it2 << " port " << port);
        port++;
      }
    }
  }
}
 
void PXDPackerErrModule::terminate()
{
  if (m_Check) {
    // Bail out if error detected
    if (m_found_fatal) B2FATAL("At least one of the checks failed (see details above)!");
    // Check kindof test coverage
    B2INFO("Check Test coverage:");
    PXDErrorFlags mask = c_NO_ERROR;
    mask = std::accumulate(m_errors.begin(), m_errors.end(), mask, std::bit_or<PXDErrorFlags>());
    for (int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) {
      PXDErrorFlags m;
      m[i] = true;
      if ((m & mask) == 0) {
        B2WARNING("Bit " << i << ": Not Covered   : " << getPXDBitErrorName(i));
      }
    }
  }
}
 
void PXDPackerErrModule::event()
{
  B2DEBUG(27, "PXD Packer Err --> Event");
  StoreObjPtr<EventMetaData> evtPtr;
 
  m_real_trigger_nr = m_trigger_nr = evtPtr->getEvent();
 
  if (m_Check) {
    CheckErrorMaskInEvent(m_trigger_nr, m_daqStatus->getErrorMask());
  } else {
 
    // First, throw the dices for a few event-wise properties
 
    m_trigger_dhp_framenr = gRandom->Integer(0x10000);
    m_trigger_dhe_gate = gRandom->Integer(192);
 
 
    if (isErrorIn(1)) m_trigger_nr += 10;
    if (isErrorIn(2)) m_trigger_nr = 0;
 
    uint32_t run = evtPtr->getRun();
    uint32_t exp = evtPtr->getExperiment();
    uint32_t sub = evtPtr->getSubrun();
 
    if (isErrorIn(3)) run++;
    if (isErrorIn(4)) sub++;
    if (isErrorIn(5)) exp++;
 
    m_run_nr_word1 = ((run & 0xFF) << 8) | (sub & 0xFF);
    m_run_nr_word2 = ((exp & 0x3FF) << 6) | ((run >> 8) & 0x3F);
    m_meta_time = evtPtr->getTime();
 
    B2INFO("Pack Event : " << evtPtr->getEvent() << ","  << evtPtr->getRun() << "," << evtPtr->getSubrun() << "," <<
           evtPtr->getExperiment() << "," << evtPtr->getTime() << " (MetaInfo)");
 
    if (!isErrorIn(44)) {
      pack_event();
      m_packed_events++;
    }
  }
}
 
void PXDPackerErrModule::pack_event(void)
{
  int dhe_ids[5] = {0, 0, 0, 0, 0};
  B2DEBUG(27, "PXD Packer Err --> pack_event");
 
  // loop for each DHC in system
  // get active DHCs from a database?
  for (auto& it : m_dhc_mapto_dhe) {
    int port = 1, port_inx = 0;
    int act_port = 0;
 
    for (auto& it2 : it.second) {
      if (it2 >= 0) act_port += port;
      port += port;
      dhe_ids[port_inx] = it2;
      port_inx++;
      if (port_inx == 5) break; // not more than five.. checked above
    }
 
    //  if(act_port&0x1F) B2ERROR();... checked above
    //  act_port&=0x1F;... checked above
 
    // get active DHE mask from a database?
 
    m_onsen_header.clear();// Reset
    m_onsen_payload.clear();// Reset
    if (isErrorIn(74)) {
      // add a faked DHC, "no data"
      start_frame();
      append_int32(EDHCFrameHeaderDataType::c_DHC_START << 27);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      add_frame_to_payload();
    }
    if (!isErrorIn(53)) pack_dhc(it.first, act_port, dhe_ids);
    // and write to PxdRaw object
    // header will be finished and endian swapped by constructor; payload already has be on filling the vector
    if (isErrorIn(73)) {
      // add a faked DHC, "no data"
      start_frame();
      append_int32(EDHCFrameHeaderDataType::c_DHC_END << 27);
      append_int32(0);
      append_int32(0);
      add_frame_to_payload();
    }
    if (isErrorIn(72)) {
      // add a faked DHC, "no data"
      start_frame();
      append_int32(EDHCFrameHeaderDataType::c_DHC_START << 27);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      add_frame_to_payload();
 
      start_frame();
      append_int32(EDHCFrameHeaderDataType::c_DHC_END << 27);
      append_int32(0);
      append_int32(0);
      add_frame_to_payload();
    }
    auto objptr = m_storeRaws.appendNew(m_onsen_header, m_onsen_payload);
    if (isErrorIn(54)) {
      objptr->data()[0] = 0xDEADBEAF; // invalid magic
    }
    if (isErrorIn(55)) {
      objptr->data()[1] = 0x00110000; // invalid #frames
    }
    if (isErrorIn(56)) {
      objptr->data()[1] = 0x00010000; // valid #frames, but will exceed size
    }
    if (isErrorIn(57)) {
      objptr->data()[2] = 0x01010101; // extremely large frame
    }
  }
 
}
 
void PXDPackerErrModule::add_frame_to_payload(void)
{
  if (m_current_frame.size() & 0x3) {
    B2WARNING("Frame is not 32bit aligned!!! Unsupported by Unpacker!");
  }
  // checksum frame
  dhc_crc_32_type current_crc;
  current_crc.process_bytes(m_current_frame.data(), m_current_frame.size());
  if (isErrorIn(27) and m_onsen_header.size() == 1) current_crc.process_byte(0x42); // mess up CRC in second frame
  append_int32(current_crc.checksum());
 
  // and add it
  m_onsen_header.push_back(m_current_frame.size());
  m_onsen_payload.push_back(m_current_frame);
}
 
void PXDPackerErrModule::append_int8(unsigned char w)
{
  m_current_frame.push_back(w);
  dhe_byte_count++;
  dhc_byte_count++;
}
 
void PXDPackerErrModule::append_int16(unsigned short w)
{
  m_current_frame.push_back((unsigned char)(w >> 8));
  m_current_frame.push_back((unsigned char)(w));
  dhe_byte_count += 2;
  dhc_byte_count += 2;
}
 
void PXDPackerErrModule::append_int32(unsigned int w)
{
  m_current_frame.push_back((unsigned char)(w >> 24));
  m_current_frame.push_back((unsigned char)(w >> 16));
  m_current_frame.push_back((unsigned char)(w >> 8));
  m_current_frame.push_back((unsigned char)(w));
  dhe_byte_count += 4;
  dhc_byte_count += 4;
}
 
// void PXDPackerErrModule::remove_back_int32(void)
// {
//   m_current_frame.pop_back();
//   m_current_frame.pop_back();
//   m_current_frame.pop_back();
//   m_current_frame.pop_back();
//   dhe_byte_count -= 4;
//   dhc_byte_count -= 4;
// }
 
void PXDPackerErrModule::start_frame(void)
{
  m_current_frame.clear();
}
 
void PXDPackerErrModule::pack_dhc(int dhc_id, int dhe_active, int* dhe_ids, bool send_all, bool send_roi)
{
  B2DEBUG(27, "PXD Packer Err --> pack_dhc ID " << dhc_id << " DHE act: " << dhe_active);

  start_frame();
  append_int32((EDHCFrameHeaderDataType::c_ONSEN_TRG << 27) | (m_trigger_nr & 0xFFFF));
  B2INFO("Trigger packet: $" << hex << m_run_nr_word1 << ", $" << m_run_nr_word2);
  if (isErrorIn(23)) {
    append_int32(0xDEAD8000);
  } else if (isErrorIn(25)) {
    append_int32(0xCAFE0000);// HLT HEADER, NO accepted flag
  } else {
    append_int32(0xCAFE8000 | (send_all ? 0x4000 : 0) | (send_roi ? 0x2000 : 0)); // HLT HEADER, accepted flag set
  }
  if (isErrorIn(26)) {
    append_int32(m_trigger_nr + 1);
  } else if (isErrorIn(36)) {
    append_int32(0x10000000 | m_trigger_nr); // HLT Trigger Nr with Hi work messed up
  } else {
    append_int32(m_trigger_nr); // HLT Trigger Nr
  }
  append_int16(m_run_nr_word2); // HLT Run NR etc
  append_int16(m_run_nr_word1); // HLT Run NR etc
  if (isErrorIn(24)) append_int32(0xDEAD0000);
  else append_int32(0xCAFE0000);// DATCON HEADER ...
  if (isErrorIn(45)) {
    // No Datcon
    append_int32(0x0); // trigger nr
    append_int32(0x0); // 2*16 trg tag
  } else {
    if (isErrorIn(22)) append_int32(m_trigger_nr + 1);
    else append_int32(m_trigger_nr);// DATCON Trigger Nr
    if (!isErrorIn(6)) {
      append_int16(m_run_nr_word2);  // DATCON Run NR etc
      append_int16(m_run_nr_word1);  // DATCON Run NR etc
    }
  }
  if (!isErrorIn(12)) add_frame_to_payload();
  if (isErrorIn(17)) {
    // double frame
    m_onsen_header.push_back(m_current_frame.size());
    m_onsen_payload.push_back(m_current_frame);
  }
 
  if (isErrorIn(30)) return; // empty event, no DHC frames

  if (!isErrorIn(67)) {
 
    dhc_byte_count = 0;
    if (isErrorIn(76)) {
      // add a faked DHC, "no data"
      start_frame();
      append_int32(EDHCFrameHeaderDataType::c_DHC_START << 27);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      append_int16(0);
      add_frame_to_payload();
    } else {
      start_frame();
      uint32_t header = (EDHCFrameHeaderDataType::c_DHC_START << 27) | ((dhc_id & 0xF) << 21) | ((dhe_active & 0x1F) << 16) |
                        (m_trigger_nr & 0xFFFF);
      if (isErrorIn(59)) header++;
      append_int32(header);
      if (!isErrorIn(58)) append_int16(m_trigger_nr >> 16);
      else  append_int16((m_trigger_nr >> 16) + 1);
 
      uint32_t mm = (unsigned int)std::round((m_meta_time % 1000000000ull) * 0.127216); // in 127MHz Ticks
      uint32_t ss = (unsigned int)(m_meta_time / 1000000000ull) ; // in seconds
      if (isErrorIn(70)) mm++;
      if (isErrorIn(70)) ss++;
      append_int16(((mm << 4) & 0xFFF0) | 0x1); // TT 11-0 | Type --- fill with something useful TODO
      append_int16(((mm >> 12) & 0x7FFF) | ((ss & 1) ? 0x8000 : 0x0)); // TT 27-12 ... not clear if completely filled by DHC
      append_int16((ss >> 1) & 0xFFFF); // TT 43-28 ... not clear if completely filled by DHC
      if (!isErrorIn(7)) {
        append_int16(m_run_nr_word1); // Run Nr 7-0 | Subrunnr 7-0
        append_int16(m_run_nr_word2);  // Exp NR 9-0 | Run Nr 13-8
      }
      if (!isErrorIn(13)) add_frame_to_payload();
      if (isErrorIn(18)) {
        // double frame
        m_onsen_header.push_back(m_current_frame.size());
        m_onsen_payload.push_back(m_current_frame);
      }
    }
 
    // loop for each DHE in system
    // Run & TTT etc are zero until better idea
 
    if (isErrorIn(29)) dhe_active = 0; // dont send any DHE
    for (int i = 0; i < 5; i++) {
      if ((dhe_active & 0x1) or isErrorIn(28)) pack_dhe(dhe_ids[i], 0xF);
      if (isErrorIn(71) && i == 2) {
        pack_dhp(1, dhe_ids[i], 1);
      }
      dhe_active >>= 1;
    }

 
    if (isErrorIn(77)) {
      // TODO add ROI Frame if header bit is set
      int old = dhc_byte_count;
      start_frame();
      append_int32((EDHCFrameHeaderDataType::c_ONSEN_ROI << 27) | (m_trigger_nr & 0xFFFF));
      add_frame_to_payload();
      dhc_byte_count = old; // dont count
    }

    if (isErrorIn(75)) {
      // add a faked DHC, "no data"
      start_frame();
      append_int32(EDHCFrameHeaderDataType::c_DHC_END << 27);
      append_int32(0);
      append_int32(0);
      add_frame_to_payload();
    } else {
      if (isErrorIn(31)) dhc_id += 1;
      if (isErrorIn(33)) dhc_byte_count += 4;
      unsigned int dlen = (dhc_byte_count / 4); // 32 bit words
      start_frame();
      append_int32((EDHCFrameHeaderDataType::c_DHC_END << 27) | ((dhc_id & 0xF) << 21) | (m_trigger_nr & 0xFFFF));
      append_int32(dlen); // 32 bit word count
      if (!isErrorIn(8)) append_int32(0x00000000);  // Error Flags
      if (!isErrorIn(14)) add_frame_to_payload();
      if (isErrorIn(19)) {
        // double frame
        m_onsen_header.push_back(m_current_frame.size());
        m_onsen_payload.push_back(m_current_frame);
      }
    }
    if (isErrorIn(78)) {
      // TODO add ROI Frame if header bit is set
      int old = dhc_byte_count;
      start_frame();
      append_int32((EDHCFrameHeaderDataType::c_ONSEN_ROI << 27) | (m_trigger_nr & 0xFFFF));
      add_frame_to_payload();
      dhc_byte_count = old; // dont count
    }
 
  } else {
    // add a faked DHC, "no data"
    start_frame();
    append_int32(EDHCFrameHeaderDataType::c_DHC_START << 27);
    append_int16(0);
    append_int16(0);
    append_int16(0);
    append_int16(0);
    append_int16(0);
    append_int16(0);
    add_frame_to_payload();
 
    start_frame();
    append_int32(EDHCFrameHeaderDataType::c_DHC_END << 27);
    append_int32(0);
    append_int32(0);
    add_frame_to_payload();
  }
}
 
void PXDPackerErrModule::pack_dhe(int dhe_id, int dhp_active)
{
  if (isErrorIn(37)) dhp_active = 0; // mark as no DHP, but send them (see below)
  B2DEBUG(27, "PXD Packer Err --> pack_dhe ID " << dhe_id << " DHP act: " << dhp_active);
  // dhe_id is not dhe_id ...
  bool dhe_has_remapped = !m_InvertMapping; 
 
  if (m_InvertMapping) {
    // problem, we do not have an exact definition of if this bit is set in the new firmware and under which circumstances
    // and its not clear if we have to translate the coordinates back to "DHP" layout! (look up table etc!)
    B2FATAL("Inverse Mapping not implemented in Packer");
  }
 
  if (isErrorIn(65)) dhe_id = 0x3F; // invalid
  dhe_byte_count = 0;
  start_frame();
  uint32_t header = (EDHCFrameHeaderDataType::c_DHE_START << 27) | ((dhe_id & 0x3F) << 20) | ((dhp_active & 0xF) << 16) |
                    (m_trigger_nr & 0xFFFF);
  if (isErrorIn(60)) header++;
  append_int32(header);
 
  if (isErrorIn(35)) append_int16(0x1000);
  else append_int16(m_trigger_nr >> 16); // Trigger Nr Hi
  if (!isErrorIn(11)) {
    append_int16(0x00000000);  // DHE Timer Lo
  }
  if (!isErrorIn(9)) {
    append_int16(0x00000000);  // DHE Time Hi
    append_int16(((m_trigger_dhp_framenr & 0x3F) << 10) |
                 (m_trigger_dhe_gate & 0xFF)); // Last DHP Frame Nr 15-10, Reserved 9-8, Trigger Offset 7-0
  }
  if (!isErrorIn(15)) add_frame_to_payload();
  if (isErrorIn(20)) {
    // double frame
    m_onsen_header.push_back(m_current_frame.size());
    m_onsen_payload.push_back(m_current_frame);
  }
 
  // Now we add some undefined things
  if (isErrorIn(46)) {
    start_frame();
    append_int32((EDHCFrameHeaderDataType::c_COMMODE << 27) | ((dhe_id & 0x3F) << 20) | (m_trigger_nr & 0xFFFF));
    add_frame_to_payload();
  }
  if (isErrorIn(47)) {
    start_frame();
    append_int32((EDHCFrameHeaderDataType::c_FCE_RAW << 27) | ((dhe_id & 0x3F) << 20) | (m_trigger_nr & 0xFFFF));
    add_frame_to_payload();
  }
  if (isErrorIn(48)) {
    start_frame();
    append_int32((EDHCFrameHeaderDataType::c_ONSEN_FCE << 27) | ((dhe_id & 0x3F) << 20) | (m_trigger_nr & 0xFFFF));
    add_frame_to_payload();
  }
  if (isErrorIn(49)) {
    start_frame();
    append_int32((EDHCFrameHeaderDataType::c_UNUSED_7 << 27) | ((dhe_id & 0x3F) << 20) | (m_trigger_nr & 0xFFFF));
    add_frame_to_payload();
  }
  if (isErrorIn(50)) {
    start_frame();
    append_int32((EDHCFrameHeaderDataType::c_UNUSED_8 << 27) | ((dhe_id & 0x3F) << 20) | (m_trigger_nr & 0xFFFF));
    add_frame_to_payload();
  }
  if (isErrorIn(51)) {
    start_frame();
    append_int32((EDHCFrameHeaderDataType::c_UNUSED_A << 27) | ((dhe_id & 0x3F) << 20) | (m_trigger_nr & 0xFFFF));
    add_frame_to_payload();
  }
 
// now prepare the data from one halfladder
// do the ROI selection??? optional...
// then loop for each DHP in system
// get active DHPs from a database?
// and pack data per halfladder.
// we fake the framenr and startframenr until we find some better solution
 
  if (dhp_active != 0) { 

    bzero(halfladder_pixmap, sizeof(halfladder_pixmap));

    unsigned short sensor, ladder, layer;
    sensor = (dhe_id & 0x1) + 1;
    ladder = (dhe_id & 0x1E) >> 1; // no +1
    layer = ((dhe_id & 0x20) >> 5) + 1;
 
    B2DEBUG(27, "pack_dhe: VxdId: " << VxdID(layer, ladder, sensor) << " " << (int)VxdID(layer, ladder, sensor));
 
    // Create some fixed hits (not too many, jut a few per ladder)
    for (auto j = 0; j < 10; j++) {
      unsigned int row, col;
      unsigned char charge;
      row = j * 23;
      col = j * 23;
      charge = 20 + j; // 0-255
      if (!dhe_has_remapped) {
        do_the_reverse_mapping(row, col, layer, sensor);
      }
      halfladder_pixmap[row][col] = charge;
    }
 
    if (isErrorIn(38)) dhp_active = 0; // no DHP data even if we expect it
    if (m_Clusterize) {
      B2FATAL("Clusterizer not supported in Packer");
    } else {
      for (int i = 0; i < 4; i++) {
        if ((dhp_active & 0x1) or isErrorIn(37)) {
          pack_dhp(i, dhe_id, dhe_has_remapped ? 1 : 0);
//         if (m_trigger_nr == 0x11) {
//           pack_dhp_raw(i, dhe_id, false);
//           pack_dhp_raw(i, dhe_id, true);
//         }
        }
        dhp_active >>= 1;
      }
    }
  }

  if (isErrorIn(32)) dhe_id += 1;
  if (isErrorIn(34)) dhe_byte_count += 4;
  unsigned int dlen = (dhe_byte_count / 2); // 16 bit words
  start_frame();
  header = (EDHCFrameHeaderDataType::c_DHE_END << 27) | ((dhe_id & 0x3F) << 20) | (m_trigger_nr & 0xFFFF);
  if (isErrorIn(61)) header++;
  if (isErrorIn(62)) header += 1 << 20;
  if (isErrorIn(64)) header |= 0x80000000;
  append_int32(header);
  append_int16(dlen & 0xFFFF); // 16 bit word count
  append_int16((dlen >> 16) & 0xFFFF); // 16 bit word count
  if (!isErrorIn(10)) append_int32(0x00000000);   // Error Flags
  if (!isErrorIn(16)) add_frame_to_payload();
  if (isErrorIn(21)) {
    // double frame
    m_onsen_header.push_back(m_current_frame.size());
    m_onsen_payload.push_back(m_current_frame);
  }
}
 
void PXDPackerErrModule::do_the_reverse_mapping(unsigned int& /*row*/, unsigned int& /*col*/, unsigned short /*layer*/,
                                                unsigned short /*sensor*/)
{
  B2FATAL("code needs to be written");
  // work to be done
  //
  // PXDMappingLookup::map_uv_to_rc_IF_OB(unsigned int& v_cellID, unsigned int& u_cellID, unsigned int& dhp_id, unsigned int dhe_ID)
  // PXDMappingLookup::map_uv_to_rc_IB_OF(unsigned int& v_cellID, unsigned int& u_cellID, unsigned int& dhp_id, unsigned int dhe_ID)
}
 
void PXDPackerErrModule::pack_dhp_raw(int chip_id, int dhe_id)
{
  B2DEBUG(27, "PXD Packer Err --> pack_dhp Raw Chip " << chip_id << " of DHE id: " << dhe_id);
  start_frame();
  append_int32((EDHCFrameHeaderDataType::c_DHP_RAW << 27) | ((dhe_id & 0x3F) << 20) | ((chip_id & 0x03) << 16) |
               (m_trigger_nr & 0xFFFF));
  append_int32((EDHPFrameHeaderDataType::c_RAW << 29) | ((dhe_id & 0x3F) << 18) | ((chip_id & 0x03) << 16) |
               (m_trigger_dhp_framenr & 0xFFFF));
 
  int c1, c2;
  c1 = 64 * chip_id;
  c2 = c1 + 64;
  if (c2 >= PACKER_NUM_COLS) c2 = PACKER_NUM_COLS;
 
  // ADC data / memdump for pedestal calculation
  for (int row = 0; row < PACKER_NUM_ROWS; row++) {
    for (int col = c1; col < c2; col++) {
      append_int8(halfladder_pixmap[row][col]);
    }
    // unconnected drain lines -> 0
    for (int col = c2; col < c1 + 64; col++) {
      append_int8(0);
    }
  }
 
  add_frame_to_payload();
}
 
void PXDPackerErrModule::pack_dhp(int chip_id, int dhe_id, int dhe_has_remapped)
{
  B2DEBUG(27, "PXD Packer Err --> pack_dhp Chip " << chip_id << " of DHE id: " << dhe_id);
  // remark: chip_id != port most of the time ...
  bool empty = true;
  unsigned short last_rowstart = 0;
  bool error_done = false;
 
  if (dhe_has_remapped == 0) {
    // problem, we do not have an exact definition of if this bit is set in the new firmware and under which circumstances
    // and its not clear if we have to translate the coordinates back to "DHP" layout! (look up table etc!)
    B2FATAL("dhe_has_remapped == 0");
  }
 
  start_frame();
  uint32_t header = (EDHCFrameHeaderDataType::c_DHP_ZSD << 27) | ((dhe_id & 0x3F) << 20) | ((dhe_has_remapped & 0x1) << 19) | ((
                      chip_id & 0x03) << 16) | (m_trigger_nr & 0xFFFF);
  if (isErrorIn(63)) header += 1 << 20;
  append_int32(header);
 
  if (isErrorIn(69)) {
    add_frame_to_payload();
    return;
  }
 
  if (isErrorIn(39)) dhe_id = 0; // mess up dhe_id in DHP header
  if (isErrorIn(40)) chip_id = ~chip_id; // mess up chip id
  header = (EDHPFrameHeaderDataType::c_ZSD << 29) | ((dhe_id & 0x3F) << 18) | ((chip_id & 0x03) << 16) |
           (m_trigger_dhp_framenr & 0xFFFF);
  if (isErrorIn(68)) header++;
  append_int32(header);
  if (isErrorIn(66)) append_int32(header + 1); // with inc trigger nr
 
  if (isErrorIn(41) or isErrorIn(42)) {
    halfladder_pixmap[PACKER_NUM_ROWS - 1][PACKER_NUM_COLS - 1] = 0x42; // make sure we have a hit
  }
  for (int row = 0; row < PACKER_NUM_ROWS; row++) { // should be variable
    bool rowstart;
    if (isErrorIn(43) && !error_done) rowstart = false;
    else rowstart = true;
    int c1, c2;
    c1 = 64 * chip_id;
    c2 = c1 + 64;
    if (c2 >= PACKER_NUM_COLS) c2 = PACKER_NUM_COLS;
    for (int col = c1; col < c2; col++) {
      if (halfladder_pixmap[row][col] != 0) {
        unsigned char charge;
        charge = halfladder_pixmap[row][col] & 0xFF; // before we make overflow error
        if (isErrorIn(41) and row == PACKER_NUM_ROWS - 1 and col == PACKER_NUM_COLS - 1 and !error_done) {
          row = PACKER_NUM_ROWS;
          rowstart = true; // force a new row
          error_done = true;
        }
        if (isErrorIn(42) and row == PACKER_NUM_ROWS - 1 and col == PACKER_NUM_COLS - 1 and !error_done) {
          col = PACKER_NUM_COLS; // masked out to modulo 64 anyway
          error_done = true;
        }
        if (rowstart) {
          last_rowstart = ((row & 0x3FE) << (6 - 1)) | 0; // plus common mode 6 bits ... set to 0
          append_int16(last_rowstart);
          rowstart = false;
        }
        int colout = col;
        if (!isErrorIn(52)) append_int16(0x8000 | ((row & 0x1) << 14) | ((colout & 0x3F) << 8) | charge);
        empty = false;
      }
    }
  }
  if (!empty && (m_current_frame.size() & 0x3)) {
    B2DEBUG(27, "Repeat last rowstart to align to 32bit.");
    append_int16(last_rowstart);
  }
 
 
  if (empty) {
    B2DEBUG(27, "Found no data for halfladder! DHEID: " << dhe_id << " Chip: " << chip_id);
    // we DROP the frame, thus we have to correct DHE and DHC counters
    dhc_byte_count -= 8; // fixed size of Header
    dhe_byte_count -= 8; // fixed size of Header
    start_frame();
    append_int32((EDHCFrameHeaderDataType::c_GHOST << 27) | ((dhe_id & 0x3F) << 20) | ((chip_id & 0x03) << 16) |
                 (m_trigger_nr & 0xFFFF));
  } else {
    //B2DEBUG(20,"Found data for halfladder DHEID: " << dhe_id << " Chip: " << chip_id);
  }
  add_frame_to_payload();
 
}
 
bool PXDPackerErrModule::isErrorIn(uint32_t enr)
{
  if (m_real_trigger_nr == enr) return true; // oder modulo, oder oder
  return false;
}