1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
|
/** \class CSCTMBData
*
* \author A. Tumanov - Rice
*/
#include "EventFilter/CSCRawToDigi/interface/CSCTMBData.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include <iomanip> // dump for JK
#include <iostream>
#include <cstdio>
#include "EventFilter/CSCRawToDigi/interface/bitset_append.h"
#include "EventFilter/CSCRawToDigi/interface/cscPackerCompare.h"
#ifdef LOCAL_UNPACK
bool CSCTMBData::debug = false;
#else
std::atomic<bool> CSCTMBData::debug{false};
#endif
CSCTMBData::CSCTMBData()
: theOriginalBuffer(nullptr),
theB0CLine(0),
theE0FLine(0),
theTMBHeader(2007, 0x50c3),
theComparatorData(&theTMBHeader),
theGEMData(),
theTMBScopeIsPresent(false),
theTMBScope(nullptr),
theTMBMiniScopeIsPresent(false),
theTMBMiniScope(nullptr),
theBlockedCFEBIsPresent(false),
theTMBBlockedCFEB(nullptr),
theTMBTrailer(theTMBHeader.sizeInWords() + theComparatorData.sizeInWords(), 2007),
size_(0),
cWordCnt(0),
theRPCDataIsPresent(false),
theGEMDataIsPresent(false) {}
CSCTMBData::CSCTMBData(int firmwareVersion, int firmwareRevision, int cfebs)
: theOriginalBuffer(nullptr),
theB0CLine(0),
theE0FLine(0),
theTMBHeader(firmwareVersion, firmwareRevision),
theComparatorData(&theTMBHeader),
theGEMData(), // allocate 12 GEM tbins, 0xf - 4 GEM fibers enabled
theTMBScopeIsPresent(false),
theTMBScope(nullptr),
theTMBMiniScopeIsPresent(false),
theTMBMiniScope(nullptr),
theBlockedCFEBIsPresent(false),
theTMBBlockedCFEB(nullptr),
theTMBTrailer(theTMBHeader.sizeInWords() + theComparatorData.sizeInWords(), firmwareVersion),
size_(0),
cWordCnt(0),
theRPCDataIsPresent(false),
theGEMDataIsPresent(false) {
theTMBHeader.setNCFEBs(cfebs);
theComparatorData = CSCComparatorData(&theTMBHeader);
int wordCnt = theTMBHeader.sizeInWords() + theComparatorData.sizeInWords();
/// check if this is OTMB GEM fw and adjust expected TMB data word count
if ((firmwareVersion == 2020) && (((firmwareRevision >> 9) & 0x3) == 3)) {
theGEMDataIsPresent = true;
wordCnt += theGEMData.sizeInWords();
}
theTMBTrailer = CSCTMBTrailer(wordCnt, firmwareVersion);
}
CSCTMBData::CSCTMBData(const uint16_t* buf)
: theOriginalBuffer(buf),
theTMBHeader(2007, 0x50c3),
theComparatorData(&theTMBHeader),
theTMBScopeIsPresent(false),
theTMBScope(nullptr),
theTMBMiniScopeIsPresent(false),
theTMBMiniScope(nullptr),
theBlockedCFEBIsPresent(false),
theTMBBlockedCFEB(nullptr),
theTMBTrailer(theTMBHeader.sizeInWords() + theComparatorData.sizeInWords(), 2007),
theRPCDataIsPresent(false),
theGEMDataIsPresent(false) {
size_ = UnpackTMB(buf);
}
// Explicitly-defined copy constructor is needed when the scope data is
// present, to prevent the same pointer from being deleted twice. -SV.
CSCTMBData::CSCTMBData(const CSCTMBData& data)
: theOriginalBuffer(data.theOriginalBuffer),
theB0CLine(data.theB0CLine),
theE0FLine(data.theE0FLine),
theTMBHeader(data.theTMBHeader),
theComparatorData(data.theComparatorData),
theRPCData(data.theRPCData),
theGEMData(data.theGEMData),
theTMBScopeIsPresent(data.theTMBScopeIsPresent),
theTMBMiniScopeIsPresent(data.theTMBMiniScopeIsPresent),
theBlockedCFEBIsPresent(data.theBlockedCFEBIsPresent),
theTMBTrailer(data.theTMBTrailer),
size_(data.size_),
cWordCnt(data.cWordCnt),
theRPCDataIsPresent(data.theRPCDataIsPresent),
theGEMDataIsPresent(data.theGEMDataIsPresent) {
if (theTMBScopeIsPresent) {
theTMBScope = new CSCTMBScope(*(data.theTMBScope));
} else {
theTMBScope = nullptr;
}
if (theTMBMiniScopeIsPresent) {
theTMBMiniScope = new CSCTMBMiniScope(*(data.theTMBMiniScope));
} else {
theTMBMiniScope = nullptr;
}
if (theBlockedCFEBIsPresent) {
theTMBBlockedCFEB = new CSCTMBBlockedCFEB(*(data.theTMBBlockedCFEB));
} else {
theTMBBlockedCFEB = nullptr;
}
}
CSCTMBData::~CSCTMBData() {
if (theTMBScopeIsPresent) {
delete theTMBScope;
theTMBScopeIsPresent = false;
}
if (theTMBMiniScopeIsPresent) {
delete theTMBMiniScope;
theTMBMiniScopeIsPresent = false;
}
if (theBlockedCFEBIsPresent) {
delete theTMBBlockedCFEB;
theBlockedCFEBIsPresent = false;
}
}
/// returns -1 if not found
/// obsolete
int findLine(const uint16_t* buf, uint16_t marker, int first, int maxToDo) {
for (int i = first; i < maxToDo; ++i) {
if (buf[i] == marker) {
return i;
}
}
return -1;
}
int CSCTMBData::TMBCRCcalc() {
std::vector<std::bitset<16> > theTotalTMBData(theE0FLine + 1 - theB0CLine);
unsigned i = 0;
for (unsigned int line = theB0CLine; line < theE0FLine + 1; ++line) {
theTotalTMBData[i] = std::bitset<16>(theOriginalBuffer[line]);
++i;
}
if (!theTotalTMBData.empty()) {
std::bitset<22> CRC = calCRC22(theTotalTMBData);
LogTrace("CSCTMBData|CSCRawToDigi") << " Test here " << CRC.to_ulong();
return CRC.to_ulong();
} else {
LogTrace("CSCTMBData|CSCRawToDigi") << "theTotalTMBData doesn't exist";
return 0;
}
}
int CSCTMBData::UnpackTMB(const uint16_t* buf) {
///determine 2007 or 2006 version
unsigned short int firmwareVersion = 0;
unsigned short int firmwareRevision = 0;
int Ntbins = 0;
int NRPCtbins = 0; // Number of RPC tbins
int NGEMtbins = 0; // Number of GEM tbins
int NGEMEnabled = 0; // Number of Enabled GEM Fibers
int GEMFibersMask = 0;
bool isGEMfirmware = false;
int b0cLine = 0; ///assumes that buf starts at the tmb data
///this is not true if something is wrong in the data
///before TMB - then we skip the whole event
if (buf[b0cLine] == 0xdb0c) {
firmwareVersion = 2007;
firmwareRevision = buf[b0cLine + 7] & 0x7fff;
Ntbins = buf[b0cLine + 19] & 0xF8;
if ((firmwareRevision < 0x4000) /* New Run3 (O)TMB firmware revision format */
&& (((firmwareRevision >> 9) & 0x3) == 0x3))
isGEMfirmware = true;
if (isGEMfirmware) {
GEMFibersMask = buf[b0cLine + 36] & 0xf; // GEM enabled fibers 4-bits mask
/// Handling of enabled GEM fibers is not implemented in the firmware
// for (int i = 0; i < 4; i++)
// NGEMEnabled += (buf[b0cLine + 36] >> i) & 0x1; // Get number of enabled GEM fibers
NGEMEnabled = 4; // Currently always assume that all 4 fibers are enabled
NGEMtbins = (buf[b0cLine + 36] >> 5) & 0x1F; // Get GEM tbins
}
NRPCtbins = (buf[b0cLine + 36] >> 5) & 0x1F; // Get RPC tbins
} else if (buf[b0cLine] == 0x6b0c) {
firmwareVersion = 2006;
Ntbins = buf[b0cLine + 1] & 0x1f;
NRPCtbins = Ntbins;
} else {
LogTrace("CSCTMBData|CSCRawToDigi") << "+++ Can't find b0C flag";
}
if ((firmwareVersion == 2007) &&
(!(((buf[b0cLine] & 0xFFFF) == 0xDB0C) && ((buf[b0cLine + 1] & 0xf000) == 0xD000) &&
((buf[b0cLine + 2] & 0xf000) == 0xD000) && ((buf[b0cLine + 3] & 0xf000) == 0xD000)))) {
LogTrace("CSCTMBData|CSCRawToDigi") << "+++ CSCTMBData warning: error in header in 2007 format!";
}
int MaxSizeRPC = 1 + NRPCtbins * 2 * 4 + 1;
int MaxSizeGEM = 1 + NGEMEnabled * NGEMtbins * 4 + 1;
//int MaxSizeScope = 5;
int e0bLine = -1;
switch (firmwareVersion) {
case 2007:
e0bLine = 42; //last word of header2007
break;
case 2006:
e0bLine = 26; //last word of header in 2006 format
break;
default:
edm::LogError("CSCTMBData|CSCRawToDigi") << "+++ undetermined firmware format - cant find e0bLine";
}
theTMBHeader = CSCTMBHeader(buf);
if (!theTMBHeader.check()) {
LogTrace("CSCTMBData|CSCRawToDigi") << "+++ CSCTMBData warning: Bad TMB header e0bLine=" << std::hex
<< buf[e0bLine];
return 0;
}
int currentPosition = theTMBHeader.sizeInWords();
int theFirmwareVersion = theTMBHeader.FirmwareVersion();
theComparatorData =
CSCComparatorData(theTMBHeader.NCFEBs(), theTMBHeader.NTBins(), buf + e0bLine + 1, theFirmwareVersion);
if (!theComparatorData.check()) {
LogTrace("CSCTMBData|CSCRawToDigi") << "+++ CSCTMBData warning: Bad CLCT data";
} else {
currentPosition += theComparatorData.sizeInWords();
}
// look for RPC data
int b04Line = currentPosition;
if (buf[b04Line] == 0x6b04) {
// we need an e04 line to calculate the size
int e04Line = findLine(buf, 0x6e04, currentPosition, currentPosition + MaxSizeRPC);
if (e04Line != -1) {
theRPCDataIsPresent = true;
theRPCData = CSCRPCData(buf + b04Line, e04Line - b04Line + 1);
currentPosition += theRPCData.sizeInWords();
} else {
LogTrace("CSCTMBData|CSCRawToDigi") << "CSCTMBData::corrupt RPC data! Failed to find end! ";
return 0;
}
}
// look for GEM data
int c04Line = currentPosition;
if (buf[c04Line] == 0x6c04) {
// we need an d04 line to calculate the size
int d04Line = findLine(buf, 0x6d04, currentPosition, currentPosition + MaxSizeGEM);
if (d04Line != -1) {
theGEMDataIsPresent = true;
theGEMData = CSCGEMData(buf + c04Line, d04Line - c04Line + 1, GEMFibersMask);
currentPosition += theGEMData.sizeInWords();
} else {
LogTrace("CSCTMBData|CSCRawToDigi") << "CSCTMBData::corrupt GEM data! Failed to find end! ";
return 0;
}
}
int TotTMBReadout = 0;
switch (firmwareVersion) {
case 2007:
if (theGEMDataIsPresent) {
TotTMBReadout = 43 + Ntbins * 6 * 5 + 1 + NGEMEnabled * NGEMtbins * 4 + 2 + 8 * 256 + 8;
} else {
TotTMBReadout = 43 + Ntbins * 6 * 5 + 1 + NRPCtbins * 2 * 4 + 2 + 8 * 256 + 8;
};
break;
case 2006:
TotTMBReadout =
27 + Ntbins * 6 * 5 + 1 + NRPCtbins * 2 * 4 + 2 + 8 * 256 + 8; //see tmb2004 manual (version v2p06) page54.
break;
default:
edm::LogError("CSCTMBData|CSCRawToDigi") << "can't find TotTMBReadout - unknown firmware version!";
break;
}
//std::cout << " !!!TMB Scope!!! " << std::endl;
if (buf[currentPosition] == 0x6b05) {
int b05Line = currentPosition;
LogTrace("CSCTMBData|CSCRawToDigi") << "found scope!";
int e05Line = findLine(buf, 0x6e05, currentPosition, TotTMBReadout - currentPosition);
if (e05Line != -1) {
theTMBScopeIsPresent = true;
theTMBScope = new CSCTMBScope(buf, b05Line, e05Line);
// The size of the TMB scope data can vary, and I see no good reasons
// not to determine it dynamically. -SV, 5 Nov 2008.
//currentPosition+=theTMBScope->sizeInWords();
currentPosition += (e05Line - b05Line + 1);
} else {
LogTrace("CSCTMBData|CSCRawToDigi") << "+++ CSCTMBData warning: found 0x6b05 line, but not 0x6e05! +++";
}
}
/// Now Find the miniscope
if (buf[currentPosition] == 0x6b07) {
int Line6b07 = currentPosition;
LogTrace("CSCTMBData") << " TMBData ---> Begin of MiniScope found ";
int Line6E07 = findLine(buf, 0x6E07, currentPosition, TotTMBReadout - currentPosition);
if (Line6E07 != -1) {
LogTrace("CSCTMBData") << " TMBData --> End of MiniScope found " << Line6E07 - Line6b07 + 1 << " words ";
theTMBMiniScopeIsPresent = true;
theTMBMiniScope = new CSCTMBMiniScope(buf, Line6b07, Line6E07);
currentPosition += (Line6E07 - Line6b07 + 1);
} else {
LogTrace("CSCTMBData") << "+++ CSCTMBData warning MiniScope!: found 0x6b07 line, but not 0x6e07! +++";
}
}
/// end for the mini scope
/// Now Find the blocked CFEB DiStrips List Format
if (buf[currentPosition] == 0x6BCB) {
int Line6BCB = currentPosition;
LogTrace("CSCTMBData") << " TMBData ---> Begin of Blocked CFEB found ";
int Line6ECB = findLine(buf, 0x6ECB, currentPosition, TotTMBReadout - currentPosition);
if (Line6ECB != -1) {
LogTrace("CSCTMBData") << " TMBData --> End of Blocked CFEB found " << Line6ECB - Line6BCB + 1 << " words ";
theBlockedCFEBIsPresent = true;
theTMBBlockedCFEB = new CSCTMBBlockedCFEB(buf, Line6BCB, Line6ECB);
currentPosition += (Line6ECB - Line6BCB + 1);
} else {
LogTrace("CSCTMBData") << "+++ CSCTMBData warning Blocked CFEB!: found 0x6BCB line, but not 0x6ECB! +++";
}
}
/// end for the blocked CFEB DiStrips List Format
int maxLine = findLine(buf, 0xde0f, currentPosition, TotTMBReadout - currentPosition);
if (maxLine == -1) {
LogTrace("CSCTMBData|CSCRawToDigi") << "+++ CSCTMBData warning: No e0f line!";
return 0;
}
//Now for CRC check put this information into bitset
theB0CLine = b0cLine;
theE0FLine = maxLine;
// finally, the trailer
int e0cLine = findLine(buf, 0x6e0c, currentPosition, maxLine);
if (e0cLine == -1) {
LogTrace("CSCTMBData|CSCRawToDigi") << "+++ CSCTMBData warning: No e0c line!";
} else {
theTMBTrailer = CSCTMBTrailer(buf + e0cLine, firmwareVersion);
LogTrace("CSCTMBData|CSCRawToDigi") << "TMB trailer size: " << theTMBTrailer.sizeInWords();
}
checkSize();
// Dump of TMB; format proposed by JK.
#ifdef TMBDUMP
LogTrace("CSCTMBData") << "Dump of TMB data:";
for (int line = b0cLine; line <= maxLine + 3; line++) {
LogTrace("CSCTMBData") << "Adr= " << std::setw(4) << line << " Data= " << std::setfill('0') << std::setw(5)
<< std::uppercase << std::hex << buf[line] << std::dec << std::endl;
}
#endif
// size, since we count from 0 and have one more trailer word
// there are sometimes multiple "de0f" lines in trailer, so key on "6e0c"
return e0cLine - b0cLine + theTMBTrailer.sizeInWords();
} //UnpackTMB
bool CSCTMBData::checkSize() const {
// sum up all the components and see if they have the size indicated in the TMBTrailer
return true;
}
std::bitset<22> CSCTMBData::calCRC22(const std::vector<std::bitset<16> >& datain) {
std::bitset<22> CRC;
CRC.reset();
for (unsigned int i = 0; i < datain.size() - 3; ++i) {
CRC = nextCRC22_D16(datain[i], CRC);
}
return CRC;
}
CSCTMBScope& CSCTMBData::tmbScope() const {
if (!theTMBScopeIsPresent)
throw("No TMBScope in this chamber");
return *theTMBScope;
}
CSCTMBMiniScope& CSCTMBData::tmbMiniScope() const {
if (!theTMBMiniScopeIsPresent)
throw("No TMBScope in this chamber");
return *theTMBMiniScope;
}
CSCGEMData* CSCTMBData::gemData() {
if (!theGEMDataIsPresent)
throw("No GEM Data in this chamber");
return &theGEMData;
}
std::bitset<22> CSCTMBData::nextCRC22_D16(const std::bitset<16>& D, const std::bitset<22>& C) {
std::bitset<22> NewCRC;
NewCRC[0] = D[0] ^ C[6];
NewCRC[1] = D[1] ^ D[0] ^ C[6] ^ C[7];
NewCRC[2] = D[2] ^ D[1] ^ C[7] ^ C[8];
NewCRC[3] = D[3] ^ D[2] ^ C[8] ^ C[9];
NewCRC[4] = D[4] ^ D[3] ^ C[9] ^ C[10];
NewCRC[5] = D[5] ^ D[4] ^ C[10] ^ C[11];
NewCRC[6] = D[6] ^ D[5] ^ C[11] ^ C[12];
NewCRC[7] = D[7] ^ D[6] ^ C[12] ^ C[13];
NewCRC[8] = D[8] ^ D[7] ^ C[13] ^ C[14];
NewCRC[9] = D[9] ^ D[8] ^ C[14] ^ C[15];
NewCRC[10] = D[10] ^ D[9] ^ C[15] ^ C[16];
NewCRC[11] = D[11] ^ D[10] ^ C[16] ^ C[17];
NewCRC[12] = D[12] ^ D[11] ^ C[17] ^ C[18];
NewCRC[13] = D[13] ^ D[12] ^ C[18] ^ C[19];
NewCRC[14] = D[14] ^ D[13] ^ C[19] ^ C[20];
NewCRC[15] = D[15] ^ D[14] ^ C[20] ^ C[21];
NewCRC[16] = D[15] ^ C[0] ^ C[21];
NewCRC[17] = C[1];
NewCRC[18] = C[2];
NewCRC[19] = C[3];
NewCRC[20] = C[4];
NewCRC[21] = C[5];
return NewCRC;
}
boost::dynamic_bitset<> CSCTMBData::pack() {
boost::dynamic_bitset<> result =
bitset_utilities::ushortToBitset(theTMBHeader.sizeInWords() * 16, theTMBHeader.data());
boost::dynamic_bitset<> comparatorData =
bitset_utilities::ushortToBitset(theComparatorData.sizeInWords() * 16, theComparatorData.data());
result = bitset_utilities::append(result, comparatorData);
/// Add packed GEM data to TMB data block
if (theGEMDataIsPresent) {
boost::dynamic_bitset<> gemData =
bitset_utilities::ushortToBitset(theGEMData.sizeInWords() * 16, theGEMData.data());
result = bitset_utilities::append(result, gemData);
}
boost::dynamic_bitset<> newResult = result;
boost::dynamic_bitset<> tmbTrailer =
bitset_utilities::ushortToBitset(theTMBTrailer.sizeInWords() * 16, theTMBTrailer.data());
result = bitset_utilities::append(result, tmbTrailer);
// now convert to a vector<bitset<16>>, so we can calculate the crc
std::vector<std::bitset<16> > wordVector;
// try to tune so it stops before the e0f line
for (unsigned pos = 0; pos < result.size() - 16; pos += 16) {
std::bitset<16> word;
for (int i = 0; i < 16; ++i) {
word[i] = result[pos + i];
}
wordVector.push_back(word);
}
theTMBTrailer.setCRC(calCRC22(wordVector).to_ulong());
tmbTrailer = bitset_utilities::ushortToBitset(theTMBTrailer.sizeInWords() * 16, theTMBTrailer.data());
newResult = bitset_utilities::append(newResult, tmbTrailer);
return newResult;
}
void CSCTMBData::selfTest() {
CSCTMBData tmbData;
cscClassPackerCompare(tmbData);
}
|