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
109 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
110 AliHMPIDRawStream::~AliHMPIDRawStream()
126 for(Int_t i=0;i<kNDDL;i++) delete [] fNumOfErr[i];
129 delete [] fnDDLInStream;
130 delete [] fnDDLOutStream;
132 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
133 void AliHMPIDRawStream::Reset()
135 // reset raw stream params
136 // Reinitalize the containers
142 if (fRawReader) fRawReader->Reset();
144 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
145 Bool_t AliHMPIDRawStream::Turbo()
148 Int_t row,dilogic;UInt_t pad;
149 Int_t cntGlob = fRawReader->GetDataSize()/4;
153 for(Int_t i=1;i<cntGlob;i++) {
154 if(!GetWord(1)) return kFALSE;
155 if (((fWord >> kbit27) & 1)) continue;
156 UInt_t statusControlRow = 0x32a8;
157 UInt_t rowControlWord = fWord >> kbit0 & 0xfbff;
158 if(rowControlWord == statusControlRow) continue;
160 row = (fWord >> kbit22) & 0x1f;
161 dilogic = (fWord >> kbit18) & 0xf; //dilogic info in raw word is between bits: 18...21
163 pad = (fWord >> kbit12) & 0x3f; //pad info in raw word is between bits: 12...17
164 if(!CheckPad(pad)) continue;
165 Int_t charge = fWord & 0xfff;
166 if(GetPad(fDDLNumber,row,dilogic,pad)<0) continue;
167 fPad[fNPads] = GetPad(fDDLNumber,row,dilogic,pad);
168 fCharge[fNPads] = charge;
170 if(charge==0) fNumOfErr[fDDLNumber][kPedQZero]++;
172 //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++);
175 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
176 Bool_t AliHMPIDRawStream::Next()
178 // read next DDL raw data from the HMPID raw data stream
179 // return kFALSE in case of error or no data left
180 AliDebug(1,"Start.");
182 if (!fRawReader->ReadNextData(fData)) return kFALSE;
183 } while (fRawReader->GetDataSize() == 0);
187 Event type is selected as in $ALICE_ROOT/RAW/event.h
188 #define START_OF_RUN ((eventTypeType) 1)
189 #define END_OF_RUN ((eventTypeType) 2)
190 #define START_OF_RUN_FILES ((eventTypeType) 3)
191 #define END_OF_RUN_FILES ((eventTypeType) 4)
192 #define START_OF_BURST ((eventTypeType) 5)
193 #define END_OF_BURST ((eventTypeType) 6)
194 #define PHYSICS_EVENT ((eventTypeType) 7) <<---------------
195 #define CALIBRATION_EVENT ((eventTypeType) 8)
196 #define EVENT_FORMAT_ERROR ((eventTypeType) 9)
197 #define START_OF_DATA ((eventTypeType)10)
198 #define END_OF_DATA ((eventTypeType)11)
199 #define SYSTEM_SOFTWARE_TRIGGER_EVENT ((eventTypeType)12)
200 #define DETECTOR_SOFTWARE_TRIGGER_EVENT ((eventTypeType)13)
201 #define EVENT_TYPE_MIN 1
202 #define EVENT_TYPE_MAX 13
206 Bool_t status=kFALSE;
208 fDDLNumber = fRawReader->GetDDLID();
211 AliWarning(Form("fDDLNumber not a acceptable value %i",fDDLNumber));
215 if(fRawReader->GetType() == 7 || fRawReader->GetType() == 8 ) { //New: Select Physics events, Old: Raw data size is not 0 and not 47148 (pedestal)
216 fnDDLInStream[fDDLNumber]=1; fnDDLOutStream[fDDLNumber]=0;
218 fLDCNumber = fRawReader->GetLDCId();
219 fTimeStamp = fRawReader->GetTimestamp();
221 AliDebug(1,Form("DDL %i started to be decoded!",fDDLNumber));
222 fRawDataSize=fRawReader->GetDataSize()/4;
223 DelVars(); //We have to delete the variables initialized in the InitVars before recall IntiVars!!!
224 InitVars(fRawDataSize); //To read the charge and pads we cannot delete before the status return
226 if(fTurbo==kTRUE) status=Turbo();
227 else status = ReadHMPIDRawData();
229 if(status) AliDebug(1,Form("Event DDL %i successfully decoded!.",fDDLNumber));
230 else AliDebug(1,Form("Event DDL %i ERROR in decoding!.",fDDLNumber));
231 //DumpData(fRawReader->GetDataSize());
235 if(status==kTRUE) {fnDDLOutStream[fDDLNumber]++; }//Printf("fnDDLOutStream[%d]=%d",fDDLNumber,fnDDLOutStream[fDDLNumber]); } //Count the number of events when the DDL was succesfully decoded
237 // return status; // temporary solution...
240 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
241 void AliHMPIDRawStream::InitVars(Int_t n)
247 fCharge = new Int_t[n];
250 fPos = new Int_t[4*n+4]; //reset debug
251 for(Int_t ie = 0 ; ie < 4*n+4; ie++) fPos[ie] = 0; //initialize for 0, otherwise the position is considered filled and will not be updated for the dump
254 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
255 void AliHMPIDRawStream::DelVars()
260 //Clean the initvars!!!!!!!!
262 if (fCharge) { delete [] fCharge; fCharge = 0x0; }
263 if (fPad) { delete [] fPad; fPad = 0x0; }
264 if (fPos) { delete [] fPos; fPos = 0x0; }
270 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
271 Bool_t AliHMPIDRawStream::ReadHMPIDRawData()
273 //Here the loop on the decoding the raw bank
274 //for one ddl starts.
275 //It returns: kFALSE if any error occurs
277 Int_t cntGlob = fRawReader->GetDataSize()/4;
278 if(cntGlob==0) {fNumOfErr[fDDLNumber][kRawDataSizeErr]++; return kFALSE; }
284 if(!GetWord(cnt)) return kFALSE;
288 while (cnt>20) { //counter limit is changed from 0 to 20 to take into account (skipp) the 5 extra words in the equipment header
289 nwSeg = (fWord >> kbit8) & 0xfff;
290 if(!CheckSegment()) return kFALSE;
291 if(!ReadSegment(cntSegment)) return kFALSE;
293 if(nwSeg != cntSegment) {AliDebug(1,Form("Error in Segment counters: %i different wrt %i",nwSeg,cntSegment)); return kFALSE;}
294 if(!GetWord(cntSegment+1,kBwd)) return kFALSE;
301 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
302 Bool_t AliHMPIDRawStream::ReadSegment(Int_t &cntSegment)
305 //It returns: kFALSE if any error occurs
307 cntSegment = (fWord >> kbit8) & 0xfff;
308 Int_t cnt = cntSegment;
312 if(!GetWord(cnt,kBwd)) return kFALSE;
316 cntRow = (fWord >> kbit16) & 0xfff;
317 if(!CheckRowMarker()) return kFALSE;
318 if(!ReadRow(nwRow)) return kFALSE;
320 if(nwRow != cntRow) {AliDebug(1,Form("Error in Row counters: %i different wrt %i",nwRow,cntRow)); return kFALSE;}
321 if(!GetWord(cntRow+1)) return kFALSE;
331 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
332 Bool_t AliHMPIDRawStream::ReadRow(Int_t &cntRow)
335 //It returns: kFALSE if any error occurs
342 cntRow = (fWord >> kbit16) & 0xfff;
345 if(!GetWord(cntRow)) return kFALSE;
349 if(!CheckEoE(nwDil)) return kFALSE;
350 if(!ReadDilogic(cntDilogic)) return kFALSE;
352 if(nwDil != cntDilogic) {AliDebug(1,Form("Error in Dilogic counters: %i different wrt %i",nwDil,cntDilogic));return kFALSE;}
354 if(!GetWord(1,kBwd)) return kFALSE; // go to next Dilogic bank...
356 // Printf(" cnt %i cntDilogic %i ",cnt,cntDilogic);
364 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
365 Bool_t AliHMPIDRawStream::ReadDilogic(Int_t &cntDilogic)
367 // Read the dilogic bank
368 //It returns: kFALSE if any error occurs
371 cntDilogic = fWord & 0x7f;
373 Int_t cnt = cntDilogic;
375 // Printf(" cnt DILOGIC %i at %i word %08X",cnt,fPosition,fWord);
377 for(Int_t iDil=0;iDil<cntDilogic;iDil++) {
378 UInt_t dilogic = 0, row = 0;
379 if(!GetWord(1,kBwd)) return kFALSE;
380 //check on row number
382 row = (fWord >> kbit22) & 0x1f;
383 if(!CheckRow(row)) continue;
384 //check dilogic number
385 dilogic = (fWord >> kbit18) & 0xf; //dilogic info in raw word is between bits: 18...21
386 if(!CheckDilogic(dilogic)) continue;
388 UInt_t pad = (fWord >> kbit12) & 0x3f; //pad info in raw word is between bits: 12...17
389 if(!CheckPad(pad)) continue;
390 Int_t charge = fWord & 0xfff;
391 if(GetPad(fDDLNumber,row,dilogic,pad)<0) continue;
392 fPad[fNPads] = GetPad(fDDLNumber,row,dilogic,pad);
393 fCharge[fNPads] = charge;
398 AliDebug(1,Form("If PEDESTAL run -> WARNING: ZERO charge is read from DDL: %d row: %d dil: %d pad: %d",fDDLNumber,row,dilogic,pad));
399 fNumOfErr[fDDLNumber][kPedQZero]++;
407 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
408 Bool_t AliHMPIDRawStream::CheckSegment()
410 // Check the segment marker
411 //It returns: kFALSE if any error occurs
414 UInt_t markSegment = 0xAB0;
417 UInt_t segWord = GetWord();
418 if ((segWord >> 20) != statusSegWord) {
419 fRawReader->AddMajorErrorLog(kBadSegWordErr);
420 AliDebug(1,Form("Wrong segment word signature: %x, expected 0xab0!",(segWord >> 20)));
421 fNumOfErr[kBadSegWordErr]++;
425 UInt_t segMarker = (fWord >> kbit20) & 0xfff;
426 if (segMarker != markSegment ) {
427 //fRawReader->AddMajorErrorLog(kWrongSegErr,Form("Segment marker %0X wrong (expected %0X) at %i in word %0X!",segMarker,markSegment,fPosition,fWord));
428 AliDebug(1,Form("Segment marker %X wrong (expected %0X)! at %i in word %0X!",segMarker,markSegment,fPosition,fWord));
429 fNumOfErr[fDDLNumber][kWrongSegErr]++;
433 UInt_t segAddress = fWord & 0xff;
434 if (segAddress<1 ||segAddress>3) {
435 //fRawReader->AddMajorErrorLog(kWrongSegErr,Form("Segment address %d not in the valid range [1-3] at %i in word %0X",segAddress,fPosition,fWord));
436 AliDebug(1,Form("Segment address %d not in the valid range [1-3]",segAddress));
437 fNumOfErr[fDDLNumber][kWrongSegErr]++;
440 // Printf("Segment Marker found at %i! Number of segment is %i",fPosition,segAddress);
443 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
444 Bool_t AliHMPIDRawStream::CheckRow(UInt_t row)
446 //check on row number
447 //It returns: kFALSE if any error occurs
449 // Printf("ROW %i word %0X",row,fWord);
450 if(row>=1 && row <=kNRows) return kTRUE;
452 //fRawReader->AddMajorErrorLog(kWrongRowErr,Form("row %d",row));
453 AliDebug(1,Form("Wrong row index: %d, expected (1 -> %d) word %0X at %i...",row,kNRows,fWord,fPosition));
454 fNumOfErr[fDDLNumber][kWrongRowErr]++;
457 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
458 Bool_t AliHMPIDRawStream::CheckDilogic(UInt_t dilogic)
460 //check dilogic number
461 //It returns: kFALSE if any error occurs
463 if (dilogic>= 1 && dilogic <=kNDILOGICAdd) return kTRUE;
465 //fRawReader->AddMajorErrorLog(kWrongDilogicErr,Form("dil %d",dilogic));
466 AliDebug(1,Form("Wrong DILOGIC index: %d, expected (1 -> %d)!",dilogic,kNDILOGICAdd));
467 fNumOfErr[fDDLNumber][kWrongDilogicErr]++;
468 //dilogic = iDILOGIC;
471 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
472 Bool_t AliHMPIDRawStream::CheckPad(UInt_t pad)
475 //It returns: kFALSE if any error occurs
477 if (pad < kNPadAdd) return kTRUE;
479 //fRawReader->AddMajorErrorLog(kWrongPadErr,Form("pad %d",pad));
480 AliDebug(1,Form("Wrong pad index: %d, expected (0 -> %d)!",pad,kNPadAdd));
481 fNumOfErr[fDDLNumber][kWrongPadErr]++;
484 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
485 Bool_t AliHMPIDRawStream::CheckEoE(Int_t &nDil)
487 //check the End of Event
488 //It returns: kFALSE if any error occurs
490 if (!((fWord >> kbit27) & 0x1)) { //check 27th bit in EoE. It must be 1!
491 //fRawReader->AddMajorErrorLog(kEoEFlagErr);
492 AliDebug(1,Form("Missing end-of-event flag! (%08X) at %i",fWord,fPosition));
493 fNumOfErr[fDDLNumber][kEoEFlagErr]++;
496 nDil = fWord & 0x7f; //nDil=EoE word count
497 if(nDil < 0 || nDil > 48 ) {
499 //fRawReader->AddMajorErrorLog(kEoESizeErr,Form("EoE size=%d",nDil));
500 AliDebug(1,Form("Wrong end-of-event word-count: %08X",fWord));
501 fNumOfErr[fDDLNumber][kEoESizeErr]++;
504 // UInt_t da = (eOfEvent >> 18) & 0xf;
505 // if (cntData!=0 && da != dilogic) {
506 // fRawReader->AddMajorErrorLog(kEoEDILOGICErr,Form("eoe dil %d != %d",da,dilogic));
507 // AliDebug(1,Form("Wrong DILOGIC address found in end-of-event: %d, expected %d!",da,dilogic));
508 // fNumOfErr[kEoEDILOGICErr]++;
509 // return kFALSE; AliQAChecker::Instance()->Run(AliQAv1::kHMPID, task, obj) ;
512 // UInt_t ca = (eOfEvent >> 22) & 0x1f;
513 // if (cntData!=0 && ca != row) {
514 // fRawReader->AddMajorErrorLog(kEoERowErr,Form("eoe row %d != %d",ca,row));
515 // AliDebug(1,Form("Wrong row index found in end-of-event: %d, expected %d!",ca,row));
516 // fNumOfErr[kEoERowErr]++;
521 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
522 Bool_t AliHMPIDRawStream::CheckRowMarker()
524 //check the row marker
525 //It returns: kFALSE if any error occurs
527 UInt_t nMAXwordsInRow = 0x1EA;
528 UInt_t statusControlRow = 0x32a8; // 0x36a8 for zero suppression
529 //First check on row marker
530 UInt_t rowControlWord = fWord >> kbit0 & 0xfbff;
532 if(rowControlWord != statusControlRow) {
533 //fRawReader->AddMajorErrorLog(kRowMarkerErr);
534 AliDebug(1,Form("Wrong row marker %x expected 0x32a8!",rowControlWord));
535 fNumOfErr[fDDLNumber][kRowMarkerErr]++;
538 //Second check on row marker
539 UInt_t wordsInRow = fWord >> kbit16 & 0x0fff; // Number of words after the row marker, bit 10 is skipped in this check
541 if (wordsInRow > nMAXwordsInRow) {
542 //fRawReader->AddMajorErrorLog(kRowMarkerSizeErr);
543 AliDebug(1,Form(" FATAL: Number of words %x in a row exceeds the expected value: 0x1EA !",wordsInRow));
544 fNumOfErr[fDDLNumber][kRowMarkerSizeErr]++;
550 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
551 Bool_t AliHMPIDRawStream::GetWord(Int_t n,EDirection dir)
553 // This method returns the n-th 32 bit word
554 // inside the raw data payload.
555 // The method is supposed to be endian (platform)
560 AliError("fPosition < 0 !!! Event skipped.");
561 fRawReader->AddMajorErrorLog(kRawDataSizeErr,"fPosition<0");
565 if(dir==kBwd) n = -n;
568 if(fPosition==-4) return kTRUE;
570 if(fPosition<0 || fPosition > fRawReader->GetDataSize()) {
571 AliWarning(Form("fPosition out of boundaries %i",fPosition));
577 fWord |= fData[fPosition++];
578 fWord |= fData[fPosition++] << 8;
579 fWord |= fData[fPosition++] << 16;
580 fWord |= fData[fPosition++] << 24;
584 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
585 void AliHMPIDRawStream::DumpData(Int_t nw)
587 //just a simple raw data dump
588 // in () is the position in bytes
590 for(Int_t i=0;i<nw;i+=4) {
591 if(!(i%16)) printf(" \n %8i) ",i);
592 printf("%02X%02X%02X%02X [ %06i ] ",fData[i+3],fData[i+2],fData[i+1],fData[i+0],fPos[i]);
594 Printf(" \n -----end of dump ----------- ");
596 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
597 void AliHMPIDRawStream::StorePosition()
599 //just for debug purpose
600 // it stores the position
601 //read for the first time
602 // Printf("@@@@@@@@@ fPos: %x fPosition: %d",fPos,fPosition);
603 if(fPos[fPosition]!=0) {
604 // Printf("Position already stored!!! Value %i at address %i",fPos[fPosition],fPosition);
608 fPos[fPosition] = fiPos;
609 // if(stDeb)Printf("%i - Actual position %i",iPos,fPosition);
611 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++