TOF QA Task (F. Bellini)
[u/mrichter/AliRoot.git] / RAW / AliAltroRawStreamV3.h
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
21 class AliRawReader;
22 class AliAltroRawStream;
23
24 class 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
46     UInt_t GetEndTimeBin()     const { return fStartTimeBin-fBunchLength+1; } // Provide the index of the last time-bin in current bunch
47     Int_t  GetBunchLength()    const { return fBunchLength; }  // Provide the current bunch length
48     const UShort_t* GetSignals() const { return fBunchDataPointer; }  // Provide access to altro data itself
49     Bool_t IsChannelBad()      const { return fBadChannel; }   // Is the channel data bad or not
50
51     Int_t GetChannelPayloadSize() const { return fChannelPayloadSize; }
52     UChar_t *GetRCUPayloadInSOD() const;
53     Int_t GetRCUPayloadSizeInSOD() const;
54
55     Int_t GetBranch()     const; // Provide the branch index for the current hardware address
56     Int_t GetFEC()        const; // Provide the front-end card index for the current hardware address
57     Int_t GetAltro()      const; // Provide the altro chip index for the current hardware address
58     Int_t GetChannel()    const; // Provide the channel index for the current hardware address
59
60     Bool_t  GetRCUTrailerData(UChar_t*& data) const;              // Provide a pointer to RCU trailer
61     Int_t   GetRCUTrailerSize() const { return fRCUTrailerSize; } // Provide size of RCU trailer
62
63     // RCU trailer related getters
64     UInt_t  GetFECERRA() const { return fFECERRA; }
65     UInt_t  GetFECERRB() const { return fFECERRB; }
66     UShort_t GetERRREG2() const { return fERRREG2; }
67     UShort_t GetNChAddrMismatch() const { return (fERRREG3 & 0xFFF); }
68     UShort_t GetNChLengthMismatch() const { return ((fERRREG3 >> 12) & 0x1FFF); }
69
70     UShort_t GetActiveFECsA() const { return fActiveFECsA; }
71     UShort_t GetActiveFECsB() const { return fActiveFECsB; }
72
73     UInt_t  GetAltroCFG1() const { return fAltroCFG1; }
74     UChar_t GetBaselineCorr() const { return fAltroCFG1 & 0xF; }
75     Bool_t  GetPolarity() const { return (fAltroCFG1 >> 4) & 0x1; }
76     UChar_t GetNPresamples() const  { return (fAltroCFG1 >> 5) & 0x3; }
77     UChar_t GetNPostsamples() const { return (fAltroCFG1 >> 7) & 0xF; }
78     Bool_t  GetSecondBaselineCorr() const { return (fAltroCFG1 >> 11) & 0x1; }
79     UChar_t GetGlitchFilter() const { return (fAltroCFG1 >> 12) & 0x3; }
80     UChar_t GetNNonZSPostsamples() const { return (fAltroCFG1 >> 14) & 0x7; }
81     UChar_t GetNNonZSPresamples() const  { return (fAltroCFG1 >> 17) & 0x3; }
82     Bool_t  GetZeroSupp() const          { return (fAltroCFG1 >> 19) & 0x1; }
83     
84     UInt_t   GetAltroCFG2() const { return fAltroCFG2; }
85     Bool_t   GetNAltroBuffers() const     { return (fAltroCFG2 >> 24) & 0x1; }
86     UChar_t  GetNPretriggerSamples() const{ return (fAltroCFG2 >> 20) & 0xF; }
87     UShort_t GetNSamplesPerCh() const     { return (fAltroCFG2 >> 10) & 0x3FF; }
88     Bool_t   GetSparseRO() const          { return (fAltroCFG2 >> 9) & 0x1; }
89     Double_t GetTSample() const;
90     Double_t GetL1Phase() const;
91     void     PrintRCUTrailer() const;
92  
93     void  SetShortDataHeader(Bool_t flag) { fIsShortDataHeader = flag; } // Specify whenever to assume or not a short CDH format
94
95     void  SetCheckAltroPayload(Bool_t check) { fCheckAltroPayload = check; }
96
97     void HexDumpChannel() const;
98
99     enum EAltroRawStreamV3Error {
100       kRCUTrailerErr = 1,
101       kRCUVerErr = 2,
102       kRCUTrailerSizeErr = 3,
103       kAltroBunchHeadErr = 4,
104       kBunchLengthErr = 5,
105       kAltroPayloadErr = 6,
106       kBadAltroMapping = 7
107     };
108
109     enum {kMaxNTimeBins = 1024};
110
111   protected:
112
113     void             AddMappingErrorLog(const char *message = NULL);
114
115     Bool_t           fIsShortDataHeader; // flag used to select between normal and short CDH format
116
117   private:
118
119     UInt_t           Get32bitWord(Int_t index) const;
120     Bool_t           ReadRCUTrailer(UChar_t rcuVer);
121
122     Int_t            fDDLNumber;    // index of current DDL number
123     Int_t            fRCUId;        // current RCU identifier
124     Short_t          fHWAddress;    // current hardware address
125
126     AliRawReader*    fRawReader;    // object for reading the raw data
127
128     UChar_t*         fData;         // raw data
129
130     Int_t            fPosition;     // current position (32-bit words) in fData
131     Int_t            fCount;        // 
132     Int_t            fStartTimeBin; //
133     Int_t            fBunchLength;  //
134
135     Bool_t           fBadChannel;   //
136     Int_t            fPayloadSize;  //
137
138     Int_t            fChannelPayloadSize; //
139
140     UShort_t         fBunchData[kMaxNTimeBins];    // cache for the decoded altro payload
141     UShort_t*        fBunchDataPointer;            // pointer to the current bunch samples
142     Int_t            fBunchDataIndex;              // current position in the payload
143
144     UChar_t*         fRCUTrailerData; // pointer to RCU trailer data
145     Int_t            fRCUTrailerSize; // size of RCU trailer data in bytes
146
147     // RCU trailer contents
148     UInt_t           fFECERRA;      // contains errors related to ALTROBUS transactions
149     UInt_t           fFECERRB;      // contains errors related to ALTROBUS transactions
150     UShort_t         fERRREG2;      // contains errors related to ALTROBUS transactions or trailer of ALTRO channel block
151     UInt_t           fERRREG3;      // contains number of altro channels skipped due to an address mismatch 
152     UShort_t         fActiveFECsA;  // bit pattern of active FECs in branch A
153     UShort_t         fActiveFECsB;  // bit pattern of active FECs in branch B
154     UInt_t           fAltroCFG1;    // ALTROCFG1 register
155     UInt_t           fAltroCFG2;    // ALTROCFG2 and ALTROIF registers
156
157     AliAltroRawStream* fOldStream;  // streamer for old altro format
158
159     Bool_t           fCheckAltroPayload; // check altro payload correctness or not?
160
161     ClassDef(AliAltroRawStreamV3, 0)  // base class for reading Altro raw digits
162 };
163
164 #endif