1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
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 **************************************************************************/
16 ///////////////////////////////////////////////////////////////////////////////
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.
22 ///////////////////////////////////////////////////////////////////////////////
24 #include "AliHMPIDRawStream.h"
25 #include "AliRawReader.h"
28 ClassImp(AliHMPIDRawStream)
30 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
31 AliHMPIDRawStream::AliHMPIDRawStream(AliRawReader* rawReader) :
40 fRawReader(rawReader),
53 fNumOfErr = new Int_t*[kNDDL]; // Store the numner of errors for a given error type and a given DD
54 for(Int_t i=0;i<kNDDL;i++) {
55 fNumOfErr[i] = new Int_t [kSumErr];
58 fnDDLInStream=new Int_t[kNDDL];
59 fnDDLOutStream=new Int_t[kNDDL];
60 for(Int_t iddl=0;iddl<kNDDL;iddl++) { fnDDLInStream[iddl]=-1;fnDDLOutStream[iddl]=-1;}
62 for(Int_t iddl=0;iddl<kNDDL;iddl++)
63 for(Int_t ierr=0; ierr < kSumErr; ierr++) fNumOfErr[iddl][ierr]=0; //reset errors
65 fRawReader->Select("HMPID");
70 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
71 AliHMPIDRawStream::AliHMPIDRawStream() :
93 fNumOfErr = new Int_t*[kNDDL]; // Store the numner of errors for a given error type and a given DD
94 for(Int_t i=0;i<kNDDL;i++) {
95 fNumOfErr[i] = new Int_t [kSumErr];
97 fnDDLInStream=new Int_t[kNDDL];
98 fnDDLOutStream=new Int_t[kNDDL];
99 for(Int_t iddl=0;iddl<kNDDL;iddl++) { fnDDLInStream[iddl]=-1;fnDDLOutStream[iddl]=-1;}
102 for(Int_t iddl=0;iddl<kNDDL;iddl++)
103 for(Int_t ierr=0; ierr < kSumErr; ierr++) fNumOfErr[iddl][ierr]=0; //reset errors
106 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
107 AliHMPIDRawStream::~AliHMPIDRawStream()
122 for(Int_t i=0;i<kSumErr;i++) delete [] fNumOfErr[i];
125 if(fnDDLInStream) { delete [] fnDDLInStream; fnDDLInStream = 0x0; }
127 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
128 void AliHMPIDRawStream::Reset()
130 // reset raw stream params
131 // Reinitalize the containers
137 if (fRawReader) fRawReader->Reset();
139 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
140 Bool_t AliHMPIDRawStream::Turbo()
143 Int_t row,dilogic;UInt_t pad;
144 Int_t cntGlob = fRawReader->GetDataSize()/4;
148 for(Int_t i=1;i<cntGlob;i++) {
150 if (((fWord >> kbit27) & 1)) continue;
151 UInt_t statusControlRow = 0x32a8;
152 UInt_t rowControlWord = fWord >> kbit0 & 0xfbff;
153 if(rowControlWord == statusControlRow) continue;
155 row = (fWord >> kbit22) & 0x1f;
156 dilogic = (fWord >> kbit18) & 0xf; //dilogic info in raw word is between bits: 18...21
158 pad = (fWord >> kbit12) & 0x3f; //pad info in raw word is between bits: 12...17
159 if(!CheckPad(pad)) continue;
160 Int_t charge = fWord & 0xfff;
161 if(GetPad(fDDLNumber,row,dilogic,pad)<0) continue;
162 fPad[fNPads] = GetPad(fDDLNumber,row,dilogic,pad);
163 fCharge[fNPads] = charge;
165 if(charge==0) fNumOfErr[fDDLNumber][kPedQZero]++;
167 //Printf("Size: %i DDL %i row %i dilogic %i pad %i fPos %i fNPads: %i Charge: %d Word %4.4x GoodW: %i",cntGlob,fDDLNumber,row,dilogic,pad,fPosition,fNPads,fCharge[fNPads-1],fWord,gw++);
170 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
171 Bool_t AliHMPIDRawStream::Next()
173 // read next DDL raw data from the HMPID raw data stream
174 // return kFALSE in case of error or no data left
175 AliDebug(1,"Start.");
177 if (!fRawReader->ReadNextData(fData)) return kFALSE;
178 } while (fRawReader->GetDataSize() == 0);
182 Event type is selected as in $ALICE_ROOT/RAW/event.h
183 #define START_OF_RUN ((eventTypeType) 1)
184 #define END_OF_RUN ((eventTypeType) 2)
185 #define START_OF_RUN_FILES ((eventTypeType) 3)
186 #define END_OF_RUN_FILES ((eventTypeType) 4)
187 #define START_OF_BURST ((eventTypeType) 5)
188 #define END_OF_BURST ((eventTypeType) 6)
189 #define PHYSICS_EVENT ((eventTypeType) 7) <<---------------
190 #define CALIBRATION_EVENT ((eventTypeType) 8)
191 #define EVENT_FORMAT_ERROR ((eventTypeType) 9)
192 #define START_OF_DATA ((eventTypeType)10)
193 #define END_OF_DATA ((eventTypeType)11)
194 #define SYSTEM_SOFTWARE_TRIGGER_EVENT ((eventTypeType)12)
195 #define DETECTOR_SOFTWARE_TRIGGER_EVENT ((eventTypeType)13)
196 #define EVENT_TYPE_MIN 1
197 #define EVENT_TYPE_MAX 13
203 if(fRawReader->GetType() == 7 || fRawReader->GetType() == 8 ) { //New: Select Physics events, Old: Raw data size is not 0 and not 47148 (pedestal)
204 fDDLNumber = fRawReader->GetDDLID();
205 fnDDLInStream[fDDLNumber]=1; fnDDLOutStream[fDDLNumber]=0;
207 fLDCNumber = fRawReader->GetLDCId();
208 fTimeStamp = fRawReader->GetTimestamp();
210 AliDebug(1,Form("DDL %i started to be decoded!",fDDLNumber));
211 rawDataSize=fRawReader->GetDataSize()/4;
212 DelVars(); //We have to delete the variables initialized in the InitVars before recall IntiVars!!!
213 InitVars(rawDataSize); //To read the charge and pads we cannot delete before the status return
215 if(fTurbo==kTRUE) status=Turbo();
216 else status = ReadHMPIDRawData();
218 if(status) AliDebug(1,Form("Event DDL %i successfully decoded!.",fDDLNumber));
219 else AliDebug(1,Form("Event DDL %i ERROR in decoding!.",fDDLNumber));
220 // DumpData(fRawReader->GetDataSize());
224 if(status==kTRUE) {fnDDLOutStream[fDDLNumber]++; }//Printf("fnDDLOutStream[%d]=%d",fDDLNumber,fnDDLOutStream[fDDLNumber]); } //Count the number of events when the DDL was succesfully decoded
226 // return status; // temporary solution...
229 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
230 void AliHMPIDRawStream::InitVars(Int_t n)
236 fCharge = new Int_t[n];
239 fPos = new Int_t[4*n+4]; //reset debug
242 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
243 void AliHMPIDRawStream::DelVars()
248 //Clean the initvars!!!!!!!!
250 if (fCharge) { delete [] fCharge; fCharge = 0x0; }
251 if (fPad) { delete [] fPad; fPad = 0x0; }
252 if (fPos) { delete [] fPos; fPos = 0x0; }
258 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
259 Bool_t AliHMPIDRawStream::ReadHMPIDRawData()
261 //Here the loop on the decoding the raw bank
262 //for one ddl starts.
263 //It returns: kFALSE if any error occurs
265 Int_t cntGlob = fRawReader->GetDataSize()/4;
266 if(cntGlob==0) {fNumOfErr[fDDLNumber][kRawDataSizeErr]++; return kFALSE; }
272 if(!GetWord(cnt)) return kFALSE;
278 nwSeg = (fWord >> kbit8) & 0xfff;
279 if(!CheckSegment()) return kFALSE;
280 if(!ReadSegment(cntSegment)) return kFALSE;
282 if(nwSeg != cntSegment) {AliDebug(1,Form("Error in Segment counters: %i different wrt %i",nwSeg,cntSegment)); return kFALSE;}
283 if(!GetWord(cntSegment+1,kBwd)) return kFALSE;
290 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
291 Bool_t AliHMPIDRawStream::ReadSegment(Int_t &cntSegment)
294 //It returns: kFALSE if any error occurs
296 cntSegment = (fWord >> kbit8) & 0xfff;
297 Int_t cnt = cntSegment;
301 if(!GetWord(cnt,kBwd)) return kFALSE;
305 cntRow = (fWord >> kbit16) & 0xfff;
306 if(!CheckRowMarker()) return kFALSE;
307 if(!ReadRow(nwRow)) return kFALSE;
309 if(nwRow != cntRow) {AliDebug(1,Form("Error in Row counters: %i different wrt %i",nwRow,cntRow)); return kFALSE;}
310 if(!GetWord(cntRow+1)) return kFALSE;
320 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
321 Bool_t AliHMPIDRawStream::ReadRow(Int_t &cntRow)
324 //It returns: kFALSE if any error occurs
331 cntRow = (fWord >> kbit16) & 0xfff;
334 if(!GetWord(cntRow)) return kFALSE;
338 if(!CheckEoE(nwDil)) return kFALSE;
339 if(!ReadDilogic(cntDilogic)) return kFALSE;
341 if(nwDil != cntDilogic) {AliDebug(1,Form("Error in Dilogic counters: %i different wrt %i",nwDil,cntDilogic));return kFALSE;}
343 if(!GetWord(1,kBwd)) return kFALSE; // go to next Dilogic bank...
345 // Printf(" cnt %i cntDilogic %i ",cnt,cntDilogic);
353 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
354 Bool_t AliHMPIDRawStream::ReadDilogic(Int_t &cntDilogic)
356 // Read the dilogic bank
357 //It returns: kFALSE if any error occurs
360 cntDilogic = fWord & 0x7f;
362 Int_t cnt = cntDilogic;
364 // Printf(" cnt DILOGIC %i at %i word %08X",cnt,fPosition,fWord);
366 for(Int_t iDil=0;iDil<cntDilogic;iDil++) {
367 UInt_t dilogic = 0, row = 0;
368 if(!GetWord(1,kBwd)) return kFALSE;
369 //check on row number
371 row = (fWord >> kbit22) & 0x1f;
372 if(!CheckRow(row)) continue;
373 //check dilogic number
374 dilogic = (fWord >> kbit18) & 0xf; //dilogic info in raw word is between bits: 18...21
375 if(!CheckDilogic(dilogic)) continue;
377 UInt_t pad = (fWord >> kbit12) & 0x3f; //pad info in raw word is between bits: 12...17
378 if(!CheckPad(pad)) continue;
379 Int_t charge = fWord & 0xfff;
380 fPad[fNPads] = GetPad(fDDLNumber,row,dilogic,pad);
381 fCharge[fNPads] = charge;
386 AliDebug(1,Form("If PEDESTAL run -> WARNING: ZERO charge is read from DDL: %d row: %d dil: %d pad: %d",fDDLNumber,row,dilogic,pad));
387 fNumOfErr[fDDLNumber][kPedQZero]++;
395 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
396 Bool_t AliHMPIDRawStream::CheckSegment()
398 // Check the segment marker
399 //It returns: kFALSE if any error occurs
402 UInt_t markSegment = 0xAB0;
405 UInt_t segWord = GetWord();
406 if ((segWord >> 20) != statusSegWord) {
407 fRawReader->AddMajorErrorLog(kBadSegWordErr);
408 AliDebug(1,Form("Wrong segment word signature: %x, expected 0xab0!",(segWord >> 20)));
409 fNumOfErr[kBadSegWordErr]++;
413 UInt_t segMarker = (fWord >> kbit20) & 0xfff;
414 if (segMarker != markSegment ) {
415 //fRawReader->AddMajorErrorLog(kWrongSegErr,Form("Segment marker %0X wrong (expected %0X) at %i in word %0X!",segMarker,markSegment,fPosition,fWord));
416 AliDebug(1,Form("Segment marker %X wrong (expected %0X)! at %i in word %0X!",segMarker,markSegment,fPosition,fWord));
417 fNumOfErr[fDDLNumber][kWrongSegErr]++;
421 UInt_t segAddress = fWord & 0xff;
422 if (segAddress<1 ||segAddress>3) {
423 //fRawReader->AddMajorErrorLog(kWrongSegErr,Form("Segment address %d not in the valid range [1-3] at %i in word %0X",segAddress,fPosition,fWord));
424 AliDebug(1,Form("Segment address %d not in the valid range [1-3]",segAddress));
425 fNumOfErr[fDDLNumber][kWrongSegErr]++;
428 // Printf("Segment Marker found at %i! Number of segment is %i",fPosition,segAddress);
431 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
432 Bool_t AliHMPIDRawStream::CheckRow(UInt_t row)
434 //check on row number
435 //It returns: kFALSE if any error occurs
437 // Printf("ROW %i word %0X",row,fWord);
438 if(row>=1 && row <=kNRows) return kTRUE;
440 //fRawReader->AddMajorErrorLog(kWrongRowErr,Form("row %d",row));
441 AliDebug(1,Form("Wrong row index: %d, expected (1 -> %d) word %0X at %i...",row,kNRows,fWord,fPosition));
442 fNumOfErr[fDDLNumber][kWrongRowErr]++;
445 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
446 Bool_t AliHMPIDRawStream::CheckDilogic(UInt_t dilogic)
448 //check dilogic number
449 //It returns: kFALSE if any error occurs
451 if (dilogic>= 1 && dilogic <=kNDILOGICAdd) return kTRUE;
453 //fRawReader->AddMajorErrorLog(kWrongDilogicErr,Form("dil %d",dilogic));
454 AliDebug(1,Form("Wrong DILOGIC index: %d, expected (1 -> %d)!",dilogic,kNDILOGICAdd));
455 fNumOfErr[fDDLNumber][kWrongDilogicErr]++;
456 //dilogic = iDILOGIC;
459 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
460 Bool_t AliHMPIDRawStream::CheckPad(UInt_t pad)
463 //It returns: kFALSE if any error occurs
465 if (pad < kNPadAdd) return kTRUE;
467 //fRawReader->AddMajorErrorLog(kWrongPadErr,Form("pad %d",pad));
468 AliDebug(1,Form("Wrong pad index: %d, expected (0 -> %d)!",pad,kNPadAdd));
469 fNumOfErr[fDDLNumber][kWrongPadErr]++;
472 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
473 Bool_t AliHMPIDRawStream::CheckEoE(Int_t &nDil)
475 //check the End of Event
476 //It returns: kFALSE if any error occurs
478 if (!((fWord >> kbit27) & 0x1)) { //check 27th bit in EoE. It must be 1!
479 //fRawReader->AddMajorErrorLog(kEoEFlagErr);
480 AliDebug(1,Form("Missing end-of-event flag! (%08X) at %i",fWord,fPosition));
481 fNumOfErr[fDDLNumber][kEoEFlagErr]++;
484 nDil = fWord & 0x7f; //nDil=EoE word count
485 if(nDil < 0 || nDil > 48 ) {
487 //fRawReader->AddMajorErrorLog(kEoESizeErr,Form("EoE size=%d",nDil));
488 AliDebug(1,Form("Wrong end-of-event word-count: %08X",fWord));
489 fNumOfErr[fDDLNumber][kEoESizeErr]++;
492 // UInt_t da = (eOfEvent >> 18) & 0xf;
493 // if (cntData!=0 && da != dilogic) {
494 // fRawReader->AddMajorErrorLog(kEoEDILOGICErr,Form("eoe dil %d != %d",da,dilogic));
495 // AliDebug(1,Form("Wrong DILOGIC address found in end-of-event: %d, expected %d!",da,dilogic));
496 // fNumOfErr[kEoEDILOGICErr]++;
497 // return kFALSE; AliQAChecker::Instance()->Run(AliQA::kHMPID, task, obj) ;
500 // UInt_t ca = (eOfEvent >> 22) & 0x1f;
501 // if (cntData!=0 && ca != row) {
502 // fRawReader->AddMajorErrorLog(kEoERowErr,Form("eoe row %d != %d",ca,row));
503 // AliDebug(1,Form("Wrong row index found in end-of-event: %d, expected %d!",ca,row));
504 // fNumOfErr[kEoERowErr]++;
509 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
510 Bool_t AliHMPIDRawStream::CheckRowMarker()
512 //check the row marker
513 //It returns: kFALSE if any error occurs
515 UInt_t nMAXwordsInRow = 0x1EA;
516 UInt_t statusControlRow = 0x32a8; // 0x36a8 for zero suppression
517 //First check on row marker
518 UInt_t rowControlWord = fWord >> kbit0 & 0xfbff;
520 if(rowControlWord != statusControlRow) {
521 //fRawReader->AddMajorErrorLog(kRowMarkerErr);
522 AliDebug(1,Form("Wrong row marker %x expected 0x32a8!",rowControlWord));
523 fNumOfErr[fDDLNumber][kRowMarkerErr]++;
526 //Second check on row marker
527 UInt_t wordsInRow = fWord >> kbit16 & 0x0fff; // Number of words after the row marker, bit 10 is skipped in this check
529 if (wordsInRow > nMAXwordsInRow) {
530 //fRawReader->AddMajorErrorLog(kRowMarkerSizeErr);
531 AliDebug(1,Form(" FATAL: Number of words %x in a row exceeds the expected value: 0x1EA !",wordsInRow));
532 fNumOfErr[fDDLNumber][kRowMarkerSizeErr]++;
538 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
539 Bool_t AliHMPIDRawStream::GetWord(Int_t n,EDirection dir)
541 // This method returns the n-th 32 bit word
542 // inside the raw data payload.
543 // The method is supposed to be endian (platform)
547 if (!fData || fPosition < 0) AliFatal("Raw data payload buffer is not yet initialized !");
549 if(dir==kBwd) n = -n;
552 if(fPosition==-4) return kTRUE;
554 if(fPosition<0 || fPosition > fRawReader->GetDataSize()) {
555 AliDebug(1,Form("fPosition out of boundaries %i",fPosition));
561 fWord |= fData[fPosition++];
562 fWord |= fData[fPosition++] << 8;
563 fWord |= fData[fPosition++] << 16;
564 fWord |= fData[fPosition++] << 24;
568 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
569 void AliHMPIDRawStream::DumpData(Int_t nw)
571 //just a simple raw data dump
572 // in () is the position in bytes
574 for(Int_t i=0;i<nw;i+=4) {
575 if(!(i%16)) printf(" \n %8i) ",i);
576 printf("%02X%02X%02X%02X [ %06i ] ",fData[i+3],fData[i+2],fData[i+1],fData[i+0],fPos[i]);
578 Printf(" \n -----end of dump ----------- ");
580 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
581 void AliHMPIDRawStream::StorePosition()
583 //just for debug purpose
584 // it stores the position
585 //read for the first time
586 // Printf("@@@@@@@@@ fPos: %x fPosition: %d",fPos,fPosition);
587 if(fPos[fPosition]!=0) {
588 // Printf("Position already stored!!! Value %i at address %i",fPos[fPosition],fPosition);
592 fPos[fPosition] = fiPos;
593 // if(stDeb)Printf("%i - Actual position %i",iPos,fPosition);
595 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++