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 /** @file AliFMDRawReader.cxx
17 @author Christian Holm Christensen <cholm@nbi.dk>
18 @date Mon Mar 27 12:45:23 2006
19 @brief Class to read raw data
22 //____________________________________________________________________
24 // Class to read ADC values from a AliRawReader object.
26 // This class uses the AliFMDRawStreamer class to read the ALTRO
34 // +-----------------+ <<references>> +--------------+
35 // | AliFMDRawReader |<>----------------| AliRawReader |
36 // +-----------------+ +--------------+
40 // +-----------------+ <<uses>> |
41 // | AliFMDRawStream |------------------------+
42 // +-----------------+
49 // #include <AliLog.h> // ALILOG_H
50 #include "AliFMDDebug.h" // Better debug macros
51 #include "AliFMDParameters.h" // ALIFMDPARAMETERS_H
52 #include "AliFMDDigit.h" // ALIFMDDIGIT_H
53 #include "AliFMDRawStream.h" // ALIFMDRAWSTREAM_H
54 #include "AliRawReader.h" // ALIRAWREADER_H
55 #include "AliFMDRawReader.h" // ALIFMDRAWREADER_H
56 #include "AliFMDDebug.h"
57 #include "AliFMDCalibSampleRate.h"
58 #include "AliFMDCalibStripRange.h"
59 // #include "AliFMDAltroIO.h" // ALIFMDALTROIO_H
60 #include <TArrayS.h> // ROOT_TArrayS
61 #include <TTree.h> // ROOT_TTree
62 #include <TClonesArray.h> // ROOT_TClonesArray
67 //____________________________________________________________________
68 ClassImp(AliFMDRawReader)
70 ; // This is here to keep Emacs for indenting the next line
73 //____________________________________________________________________
74 AliFMDRawReader::AliFMDRawReader(AliRawReader* reader, TTree* tree)
75 : TTask("FMDRawReader", "Reader of Raw ADC values from the FMD"),
86 //____________________________________________________________________
88 AliFMDRawReader::Exec(Option_t*)
91 TClonesArray* array = new TClonesArray("AliFMDDigit");
96 fTree->Branch("FMD", &array);
100 Int_t nWrite = fTree->Fill();
101 AliFMDDebug(1, ("Got a grand total of %d digits, wrote %d bytes to tree",
102 array->GetEntriesFast(), nWrite));
107 //____________________________________________________________________
109 AliFMDRawReader::ReadAdcs(TClonesArray* array)
112 fReader->Select("FMD");
113 // Read raw data into the digits array, using AliFMDAltroReader.
115 AliError("No TClonesArray passed");
118 const UShort_t kUShortMax = (1 << 16) - 1;
119 fSeen.Reset(kUShortMax);
121 // if (!fReader->ReadHeader()) {
122 // AliError("Couldn't read header");
126 AliFMDParameters* pars = AliFMDParameters::Instance();
127 AliFMDRawStream input(fReader);
128 AliFMDDebug(5, ("Setting 7 word headers"));
129 input.SetShortDataHeader(!pars->HasCompleteHeader());
131 UShort_t stripMin = 0;
132 UShort_t stripMax = 0; // 127;
133 UShort_t preSamp = 0; // 14+5;
139 // Data array is approx twice the size needed.
142 Bool_t isGood = kTRUE;
144 isGood = input.ReadChannel(ddl, hwaddr, last, data);
145 // if (!isGood) break;
146 if (ddl >= UInt_t(-1)) {
147 AliFMDDebug(5, ("At end of event with %d digits",
148 array->GetEntriesFast()));
152 AliFMDDebug(5, ("Read channel 0x%x of size %d", hwaddr, last));
154 UShort_t det, sec, samp;
158 if (!pars->Hardware2Detector(ddl, hwaddr, det, ring, sec, strbase)) {
159 AliError(Form("Failed to get detector id from DDL %d, "
160 "hardware address 0x%03x", ddl, hwaddr));
164 stripMin = pars->GetMinStrip(det, ring, sec, strbase);
165 stripMax = pars->GetMaxStrip(det, ring, sec, strbase);
166 preSamp = pars->GetPreSamples(det, ring, sec, strbase);
167 rate = pars->GetSampleRate(det, ring, sec, strbase);
169 // Loop over the `timebins', and make the digits
170 for (size_t i = 0; i < last; i++) {
171 // if (i < preSamp) continue;
173 Short_t str = strbase;
175 UShort_t t = (i - preSamp);
178 str += (sec % 2 ? -1 : 1) * t / rate;
180 AliFMDDebug(10, ("0x%04x/0x%03x/%04d maps to FMD%d%c[%2d,%3d]-%d",
181 ddl, hwaddr, i, det, ring, sec, str, samp));
183 AliFMDDebug(8, ("Got presamples at timebin %d", i));
187 Short_t lstrip = (i - preSamp) / rate + stripMin;
189 AliFMDDebug(15, ("Checking if strip %d (%d) in range [%d,%d]",
190 lstrip, str, stripMin, stripMax));
191 if (lstrip < stripMin || lstrip > stripMax) {
192 AliFMDDebug(5, ("FMD%d%c[%02d,%03d]-%d out of range (%3d->%3d)",
193 det, ring, sec, samp, str, stripMin, stripMax));
197 // Check the cache of indicies
198 Int_t idx = fSeen(det, ring, sec, str);
199 if (idx == kUShortMax) {
200 // We haven't seen this strip yet.
201 fSeen(det, ring, sec, str) = idx = array->GetEntriesFast();
202 AliFMDDebug(7,("making digit for FMD%d%c[%2d,%3d]-%d from timebin %4d",
203 det, ring, sec, str, samp, i));
204 new ((*array)[idx]) AliFMDDigit(det, ring, sec, str);
206 AliFMDDigit* digit = static_cast<AliFMDDigit*>(array->At(idx));
208 ("Setting from FMD%d%c[%2d,%3d]-%d from timebin %4d = %4d",
209 det, ring, sec, str, samp, i, data[i]));
210 digit->SetCount(samp, data[i]);
216 //____________________________________________________________________
218 AliFMDRawReader::ReadAdcs(TClonesArray* array)
220 // Read raw data into the digits array, using AliFMDAltroReader.
222 AliError("No TClonesArray passed");
225 // if (!fReader->ReadHeader()) {
226 // AliError("Couldn't read header");
230 AliFMDParameters* pars = AliFMDParameters::Instance();
233 fReader->Select("FMD");
235 UShort_t stripMin = 0;
236 UShort_t stripMax = 127;
237 UShort_t preSamp = 0;
241 if (!fReader->ReadNextData(cdata)) break;
242 size_t nchar = fReader->GetDataSize();
243 UShort_t ddl = fReader->GetDDLID();
245 AliFMDDebug(1, ("Reading %d bytes (%d 10bit words) from %d",
246 nchar, nchar * 8 / 10, ddl));
247 // Make a stream to read from
248 std::string str((char*)(cdata), nchar);
249 std::istringstream s(str);
250 // Prep the reader class.
251 AliFMDAltroReader r(s);
252 // Data array is approx twice the size needed.
253 UShort_t data[2048], hwaddr, last;
254 while (r.ReadChannel(hwaddr, last, data) > 0) {
255 AliFMDDebug(5, ("Read channel 0x%x of size %d", hwaddr, last));
256 UShort_t det, sec, str;
258 if (!pars->Hardware2Detector(ddl, hwaddr, det, ring, sec, str)) {
259 AliError(Form("Failed to detector id from DDL %d "
260 "and hardware address 0x%x", ddl, hwaddr));
263 rate = pars->GetSampleRate(det, ring, sec, str);
264 stripMin = pars->GetMinStrip(det, ring, sec, str);
265 stripMax = pars->GetMaxStrip(det, ring, sec, str);
266 AliFMDDebug(5, ("DDL 0x%04x, address 0x%03x maps to FMD%d%c[%2d,%3d]",
267 ddl, hwaddr, det, ring, sec, str));
269 // Loop over the `timebins', and make the digits
270 for (size_t i = 0; i < last; i++) {
271 if (i < preSamp) continue;
272 Int_t n = array->GetEntries();
273 UShort_t curStr = str + stripMin + i / rate;
274 if ((curStr-str) > stripMax) {
275 AliError(Form("Current strip is %d but DB says max is %d",
278 AliFMDDebug(5, ("making digit for FMD%d%c[%2d,%3d] from sample %4d",
279 det, ring, sec, curStr, i));
280 new ((*array)[n]) AliFMDDigit(det, ring, sec, curStr, data[i],
281 (rate >= 2 ? data[i+1] : 0),
282 (rate >= 3 ? data[i+2] : 0));
286 if (r.IsBof()) break;
294 // This is the old method, for comparison. It's really ugly, and far
296 //____________________________________________________________________
298 AliFMDRawReader::Exec(Option_t*)
300 // Read raw data into the digits array
301 // if (!fReader->ReadHeader()) {
302 // Error("ReadAdcs", "Couldn't read header");
307 TClonesArray* array = new TClonesArray("AliFMDDigit");
308 fTree->Branch("FMD", &array);
311 AliFMDParameters* pars = AliFMDParameters::Instance();
312 fSampleRate = pars->GetSampleRate(0);
314 // Use AliAltroRawStream to read the ALTRO format. No need to
315 // reinvent the wheel :-)
316 AliFMDRawStream input(fReader, fSampleRate);
318 fReader->Select("FMD");
322 UShort_t detector = 1; // Must be one here
323 UShort_t oldDetector = 0;
330 // Loop over data in file
335 Int_t ddl = fReader->GetDDLID();
336 AliFMDDebug(10, ("Current DDL is %d", ddl));
337 if (ddl != oldDDL || input.IsNewStrip() || !next) {
338 // Make a new digit, if we have some data (oldDetector == 0,
339 // means that we haven't really read anything yet - that is,
340 // it's the first time we get here).
341 if (oldDetector > 0) {
343 AliFMDDebug(10, ("Add a new strip: FMD%d%c[%2d,%3d] "
344 "(current: FMD%d%c[%2d,%3d])",
345 oldDetector, input.PrevRing(),
346 input.PrevSector() , input.PrevStrip(),
347 detector , input.Ring(), input.Sector(),
349 new ((*array)[n]) AliFMDDigit(oldDetector,
353 counts[0], counts[1], counts[2]);
357 static_cast<AliFMDDigit*>(fFMD->Digits()->
358 UncheckedAt(fFMD->GetNdigits()-1));
363 AliFMDDebug(10, ("Read %d channels for FMD%d",
364 count + 1, detector));
369 // If we got a new DDL, it means we have a new detector.
372 AliFMDDebug(10, ("Read %d channels for FMD%d", count + 1, detector));
373 // Reset counts, and update the DDL cache
376 // Check that we're processing a FMD detector
377 Int_t detId = fReader->GetDetectorID();
378 if (detId != (AliDAQ::DetectorID("FMD"))) {
379 AliError(Form("Detector ID %d != %d",
380 detId, (AliDAQ::DetectorID("FMD"))));
383 // Figure out what detector we're deling with
384 oldDetector = detector;
386 case 0: detector = 1; break;
387 case 1: detector = 2; break;
388 case 2: detector = 3; break;
390 AliError(Form("Unknown DDL 0x%x for FMD", ddl));
393 AliFMDDebug(10, ("Reading ADCs for 0x%x - That is FMD%d",
394 fReader->GetEquipmentId(), detector));
399 counts[input.Sample()] = input.Count();
401 AliFMDDebug(10, ("ADC of FMD%d%c[%2d,%3d] += %d",
402 detector, input.Ring(), input.Sector(),
403 input.Strip(), input.Count()));
404 oldDetector = detector;
411 //____________________________________________________________________
412 Bool_t AliFMDRawReader::ReadSODevent(AliFMDCalibSampleRate* sampleRate,
413 AliFMDCalibStripRange* stripRange,
415 TArrayS &pulseLength)
418 AliFMDDebug(0, ("Start of SOD/EOD"));
420 UInt_t shift_clk[18];
421 UInt_t sample_clk[18];
422 UInt_t strip_low[18];
423 UInt_t strip_high[18];
424 UInt_t pulse_size[18];
425 UInt_t pulse_length[18];
426 AliFMDParameters* param = AliFMDParameters::Instance();
428 while(fReader->ReadNextData(fData)) {
430 Int_t ddl = fReader->GetDDLID();
431 Int_t detID = fReader->GetDetectorID();
432 AliFMDDebug(0, (" From reader: DDL number is %d , det ID is %d",ddl,detID));
434 fNbytes = fReader->GetDataSize();
436 ULong_t nWords = GetNwords();
437 UInt_t trailerLast = Get32bitWord(nWords);
438 AliFMDDebug(20, (" # Bytes: %d, # Words: %d, Last word: 0x%08x",
439 fNbytes, nWords, trailerLast));
440 if ((trailerLast & 0xFFFF0000) != 0xAAAA0000) {
441 AliWarning(Form("Last word 0x%08x does not match RCU II trailer",
446 // 7 last bits is size of trailer
447 ULong_t nTrailerWords = trailerLast & 0x7f;
448 ULong_t nPayloadWords = Get32bitWord(nWords - nTrailerWords+1);
450 AliFMDDebug(20, (" # trailer words: %d, # payload words: %d",
451 nTrailerWords, nPayloadWords));
454 for (ULong_t i = 1; i <= nPayloadWords ; i++) {
455 UInt_t payloadWord = Get32bitWord(i);
457 // address is only 24 bit
458 UInt_t address = (0xffffff & payloadWord);
459 UInt_t type = ((address >> 21) & 0xf);
460 UInt_t error = ((address >> 20) & 0x1);
461 UInt_t bcast = ((address >> 18) & 0x1);
462 UInt_t bc_not_altro = ((address >> 17) & 0x1);
463 UInt_t board = ((address >> 12) & 0x1f);
464 UInt_t instruction = 0;
468 instruction = address & 0xfff;
470 chip = ((address >> 9) & 0x7);
471 channel = ((address >> 5) & 0x5);
472 instruction = (address & 0x1f);
475 Bool_t readDataWord = kFALSE;
477 case 0x0: // Fec read
478 readDataWord = kTRUE;
480 case 0x2: // Fec write
486 case 0x6: // End sequence
488 i = nPayloadWords + 1;
494 //Don't read unless we have a FEC_RD
495 if(!readDataWord) continue;
497 UInt_t dataWord = Get32bitWord(i);
498 UInt_t data = (0xFFFFF & dataWord) ;
499 //UInt_t data = (0xFFFF & dataWord) ;
502 AliWarning(Form("error bit detected at Word 0x%06x; "
503 "error % d, type %d, bc_not_altro %d, "
504 "bcast %d, board 0x%02x, chip 0x%x, "
505 "channel 0x%02x, instruction 0x%03x",
506 address, error, type, bc_not_altro,
507 bcast,board,chip,channel,instruction));
513 switch(instruction) {
515 case 0x01: break; // First ADC T
516 case 0x02: break; // I 3.3 V
517 case 0x03: break; // I 2.5 V altro digital
518 case 0x04: break; // I 2.5 V altro analog
519 case 0x05: break; // I 2.5 V VA
520 case 0x06: break; // First ADC T
521 case 0x07: break; // I 3.3 V
522 case 0x08: break; // I 2.5 V altro digital
523 case 0x09: break; // I 2.5 V altro analog
524 case 0x0A: break; // I 2.5 V VA
525 case 0x2D: break; // Second ADC T
526 case 0x2E: break; // I 1.5 V VA
527 case 0x2F: break; // I -2.0 V
528 case 0x30: break; // I -2.0 V VA
529 case 0x31: break; // 2.5 V Digital driver
530 case 0x32: break; // Second ADC T
531 case 0x33: break; // I 1.5 V VA
532 case 0x34: break; // I -2.0 V
533 case 0x35: break; // I -2.0 V VA
534 case 0x36: break; // 2.5 V Digital driver
535 case 0x37: break; // Third ADC T
536 case 0x38: break; // Temperature sens. 1
537 case 0x39: break; // Temperature sens. 2
538 case 0x3A: break; // U 2.5 altro digital (m)
539 case 0x3B: break; // U 2.5 altro analog (m)
540 case 0x3C: break; // Third ADC T
541 case 0x3D: break; // Temperature sens. 1
542 case 0x3E: break; // Temperature sens. 2
543 case 0x3F: break; // U 2.5 altro digital (m)
544 case 0x40: break; // U 2.5 altro analog (m)
545 case 0x41: break; // Forth ADC T
546 case 0x42: break; // U 2.5 VA (m)
547 case 0x43: break; // U 1.5 VA (m)
548 case 0x44: break; // U -2.0 VA (m)
549 case 0x45: break; // U -2.0 (m)
550 case 0x46: break; // Forth ADC T
551 case 0x47: break; // U 2.5 VA (m)
552 case 0x48: break; // U 1.5 VA (m)
553 case 0x49: break; // U -2.0 VA (m)
554 case 0x4A: break; // U -2.0 (m)
556 case 0x0B: break; // L1 trigger CouNTer
557 case 0x0C: break; // L2 trigger CouNTer
558 case 0x0D: break; // Sampling CLK CouNTer
559 case 0x0E: break; // DSTB CouNTer
561 case 0x0F: break; // Test mode word
562 case 0x10: break; // Undersampling ratio.
563 // Configuration and status
564 case 0x11: break; // Config/Status Register 0
565 case 0x12: break; // Config/Status Register 1
566 case 0x13: break; // Config/Status Register 2
567 case 0x14: break; // Config/Status Register 3
568 case 0x15: break; // Free
570 case 0x16: break; // Latch L1, L2, SCLK Counters
571 case 0x17: break; // Clear counters
572 case 0x18: break; // Clear CSR1
573 case 0x19: break; // rstb ALTROs
574 case 0x1A: break; // rstb BC
575 case 0x1B: break; // Start conversion
576 case 0x1C: break; // Scan event length
577 case 0x1D: break; // Read event length
578 case 0x1E: break; // Start test mode
579 case 0x1F: break; // Read acquisition memory
581 case 0x20: break; // FMDD status
582 case 0x21: break; // L0 counters
583 case 0x22: break; // FMD: Wait to hold
584 case 0x23: break; // FMD: L1 timeout
585 case 0x24: break; // FMD: L2 timeout
586 case 0x25: // FMD: Shift clk
587 shift_clk[board] = ((data >> 8 ) & 0xFF);
589 case 0x26: // FMD: Strips
590 strip_low[board] = ((data >> 0 ) & 0xFF);
591 strip_high[board] = ((data >> 8 ) & 0xFF);
593 case 0x27: // FMD: Cal pulse
594 pulse_size[board] = ((data >> 8 ) & 0xFF);
596 case 0x28: break; // FMD: Shape bias
597 case 0x29: break; // FMD: Shape ref
598 case 0x2A: break; // FMD: Preamp ref
599 case 0x2B: // FMD: Sample clk
600 sample_clk[board] = ((data >> 8 ) & 0xFF);
602 case 0x2C: break; // FMD: Commands
603 case 0x4B: // FMD: Cal events
604 pulse_length[board] = ((data >> 0 ) & 0xFF);
609 AliFMDDebug(50, ("instruction 0x%x, dataword 0x%x",
610 instruction,dataWord));
617 const UInt_t boards[4] = {0,1,16,17};
618 for(Int_t i=0;i<4;i++) {
619 if(ddl==0 && (i==1 || i==3)) continue;
621 UInt_t chip =0, channel=0;
622 param->Hardware2Detector(ddl,boards[i],chip,channel,
623 det,ring,sector,strip);
625 UInt_t samplerate = 1;
626 if(sample_clk[boards[i]] == 0) {
628 Int_t sample1 = sample_clk[boards[0]];
629 Int_t sample2 = sample_clk[boards[2]];
630 if(sample1) sample_clk[boards[i]] = sample1;
631 else sample_clk[boards[i]] = sample2;
634 Int_t sample1 = sample_clk[boards[0]];
635 Int_t sample2 = sample_clk[boards[1]];
636 Int_t sample3 = sample_clk[boards[2]];
637 Int_t sample4 = sample_clk[boards[3]];
639 if(sample1 == sample2) agreement++;
640 if(sample1 == sample3) agreement++;
641 if(sample1 == sample4) agreement++;
642 if(sample2 == sample3) agreement++;
643 if(sample2 == sample4) agreement++;
644 if(sample3 == sample4) agreement++;
650 sample_clk[boards[i]] = sample_clk[boards[idx]];
651 shift_clk[boards[i]] = shift_clk[boards[idx]];
652 strip_low[boards[i]] = strip_low[boards[idx]];
653 strip_high[boards[i]] = strip_high[boards[idx]];
654 pulse_length[boards[i]] = pulse_length[boards[idx]];
655 pulse_size[boards[i]] = pulse_size[boards[idx]];
656 AliFMDDebug(0, ("Vote taken for ddl %d, board 0x%x",
662 if(sample_clk[boards[i]])
663 samplerate = shift_clk[boards[i]]/sample_clk[boards[i]];
664 sampleRate->Set(det,ring,sector,0,samplerate);
665 stripRange->Set(det,ring,sector,0,
666 strip_low[boards[i]],strip_high[boards[i]]);
668 AliFMDDebug(20, ("det %d, ring %c, ",det,ring));
669 pulseLength.AddAt(pulse_length[boards[i]],
670 GetHalfringIndex(det,ring,boards[i]/16));
671 pulseSize.AddAt(pulse_size[boards[i]],
672 GetHalfringIndex(det,ring,boards[i]/16));
676 AliFMDDebug(20, (": Board: 0x%02x\n"
677 "\tstrip_low %3d, strip_high %3d\n"
678 "\tshift_clk %3d, sample_clk %3d\n"
679 "\tpulse_size %3d, pulse_length %3d",
681 strip_low[boards[i]], strip_high[boards[i]],
682 shift_clk[boards[i]], sample_clk[boards[i]],
683 pulse_size[boards[i]],pulse_length[boards[i]]));
688 AliFMDParameters::Instance()->SetSampleRate(sampleRate);
689 AliFMDParameters::Instance()->SetStripRange(stripRange);
691 AliFMDDebug(0, ("End of SOD/EOD"));
695 //____________________________________________________________________
697 UInt_t AliFMDRawReader::Get32bitWord(Int_t idx)
699 // This method returns the 32 bit word at a given
700 // position inside the raw data payload.
701 // The 'index' points to the beginning of the next word.
702 // The method is supposed to be endian (platform)
705 AliFatal("Raw data paylod buffer is not yet initialized !");
711 // fRawReader->AddFatalErrorLog(k32bitWordReadErr,Form("pos = %d",index));
713 AliWarning(Form("Invalid raw data payload position (%d) !",index));
718 word = fData[--index] << 24;
719 word |= fData[--index] << 16;
720 word |= fData[--index] << 8;
721 word |= fData[--index] << 0 ;
725 //_____________________________________________________________________
726 Int_t AliFMDRawReader::GetHalfringIndex(UShort_t det, Char_t ring,
729 UShort_t iring = (ring == 'I' ? 1 : 0);
731 Int_t index = (((det-1) << 2) | (iring << 1) | (board << 0));
736 //____________________________________________________________________