test
CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
SiStripFEDBufferComponents.h
Go to the documentation of this file.
1 #ifndef EventFilter_SiStripRawToDigi_SiStripFEDBufferComponents_H
2 #define EventFilter_SiStripRawToDigi_SiStripFEDBufferComponents_H
3 
4 #include "boost/cstdint.hpp"
5 #include <ostream>
6 #include <memory>
7 #include <cstring>
8 #include "DataFormats/SiStripCommon/interface/ConstantsForHardwareSystems.h"
9 #include "FWCore/Utilities/interface/Exception.h"
10 
11 namespace sistrip {
12 
13  //
14  // Constants
15  //
16 
17  static const uint8_t INVALID=0xFF;
18 
19  static const uint8_t APV_MAX_ADDRESS=192;
20 
21  static const uint16_t SCOPE_MODE_MAX_SCOPE_LENGTH=1022;
22 
23  enum FEDBufferFormat { BUFFER_FORMAT_INVALID=INVALID,
24  BUFFER_FORMAT_OLD_VME,
25  BUFFER_FORMAT_OLD_SLINK,
26  BUFFER_FORMAT_NEW
27  };
28  //these are the values which appear in the buffer.
29  static const uint8_t BUFFER_FORMAT_CODE_OLD = 0xED;
30  static const uint8_t BUFFER_FORMAT_CODE_NEW = 0xC5;
31 
32  //enum values are values which appear in buffer. DO NOT CHANGE!
33  enum FEDHeaderType { HEADER_TYPE_INVALID=INVALID,
34  HEADER_TYPE_FULL_DEBUG=1,
35  HEADER_TYPE_APV_ERROR=2,
36  HEADER_TYPE_NONE=4 //spy channel
37  };
38 
39  //enum values are values which appear in buffer. DO NOT CHANGE!
40  enum FEDReadoutMode { READOUT_MODE_INVALID=INVALID,
41  READOUT_MODE_SCOPE=0x1,
42  READOUT_MODE_VIRGIN_RAW=0x2,
43  READOUT_MODE_PROC_RAW=0x6,
44  READOUT_MODE_ZERO_SUPPRESSED=0xA,
45  READOUT_MODE_ZERO_SUPPRESSED_LITE=0xC,
46  READOUT_MODE_SPY=0xE,
47  READOUT_MODE_PREMIX_RAW=0xF //0x8?
48  };
49 
50  static const uint8_t PACKET_CODE_SCOPE = 0xE5;
51  static const uint8_t PACKET_CODE_VIRGIN_RAW = 0xE6;
52  static const uint8_t PACKET_CODE_PROC_RAW = 0xF2;
53  static const uint8_t PACKET_CODE_ZERO_SUPPRESSED = 0xEA;
54 
55  //enum values are values which appear in buffer. DO NOT CHANGE!
56  enum FEDDataType { DATA_TYPE_REAL=0,
57  DATA_TYPE_FAKE=1
58  };
59 
60  //enum values are values which appear in buffer. DO NOT CHANGE!
61  //see http://cmsdoc.cern.ch/cms/TRIDAS/horizontal/RUWG/DAQ_IF_guide/DAQ_IF_guide.html
62  enum FEDDAQEventType { DAQ_EVENT_TYPE_PHYSICS=0x1,
63  DAQ_EVENT_TYPE_CALIBRATION=0x2,
64  DAQ_EVENT_TYPE_TEST=0x3,
65  DAQ_EVENT_TYPE_TECHNICAL=0x4,
66  DAQ_EVENT_TYPE_SIMULATED=0x5,
67  DAQ_EVENT_TYPE_TRACED=0x6,
68  DAQ_EVENT_TYPE_ERROR=0xF,
69  DAQ_EVENT_TYPE_INVALID=INVALID
70  };
71 
72  //enum values are values which appear in buffer. DO NOT CHANGE!
73  //see http://cmsdoc.cern.ch/cms/TRIDAS/horizontal/RUWG/DAQ_IF_guide/DAQ_IF_guide.html
74  enum FEDTTSBits { TTS_DISCONNECTED0=0x0,
75  TTS_WARN_OVERFLOW=0x1,
76  TTS_OUT_OF_SYNC=0x2,
77  TTS_BUSY=0x4,
78  TTS_READY=0x8,
79  TTS_ERROR=0x12,
80  TTS_DISCONNECTED1=0xF,
81  TTS_INVALID=INVALID };
82 
83  //enum values are values which appear in buffer. DO NOT CHANGE!
84  enum FEDBufferState { BUFFER_STATE_UNSET=0x0,
85  BUFFER_STATE_EMPTY=0x1,
86  BUFFER_STATE_PARTIAL_FULL=0x4,
87  BUFFER_STATE_FULL=0x8
88  };
89 
90  //enum values are values which appear in buffer. DO NOT CHANGE!
91  enum FEDChannelStatus { CHANNEL_STATUS_LOCKED=0x20,
92  CHANNEL_STATUS_IN_SYNC=0x10,
93  CHANNEL_STATUS_APV1_ADDRESS_GOOD=0x08,
94  CHANNEL_STATUS_APV0_NO_ERROR_BIT=0x04,
95  CHANNEL_STATUS_APV0_ADDRESS_GOOD=0x02,
96  CHANNEL_STATUS_APV1_NO_ERROR_BIT=0x01,
97  CHANNEL_STATUS_NO_PROBLEMS=CHANNEL_STATUS_LOCKED|
98  CHANNEL_STATUS_IN_SYNC|
99  CHANNEL_STATUS_APV1_ADDRESS_GOOD|
100  CHANNEL_STATUS_APV0_NO_ERROR_BIT|
101  CHANNEL_STATUS_APV0_ADDRESS_GOOD|
102  CHANNEL_STATUS_APV1_NO_ERROR_BIT
103  };
104 
105  //
106  // Global function declarations
107  //
108 
109  //used by these classes
110  uint8_t internalFEDChannelNum(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum);
111  void printHex(const void* pointer, const size_t length, std::ostream& os);
112  //calculate the CRC for a FED buffer
113  uint16_t calculateFEDBufferCRC(const uint8_t* buffer, const size_t lengthInBytes);
114  //to make enums printable
115  std::ostream& operator<<(std::ostream& os, const FEDBufferFormat& value);
116  std::ostream& operator<<(std::ostream& os, const FEDHeaderType& value);
117  std::ostream& operator<<(std::ostream& os, const FEDReadoutMode& value);
118  std::ostream& operator<<(std::ostream& os, const FEDDataType& value);
119  std::ostream& operator<<(std::ostream& os, const FEDDAQEventType& value);
120  std::ostream& operator<<(std::ostream& os, const FEDTTSBits& value);
121  std::ostream& operator<<(std::ostream& os, const FEDBufferState& value);
122  std::ostream& operator<<(std::ostream& os, const FEDChannelStatus& value);
123  //convert name of an element of enum to enum value (useful for getting values from config)
124  FEDBufferFormat fedBufferFormatFromString(const std::string& bufferFormatString);
125  FEDHeaderType fedHeaderTypeFromString(const std::string& headerTypeString);
126  FEDReadoutMode fedReadoutModeFromString(const std::string& readoutModeString);
127  FEDDataType fedDataTypeFromString(const std::string& dataTypeString);
128  FEDDAQEventType fedDAQEventTypeFromString(const std::string& daqEventTypeString);
129 
130  //
131  // Class definitions
132  //
133 
134  //handles conversion between order of data in buffer in VR/PR modes (readout order) and strip order (physical order)
135  class FEDStripOrdering
136  {
137  public:
138  //convert strip/sample index in channel (ie 0-255) between physical and readout order
139  static uint8_t physicalOrderForStripInChannel(const uint8_t readoutOrderStripIndexInChannel);
140  static uint8_t readoutOrderForStripInChannel(const uint8_t physicalOrderStripIndexInChannel);
141  //convert strip/sample index in APV (ie 0-127) between physical and readout order
142  static uint8_t physicalOrderForStripInAPV(const uint8_t readoutOrderStripIndexInAPV);
143  static uint8_t readoutOrderForStripInAPV(const uint8_t physicalOrderStripIndexInAPV);
144  };
145 
146  //see http://cmsdoc.cern.ch/cms/TRIDAS/horizontal/RUWG/DAQ_IF_guide/DAQ_IF_guide.html
147  class FEDDAQHeader
148  {
149  public:
150  FEDDAQHeader() { }
151  explicit FEDDAQHeader(const uint8_t* header);
152  //0x5 in first fragment
153  uint8_t boeNibble() const;
154  uint8_t eventTypeNibble() const;
155  FEDDAQEventType eventType() const;
156  uint32_t l1ID() const;
157  uint16_t bxID() const;
158  uint16_t sourceID() const;
159  uint8_t version() const;
160  //0 if current header word is last, 1 otherwise
161  bool hBit() const;
162  bool lastHeader() const;
163  void print(std::ostream& os) const;
164  //used by digi2Raw
165  const uint8_t* data() const;
166  FEDDAQHeader& setEventType(const FEDDAQEventType evtType);
167  FEDDAQHeader& setL1ID(const uint32_t l1ID);
168  FEDDAQHeader& setBXID(const uint16_t bxID);
169  FEDDAQHeader& setSourceID(const uint16_t sourceID);
170  FEDDAQHeader(const uint32_t l1ID, const uint16_t bxID, const uint16_t sourceID,
171  const FEDDAQEventType evtType = DAQ_EVENT_TYPE_PHYSICS);
172  private:
173  uint8_t header_[8];
174  };
175 
176  //see http://cmsdoc.cern.ch/cms/TRIDAS/horizontal/RUWG/DAQ_IF_guide/DAQ_IF_guide.html
177  class FEDDAQTrailer
178  {
179  public:
180  FEDDAQTrailer() { }
181  explicit FEDDAQTrailer(const uint8_t* trailer);
182  //0xA in first fragment
183  uint8_t eoeNibble() const;
184  uint32_t eventLengthIn64BitWords() const;
185  uint32_t eventLengthInBytes() const;
186  uint16_t crc() const;
187  //set to 1 if FRL detects a transmission error over S-link
188  bool cBit() const;
189  bool slinkTransmissionError() const { return cBit(); }
190  //set to 1 if the FED ID is not the one expected by the FRL
191  bool fBit() const;
192  bool badSourceID() const { return fBit(); }
193  uint8_t eventStatusNibble() const;
194  uint8_t ttsNibble() const;
195  FEDTTSBits ttsBits() const;
196  //0 if the current trailer is the last, 1 otherwise
197  bool tBit() const;
198  bool lastTrailer() const { return !tBit(); }
199  //set to 1 if the S-link sender card detects a CRC error (the CRC it computes is put in the CRC field)
200  bool rBit() const;
201  bool slinkCRCError() const { return rBit(); }
202  void print(std::ostream& os) const;
203  //used by digi2Raw
204  const uint8_t* data() const;
205  FEDDAQTrailer& setEventLengthIn64BitWords(const uint32_t eventLengthIn64BitWords);
206  FEDDAQTrailer& setCRC(const uint16_t crc);
207  FEDDAQTrailer& setSLinkTransmissionErrorBit(const bool bitSet);
208  FEDDAQTrailer& setBadSourceIDBit(const bool bitSet);
209  FEDDAQTrailer& setSLinkCRCErrorBit(const bool bitSet);
210  FEDDAQTrailer& setEventStatusNibble(const uint8_t eventStatusNibble);
211  FEDDAQTrailer& setTTSBits(const FEDTTSBits ttsBits);
212  FEDDAQTrailer(const uint32_t eventLengthIn64BitWords, const uint16_t crc = 0, const FEDTTSBits ttsBits = TTS_READY,
213  const bool slinkTransmissionError = false, const bool badFEDID = false, const bool slinkCRCError = false,
214  const uint8_t eventStatusNibble = 0);
215  private:
216  uint8_t trailer_[8];
217  };
218 
219  class FEDStatusRegister
220  {
221  public:
222  FEDStatusRegister(const uint16_t fedStatusRegister);
223  bool slinkFullFlag() const;
224  bool trackerHeaderMonitorDataReadyFlag() const;
225  bool qdrMemoryFullFlag() const;
226  bool qdrMemoryPartialFullFlag() const;
227  bool qdrMemoryEmptyFlag() const;
228  bool l1aBxFIFOFullFlag() const;
229  bool l1aBxFIFOPartialFullFlag() const;
230  bool l1aBxFIFOEmptyFlag() const;
231  FEDBufferState qdrMemoryState() const;
232  FEDBufferState l1aBxFIFOState() const;
233  bool feDataMissingFlag(const uint8_t internalFEUnitNum) const;
234  void print(std::ostream& os) const;
235  void printFlags(std::ostream& os) const;
236  operator uint16_t () const;
237  //used by digi2Raw
238  FEDStatusRegister& setSLinkFullFlag(const bool bitSet);
239  FEDStatusRegister& setTrackerHeaderMonitorDataReadyFlag(const bool bitSet);
240  FEDStatusRegister& setQDRMemoryBufferState(const FEDBufferState state);
241  FEDStatusRegister& setL1ABXFIFOBufferState(const FEDBufferState state);
242  FEDStatusRegister(const FEDBufferState qdrMemoryBufferState = BUFFER_STATE_UNSET,
243  const FEDBufferState l1aBxFIFOBufferState = BUFFER_STATE_UNSET,
244  const bool trackerHeaderMonitorDataReadyFlagSet = false,
245  const bool slinkFullFlagSet = false);
246  private:
247  bool getBit(const uint8_t num) const;
248  void setBit(const uint8_t num, const bool bitSet);
249  void setQDRMemoryFullFlag(const bool bitSet);
250  void setQDRMemoryPartialFullFlag(const bool bitSet);
251  void setQDRMemoryEmptyFlag(const bool bitSet);
252  void setL1ABXFIFOFullFlag(const bool bitSet);
253  void setL1ABXFIFOPartialFullFlag(const bool bitSet);
254  void setL1ABXFIFOEmptyFlag(const bool bitSet);
255  uint16_t data_;
256  };
257 
258  class TrackerSpecialHeader
259  {
260  public:
261  TrackerSpecialHeader();
262  //construct with a pointer to the data. The data will be coppied and swapped if necessary.
263  explicit TrackerSpecialHeader(const uint8_t* headerPointer);
264  uint8_t bufferFormatByte() const;
265  FEDBufferFormat bufferFormat() const;
266  uint8_t headerTypeNibble() const;
267  FEDHeaderType headerType() const;
268  uint8_t trackerEventTypeNibble() const;
269  FEDReadoutMode readoutMode() const;
270  FEDDataType dataType() const;
271  uint8_t apveAddress() const;
272  uint8_t apvAddressErrorRegister() const;
273  bool majorityAddressErrorForFEUnit(const uint8_t internalFEUnitNum) const;
274  uint8_t feEnableRegister() const;
275  bool feEnabled(const uint8_t internalFEUnitNum) const;
276  uint8_t feOverflowRegister() const;
277  bool feOverflow(const uint8_t internalFEUnitNum) const;
278  uint16_t fedStatusRegisterWord() const;
279  FEDStatusRegister fedStatusRegister() const;
280  void print(std::ostream& os) const;
281  //used by digi2Raw
282  //returns ordered buffer (ie this may need to be swapped to get original order)
283  const uint8_t* data() const;
284  bool wasSwapped() const;
285  TrackerSpecialHeader& setBufferFormat(const FEDBufferFormat newBufferFormat);
286  TrackerSpecialHeader& setHeaderType(const FEDHeaderType headerType);
287  TrackerSpecialHeader& setReadoutMode(const FEDReadoutMode readoutMode);
288  TrackerSpecialHeader& setDataType(const FEDDataType dataType);
289  TrackerSpecialHeader& setAPVEAddress(const uint8_t address);
290  TrackerSpecialHeader& setAPVEAddressErrorRegister(const uint8_t addressErrorRegister);
291  TrackerSpecialHeader& setAPVAddressErrorForFEUnit(const uint8_t internalFEUnitNum, const bool error);
292  TrackerSpecialHeader& setFEEnableRegister(const uint8_t feEnableRegister);
293  TrackerSpecialHeader& setFEEnableForFEUnit(const uint8_t internalFEUnitNum, const bool enabled);
294  TrackerSpecialHeader& setFEOverflowRegister(const uint8_t feOverflowRegister);
295  TrackerSpecialHeader& setFEOverflowForFEUnit(const uint8_t internalFEUnitNum, const bool overflow);
296  TrackerSpecialHeader& setFEDStatusRegister(const FEDStatusRegister fedStatusRegister);
297  TrackerSpecialHeader(const FEDBufferFormat bufferFormat, const FEDReadoutMode readoutMode,
298  const FEDHeaderType headerType, const FEDDataType dataType,
299  const uint8_t address = 0x00, const uint8_t addressErrorRegister = 0x00,
300  const uint8_t feEnableRegister = 0xFF, const uint8_t feOverflowRegister = 0x00,
301  const FEDStatusRegister fedStatusRegister = FEDStatusRegister());
302  private:
303  void setBufferFormatByte(const FEDBufferFormat newBufferFormat);
304  void setHeaderTypeNibble(const uint8_t value);
305  void setReadoutModeBits(const uint8_t value);
306  void setDataTypeBit(const bool value);
307  enum byteIndicies { FEDSTATUS=0, FEOVERFLOW=2, FEENABLE=3, ADDRESSERROR=4, APVEADDRESS=5, BUFFERTYPE=6, BUFFERFORMAT=7 };
308  //copy of header, 32 bit word swapped if needed
309  uint8_t specialHeader_[8];
310  //was the header word swapped wrt order in buffer?
311  bool wordSwapped_;
312  };
313 
314  class FEDBackendStatusRegister
315  {
316  public:
317  FEDBackendStatusRegister(const uint32_t backendStatusRegister);
318  bool internalFreezeFlag() const;
319  bool slinkDownFlag() const;
320  bool slinkFullFlag() const;
321  bool backpressureFlag() const;
322  bool ttcReadyFlag() const;
323  bool trackerHeaderMonitorDataReadyFlag() const;
324  FEDBufferState qdrMemoryState() const;
325  FEDBufferState frameAddressFIFOState() const;
326  FEDBufferState totalLengthFIFOState() const;
327  FEDBufferState trackerHeaderFIFOState() const;
328  FEDBufferState l1aBxFIFOState() const;
329  FEDBufferState feEventLengthFIFOState() const;
330  FEDBufferState feFPGABufferState() const;
331  void print(std::ostream& os) const;
332  void printFlags(std::ostream& os) const;
333  operator uint32_t () const;
334  //used by digi2Raw
335  FEDBackendStatusRegister& setInternalFreezeFlag(const bool bitSet);
336  FEDBackendStatusRegister& setSLinkDownFlag(const bool bitSet);
337  FEDBackendStatusRegister& setSLinkFullFlag(const bool bitSet);
338  FEDBackendStatusRegister& setBackpressureFlag(const bool bitSet);
339  FEDBackendStatusRegister& setTTCReadyFlag(const bool bitSet);
340  FEDBackendStatusRegister& setTrackerHeaderMonitorDataReadyFlag(const bool bitSet);
341  FEDBackendStatusRegister& setQDRMemoryState(const FEDBufferState state);
342  FEDBackendStatusRegister& setFrameAddressFIFOState(const FEDBufferState state);
343  FEDBackendStatusRegister& setTotalLengthFIFOState(const FEDBufferState state);
344  FEDBackendStatusRegister& setTrackerHeaderFIFOState(const FEDBufferState state);
345  FEDBackendStatusRegister& setL1ABXFIFOState(const FEDBufferState state);
346  FEDBackendStatusRegister& setFEEventLengthFIFOState(const FEDBufferState state);
347  FEDBackendStatusRegister& setFEFPGABufferState(const FEDBufferState state);
348  FEDBackendStatusRegister(const FEDBufferState qdrMemoryBufferState = BUFFER_STATE_UNSET,
349  const FEDBufferState frameAddressFIFOBufferState = BUFFER_STATE_UNSET,
350  const FEDBufferState totalLengthFIFOBufferState = BUFFER_STATE_UNSET,
351  const FEDBufferState trackerHeaderFIFOBufferState = BUFFER_STATE_UNSET,
352  const FEDBufferState l1aBxFIFOBufferState = BUFFER_STATE_UNSET,
353  const FEDBufferState feEventLengthFIFOBufferState = BUFFER_STATE_UNSET,
354  const FEDBufferState feFPGABufferState = BUFFER_STATE_UNSET,
355  const bool backpressure = false, const bool slinkFull = false,
356  const bool slinkDown = false, const bool internalFreeze = false,
357  const bool trackerHeaderMonitorDataReady = false, const bool ttcReady = true);
358  private:
359  bool getBit(const uint8_t num) const;
360  void setBit(const uint8_t num, const bool bitSet);
361  //get the state of the buffer in position 'bufferPosition'
362  FEDBufferState getBufferState(const uint8_t bufferPosition) const;
363  //set the state of the buffer in position 'bufferPosition' to state 'state'
364  void setBufferSate(const uint8_t bufferPosition, const FEDBufferState state);
365  void printFlagsForBuffer(const FEDBufferState bufferState, const std::string name, std::ostream& os) const;
366  //constants marking order of flags in buffer
367  //eg. bit offset for L1A/BX FIFO Partial full flag is STATE_OFFSET_PARTIAL_FULL+BUFFER_POSITION_L1ABX_FIFO
368  // bit offset for total length FIFO empty flag is STATE_OFFSET_EMPTY+BUFFER_POSITION_TOTAL_LENGTH_FIFO
369  //see BE FPGA technical description
370  enum bufferPositions { BUFFER_POSITION_QDR_MEMORY=0,
371  BUFFER_POSITION_FRAME_ADDRESS_FIFO=1,
372  BUFFER_POSITION_TOTAL_LENGTH_FIFO=2,
373  BUFFER_POSITION_TRACKER_HEADER_FIFO=3,
374  BUFFER_POSITION_L1ABX_FIFO=4,
375  BUFFER_POSITION_FE_EVENT_LENGTH_FIFO=5,
376  BUFFER_POSITION_FE_FPGA_BUFFER=6 };
377  enum stateOffsets { STATE_OFFSET_FULL=8,
378  STATE_OFFSET_PARTIAL_FULL=16,
379  STATE_OFFSET_EMPTY=24 };
380  uint32_t data_;
381  };
382 
383  class FEDFEHeader
384  {
385  public:
386  //factory function: allocates new FEDFEHeader derrivative of appropriate type
387  static std::auto_ptr<FEDFEHeader> newFEHeader(const FEDHeaderType headerType, const uint8_t* headerBuffer);
388  //used by digi2Raw
389  static std::auto_ptr<FEDFEHeader> newFEHeader(const FEDHeaderType headerType);
390  //create a buffer to use with digi2Raw
391  static std::auto_ptr<FEDFEHeader> newFEFakeHeader(const FEDHeaderType headerType);
392  virtual ~FEDFEHeader();
393  //the length of the header
394  virtual size_t lengthInBytes() const = 0;
395  //check that there are no errors indicated in which ever error bits are available in the header
396  //check bits for both APVs on a channel
397  bool checkChannelStatusBits(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const;
398  virtual bool checkChannelStatusBits(const uint8_t internalFEDChannelNum) const = 0;
399  //check bits for one APV
400  bool checkStatusBits(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const uint8_t apvNum) const;
401  virtual bool checkStatusBits(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const = 0;
402  virtual void print(std::ostream& os) const = 0;
403  virtual FEDFEHeader* clone() const = 0;
404  //used by digi2Raw
405  virtual const uint8_t* data() const = 0;
406  virtual void setChannelStatus(const uint8_t internalFEDChannelNum, const FEDChannelStatus status) = 0;
407  virtual void setFEUnitMajorityAddress(const uint8_t internalFEUnitNum, const uint8_t address) = 0;
408  virtual void setBEStatusRegister(const FEDBackendStatusRegister beStatusRegister) = 0;
409  virtual void setFEUnitLength(const uint8_t internalFEUnitNum, const uint16_t length) = 0;
410  void setChannelStatus(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const FEDChannelStatus status);
411  };
412 
413  class FEDAPVErrorHeader final : public FEDFEHeader
414  {
415  public:
416  explicit FEDAPVErrorHeader(const uint8_t* headerBuffer);
417  virtual ~FEDAPVErrorHeader();
418  virtual size_t lengthInBytes() const;
419  virtual bool checkChannelStatusBits(const uint8_t internalFEDChannelNum) const;
420  virtual bool checkStatusBits(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const;
421  virtual void print(std::ostream& os) const;
422  virtual FEDAPVErrorHeader* clone() const;
423  //used by digi2Raw
424  virtual const uint8_t* data() const;
425  FEDAPVErrorHeader& setAPVStatusBit(const uint8_t internalFEDChannelNum, const uint8_t apvNum, const bool apvGood);
426  FEDAPVErrorHeader& setAPVStatusBit(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const uint8_t apvNum, const bool apvGood);
427  FEDAPVErrorHeader(const std::vector<bool>& apvsGood = std::vector<bool>(APVS_PER_FED,true));
428  //Information which is not present in APVError mode is allowed to be set here so that the methods can be called on the base class without caring
429  //if the values need to be set.
430  virtual void setChannelStatus(const uint8_t internalFEDChannelNum, const FEDChannelStatus status);
431  virtual void setFEUnitMajorityAddress(const uint8_t internalFEUnitNum, const uint8_t address);
432  virtual void setBEStatusRegister(const FEDBackendStatusRegister beStatusRegister);
433  virtual void setFEUnitLength(const uint8_t internalFEUnitNum, const uint16_t length);
434  private:
435  static const size_t APV_ERROR_HEADER_SIZE_IN_64BIT_WORDS = 3;
436  static const size_t APV_ERROR_HEADER_SIZE_IN_BYTES = APV_ERROR_HEADER_SIZE_IN_64BIT_WORDS*8;
437  uint8_t header_[APV_ERROR_HEADER_SIZE_IN_BYTES];
438  };
439 
440  class FEDFullDebugHeader final : public FEDFEHeader
441  {
442  public:
443  explicit FEDFullDebugHeader(const uint8_t* headerBuffer);
444  virtual ~FEDFullDebugHeader();
445  virtual size_t lengthInBytes() const;
446  virtual bool checkChannelStatusBits(const uint8_t internalFEDChannelNum) const;
447  virtual bool checkStatusBits(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const;
448  virtual void print(std::ostream& os) const;
449  virtual FEDFullDebugHeader* clone() const;
450 
451  uint8_t feUnitMajorityAddress(const uint8_t internalFEUnitNum) const;
452  FEDBackendStatusRegister beStatusRegister() const;
453  uint32_t daqRegister() const;
454  uint32_t daqRegister2() const;
455  uint16_t feUnitLength(const uint8_t internalFEUnitNum) const;
456  bool fePresent(const uint8_t internalFEUnitNum) const;
457 
458  FEDChannelStatus getChannelStatus(const uint8_t internalFEDChannelNum) const;
459  FEDChannelStatus getChannelStatus(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const;
460 
461  //These methods return true if there was an error of the appropriate type (ie if the error bit is 0).
462  //They return false if the error could not occur due to a more general error.
463  //was channel unlocked
464  bool unlocked(const uint8_t internalFEDChannelNum) const;
465  bool unlocked(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const;
466  //was channel out of sync if it was unlocked
467  bool outOfSync(const uint8_t internalFEDChannelNum) const;
468  bool outOfSync(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const;
469  //was there an internal APV error if it was in sync
470  bool apvError(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const;
471  bool apvError(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const uint8_t apvNum) const;
472  //was the APV address wrong if it was in sync (does not depend on APV internal error bit)
473  bool apvAddressError(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const;
474  bool apvAddressError(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const uint8_t apvNum) const;
475 
476  //used by digi2Raw
477  virtual const uint8_t* data() const;
478  virtual void setChannelStatus(const uint8_t internalFEDChannelNum, const FEDChannelStatus status);
479  virtual void setFEUnitMajorityAddress(const uint8_t internalFEUnitNum, const uint8_t address);
480  virtual void setBEStatusRegister(const FEDBackendStatusRegister beStatusRegister);
481  virtual void setDAQRegister(const uint32_t daqRegister);
482  virtual void setDAQRegister2(const uint32_t daqRegister2);
483  virtual void setFEUnitLength(const uint8_t internalFEUnitNum, const uint16_t length);
484  FEDFullDebugHeader(const std::vector<uint16_t>& feUnitLengths = std::vector<uint16_t>(FEUNITS_PER_FED,0),
485  const std::vector<uint8_t>& feMajorityAddresses = std::vector<uint8_t>(FEUNITS_PER_FED,0),
486  const std::vector<FEDChannelStatus>& channelStatus = std::vector<FEDChannelStatus>(FEDCH_PER_FED,CHANNEL_STATUS_NO_PROBLEMS),
487  const FEDBackendStatusRegister beStatusRegister = FEDBackendStatusRegister(),
488  const uint32_t daqRegister = 0, const uint32_t daqRegister2 = 0);
489  private:
490  bool getBit(const uint8_t internalFEDChannelNum, const uint8_t bit) const;
491  static uint32_t get32BitWordFrom(const uint8_t* startOfWord);
492  static void set32BitWordAt(uint8_t* startOfWord, const uint32_t value);
493  const uint8_t* feWord(const uint8_t internalFEUnitNum) const;
494  uint8_t* feWord(const uint8_t internalFEUnitNum);
495  void setBit(const uint8_t internalFEDChannelNum, const uint8_t bit, const bool value);
496 
497  //These methods return true if there was an error of the appropriate type (ie if the error bit is 0).
498  //They ignore any previous errors which make the status bits meaningless and return the value of the bit anyway.
499  //In general, the methods above which only return an error for the likely cause are more useful.
500  bool unlockedFromBit(const uint8_t internalFEDChannelNum) const;
501  bool outOfSyncFromBit(const uint8_t internalFEDChannelNum) const;
502  bool apvErrorFromBit(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const;
503  bool apvAddressErrorFromBit(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const;
504 
505  //following methods set the bits to 1 (no error) if value is false
506  void setUnlocked(const uint8_t internalFEDChannelNum, const bool value);
507  void setOutOfSync(const uint8_t internalFEDChannelNum, const bool value);
508  void setAPVAddressError(const uint8_t internalFEDChannelNum, const uint8_t apvNum, const bool value);
509  void setAPVError(const uint8_t internalFEDChannelNum, const uint8_t apvNum, const bool value);
510  static const size_t FULL_DEBUG_HEADER_SIZE_IN_64BIT_WORDS = FEUNITS_PER_FED*2;
511  static const size_t FULL_DEBUG_HEADER_SIZE_IN_BYTES = FULL_DEBUG_HEADER_SIZE_IN_64BIT_WORDS*8;
512  uint8_t header_[FULL_DEBUG_HEADER_SIZE_IN_BYTES];
513  };
514 
515  //holds information about position of a channel in the buffer for use by unpacker
516  class FEDChannel
517  {
518  public:
519  FEDChannel(const uint8_t*const data, const size_t offset, const uint16_t length);
520  //gets length from first 2 bytes (assuming normal FED channel)
521  FEDChannel(const uint8_t*const data, const size_t offset);
522  uint16_t length() const;
523  const uint8_t* data() const;
524  size_t offset() const;
525  uint16_t cmMedian(const uint8_t apvIndex) const;
526  private:
527  friend class FEDBuffer;
528  //third byte of channel data for normal FED channels
529  uint8_t packetCode() const;
530  const uint8_t* data_;
531  size_t offset_;
532  uint16_t length_;
533  };
534 
535  //base class for sistrip FED buffers which have a DAQ header/trailer and tracker special header
536  class FEDBufferBase
537  {
538  public:
539  FEDBufferBase(const uint8_t* fedBuffer, const size_t fedBufferSize, const bool allowUnrecognizedFormat = false);
540  virtual ~FEDBufferBase();
541  //dump buffer to stream
542  void dump(std::ostream& os) const;
543  //dump original buffer before word swapping
544  void dumpOriginalBuffer(std::ostream& os) const;
545  virtual void print(std::ostream& os) const;
546  //calculate the CRC from the buffer
547  uint16_t calcCRC() const;
548 
549  //methods to get parts of the buffer
550  FEDDAQHeader daqHeader() const;
551  FEDDAQTrailer daqTrailer() const;
552  size_t bufferSize() const;
553  TrackerSpecialHeader trackerSpecialHeader() const;
554  //methods to get info from DAQ header
555  FEDDAQEventType daqEventType() const;
556  uint32_t daqLvl1ID() const;
557  uint16_t daqBXID() const;
558  uint16_t daqSourceID() const;
559  uint16_t sourceID() const;
560  //methods to get info from DAQ trailer
561  uint32_t daqEventLengthIn64bitWords() const;
562  uint32_t daqEventLengthInBytes() const;
563  uint16_t daqCRC() const;
564  FEDTTSBits daqTTSState() const;
565  //methods to get info from the tracker special header
566  FEDBufferFormat bufferFormat() const;
567  FEDHeaderType headerType() const;
568  FEDReadoutMode readoutMode() const;
569  FEDDataType dataType() const;
570  uint8_t apveAddress() const;
571  bool majorityAddressErrorForFEUnit(const uint8_t internalFEUnitNum) const;
572  bool feEnabled(const uint8_t internalFEUnitNum) const;
573  uint8_t nFEUnitsEnabled() const;
574  bool feOverflow(const uint8_t internalFEUnitNum) const;
575  FEDStatusRegister fedStatusRegister() const;
576 
577  //check that channel has no errors
578  virtual bool channelGood(const uint8_t internalFEDChannelNum) const;
579  bool channelGood(const uint8_t internalFEUnitNum, const uint8_t internalChannelNum) const;
580  //return channel object for channel
581  const FEDChannel& channel(const uint8_t internalFEDChannelNum) const;
582  const FEDChannel& channel(const uint8_t internalFEUnitNum, const uint8_t internalChannelNum) const;
583 
584  //summary checks
585  //check that tracker special header is valid (does not check for FE unit errors indicated in special header)
586  bool doTrackerSpecialHeaderChecks() const;
587  //check for errors in DAQ heaqder and trailer (not including bad CRC)
588  bool doDAQHeaderAndTrailerChecks() const;
589  //do both
590  virtual bool doChecks() const;
591  //print the result of all detailed checks
592  virtual std::string checkSummary() const;
593 
594  //detailed checks
595  bool checkCRC() const;
596  bool checkMajorityAddresses() const;
597  //methods to check tracker special header
598  bool checkBufferFormat() const;
599  bool checkHeaderType() const;
600  bool checkReadoutMode() const;
601  bool checkAPVEAddressValid() const;
602  bool checkNoFEOverflows() const;
603  //methods to check daq header and trailer
604  bool checkNoSlinkCRCError() const;
605  bool checkNoSLinkTransmissionError() const;
606  bool checkSourceIDs() const;
607  bool checkNoUnexpectedSourceID() const;
608  bool checkNoExtraHeadersOrTrailers() const;
609  bool checkLengthFromTrailer() const;
610  protected:
611  const uint8_t* getPointerToDataAfterTrackerSpecialHeader() const;
612  const uint8_t* getPointerToByteAfterEndOfPayload() const;
613  FEDBufferBase(const uint8_t* fedBuffer, const size_t fedBufferSize, const bool allowUnrecognizedFormat, const bool fillChannelVector);
614  std::vector<FEDChannel> channels_;
615  private:
616  void init(const uint8_t* fedBuffer, const size_t fedBufferSize, const bool allowUnrecognizedFormat);
617  const uint8_t* originalBuffer_;
618  const uint8_t* orderedBuffer_;
619  const size_t bufferSize_;
620  FEDDAQHeader daqHeader_;
621  FEDDAQTrailer daqTrailer_;
622  TrackerSpecialHeader specialHeader_;
623  };
624 
625  //
626  // Inline function definitions
627  //
628 
629  inline std::ostream& operator << (std::ostream& os, const FEDBufferBase& obj) { obj.print(os); os << obj.checkSummary(); return os; }
630 
631  inline uint8_t internalFEDChannelNum(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum)
632  {
633  return (internalFEUnitNum*FEDCH_PER_FEUNIT + internalFEUnitChannelNum);
634  }
635 
636  inline std::ostream& operator << (std::ostream& os, const FEDDAQHeader& obj) { obj.print(os); return os; }
637  inline std::ostream& operator << (std::ostream& os, const FEDDAQTrailer& obj) { obj.print(os); return os; }
638  inline std::ostream& operator << (std::ostream& os, const TrackerSpecialHeader& obj) { obj.print(os); return os; }
639  inline std::ostream& operator << (std::ostream& os, const FEDStatusRegister& obj) { obj.print(os); return os; }
640  inline std::ostream& operator << (std::ostream& os, const FEDFEHeader& obj) { obj.print(os); return os; }
641 
642  //FEDStripOrdering
643 
644  inline uint8_t FEDStripOrdering::physicalOrderForStripInChannel(const uint8_t readoutOrderStripIndexInChannel)
645  {
646  return physicalOrderForStripInAPV(readoutOrderStripIndexInChannel/2) + (readoutOrderStripIndexInChannel%2)*STRIPS_PER_APV;
647  }
648 
649  inline uint8_t FEDStripOrdering::readoutOrderForStripInChannel(const uint8_t physicalOrderStripIndexInChannel)
650  {
651  return ( readoutOrderForStripInAPV(physicalOrderStripIndexInChannel%128)*2 + (physicalOrderStripIndexInChannel/128) );
652  }
653 
654  inline uint8_t FEDStripOrdering::physicalOrderForStripInAPV(const uint8_t readout_order)
655  {
656  return ( (32 * (readout_order%4)) +
657  (8 * static_cast<uint16_t>(static_cast<float>(readout_order)/4.0)) -
658  (31 * static_cast<uint16_t>(static_cast<float>(readout_order)/16.0))
659  );
660  }
661 
662  inline uint8_t FEDStripOrdering::readoutOrderForStripInAPV(const uint8_t physical_order)
663  {
664  return ( 4*((static_cast<uint16_t>((static_cast<float>(physical_order)/8.0)))%4) +
665  static_cast<uint16_t>(static_cast<float>(physical_order)/32.0) +
666  16*(physical_order%8)
667  );
668  }
669 
670  //TrackerSpecialHeader
671 
672  inline TrackerSpecialHeader::TrackerSpecialHeader()
673  : wordSwapped_(false)
674  {
675  }
676 
677  inline uint8_t TrackerSpecialHeader::bufferFormatByte() const
678  { return specialHeader_[BUFFERFORMAT]; }
679 
680  inline uint8_t TrackerSpecialHeader::headerTypeNibble() const
681  { return ( (specialHeader_[BUFFERTYPE] & 0xF0) >> 4 ); }
682 
683  inline uint8_t TrackerSpecialHeader::trackerEventTypeNibble() const
684  { return (specialHeader_[BUFFERTYPE] & 0x0F); }
685 
686  inline uint8_t TrackerSpecialHeader::apveAddress() const
687  { return specialHeader_[APVEADDRESS]; }
688 
689  inline uint8_t TrackerSpecialHeader::apvAddressErrorRegister() const
690  { return specialHeader_[ADDRESSERROR]; }
691 
692  inline bool TrackerSpecialHeader::majorityAddressErrorForFEUnit(const uint8_t internalFEUnitNum) const
693  {
694  return ( !(readoutMode() == READOUT_MODE_SCOPE) && !( (0x1<<internalFEUnitNum) & apvAddressErrorRegister() ) );
695  }
696 
697  inline uint8_t TrackerSpecialHeader::feEnableRegister() const
698  { return specialHeader_[FEENABLE]; }
699 
700  inline bool TrackerSpecialHeader::feEnabled(const uint8_t internalFEUnitNum) const
701  {
702  return ( (0x1<<internalFEUnitNum) & feEnableRegister() );
703  }
704 
705  inline uint8_t TrackerSpecialHeader::feOverflowRegister() const
706  { return specialHeader_[FEOVERFLOW]; }
707 
708  inline bool TrackerSpecialHeader::feOverflow(const uint8_t internalFEUnitNum) const
709  {
710  return ( (0x1<<internalFEUnitNum) & feOverflowRegister() );
711  }
712 
713  inline uint16_t TrackerSpecialHeader::fedStatusRegisterWord() const
714  {
715  //get 16 bits
716  uint16_t statusRegister = ( (specialHeader_[(FEDSTATUS+1)]<<8) | specialHeader_[FEDSTATUS]);
717  return statusRegister;
718  }
719 
720  inline FEDStatusRegister TrackerSpecialHeader::fedStatusRegister() const
721  { return FEDStatusRegister(fedStatusRegisterWord()); }
722 
723  inline void TrackerSpecialHeader::print(std::ostream& os) const
724  { printHex(specialHeader_,8,os); }
725 
726  inline const uint8_t* TrackerSpecialHeader::data() const
727  {
728  return specialHeader_;
729  }
730 
731  inline bool TrackerSpecialHeader::wasSwapped() const
732  {
733  return wordSwapped_;
734  }
735 
736  inline void TrackerSpecialHeader::setHeaderTypeNibble(const uint8_t value)
737  {
738  specialHeader_[BUFFERTYPE] = ( (specialHeader_[BUFFERTYPE] & 0x0F) | ((value<<4) & 0xF0) );
739  }
740 
741  inline void TrackerSpecialHeader::setReadoutModeBits(const uint8_t value)
742  {
743  specialHeader_[BUFFERTYPE] = ( (specialHeader_[BUFFERTYPE] & (~0x0E)) | (value & 0x0E) );
744  }
745 
746  inline void TrackerSpecialHeader::setDataTypeBit(const bool value)
747  {
748  specialHeader_[BUFFERTYPE] = ( (specialHeader_[BUFFERTYPE] & (~0x01)) | (value ? 0x01 : 0x00) );
749  }
750 
751  inline TrackerSpecialHeader& TrackerSpecialHeader::setAPVEAddress(const uint8_t address)
752  {
753  specialHeader_[APVEADDRESS] = address;
754  return *this;
755  }
756 
757  inline TrackerSpecialHeader& TrackerSpecialHeader::setAPVEAddressErrorRegister(const uint8_t addressErrorRegister)
758  {
759  specialHeader_[ADDRESSERROR] = addressErrorRegister;
760  return *this;
761  }
762 
763  inline TrackerSpecialHeader& TrackerSpecialHeader::setFEEnableRegister(const uint8_t feEnableRegister)
764  {
765  specialHeader_[FEENABLE] = feEnableRegister;
766  return *this;
767  }
768 
769  inline TrackerSpecialHeader& TrackerSpecialHeader::setFEOverflowRegister(const uint8_t feOverflowRegister)
770  {
771  specialHeader_[FEOVERFLOW] = feOverflowRegister;
772  return *this;
773  }
774 
775  inline TrackerSpecialHeader& TrackerSpecialHeader::setFEDStatusRegister(const FEDStatusRegister fedStatusRegister)
776  {
777  specialHeader_[FEDSTATUS] = (static_cast<uint16_t>(fedStatusRegister) & 0x00FF);
778  specialHeader_[FEDSTATUS+1] = ( (static_cast<uint16_t>(fedStatusRegister) & 0xFF00) >> 8);
779  return *this;
780  }
781 
782  //FEDStatusRegister
783 
784  inline FEDStatusRegister::FEDStatusRegister(const uint16_t fedStatusRegister)
785  : data_(fedStatusRegister) { }
786 
787  inline FEDStatusRegister::operator uint16_t () const
788  { return data_; }
789 
790  inline bool FEDStatusRegister::getBit(const uint8_t num) const
791  { return ( (0x1<<num) & (data_) ); }
792 
793  inline bool FEDStatusRegister::slinkFullFlag() const
794  { return getBit(0); }
795 
796  inline bool FEDStatusRegister::trackerHeaderMonitorDataReadyFlag() const
797  { return getBit(1); }
798 
799  inline bool FEDStatusRegister::qdrMemoryFullFlag() const
800  { return getBit(2); }
801 
802  inline bool FEDStatusRegister::qdrMemoryPartialFullFlag() const
803  { return getBit(3); }
804 
805  inline bool FEDStatusRegister::qdrMemoryEmptyFlag() const
806  { return getBit(4); }
807 
808  inline bool FEDStatusRegister::l1aBxFIFOFullFlag() const
809  { return getBit(5); }
810 
811  inline bool FEDStatusRegister::l1aBxFIFOPartialFullFlag() const
812  { return getBit(6); }
813 
814  inline bool FEDStatusRegister::l1aBxFIFOEmptyFlag() const
815  { return getBit(7); }
816 
817  inline bool FEDStatusRegister::feDataMissingFlag(const uint8_t internalFEUnitNum) const
818  {
819  return getBit(8+internalFEUnitNum);
820  }
821 
822  inline void FEDStatusRegister::print(std::ostream& os) const
823  { printHex(&data_,2,os); }
824 
825  inline FEDStatusRegister& FEDStatusRegister::setSLinkFullFlag(const bool bitSet)
826  { setBit(0,bitSet); return *this; }
827 
828  inline FEDStatusRegister& FEDStatusRegister::setTrackerHeaderMonitorDataReadyFlag(const bool bitSet)
829  { setBit(1,bitSet); return *this; }
830 
831  inline void FEDStatusRegister::setQDRMemoryFullFlag(const bool bitSet)
832  { setBit(2,bitSet); }
833 
834  inline void FEDStatusRegister::setQDRMemoryPartialFullFlag(const bool bitSet)
835  { setBit(3,bitSet); }
836 
837  inline void FEDStatusRegister::setQDRMemoryEmptyFlag(const bool bitSet)
838  { setBit(4,bitSet); }
839 
840  inline void FEDStatusRegister::setL1ABXFIFOFullFlag(const bool bitSet)
841  { setBit(5,bitSet); }
842 
843  inline void FEDStatusRegister::setL1ABXFIFOPartialFullFlag(const bool bitSet)
844  { setBit(6,bitSet); }
845 
846  inline void FEDStatusRegister::setL1ABXFIFOEmptyFlag(const bool bitSet)
847  { setBit(7,bitSet); }
848 
849  inline FEDStatusRegister::FEDStatusRegister(const FEDBufferState qdrMemoryBufferState, const FEDBufferState l1aBxFIFOBufferState,
850  const bool trackerHeaderMonitorDataReadyFlagSet, const bool slinkFullFlagSet)
851  : data_(0x0000)
852  {
853  setSLinkFullFlag(slinkFullFlagSet);
854  setTrackerHeaderMonitorDataReadyFlag(trackerHeaderMonitorDataReadyFlagSet);
855  setQDRMemoryBufferState(qdrMemoryBufferState);
856  setL1ABXFIFOBufferState(l1aBxFIFOBufferState);
857  }
858 
859  //FEDBackendStatusRegister
860 
861  inline FEDBackendStatusRegister::FEDBackendStatusRegister(const uint32_t backendStatusRegister)
862  : data_(backendStatusRegister) { }
863 
864  inline FEDBackendStatusRegister::operator uint32_t () const
865  { return data_; }
866 
867  inline void FEDBackendStatusRegister::print(std::ostream& os) const
868  { printHex(&data_,4,os); }
869 
870  inline bool FEDBackendStatusRegister::getBit(const uint8_t num) const
871  { return ( (0x1<<num) & (data_) ); }
872 
873  inline bool FEDBackendStatusRegister::internalFreezeFlag() const
874  { return getBit(1); }
875 
876  inline bool FEDBackendStatusRegister::slinkDownFlag() const
877  { return getBit(2); }
878 
879  inline bool FEDBackendStatusRegister::slinkFullFlag() const
880  { return getBit(3); }
881 
882  inline bool FEDBackendStatusRegister::backpressureFlag() const
883  { return getBit(4); }
884 
885  inline bool FEDBackendStatusRegister::ttcReadyFlag() const
886  { return getBit(6); }
887 
888  inline bool FEDBackendStatusRegister::trackerHeaderMonitorDataReadyFlag() const
889  { return getBit(7); }
890 
891  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setInternalFreezeFlag(const bool bitSet)
892  { setBit(1,bitSet); return *this; }
893 
894  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setSLinkDownFlag(const bool bitSet)
895  { setBit(2,bitSet); return *this; }
896 
897  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setSLinkFullFlag(const bool bitSet)
898  { setBit(3,bitSet); return *this; }
899 
900  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setBackpressureFlag(const bool bitSet)
901  { setBit(4,bitSet); return *this; }
902 
903  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setTTCReadyFlag(const bool bitSet)
904  { setBit(6,bitSet); return *this; }
905 
906  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setTrackerHeaderMonitorDataReadyFlag(const bool bitSet)
907  { setBit(7,bitSet); return *this; }
908 
909  inline FEDBufferState FEDBackendStatusRegister::qdrMemoryState() const
910  {
911  return getBufferState(BUFFER_POSITION_QDR_MEMORY);
912  }
913 
914  inline FEDBufferState FEDBackendStatusRegister::frameAddressFIFOState() const
915  {
916  return getBufferState(BUFFER_POSITION_FRAME_ADDRESS_FIFO);
917  }
918 
919  inline FEDBufferState FEDBackendStatusRegister::totalLengthFIFOState() const
920  {
921  return getBufferState(BUFFER_POSITION_TOTAL_LENGTH_FIFO);
922  }
923 
924  inline FEDBufferState FEDBackendStatusRegister::trackerHeaderFIFOState() const
925  {
926  return getBufferState(BUFFER_POSITION_TRACKER_HEADER_FIFO);
927  }
928 
929  inline FEDBufferState FEDBackendStatusRegister::l1aBxFIFOState() const
930  {
931  return getBufferState(BUFFER_POSITION_L1ABX_FIFO);
932  }
933 
934  inline FEDBufferState FEDBackendStatusRegister::feEventLengthFIFOState() const
935  {
936  return getBufferState(BUFFER_POSITION_FE_EVENT_LENGTH_FIFO);
937  }
938 
939  inline FEDBufferState FEDBackendStatusRegister::feFPGABufferState() const
940  {
941  return getBufferState(BUFFER_POSITION_FE_FPGA_BUFFER);
942  }
943 
944  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setQDRMemoryState(const FEDBufferState state)
945  {
946  setBufferSate(BUFFER_POSITION_QDR_MEMORY,state);
947  return *this;
948  }
949 
950  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setFrameAddressFIFOState(const FEDBufferState state)
951  {
952  setBufferSate(BUFFER_POSITION_FRAME_ADDRESS_FIFO,state);
953  return *this;
954  }
955 
956  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setTotalLengthFIFOState(const FEDBufferState state)
957  {
958  setBufferSate(BUFFER_POSITION_TOTAL_LENGTH_FIFO,state);
959  return *this;
960  }
961 
962  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setTrackerHeaderFIFOState(const FEDBufferState state)
963  {
964  setBufferSate(BUFFER_POSITION_TRACKER_HEADER_FIFO,state);
965  return *this;
966  }
967 
968  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setL1ABXFIFOState(const FEDBufferState state)
969  {
970  setBufferSate(BUFFER_POSITION_L1ABX_FIFO,state);
971  return *this;
972  }
973 
974  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setFEEventLengthFIFOState(const FEDBufferState state)
975  {
976  setBufferSate(BUFFER_POSITION_FE_EVENT_LENGTH_FIFO,state);
977  return *this;
978  }
979 
980  inline FEDBackendStatusRegister& FEDBackendStatusRegister::setFEFPGABufferState(const FEDBufferState state)
981  {
982  setBufferSate(BUFFER_POSITION_FE_FPGA_BUFFER,state);
983  return *this;
984  }
985 
986  //FEDFEHeader
987 
988  inline std::auto_ptr<FEDFEHeader> FEDFEHeader::newFEHeader(const FEDHeaderType headerType, const uint8_t* headerBuffer)
989  {
990  switch (headerType) {
991  case HEADER_TYPE_FULL_DEBUG:
992  return std::auto_ptr<FEDFEHeader>(new FEDFullDebugHeader(headerBuffer));
993  case HEADER_TYPE_APV_ERROR:
994  return std::auto_ptr<FEDFEHeader>(new FEDAPVErrorHeader(headerBuffer));
995  default:
996  return std::auto_ptr<FEDFEHeader>();
997  }
998  }
999 
1000  inline std::auto_ptr<FEDFEHeader> FEDFEHeader::newFEHeader(const FEDHeaderType headerType)
1001  {
1002  switch (headerType) {
1003  case HEADER_TYPE_FULL_DEBUG:
1004  return std::auto_ptr<FEDFEHeader>(new FEDFullDebugHeader());
1005  case HEADER_TYPE_APV_ERROR:
1006  return std::auto_ptr<FEDFEHeader>(new FEDAPVErrorHeader());
1007  default:
1008  return std::auto_ptr<FEDFEHeader>();
1009  }
1010  }
1011 
1012  inline std::auto_ptr<FEDFEHeader> FEDFEHeader::newFEFakeHeader(const FEDHeaderType headerType)
1013  {
1014  switch (headerType) {
1015  case HEADER_TYPE_FULL_DEBUG:
1016  return std::auto_ptr<FEDFEHeader>(new FEDFullDebugHeader);
1017  case HEADER_TYPE_APV_ERROR:
1018  return std::auto_ptr<FEDFEHeader>(new FEDAPVErrorHeader);
1019  default:
1020  return std::auto_ptr<FEDFEHeader>();
1021  }
1022  }
1023 
1024  inline bool FEDFEHeader::checkChannelStatusBits(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const
1025  {
1026  return checkChannelStatusBits(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum));
1027  }
1028 
1029  inline bool FEDFEHeader::checkStatusBits(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const uint8_t apvNum) const
1030  {
1031  return checkStatusBits(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum),apvNum);
1032  }
1033 
1034  inline void FEDFEHeader::setChannelStatus(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const FEDChannelStatus status)
1035  {
1036  this->setChannelStatus(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum),status);
1037  }
1038 
1039  inline FEDAPVErrorHeader::FEDAPVErrorHeader(const uint8_t* headerBuffer)
1040  {
1041  memcpy(header_,headerBuffer,APV_ERROR_HEADER_SIZE_IN_BYTES);
1042  }
1043 
1044  inline FEDAPVErrorHeader& FEDAPVErrorHeader::setAPVStatusBit(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum,
1045  const uint8_t apvNum, const bool apvGood)
1046  {
1047  return setAPVStatusBit(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum),apvNum,apvGood);
1048  }
1049 
1050  inline FEDFullDebugHeader::FEDFullDebugHeader(const uint8_t* headerBuffer)
1051  {
1052  memcpy(header_,headerBuffer,FULL_DEBUG_HEADER_SIZE_IN_BYTES);
1053  }
1054 
1055  inline uint8_t FEDFullDebugHeader::feUnitMajorityAddress(const uint8_t internalFEUnitNum) const
1056  {
1057  return feWord(internalFEUnitNum)[9];
1058  }
1059 
1060  inline FEDBackendStatusRegister FEDFullDebugHeader::beStatusRegister() const
1061  {
1062  return FEDBackendStatusRegister(get32BitWordFrom(feWord(0)+10));
1063  }
1064 
1065  inline uint32_t FEDFullDebugHeader::daqRegister() const
1066  {
1067  return get32BitWordFrom(feWord(7)+10);
1068  }
1069 
1070  inline uint32_t FEDFullDebugHeader::daqRegister2() const
1071  {
1072  return get32BitWordFrom(feWord(6)+10);
1073  }
1074 
1075  inline uint16_t FEDFullDebugHeader::feUnitLength(const uint8_t internalFEUnitNum) const
1076  {
1077  return ( (feWord(internalFEUnitNum)[15]<<8) | (feWord(internalFEUnitNum)[14]) );
1078  }
1079 
1080  inline bool FEDFullDebugHeader::fePresent(const uint8_t internalFEUnitNum) const
1081  {
1082  return (feUnitLength(internalFEUnitNum) != 0);
1083  }
1084 
1085  inline bool FEDFullDebugHeader::unlocked(const uint8_t internalFEDChannelNum) const
1086  {
1087  return unlockedFromBit(internalFEDChannelNum);
1088  }
1089 
1090  inline bool FEDFullDebugHeader::unlocked(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const
1091  {
1092  return unlocked(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum));
1093  }
1094 
1095  inline bool FEDFullDebugHeader::outOfSync(const uint8_t internalFEDChannelNum) const
1096  {
1097  return ( !unlocked(internalFEDChannelNum) && outOfSyncFromBit(internalFEDChannelNum) );
1098  }
1099 
1100  inline bool FEDFullDebugHeader::outOfSync(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const
1101  {
1102  return outOfSync(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum));
1103  }
1104 
1105  inline bool FEDFullDebugHeader::apvError(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
1106  {
1107  return ( !unlockedFromBit(internalFEDChannelNum) &&
1108  !outOfSyncFromBit(internalFEDChannelNum) &&
1109  apvErrorFromBit(internalFEDChannelNum,apvNum) );
1110  }
1111 
1112  inline bool FEDFullDebugHeader::apvError(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const uint8_t apvNum) const
1113  {
1114  return apvError(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum),apvNum);
1115  }
1116 
1117  inline bool FEDFullDebugHeader::apvAddressError(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
1118  {
1119  return ( !unlockedFromBit(internalFEDChannelNum) &&
1120  !outOfSyncFromBit(internalFEDChannelNum) &&
1121  apvAddressErrorFromBit(internalFEDChannelNum,apvNum) );
1122  }
1123 
1124  inline bool FEDFullDebugHeader::apvAddressError(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const uint8_t apvNum) const
1125  {
1126  return apvAddressError(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum),apvNum);
1127  }
1128 
1129  inline FEDChannelStatus FEDFullDebugHeader::getChannelStatus(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const
1130  {
1131  return getChannelStatus(internalFEDChannelNum(internalFEUnitNum,internalFEUnitChannelNum));
1132  }
1133 
1134  inline bool FEDFullDebugHeader::unlockedFromBit(const uint8_t internalFEDChannelNum) const
1135  {
1136  return !getBit(internalFEDChannelNum,5);
1137  }
1138 
1139  inline bool FEDFullDebugHeader::outOfSyncFromBit(const uint8_t internalFEDChannelNum) const
1140  {
1141  return !getBit(internalFEDChannelNum,4);
1142  }
1143 
1144  inline bool FEDFullDebugHeader::apvErrorFromBit(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
1145  {
1146  //Discovered March 2012: two bits inverted in firmware. Decided
1147  //to update documentation but keep firmware identical for
1148  //backward compatibility. So status bit order is actually:
1149  //apvErr1 - apvAddrErr0 - apvErr0 - apvAddrErr1 - OOS - unlocked.
1150  //Before, it was: return !getBit(internalFEDChannelNum,0+2*apvNum);
1151 
1152  return !getBit(internalFEDChannelNum,0+2*(1-apvNum));
1153  }
1154 
1155  inline bool FEDFullDebugHeader::apvAddressErrorFromBit(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
1156  {
1157  return !getBit(internalFEDChannelNum,1+2*apvNum);
1158  }
1159 
1160  inline bool FEDFullDebugHeader::getBit(const uint8_t internalFEDChannelNum, const uint8_t bit) const
1161  {
1162  const uint8_t* pFEWord = feWord(internalFEDChannelNum / FEDCH_PER_FEUNIT);
1163  const uint8_t bitInFeWord = ((FEDCH_PER_FEUNIT-1) - (internalFEDChannelNum%FEDCH_PER_FEUNIT)) * 6 + bit;
1164  return ( pFEWord[bitInFeWord/8] & (0x1 << (bitInFeWord%8)) );
1165  }
1166 
1167  inline uint32_t FEDFullDebugHeader::get32BitWordFrom(const uint8_t* startOfWord)
1168  {
1169  return ( startOfWord[0] | (startOfWord[1]<<8) | (startOfWord[2]<<16) | (startOfWord[3]<<24) );
1170  }
1171 
1172  inline void FEDFullDebugHeader::set32BitWordAt(uint8_t* startOfWord, const uint32_t value)
1173  {
1174  memcpy(startOfWord,&value,4);
1175  }
1176 
1177  inline const uint8_t* FEDFullDebugHeader::feWord(const uint8_t internalFEUnitNum) const
1178  {
1179  return header_+internalFEUnitNum*2*8;
1180  }
1181 
1182  //re-use const method
1183  inline uint8_t* FEDFullDebugHeader::feWord(const uint8_t internalFEUnitNum)
1184  {
1185  return const_cast<uint8_t*>(static_cast<const FEDFullDebugHeader*>(this)->feWord(internalFEUnitNum));
1186  }
1187 
1188  inline void FEDFullDebugHeader::setUnlocked(const uint8_t internalFEDChannelNum, const bool value)
1189  {
1190  setBit(internalFEDChannelNum,5,!value);
1191  }
1192 
1193  inline void FEDFullDebugHeader::setOutOfSync(const uint8_t internalFEDChannelNum, const bool value)
1194  {
1195  setBit(internalFEDChannelNum,4,!value);
1196  }
1197 
1198  inline void FEDFullDebugHeader::setAPVAddressError(const uint8_t internalFEDChannelNum, const uint8_t apvNum, const bool value)
1199  {
1200  setBit(internalFEDChannelNum,1+2*apvNum,!value);
1201  }
1202 
1203  inline void FEDFullDebugHeader::setAPVError(const uint8_t internalFEDChannelNum, const uint8_t apvNum, const bool value)
1204  {
1205  //Discovered March 2012: two bits inverted in firmware. Decided
1206  //to update documentation but keep firmware identical for
1207  //backward compatibility. So status bit order is actually:
1208  //apvErr1 - apvAddrErr0 - apvErr0 - apvAddrErr1 - OOS - unlocked.
1209  //Before, it was: return !getBit(internalFEDChannelNum,0+2*apvNum);
1210 
1211  setBit(internalFEDChannelNum,0+2*(1-apvNum),!value);
1212  }
1213 
1214  //FEDDAQHeader
1215 
1216  inline FEDDAQHeader::FEDDAQHeader(const uint8_t* header)
1217  {
1218  memcpy(header_,header,8);
1219  }
1220 
1221  inline uint8_t FEDDAQHeader::boeNibble() const
1222  {
1223  return ( (header_[7] & 0xF0) >> 4 );
1224  }
1225 
1226  inline uint8_t FEDDAQHeader::eventTypeNibble() const
1227  {
1228  return (header_[7] & 0x0F);
1229  }
1230 
1231  inline uint32_t FEDDAQHeader::l1ID() const
1232  {
1233  return ( header_[4] | (header_[5]<<8) | (header_[6]<<16) );
1234  }
1235 
1236  inline uint16_t FEDDAQHeader::bxID() const
1237  {
1238  return ( (header_[3]<<4) | ((header_[2]&0xF0)>>4) );
1239  }
1240 
1241  inline uint16_t FEDDAQHeader::sourceID() const
1242  {
1243  return ( ((header_[2]&0x0F)<<8) | header_[1] );
1244  }
1245 
1246  inline uint8_t FEDDAQHeader::version() const
1247  {
1248  return ( (header_[0] & 0xF0) >> 4 );
1249  }
1250 
1251  inline bool FEDDAQHeader::hBit() const
1252  {
1253  return (header_[0] & 0x8);
1254  }
1255 
1256  inline bool FEDDAQHeader::lastHeader() const
1257  {
1258  return !hBit();
1259  }
1260 
1261  inline const uint8_t* FEDDAQHeader::data() const
1262  {
1263  return header_;
1264  }
1265 
1266  inline void FEDDAQHeader::print(std::ostream& os) const
1267  {
1268  printHex(header_,8,os);
1269  }
1270 
1271  //FEDDAQTrailer
1272 
1273  inline FEDDAQTrailer::FEDDAQTrailer(const uint8_t* trailer)
1274  {
1275  memcpy(trailer_,trailer,8);
1276  }
1277 
1278  inline uint8_t FEDDAQTrailer::eoeNibble() const
1279  {
1280  return ( (trailer_[7] & 0xF0) >> 4 );
1281  }
1282 
1283  inline uint32_t FEDDAQTrailer::eventLengthIn64BitWords() const
1284  {
1285  return ( trailer_[4] | (trailer_[5]<<8) | (trailer_[6]<<16) );
1286  }
1287 
1288  inline uint32_t FEDDAQTrailer::eventLengthInBytes() const
1289  {
1290  return eventLengthIn64BitWords()*8;
1291  }
1292 
1293  inline uint16_t FEDDAQTrailer::crc() const
1294  {
1295  return ( trailer_[2] | (trailer_[3]<<8) );
1296  }
1297 
1298  inline bool FEDDAQTrailer::cBit() const
1299  {
1300  return (trailer_[1] & 0x80);
1301  }
1302 
1303  inline bool FEDDAQTrailer::fBit() const
1304  {
1305  return (trailer_[1] & 0x40);
1306  }
1307 
1308  inline uint8_t FEDDAQTrailer::eventStatusNibble() const
1309  {
1310  return (trailer_[1] & 0x0F);
1311  }
1312 
1313  inline uint8_t FEDDAQTrailer::ttsNibble() const
1314  {
1315  return ( (trailer_[0] & 0xF0) >> 4);
1316  }
1317 
1318  inline bool FEDDAQTrailer::tBit() const
1319  {
1320  return (trailer_[0] & 0x08);
1321  }
1322 
1323  inline bool FEDDAQTrailer::rBit() const
1324  {
1325  return (trailer_[0] & 0x04);
1326  }
1327 
1328  inline void FEDDAQTrailer::print(std::ostream& os) const
1329  {
1330  printHex(trailer_,8,os);
1331  }
1332 
1333  inline const uint8_t* FEDDAQTrailer::data() const
1334  {
1335  return trailer_;
1336  }
1337 
1338  //FEDBufferBase
1339 
1340  inline void FEDBufferBase::dump(std::ostream& os) const
1341  {
1342  printHex(orderedBuffer_,bufferSize_,os);
1343  }
1344 
1345  inline void FEDBufferBase::dumpOriginalBuffer(std::ostream& os) const
1346  {
1347  printHex(originalBuffer_,bufferSize_,os);
1348  }
1349 
1350  inline uint16_t FEDBufferBase::calcCRC() const
1351  {
1352  return calculateFEDBufferCRC(orderedBuffer_,bufferSize_);
1353  }
1354 
1355  inline FEDDAQHeader FEDBufferBase::daqHeader() const
1356  {
1357  return daqHeader_;
1358  }
1359 
1360  inline FEDDAQTrailer FEDBufferBase::daqTrailer() const
1361  {
1362  return daqTrailer_;
1363  }
1364 
1365  inline size_t FEDBufferBase::bufferSize() const
1366  {
1367  return bufferSize_;
1368  }
1369 
1370  inline TrackerSpecialHeader FEDBufferBase::trackerSpecialHeader() const
1371  {
1372  return specialHeader_;
1373  }
1374 
1375  inline FEDDAQEventType FEDBufferBase::daqEventType() const
1376  {
1377  return daqHeader_.eventType();
1378  }
1379 
1380  inline uint32_t FEDBufferBase::daqLvl1ID() const
1381  {
1382  return daqHeader_.l1ID();
1383  }
1384 
1385  inline uint16_t FEDBufferBase::daqBXID() const
1386  {
1387  return daqHeader_.bxID();
1388  }
1389 
1390  inline uint16_t FEDBufferBase::daqSourceID() const
1391  {
1392  return daqHeader_.sourceID();
1393  }
1394 
1395  inline uint32_t FEDBufferBase::daqEventLengthIn64bitWords() const
1396  {
1397  return daqTrailer_.eventLengthIn64BitWords();
1398  }
1399 
1400  inline uint32_t FEDBufferBase::daqEventLengthInBytes() const
1401  {
1402  return daqTrailer_.eventLengthInBytes();
1403  }
1404 
1405  inline uint16_t FEDBufferBase::daqCRC() const
1406  {
1407  return daqTrailer_.crc();
1408  }
1409 
1410  inline FEDTTSBits FEDBufferBase::daqTTSState() const
1411  {
1412  return daqTrailer_.ttsBits();
1413  }
1414 
1415  inline FEDBufferFormat FEDBufferBase::bufferFormat() const
1416  {
1417  return specialHeader_.bufferFormat();
1418  }
1419 
1420  inline FEDHeaderType FEDBufferBase::headerType() const
1421  {
1422  return specialHeader_.headerType();
1423  }
1424 
1425  inline FEDReadoutMode FEDBufferBase::readoutMode() const
1426  {
1427  return specialHeader_.readoutMode();
1428  }
1429 
1430  inline FEDDataType FEDBufferBase::dataType() const
1431  {
1432  return specialHeader_.dataType();
1433  }
1434 
1435  inline uint8_t FEDBufferBase::apveAddress() const
1436  {
1437  return specialHeader_.apveAddress();
1438  }
1439 
1440  inline bool FEDBufferBase::majorityAddressErrorForFEUnit(const uint8_t internalFEUnitNum) const
1441  {
1442  return (specialHeader_.majorityAddressErrorForFEUnit(internalFEUnitNum) && (specialHeader_.apveAddress() != 0x00));
1443  }
1444 
1445  inline bool FEDBufferBase::feEnabled(const uint8_t internalFEUnitNum) const
1446  {
1447  return specialHeader_.feEnabled(internalFEUnitNum);
1448  }
1449 
1450  inline bool FEDBufferBase::feOverflow(const uint8_t internalFEUnitNum) const
1451  {
1452  return specialHeader_.feOverflow(internalFEUnitNum);
1453  }
1454 
1455  inline FEDStatusRegister FEDBufferBase::fedStatusRegister() const
1456  {
1457  return specialHeader_.fedStatusRegister();
1458  }
1459 
1460  inline bool FEDBufferBase::channelGood(const uint8_t internalFEUnitNum, const uint8_t internalChannelNum) const
1461  {
1462  return channelGood(internalFEDChannelNum(internalFEUnitNum,internalChannelNum));
1463  }
1464 
1465  inline const FEDChannel& FEDBufferBase::channel(const uint8_t internalFEDChannelNum) const
1466  {
1467  return channels_[internalFEDChannelNum];
1468  }
1469 
1470  inline const FEDChannel& FEDBufferBase::channel(const uint8_t internalFEUnitNum, const uint8_t internalChannelNum) const
1471  {
1472  return channel(internalFEDChannelNum(internalFEUnitNum,internalChannelNum));
1473  }
1474 
1475  inline bool FEDBufferBase::doTrackerSpecialHeaderChecks() const
1476  {
1477  return ( checkBufferFormat() &&
1478  checkHeaderType() &&
1479  checkReadoutMode() &&
1480  //checkAPVEAddressValid() &&
1481  checkNoFEOverflows() );
1482  }
1483 
1484  inline bool FEDBufferBase::doDAQHeaderAndTrailerChecks() const
1485  {
1486  return ( checkNoSLinkTransmissionError() &&
1487  checkSourceIDs() &&
1488  checkNoUnexpectedSourceID() &&
1489  checkNoExtraHeadersOrTrailers() &&
1490  checkLengthFromTrailer() );
1491  }
1492 
1493  inline bool FEDBufferBase::checkCRC() const
1494  {
1495  return ( checkNoSlinkCRCError() && (calcCRC()==daqCRC()) );
1496  }
1497 
1498  inline bool FEDBufferBase::checkBufferFormat() const
1499  {
1500  return (bufferFormat() != BUFFER_FORMAT_INVALID);
1501  }
1502 
1503  inline bool FEDBufferBase::checkHeaderType() const
1504  {
1505  return (headerType() != HEADER_TYPE_INVALID);
1506  }
1507 
1508  inline bool FEDBufferBase::checkReadoutMode() const
1509  {
1510  return (readoutMode() != READOUT_MODE_INVALID);
1511  }
1512 
1513  inline bool FEDBufferBase::checkAPVEAddressValid() const
1514  {
1515  return (apveAddress() <= APV_MAX_ADDRESS);
1516  }
1517 
1518  inline bool FEDBufferBase::checkNoFEOverflows() const
1519  {
1520  return !specialHeader_.feOverflowRegister();
1521  }
1522 
1523  inline bool FEDBufferBase::checkNoSlinkCRCError() const
1524  {
1525  return !daqTrailer_.slinkCRCError();
1526  }
1527 
1528  inline bool FEDBufferBase::checkNoSLinkTransmissionError() const
1529  {
1530  return !daqTrailer_.slinkTransmissionError();
1531  }
1532 
1533  inline bool FEDBufferBase::checkNoUnexpectedSourceID() const
1534  {
1535  return !daqTrailer_.badSourceID();
1536  }
1537 
1538  inline bool FEDBufferBase::checkNoExtraHeadersOrTrailers() const
1539  {
1540  return ( (daqHeader_.boeNibble() == 0x5) && (daqTrailer_.eoeNibble() == 0xA) );
1541  }
1542 
1543  inline bool FEDBufferBase::checkLengthFromTrailer() const
1544  {
1545  return (bufferSize() == daqEventLengthInBytes());
1546  }
1547 
1548  inline const uint8_t* FEDBufferBase::getPointerToDataAfterTrackerSpecialHeader() const
1549  {
1550  return orderedBuffer_+16;
1551  }
1552 
1553  inline const uint8_t* FEDBufferBase::getPointerToByteAfterEndOfPayload() const
1554  {
1555  return orderedBuffer_+bufferSize_-8;
1556  }
1557 
1558  //FEDChannel
1559 
1560  inline FEDChannel::FEDChannel(const uint8_t*const data, const size_t offset)
1561  : data_(data),
1562  offset_(offset)
1563  {
1564  length_ = ( data_[(offset_)^7] + (data_[(offset_+1)^7] << 8) );
1565  }
1566 
1567  inline FEDChannel::FEDChannel(const uint8_t*const data, const size_t offset, const uint16_t length)
1568  : data_(data),
1569  offset_(offset),
1570  length_(length)
1571  {
1572  }
1573 
1574  inline uint16_t FEDChannel::length() const
1575  {
1576  return length_;
1577  }
1578 
1579  inline uint8_t FEDChannel::packetCode() const
1580  {
1581  return data_[(offset_+2)^7];
1582  }
1583 
1584  inline const uint8_t* FEDChannel::data() const
1585  {
1586  return data_;
1587  }
1588 
1589  inline size_t FEDChannel::offset() const
1590  {
1591  return offset_;
1592  }
1593 
1594 }
1595 
1596 #endif //ndef EventFilter_SiStripRawToDigi_FEDBufferComponents_H
sistrip::FEDStripOrdering::physicalOrderForStripInChannel
static uint8_t physicalOrderForStripInChannel(const uint8_t readoutOrderStripIndexInChannel)
Definition: SiStripFEDBufferComponents.h:644
sistrip::FEDBackendStatusRegister::setFEFPGABufferState
FEDBackendStatusRegister & setFEFPGABufferState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.h:980
sistrip::FEDBackendStatusRegister::setQDRMemoryState
FEDBackendStatusRegister & setQDRMemoryState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.h:944
sistrip::FEDBackendStatusRegister::setL1ABXFIFOState
FEDBackendStatusRegister & setL1ABXFIFOState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.h:968
sistrip::FEDFullDebugHeader::getBit
bool getBit(const uint8_t internalFEDChannelNum, const uint8_t bit) const
Definition: SiStripFEDBufferComponents.h:1160
sistrip::FEDBufferBase::sourceID
uint16_t sourceID() const
sistrip::FEDFEHeader::setBEStatusRegister
virtual void setBEStatusRegister(const FEDBackendStatusRegister beStatusRegister)=0
sistrip::FEDStatusRegister::feDataMissingFlag
bool feDataMissingFlag(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:817
sistrip::FEDFEHeader::lengthInBytes
virtual size_t lengthInBytes() const =0
sistrip::FEDFullDebugHeader::setDAQRegister
virtual void setDAQRegister(const uint32_t daqRegister)
Definition: SiStripFEDBufferComponents.cc:1186
sistrip::FEDFullDebugHeader::print
virtual void print(std::ostream &os) const
Definition: SiStripFEDBufferComponents.cc:1075
sistrip::TrackerSpecialHeader::setDataType
TrackerSpecialHeader & setDataType(const FEDDataType dataType)
Definition: SiStripFEDBufferComponents.cc:762
sistrip::FEDAPVErrorHeader::APV_ERROR_HEADER_SIZE_IN_BYTES
static const size_t APV_ERROR_HEADER_SIZE_IN_BYTES
Definition: SiStripFEDBufferComponents.h:436
sistrip::FEDBackendStatusRegister::printFlags
void printFlags(std::ostream &os) const
Definition: SiStripFEDBufferComponents.cc:529
sistrip::FEDBackendStatusRegister::setBit
void setBit(const uint8_t num, const bool bitSet)
Definition: SiStripFEDBufferComponents.cc:582
sistrip::FEDFullDebugHeader::fePresent
bool fePresent(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:1080
sistrip::FEDFullDebugHeader::setOutOfSync
void setOutOfSync(const uint8_t internalFEDChannelNum, const bool value)
Definition: SiStripFEDBufferComponents.h:1193
sistrip::FEDAPVErrorHeader::setFEUnitLength
virtual void setFEUnitLength(const uint8_t internalFEUnitNum, const uint16_t length)
Definition: SiStripFEDBufferComponents.cc:1060
sistrip::FEDStatusRegister::getBit
bool getBit(const uint8_t num) const
Definition: SiStripFEDBufferComponents.h:790
sistrip::FEDStatusRegister::setQDRMemoryEmptyFlag
void setQDRMemoryEmptyFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:837
sistrip::FEDBufferBase::daqEventLengthIn64bitWords
uint32_t daqEventLengthIn64bitWords() const
Definition: SiStripFEDBufferComponents.h:1395
sistrip::TrackerSpecialHeader::feEnabled
bool feEnabled(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:700
sistrip::FEDBufferBase::checkSummary
virtual std::string checkSummary() const
Definition: SiStripFEDBufferComponents.cc:1353
sistrip::FEDStatusRegister::setTrackerHeaderMonitorDataReadyFlag
FEDStatusRegister & setTrackerHeaderMonitorDataReadyFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:828
sistrip::FEDBackendStatusRegister::setFrameAddressFIFOState
FEDBackendStatusRegister & setFrameAddressFIFOState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.h:950
sistrip::TrackerSpecialHeader::setFEOverflowRegister
TrackerSpecialHeader & setFEOverflowRegister(const uint8_t feOverflowRegister)
Definition: SiStripFEDBufferComponents.h:769
sistrip::FEDFullDebugHeader::unlockedFromBit
bool unlockedFromBit(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.h:1134
sistrip::FEDFullDebugHeader::checkStatusBits
virtual bool checkStatusBits(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
Definition: SiStripFEDBufferComponents.cc:1085
sistrip::FEDBufferBase::getPointerToByteAfterEndOfPayload
const uint8_t * getPointerToByteAfterEndOfPayload() const
Definition: SiStripFEDBufferComponents.h:1553
sistrip::FEDBufferBase::daqTrailer
FEDDAQTrailer daqTrailer() const
Definition: SiStripFEDBufferComponents.h:1360
sistrip::PACKET_CODE_SCOPE
static const uint8_t PACKET_CODE_SCOPE
Definition: SiStripFEDBufferComponents.h:50
sistrip::FEDFullDebugHeader::unlocked
bool unlocked(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.h:1085
sistrip::FEDBackendStatusRegister::setTrackerHeaderFIFOState
FEDBackendStatusRegister & setTrackerHeaderFIFOState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.h:962
sistrip::FEDFullDebugHeader::FEDFullDebugHeader
FEDFullDebugHeader(const uint8_t *headerBuffer)
Definition: SiStripFEDBufferComponents.h:1050
sistrip::FEDAPVErrorHeader::checkChannelStatusBits
virtual bool checkChannelStatusBits(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.cc:999
sistrip::FEDDAQTrailer::print
void print(std::ostream &os) const
Definition: SiStripFEDBufferComponents.h:1328
sistrip::FEDDAQTrailer::setSLinkCRCErrorBit
FEDDAQTrailer & setSLinkCRCErrorBit(const bool bitSet)
Definition: SiStripFEDBufferComponents.cc:950
sistrip::FEDDAQTrailer::setTTSBits
FEDDAQTrailer & setTTSBits(const FEDTTSBits ttsBits)
Definition: SiStripFEDBufferComponents.cc:963
sistrip::FEDFullDebugHeader::feWord
const uint8_t * feWord(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:1177
sistrip::FEDAPVErrorHeader::setBEStatusRegister
virtual void setBEStatusRegister(const FEDBackendStatusRegister beStatusRegister)
Definition: SiStripFEDBufferComponents.cc:1056
sistrip::FEDFullDebugHeader::beStatusRegister
FEDBackendStatusRegister beStatusRegister() const
Definition: SiStripFEDBufferComponents.h:1060
sistrip::FEDBufferBase::readoutMode
FEDReadoutMode readoutMode() const
Definition: SiStripFEDBufferComponents.h:1425
sistrip::fedDataTypeFromString
FEDDataType fedDataTypeFromString(const std::string &dataTypeString)
Definition: SiStripFEDBufferComponents.cc:384
sistrip::FEDBackendStatusRegister::getBit
bool getBit(const uint8_t num) const
Definition: SiStripFEDBufferComponents.h:870
sistrip::FEDStatusRegister::FEDStatusRegister
FEDStatusRegister(const uint16_t fedStatusRegister)
Definition: SiStripFEDBufferComponents.h:784
sistrip::FEDFullDebugHeader::get32BitWordFrom
static uint32_t get32BitWordFrom(const uint8_t *startOfWord)
Definition: SiStripFEDBufferComponents.h:1167
sistrip::FEDFullDebugHeader::setAPVError
void setAPVError(const uint8_t internalFEDChannelNum, const uint8_t apvNum, const bool value)
Definition: SiStripFEDBufferComponents.h:1203
sistrip::FEDFullDebugHeader::setFEUnitMajorityAddress
virtual void setFEUnitMajorityAddress(const uint8_t internalFEUnitNum, const uint8_t address)
Definition: SiStripFEDBufferComponents.cc:1176
sistrip::FEDStatusRegister::setSLinkFullFlag
FEDStatusRegister & setSLinkFullFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:825
sistrip::internalFEDChannelNum
uint8_t internalFEDChannelNum(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum)
Definition: SiStripFEDBufferComponents.h:631
sistrip::TrackerSpecialHeader::fedStatusRegister
FEDStatusRegister fedStatusRegister() const
Definition: SiStripFEDBufferComponents.h:720
sistrip::FEDStatusRegister::print
void print(std::ostream &os) const
Definition: SiStripFEDBufferComponents.h:822
sistrip::TrackerSpecialHeader::setAPVEAddress
TrackerSpecialHeader & setAPVEAddress(const uint8_t address)
Definition: SiStripFEDBufferComponents.h:751
sistrip::FEDBufferBase::getPointerToDataAfterTrackerSpecialHeader
const uint8_t * getPointerToDataAfterTrackerSpecialHeader() const
Definition: SiStripFEDBufferComponents.h:1548
sistrip::FEDDAQTrailer::setSLinkTransmissionErrorBit
FEDDAQTrailer & setSLinkTransmissionErrorBit(const bool bitSet)
Definition: SiStripFEDBufferComponents.cc:936
sistrip::fedHeaderTypeFromString
FEDHeaderType fedHeaderTypeFromString(const std::string &headerTypeString)
Definition: SiStripFEDBufferComponents.cc:321
sistrip::FEDStatusRegister::printFlags
void printFlags(std::ostream &os) const
Definition: SiStripFEDBufferComponents.cc:446
sistrip::TrackerSpecialHeader::setBufferFormat
TrackerSpecialHeader & setBufferFormat(const FEDBufferFormat newBufferFormat)
Definition: SiStripFEDBufferComponents.cc:688
sistrip::calculateFEDBufferCRC
uint16_t calculateFEDBufferCRC(const uint8_t *buffer, const size_t lengthInBytes)
Definition: SiStripFEDBufferComponents.cc:64
sistrip::FEDChannel::FEDChannel
FEDChannel(const uint8_t *const data, const size_t offset, const uint16_t length)
Definition: SiStripFEDBufferComponents.h:1567
sistrip::operator<<
std::ostream & operator<<(std::ostream &os, const FEDBufferFormat &value)
Definition: SiStripFEDBufferComponents.cc:83
sistrip::FEDAPVErrorHeader::checkStatusBits
virtual bool checkStatusBits(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
Definition: SiStripFEDBufferComponents.cc:991
sistrip::FEDFullDebugHeader::apvError
bool apvError(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
Definition: SiStripFEDBufferComponents.h:1105
sistrip::FEDAPVErrorHeader::FEDAPVErrorHeader
FEDAPVErrorHeader(const uint8_t *headerBuffer)
Definition: SiStripFEDBufferComponents.h:1039
sistrip::FEDDAQHeader::data
const uint8_t * data() const
Definition: SiStripFEDBufferComponents.h:1261
sistrip::fedBufferFormatFromString
FEDBufferFormat fedBufferFormatFromString(const std::string &bufferFormatString)
Definition: SiStripFEDBufferComponents.cc:300
sistrip::FEDStatusRegister::setBit
void setBit(const uint8_t num, const bool bitSet)
Definition: SiStripFEDBufferComponents.cc:479
AlCaHLTBitMon_QueryRunRegistry.string
string string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:255
sistrip::FEDBufferBase::daqEventType
FEDDAQEventType daqEventType() const
Definition: SiStripFEDBufferComponents.h:1375
sistrip::TrackerSpecialHeader::setHeaderType
TrackerSpecialHeader & setHeaderType(const FEDHeaderType headerType)
Definition: SiStripFEDBufferComponents.cc:718
sistrip::FEDFEHeader::newFEFakeHeader
static std::auto_ptr< FEDFEHeader > newFEFakeHeader(const FEDHeaderType headerType)
Definition: SiStripFEDBufferComponents.h:1012
sistrip::FEDBufferBase::dumpOriginalBuffer
void dumpOriginalBuffer(std::ostream &os) const
Definition: SiStripFEDBufferComponents.h:1345
sistrip::fedReadoutModeFromString
FEDReadoutMode fedReadoutModeFromString(const std::string &readoutModeString)
Definition: SiStripFEDBufferComponents.cc:341
sistrip::TrackerSpecialHeader::feOverflow
bool feOverflow(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:708
sistrip::FEDStripOrdering::readoutOrderForStripInChannel
static uint8_t readoutOrderForStripInChannel(const uint8_t physicalOrderStripIndexInChannel)
Definition: SiStripFEDBufferComponents.h:649
sistrip::FEDBackendStatusRegister::FEDBackendStatusRegister
FEDBackendStatusRegister(const uint32_t backendStatusRegister)
Definition: SiStripFEDBufferComponents.h:861
sistrip::FEDChannel::cmMedian
uint16_t cmMedian(const uint8_t apvIndex) const
Definition: SiStripFEDBufferComponents.cc:1400
sistrip::FEDFullDebugHeader::setFEUnitLength
virtual void setFEUnitLength(const uint8_t internalFEUnitNum, const uint16_t length)
Definition: SiStripFEDBufferComponents.cc:1196
sistrip::FEDAPVErrorHeader::print
virtual void print(std::ostream &os) const
Definition: SiStripFEDBufferComponents.cc:981
sistrip::FEDFEHeader::checkStatusBits
bool checkStatusBits(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum, const uint8_t apvNum) const
Definition: SiStripFEDBufferComponents.h:1029
sistrip::FEDDAQTrailer::data
const uint8_t * data() const
Definition: SiStripFEDBufferComponents.h:1333
sistrip::PACKET_CODE_ZERO_SUPPRESSED
static const uint8_t PACKET_CODE_ZERO_SUPPRESSED
Definition: SiStripFEDBufferComponents.h:53
sistrip::FEDFullDebugHeader::clone
virtual FEDFullDebugHeader * clone() const
Definition: SiStripFEDBufferComponents.cc:1080
sistrip::FEDFullDebugHeader::setBEStatusRegister
virtual void setBEStatusRegister(const FEDBackendStatusRegister beStatusRegister)
Definition: SiStripFEDBufferComponents.cc:1181
sistrip::FEDBackendStatusRegister::setTotalLengthFIFOState
FEDBackendStatusRegister & setTotalLengthFIFOState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.h:956
sistrip::TrackerSpecialHeader::setFEEnableForFEUnit
TrackerSpecialHeader & setFEEnableForFEUnit(const uint8_t internalFEUnitNum, const bool enabled)
Definition: SiStripFEDBufferComponents.cc:787
sistrip::FEDDAQTrailer::setEventLengthIn64BitWords
FEDDAQTrailer & setEventLengthIn64BitWords(const uint32_t eventLengthIn64BitWords)
Definition: SiStripFEDBufferComponents.cc:921
sistrip::FEDDAQTrailer::setEventStatusNibble
FEDDAQTrailer & setEventStatusNibble(const uint8_t eventStatusNibble)
Definition: SiStripFEDBufferComponents.cc:957
sistrip::FEDBufferBase::majorityAddressErrorForFEUnit
bool majorityAddressErrorForFEUnit(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:1440
sistrip::FEDFullDebugHeader::setUnlocked
void setUnlocked(const uint8_t internalFEDChannelNum, const bool value)
Definition: SiStripFEDBufferComponents.h:1188
sistrip::FEDBackendStatusRegister::setTTCReadyFlag
FEDBackendStatusRegister & setTTCReadyFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:903
sistrip::FEDDAQTrailer::setCRC
FEDDAQTrailer & setCRC(const uint16_t crc)
Definition: SiStripFEDBufferComponents.cc:929
sistrip::TrackerSpecialHeader::setAPVEAddressErrorRegister
TrackerSpecialHeader & setAPVEAddressErrorRegister(const uint8_t addressErrorRegister)
Definition: SiStripFEDBufferComponents.h:757
sistrip::TrackerSpecialHeader::setFEDStatusRegister
TrackerSpecialHeader & setFEDStatusRegister(const FEDStatusRegister fedStatusRegister)
Definition: SiStripFEDBufferComponents.h:775
sistrip::FEDFullDebugHeader::apvErrorFromBit
bool apvErrorFromBit(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
Definition: SiStripFEDBufferComponents.h:1144
sistrip::TrackerSpecialHeader::setAPVAddressErrorForFEUnit
TrackerSpecialHeader & setAPVAddressErrorForFEUnit(const uint8_t internalFEUnitNum, const bool error)
Definition: SiStripFEDBufferComponents.cc:779
sistrip::FEDStatusRegister::setL1ABXFIFOBufferState
FEDStatusRegister & setL1ABXFIFOBufferState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.cc:506
sistrip::FEDAPVErrorHeader::setAPVStatusBit
FEDAPVErrorHeader & setAPVStatusBit(const uint8_t internalFEDChannelNum, const uint8_t apvNum, const bool apvGood)
Definition: SiStripFEDBufferComponents.cc:1018
sistrip::FEUNITS_PER_FED
static const uint16_t FEUNITS_PER_FED
Definition: ConstantsForHardwareSystems.h:29
sistrip::FEDStatusRegister::qdrMemoryState
FEDBufferState qdrMemoryState() const
Definition: SiStripFEDBufferComponents.cc:461
sistrip::FEDStatusRegister::setQDRMemoryFullFlag
void setQDRMemoryFullFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:831
sistrip::FEDBufferBase::feEnabled
bool feEnabled(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:1445
sistrip::FEDFullDebugHeader::setDAQRegister2
virtual void setDAQRegister2(const uint32_t daqRegister2)
Definition: SiStripFEDBufferComponents.cc:1191
sistrip::FEDFEHeader::setFEUnitLength
virtual void setFEUnitLength(const uint8_t internalFEUnitNum, const uint16_t length)=0
sistrip::FEDFEHeader::setChannelStatus
virtual void setChannelStatus(const uint8_t internalFEDChannelNum, const FEDChannelStatus status)=0
sistrip::FEDBufferBase::dump
void dump(std::ostream &os) const
Definition: SiStripFEDBufferComponents.h:1340
sistrip::FEDStatusRegister::setL1ABXFIFOFullFlag
void setL1ABXFIFOFullFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:840
sistrip::BUFFER_FORMAT_CODE_NEW
static const uint8_t BUFFER_FORMAT_CODE_NEW
Definition: SiStripFEDBufferComponents.h:30
sistrip::FEDBufferBase::FEDBufferBase
FEDBufferBase(const uint8_t *fedBuffer, const size_t fedBufferSize, const bool allowUnrecognizedFormat=false)
Definition: SiStripFEDBufferComponents.cc:1217
sistrip::FEDBufferBase::headerType
FEDHeaderType headerType() const
Definition: SiStripFEDBufferComponents.h:1420
sistrip::FEDFEHeader::setFEUnitMajorityAddress
virtual void setFEUnitMajorityAddress(const uint8_t internalFEUnitNum, const uint8_t address)=0
sistrip::FEDFullDebugHeader::setAPVAddressError
void setAPVAddressError(const uint8_t internalFEDChannelNum, const uint8_t apvNum, const bool value)
Definition: SiStripFEDBufferComponents.h:1198
sistrip::FEDBackendStatusRegister::printFlagsForBuffer
void printFlagsForBuffer(const FEDBufferState bufferState, const std::string name, std::ostream &os) const
Definition: SiStripFEDBufferComponents.cc:546
sistrip::FEDAPVErrorHeader::APV_ERROR_HEADER_SIZE_IN_64BIT_WORDS
static const size_t APV_ERROR_HEADER_SIZE_IN_64BIT_WORDS
Definition: SiStripFEDBufferComponents.h:435
sistrip::APV_MAX_ADDRESS
static const uint8_t APV_MAX_ADDRESS
Definition: SiStripFEDBufferComponents.h:19
sistrip::FEDAPVErrorHeader::setFEUnitMajorityAddress
virtual void setFEUnitMajorityAddress(const uint8_t internalFEUnitNum, const uint8_t address)
Definition: SiStripFEDBufferComponents.cc:1052
sistrip::FEDStatusRegister::setL1ABXFIFOPartialFullFlag
void setL1ABXFIFOPartialFullFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:843
sistrip::FEDStatusRegister::l1aBxFIFOState
FEDBufferState l1aBxFIFOState() const
Definition: SiStripFEDBufferComponents.cc:470
sistrip::TrackerSpecialHeader::setHeaderTypeNibble
void setHeaderTypeNibble(const uint8_t value)
Definition: SiStripFEDBufferComponents.h:736
sistrip::INVALID
static const uint8_t INVALID
Definition: SiStripFEDBufferComponents.h:17
sistrip::FEDBufferBase::channel
const FEDChannel & channel(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.h:1465
sistrip::fedDAQEventTypeFromString
FEDDAQEventType fedDAQEventTypeFromString(const std::string &daqEventTypeString)
Definition: SiStripFEDBufferComponents.cc:402
sistrip::FEDFullDebugHeader::outOfSync
bool outOfSync(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.h:1095
sistrip::FEDBufferBase::channels_
std::vector< FEDChannel > channels_
Definition: SiStripFEDBufferComponents.h:614
sistrip::TrackerSpecialHeader::setBufferFormatByte
void setBufferFormatByte(const FEDBufferFormat newBufferFormat)
Definition: SiStripFEDBufferComponents.cc:700
sistrip::FEDBackendStatusRegister::getBufferState
FEDBufferState getBufferState(const uint8_t bufferPosition) const
Definition: SiStripFEDBufferComponents.cc:554
sistrip::FEDFEHeader::checkChannelStatusBits
bool checkChannelStatusBits(const uint8_t internalFEUnitNum, const uint8_t internalFEUnitChannelNum) const
Definition: SiStripFEDBufferComponents.h:1024
sistrip::FEDDAQTrailer::setBadSourceIDBit
FEDDAQTrailer & setBadSourceIDBit(const bool bitSet)
Definition: SiStripFEDBufferComponents.cc:943
sistrip::TrackerSpecialHeader::print
void print(std::ostream &os) const
Definition: SiStripFEDBufferComponents.h:723
sistrip::FEDFullDebugHeader::FULL_DEBUG_HEADER_SIZE_IN_BYTES
static const size_t FULL_DEBUG_HEADER_SIZE_IN_BYTES
Definition: SiStripFEDBufferComponents.h:511
sistrip::PACKET_CODE_PROC_RAW
static const uint8_t PACKET_CODE_PROC_RAW
Definition: SiStripFEDBufferComponents.h:52
sistrip::APVS_PER_FED
static const uint16_t APVS_PER_FED
Definition: ConstantsForHardwareSystems.h:36
sistrip::FEDFEHeader::print
virtual void print(std::ostream &os) const =0
sistrip::printHex
void printHex(const void *pointer, const size_t length, std::ostream &os)
Definition: SiStripFEDBufferComponents.cc:27
sistrip::FEDStripOrdering::physicalOrderForStripInAPV
static uint8_t physicalOrderForStripInAPV(const uint8_t readoutOrderStripIndexInAPV)
Definition: SiStripFEDBufferComponents.h:654
sistrip::FEDCH_PER_FEUNIT
static const uint16_t FEDCH_PER_FEUNIT
Definition: ConstantsForHardwareSystems.h:28
ConstantsForHardwareSystems.h
Constants and enumerated types for FED/FEC systems.
sistrip::FEDBackendStatusRegister::setTrackerHeaderMonitorDataReadyFlag
FEDBackendStatusRegister & setTrackerHeaderMonitorDataReadyFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:906
sistrip::TrackerSpecialHeader::setReadoutModeBits
void setReadoutModeBits(const uint8_t value)
Definition: SiStripFEDBufferComponents.h:741
sistrip::FEDFullDebugHeader::apvAddressError
bool apvAddressError(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
Definition: SiStripFEDBufferComponents.h:1117
sistrip::FEDAPVErrorHeader::setChannelStatus
virtual void setChannelStatus(const uint8_t internalFEDChannelNum, const FEDChannelStatus status)
Definition: SiStripFEDBufferComponents.cc:1029
sistrip::FEDDAQHeader::setEventType
FEDDAQHeader & setEventType(const FEDDAQEventType evtType)
Definition: SiStripFEDBufferComponents.cc:843
sistrip::FEDChannel::data
const uint8_t * data() const
Definition: SiStripFEDBufferComponents.h:1584
sistrip::FEDBufferBase::trackerSpecialHeader
TrackerSpecialHeader trackerSpecialHeader() const
Definition: SiStripFEDBufferComponents.h:1370
sistrip::FEDDAQHeader::setL1ID
FEDDAQHeader & setL1ID(const uint32_t l1ID)
Definition: SiStripFEDBufferComponents.cc:849
hltrates_dqm_sourceclient-live_cfg.offset
tuple offset
Definition: hltrates_dqm_sourceclient-live_cfg.py:81
sistrip::FEDBackendStatusRegister::setSLinkFullFlag
FEDBackendStatusRegister & setSLinkFullFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:897
sistrip::FEDDAQHeader::print
void print(std::ostream &os) const
Definition: SiStripFEDBufferComponents.h:1266
sistrip::FEDDAQHeader::setSourceID
FEDDAQHeader & setSourceID(const uint16_t sourceID)
Definition: SiStripFEDBufferComponents.cc:864
sistrip::FEDFullDebugHeader::feUnitLength
uint16_t feUnitLength(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:1075
sistrip::FEDBackendStatusRegister::setBufferSate
void setBufferSate(const uint8_t bufferPosition, const FEDBufferState state)
Definition: SiStripFEDBufferComponents.cc:563
sistrip::FEDFullDebugHeader::setChannelStatus
virtual void setChannelStatus(const uint8_t internalFEDChannelNum, const FEDChannelStatus status)
Definition: SiStripFEDBufferComponents.cc:1166
sistrip::FEDBufferBase::init
void init(const uint8_t *fedBuffer, const size_t fedBufferSize, const bool allowUnrecognizedFormat)
Definition: SiStripFEDBufferComponents.cc:1233
sistrip::FEDFEHeader::data
virtual const uint8_t * data() const =0
sistrip::FEDFullDebugHeader::header_
uint8_t header_[FULL_DEBUG_HEADER_SIZE_IN_BYTES]
Definition: SiStripFEDBufferComponents.h:512
sistrip::FEDFullDebugHeader::feUnitMajorityAddress
uint8_t feUnitMajorityAddress(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:1055
sistrip::FEDBufferBase::specialHeader_
TrackerSpecialHeader specialHeader_
Definition: SiStripFEDBufferComponents.h:622
sistrip::FEDFullDebugHeader::data
virtual const uint8_t * data() const
Definition: SiStripFEDBufferComponents.cc:1144
sistrip::FEDFullDebugHeader::getChannelStatus
FEDChannelStatus getChannelStatus(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.cc:1104
sistrip::FEDBufferBase::print
virtual void print(std::ostream &os) const
Definition: SiStripFEDBufferComponents.cc:1300
data
char data[epos_bytes_allocation]
Definition: EPOS_Wrapper.h:82
sistrip::FEDCH_PER_FED
static const uint16_t FEDCH_PER_FED
Definition: ConstantsForHardwareSystems.h:30
sistrip::STRIPS_PER_APV
static const uint16_t STRIPS_PER_APV
Definition: ConstantsForHardwareSystems.h:43
sistrip::TrackerSpecialHeader::setFEOverflowForFEUnit
TrackerSpecialHeader & setFEOverflowForFEUnit(const uint8_t internalFEUnitNum, const bool overflow)
Definition: SiStripFEDBufferComponents.cc:795
sistrip::FEDBufferBase::channelGood
virtual bool channelGood(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.cc:1342
sistrip::FEDFullDebugHeader::FULL_DEBUG_HEADER_SIZE_IN_64BIT_WORDS
static const size_t FULL_DEBUG_HEADER_SIZE_IN_64BIT_WORDS
Definition: SiStripFEDBufferComponents.h:510
sistrip::FEDFEHeader::clone
virtual FEDFEHeader * clone() const =0
sistrip::FEDBackendStatusRegister::setFEEventLengthFIFOState
FEDBackendStatusRegister & setFEEventLengthFIFOState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.h:974
sistrip::FEDAPVErrorHeader::data
virtual const uint8_t * data() const
Definition: SiStripFEDBufferComponents.cc:1004
sistrip::TrackerSpecialHeader::majorityAddressErrorForFEUnit
bool majorityAddressErrorForFEUnit(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:692
sistrip::FEDFEHeader::newFEHeader
static std::auto_ptr< FEDFEHeader > newFEHeader(const FEDHeaderType headerType, const uint8_t *headerBuffer)
Definition: SiStripFEDBufferComponents.h:988
sistrip::FEDDAQHeader::setBXID
FEDDAQHeader & setBXID(const uint16_t bxID)
Definition: SiStripFEDBufferComponents.cc:857
sistrip::FEDFullDebugHeader::apvAddressErrorFromBit
bool apvAddressErrorFromBit(const uint8_t internalFEDChannelNum, const uint8_t apvNum) const
Definition: SiStripFEDBufferComponents.h:1155
sistrip::BUFFER_FORMAT_CODE_OLD
static const uint8_t BUFFER_FORMAT_CODE_OLD
Definition: SiStripFEDBufferComponents.h:29
edm::false
volatile std::atomic< bool > shutdown_flag false
Definition: UnixSignalHandlers.cc:22
sistrip::FEDFullDebugHeader::setBit
void setBit(const uint8_t internalFEDChannelNum, const uint8_t bit, const bool value)
Definition: SiStripFEDBufferComponents.cc:1202
sistrip::SCOPE_MODE_MAX_SCOPE_LENGTH
static const uint16_t SCOPE_MODE_MAX_SCOPE_LENGTH
Definition: SiStripFEDBufferComponents.h:21
ntuplemaker.status
tuple status
Definition: ntuplemaker.py:245
sistrip::FEDStripOrdering::readoutOrderForStripInAPV
static uint8_t readoutOrderForStripInAPV(const uint8_t physicalOrderStripIndexInAPV)
Definition: SiStripFEDBufferComponents.h:662
sistrip::FEDStatusRegister::setQDRMemoryBufferState
FEDStatusRegister & setQDRMemoryBufferState(const FEDBufferState state)
Definition: SiStripFEDBufferComponents.cc:486
sistrip::FEDAPVErrorHeader::clone
virtual FEDAPVErrorHeader * clone() const
Definition: SiStripFEDBufferComponents.cc:986
sistrip::FEDDAQHeader::eventType
FEDDAQEventType eventType() const
Definition: SiStripFEDBufferComponents.cc:827
sistrip::FEDFullDebugHeader::set32BitWordAt
static void set32BitWordAt(uint8_t *startOfWord, const uint32_t value)
Definition: SiStripFEDBufferComponents.h:1172
sistrip::FEDAPVErrorHeader::header_
uint8_t header_[APV_ERROR_HEADER_SIZE_IN_BYTES]
Definition: SiStripFEDBufferComponents.h:437
sistrip::FEDBackendStatusRegister::setInternalFreezeFlag
FEDBackendStatusRegister & setInternalFreezeFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:891
sistrip::FEDStatusRegister::setL1ABXFIFOEmptyFlag
void setL1ABXFIFOEmptyFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:846
sistrip::FEDFullDebugHeader::checkChannelStatusBits
virtual bool checkChannelStatusBits(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.cc:1093
sistrip::FEDBackendStatusRegister::setBackpressureFlag
FEDBackendStatusRegister & setBackpressureFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:900
sistrip::PACKET_CODE_VIRGIN_RAW
static const uint8_t PACKET_CODE_VIRGIN_RAW
Definition: SiStripFEDBufferComponents.h:51
sistrip::TrackerSpecialHeader::setReadoutMode
TrackerSpecialHeader & setReadoutMode(const FEDReadoutMode readoutMode)
Definition: SiStripFEDBufferComponents.cc:734
sistrip::FEDFullDebugHeader::outOfSyncFromBit
bool outOfSyncFromBit(const uint8_t internalFEDChannelNum) const
Definition: SiStripFEDBufferComponents.h:1139
sistrip::FEDBufferBase::feOverflow
bool feOverflow(const uint8_t internalFEUnitNum) const
Definition: SiStripFEDBufferComponents.h:1450
sistrip::FEDBufferBase::fedStatusRegister
FEDStatusRegister fedStatusRegister() const
Definition: SiStripFEDBufferComponents.h:1455
sistrip::FEDStatusRegister::setQDRMemoryPartialFullFlag
void setQDRMemoryPartialFullFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:834
sistrip::FEDBackendStatusRegister::setSLinkDownFlag
FEDBackendStatusRegister & setSLinkDownFlag(const bool bitSet)
Definition: SiStripFEDBufferComponents.h:894
sistrip::FEDBufferBase::bufferFormat
FEDBufferFormat bufferFormat() const
Definition: SiStripFEDBufferComponents.h:1415
sistrip::TrackerSpecialHeader::setFEEnableRegister
TrackerSpecialHeader & setFEEnableRegister(const uint8_t feEnableRegister)
Definition: SiStripFEDBufferComponents.h:763
Generated for CMSSW Reference Manual by doxygen 1.8.5