include/roc/Message.h (r4864/r3440)

Go to the documentation of this file.

#ifndef ROC_MESSAGE_H
#define ROC_MESSAGE_H

#include <stdint.h>
#include <iostream>

namespace roc {


   enum MessageFormat {
      formatEth1   = 0,  // original message format with big-endian coding, 6-byte
      formatOptic1 = 1,  // original message format with big-endian coding, add 2 byte send/recv info, 8-byte
      formatEth2   = 2,  // new message format with little-endian coding, 6-byte
      formatOptic2 = 3,  // new message format with little-endian coding, add 2 byte send/recv info, 8-byte
      formatNormal = 4   // new message format with little-endian coding, 16-bit roc number (default)
   };

   enum MessageTypes {
      MSG_NOP    = 0,
      MSG_HIT    = 1,
      MSG_EPOCH  = 2,
      MSG_SYNC   = 3,
      MSG_AUX    = 4,
      MSG_EPOCH2 = 5,
      MSG_GET4   = 6,
      MSG_SYS    = 7
   };

   enum SysMessageTypes {
      SYSMSG_DAQ_START    = 1,      // indicates start daq in data stream
      SYSMSG_DAQ_FINISH   = 2,      // stop daq
      SYSMSG_NX_PARITY    = 3,      // nx_parity error
      SYSMSG_SYNC_PARITY  = 4,      // sync parity error
      SYSMSG_DAQ_RESUME   = 5,      // daq resume due to low/high water marker, only in udp case
      SYSMSG_FIFO_RESET   = 6,      // FPGA fifo reset
      SYSMSG_USER         = 7,      // user define message, generated by writing into ROC_ADDSYSMSG register
      SYSMSG_PCTIME       = 8,      // contains value of time() function, indicates when message was created on PC
      SYSMSG_ADC          = 9,      // contains feb1d (1 bit), channel id (7 bit) and adc value (24 bit), measured on PC
      SYSMSG_PACKETLOST   = 10,     // inserted by udp transport when packet was lost at this place
      SYSMSG_GET4_EVENT   = 11,     // GET4 event
      SYSMSG_CLOSYSYNC_ERROR = 12,  // added to data stream when the closy-sync-strobe does not match the rocs 156MHz timestamp counter
      SYSMSG_TS156_SYNC   = 13      // added when 156MHz timestamp counter is reset by a DLM

   };

   enum SysMessageUserTypes {
      SYSMSG_USER_CALIBR_ON    = 7,
      SYSMSG_USER_CALIBR_OFF   = 8,
      SYSMSG_USER_RECONFIGURE  = 9
   };

   enum MessagePrintMask {
      msg_print_Prefix = 1,
      msg_print_Data   = 2,
      msg_print_Hex    = 4,
      msg_print_Human  = 8
   };

   class Message {

      protected:
         uint64_t data;   // main and only storage field for the message

      public:
         Message() : data(0) {}

         Message(const Message& src) : data(src.data) {}

         void assign(const Message& src) { data = src.data; }

         Message& operator=(const Message& src) { assign(src); return *this; }

         inline void reset() { data = 0; }

         inline uint32_t getField(uint32_t shift, uint32_t len) const
            { return (data >> shift) & ((((uint32_t)1) << len) - 1); }

         inline void setField(uint32_t shift, uint32_t len, uint32_t value)
            { data = (data & ~(((((uint64_t) 1) << len) - 1) << shift)) | (((uint64_t) value) << shift); }

         inline uint8_t getBit(uint32_t shift) const
            { return (data >> shift) & 1; }

         inline void setBit(uint32_t shift, uint8_t value)
            { data = value ? (data | (((uint64_t) 1) << shift)) : (data & ~(((uint64_t) 1) << shift)) ; }


         // --------------------------- common fields ---------------------------------

         inline uint8_t getMessageType() const { return getField(0, 4); }


         inline uint16_t getRocNumber() const { return getField(48, 16); }

         inline void setMessageType(uint8_t v) { setField(0, 4, v); }

         inline void setRocNumber(uint16_t v) { setField(48, 16, v); }


         // ---------- nXYTER Hit data access methods ----------------


