Adding optional check on the consistency of the ALTRO payload. By default it is on...
[u/mrichter/AliRoot.git] / RAW / AliAltroRawStreamV3.h
CommitLineData
f8e5b5a0 1#ifndef ALIALTRORAWSTREAMV3_H
2#define ALIALTRORAWSTREAMV3_H
3/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * See cxx source for full Copyright notice */
5
6///////////////////////////////////////////////////////////////////////////////
7///
8/// This is a base class for reading raw data digits in Altro format.
9/// The class is able to read the RCU v3 and above formats.
10/// The main difference between the format V3 and older ones is in
11/// the coding of the 10-bit Altro payload words. In V3 3 10-bit words
12/// are coded in one 32-bit word. The bits 30 and 31 are used to identify
13/// the payload, altro header and RCU trailer contents.
14///
15///
16/// cvetan.cheshkov@cern.ch 1/04/2009
17///////////////////////////////////////////////////////////////////////////////
18
19#include <TObject.h>
20
21class AliRawReader;
0148e633 22class AliAltroRawStream;
f8e5b5a0 23
24class AliAltroRawStreamV3: public TObject {
25 public :
26 AliAltroRawStreamV3(AliRawReader* rawReader);
27 virtual ~AliAltroRawStreamV3();
28
29 AliAltroRawStreamV3& operator = (const AliAltroRawStreamV3& stream);
30 AliAltroRawStreamV3(const AliAltroRawStreamV3& stream);
31
32 void SelectRawData(Int_t detId); // Select raw data for specific detector id
33 void SelectRawData(const char *detName); // Select raw data for specific detector name
34
35 virtual void Reset(); // Reset the raw-stream object
36
37 virtual Bool_t NextDDL(); // Iterate over DDLs/RCUs
38 virtual Bool_t NextChannel(); // Iterate over altro channels
39 virtual Bool_t NextBunch(); // Iterate over altro bunches
40
41 Int_t GetDDLNumber() const { return fDDLNumber; } // Provide current DDL number
42 Int_t GetHWAddress() const { return fHWAddress; } // Provide current hardware address
43 Int_t GetRCUId() const { return fRCUId; } // Provide current RCU identifier
44
45 UInt_t GetStartTimeBin() const { return fStartTimeBin; } // Provide the index if the first time-bin in current bunch
6d4dd848 46 UInt_t GetEndTimeBin() const { return fStartTimeBin-fBunchLength+1; } // Provide the index of the last time-bin in current bunch
f8e5b5a0 47 Int_t GetBunchLength() const { return fBunchLength; } // Provide the current bunch length
6d4dd848 48 const UShort_t* GetSignals() const { return fBunchDataPointer; } // Provide access to altro data itself
f8e5b5a0 49 Bool_t IsChannelBad() const { return fBadChannel; } // Is the channel data bad or not
50
51
52 Int_t GetBranch() const; // Provide the branch index for the current hardware address
53 Int_t GetFEC() const; // Provide the front-end card index for the current hardware address
54 Int_t GetAltro() const; // Provide the altro chip index for the current hardware address
55 Int_t GetChannel() const; // Provide the channel index for the current hardware address
56
57 Bool_t GetRCUTrailerData(UChar_t*& data) const; // Provide a pointer to RCU trailer
58 Int_t GetRCUTrailerSize() const { return fRCUTrailerSize; } // Provide size of RCU trailer
59
60 // RCU trailer related getters
61 UInt_t GetFECERRA() const { return fFECERRA; }
62 UInt_t GetFECERRB() const { return fFECERRB; }
63 UShort_t GetERRREG2() const { return fERRREG2; }
9283f3a5 64 UShort_t GetNChAddrMismatch() const { return (fERRREG3 & 0xFFF); }
65 UShort_t GetNChLengthMismatch() const { return ((fERRREG3 >> 12) & 0x1FFF); }
f8e5b5a0 66
67 UShort_t GetActiveFECsA() const { return fActiveFECsA; }
68 UShort_t GetActiveFECsB() const { return fActiveFECsB; }
69
70 UInt_t GetAltroCFG1() const { return fAltroCFG1; }
71 UChar_t GetBaselineCorr() const { return fAltroCFG1 & 0xF; }
72 Bool_t GetPolarity() const { return (fAltroCFG1 >> 4) & 0x1; }
73 UChar_t GetNPresamples() const { return (fAltroCFG1 >> 5) & 0x3; }
74 UChar_t GetNPostsamples() const { return (fAltroCFG1 >> 7) & 0xF; }
75 Bool_t GetSecondBaselineCorr() const { return (fAltroCFG1 >> 11) & 0x1; }
76 UChar_t GetGlitchFilter() const { return (fAltroCFG1 >> 12) & 0x3; }
77 UChar_t GetNNonZSPostsamples() const { return (fAltroCFG1 >> 14) & 0x7; }
78 UChar_t GetNNonZSPresamples() const { return (fAltroCFG1 >> 17) & 0x3; }
79 Bool_t GetZeroSupp() const { return (fAltroCFG1 >> 19) & 0x1; }
80
81 UInt_t GetAltroCFG2() const { return fAltroCFG2; }
82 Bool_t GetNAltroBuffers() const { return (fAltroCFG2 >> 24) & 0x1; }
83 UChar_t GetNPretriggerSamples() const{ return (fAltroCFG2 >> 20) & 0xF; }
84 UShort_t GetNSamplesPerCh() const { return (fAltroCFG2 >> 10) & 0x3FF; }
85 Bool_t GetSparseRO() const { return (fAltroCFG2 >> 9) & 0x1; }
86 Double_t GetTSample() const;
87 Double_t GetL1Phase() const;
88 void PrintRCUTrailer() const;
89
90 void SetShortDataHeader(Bool_t flag) { fIsShortDataHeader = flag; } // Specify whenever to assume or not a short CDH format
91
3ce326c0 92 void SetCheckAltroPayload(Bool_t check) { fCheckAltroPayload = check; }
93
f8e5b5a0 94 enum EAltroRawStreamV3Error {
95 kRCUTrailerErr = 1,
96 kRCUVerErr = 2,
97 kRCUTrailerSizeErr = 3,
98 kAltroBunchHeadErr = 4,
99 kBunchLengthErr = 5,
100 kAltroPayloadErr = 6,
101 kBadAltroMapping = 7
102 };
103
104 enum {kMaxNTimeBins = 1024};
105
106 protected:
107
108 void AddMappingErrorLog(const char *message = NULL);
109
110 Bool_t fIsShortDataHeader; // flag used to select between normal and short CDH format
111
112 private:
113
114 UInt_t Get32bitWord(Int_t index) const;
115 Bool_t ReadRCUTrailer(UChar_t rcuVer);
116
117 Int_t fDDLNumber; // index of current DDL number
118 Int_t fRCUId; // current RCU identifier
119 Short_t fHWAddress; // current hardware address
120
121 AliRawReader* fRawReader; // object for reading the raw data
122
123 UChar_t* fData; // raw data
124
125 Int_t fPosition; // current position (32-bit words) in fData
126 Int_t fCount; //
127 Int_t fStartTimeBin; //
128 Int_t fBunchLength; //
129
130 Bool_t fBadChannel; //
131 Int_t fPayloadSize; //
132
6d4dd848 133 UShort_t fBunchData[kMaxNTimeBins]; // cache for the decoded altro payload
134 UShort_t* fBunchDataPointer; // pointer to the current bunch samples
135 Int_t fBunchDataIndex; // current position in the payload
f8e5b5a0 136
137 UChar_t* fRCUTrailerData; // pointer to RCU trailer data
138 Int_t fRCUTrailerSize; // size of RCU trailer data in bytes
139
140 // RCU trailer contents
141 UInt_t fFECERRA; // contains errors related to ALTROBUS transactions
142 UInt_t fFECERRB; // contains errors related to ALTROBUS transactions
143 UShort_t fERRREG2; // contains errors related to ALTROBUS transactions or trailer of ALTRO channel block
9283f3a5 144 UInt_t fERRREG3; // contains number of altro channels skipped due to an address mismatch
f8e5b5a0 145 UShort_t fActiveFECsA; // bit pattern of active FECs in branch A
146 UShort_t fActiveFECsB; // bit pattern of active FECs in branch B
147 UInt_t fAltroCFG1; // ALTROCFG1 register
148 UInt_t fAltroCFG2; // ALTROCFG2 and ALTROIF registers
149
0148e633 150 AliAltroRawStream* fOldStream; // streamer for old altro format
151
3ce326c0 152 Bool_t fCheckAltroPayload; // check altro payload correctness or not?
153
f8e5b5a0 154 ClassDef(AliAltroRawStreamV3, 0) // base class for reading Altro raw digits
155};
156
157#endif