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),
54 fNumOfErr = new Int_t*[kNDDL]; // Store the numner of errors for a given error type and a given DD
55 for(Int_t i=0;i<kNDDL;i++) {
56 fNumOfErr[i] = new Int_t [kSumErr];
59 fnDDLInStream=new Int_t[kNDDL];
60 fnDDLOutStream=new Int_t[kNDDL];
61 for(Int_t iddl=0;iddl<kNDDL;iddl++) { fnDDLInStream[iddl]=-1;fnDDLOutStream[iddl]=-1;}
63 for(Int_t iddl=0;iddl<kNDDL;iddl++)
64 for(Int_t ierr=0; ierr < kSumErr; ierr++) fNumOfErr[iddl][ierr]=0; //reset errors
66 fRawReader->Select("HMPID");
71 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
72 AliHMPIDRawStream::AliHMPIDRawStream() :
95 fNumOfErr = new Int_t*[kNDDL]; // Store the numner of errors for a given error type and a given DD
96 for(Int_t i=0;i<kNDDL;i++) {
97 fNumOfErr[i] = new Int_t [kSumErr];
99 fnDDLInStream=new Int_t[kNDDL];
100 fnDDLOutStream=new Int_t[kNDDL];
101 for(Int_t iddl=0;iddl<kNDDL;iddl++) { fnDDLInStream[iddl]=-1;fnDDLOutStream[iddl]=-1;}
104 for(Int_t iddl=0;iddl<kNDDL;iddl++)
105 for(Int_t ierr=0; ierr < kSumErr; ierr++) fNumOfErr[iddl][ierr]=0; //reset errors
108 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
109 AliHMPIDRawStream::~AliHMPIDRawStream()
125 for(Int_t i=0;i<kNDDL;i++) delete [] fNumOfErr[i];
128 delete [] fnDDLInStream;
129 delete [] fnDDLOutStream;
131 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
132 void AliHMPIDRawStream::Reset()
134 // reset raw stream params
135 // Reinitalize the containers
141 if (fRawReader) fRawReader->Reset();
143 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
144 Bool_t AliHMPIDRawStream::Turbo()
147 Int_t row,dilogic;UInt_t pad;
148 Int_t cntGlob = fRawReader->GetDataSize()/4;
152 for(Int_t i=1;i<cntGlob;i++) {
153 if(!GetWord(1)) return kFALSE;
154 if (((fWord >> kbit27) & 1)) continue;
155 UInt_t statusControlRow = 0x32a8;
156 UInt_t rowControlWord = fWord >> kbit0 & 0xfbff;
157 if(rowControlWord == statusControlRow) continue;
159 row = (fWord >> kbit22) & 0x1f;
160 dilogic = (fWord >> kbit18) & 0xf; //dilogic info in raw word is between bits: 18...21
162 pad = (fWord >> kbit12) & 0x3f; //pad info in raw word is between bits: 12...17
163 if(!CheckPad(pad)) continue;
164 Int_t charge = fWord & 0xfff;
165 if(GetPad(fDDLNumber,row,dilogic,pad)<0) continue;
166 fPad[fNPads] = GetPad(fDDLNumber,row,dilogic,pad);
167 fCharge[fNPads] = charge;
169 if(charge==0) fNumOfErr[fDDLNumber][kPedQZero]++;
171 //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++);
174 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
175 Bool_t AliHMPIDRawStream::Next()
177 // read next DDL raw data from the HMPID raw data stream
178 // return kFALSE in case of error or no data left
179 AliDebug(1,"Start.");
181 if (!fRawReader->ReadNextData(fData)) return kFALSE;
182 } while (fRawReader->GetDataSize() == 0);
186 Event type is selected as in $ALICE_ROOT/RAW/event.h
187 #define START_OF_RUN ((eventTypeType) 1)
188 #define END_OF_RUN ((eventTypeType) 2)
189 #define START_OF_RUN_FILES ((eventTypeType) 3)
190 #define END_OF_RUN_FILES ((eventTypeType) 4)
191 #define START_OF_BURST ((eventTypeType) 5)
192 #define END_OF_BURST ((eventTypeType) 6)
193 #define PHYSICS_EVENT ((eventTypeType) 7) <<---------------
194 #define CALIBRATION_EVENT ((eventTypeType) 8)
195 #define EVENT_FORMAT_ERROR ((eventTypeType) 9)
196 #define START_OF_DATA ((eventTypeType)10)
197 #define END_OF_DATA ((eventTypeType)11)
198 #define SYSTEM_SOFTWARE_TRIGGER_EVENT ((eventTypeType)12)
199 #define DETECTOR_SOFTWARE_TRIGGER_EVENT ((eventTypeType)13)
200 #define EVENT_TYPE_MIN 1
201 #define EVENT_TYPE_MAX 13
205 Bool_t status=kFALSE;
207 fDDLNumber = fRawReader->GetDDLID();
208 if(fRawReader->GetType() == 7 || fRawReader->GetType() == 8 ) { //New: Select Physics events, Old: Raw data size is not 0 and not 47148 (pedestal)
209 fnDDLInStream[fDDLNumber]=1; fnDDLOutStream[fDDLNumber]=0;
211 fLDCNumber = fRawReader->GetLDCId();
212 fTimeStamp = fRawReader->GetTimestamp();
214 AliDebug(1,Form("DDL %i started to be decoded!",fDDLNumber));
215 fRawDataSize=fRawReader->GetDataSize()/4;
216 DelVars(); //We have to delete the variables initialized in the InitVars before recall IntiVars!!!
217 InitVars(fRawDataSize); //To read the charge and pads we cannot delete before the status return
219 if(fTurbo==kTRUE) status=Turbo();
220 else status = ReadHMPIDRawData();
222 if(status) AliDebug(1,Form("Event DDL %i successfully decoded!.",fDDLNumber));
223 else AliDebug(1,Form("Event DDL %i ERROR in decoding!.",fDDLNumber));
224 // DumpData(fRawReader->GetDataSize());
228 if(status==kTRUE) {fnDDLOutStream[fDDLNumber]++; }//Printf("fnDDLOutStream[%d]=%d",fDDLNumber,fnDDLOutStream[fDDLNumber]); } //Count the number of events when the DDL was succesfully decoded
230 // return status; // temporary solution...
233 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
234 void AliHMPIDRawStream::InitVars(Int_t n)
240 fCharge = new Int_t[n];
243 fPos = new Int_t[4*n+4]; //reset debug
246 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
247 void AliHMPIDRawStream::DelVars()
252 //Clean the initvars!!!!!!!!
254 if (fCharge) { delete [] fCharge; fCharge = 0x0; }
255 if (fPad) { delete [] fPad; fPad = 0x0; }
256 if (fPos) { delete [] fPos; fPos = 0x0; }
262 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
263 Bool_t AliHMPIDRawStream::ReadHMPIDRawData()
265 //Here the loop on the decoding the raw bank
266 //for one ddl starts.
267 //It returns: kFALSE if any error occurs
269 Int_t cntGlob = fRawReader->GetDataSize()/4;
270 if(cntGlob==0) {fNumOfErr[fDDLNumber][kRawDataSizeErr]++; return kFALSE; }
276 if(!GetWord(cnt)) return kFALSE;
282 nwSeg = (fWord >> kbit8) & 0xfff;
283 if(!CheckSegment()) return kFALSE;
284 if(!ReadSegment(cntSegment)) return kFALSE;
286 if(nwSeg != cntSegment) {AliDebug(1,Form("Error in Segment counters: %i different wrt %i",nwSeg,cntSegment)); return kFALSE;}
287 if(!GetWord(cntSegment+1,kBwd)) return kFALSE;
294 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
295 Bool_t AliHMPIDRawStream::ReadSegment(Int_t &cntSegment)
298 //It returns: kFALSE if any error occurs
300 cntSegment = (fWord >> kbit8) & 0xfff;
301 Int_t cnt = cntSegment;
305 if(!GetWord(cnt,kBwd)) return kFALSE;
309 cntRow = (fWord >> kbit16) & 0xfff;
310 if(!CheckRowMarker()) return kFALSE;
311 if(!ReadRow(nwRow)) return kFALSE;
313 if(nwRow != cntRow) {AliDebug(1,Form("Error in Row counters: %i different wrt %i",nwRow,cntRow)); return kFALSE;}
314 if(!GetWord(cntRow+1)) return kFALSE;
324 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
325 Bool_t AliHMPIDRawStream::ReadRow(Int_t &cntRow)
328 //It returns: kFALSE if any error occurs
335 cntRow = (fWord >> kbit16) & 0xfff;
338 if(!GetWord(cntRow)) return kFALSE;
342 if(!CheckEoE(nwDil)) return kFALSE;
343 if(!ReadDilogic(cntDilogic)) return kFALSE;
345 if(nwDil != cntDilogic) {AliDebug(1,Form("Error in Dilogic counters: %i different wrt %i",nwDil,cntDilogic));return kFALSE;}
347 if(!GetWord(1,kBwd)) return kFALSE; // go to next Dilogic bank...
349 // Printf(" cnt %i cntDilogic %i ",cnt,cntDilogic);
357 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
358 Bool_t AliHMPIDRawStream::ReadDilogic(Int_t &cntDilogic)
360 // Read the dilogic bank
361 //It returns: kFALSE if any error occurs
364 cntDilogic = fWord & 0x7f;
366 Int_t cnt = cntDilogic;
368 // Printf(" cnt DILOGIC %i at %i word %08X",cnt,fPosition,fWord);
370 for(Int_t iDil=0;iDil<cntDilogic;iDil++) {
371 UInt_t dilogic = 0, row = 0;
372 if(!GetWord(1,kBwd)) return kFALSE;
373 //check on row number
375 row = (fWord >> kbit22) & 0x1f;
376 if(!CheckRow(row)) continue;
377 //check dilogic number
378 dilogic = (fWord >> kbit18) & 0xf; //dilogic info in raw word is between bits: 18...21
379 if(!CheckDilogic(dilogic)) continue;
381 UInt_t pad = (fWord >> kbit12) & 0x3f; //pad info in raw word is between bits: 12...17
382 if(!CheckPad(pad)) continue;
383 Int_t charge = fWord & 0xfff;
384 if(GetPad(fDDLNumber,row,dilogic,pad)<0) continue;
385 fPad[fNPads] = GetPad(fDDLNumber,row,dilogic,pad);
386 fCharge[fNPads] = charge;
391 AliDebug(1,Form("If PEDESTAL run -> WARNING: ZERO charge is read from DDL: %d row: %d dil: %d pad: %d",fDDLNumber,row,dilogic,pad));
392 fNumOfErr[fDDLNumber][kPedQZero]++;
400 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
401 Bool_t AliHMPIDRawStream::CheckSegment()
403 // Check the segment marker
404 //It returns: kFALSE if any error occurs
407 UInt_t markSegment = 0xAB0;
410 UInt_t segWord = GetWord();
411 if ((segWord >> 20) != statusSegWord) {
412 fRawReader->AddMajorErrorLog(kBadSegWordErr);
413 AliDebug(1,Form("Wrong segment word signature: %x, expected 0xab0!",(segWord >> 20)));
414 fNumOfErr[kBadSegWordErr]++;
418 UInt_t segMarker = (fWord >> kbit20) & 0xfff;
419 if (segMarker != markSegment ) {
420 //fRawReader->AddMajorErrorLog(kWrongSegErr,Form("Segment marker %0X wrong (expected %0X) at %i in word %0X!",segMarker,markSegment,fPosition,fWord));
421 AliDebug(1,Form("Segment marker %X wrong (expected %0X)! at %i in word %0X!",segMarker,markSegment,fPosition,fWord));
422 fNumOfErr[fDDLNumber][kWrongSegErr]++;
426 UInt_t segAddress = fWord & 0xff;
427 if (segAddress<1 ||segAddress>3) {
428 //fRawReader->AddMajorErrorLog(kWrongSegErr,Form("Segment address %d not in the valid range [1-3] at %i in word %0X",segAddress,fPosition,fWord));
429 AliDebug(1,Form("Segment address %d not in the valid range [1-3]",segAddress));
430 fNumOfErr[fDDLNumber][kWrongSegErr]++;
433 // Printf("Segment Marker found at %i! Number of segment is %i",fPosition,segAddress);
436 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
437 Bool_t AliHMPIDRawStream::CheckRow(UInt_t row)
439 //check on row number
440 //It returns: kFALSE if any error occurs
442 // Printf("ROW %i word %0X",row,fWord);
443 if(row>=1 && row <=kNRows) return kTRUE;
445 //fRawReader->AddMajorErrorLog(kWrongRowErr,Form("row %d",row));
446 AliDebug(1,Form("Wrong row index: %d, expected (1 -> %d) word %0X at %i...",row,kNRows,fWord,fPosition));
447 fNumOfErr[fDDLNumber][kWrongRowErr]++;
450 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
451 Bool_t AliHMPIDRawStream::CheckDilogic(UInt_t dilogic)
453 //check dilogic number
454 //It returns: kFALSE if any error occurs
456 if (dilogic>= 1 && dilogic <=kNDILOGICAdd) return kTRUE;
458 //fRawReader->AddMajorErrorLog(kWrongDilogicErr,Form("dil %d",dilogic));
459 AliDebug(1,Form("Wrong DILOGIC index: %d, expected (1 -> %d)!",dilogic,kNDILOGICAdd));
460 fNumOfErr[fDDLNumber][kWrongDilogicErr]++;
461 //dilogic = iDILOGIC;
464 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
465 Bool_t AliHMPIDRawStream::CheckPad(UInt_t pad)
468 //It returns: kFALSE if any error occurs
470 if (pad < kNPadAdd) return kTRUE;
472 //fRawReader->AddMajorErrorLog(kWrongPadErr,Form("pad %d",pad));
473 AliDebug(1,Form("Wrong pad index: %d, expected (0 -> %d)!",pad,kNPadAdd));
474 fNumOfErr[fDDLNumber][kWrongPadErr]++;
477 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
478 Bool_t AliHMPIDRawStream::CheckEoE(Int_t &nDil)
480 //check the End of Event
481 //It returns: kFALSE if any error occurs
483 if (!((fWord >> kbit27) & 0x1)) { //check 27th bit in EoE. It must be 1!
484 //fRawReader->AddMajorErrorLog(kEoEFlagErr);
485 AliDebug(1,Form("Missing end-of-event flag! (%08X) at %i",fWord,fPosition));
486 fNumOfErr[fDDLNumber][kEoEFlagErr]++;
489 nDil = fWord & 0x7f; //nDil=EoE word count
490 if(nDil < 0 || nDil > 48 ) {
492 //fRawReader->AddMajorErrorLog(kEoESizeErr,Form("EoE size=%d",nDil));
493 AliDebug(1,Form("Wrong end-of-event word-count: %08X",fWord));
494 fNumOfErr[fDDLNumber][kEoESizeErr]++;
497 // UInt_t da = (eOfEvent >> 18) & 0xf;
498 // if (cntData!=0 && da != dilogic) {
499 // fRawReader->AddMajorErrorLog(kEoEDILOGICErr,Form("eoe dil %d != %d",da,dilogic));
500 // AliDebug(1,Form("Wrong DILOGIC address found in end-of-event: %d, expected %d!",da,dilogic));
501 // fNumOfErr[kEoEDILOGICErr]++;
502 // return kFALSE; AliQAChecker::Instance()->Run(AliQAv1::kHMPID, task, obj) ;
505 // UInt_t ca = (eOfEvent >> 22) & 0x1f;
506 // if (cntData!=0 && ca != row) {
507 // fRawReader->AddMajorErrorLog(kEoERowErr,Form("eoe row %d != %d",ca,row));
508 // AliDebug(1,Form("Wrong row index found in end-of-event: %d, expected %d!",ca,row));
509 // fNumOfErr[kEoERowErr]++;
514 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
515 Bool_t AliHMPIDRawStream::CheckRowMarker()
517 //check the row marker
518 //It returns: kFALSE if any error occurs
520 UInt_t nMAXwordsInRow = 0x1EA;
521 UInt_t statusControlRow = 0x32a8; // 0x36a8 for zero suppression
522 //First check on row marker
523 UInt_t rowControlWord = fWord >> kbit0 & 0xfbff;
525 if(rowControlWord != statusControlRow) {
526 //fRawReader->AddMajorErrorLog(kRowMarkerErr);
527 AliDebug(1,Form("Wrong row marker %x expected 0x32a8!",rowControlWord));
528 fNumOfErr[fDDLNumber][kRowMarkerErr]++;
531 //Second check on row marker
532 UInt_t wordsInRow = fWord >> kbit16 & 0x0fff; // Number of words after the row marker, bit 10 is skipped in this check
534 if (wordsInRow > nMAXwordsInRow) {
535 //fRawReader->AddMajorErrorLog(kRowMarkerSizeErr);
536 AliDebug(1,Form(" FATAL: Number of words %x in a row exceeds the expected value: 0x1EA !",wordsInRow));
537 fNumOfErr[fDDLNumber][kRowMarkerSizeErr]++;
543 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
544 Bool_t AliHMPIDRawStream::GetWord(Int_t n,EDirection dir)
546 // This method returns the n-th 32 bit word
547 // inside the raw data payload.
548 // The method is supposed to be endian (platform)
553 AliError("fPosition < 0 !!! Event skipped.");
554 fRawReader->AddMajorErrorLog(kRawDataSizeErr,"fPosition<0");
558 if(dir==kBwd) n = -n;
561 if(fPosition==-4) return kTRUE;
563 if(fPosition<0 || fPosition > fRawReader->GetDataSize()) {
564 AliWarning(Form("fPosition out of boundaries %i",fPosition));
570 fWord |= fData[fPosition++];
571 fWord |= fData[fPosition++] << 8;
572 fWord |= fData[fPosition++] << 16;
573 fWord |= fData[fPosition++] << 24;
577 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
578 void AliHMPIDRawStream::DumpData(Int_t nw)
580 //just a simple raw data dump
581 // in () is the position in bytes
583 for(Int_t i=0;i<nw;i+=4) {
584 if(!(i%16)) printf(" \n %8i) ",i);
585 printf("%02X%02X%02X%02X [ %06i ] ",fData[i+3],fData[i+2],fData[i+1],fData[i+0],fPos[i]);
587 Printf(" \n -----end of dump ----------- ");
589 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
590 void AliHMPIDRawStream::StorePosition()
592 //just for debug purpose
593 // it stores the position
594 //read for the first time
595 // Printf("@@@@@@@@@ fPos: %x fPosition: %d",fPos,fPosition);
596 if(fPos[fPosition]!=0) {
597 // Printf("Position already stored!!! Value %i at address %i",fPos[fPosition],fPosition);
601 fPos[fPosition] = fiPos;
602 // if(stDeb)Printf("%i - Actual position %i",iPos,fPosition);
604 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++