         inline uint8_t getNxNumber() const { return getField(6, 2); }


         inline uint8_t getNxLtsMsb() const { return getField(8, 3); }


         inline uint16_t getNxTs() const { return getField(11, 14); }

         inline uint8_t getNxChNum() const { return getField(25, 7); }

         // 1 bit unused

         inline uint16_t getNxAdcValue() const { return getField(33, 12); }


         inline uint8_t getNxPileup() const { return getBit(45); }


         inline uint8_t getNxOverflow() const { return getBit(46); }


         inline uint8_t getNxLastEpoch() const { return getBit(47); }


         inline void setNxNumber(uint8_t v) { setField(6, 2, v); }

         inline void setNxLtsMsb(uint8_t v) { setField(8, 3, v); }

         inline void setNxTs(uint16_t v) { setField(11, 14, v); }

         inline void setNxChNum(uint8_t v) { setField(25, 7, v); }

         // 1 bit unused

         inline void setNxAdcValue(uint16_t v) { setField(33, 12, v); }

         inline void setNxPileup(uint8_t v) { setBit(45, v); }

         inline void setNxOverflow(uint8_t v) { setBit(46,v ); }

         inline void setNxLastEpoch(uint8_t v) { setBit(47, v); }

         // ---------- Epoch marker access methods ------------

         // 2 bit unused

         // inline uint32_t getEpochNumber() const { return getField(8, 32); }
         // on some machines 32-bit field is not working
         inline uint32_t getEpochNumber() const { return data >> 8; }


         inline uint8_t getEpochMissed() const { return getField(40, 8); }

         inline void setEpochNumber(uint32_t v) { setField(8, 32, v); }

         inline void setEpochMissed(uint8_t v) { setField(40, 8, v); }


         // ---------- Sync marker access methods -------------

         inline uint8_t getSyncChNum() const { return getField(6, 2); }

         inline uint16_t getSyncTs() const { return getField(8, 13) << 1; }

         inline uint8_t getSyncEpochLSB() const { return getBit(21); }

         inline uint32_t getSyncData() const { return getField(22, 24); }

         inline uint8_t getSyncStFlag() const { return getField(46, 2); }


         inline void setSyncChNum(uint8_t v) { setField(6, 2, v); }

         inline void setSyncTs(uint16_t v) { setField(8, 13, v >> 1); }

         inline void setSyncEpochLSB(uint8_t v) { setBit(21, v); }

         inline void setSyncData(uint32_t v) { setField(22, 24, v); }

         inline void setSyncStFlag(uint8_t v)  { setField(46, 2, v); }


         // ---------- AUX marker access methods --------------

         inline uint8_t getAuxChNum() const { return getField(6, 7); }

         inline uint16_t getAuxTs() const { return getField(13, 13) << 1; }

         inline uint8_t getAuxEpochLSB() const { return getBit(26); }

         inline uint8_t getAuxFalling() const { return getBit(27); }

         inline uint8_t getAuxOverflow() const { return getBit(28); }


         inline void setAuxChNum(uint8_t v) { setField(6, 7, v); }

         inline void setAuxTs(uint16_t v) { setField(13, 13, v >> 1); }

         inline void setAuxEpochLSB(uint8_t v) { setBit(26, v); }

         inline void setAuxFalling(uint8_t v) { setBit(27, v); }

         inline void setAuxOverflow(uint8_t v) { setBit(28, v); }

         // ---------- Epoch2 marker access methods ------------

         inline uint32_t getEpoch2EpochMissmatch() const { return getBit(4); }

         inline uint32_t getEpoch2EpochLost() const { return getBit(5); }

         inline uint32_t getEpoch2DataLost() const { return getBit(6); }

         inline uint32_t getEpoch2Sync() const { return getBit(7); }

         inline uint32_t getEpoch2StampTime() const { return getField(8, 4); }

         // inline uint32_t getEpoch2Number() const { return getField(12, 20); }
         // on some machines 32-bit field is not working
         // inline uint32_t getEpoch2Number() const { return getField(12, 32); }
         inline uint32_t getEpoch2Number() const { return data >> 12; }

         inline uint32_t getEpoch2ChipNumber() const { return getField(44, 4); }

