CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
EMTFBlockHeaders.cc
Go to the documentation of this file.
1 // Code to unpack the AMC13 header, "AMC data header", and "Event Record Header"
2 
4 #include "EMTFCollections.h"
5 #include "EMTFUnpackerTools.h"
6 
7 // This is the "header" - no EMTFBlockHeaders.h file is needed
8 namespace l1t {
9  namespace stage2 {
10  namespace emtf {
11 
12  class HeadersBlockUnpacker : public Unpacker { // "HeadersBlockUnpacker" inherits from "Unpacker"
13  public:
14  virtual int checkFormat(const Block& block);
15  virtual bool unpack(const Block& block, UnpackerCollections *coll) override; // Apparently it's always good to use override in C++
16  // virtual bool packBlock(const Block& block, UnpackerCollections *coll) override;
17  };
18 
19  // class HeadersBlockPacker : public Packer { // "HeadersBlockPacker" inherits from "Packer"
20  // public:
21  // virtual bool unpack(const Block& block, UnpackerCollections *coll) override; // Apparently it's always good to use override in C++
22  // };
23 
24  }
25  }
26 }
27 
28 namespace l1t {
29  namespace stage2 {
30  namespace emtf {
31 
33 
34  auto payload = block.payload();
35  int errors = 0;
36 
37  //Check the number of 16-bit words
38  if(payload.size() != 12) { errors += 1; edm::LogError("L1T|EMTF") << "Payload size in 'AMC Data Header' is different than expected"; }
39 
40  //Check that each word is 16 bits
41  if(GetHexBits(payload[0], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[0] has more than 16 bits in 'AMC Data Header'"; }
42  if(GetHexBits(payload[1], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[1] has more than 16 bits in 'AMC Data Header'"; }
43  if(GetHexBits(payload[2], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[2] has more than 16 bits in 'AMC Data Header'"; }
44  if(GetHexBits(payload[3], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[3] has more than 16 bits in 'AMC Data Header'"; }
45  if(GetHexBits(payload[4], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[4] has more than 16 bits in 'AMC Data Header'"; }
46  if(GetHexBits(payload[5], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[5] has more than 16 bits in 'AMC Data Header'"; }
47  if(GetHexBits(payload[6], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[6] has more than 16 bits in 'AMC Data Header'"; }
48  if(GetHexBits(payload[7], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[7] has more than 16 bits in 'AMC Data Header'"; }
49  if(GetHexBits(payload[8], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[8] has more than 16 bits in 'AMC Data Header'"; }
50  if(GetHexBits(payload[9], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[9] has more than 16 bits in 'AMC Data Header'"; }
51  if(GetHexBits(payload[10], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[10] has more than 16 bits in 'AMC Data Header'"; }
52  if(GetHexBits(payload[11], 16, 31) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Payload[11] has more than 16 bits in 'AMC Data Header'"; }
53 
54  uint16_t HD1a = payload[0];
55  uint16_t HD1b = payload[1];
56  uint16_t HD1c = payload[2];
57  uint16_t HD1d = payload[3];
58  uint16_t HD2a = payload[4];
59  uint16_t HD2b = payload[5];
60  uint16_t HD2c = payload[6];
61  uint16_t HD2d = payload[7];
62  uint16_t HD3a = payload[8];
63  uint16_t HD3b = payload[9];
64  uint16_t HD3c = payload[10];
65  uint16_t HD3d = payload[11];
66 
67  //Check Format
68  if(GetHexBits(HD1a, 12, 15) != 9) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD1a are incorrect"; }
69  if(GetHexBits(HD1b, 12, 15) != 9) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD1b are incorrect"; }
70  if(GetHexBits(HD1c, 12, 15) != 9) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD1c are incorrect"; }
71  if(GetHexBits(HD1c, 0, 11) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD1c are incorrect"; }
72  if(GetHexBits(HD1d, 12, 15) != 9) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD1d are incorrect"; }
73  if(GetHexBits(HD2a, 12, 15) != 10) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD2a are incorrect"; }
74  if(GetHexBits(HD2a, 0, 11) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD2a are incorrect"; }
75  if(GetHexBits(HD2b, 12, 15) != 10) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD2b are incorrect"; }
76  if(GetHexBits(HD2c, 12, 15) != 10) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD2c are incorrect"; }
77  if(GetHexBits(HD2c, 11, 11) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD2c are incorrect"; }
78  if(GetHexBits(HD2d, 12, 15) != 10) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD2d are incorrect"; }
79  if(GetHexBits(HD3a, 9, 14) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD3a are incorrect"; }
80  if(GetHexBits(HD3a, 15, 15) != 1) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD3a are incorrect"; }
81  if(GetHexBits(HD3b, 11, 15) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD3b are incorrect"; }
82  if(GetHexBits(HD3c, 11, 15) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD3c are incorrect"; }
83  if(GetHexBits(HD3d, 11, 15) != 0) { errors += 1; edm::LogError("L1T|EMTF") << "Format identifier bits in HD3d are incorrect"; }
84 
85  return errors;
86 
87  }
88 
89 
91 
92  // std::cout << "Inside EMTFBlockHeaders.cc: unpack" << std::endl;
93 
94  // Get the payload for this block, made up of 16-bit words (0xffff)
95  // Format defined in MTF7Payload::getBlock() in src/Block.cc
96  // payload[0] = bits 0-15, payload[1] = 16-31, payload[3] = 32-47, etc.
97  auto payload = block.payload();
98 
99  // Check Format of Payload
100  l1t::emtf::AMC13Header AMC13Header_;
101  l1t::emtf::MTF7Header MTF7Header_;
102  l1t::emtf::EventHeader EventHeader_;
103  for (int err = 0; err < checkFormat(block); err++) EventHeader_.add_format_error();
104 
105  // Assign payload to 16-bit words
106  uint16_t HD1a = payload[0];
107  uint16_t HD1b = payload[1];
108  // uint16_t HD1c = payload[2];
109  uint16_t HD1d = payload[3];
110  // uint16_t HD2a = payload[4];
111  uint16_t HD2b = payload[5];
112  uint16_t HD2c = payload[6];
113  uint16_t HD2d = payload[7];
114  uint16_t HD3a = payload[8];
115  uint16_t HD3b = payload[9];
116  uint16_t HD3c = payload[10];
117  uint16_t HD3d = payload[11];
118 
119  // res is a pointer to a collection of EMTFDaqOut class objects
120  // There is one EMTFDaqOut for each MTF7 (60 deg. sector) in the event
122  res = static_cast<EMTFCollections*>(coll)->getEMTFDaqOuts();
123 
124  EMTFDaqOut EMTFDaqOut_;
125  res->push_back(EMTFDaqOut_);
126  int iOut = res->size() - 1;
127 
129  // Unpack the AMC13 header information
131 
132  if ( (res->at(iOut)).HasAMC13Header() == true )
133  { (res->at(iOut)).add_format_error(); edm::LogError("L1T|EMTF") << "Why is there already an AMC13Header object?"; goto write_AMC13; }
134 
135  // TODO: Write functions in interface/AMC13Spec.h (as in AMCSpec.h) to extract all AMC13 header and trailer info
136  // TODO: Edit interface/Block.h to have a amc13() function similar to amc()
137 
138  // AMC13Header_.set_orn( block.amc13().get() ) { orn = bits; };
139  // AMC13Header_.set_lv1_id( block.amc13().get() ) { lv1_id = bits; };
140  // AMC13Header_.set_bx_id( block.amc13().get() ) { bx_id = bits; };
141  // AMC13Header_.set_source_id( block.amc13().get() ) { source_id = bits; };
142  // AMC13Header_.set_evt_ty( block.amc13().get() ) { evt_ty = bits; };
143  // AMC13Header_.set_fov( block.amc13().get() ) { fov = bits; };
144  // AMC13Header_.set_ufov( block.amc13().get() ) { ufov = bits; };
145  // AMC13Header_.set_res( block.amc13().get() ) { res = bits; };
146  // AMC13Header_.set_namc( block.amc13().get() ) { namc = bits; };
147  // AMC13Header_.set_h( block.amc13().get() ) { h = bits; };
148  // AMC13Header_.set_x( block.amc13().get() ) { x = bits; };
149  // AMC13Header_.set_dataword(uint64_t bits) { dataword = bits; };
150 
151  write_AMC13:
152 
153  (res->at(iOut)).set_AMC13Header(AMC13Header_);
154 
156  // Unpack the MTF7 header information
158 
159  if ( (res->at(iOut)).HasMTF7Header() == true )
160  { (res->at(iOut)).add_format_error(); edm::LogError("L1T|EMTF") << "Why is there already an MTF7Header object?"; goto write_MTF7; }
161 
162  // AMC header info defined in interface/AMCSpec.h
163  MTF7Header_.set_amc_number ( block.amc().getAMCNumber() );
164  MTF7Header_.set_bx_id ( block.amc().getBX() );
165  MTF7Header_.set_orbit_number ( block.amc().getOrbitNumber() );
166  MTF7Header_.set_board_id ( block.amc().getBoardID() );
167  MTF7Header_.set_lv1_id ( block.amc().getLV1ID() );
168  MTF7Header_.set_data_length ( block.amc().getSize() );
169  MTF7Header_.set_user_id ( block.amc().getUserData() );
170  // MTF7Header_.set_dataword(uint64_t bits) { dataword = bits; };
171 
172  write_MTF7:
173 
174  (res->at(iOut)).set_MTF7Header(MTF7Header_);
175 
177  // Unpack the Event Record header information
179 
180  if ( (res->at(iOut)).HasEventHeader() == true )
181  { (res->at(iOut)).add_format_error(); edm::LogError("L1T|EMTF") << "Why is there already an EventHeader object?"; goto write_Event; }
182  if (EventHeader_.Format_Errors() > 0) goto write_Event;
183 
184  EventHeader_.set_l1a ( GetHexBits(HD1a, 0, 11, HD1b, 0, 11) );
185  EventHeader_.set_l1a_BXN ( GetHexBits(HD1d, 0, 11) );
186  EventHeader_.set_sp_TS ( GetHexBits(HD2b, 8, 11) );
187  EventHeader_.set_endcap ( GetHexBits(HD2b, 11, 11) ? -1 : 1 );
188  EventHeader_.set_sector ( GetHexBits(HD2b, 8, 10) + 1 );
189  EventHeader_.set_sp_ersv ( GetHexBits(HD2b, 5, 7) );
190  EventHeader_.set_sp_addr ( GetHexBits(HD2b, 0, 4) );
191  EventHeader_.set_tbin ( GetHexBits(HD2c, 8, 10) );
192  EventHeader_.set_ddm ( GetHexBits(HD2c, 7, 7) );
193  EventHeader_.set_spa ( GetHexBits(HD2c, 6, 6) );
194  EventHeader_.set_rpca ( GetHexBits(HD2c, 5, 5) );
195  EventHeader_.set_skip ( GetHexBits(HD2c, 4, 4) );
196  EventHeader_.set_rdy ( GetHexBits(HD2c, 3, 3) );
197  EventHeader_.set_bsy ( GetHexBits(HD2c, 2, 2) );
198  EventHeader_.set_osy ( GetHexBits(HD2c, 1, 1) );
199  EventHeader_.set_wof ( GetHexBits(HD2c, 0, 0) );
200  EventHeader_.set_me1a ( GetHexBits(HD2d, 0, 11) );
201  EventHeader_.set_me1b ( GetHexBits(HD3a, 0, 8) );
202  EventHeader_.set_me2 ( GetHexBits(HD3b, 0, 10) );
203  EventHeader_.set_me3 ( GetHexBits(HD3c, 0, 10) );
204  EventHeader_.set_me4 ( GetHexBits(HD3d, 0, 10) );
205  // EventHeader_.set_dataword(uint64_t bits) { dataword = bits; };
206 
207  write_Event:
208 
209  (res->at(iOut)).set_EventHeader(EventHeader_);
210 
211  // Finished with unpacking headers
212  return true;
213 
214  } // End bool HeadersBlockUnpacker::unpack
215 
216  // bool HeadersBlockPacker::pack(const Block& block, UnpackerCollections *coll) {
217  // std::cout << "Inside HeadersBlockPacker::pack" << std::endl;
218  // return true;
219  // } // End bool HeadersBlockPacker::pack
220 
221  } // End namespace emtf
222  } // End namespace stage2
223 } // End namespace l1t
224 
226 // DEFINE_L1T_PACKER(l1t::stage2::HeadersBlockPacker);
void set_endcap(int bits)
Definition: EventHeader.h:34
void set_lv1_id(int bits)
Definition: MTF7Header.h:35
void set_sp_TS(int bits)
Definition: EventHeader.h:33
void set_orbit_number(int bits)
Definition: MTF7Header.h:33
void set_skip(int bits)
Definition: EventHeader.h:42
void set_amc_number(int bits)
Definition: MTF7Header.h:31
void set_me3(int bits)
Definition: EventHeader.h:50
void set_bsy(int bits)
Definition: EventHeader.h:44
std::vector< uint32_t > payload() const
Definition: Block.h:57
#define DEFINE_L1T_UNPACKER(type)
Definition: Unpacker.h:31
void set_me4(int bits)
Definition: EventHeader.h:51
void set_sector(int bits)
Definition: EventHeader.h:35
void set_data_length(int bits)
Definition: MTF7Header.h:36
virtual int checkFormat(const Block &block)
void set_bx_id(int bits)
Definition: MTF7Header.h:32
int Format_Errors() const
Definition: EventHeader.h:76
void set_rpca(int bits)
Definition: EventHeader.h:41
void set_me1b(int bits)
Definition: EventHeader.h:48
void set_board_id(int bits)
Definition: MTF7Header.h:34
void set_spa(int bits)
Definition: EventHeader.h:40
void set_ddm(int bits)
Definition: EventHeader.h:39
void set_sp_addr(int bits)
Definition: EventHeader.h:37
std::vector< EMTFDaqOut > EMTFDaqOutCollection
Definition: EMTFDaqOut.h:130
void set_me1a(int bits)
Definition: EventHeader.h:47
void set_user_id(int bits)
Definition: MTF7Header.h:37
JetCorrectorParametersCollection coll
Definition: classes.h:10
void set_sp_ersv(int bits)
Definition: EventHeader.h:36
void set_osy(int bits)
Definition: EventHeader.h:45
void set_l1a(int bits)
Definition: EventHeader.h:31
void set_me2(int bits)
Definition: EventHeader.h:49
void set_rdy(int bits)
Definition: EventHeader.h:43
virtual bool unpack(const Block &block, UnpackerCollections *coll) override
void set_wof(int bits)
Definition: EventHeader.h:46
uint16_t GetHexBits(uint16_t word, uint16_t lowBit, uint16_t highBit)
void set_tbin(int bits)
Definition: EventHeader.h:38
void set_l1a_BXN(int bits)
Definition: EventHeader.h:32
void amc(const amc::Header &h)
Definition: Block.h:59