Fix coding rule violations
[u/mrichter/AliRoot.git] / TRD / AliTRDrawStream.h
1 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
2  * See cxx source for full Copyright notice                               */
3
4 //-----------------------------------
5 //
6 // decoding of TRD raw data stream 
7 // and translation into digits
8 //
9 //----------------------------------
10
11 #ifndef ALITRDRAWSTREAM_H
12 #define ALITRDRAWSTREAM_H
13
14 #include "TObject.h"
15
16 #include "AliTRDrawStreamBase.h"
17 //#include "AliRawReader.h"
18
19 class TObjArray;
20 class TString;
21 class TTree;
22
23 class AliRawReader;
24 class AliTRDdigitsManager;
25 class AliTRDdigitsParam;
26 class AliTRDarrayADC;
27 class AliTRDSignalIndex;
28
29 class AliTRDrawStream : public AliTRDrawStreamBase
30 {
31  public:
32   AliTRDrawStream(AliRawReader *rawReader = 0x0);
33   ~AliTRDrawStream();
34
35   Bool_t SetReader(AliRawReader *rawReader) { fRawReader = rawReader; return kTRUE; }
36   void SetDigitsManager(AliTRDdigitsManager *digMgr) { fDigitsManager = digMgr; }
37
38   Bool_t ReadEvent(TTree *trackletTree = 0x0);
39
40   Bool_t NextDDL();
41   Int_t NextChamber(AliTRDdigitsManager *digMgr, 
42                     UInt_t ** /* trackletContainer */, UShort_t ** /* errorContainer */);
43
44   // legacy code, to be removed
45   Bool_t SetRawVersion(Int_t) { return kTRUE; }
46   void SetSharedPadReadout(Bool_t) {}
47   void SetNoErrorWarning() {}
48
49   // error handling
50   enum ErrorCode_t { 
51     kUnknown = 0, 
52     kLinkMonitor, 
53     kPtrgCntMismatch, 
54     kNonTrdEq,
55     kStackHeaderInvalid,
56     kInvalidDetector,
57     kNoDigits,
58     kHCmismatch,
59     kHCcheckFailed,
60     kPosUnexp,
61     kTPmodeInvalid,
62     kTPmismatch,
63     kNtimebinsChanged,
64     kAdcMaskInconsistent,
65     kAdcCheckInvalid,
66     kAdcDataAbort,
67     kAdcChannelsMiss,
68     kMissMcmHeaders,
69     kLastErrorCode
70   }; 
71
72   TTree* GetErrorTree() const { return fErrors; }
73   static const char* GetErrorMessage(ErrorCode_t errCode);
74
75  protected:
76   Int_t ReadSmHeader();
77   Int_t ReadStackIndexHeader(Int_t stack);
78
79   Int_t ReadLinkData();
80   Int_t ReadTracklets();
81   Int_t ReadHcHeader();
82   Int_t ReadTPData(Int_t mode = 1);
83   Int_t ReadZSData();
84   Int_t ReadNonZSData();
85
86   // MCM header decoding
87   Int_t ROB(UInt_t mcmhdr) const { return 0x7 & mcmhdr >> 28; }
88   Int_t MCM(UInt_t mcmhdr) const { return 0xf & mcmhdr >> 24; }
89   Int_t Row(UInt_t mcmhdr) const { return (ROB(mcmhdr) / 2) * 4 + MCM(mcmhdr) / 4; }
90   Int_t AdcColOffset(UInt_t mcmhdr) const { return (MCM(mcmhdr) % 4 + 1) * 21 + (ROB(mcmhdr) % 2) * 84 - 1; }
91   Int_t PadColOffset(UInt_t mcmhdr) const { return (MCM(mcmhdr) % 4 + 1) * 18 + (ROB(mcmhdr) % 2) * 72 + 1; }
92   Int_t EvNo(UInt_t mcmhdr) const { return 0xfffff & mcmhdr >> 4; }
93   Int_t Check(UInt_t mcmhdr) const { return 0xf & mcmhdr; }
94   Int_t CouldBeMCMhdr(UInt_t mcmhdr) const { return ((0xf & mcmhdr) == 0xc); }
95
96   Int_t GetMCMReadoutPos(Int_t mcm) const { return (mcm > -1 && mcm < 16) ? fgkMcmOrder[mcm] : -1; }
97   Int_t GetROBReadoutPos(Int_t rob) const { return (rob > -1 && rob < 4) ? fgkRobOrder[rob] : -1; }
98
99   // ADC mask decoding
100   Int_t GetActiveChannels(UInt_t adcmask) const { return 0x1fffff & adcmask >> 4; }
101   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; }
102   Int_t GetNActiveChannels(UInt_t adcmask) const { return (0x1f & ~(adcmask >> 25)); }
103   Int_t CouldBeADCmask(UInt_t adcmask) const { return ((0xf & adcmask) == 0xc && (0x3 & adcmask >> 30) == 0x1); }
104       
105   // error message generation
106   TString EquipmentError(ErrorCode_t err = kUnknown, TString msg = ""); 
107   TString StackError    (ErrorCode_t err = kUnknown, TString msg = "");     
108   TString LinkError     (ErrorCode_t err = kUnknown, TString msg = ""); 
109   TString ROBError      (ErrorCode_t err = kUnknown, TString msg = ""); 
110   TString MCMError      (ErrorCode_t err = kUnknown, TString msg = ""); 
111
112   static char* fgErrorMessages[kLastErrorCode]; // error messages corresponding to the error codes
113
114   // I/O
115   AliRawReader *fRawReader;                     // pointer to the raw reader to take the data from 
116   AliTRDdigitsManager *fDigitsManager;          // pointer to the digitsManager to fill the data
117   AliTRDdigitsParam   *fDigitsParam;            // pointer to the parameters belonging to the digits
118
119   TTree *fErrors;                               // tree containing the occured error codes
120   struct { Int_t fSector; Int_t fStack; Int_t fLink; Int_t fError; Int_t fRob; Int_t fMcm; } 
121   fLastError;                                   // last error which occured
122
123   UInt_t *fPayloadStart;                        // pointer to start of data payload
124   UInt_t *fPayloadCurr;                         // pointer to current reading position in the payload
125   Int_t   fPayloadSize;                         // size of the payload
126
127   static const Int_t fgkNlinks;                 // number of links to read
128   static const Int_t fgkNstacks;                // number of stacks to read
129   static const UInt_t fgkDataEndmarker;         // data endmarker 
130   static const UInt_t fgkTrackletEndmarker;     // tracklet endmarker
131   static const Int_t fgkMcmOrder [];            // expected readout order of the MCMs
132   static const Int_t fgkRobOrder [];            // expected readout order of the ROBs
133
134   // persistent information
135   Int_t  fNtimebins;                            // number of timebins
136   Int_t  fLastEvId;                             // Event ID of last event 
137
138   // information valid at current reader position
139   // all the variables fCurr... refer to the value at the current
140   // reading position
141   Int_t fCurrSlot;                              // current slot 
142   Int_t fCurrLink;                              // current link
143   Int_t fCurrRobPos;                            // current ROB number
144   Int_t fCurrMcmPos;                            // current MCM number
145
146   // DDL header
147   UInt_t fCurrEquipmentId;                      // current Equipment ID
148
149   // SMU index header
150   UInt_t fCurrSmuIndexHeaderSize;               // current size of the SMU index header
151   UInt_t fCurrSmuIndexHeaderVersion;            // current version of the SMU index header
152   UInt_t fCurrTrackEnable;                      // current value of track enable
153   UInt_t fCurrTrackletEnable;                   // current value of tracklet enable
154   UInt_t fCurrStackMask;                        // current mask of active stacks
155
156   // Stack index header
157   UInt_t *fCurrStackIndexWord;                  // current stack index words
158   UInt_t *fCurrStackHeaderSize;                 // current stack index sizes
159   UInt_t *fCurrStackHeaderVersion;              // current stack header versions
160   UInt_t *fCurrLinkMask;                        // current link masks
161   UInt_t *fCurrCleanCheckout;                   // current clean checkout flags
162   UInt_t *fCurrBoardId;                         // current board IDs
163   UInt_t *fCurrHwRev;                           // current hardware revision
164   UInt_t *fCurrLinkMonitorFlags;                // current link monitor flags
165   UInt_t *fCurrLinkDataTypeFlags;               // current link data flags
166   UInt_t *fCurrLinkDebugFlags;                  // current link debug flags
167
168   // HC information
169   Int_t fCurrSpecial;                           // current value of the special flag
170   Int_t fCurrMajor;                             // current major version
171   Int_t fCurrMinor;                             // current minor version
172   Int_t fCurrAddHcWords;                        // current number of additional HC-header words
173   Int_t fCurrSm;                                // current sector
174   Int_t fCurrStack;                             // current stack
175   Int_t fCurrLayer;                             // current layer
176   Int_t fCurrSide;                              // current side
177   Int_t fCurrHC;                                // current HC
178   Int_t fCurrCheck;                             // current check bits
179   Int_t fCurrNtimebins;                         // current number of timebins
180   Int_t fCurrBC;                                // current BC
181   Int_t fCurrPtrgCnt;                           // current pretrigger count
182   Int_t fCurrPtrgPhase;                         // current pretrigger phase
183
184   // tracklet information
185   TClonesArray *fTrackletArray;                 // pointer to array for tracklet storage
186
187   // output data
188   AliTRDarrayADC *fAdcArray;                    // pointer to ADC array
189   AliTRDSignalIndex *fSignalIndex;              // pointer to the signal index
190   TTree *fTrackletTree;                         // pointer to the tree for tracklet storage
191
192   AliTRDrawStream(const AliTRDrawStream&);           // not implemented
193   AliTRDrawStream& operator=(const AliTRDrawStream&); // not implemented
194
195   ClassDef(AliTRDrawStream, 0);
196 };
197
198 #endif