HMPID/AliHMPIDRawStream.cxx

   1 /**************************************************************************
   2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   3  *                                                                        *
   4  * Author: The ALICE Off-line Project.                                    *
   5  * Contributors are mentioned in the code where appropriate.              *
   6  *                                                                        *
   7  * Permission to use, copy, modify and distribute this software and its   *
   8  * documentation strictly for non-commercial purposes is hereby granted   *
   9  * without fee, provided that the above copyright notice appears in all   *
  10  * copies and that both the copyright notice and this permission notice   *
  11  * appear in the supporting documentation. The authors make no claims     *
  12  * about the suitability of this software for any purpose. It is          *
  13  * provided "as is" without express or implied warranty.                  *
  14  **************************************************************************/
  15
  16 ///////////////////////////////////////////////////////////////////////////////
  17 ///
  18 /// This is a class for reading the HMPID raw data
  19 /// The format of the raw data corresponds to the one
  20 /// which was documented by Paolo Martinengo.
  21 ///
  22 ///////////////////////////////////////////////////////////////////////////////
  23
  24 #include "AliHMPIDRawStream.h"
  25 #include "AliRawReader.h"
  26 #include "AliLog.h"
  27
  28 Int_t fPos[170000];
  29 Int_t iPos = 0;
  30 static Bool_t stDeb = kTRUE;
  31
  32 ClassImp(AliHMPIDRawStream)
  33
  34 //_____________________________________________________________________________
  35 AliHMPIDRawStream::AliHMPIDRawStream(AliRawReader* rawReader) :
  36   fDDLNumber(-1),
  37   fRawReader(rawReader),
  38   fData(NULL),
  39   fPosition(-1)
  40 {
  41   // Constructor
  42   fNPads = 0;
  43   fCharge = 0x0;
  44   fPad =0x0;
  45
  46   for(Int_t l=1; l < kSumErr; l++) fNumOfErr[l]=0;               //reset errors
  47
  48   fRawReader->Reset();
  49   fRawReader->Select("HMPID");
  50 }
  51 //-----------------------------------------------------------------------------
  52 AliHMPIDRawStream::AliHMPIDRawStream() :
  53   fDDLNumber(-1),
  54   fRawReader(0x0),
  55   fData(NULL),
  56   fPosition(-1)
  57 {
  58   // Constructor
  59   for(Int_t l=1; l < kSumErr; l++) fNumOfErr[l]=0;               //reset errors
  60 }
  61 //_____________________________________________________________________________
  62 AliHMPIDRawStream::~AliHMPIDRawStream()
  63 {
  64   // destructor
  65     DelVars();
  66 }
  67 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  68 void AliHMPIDRawStream::Reset()
  69 {
  70   // reset raw stream params
  71   // Reinitalize the containers
  72   fDDLNumber = -1;
  73   fPosition = -1;
  74   fData = NULL;
  75   if (fRawReader) fRawReader->Reset();
  76 }
  77 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  78 Bool_t AliHMPIDRawStream::Next()
  79 {
  80   // read next DDL raw data from the HMPID raw data stream
  81   // return kFALSE in case of error or no data left
  82   AliDebug(1,"Start.");
  83   do {
  84     if (!fRawReader->ReadNextData(fData)) return kFALSE;
  85   } while (fRawReader->GetDataSize() == 0);
  86
  87
  88   /*
  89   Event type is selected as in $ALICE_ROOT/RAW/event.h
  90   #define START_OF_RUN                    ((eventTypeType) 1)
  91   #define END_OF_RUN                      ((eventTypeType) 2)
  92   #define START_OF_RUN_FILES              ((eventTypeType) 3)
  93   #define END_OF_RUN_FILES                ((eventTypeType) 4)
  94   #define START_OF_BURST                  ((eventTypeType) 5)
  95   #define END_OF_BURST                    ((eventTypeType) 6)
  96   #define PHYSICS_EVENT                   ((eventTypeType) 7) <<---------------
  97   #define CALIBRATION_EVENT               ((eventTypeType) 8)
  98   #define EVENT_FORMAT_ERROR              ((eventTypeType) 9)
  99   #define START_OF_DATA                   ((eventTypeType)10)
 100   #define END_OF_DATA                     ((eventTypeType)11)
 101   #define SYSTEM_SOFTWARE_TRIGGER_EVENT   ((eventTypeType)12)
 102   #define DETECTOR_SOFTWARE_TRIGGER_EVENT ((eventTypeType)13)
 103   #define EVENT_TYPE_MIN                  1
 104   #define EVENT_TYPE_MAX                  13
 105   */
 106
 107   fPosition = 0;
 108   Bool_t status;
 109
 110   if(fRawReader->GetType() == 7)  {                             //New: Select Physics events, Old: Raw data size is not 0 and not 47148 (pedestal)
 111     fDDLNumber = fRawReader->GetDDLID();
 112     Printf("DDL %i started to be decoded!.",fDDLNumber);
 113     InitVars(fRawReader->GetDataSize()/4);
 114     status = ReadHMPIDRawData();
 115     if(status) Printf("Event DDL %i successfully decoded!.",fDDLNumber);
 116     else Printf("Event DDL %i ERROR in decoding!.",fDDLNumber);
 117     if(stDeb) DumpData(fRawReader->GetDataSize());
 118 //    stDeb=kFALSE;
 119   }
 120 //  return status;
 121   return kTRUE;
 122 }
 123 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 124 void AliHMPIDRawStream::InitVars(Int_t n)
 125 {
 126   fNPads = 0;
 127   fCharge = new Int_t[n];
 128   fPad = new Int_t[n];
 129   //for debug purpose
 130   for(Int_t i=0; i < 170000; i++) fPos[i]=0;                     //reset debug
 131   iPos = 0;
 132 }
 133 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 134 void AliHMPIDRawStream::DelVars()
 135 {
 136   fNPads = 0;
 137   delete fCharge;
 138   delete fPad;
 139 }
 140 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 141 Bool_t AliHMPIDRawStream::ReadHMPIDRawData()
 142 {
 143   Int_t cntGlob = fRawReader->GetDataSize()/4;
 144   Int_t cnt = cntGlob;
 145   Int_t nwSeg;
 146   Int_t cntSegment;
 147
 148   fWord = GetWord(cnt);cnt--;
 149
 150
 151   while (cnt>0) {
 152
 153     nwSeg = (fWord >> kbit8) & 0xfff;
 154     if(!CheckSegment()) return kFALSE;
 155     if(!ReadSegment(cntSegment)) return kFALSE;
 156
 157     if(nwSeg != cntSegment) {Printf("Error in Segment counters: %i different wrt %i",nwSeg,cntSegment);return kFALSE;}
 158 //    Printf(" cnt %i cntSegment %i",cnt,cntSegment);
 159     fWord = GetWord(cntSegment+1,kBwd);
 160     cnt-=cntSegment+1;
 161   }
 162
 163   return kTRUE;
 164
 165 }
 166 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 167 Bool_t AliHMPIDRawStream::ReadSegment(Int_t &cntSegment)
 168 {
 169   cntSegment = (fWord >> kbit8) & 0xfff;
 170   Int_t cnt = cntSegment;
 171   Int_t cntRow;
 172   Int_t nwRow;
 173
 174   fWord = GetWord(cnt,kBwd);
 175
 176   while (cnt>0) {
 177
 178     cntRow  = (fWord >> kbit16) & 0xfff;
 179     if(!CheckRowMarker()) return kFALSE;
 180     if(!ReadRow(nwRow)) return kFALSE;
 181
 182     if(nwRow != cntRow) {Printf("Error in Row counters: %i different wrt %i",nwRow,cntRow);return kFALSE;}
 183     fWord = GetWord(cntRow+1);
 184     cnt -= cntRow+1;
 185
 186   }
 187
 188   cntSegment -= cnt;
 189
 190   return kTRUE;
 191
 192 }
 193 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 194 Bool_t AliHMPIDRawStream::ReadRow(Int_t &cntRow)
 195 {
 196   Int_t cnt;
 197   Int_t cntDilogic;
 198   Int_t nwDil;
 199
 200   cntRow  = (fWord >> kbit16) & 0xfff;
 201   cnt = cntRow;
 202
 203   fWord = GetWord(cntRow);
 204
 205   while (cnt>0) {
 206
 207     if(!CheckEoE(nwDil)) return kFALSE;
 208     if(!ReadDilogic(cntDilogic)) return kFALSE;
 209
 210     if(nwDil != cntDilogic) {Printf("Error in Dilogic counters: %i different wrt %i",nwDil,cntDilogic);return kFALSE;}
 211     cnt -= cntDilogic;
 212     fWord = GetWord(1,kBwd); // go to next Dilogic bank...
 213     cnt--;
 214 //    Printf(" cnt %i cntDilogic %i ",cnt,cntDilogic);
 215   }
 216
 217   cntRow -= cnt;
 218
 219   return kTRUE;
 220
 221 }
 222 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 223 Bool_t AliHMPIDRawStream::ReadDilogic(Int_t &cntDilogic)
 224 {
 225   cntDilogic = fWord & 0x7f;
 226
 227   Int_t cnt = cntDilogic;
 228
 229 //  Printf(" cnt DILOGIC %i at %i word %08X",cnt,fPosition,fWord);
 230
 231   for(Int_t iDil=0;iDil<cntDilogic;iDil++) {
 232     UInt_t dilogic = 0, row = 0;
 233     fWord = GetWord(1,kBwd);
 234 //check on row number
 235     cnt--;
 236     row = (fWord >> kbit22) & 0x1f;
 237     if(!CheckRow(row)) continue;
 238 //check dilogic number
 239     dilogic = (fWord >> kbit18) & 0xf;                                              //dilogic info in raw word is between bits: 18...21
 240     if(!CheckDilogic(dilogic)) continue;
 241 //check pad number
 242     UInt_t pad = (fWord >> kbit12) & 0x3f;                                          //pad info in raw word is between bits: 12...17
 243     if(!CheckPad(pad)) continue;
 244     Int_t charge = fWord & 0xfff;
 245     fPad[fNPads] = GetPad(fDDLNumber,row,dilogic,pad);
 246     fCharge[fNPads] = charge;
 247     fNPads++;
 248   }
 249
 250   cntDilogic -= cnt;
 251   return kTRUE;
 252 }
 253 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 254 Bool_t AliHMPIDRawStream::CheckSegment()
 255 {
 256   UInt_t markSegment = 0xAB0;
 257   /*
 258   if (iRow%8 == 0) {
 259     UInt_t segWord = GetWord();
 260     if ((segWord >> 20) != statusSegWord) {
 261       fRawReader->AddMajorErrorLog(kBadSegWordErr);
 262       AliWarning(Form("Wrong segment word signature: %x, expected 0xab0!",(segWord >> 20)));
 263       fNumOfErr[kBadSegWordErr]++;
 264       return kTRUE;
 265     }
 266 */
 267   UInt_t segMarker = (fWord >> kbit20) & 0xfff;
 268   if (segMarker != markSegment ) {
 269     fRawReader->AddMajorErrorLog(kWrongSegErr,Form("Segment marker %0X wrong (expected %0X) at %i in word %0X!",segMarker,markSegment,fPosition,fWord));
 270     AliWarning(Form("Segment marker %X wrong (expected %0X)! at %i in word %0X!",segMarker,markSegment,fPosition,fWord));
 271     fNumOfErr[kWrongSegErr]++;
 272     return kFALSE;
 273   }
 274
 275   UInt_t segAddress = fWord & 0xff;
 276   if (segAddress<1 ||segAddress>3) {
 277     fRawReader->AddMajorErrorLog(kWrongSegErr,Form("Segment address %d not in the valid range [1-3] at %i in word %0X",segAddress,fPosition,fWord));
 278     AliWarning(Form("Segment address %d not in the valid range [1-3]",segAddress));
 279     fNumOfErr[kWrongSegErr]++;
 280     return kFALSE;
 281   }
 282 //  Printf("Segment Marker found at %i! Number of segment is %i",fPosition,segAddress);
 283   return kTRUE;
 284 }
 285 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 286 Bool_t AliHMPIDRawStream::CheckRow(UInt_t row)
 287 {
 288 //check on row number
 289 //  Printf("ROW %i word %0X",row,fWord);
 290   if(row>=1 && row <=kNRows) return kTRUE;
 291
 292   fRawReader->AddMajorErrorLog(kWrongRowErr,Form("row %d",row));
 293   AliWarning(Form("Wrong row index: %d, expected (1 -> %d) word %0X at %i...",row,kNRows,fWord,fPosition));
 294   fNumOfErr[kWrongRowErr]++;
 295   return kFALSE;
 296 }
 297 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 298 Bool_t AliHMPIDRawStream::CheckDilogic(UInt_t dilogic)
 299 {
 300 //check dilogic number
 301   if (dilogic>= 1 && dilogic <=kNDILOGICAdd) return kTRUE;
 302
 303   fRawReader->AddMajorErrorLog(kWrongDilogicErr,Form("dil %d",dilogic));
 304   AliWarning(Form("Wrong DILOGIC index: %d, expected (1 -> %d)!",dilogic,kNDILOGICAdd));
 305   fNumOfErr[kWrongDilogicErr]++;
 306   //dilogic = iDILOGIC;
 307   return kFALSE;
 308 }
 309 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 310 Bool_t AliHMPIDRawStream::CheckPad(UInt_t pad)
 311 {
 312 //check pad number
 313   if (pad < kNPadAdd) return kTRUE;
 314
 315   fRawReader->AddMajorErrorLog(kWrongPadErr,Form("pad %d",pad));
 316   AliWarning(Form("Wrong pad index: %d, expected (0 -> %d)!",pad,kNPadAdd));
 317   fNumOfErr[kWrongPadErr]++;
 318   return kFALSE;
 319 }
 320 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 321 Bool_t AliHMPIDRawStream::CheckEoE(Int_t &nDil)
 322 {
 323   if (!((fWord >> kbit27) & 0x1)) {                                                //check 27th bit in EoE. It must be 1!
 324     fRawReader->AddMajorErrorLog(kEoEFlagErr);
 325     AliWarning(Form("Missing end-of-event flag! (%08X) at %i",fWord,fPosition));
 326     fNumOfErr[kEoEFlagErr]++;
 327     return kFALSE;
 328   }
 329   nDil = fWord & 0x7f;
 330   if(nDil < 0 || nDil > 48 ) {
 331     fRawReader->AddMajorErrorLog(kEoESizeErr,Form("EoE size=%d",nDil));
 332     AliWarning(Form("Wrong end-of-event word-count: %08X",fWord));
 333     fNumOfErr[kEoESizeErr]++;
 334     return kFALSE;
 335   }
 336 //  UInt_t da = (eOfEvent >> 18) & 0xf;
 337 //  if (cntData!=0 && da != dilogic) {
 338 //    fRawReader->AddMajorErrorLog(kEoEDILOGICErr,Form("eoe dil %d != %d",da,dilogic));
 339 //    AliWarning(Form("Wrong DILOGIC address found in end-of-event: %d, expected %d!",da,dilogic));
 340 //    fNumOfErr[kEoEDILOGICErr]++;
 341 //    return kFALSE;  AliQAChecker::Instance()->Run(AliQA::kHMPID, task, obj) ;
 342
 343 //  }
 344 //  UInt_t ca = (eOfEvent >> 22) & 0x1f;
 345 //  if (cntData!=0 &&  ca != row) {
 346 //    fRawReader->AddMajorErrorLog(kEoERowErr,Form("eoe row %d != %d",ca,row));
 347 //    AliWarning(Form("Wrong row index found in end-of-event: %d, expected %d!",ca,row));
 348 //    fNumOfErr[kEoERowErr]++;
 349 //    return kFALSE;
 350 //  }
 351   return kTRUE;
 352 }
 353 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 354 Bool_t AliHMPIDRawStream::CheckRowMarker()
 355 {
 356   UInt_t nMAXwordsInRow = 0x1EA;
 357   UInt_t statusControlRow = 0x32a8; // 0x36a8 for zero suppression
 358 //First check on row marker
 359   UInt_t rowControlWord = fWord >> kbit0 & 0xfbff;
 360
 361   if(rowControlWord != statusControlRow) {
 362     fRawReader->AddMajorErrorLog(kRowMarkerErr);
 363     AliWarning(Form("Wrong row marker %x expected 0x32a8!",rowControlWord));
 364     fNumOfErr[kRowMarkerErr]++;
 365     return kFALSE;
 366   }
 367 //Second check on row marker
 368    UInt_t wordsInRow = fWord >> kbit16 & 0x0fff;                // Number of words after the row marker
 369
 370   if (wordsInRow > nMAXwordsInRow) {
 371     fRawReader->AddMajorErrorLog(kRowMarkerSizeErr);
 372     AliWarning(Form(" FATAL: Number of words %x in a row exceeds the expected value: 0x1EA !",wordsInRow));
 373     fNumOfErr[kRowMarkerSizeErr]++;
 374     return kFALSE;
 375   }
 376
 377   return kTRUE;
 378 }
 379 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 380 UInt_t AliHMPIDRawStream::GetWord(Int_t n,EDirection dir)
 381 {
 382   // This method returns the n-th 32 bit word
 383   // inside the raw data payload.
 384   // The method is supposed to be endian (platform)
 385   // independent.
 386   if (!fData || fPosition < 0) AliFatal("Raw data payload buffer is not yet initialized !");
 387
 388   UInt_t word = 0;
 389
 390   if(dir==kBwd) n = -n;
 391   fPosition+=4*n-4;
 392
 393   StorePosition();
 394
 395   word |= fData[fPosition++];
 396   word |= fData[fPosition++] << 8;
 397   word |= fData[fPosition++] << 16;
 398   word |= fData[fPosition++] << 24;
 399
 400   return word;
 401 }
 402 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 403 void AliHMPIDRawStream::DumpData(Int_t nw)
 404 {
 405    for(Int_t i=0;i<nw;i+=4) {
 406      if(!(i%16)) printf(" \n %8i) ",i);
 407      printf("%02X%02X%02X%02X [ %06i ] ",fData[i+3],fData[i+2],fData[i+1],fData[i+0],fPos[i]);
 408    }
 409    Printf(" \n -----end of dump ----------- ");
 410 }
 411 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 412 void AliHMPIDRawStream::StorePosition()
 413 {
 414   if(fPos[fPosition]!=0) {
 415 //    Printf("Position already stored!!! Value %i at address %i",fPos[fPosition],fPosition);
 416     return;
 417   }
 418   iPos++;
 419   fPos[fPosition] = iPos;
 420 //  if(stDeb)Printf("%i - Actual position %i",iPos,fPosition);
 421 }