1 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
2 * See cxx source for full Copyright notice */
4 //-----------------------------------
6 // decoding of TRD raw data stream
7 // and translation into digits
9 //----------------------------------
11 #ifndef ALITRDRAWSTREAM_H
12 #define ALITRDRAWSTREAM_H
15 #include "TClonesArray.h"
25 class AliTRDdigitsManager;
26 class AliTRDdigitsParam;
28 class AliTRDSignalIndex;
29 class AliTRDtrackletContainer;
31 class AliTRDrawStream : public TObject
34 AliTRDrawStream(AliRawReader *rawReader = 0x0);
37 enum { kDDLOffset = 0x400, // Offset for DDL numbers
38 kDDLMax = 0x411 }; // Max DDL number for TRD SM
40 Bool_t SetReader(AliRawReader *rawReader) { fRawReader = rawReader; return kTRUE; }
41 void SetDigitsManager(AliTRDdigitsManager *digMgr) { fDigitsManager = digMgr; }
42 void SetTrackletArray(TClonesArray *ar) { fTracklets = ar; }
43 void SetTrackArray(TClonesArray *ar) { fTracks = ar; }
44 void SetMarkerArray(TClonesArray *ar) { fMarkers = ar; }
46 TClonesArray* GetTrackletArray() const { return fTracklets; }
47 TClonesArray* GetTrackArray() const { return fTracks; }
48 TClonesArray* GetMarkerArray() const { return fMarkers; }
50 AliTRDdigitsManager* GetDigitsManager() const { return fDigitsManager; }
51 TTree *GetTrackletTree() const { return fTrackletTree; }
53 Bool_t ReadEvent(TTree *trackletTree = 0x0);
56 Int_t NextChamber(AliTRDdigitsManager *digMgr);
57 Int_t NextChamber(AliTRDdigitsManager *digMgr,
58 UInt_t ** /* trackletContainer */, UShort_t ** /* errorContainer */) { AliError("Deprecated, use NextChamber(AliTRDdigitsManger*) instead!"); return NextChamber(digMgr); }
60 Bool_t ConnectTracklets(TTree *trklTree);
62 void StoreErrorsInTree() { fStoreError = &AliTRDrawStream::StoreErrorTree; }
63 void StoreErrorsInArray() { fStoreError = &AliTRDrawStream::StoreErrorArray; }
64 void EnableErrorStorage() { fStoreError = &AliTRDrawStream::StoreErrorTree; }
65 void DisableErrorStorage() { fStoreError = &AliTRDrawStream::ForgetError; }
103 TTree* GetErrorTree() const { return fErrors; }
104 static const char* GetErrorMessage(ErrorCode_t errCode);
105 static void SetErrorDebugLevel(ErrorCode_t error, Int_t level) { fgErrorDebugLevel[error] = level; }
106 static void SetErrorBehaviour(ErrorCode_t error, ErrorBehav_t behav) { fgErrorBehav[error] = behav; }
108 class AliTRDrawStreamError : public TObject {
110 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);
111 virtual ~AliTRDrawStreamError() {}
112 Int_t fError; // error code
113 Int_t fSector; // sector
114 Int_t fStack; // stack
116 Int_t fRob; // ROB no
117 Int_t fMcm; // MCM no
118 ClassDef(AliTRDrawStreamError, 1);
122 class AliTRDrawStats : public TObject {
124 AliTRDrawStats() : TObject(), fBytesRead(0) {}
127 class AliTRDrawStatsSector : public TObject {
129 AliTRDrawStatsSector() : TObject(), fBytes(0), fBytesRead(0), fNTracklets(0), fNMCMs(0), fNChannels(0) {}
132 class AliTRDrawStatsHC : public TObject {
134 AliTRDrawStatsHC() : TObject(), fBytes(0), fBytesRead(0), fNTracklets(0), fNMCMs(0), fNChannels(0) {}
137 Int_t fBytes; // number of bytes (not necessarily read)
138 Int_t fBytesRead; // number of bytes read
139 Int_t fNTracklets; // number of tracklets
140 Int_t fNMCMs; // number of MCMs (from MCM headers)
141 Int_t fNChannels; // number of channels
142 ClassDef(AliTRDrawStatsHC, 1);
145 Int_t fBytes; // number of bytes (not necessarily read)
146 Int_t fBytesRead; // number of bytes read
147 Int_t fNTracklets; // number of tracklets
148 Int_t fNMCMs; // number of MCMs (from MCM headers)
149 Int_t fNChannels; // number of channels
150 AliTRDrawStatsHC fStatsHC[60]; //[60] HC-wise statistics
151 ClassDef(AliTRDrawStatsSector, 1);
154 AliTRDrawStatsSector fStatsSector[18]; //[18] sector-wise statistics
155 Int_t fBytesRead; // number of bytes read
156 ClassDef(AliTRDrawStats, 1);
159 AliTRDrawStats* GetStats() { return &fStats; }
160 Int_t GetEventSize(Int_t sector) const { return fStats.fStatsSector[sector].fBytes; }
161 Int_t GetNTracklets(Int_t sector) const { return fStats.fStatsSector[sector].fNTracklets; }
162 Int_t GetNMCMs(Int_t sector) const { return fStats.fStatsSector[sector].fNMCMs; }
163 Int_t GetNChannels(Int_t sector) const { return fStats.fStatsSector[sector].fNChannels; }
165 ULong64_t GetTrkFlags(Int_t sector, Int_t stack) const { return fCurrTrkFlags[sector*fgkNstacks + stack]; }
166 UInt_t GetTriggerFlags(Int_t sector) const { return fCurrTrgFlags[sector]; }
169 void SetDumpMCM(Int_t det, Int_t rob, Int_t mcm, Bool_t dump = kTRUE);
171 Bool_t IsDumping() const { return (fNDumpMCMs > 0); }
172 Bool_t DumpingMCM(Int_t det, Int_t rob, Int_t mcm) const;
174 TString DumpRaw(TString title, UInt_t *start, Int_t length, UInt_t endmarker = 0xffffffff);
175 TString DumpMcmHeader(TString title, UInt_t word);
176 TString DumpAdcMask(TString title, UInt_t word);
178 // temporary: allow to change expected readout order
179 static void SetMCMReadoutPos(Int_t mcm, Int_t pos) { if (mcm > -1 && mcm < 16) fgMcmOrder[mcm] = pos; }
180 static void SetROBReadoutPos(Int_t robpair, Int_t pos) { if (robpair > -1 && robpair < 4) fgMcmOrder[robpair] = pos; }
183 Int_t ReadGTUHeaders(UInt_t *buffer);
184 Int_t ReadSmHeader();
185 Int_t ReadTrackingHeader(Int_t stack);
186 Int_t ReadTriggerHeaders();
187 Int_t ReadStackHeader(Int_t stack);
188 Int_t DecodeGTUtracks();
189 Int_t ReadGTUTrailer();
191 Int_t ReadLinkData();
192 Int_t ReadTracklets();
193 Int_t ReadHcHeader();
194 Int_t ReadTPData(Int_t mode = 1);
196 Int_t ReadNonZSData();
198 Int_t SeekNextLink();
200 // MCM header decoding
201 Int_t ROB(UInt_t mcmhdr) const { return 0x7 & mcmhdr >> 28; }
202 Int_t MCM(UInt_t mcmhdr) const { return 0xf & mcmhdr >> 24; }
203 Int_t Row(UInt_t mcmhdr) const { return (ROB(mcmhdr) / 2) * 4 + MCM(mcmhdr) / 4; }
204 Int_t AdcColOffset(UInt_t mcmhdr) const { return (MCM(mcmhdr) % 4 + 1) * 21 + (ROB(mcmhdr) % 2) * 84 - 1; }
205 Int_t PadColOffset(UInt_t mcmhdr) const { return (MCM(mcmhdr) % 4 + 1) * 18 + (ROB(mcmhdr) % 2) * 72 + 1; }
206 Int_t EvNo(UInt_t mcmhdr) const { return 0xfffff & mcmhdr >> 4; }
207 Int_t Check(UInt_t mcmhdr) const { return 0xf & mcmhdr; }
208 Int_t CouldBeMCMhdr(UInt_t mcmhdr) const { return ((0xf & mcmhdr) == 0xc); }
210 Int_t GetMCMReadoutPos(Int_t mcm) const { return (mcm > -1 && mcm < 16) ? fgMcmOrder[mcm] : -1; }
211 Int_t GetROBReadoutPos(Int_t rob) const { return (rob > -1 && rob < 4) ? fgRobOrder[rob] : -1; }
214 Int_t GetActiveChannels(UInt_t adcmask) const { return 0x1fffff & adcmask >> 4; }
215 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; }
216 Int_t GetNActiveChannels(UInt_t adcmask) const { return (0x1f & ~(adcmask >> 25)); }
217 Int_t CouldBeADCmask(UInt_t adcmask) const { return ((0xf & adcmask) == 0xc && (0x3 & adcmask >> 30) == 0x1); }
219 // error message generation
220 void EquipmentError(ErrorCode_t err = kUnknown, const char *const msg = "", ...);
221 void StackError (ErrorCode_t err = kUnknown, const char *const msg = "", ...);
222 void LinkError (ErrorCode_t err = kUnknown, const char *const msg = "", ...);
223 void ROBError (ErrorCode_t err = kUnknown, const char *const msg = "", ...);
224 void MCMError (ErrorCode_t err = kUnknown, const char *const msg = "", ...);
225 void StoreErrorTree() { fErrors->Fill(); }
226 void StoreErrorArray() { new ((*fMarkers)[fMarkers->GetEntriesFast()]) AliTRDrawStreamError(fLastError); }
227 void ForgetError() { return; }
228 void (AliTRDrawStream::*fStoreError)(); //! function pointer to method used for storing the error
230 static const char* fgkErrorMessages[kLastErrorCode]; // error messages corresponding to the error codes
231 static Int_t fgErrorDebugLevel[kLastErrorCode]; // error debug level
232 static ErrorBehav_t fgErrorBehav[kLastErrorCode]; // bevhaviour in case of error of given type
235 AliRawReader *fRawReader; // pointer to the raw reader to take the data from
236 AliTRDdigitsManager *fDigitsManager; // pointer to the digitsManager to fill the data
237 AliTRDdigitsParam *fDigitsParam; // pointer to the parameters belonging to the digits
239 TTree *fErrors; // tree containing the occured error codes
240 AliTRDrawStreamError fLastError; // last error which occured
241 UInt_t fErrorFlags; // error flags used to steer subsequent reading
242 char fErrorBuffer[100]; // buffer for error message
244 AliTRDrawStats fStats; // event statistics, clearing must be done by the user
246 UInt_t *fPayloadStart; // pointer to start of data payload
247 UInt_t *fPayloadCurr; // pointer to current reading position in the payload
248 Int_t fPayloadSize; // size of the payload (in UInt_t words)
250 static const Int_t fgkNlinks; // number of links to read
251 static const Int_t fgkNsectors; // number of sectors
252 static const Int_t fgkNstacks; // number of stacks to read
253 static const Int_t fgkNtriggers; // number of triggers in data stream
254 static const UInt_t fgkDataEndmarker; // data endmarker
255 static const UInt_t fgkTrackletEndmarker; // tracklet endmarker
256 static Int_t fgMcmOrder []; // expected readout order of the MCMs
257 static Int_t fgRobOrder []; // expected readout order of the ROBs
259 // persistent information
260 Int_t fNtimebins; // number of timebins
261 Int_t fLastEvId; // Event ID of last event
263 // information valid at current reader position
264 // all the variables fCurr... refer to the value at the current
266 Int_t fCurrSlot; // current slot
267 Int_t fCurrLink; // current link
268 Int_t fCurrRobPos; // current ROB number
269 Int_t fCurrMcmPos; // current MCM number
272 UInt_t fCurrEquipmentId; // current Equipment ID
275 UInt_t fCurrSmHeaderSize; // current size of the SM header
276 UInt_t fCurrSmHeaderVersion; // current version of the SM header
277 UInt_t fCurrTrailerReadout; // current presence of trailer (after the payload)
278 UInt_t fCurrTrgHeaderAvail; // current trigger information availability
279 UInt_t fCurrTrgHeaderReadout; // current readout mode for the trigger headers
280 UInt_t fCurrTrkHeaderAvail; // current tracking information availability
281 UInt_t fCurrEvType; // current event type
282 UInt_t fCurrTriggerEnable; // current trigger enable
283 UInt_t fCurrTriggerFired; // current trigger fired
284 UInt_t fCurrTrackEnable; // current value of track enable
285 UInt_t fCurrTrackletEnable; // current value of tracklet enable
286 UInt_t fCurrStackMask; // current mask of active stacks
289 UInt_t *fCurrTrkHeaderIndexWord; // current tracking header index word
290 UInt_t *fCurrTrkHeaderSize; // current tracking header index word
291 ULong64_t *fCurrTrkFlags; // current tracking done flags
294 UInt_t *fCurrTrgHeaderIndexWord; // current tracking header index word
295 UInt_t *fCurrTrgHeaderSize; // current tracking header index word
296 UInt_t *fCurrTrgFlags; // current trigger flags of all sectors
299 UInt_t *fCurrStackIndexWord; // current stack index words
300 UInt_t *fCurrStackHeaderSize; // current stack index sizes
301 UInt_t *fCurrStackHeaderVersion; // current stack header versions
302 UInt_t *fCurrLinkMask; // current link masks
303 UInt_t *fCurrCleanCheckout; // current clean checkout flags
304 UInt_t *fCurrBoardId; // current board IDs
305 UInt_t fCurrHwRev; // current hardware revision
306 UInt_t *fCurrHwRevTMU; // current hardware revision
307 UInt_t *fCurrLinkMonitorFlags; // current link monitor flags
308 UInt_t *fCurrLinkDataTypeFlags; // current link data flags
309 UInt_t *fCurrLinkDebugFlags; // current link debug flags
312 Int_t fCurrSpecial; // current value of the special flag
313 Int_t fCurrMajor; // current major version
314 Int_t fCurrMinor; // current minor version
315 Int_t fCurrAddHcWords; // current number of additional HC-header words
316 Int_t fCurrSm; // current sector
317 Int_t fCurrStack; // current stack
318 Int_t fCurrLayer; // current layer
319 Int_t fCurrSide; // current side
320 Int_t fCurrHC; // current HC
321 Int_t fCurrCheck; // current check bits
322 Int_t fCurrNtimebins; // current number of timebins
323 Int_t fCurrBC; // current BC
324 Int_t fCurrPtrgCnt; // current pretrigger count
325 Int_t fCurrPtrgPhase; // current pretrigger phase
327 // settings for dumping
328 Int_t fDumpMCM[100]; // MCMs to dump
329 Int_t fNDumpMCMs; // number of MCMs to dump
331 // tracklet information
332 TClonesArray *fTrackletArray; // pointer to array for tracklet storage
335 AliTRDarrayADC *fAdcArray; // pointer to ADC array
336 AliTRDSignalIndex *fSignalIndex; // pointer to the signal index
337 TTree *fTrackletTree; // pointer to the tree for tracklet storage
338 TClonesArray *fTracklets; // pointer to array of tracklets
339 TClonesArray *fTracks; // pointer to array of GTU tracks
340 TClonesArray *fMarkers; // pointer to array of markers (data present, errors, ...)
342 AliTRDrawStream(const AliTRDrawStream&); // not implemented
343 AliTRDrawStream& operator=(const AliTRDrawStream&); // not implemented
345 ClassDef(AliTRDrawStream, 0);
348 Int_t AliTRDrawStream::GetNActiveChannelsFromMask(UInt_t adcmask) const
350 // return number of active bits in the ADC mask
352 adcmask = GetActiveChannels(adcmask);
353 adcmask = adcmask - ((adcmask >> 1) & 0x55555555);
354 adcmask = (adcmask & 0x33333333) + ((adcmask >> 2) & 0x33333333);
355 return (((adcmask + (adcmask >> 4)) & 0xF0F0F0F) * 0x1010101) >> 24;