/
SiStripFEDBufferComponents.cc
1461 lines (1333 loc) · 51.5 KB
/
SiStripFEDBufferComponents.cc
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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include <iomanip>
#include <ostream>
#include <sstream>
#include <cstring>
#include "EventFilter/SiStripRawToDigi/interface/SiStripFEDBufferComponents.h"
#include "FWCore/Utilities/interface/CRC16.h"
namespace sistrip {
void printHexValue(const uint8_t value, std::ostream& os)
{
const std::ios_base::fmtflags originalFormatFlags = os.flags();
os << std::hex << std::setfill('0') << std::setw(2);
os << uint16_t(value);
os.flags(originalFormatFlags);
}
void printHexWord(const uint8_t* pointer, const size_t lengthInBytes, std::ostream& os)
{
size_t i = lengthInBytes-1;
do{
printHexValue(pointer[i],os);
if (i != 0) os << " ";
} while (i-- != 0);
}
void printHex(const void* pointer, const size_t lengthInBytes, std::ostream& os)
{
const uint8_t* bytePointer = reinterpret_cast<const uint8_t*>(pointer);
//if there is one 64 bit word or less, print it out
if (lengthInBytes <= 8) {
printHexWord(bytePointer,lengthInBytes,os);
}
//otherwise, print word numbers etc
else {
//header
os << "word\tbyte\t \t\tbyte" << std::endl;;
const size_t words = lengthInBytes/8;
const size_t extraBytes = lengthInBytes - 8*words;
//print full words
for (size_t w = 0; w < words; w++) {
const size_t startByte = w*8;
os << w << '\t' << startByte+8 << '\t';
printHexWord(bytePointer+startByte,8,os);
os << "\t\t" << startByte << std::endl;
}
//print part word, if any
if (extraBytes) {
const size_t startByte = words*8;
os << words << '\t' << startByte+8 << '\t';
//padding
size_t p = 8;
while (p-- > extraBytes) {
os << "00 ";
}
printHexWord(bytePointer+startByte,extraBytes,os);
os << "\t\t" << startByte << std::endl;
}
os << std::endl;
}
}
uint16_t calculateFEDBufferCRC(const uint8_t* buffer, const size_t lengthInBytes)
{
uint16_t crc = 0xFFFF;
for (size_t i = 0; i < lengthInBytes-8; i++) {
crc = evf::compute_crc_8bit(crc,buffer[i^7]);
}
for (size_t i=lengthInBytes-8; i<lengthInBytes; i++) {
uint8_t byte;
//set CRC bytes to zero since these were not set when CRC was calculated
if (i==lengthInBytes-4 || i==lengthInBytes-3)
byte = 0x00;
else
byte = buffer[i^7];
crc = evf::compute_crc_8bit(crc,byte);
}
return crc;
}
std::ostream& operator<<(std::ostream& os, const FEDBufferFormat& value)
{
switch (value) {
case BUFFER_FORMAT_OLD_VME:
os << "Old VME";
break;
case BUFFER_FORMAT_OLD_SLINK:
os << "Old S-Link";
break;
case BUFFER_FORMAT_NEW:
os << "New";
break;
case BUFFER_FORMAT_INVALID:
os << "Invalid";
break;
default:
os << "Unrecognized";
os << " (";
printHexValue(value,os);
os << ")";
break;
}
return os;
}
std::ostream& operator<<(std::ostream& os, const FEDHeaderType& value)
{
switch (value) {
case HEADER_TYPE_FULL_DEBUG:
os << "Full debug";
break;
case HEADER_TYPE_APV_ERROR:
os << "APV error";
break;
case HEADER_TYPE_NONE:
os << "None";
break;
case HEADER_TYPE_INVALID:
os << "Invalid";
break;
default:
os << "Unrecognized";
os << " (";
printHexValue(value,os);
os << ")";
break;
}
return os;
}
std::ostream& operator<<(std::ostream& os, const FEDLegacyReadoutMode& value)
{
switch (value) {
case READOUT_MODE_LEGACY_SCOPE: os << "(L) Scope mode"; break;
case READOUT_MODE_LEGACY_VIRGIN_RAW_REAL: os << "(L) Virgin raw (real)"; break;
case READOUT_MODE_LEGACY_VIRGIN_RAW_FAKE: os << "(L) Virgin raw (fake)"; break;
case READOUT_MODE_LEGACY_PROC_RAW_REAL: os << "(L) Processed raw (real)"; break;
case READOUT_MODE_LEGACY_PROC_RAW_FAKE: os << "(L) Processed raw (fake)"; break;
case READOUT_MODE_LEGACY_ZERO_SUPPRESSED_REAL: os << "(L) Zero suppressed (real)"; break;
case READOUT_MODE_LEGACY_ZERO_SUPPRESSED_FAKE: os << "(L) Zero suppressed (fake)"; break;
case READOUT_MODE_LEGACY_ZERO_SUPPRESSED_LITE_REAL: os << "(L) Zero suppressed lite (real)"; break;
case READOUT_MODE_LEGACY_ZERO_SUPPRESSED_LITE_FAKE: os << "(L) Zero suppressed lite (fake)"; break;
case READOUT_MODE_LEGACY_SPY: os << "(L) Spy channel"; break;
case READOUT_MODE_LEGACY_PREMIX_RAW: os << "(L) PreMix raw"; break;
case READOUT_MODE_LEGACY_INVALID: os << "(L) Invalid"; break;
default:
os << "(L) Unrecognized";
os << " (";
printHexValue(value,os);
os << ")";
break;
}
return os;
}
std::ostream& operator<<(std::ostream& os, const FEDReadoutMode& value)
{
switch (value) {
case READOUT_MODE_SCOPE:
os << "Scope mode";
break;
case READOUT_MODE_VIRGIN_RAW:
os << "Virgin raw";
break;
case READOUT_MODE_PROC_RAW:
os << "Processed raw";
break;
case READOUT_MODE_ZERO_SUPPRESSED:
os << "Zero suppressed";
break;
case READOUT_MODE_ZERO_SUPPRESSED_FAKE:
os << "Zero suppressed (fake)";
break;
case READOUT_MODE_ZERO_SUPPRESSED_LITE10:
os << "Zero suppressed lite";
break;
case READOUT_MODE_SPY:
os << "Spy channel";
break;
/*case READOUT_MODE_ZERO_SUPPRESSED_CMOVERRIDE:
os << "Zero suppressed CM Override";
break;*/
case READOUT_MODE_ZERO_SUPPRESSED_LITE10_CMOVERRIDE:
os << "Zero suppressed lite CM Override";
break;
case READOUT_MODE_ZERO_SUPPRESSED_LITE8:
os << "Zero suppressed lite (8 bit, top-stripped)";
break;
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_CMOVERRIDE:
os << "Zero suppressed lite CM Override (8 bit, top-stripped)";
break;
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT:
os << "Zero suppressed lite (8 bit, bottom-stripped)";
break;
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT_CMOVERRIDE:
os << "Zero suppressed lite CM Override (8 bit, bottom-stripped)";
break;
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT:
os << "Zero suppressed lite (8 bit, top/bottom-stripped)";
break;
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT_CMOVERRIDE:
os << "Zero suppressed lite CM Override (8 bit, top/bottom-stripped)";
break;
case READOUT_MODE_PREMIX_RAW:
os << "PreMix raw";
break;
case READOUT_MODE_INVALID:
os << "Invalid";
break;
default:
os << "Unrecognized";
os << " (";
printHexValue(value,os);
os << ")";
break;
}
return os;
}
std::ostream& operator<<(std::ostream& os, const FEDDAQEventType& value)
{
switch (value) {
case DAQ_EVENT_TYPE_PHYSICS:
os << "Physics trigger";
break;
case DAQ_EVENT_TYPE_CALIBRATION:
os << "Calibration trigger";
break;
case DAQ_EVENT_TYPE_TEST:
os << "Test trigger";
break;
case DAQ_EVENT_TYPE_TECHNICAL:
os << "Technical trigger";
break;
case DAQ_EVENT_TYPE_SIMULATED:
os << "Simulated event";
break;
case DAQ_EVENT_TYPE_TRACED:
os << "Traced event";
break;
case DAQ_EVENT_TYPE_ERROR:
os << "Error";
break;
case DAQ_EVENT_TYPE_INVALID:
os << "Unknown";
break;
default:
os << "Unrecognized";
os << " (";
printHexValue(value,os);
os << ")";
break;
}
return os;
}
std::ostream& operator<<(std::ostream& os, const FEDTTSBits& value)
{
switch (value) {
case TTS_DISCONNECTED0:
os << "Disconected 0";
break;
case TTS_WARN_OVERFLOW:
os << "Warning overflow";
break;
case TTS_OUT_OF_SYNC:
os << "Out of sync";
break;
case TTS_BUSY:
os << "Busy";
break;
case TTS_READY:
os << "Ready";
break;
case TTS_ERROR:
os << "Error";
break;
case TTS_INVALID:
os << "Invalid";
break;
case TTS_DISCONNECTED1:
os << "Disconected 1";
break;
default:
os << "Unrecognized";
os << " (";
printHexValue(value,os);
os << ")";
break;
}
return os;
}
std::ostream& operator<<(std::ostream& os, const FEDBufferState& value)
{
switch (value) {
case BUFFER_STATE_UNSET:
os << "Unset";
break;
case BUFFER_STATE_EMPTY:
os << "Empty";
break;
case BUFFER_STATE_PARTIAL_FULL:
os << "Partial Full";
break;
case BUFFER_STATE_FULL:
os << "Full";
break;
default:
os << "Unrecognized";
os << " (";
printHexValue(value,os);
os << ")";
break;
}
return os;
}
std::ostream& operator<<(std::ostream& os, const FEDChannelStatus& value)
{
if (!(value&CHANNEL_STATUS_LOCKED)) os << "Unlocked ";
if (!(value&CHANNEL_STATUS_IN_SYNC)) os << "Out-of-sync ";
if (!(value&CHANNEL_STATUS_APV1_ADDRESS_GOOD)) os << "APV 1 bad address ";
if (!(value&CHANNEL_STATUS_APV1_NO_ERROR_BIT)) os << "APV 1 error ";
if (!(value&CHANNEL_STATUS_APV0_ADDRESS_GOOD)) os << "APV 0 bad address ";
if (!(value&CHANNEL_STATUS_APV0_NO_ERROR_BIT)) os << "APV 0 error ";
if (value == CHANNEL_STATUS_NO_PROBLEMS) os << "No errors";
return os;
}
FEDBufferFormat fedBufferFormatFromString(const std::string& bufferFormatString)
{
if ( (bufferFormatString == "OLD_VME") ||
(bufferFormatString == "BUFFER_FORMAT_OLD_VME") ||
(bufferFormatString == "Old VME") ) {
return BUFFER_FORMAT_OLD_VME;
}
if ( (bufferFormatString == "OLD_SLINK") ||
(bufferFormatString == "BUFFER_FORMAT_OLD_SLINK") ||
(bufferFormatString == "Old S-Link") ) {
return BUFFER_FORMAT_OLD_SLINK;
}
if ( (bufferFormatString == "NEW") ||
(bufferFormatString == "BUFFER_FORMAT_NEW") ||
(bufferFormatString == "New") ) {
return BUFFER_FORMAT_NEW;
}
//if it was none of the above then return invalid
return BUFFER_FORMAT_INVALID;
}
FEDHeaderType fedHeaderTypeFromString(const std::string& headerTypeString)
{
if ( (headerTypeString == "FULL_DEBUG") ||
(headerTypeString == "HEADER_TYPE_FULL_DEBUG") ||
(headerTypeString == "Full debug") ) {
return HEADER_TYPE_FULL_DEBUG;
}
if ( (headerTypeString == "APV_ERROR") ||
(headerTypeString == "HEADER_TYPE_APV_ERROR") ||
(headerTypeString == "APV error") ) {
return HEADER_TYPE_APV_ERROR;
}
if ( (headerTypeString == "None") ||
(headerTypeString == "none") ) {
return HEADER_TYPE_NONE;
}
//if it was none of the above then return invalid
return HEADER_TYPE_INVALID;
}
FEDReadoutMode fedReadoutModeFromString(const std::string& readoutModeString)
{
if ( (readoutModeString == "READOUT_MODE_SCOPE") ||
(readoutModeString == "SCOPE") ||
(readoutModeString == "SCOPE_MODE") ||
(readoutModeString == "Scope mode") ) {
return READOUT_MODE_SCOPE;
}
if ( (readoutModeString == "READOUT_MODE_VIRGIN_RAW") ||
(readoutModeString == "VIRGIN_RAW") ||
(readoutModeString == "Virgin raw") ) {
return READOUT_MODE_VIRGIN_RAW;
}
if ( (readoutModeString == "READOUT_MODE_PROC_RAW") ||
(readoutModeString == "PROC_RAW") ||
(readoutModeString == "PROCESSED_RAW") ||
(readoutModeString == "Processed raw") ) {
return READOUT_MODE_PROC_RAW;
}
if ( (readoutModeString == "READOUT_MODE_ZERO_SUPPRESSED") ||
(readoutModeString == "ZERO_SUPPRESSED") ||
(readoutModeString == "Zero suppressed") ) {
return READOUT_MODE_ZERO_SUPPRESSED;
}
if ( (readoutModeString == "READOUT_MODE_ZERO_SUPPRESSED_LITE") ||
(readoutModeString == "ZERO_SUPPRESSED_LITE") ||
(readoutModeString == "Zero suppressed lite") ) {
return READOUT_MODE_ZERO_SUPPRESSED_LITE10;
}
if ( (readoutModeString == "READOUT_MODE_ZERO_SUPPRESSED_CMOVERRIDE") ||
(readoutModeString == "ZERO_SUPPRESSED_CMOVERRIDE") ||
(readoutModeString == "ZERO_SUPPRESSED_CMO") ||
(readoutModeString == "Zero suppressed CM Override") ) {
return READOUT_MODE_ZERO_SUPPRESSED;
}
if ( (readoutModeString == "READOUT_MODE_ZERO_SUPPRESSED_LITE_CMOVERRIDE") ||
(readoutModeString == "ZERO_SUPPRESSED_LITE_CMO") ||
(readoutModeString == "ZERO_SUPPRESSED_LITE_CMOVERRIDE") ||
(readoutModeString == "Zero suppressed lite CM Override") ) {
return READOUT_MODE_ZERO_SUPPRESSED_LITE10;
}
if ( (readoutModeString == "READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT") ||
(readoutModeString == "ZERO_SUPPRESSED_LITE8_TOPBOT") ||
(readoutModeString == "Zero suppressed lite8 TobBot") ){
return READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT;
}
if ( (readoutModeString == "READOUT_MODE_PREMIX_RAW") ||
(readoutModeString == "PREMIX_RAW") ||
(readoutModeString == "PreMix Raw") ) {
return READOUT_MODE_PREMIX_RAW;
}
if ( (readoutModeString == "READOUT_MODE_SPY") ||
(readoutModeString == "SPY") ||
(readoutModeString == "Spy channel") ) {
return READOUT_MODE_SPY;
}
//if it was none of the above then return invalid
return READOUT_MODE_INVALID;
}
FEDDAQEventType fedDAQEventTypeFromString(const std::string& daqEventTypeString)
{
if ( (daqEventTypeString == "PHYSICS") ||
(daqEventTypeString == "DAQ_EVENT_TYPE_PHYSICS") ||
(daqEventTypeString == "Physics trigger") ) {
return DAQ_EVENT_TYPE_PHYSICS;
}
if ( (daqEventTypeString == "CALIBRATION") ||
(daqEventTypeString == "DAQ_EVENT_TYPE_CALIBRATION") ||
(daqEventTypeString == "Calibration trigger") ) {
return DAQ_EVENT_TYPE_CALIBRATION;
}
if ( (daqEventTypeString == "TEST") ||
(daqEventTypeString == "DAQ_EVENT_TYPE_TEST") ||
(daqEventTypeString == "Test trigger") ) {
return DAQ_EVENT_TYPE_TEST;
}
if ( (daqEventTypeString == "TECHNICAL") ||
(daqEventTypeString == "DAQ_EVENT_TYPE_TECHNICAL") ||
(daqEventTypeString == "Technical trigger") ) {
return DAQ_EVENT_TYPE_TECHNICAL;
}
if ( (daqEventTypeString == "SIMULATED") ||
(daqEventTypeString == "DAQ_EVENT_TYPE_SIMULATED") ||
(daqEventTypeString == "Simulated trigger") ) {
return DAQ_EVENT_TYPE_SIMULATED;
}
if ( (daqEventTypeString == "TRACED") ||
(daqEventTypeString == "DAQ_EVENT_TYPE_TRACED") ||
(daqEventTypeString == "Traced event") ) {
return DAQ_EVENT_TYPE_TRACED;
}
if ( (daqEventTypeString == "ERROR") ||
(daqEventTypeString == "DAQ_EVENT_TYPE_ERROR") ||
(daqEventTypeString == "Error") ) {
return DAQ_EVENT_TYPE_ERROR;
}
//if it was none of the above then return invalid
return DAQ_EVENT_TYPE_INVALID;
}
void FEDStatusRegister::printFlags(std::ostream& os) const
{
if (slinkFullFlag()) os << "SLINK_FULL ";
if (trackerHeaderMonitorDataReadyFlag()) os << "HEADER_MONITOR_READY ";
if (qdrMemoryFullFlag()) os << "QDR_FULL ";
if (qdrMemoryPartialFullFlag()) os << "QDR_PARTIAL_FULL ";
if (qdrMemoryEmptyFlag()) os << "QDR_EMPTY ";
if (l1aBxFIFOFullFlag()) os << "L1A_FULL ";
if (l1aBxFIFOPartialFullFlag()) os << "L1A_PARTIAL_FULL ";
if (l1aBxFIFOEmptyFlag()) os << "L1A_EMPTY ";
for (uint8_t iFE = 0; iFE < FEUNITS_PER_FED; iFE++) {
if (feDataMissingFlag(iFE)) os << "FEUNIT" << uint16_t(iFE) << "MISSING ";
}
}
FEDBufferState FEDStatusRegister::qdrMemoryState() const
{
uint8_t result(0x00);
if (qdrMemoryFullFlag()) result |= BUFFER_STATE_FULL;
if (qdrMemoryPartialFullFlag()) result |= BUFFER_STATE_PARTIAL_FULL;
if (qdrMemoryEmptyFlag()) result |= BUFFER_STATE_EMPTY;
return FEDBufferState(result);
}
FEDBufferState FEDStatusRegister::l1aBxFIFOState() const
{
uint8_t result(0x00);
if (l1aBxFIFOFullFlag()) result |= BUFFER_STATE_FULL;
if (l1aBxFIFOPartialFullFlag()) result |= BUFFER_STATE_PARTIAL_FULL;
if (l1aBxFIFOEmptyFlag()) result |= BUFFER_STATE_EMPTY;
return FEDBufferState(result);
}
void FEDStatusRegister::setBit(const uint8_t num, const bool bitSet)
{
const uint16_t mask = (0x0001 << num);
if (bitSet) data_ |= mask;
else data_ &= (~mask);
}
FEDStatusRegister& FEDStatusRegister::setQDRMemoryBufferState(const FEDBufferState state)
{
switch (state) {
case BUFFER_STATE_FULL:
case BUFFER_STATE_PARTIAL_FULL:
case BUFFER_STATE_EMPTY:
case BUFFER_STATE_UNSET:
break;
default:
std::ostringstream ss;
ss << "Invalid buffer state: ";
printHex(&state,1,ss);
throw cms::Exception("FEDBuffer") << ss.str();
}
setQDRMemoryFullFlag(state & BUFFER_STATE_FULL);
setQDRMemoryPartialFullFlag(state & BUFFER_STATE_PARTIAL_FULL);
setQDRMemoryEmptyFlag(state & BUFFER_STATE_EMPTY);
return *this;
}
FEDStatusRegister& FEDStatusRegister::setL1ABXFIFOBufferState(const FEDBufferState state)
{
switch (state) {
case BUFFER_STATE_FULL:
case BUFFER_STATE_PARTIAL_FULL:
case BUFFER_STATE_EMPTY:
case BUFFER_STATE_UNSET:
break;
default:
std::ostringstream ss;
ss << "Invalid buffer state: ";
printHex(&state,1,ss);
throw cms::Exception("FEDBuffer") << ss.str();
}
setL1ABXFIFOFullFlag(state & BUFFER_STATE_FULL);
setL1ABXFIFOPartialFullFlag(state & BUFFER_STATE_PARTIAL_FULL);
setL1ABXFIFOEmptyFlag(state & BUFFER_STATE_EMPTY);
return *this;
}
void FEDBackendStatusRegister::printFlags(std::ostream& os) const
{
if (internalFreezeFlag()) os << "INTERNAL_FREEZE ";
if (slinkDownFlag()) os << "SLINK_DOWN ";
if (slinkFullFlag()) os << "SLINK_FULL ";
if (backpressureFlag()) os << "BACKPRESSURE ";
if (ttcReadyFlag()) os << "TTC_READY ";
if (trackerHeaderMonitorDataReadyFlag()) os << "HEADER_MONITOR_READY ";
printFlagsForBuffer(qdrMemoryState(),"QDR",os);
printFlagsForBuffer(frameAddressFIFOState(),"FRAME_ADDRESS",os);
printFlagsForBuffer(totalLengthFIFOState(),"TOTAL_LENGTH",os);
printFlagsForBuffer(trackerHeaderFIFOState(),"TRACKER_HEADER",os);
printFlagsForBuffer(l1aBxFIFOState(),"L1ABX",os);
printFlagsForBuffer(feEventLengthFIFOState(),"FE_LENGTH",os);
printFlagsForBuffer(feFPGABufferState(),"FE",os);
}
void FEDBackendStatusRegister::printFlagsForBuffer(const FEDBufferState bufferState, const std::string name, std::ostream& os) const
{
if (bufferState&BUFFER_STATE_EMPTY) os << name << "_EMPTY ";
if (bufferState&BUFFER_STATE_PARTIAL_FULL) os << name << "_PARTIAL_FULL ";
if (bufferState&BUFFER_STATE_FULL) os << name << "_FULL ";
if (bufferState == BUFFER_STATE_UNSET) os << name << "_UNSET ";
}
FEDBufferState FEDBackendStatusRegister::getBufferState(const uint8_t bufferPosition) const
{
uint8_t result = 0x00;
if (getBit(bufferPosition+STATE_OFFSET_EMPTY)) result |= BUFFER_STATE_EMPTY;
if (getBit(bufferPosition+STATE_OFFSET_PARTIAL_FULL)) result |= BUFFER_STATE_PARTIAL_FULL;
if (getBit(bufferPosition+STATE_OFFSET_FULL)) result |= BUFFER_STATE_FULL;
return FEDBufferState(result);
}
void FEDBackendStatusRegister::setBufferSate(const uint8_t bufferPosition, const FEDBufferState state)
{
switch (state) {
case BUFFER_STATE_FULL:
case BUFFER_STATE_PARTIAL_FULL:
case BUFFER_STATE_EMPTY:
case BUFFER_STATE_UNSET:
break;
default:
std::ostringstream ss;
ss << "Invalid buffer state: ";
printHex(&state,1,ss);
throw cms::Exception("FEDBuffer") << ss.str();
}
setBit(bufferPosition+STATE_OFFSET_EMPTY, state&BUFFER_STATE_EMPTY);
setBit(bufferPosition+STATE_OFFSET_PARTIAL_FULL, state&BUFFER_STATE_PARTIAL_FULL);
setBit(bufferPosition+STATE_OFFSET_FULL, state&BUFFER_STATE_FULL);
}
void FEDBackendStatusRegister::setBit(const uint8_t num, const bool bitSet)
{
const uint32_t mask = (0x00000001 << num);
if (bitSet) data_ |= mask;
else data_ &= (~mask);
}
FEDBackendStatusRegister::FEDBackendStatusRegister(const FEDBufferState qdrMemoryBufferState,
const FEDBufferState frameAddressFIFOBufferState,
const FEDBufferState totalLengthFIFOBufferState,
const FEDBufferState trackerHeaderFIFOBufferState,
const FEDBufferState l1aBxFIFOBufferState,
const FEDBufferState feEventLengthFIFOBufferState,
const FEDBufferState feFPGABufferState,
const bool backpressure, const bool slinkFull,
const bool slinkDown, const bool internalFreeze,
const bool trackerHeaderMonitorDataReady, const bool ttcReady)
: data_(0)
{
setInternalFreezeFlag(internalFreeze);
setSLinkDownFlag(slinkDown);
setSLinkFullFlag(slinkFull);
setBackpressureFlag(backpressure);
setTTCReadyFlag(ttcReady);
setTrackerHeaderMonitorDataReadyFlag(trackerHeaderMonitorDataReady);
setQDRMemoryState(qdrMemoryBufferState);
setFrameAddressFIFOState(frameAddressFIFOBufferState);
setTotalLengthFIFOState(totalLengthFIFOBufferState);
setTrackerHeaderFIFOState(trackerHeaderFIFOBufferState);
setL1ABXFIFOState(l1aBxFIFOBufferState);
setFEEventLengthFIFOState(feEventLengthFIFOBufferState);
setFEFPGABufferState(feFPGABufferState);
}
TrackerSpecialHeader::TrackerSpecialHeader(const uint8_t* headerPointer)
{
//the buffer format byte is one of the valid values if we assume the buffer is not swapped
const bool validFormatByteWhenNotWordSwapped = ( (headerPointer[BUFFERFORMAT] == BUFFER_FORMAT_CODE_NEW) ||
(headerPointer[BUFFERFORMAT] == BUFFER_FORMAT_CODE_OLD) );
//the buffer format byte is the old value if we assume the buffer is swapped
const bool validFormatByteWhenWordSwapped = (headerPointer[BUFFERFORMAT^4] == BUFFER_FORMAT_CODE_OLD);
//if the buffer format byte is valid if the buffer is not swapped or it is never valid
if (validFormatByteWhenNotWordSwapped || (!validFormatByteWhenNotWordSwapped && !validFormatByteWhenWordSwapped) ) {
memcpy(specialHeader_,headerPointer,8);
wordSwapped_ = false;
} else {
memcpy(specialHeader_,headerPointer+4,4);
memcpy(specialHeader_+4,headerPointer,4);
wordSwapped_ = true;
}
}
FEDBufferFormat TrackerSpecialHeader::bufferFormat() const
{
if (bufferFormatByte() == BUFFER_FORMAT_CODE_NEW) return BUFFER_FORMAT_NEW;
else if (bufferFormatByte() == BUFFER_FORMAT_CODE_OLD) {
if (wordSwapped_) return BUFFER_FORMAT_OLD_VME;
else return BUFFER_FORMAT_OLD_SLINK;
}
else return BUFFER_FORMAT_INVALID;
}
FEDHeaderType TrackerSpecialHeader::headerType() const
{
if ( (headerTypeNibble() == HEADER_TYPE_FULL_DEBUG) ||
(headerTypeNibble() == HEADER_TYPE_APV_ERROR) ||
(headerTypeNibble() == HEADER_TYPE_NONE) )
return FEDHeaderType(headerTypeNibble());
else return HEADER_TYPE_INVALID;
}
FEDLegacyReadoutMode TrackerSpecialHeader::legacyReadoutMode() const
{
const uint8_t eventTypeNibble = trackerEventTypeNibble();
const uint8_t mode = (eventTypeNibble & 0xF);
switch(mode) {
case READOUT_MODE_LEGACY_VIRGIN_RAW_REAL:
case READOUT_MODE_LEGACY_VIRGIN_RAW_FAKE:
case READOUT_MODE_LEGACY_PROC_RAW_REAL:
case READOUT_MODE_LEGACY_PROC_RAW_FAKE:
case READOUT_MODE_LEGACY_ZERO_SUPPRESSED_REAL:
case READOUT_MODE_LEGACY_ZERO_SUPPRESSED_FAKE:
case READOUT_MODE_LEGACY_ZERO_SUPPRESSED_LITE_REAL:
case READOUT_MODE_LEGACY_ZERO_SUPPRESSED_LITE_FAKE:
return FEDLegacyReadoutMode(mode);
default:
return READOUT_MODE_LEGACY_INVALID;
}
}
FEDReadoutMode TrackerSpecialHeader::readoutMode() const
{
const uint8_t eventTypeNibble = trackerEventTypeNibble();
//if it is scope mode then return as is (it cannot be fake data)
if (eventTypeNibble == READOUT_MODE_SCOPE) return FEDReadoutMode(eventTypeNibble);
//if it is premix then return as is: stripping last bit would make it spy data !
if (eventTypeNibble == READOUT_MODE_PREMIX_RAW) return FEDReadoutMode(eventTypeNibble);
//if not then ignore the last bit which indicates if it is real or fake
else {
const uint8_t mode = (eventTypeNibble & 0xF);
switch(mode) {
case READOUT_MODE_VIRGIN_RAW:
case READOUT_MODE_PROC_RAW:
case READOUT_MODE_ZERO_SUPPRESSED:
case READOUT_MODE_ZERO_SUPPRESSED_FAKE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE10:
//case READOUT_MODE_ZERO_SUPPRESSED_CMOVERRIDE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE10_CMOVERRIDE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_CMOVERRIDE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT_CMOVERRIDE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT_CMOVERRIDE:
case READOUT_MODE_SPY:
return FEDReadoutMode(mode);
default:
return READOUT_MODE_INVALID;
}
}
}
TrackerSpecialHeader& TrackerSpecialHeader::setBufferFormat(const FEDBufferFormat newBufferFormat)
{
//check if order in buffer is different
if ( ( (bufferFormat()==BUFFER_FORMAT_OLD_VME) && (newBufferFormat!=BUFFER_FORMAT_OLD_VME) ) ||
( (bufferFormat()!=BUFFER_FORMAT_OLD_VME) && (newBufferFormat==BUFFER_FORMAT_OLD_VME) ) ) {
wordSwapped_ = !wordSwapped_;
}
//set appropriate code
setBufferFormatByte(newBufferFormat);
return *this;
}
void TrackerSpecialHeader::setBufferFormatByte(const FEDBufferFormat newBufferFormat)
{
switch (newBufferFormat) {
case BUFFER_FORMAT_OLD_VME:
case BUFFER_FORMAT_OLD_SLINK:
specialHeader_[BUFFERFORMAT] = BUFFER_FORMAT_CODE_OLD;
break;
case BUFFER_FORMAT_NEW:
specialHeader_[BUFFERFORMAT] = BUFFER_FORMAT_CODE_NEW;
break;
default:
std::ostringstream ss;
ss << "Invalid buffer format: ";
printHex(&newBufferFormat,1,ss);
throw cms::Exception("FEDBuffer") << ss.str();
}
}
TrackerSpecialHeader& TrackerSpecialHeader::setHeaderType(const FEDHeaderType headerType)
{
switch(headerType) {
case HEADER_TYPE_FULL_DEBUG:
case HEADER_TYPE_APV_ERROR:
case HEADER_TYPE_NONE:
setHeaderTypeNibble(headerType);
return *this;
default:
std::ostringstream ss;
ss << "Invalid header type: ";
printHex(&headerType,1,ss);
throw cms::Exception("FEDBuffer") << ss.str();
}
}
TrackerSpecialHeader& TrackerSpecialHeader::setReadoutMode(const FEDReadoutMode readoutMode)
{
switch(readoutMode) {
case READOUT_MODE_SCOPE:
//scope mode is always real
setReadoutModeBits(readoutMode);
case READOUT_MODE_VIRGIN_RAW:
case READOUT_MODE_PROC_RAW:
case READOUT_MODE_SPY:
case READOUT_MODE_ZERO_SUPPRESSED:
case READOUT_MODE_ZERO_SUPPRESSED_FAKE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE10:
case READOUT_MODE_ZERO_SUPPRESSED_LITE10_CMOVERRIDE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_CMOVERRIDE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT_CMOVERRIDE:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT:
case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT_CMOVERRIDE:
setReadoutModeBits(readoutMode);
break;
case READOUT_MODE_PREMIX_RAW:
//special mode for simulation
setReadoutModeBits(readoutMode);
break;
default:
std::ostringstream ss;
ss << "Invalid readout mode: ";
printHex(&readoutMode,1,ss);
throw cms::Exception("FEDBuffer") << ss.str();
}
return *this;
}
TrackerSpecialHeader& TrackerSpecialHeader::setAPVAddressErrorForFEUnit(const uint8_t internalFEUnitNum, const bool error)
{
const uint8_t mask = 0x1 << internalFEUnitNum;
const uint8_t result = ( (apvAddressErrorRegister() & (~mask)) | (error?mask:0x00) );
setAPVEAddressErrorRegister(result);
return *this;
}
TrackerSpecialHeader& TrackerSpecialHeader::setFEEnableForFEUnit(const uint8_t internalFEUnitNum, const bool enabled)
{
const uint8_t mask = 0x1 << internalFEUnitNum;
const uint8_t result = ( (feEnableRegister() & (~mask)) | (enabled?mask:0x00) );
setFEEnableRegister(result);
return *this;
}
TrackerSpecialHeader& TrackerSpecialHeader::setFEOverflowForFEUnit(const uint8_t internalFEUnitNum, const bool overflow)
{
const uint8_t mask = 0x1 << internalFEUnitNum;
const uint8_t result = ( (feOverflowRegister() & (~mask)) | (overflow?mask:0x00) );
setFEEnableRegister(result);
return *this;
}
TrackerSpecialHeader::TrackerSpecialHeader(const FEDBufferFormat bufferFormat, const FEDReadoutMode readoutMode,
const FEDHeaderType headerType,
const uint8_t address, const uint8_t addressErrorRegister,
const uint8_t feEnableRegister, const uint8_t feOverflowRegister,
const FEDStatusRegister fedStatusRegister)
{
memset(specialHeader_,0x00,8);
//determine if order is swapped in real buffer
wordSwapped_ = (bufferFormat == BUFFER_FORMAT_OLD_VME);
//set fields
setBufferFormatByte(bufferFormat);
setReadoutMode(readoutMode);
setHeaderType(headerType);
setAPVEAddress(address);
setAPVEAddressErrorRegister(addressErrorRegister);
setFEEnableRegister(feEnableRegister);
setFEOverflowRegister(feOverflowRegister);
setFEDStatusRegister(fedStatusRegister);
}
FEDDAQEventType FEDDAQHeader::eventType() const
{
switch(eventTypeNibble()) {
case DAQ_EVENT_TYPE_PHYSICS:
case DAQ_EVENT_TYPE_CALIBRATION:
case DAQ_EVENT_TYPE_TEST:
case DAQ_EVENT_TYPE_TECHNICAL:
case DAQ_EVENT_TYPE_SIMULATED:
case DAQ_EVENT_TYPE_TRACED:
case DAQ_EVENT_TYPE_ERROR:
return FEDDAQEventType(eventTypeNibble());
default:
return DAQ_EVENT_TYPE_INVALID;
}
}
FEDDAQHeader& FEDDAQHeader::setEventType(const FEDDAQEventType evtType)
{
header_[7] = ((header_[7] & 0xF0) | evtType);
return *this;
}
FEDDAQHeader& FEDDAQHeader::setL1ID(const uint32_t l1ID)
{
header_[4] = (l1ID & 0x000000FF);
header_[5] = ( (l1ID & 0x0000FF00) >> 8);
header_[6] = ( (l1ID & 0x00FF0000) >> 16);
return *this;
}
FEDDAQHeader& FEDDAQHeader::setBXID(const uint16_t bxID)
{
header_[3] = ( (bxID & 0x0FF0) >> 4);
header_[2] = ( (header_[2] & 0x0F) | ( (bxID & 0x000F) << 4) );
return *this;
}
FEDDAQHeader& FEDDAQHeader::setSourceID(const uint16_t sourceID)
{
header_[2] = ( (header_[2] & 0xF0) | ( (sourceID & 0x0F00) >> 8) );
header_[1] = (sourceID & 0x00FF);
return *this;
}
FEDDAQHeader::FEDDAQHeader(const uint32_t l1ID, const uint16_t bxID, const uint16_t sourceID, const FEDDAQEventType evtType)
{
//clear everything (FOV,H,x,$ all set to 0)
memset(header_,0x0,8);
//set the BoE nibble to indicate this is the last fragment
header_[7] = 0x50;
//set variable fields vith values supplied
setEventType(evtType);
setL1ID(l1ID);
setBXID(bxID);
setSourceID(sourceID);
}
FEDTTSBits FEDDAQTrailer::ttsBits() const
{
switch(ttsNibble()) {
case TTS_DISCONNECTED0:
case TTS_WARN_OVERFLOW:
case TTS_OUT_OF_SYNC:
case TTS_BUSY:
case TTS_READY:
case TTS_ERROR:
case TTS_DISCONNECTED1:
return FEDTTSBits(ttsNibble());
default:
return TTS_INVALID;
}
}
FEDDAQTrailer::FEDDAQTrailer(const uint32_t eventLengthIn64BitWords, const uint16_t crc, const FEDTTSBits ttsBits,
const bool slinkTransmissionError, const bool badFEDID, const bool slinkCRCError,
const uint8_t eventStatusNibble)
{
//clear everything (T,x,$ all set to 0)
memset(trailer_,0x0,8);
//set the EoE nibble to indicate this is the last fragment
trailer_[7] = 0xA0;
//set variable fields vith values supplied
setEventLengthIn64BitWords(eventLengthIn64BitWords);
setEventStatusNibble(eventStatusNibble);
setTTSBits(ttsBits);
setCRC(crc);
setSLinkTransmissionErrorBit(slinkTransmissionError);
setBadSourceIDBit(badFEDID);
setSLinkCRCErrorBit(slinkCRCError);
}
FEDDAQTrailer& FEDDAQTrailer::setEventLengthIn64BitWords(const uint32_t eventLengthIn64BitWords)
{
trailer_[4] = (eventLengthIn64BitWords & 0x000000FF);
trailer_[5] = ( (eventLengthIn64BitWords & 0x0000FF00) >> 8);
trailer_[6] = ( (eventLengthIn64BitWords & 0x00FF0000) >> 16);
return *this;
}
FEDDAQTrailer& FEDDAQTrailer::setCRC(const uint16_t crc)
{
trailer_[2] = (crc & 0x00FF);
trailer_[3] = ( (crc >> 8) & 0x00FF );
return *this;
}
FEDDAQTrailer& FEDDAQTrailer::setSLinkTransmissionErrorBit(const bool bitSet)
{
if (bitSet) trailer_[1] |= 0x80;
else trailer_[1] &= (~0x80);
return *this;
}
FEDDAQTrailer& FEDDAQTrailer::setBadSourceIDBit(const bool bitSet)
{
if (bitSet) trailer_[1] |= 0x40;
else trailer_[1] &= (~0x40);
return *this;
}
FEDDAQTrailer& FEDDAQTrailer::setSLinkCRCErrorBit(const bool bitSet)
{
if (bitSet) trailer_[0] |= 0x04;
else trailer_[0] &= (~0x40);
return *this;
}
FEDDAQTrailer& FEDDAQTrailer::setEventStatusNibble(const uint8_t eventStatusNibble)
{
trailer_[1] = ( (trailer_[1] & 0xF0) | (eventStatusNibble & 0x0F) );
return *this;
}