- add protection against invalid sector/stack information in on-line track matching
[u/mrichter/AliRoot.git] / TRD / AliTRDrawStream.h
index 8660e15..98d70d8 100644 (file)
@@ -3,7 +3,7 @@
 
 //-----------------------------------
 //
-// decoding of TRD raw data stream 
+// decoding of TRD raw data stream
 // and translation into digits
 //
 //----------------------------------
 #ifndef ALITRDRAWSTREAM_H
 #define ALITRDRAWSTREAM_H
 
-#include "TObject.h"
-#include "TClonesArray.h"
 #include "TTree.h"
+#include "AliLog.h"
+#include "TClonesArray.h"
 
+class TObject;
 class TObjArray;
 class TString;
 class TBranch;
@@ -25,11 +26,7 @@ class AliTRDdigitsParam;
 class AliTRDarrayADC;
 class AliTRDSignalIndex;
 class AliTRDtrackletContainer;
-
-#define TRDMAXTBINS 63
-#define TRDMAXADC   21
-#define TRDMAXMCM   4 * 16
-#define MAXTRACKLETSPERHC 256
+class AliESDTrdTrack;
 
 class AliTRDrawStream : public TObject
 {
@@ -37,7 +34,8 @@ class AliTRDrawStream : public TObject
   AliTRDrawStream(AliRawReader *rawReader = 0x0);
   ~AliTRDrawStream();
 
-  enum { kDDLOffset = 0x400 };                                // Offset for DDL numbers
+  enum { kDDLOffset = 0x400,                                  // Offset for DDL numbers
+         kDDLMax    = 0x411 };                                // Max DDL number for TRD SM
 
   Bool_t SetReader(AliRawReader *rawReader) { fRawReader = rawReader; return kTRUE; }
   void SetDigitsManager(AliTRDdigitsManager *digMgr) { fDigitsManager = digMgr; }
@@ -50,34 +48,28 @@ class AliTRDrawStream : public TObject
   TClonesArray* GetMarkerArray() const { return fMarkers; }
 
   AliTRDdigitsManager* GetDigitsManager() const { return fDigitsManager; }
-  TTree *GetTrackletTree() const { return fTrackletTree; }
 
-  Bool_t ReadEvent(TTree *trackletTree = 0x0);
+  Bool_t ReadEvent();
 
   Bool_t NextDDL();
-  Int_t NextChamber(AliTRDdigitsManager *digMgr, 
-                   UInt_t ** /* trackletContainer */=NULL, UShort_t ** /* errorContainer */=NULL);
-
-  Bool_t ConnectTracklets(TTree *trklTree);
+  Int_t NextChamber(AliTRDdigitsManager *digMgr);
+  Int_t NextChamber(AliTRDdigitsManager *digMgr,
+                     UInt_t ** /* trackletContainer */, UShort_t ** /* errorContainer */) { AliError("Deprecated, use NextChamber(AliTRDdigitsManger*) instead!"); return NextChamber(digMgr); }
 
   void StoreErrorsInTree()   { fStoreError = &AliTRDrawStream::StoreErrorTree; }
   void StoreErrorsInArray()  { fStoreError = &AliTRDrawStream::StoreErrorArray; }
   void EnableErrorStorage()  { fStoreError = &AliTRDrawStream::StoreErrorTree; }
   void DisableErrorStorage() { fStoreError = &AliTRDrawStream::ForgetError; }
 
-  // legacy code, to be removed
-  Bool_t SetRawVersion(Int_t) { return kTRUE; }
-  void SetSharedPadReadout(Bool_t) {}
-  void SetNoErrorWarning() {}
-
   // error handling
-  enum ErrorCode_t { 
-    kUnknown = 0, 
-    kLinkMonitor, 
-    kPtrgCntMismatch, 
+  enum ErrorCode_t {
+    kUnknown = 0,
+    kLinkMonitor,
+    kEvCntMismatch,
     kNonTrdEq,
     kStackHeaderInvalid,
     kInvalidDetector,
+    kInvalidPadRow,
     kNoDigits,
     kHCmismatch,
     kHCcheckFailed,
@@ -90,22 +82,41 @@ class AliTRDrawStream : public TObject
     kAdcDataAbort,
     kAdcChannelsMiss,
     kMissMcmHeaders,
+    kMissTpData,
+    kCRCmismatch,
     kLastErrorCode
-  }; 
+  };
 
   enum ErrorBehav_t {
     kTolerate = 0,
-    kAbort = 1, 
-    kDiscardMCM = 2,
-    kDiscardHC = 4
+    kDiscardMCM = 1,
+    kDiscardHC = 2,
+    kDiscardDDL = 4,
+    kAbort = 8
   };
 
   enum MarkerCode_t {
-    kHCactive = 1
+    kHCactive = 1,
+    kSecactive = 2
   };
 
   TTree* GetErrorTree() const { return fErrors; }
   static const char* GetErrorMessage(ErrorCode_t errCode);
+  static void SetErrorDebugLevel(ErrorCode_t error, Int_t level) { fgErrorDebugLevel[error] = level; }
+  static void SetErrorBehaviour(ErrorCode_t error, ErrorBehav_t behav) { fgErrorBehav[error] = behav; }
+
+  class AliTRDrawStreamError : public TObject {
+  public:
+    AliTRDrawStreamError(Int_t error = 0, Int_t sector = -1, Int_t stack = -1, Int_t link = -1, Int_t rob = -1, Int_t mcm = -1);
+    virtual ~AliTRDrawStreamError() {}
+    Int_t fError;                               // error code
+    Int_t fSector;                             // sector
+    Int_t fStack;                              // stack
+    Int_t fLink;                               // link
+    Int_t fRob;                                        // ROB no
+    Int_t fMcm;                                        // MCM no
+    ClassDef(AliTRDrawStreamError, 1);
+  };
 
   // event statistics
   class AliTRDrawStats : public TObject {
@@ -145,25 +156,71 @@ class AliTRDrawStream : public TObject
     ClassDef(AliTRDrawStats, 1);
   };
 
-  AliTRDrawStats fStats;            // event statistics, clearing must be done by the user
-
   AliTRDrawStats* GetStats() { return &fStats; }
-  Int_t GetEventSize(Int_t sector) { return fStats.fStatsSector[sector].fBytes; }
-  Int_t GetNTracklets(Int_t sector) { return fStats.fStatsSector[sector].fNTracklets; }
-  Int_t GetNMCMs(Int_t sector) { return fStats.fStatsSector[sector].fNMCMs; }
-  Int_t GetNChannels(Int_t sector) { return fStats.fStatsSector[sector].fNChannels; }
+  Int_t GetEventSize(Int_t sector)  const { return fStats.fStatsSector[sector].fBytes; }
+  Int_t GetEventSize(Int_t sector, Int_t stack)  const {
+    Int_t size = 0;
+    for (Int_t iHC = 0; iHC < 12; iHC++) {
+      size += fStats.fStatsSector[sector].fStatsHC[12*stack + iHC].fBytes;
+    }
+    return size;
+  }
+  Int_t GetEventSize(Int_t sector, Int_t stack, Int_t hc) const {
+    return fStats.fStatsSector[sector].fStatsHC[12*stack + hc].fBytes;
+  }
+  Int_t GetNTracklets(Int_t sector) const { return fStats.fStatsSector[sector].fNTracklets; }
+  Int_t GetNMCMs(Int_t sector)      const { return fStats.fStatsSector[sector].fNMCMs; }
+  Int_t GetNChannels(Int_t sector)  const { return fStats.fStatsSector[sector].fNChannels; }
+
+  ULong64_t GetTrkFlags(Int_t sector, Int_t stack) const { return (fCurrTrgFlags[sector] & (1 << (27 + stack))) ? fCurrTrkFlags[sector*fgkNstacks + stack] : 0; }
+  UInt_t GetTriggerFlags(Int_t sector) const { return fCurrTrgFlags[sector]; }
+  UInt_t GetLinkMonitorFlags(Int_t sector, Int_t stack) const {
+    UInt_t temp = 0;
+    for (Int_t iLink = 0; iLink < 12; iLink++)
+      temp |= (fCurrLinkMonitorFlags[(sector * fgkNstacks + stack) * fgkNlinks + iLink] & 0x3) << (iLink * 2);
+    temp |= ((GetMatchFlagsBP(sector)   >> stack) & 0x1) << 24;
+    temp |= ((GetMatchFlagsSRAM(sector) >> stack) & 0x1) << 25;
+    return temp;
+  }
+  UInt_t GetMatchFlagsSRAM(Int_t sector) const { return fCurrMatchFlagsSRAM[sector]; }
+  UInt_t GetMatchFlagsBP(Int_t sector)   const { return fCurrMatchFlagsPostBP[sector]; }
+
+#ifdef TRD_RAW_DEBUG
+  UInt_t GetBC(Int_t hc)               const { return fCurrBC[hc]; }
+  UInt_t GetEvCount(Int_t det)     const { return fCurrEvCount[det]; }
+  UInt_t GetL0Count(Int_t sector)  const { return fCurrL0Count[sector]; }
+  UInt_t GetL1aCount(Int_t sector) const { return fCurrL1aCount[sector]; }
+  UInt_t GetL1rCount(Int_t sector) const { return fCurrL1rCount[sector]; }
+  UInt_t GetL2aCount(Int_t sector) const { return fCurrL2aCount[sector]; }
+  UInt_t GetL2rCount(Int_t sector) const { return fCurrL2rCount[sector]; }
+  UInt_t GetChecksumStack(Int_t sector, Int_t stack) const { return fCurrChecksumStack[sector][stack]; }
+#endif
 
   // raw data dumping
   void SetDumpMCM(Int_t det, Int_t rob, Int_t mcm, Bool_t dump = kTRUE);
 
-  Bool_t IsDumping() { return (fNDumpMCMs > 0); }
-  Bool_t DumpingMCM(Int_t det, Int_t rob, Int_t mcm);
+  Bool_t IsDumping() const { return (fNDumpMCMs > 0); }
+  Bool_t DumpingMCM(Int_t det, Int_t rob, Int_t mcm) const;
 
-  void DumpRaw(TString title, UInt_t *start, Int_t length); 
+  TString DumpRaw(TString title, const UInt_t *start, Int_t length, UInt_t endmarker = 0xffffffff);
+  TString DumpMcmHeader(TString title, UInt_t word);
+  TString DumpAdcMask(TString title, UInt_t word);
+
+  static void SortTracklets(TClonesArray *trklArray, TList &sortedTracklets, Int_t *indices);
+  static void AssignTracklets(AliESDTrdTrack *trdTrack, Int_t *trackletIndex, Int_t refIndex[6]);
+
+  // temporary: allow to change expected readout order
+  static void SetMCMReadoutPos(Int_t mcm, Int_t pos) { if (mcm > -1 && mcm < 16) fgMcmOrder[mcm] = pos; }
+  static void SetROBReadoutPos(Int_t robpair, Int_t pos) { if (robpair > -1 && robpair < 4) fgMcmOrder[robpair] = pos; }
 
  protected:
+  Int_t ReadGTUHeaders(UInt_t *buffer);
   Int_t ReadSmHeader();
-  Int_t ReadStackIndexHeader(Int_t stack);
+  Int_t ReadTrackingHeader(Int_t stack);
+  Int_t ReadTriggerHeaders();
+  Int_t ReadStackHeader(Int_t stack);
+  Int_t DecodeGTUtracks();
+  Int_t ReadGTUTrailer();
 
   Int_t ReadLinkData();
   Int_t ReadTracklets();
@@ -172,6 +229,9 @@ class AliTRDrawStream : public TObject
   Int_t ReadZSData();
   Int_t ReadNonZSData();
 
+  UShort_t CalcLinkChecksum(UInt_t *data, Int_t size);
+
+  Int_t SeekNextStack();
   Int_t SeekNextLink();
 
   // MCM header decoding
@@ -184,70 +244,64 @@ class AliTRDrawStream : public TObject
   Int_t Check(UInt_t mcmhdr) const { return 0xf & mcmhdr; }
   Int_t CouldBeMCMhdr(UInt_t mcmhdr) const { return ((0xf & mcmhdr) == 0xc); }
 
-  Int_t GetMCMReadoutPos(Int_t mcm) const { return (mcm > -1 && mcm < 16) ? fgkMcmOrder[mcm] : -1; }
-  Int_t GetROBReadoutPos(Int_t rob) const { return (rob > -1 && rob < 4) ? fgkRobOrder[rob] : -1; }
+  Int_t GetMCMReadoutPos(Int_t mcm) const { return (mcm > -1 && mcm < 16) ? fgMcmOrder[mcm] : -1; }
+  Int_t GetROBReadoutPos(Int_t rob) const { return (rob > -1 && rob < 4) ? fgRobOrder[rob] : -1; }
 
   // ADC mask decoding
   Int_t GetActiveChannels(UInt_t adcmask) const { return 0x1fffff & adcmask >> 4; }
   inline Int_t GetNActiveChannelsFromMask(UInt_t adcmask) const; // { Int_t nch = 0; for (Int_t i = 0; i < 21; i++) if ((GetActiveChannels(adcmask) & 1 << i)) nch++; return nch; }
   Int_t GetNActiveChannels(UInt_t adcmask) const { return (0x1f & ~(adcmask >> 25)); }
   Int_t CouldBeADCmask(UInt_t adcmask) const { return ((0xf & adcmask) == 0xc && (0x3 & adcmask >> 30) == 0x1); }
-      
+
   // error message generation
-  void EquipmentError(ErrorCode_t err = kUnknown, const char *const msg = "", ...); 
-  void StackError    (ErrorCode_t err = kUnknown, const char *const msg = "", ...);     
-  void LinkError     (ErrorCode_t err = kUnknown, const char *const msg = "", ...); 
-  void ROBError      (ErrorCode_t err = kUnknown, const char *const msg = "", ...); 
-  void MCMError      (ErrorCode_t err = kUnknown, const char *const msg = "", ...); 
+  void EquipmentError(ErrorCode_t err = kUnknown, const char *const msg = " ", ...);
+  void StackError    (ErrorCode_t err = kUnknown, const char *const msg = " ", ...);
+  void LinkError     (ErrorCode_t err = kUnknown, const char *const msg = " ", ...);
+  void ROBError      (ErrorCode_t err = kUnknown, const char *const msg = " ", ...);
+  void MCMError      (ErrorCode_t err = kUnknown, const char *const msg = " ", ...);
   void StoreErrorTree() { fErrors->Fill(); }
   void StoreErrorArray() { new ((*fMarkers)[fMarkers->GetEntriesFast()]) AliTRDrawStreamError(fLastError); }
   void ForgetError() { return; }
   void (AliTRDrawStream::*fStoreError)();       //! function pointer to method used for storing the error
 
-  static const char* fgErrorMessages[kLastErrorCode];     // error messages corresponding to the error codes
-  static const Int_t fgErrorDebugLevel[kLastErrorCode];   // error debug level
+  static const char* fgkErrorMessages[kLastErrorCode];     // error messages corresponding to the error codes
+  static       Int_t fgErrorDebugLevel[kLastErrorCode];   // error debug level
   static       ErrorBehav_t fgErrorBehav[kLastErrorCode]; // bevhaviour in case of error of given type
 
   // I/O
-  AliRawReader *fRawReader;                     // pointer to the raw reader to take the data from 
+  AliRawReader *fRawReader;                     // pointer to the raw reader to take the data from
   AliTRDdigitsManager *fDigitsManager;          // pointer to the digitsManager to fill the data
   AliTRDdigitsParam   *fDigitsParam;            // pointer to the parameters belonging to the digits
 
   TTree *fErrors;                               // tree containing the occured error codes
-  class AliTRDrawStreamError { 
-  public: 
-    AliTRDrawStreamError(Int_t error = 0, Int_t sector = -1, Int_t stack = -1, Int_t link = -1, Int_t rob = -1, Int_t mcm = -1); 
-    virtual ~AliTRDrawStreamError() {}
-    Int_t fError;                               // error code
-    Int_t fSector;                             // sector
-    Int_t fStack;                              // stack
-    Int_t fLink;                               // link
-    Int_t fRob;                                        // ROB no
-    Int_t fMcm;                                        // MCM no
-    ClassDef(AliTRDrawStreamError, 1);
-  } fLastError;                                 // last error which occured
+  AliTRDrawStreamError fLastError;              // last error which occured
   UInt_t fErrorFlags;                           // error flags used to steer subsequent reading
   char   fErrorBuffer[100];                     // buffer for error message
 
+  AliTRDrawStats fStats;            // event statistics, clearing must be done by the user
+
   UInt_t *fPayloadStart;                        // pointer to start of data payload
   UInt_t *fPayloadCurr;                         // pointer to current reading position in the payload
   Int_t   fPayloadSize;                         // size of the payload (in UInt_t words)
 
   static const Int_t fgkNlinks;                 // number of links to read
+  static const Int_t fgkNsectors;               // number of sectors
   static const Int_t fgkNstacks;                // number of stacks to read
-  static const UInt_t fgkDataEndmarker;         // data endmarker 
+  static const Int_t fgkNtriggers;              // number of triggers in data stream
+  static const UInt_t fgkDataEndmarker;         // data endmarker
   static const UInt_t fgkTrackletEndmarker;     // tracklet endmarker
-  static const Int_t fgkMcmOrder [];            // expected readout order of the MCMs
-  static const Int_t fgkRobOrder [];            // expected readout order of the ROBs
+  static const UInt_t fgkStackEndmarker[];      // stack endmarker (used from version 0xd on)
+  static       Int_t fgMcmOrder [];             // expected readout order of the MCMs
+  static       Int_t fgRobOrder [];             // expected readout order of the ROBs
 
   // persistent information
   Int_t  fNtimebins;                            // number of timebins
-  Int_t  fLastEvId;                             // Event ID of last event 
+  Int_t  fLastEvId;                             // Event ID of last event
 
   // information valid at current reader position
   // all the variables fCurr... refer to the value at the current
   // reading position
-  Int_t fCurrSlot;                              // current slot 
+  Int_t fCurrSlot;                              // current slot
   Int_t fCurrLink;                             // current link
   Int_t fCurrRobPos;                           // current ROB number
   Int_t fCurrMcmPos;                           // current MCM number
@@ -255,25 +309,59 @@ class AliTRDrawStream : public TObject
   // DDL header
   UInt_t fCurrEquipmentId;                     // current Equipment ID
 
-  // SMU index header
-  UInt_t fCurrSmuIndexHeaderSize;              // current size of the SMU index header
-  UInt_t fCurrSmuIndexHeaderVersion;           // current version of the SMU index header
+  // SM header
+  UInt_t fCurrSmHeaderSize;                     // current size of the SM header
+  UInt_t fCurrSmHeaderVersion;                  // current version of the SM header
+  UInt_t fCurrTrailerReadout;                  // current presence of trailer (after the payload)
+  UInt_t fCurrTrgHeaderAvail;                  // current trigger information availability
+  UInt_t fCurrTrgHeaderReadout;                 // current readout mode for the trigger headers
+  UInt_t fCurrTrkHeaderAvail;                  // current tracking information availability
+  UInt_t fCurrStackEndmarkerAvail;              // current stack endmarker availability
+  UInt_t fCurrEvType;                          // current event type
+  UInt_t fCurrTriggerEnable;                    // current trigger enable
+  UInt_t fCurrTriggerFired;                     // current trigger fired
   UInt_t fCurrTrackEnable;                     // current value of track enable
   UInt_t fCurrTrackletEnable;                  // current value of tracklet enable
   UInt_t fCurrStackMask;                       // current mask of active stacks
+#ifdef TRD_RAW_DEBUG
+  UInt_t *fCurrL0Count;                        // number of received L0 triggers
+  UInt_t *fCurrL1aCount;                       // number of received L1a triggers
+  UInt_t *fCurrL1rCount;                       // number of received L1r triggers
+  UInt_t *fCurrL2aCount;                       // number of received L2a triggers
+  UInt_t *fCurrL2rCount;                       // number of received L2r triggers
+   Int_t fCurrL0offset[540];                   // current offset for L0 accepts from GTU and chambers
+  UInt_t fCurrEvCount[540];                    // current event count from the MCMs
+#endif
 
-  // Stack index header
+  // Tracking header
+  UInt_t *fCurrTrkHeaderIndexWord;              // current tracking header index word
+  UInt_t *fCurrTrkHeaderSize;                   // current tracking header index word
+  ULong64_t *fCurrTrkFlags;                     // current tracking done flags
+
+  // Trigger header
+  UInt_t *fCurrTrgHeaderIndexWord;              // current tracking header index word
+  UInt_t *fCurrTrgHeaderSize;                   // current tracking header index word
+  UInt_t *fCurrTrgFlags;                       // current trigger flags of all sectors
+
+  // Stack header
   UInt_t *fCurrStackIndexWord;                 // current stack index words
   UInt_t *fCurrStackHeaderSize;                        // current stack index sizes
   UInt_t *fCurrStackHeaderVersion;             // current stack header versions
   UInt_t *fCurrLinkMask;                       // current link masks
   UInt_t *fCurrCleanCheckout;                  // current clean checkout flags
   UInt_t *fCurrBoardId;                                // current board IDs
-  UInt_t *fCurrHwRev;                          // current hardware revision
+  UInt_t  fCurrHwRev;                          // current hardware revision
+  UInt_t *fCurrHwRevTMU;                       // current hardware revision
   UInt_t *fCurrLinkMonitorFlags;               // current link monitor flags
   UInt_t *fCurrLinkDataTypeFlags;              // current link data flags
   UInt_t *fCurrLinkDebugFlags;                 // current link debug flags
 
+  // CRC checks from trailer
+  Char_t fCurrMatchFlagsSRAM[18];
+  Char_t fCurrMatchFlagsPostBP[18];
+  UInt_t fCurrChecksumStack[18][5];
+  UInt_t fCurrChecksumSIU;
+
   // HC information
   Int_t fCurrSpecial;                          // current value of the special flag
   Int_t fCurrMajor;                            // current major version
@@ -286,21 +374,19 @@ class AliTRDrawStream : public TObject
   Int_t fCurrHC;                               // current HC
   Int_t fCurrCheck;                            // current check bits
   Int_t fCurrNtimebins;                                // current number of timebins
-  Int_t fCurrBC;                               // current BC
   Int_t fCurrPtrgCnt;                          // current pretrigger count
   Int_t fCurrPtrgPhase;                                // current pretrigger phase
+#ifdef TRD_RAW_DEBUG
+  Int_t fCurrBC[1080];                         // current BC
+#endif
 
   // settings for dumping
   Int_t fDumpMCM[100];                         // MCMs to dump
   Int_t fNDumpMCMs;                             // number of MCMs to dump
 
-  // tracklet information
-  TClonesArray *fTrackletArray;                        // pointer to array for tracklet storage
-
   // output data
   AliTRDarrayADC *fAdcArray;                   // pointer to ADC array
   AliTRDSignalIndex *fSignalIndex;             // pointer to the signal index
-  TTree *fTrackletTree;                        // pointer to the tree for tracklet storage
   TClonesArray *fTracklets;                    // pointer to array of tracklets
   TClonesArray *fTracks;                       // pointer to array of GTU tracks
   TClonesArray *fMarkers;                      // pointer to array of markers (data present, errors, ...)