         inline uint32_t getEpoch2CRC() const { return getField(40, 8); }

         inline void setEpoch2EpochMissmatch(uint32_t v) { setBit(4, v); }

         inline void setEpoch2EpochLost(uint32_t v) { setBit(5, v); }

         inline void setEpoch2DataLost(uint32_t v) { setBit(6, v); }

         inline void setEpoch2Sync(uint32_t v) { setBit(7, v); }

         inline void setEpoch2StampTime(uint32_t v) { setField(8, 4, v); }

         inline void setEpoch2Number(uint32_t v) { setField(12, 32, v); }

         inline void setEpoch2ChipNumber(uint32_t v) { setField(44, 4, v); }

         inline void setEpoch2CRC(uint32_t v) { setField(40, 8, v); }

         // ---------- Get4 Hit data access methods ----------------

         inline uint8_t getGet4Number() const { return getField(6, 6); }

         inline uint8_t getGet4ChNum() const { return getField(12, 2); }

         inline uint32_t getGet4Ts() const { return getField(14, 19); }

         inline uint32_t getGet4Edge() const { return getBit(33); }

         inline uint32_t getGet4CRC() const { return getField(40, 8); }


         inline void setGet4Number(uint8_t v) { setField(6, 6, v); }

         inline void setGet4ChNum(uint8_t v) { setField(12, 2, v); }

         inline void setGet4Ts(uint32_t v) { setField(14, 19, v); }

         inline void setGet4Edge(uint32_t v) { setBit(33, v); }

         inline void setGet4CRC(uint32_t v) { setField(40, 8, v); }

         // ---------- System message access methods ----------

         // 2 bit unused

         inline uint8_t getSysMesType() const { return getField(8, 8); }

         // inline uint32_t getSysMesData() const { return getField(16, 32); }
         // on some machine 32-bit field not working
         inline uint32_t getSysMesData() const { return data >> 16; }

         inline void setSysMesType(uint8_t v) { setField(8, 8, v); }

         inline void setSysMesData(uint32_t v) { setField(16, 32, v); }


         // ---------- Common functions -----------------------

         inline bool isNopMsg() const { return getMessageType() == MSG_NOP; }
         inline bool isHitMsg() const { return getMessageType() == MSG_HIT; }
         inline bool isEpochMsg() const { return getMessageType() == MSG_EPOCH;}
         inline bool isSyncMsg() const { return getMessageType() == MSG_SYNC; }
         inline bool isAuxMsg() const { return getMessageType() == MSG_AUX; }
         inline bool isEpoch2Msg() const { return getMessageType() == MSG_EPOCH2;}
         inline bool isGet4Msg() const { return getMessageType() == MSG_GET4; }
         inline bool isSysMsg() const { return getMessageType() == MSG_SYS; }

         inline bool isStartDaqMsg() const
           { return isSysMsg() && (getSysMesType() == SYSMSG_DAQ_START); }
         inline bool isStopDaqMsg() const
           { return isSysMsg() && (getSysMesType() == SYSMSG_DAQ_FINISH); }


         void printData(unsigned kind = msg_print_Prefix | msg_print_Data, uint32_t epoch = 0) const;

         void printData(std::ostream& os, unsigned kind = msg_print_Human, uint32_t epoch = 0) const;

         uint64_t getMsgFullTime(uint32_t epoch) const;

         double getMsgFullTimeD(uint32_t epoch) const;

         inline static uint64_t FullTimeStamp(uint32_t epoch, uint16_t stamp)
            { return ((uint64_t) epoch << 14) | (stamp & 0x3fff); }

         inline static uint64_t FullTimeStamp2(uint32_t epoch, uint32_t stamp)
            { return ((uint64_t) epoch << 19) | (stamp & 0x7ffff); }


         static uint64_t CalcDistance(uint64_t start, uint64_t stop);

         static double CalcDistanceD(double start, double stop);

         // -------------------- methods for working with different formats

         static uint32_t RawSize(int fmt);

         bool convertFromOld(void* src);

         bool convertToOld(void* tgt);

         bool assign(void* src, int fmt = formatNormal);

         bool copyto(void* tgt, int fmt = formatNormal);
   };

}


#endif