RAW/AliAltroRawStream.h

   1 #ifndef ALIALTRORAWSTREAM_H
   2 #define ALIALTRORAWSTREAM_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice                               */
   5
   6 /* $Id$ */
   7
   8 ///////////////////////////////////////////////////////////////////////////////
   9 ///
  10 /// This is a base class for reading raw data digits in Altro format
  11 /// The class is able to read both old and new RCU trailer formats
  12 /// Switch between formats is done automatically using the last payload word.
  13 /// In case the Common Data Header is 7 32-bit words long, one
  14 /// can use the fIsShortDataHeader flag.
  15 ///
  16 ///////////////////////////////////////////////////////////////////////////////
  17
  18 #include <TObject.h>
  19
  20 class AliRawReader;
  21
  22 class AliAltroRawStream: public TObject {
  23   public :
  24     AliAltroRawStream(AliRawReader* rawReader);
  25     virtual ~AliAltroRawStream();
  26
  27     virtual void             Reset();
  28     virtual Bool_t           Next();
  29
  30     Int_t GetDDLNumber()  const { return fDDLNumber; }  // Provide current DDL number
  31     Int_t GetPrevDDLNumber() const { return fPrevDDLNumber; }// Provide previous DDL number
  32     Bool_t  IsNewDDLNumber() const {return (fDDLNumber != fPrevDDLNumber);};
  33     Int_t GetRCUId()      const { return fRCUId; }      // Provide current RCU identifier
  34     Int_t GetPrevRCUId()  const { return fPrevRCUId; }  // Provide previous RCU identifier
  35     Bool_t  IsNewRCUId() const {return (fRCUId != fPrevRCUId);};
  36     Int_t GetHWAddress()  const { return fHWAddress; }  // Provide current hardware address
  37     Int_t GetPrevHWAddress() const { return fPrevHWAddress; }  // Provide previous hardware address
  38     Bool_t  IsNewHWAddress() const {return (fHWAddress != fPrevHWAddress) || IsNewDDLNumber();};
  39     Int_t GetTime()       const { return fTime; }       // Provide index of current time bin
  40     Int_t GetPrevTime()   const { return fPrevTime; }   // Provide index of previous time bin
  41     Bool_t  IsNewTime()   const {return (fTime != fPrevTime) || IsNewHWAddress();};
  42     Int_t GetSignal()     const { return fSignal; }     // Provide signal in ADC counts
  43     Int_t GetTimeLength() const { return fTimeBunch; }  // Provide total length of current time bunch
  44
  45     Int_t GetBranch()     const; // Provide the branch index for the current hardware address
  46     Int_t GetFEC()        const; // Provide the front-end card index for the current hardware address
  47     Int_t GetAltro()      const; // Provide the altro chip index for the current hardware address
  48     Int_t GetChannel()    const; // Provide the channel index for the current hardware address
  49
  50     Bool_t  GetRCUTrailerData(UChar_t*& data) const;              // Provide a pointer to RCU trailer
  51     Int_t   GetRCUTrailerSize() const { return fRCUTrailerSize; } // Provide size of RCU trailer
  52
  53     // RCU trailer related getters
  54     UInt_t  GetFECERRA() const { return fFECERRA; }
  55     UInt_t  GetFECERRB() const { return fFECERRB; }
  56     UShort_t GetERRREG2() const { return fERRREG2; }
  57     UShort_t GetActiveFECsA() const { return fActiveFECsA; }
  58     UShort_t GetActiveFECsB() const { return fActiveFECsB; }
  59
  60     UChar_t GetBaselineCorr() const { return fAltroCFG1 & 0xF; }
  61     UChar_t GetNPresamples() const  { return (fAltroCFG1 >> 4) & 0x3; }
  62     UChar_t GetNPostsamples() const { return (fAltroCFG1 >> 6) & 0xF; }
  63     Bool_t  GetSecondBaselineCorr() const { return (fAltroCFG1 >> 10) & 0x1; }
  64     UChar_t GetGlitchFilter() const { return (fAltroCFG1 >> 11) & 0x3; }
  65     UChar_t GetNNonZSPostsamples() const { return (fAltroCFG1 >> 13) & 0x7; }
  66     UChar_t GetNNonZSPresamples() const  { return (fAltroCFG1 >> 16) & 0x3; }
  67     Bool_t  GetZeroSupp() const          { return (fAltroCFG1 >> 18) & 0x1; }
  68
  69     Bool_t   GetNAltroBuffers() const     { return (fAltroCFG2 >> 24) & 0x1; }
  70     UChar_t  GetNPretriggerSamples() const{ return (fAltroCFG2 >> 20) & 0xF; }
  71     UShort_t GetNSamplesPerCh() const     { return (fAltroCFG2 >> 10) & 0x3FF; }
  72     Bool_t   GetSparseRO() const          { return (fAltroCFG2 >> 9) & 0x1; }
  73     UChar_t  GetSamplingFq() const        { return (fAltroCFG2 >> 5) & 0xF; }
  74     UChar_t  GetL1Phase() const           { return fAltroCFG2 & 0x1F; }
  75     void     PrintRCUTrailer() const;
  76
  77     void SelectRawData(Int_t detId);                           // Select raw data for specific detector id
  78     void SelectRawData(const char *detName);                   // Select raw data for specific detector name
  79
  80     void  SetNoAltroMapping(Bool_t flag) { fNoAltroMapping = flag; }  // Specify whenever to use or not the altro mapping
  81     void  SetShortDataHeader(Bool_t flag) { fIsShortDataHeader = flag; } // Specify whenever to assume or not a short CDH format
  82
  83     void PrintDebug() const; // Print debug information in case of decoding errors
  84     void AddMappingErrorLog(const char *message = NULL);
  85
  86     enum EAltroRawStreamError {
  87       kRCUTrailerSizeErr = 1,
  88       kAltroTrailerErr = 2,
  89       kBunchLengthReadErr = 3,
  90       kTimeBinReadErr = 4,
  91       kAmplitudeReadErr = 5,
  92       k32bitWordReadErr = 6,
  93       kBadAltroMapping = 7,
  94       kRCUTrailerErr = 8
  95     };
  96
  97     AliAltroRawStream& operator = (const AliAltroRawStream& stream);
  98     AliAltroRawStream(const AliAltroRawStream& stream);
  99
 100   protected:
 101
 102     Bool_t           fNoAltroMapping;  // temporary flag in case of no altro mapping is provided
 103     Short_t          fSegmentation[3]; // temporary container for the dummy trailer, to be removed
 104
 105     Bool_t           fIsShortDataHeader; // flag used to select between normal and short CDH format
 106
 107   private :
 108
 109     UShort_t         GetNextWord();
 110     Bool_t           ReadTrailer();
 111     Bool_t           ReadDummyTrailer();
 112     void             ReadBunch();
 113     void             ReadAmplitude();
 114     Int_t            GetPosition();
 115     UInt_t           Get32bitWord(Int_t &index);
 116     Int_t            ReadRCUTrailer(Int_t &index, Int_t trailerSize);
 117
 118     Int_t            fDDLNumber;    // index of current DDL number
 119     Int_t            fPrevDDLNumber;// index of previous DDL number
 120     Int_t            fRCUId;        // current RCU identifier
 121     Int_t            fPrevRCUId;    // previous RCU identifier
 122     Short_t          fHWAddress;    // current hardware address
 123     Short_t          fPrevHWAddress;// previous hardware address
 124     Int_t            fTime;         // index of current time bin
 125     Int_t            fPrevTime;     // index of previous time bin
 126     Int_t            fSignal;       // signal in ADC counts
 127     Int_t            fTimeBunch;    // total length of the current time bunch
 128
 129     AliRawReader*    fRawReader;    // object for reading the raw data
 130
 131
 132     UChar_t*         fData;         // raw data
 133
 134     Int_t            fPosition;     // current (10 bit) position in fData
 135     Int_t            fCount;        // counter of words to be read for current trailer
 136     Int_t            fBunchLength;  // remaining number of signal bins in the current bunch
 137
 138     UChar_t*         fRCUTrailerData; // pointer to RCU trailer data
 139     Int_t            fRCUTrailerSize; // size of RCU trailer data in bytes
 140
 141     // RCU trailer contents
 142     UInt_t           fFECERRA;      // contains errors related to ALTROBUS transactions
 143     UInt_t           fFECERRB;      // contains errors related to ALTROBUS transactions
 144     UShort_t         fERRREG2;      // contains errors related to ALTROBUS transactions or trailer of ALTRO channel block
 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
 150     ClassDef(AliAltroRawStream, 0)  // base class for reading Altro raw digits
 151 };
 152
 153 #endif