StRoot  1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
trgStructures_21.h
1 /*
2  * Header Name: trgStructures.h
3  * Header Number: x.y
4  * Package Name: All
5  * Created: z. milosevich 06Dec99
6  * Description: Global trigger structure header file.
7  * Contains definitions of trigger data structures
8  * History:
9  *
10  * 06Dec99 zm Created so offline can use and after modification for mod 8 DMA reads
11  * 08Dec99 zm Changed Event Descriptor Structure to previous length
12  * 03Feb00 zm Changed "ushort ZDCDSM[8]" to "BYTE ZDC[16]" in L0_DSM_Data structure
13  * 22Jul00 egj Added L0RegBytes and L0RegHeader to trgDataHeaders and TrgSumData.
14  * Also added Mult_Reg, ZDC_Reg and Spare_Reg to TrgSumData, making a
15  * total of 16 extra bytes. I compensated for this by removing 16 bytes,
16  * (4 uints) from L2Result, wich is currently unused.
17  * 08Dec00 JMN Changed char hdr[2] in TrgSummary to unsigned short, which is packed
18  * 25Feb01 JMN Redesigned and expanded abbreviations to full.
19  * 12Mar01 JMN Added additional changes from ZM
20  * 30May01 JMN NBNBNBNB Changed FORMAT version from 0x12 to 0x13
21  * 02Jun01 zm defined bit 6 in addBits info FIFO3 for L2.5 abort
22  * 27Jun01 JMN Added definition of number of bytes used in trigger summary headers
23  * 28Jun01 JMN Added definition of ADD_BITs
24  * 10Apr02 zm basic strawman for new structures with new TCU and added detectors
25  * 22May02 zm removed references to current non-existent trigger event header
26  * 24May02 zm incorporated eleanor's comments
27  * 24May02 zm the L0_DSM_Data instance changed from DSM to DSMdata to be able to compile on linux
28  * 19Jun02 zm removed or commented out references to TrgEvtHeader
29  * 05Aug02 JMN changes in event descriptor - moved filler word to end
30  * 15Aug02 HjC correct bytes for FPD
31  * 21Nov02 zm corrections based on eleanor's email: L0 layout for bunch xing,
32  * special and fpd elements; fpd broken down for east/west nort/south
33  * vs top/bottom and layer 1 or 0;
34  * also finished XXX_DATA_OFFSET and RAW_XXX_LEN for passing data from
35  * dsm
36  * 30Aug03 JMN Added RAW_MAX_LEN being maximum length possible in chain block transfer
37  * 14Sep03 JMN Added new dsmMemcpy2Buf
38  * 02Nov03 JMN Modified dsmMemcpy2Buf to ensure dsmData is 8-byte aligned.
39  * 04Nov03 EGJ Modified RawTrgDet to add in ZDCSMD[32]
40  */
41 
42 #ifndef trgStructures_h
43 #define trgStructures_h
44 
45 #define MAX_L0_DATA_BLOCKS 11 /* Maximum number of L0 Data Blocks: current + npre + npost */
46 #define MAX_RAW_DATA_BLOCKS 11 /* Maximum number of Raw Data Blocks: current + npre + npost */
47 #define FORMAT_VERSION 0x21 /* Format Version number for trigger data */
48 #define EV_DESC_LEN sizeof(EvtDescData) /* Number of bytes in event descriptor */
49 #define L0DSM_DATA_LEN sizeof(L0_DSM_Data) /* Size of data block in L0 DSM Tree */
50 #define RAW_DET_DATA_LEN sizeof(RawTrgDet) /* Size of Raw Detector Data from CTB, MWC with headers */
51 #define TRG_SUM_LEN sizeof(TrgSumData) /* Number of bytes in the trigger summary for DAQ with headers */
52 
53 #define L1_DATA_LEN (EV_DESC_LEN+TRG_SUM_LEN) /* Size of data passed from L1ANA to L2 */
54 #define TRG_EVT_LEN (L1_DATA_LEN+(MAX_RAW_DATA_BLOCKS*RAW_DET_DATA_LEN)) /* Max size of a trigger event */
55 #define TDI_EVT_LEN (EV_DESC_LEN+TRG_SUM_LEN+(MAX_RAW_DATA_BLOCKS*RAW_DET_DATA_LEN)) /* size of event sent to TDI */
56 
57 #define L0_SUM_LEN 148 /* Number of bytes in L0 Summary + Header */
58 #define L1_SUM_LEN 132 /* Number of bytes in L1 Summary + Header */
59 #define L2_SUM_LEN 116 /* Number of bytes in L2 Summary + Header */
60 #define L0_REG_LEN 16 /* Number of bytes in L0 Register + Header */
61 
62 #define RAW_MAX_LEN 272 /* Maximum length of any Chain Block Transfer */
63 //#define CTB_DATA_OFFSET 8 /* Number of bytes CTB Raw data is offset in raw trigger structure */
64 //#define RAW_CTB_LEN 256 /* Number of bytes in raw CTB DSMs */
65 //#define MWC_DATA_OFFSET 272 /* Number of bytes MWC Raw data is offset in raw trigger structure */
66 //#define RAW_MWC_LEN 128 /* Number of bytes in raw CTB DSMs */
67 //#define BCE_DATA_OFFSET 408 /* Number of bytes BMC Raw data is offset in raw trigger structure */
68 //#define RAW_BCE_LEN 240
69 //#define BCW_DATA_OFFSET 648
70 //#define RAW_BCW_LEN 240
71 //#define BC1_DATA_OFFSET 888
72 //#define RAW_BC1_LEN 96
73 //#define EEC_DATA_OFFSET 992
74 //#define RAW_EEC_LEN 176
75 //#define FPE_DATA_OFFSET 1176 /* everything after this will have to be re-done */
76 //#define RAW_FPE_LEN 208
77 //#define FPW_DATA_OFFSET 1384
78 //#define RAW_FPW_LEN 208
79 //#define BBC_DATA_OFFSET 1600
80 //#define RAW_BBC_LEN 176 /* Number of bytes in BBC and ZDC raw data structures */
81 
82 
83 #define ADD_BIT_PILEUP 0 /* Contamination/Pileup bit in event descriptor add-bits */
84 #define ADD_BIT_FORCE 5 /* Force store of this event */
85 #define ADD_BIT_L2_5 6 /* Level 2.5 abort */
86 #define ADD_BIT_SIM 7 /* Simulated event - used by DAQ */
87 
88 /********** Trigger Structures ***********/
89 
90 /* Event Descriptor Data Structures */
91 
92 
93 typedef struct {
94  unsigned short TCUdataBytes;
95  char TCUEvtDesc;
96  unsigned char TrgDataFmtVer;
97  unsigned int bunchXing_hi;
98  unsigned int bunchXing_lo; /* Two parts of RHIC bunch crossing number */
99  unsigned short actionWdDetectorBitMask; /* from Fifo 1 */
100  unsigned char actionWdTrgCommand; /* from Fifo 1 */
101  unsigned char actionWdDaqCommand; /* from Fifo 1 */
102  unsigned short TrgToken; /* from Fifo 2 */
103  unsigned short addBits; /* from Fifo 2 - bit 0=Contamination; bit 6=L2.5 abort; bit 7=1 is fake data */
104  unsigned short DSMInput; /* from Fifo 3 */
105  unsigned short externalBusy; /* from Fifo 3 */
106  unsigned short modifiedBusyStatus; /* from Fifo 4 */
107  unsigned short physicsWord; /* from Fifo 4 */
108  unsigned short TriggerWord; /* from Fifo 5 */
109  unsigned short DSMAddress; /* from Fifo 6 */
110  unsigned short contaminationBusyStatus; /* from Fifo 6 */
111  unsigned short npre; /* pre value for detector raw data */
112  unsigned short npost; /* post value for detector raw data */
113  unsigned short dummy; /* dummy - filler */
114 } EvtDescData; /* 40 bytes total */
115 
116 /* Trigger Summary Data Structures */
117 
118 /* L0 DSM data structures */
119 
120 typedef struct {
121  unsigned short CPA[32]; /* Contents of 4 CTB+MWC DSM Input Buffers (IB's) - coarse pixel array*/
122  unsigned short quadDSM[8]; /* Contents of 1 CTB+MWC DSM IB - outputs of previous 4 */
123  unsigned short lastDSM[8]; /* Contents of last DSM IB - results of all DSM trees */
124  unsigned short VTX[8]; /* Separate ZDC and BBC DSMs have been replaced with this one */
125  unsigned short EMC[8]; /* Contents of 1 EMC IB - results of separate BEMC and EEMC DSMs */
126  unsigned short BCdata[16]; /* Contents of 2 Bunch Crossing DSMs IB's */
127  unsigned short specialTriggers[8]; /* Contents of 1 Special Trigger DSM - all the special trigger requests */
128  unsigned short FPD[8]; /* Contents of 1 FPD IB - we are installing this DSM this year but it */
129 } L0_DSM_Data; /* 192 bytes total */
130 
131 
132 /* Summary data */
133 
134 typedef struct {
135  unsigned short TrgSumBytes;
136  unsigned short TrgSumHeader;
137  unsigned int L1Sum[2]; /* L1 Summary */
138  unsigned int L2Sum[2]; /* L2 Summary */
139  unsigned short L0SumBytes;
140  unsigned short L0SumHeader;
141  L0_DSM_Data DSMdata; /* L0 DSM Data from DSM Tree */
142  unsigned short L1SumBytes;
143  unsigned short L1SumHeader;
144  unsigned int L1Result[32]; /* Result from L1 CPU */
145  unsigned short L2SumBytes;
146  unsigned short L2SumHeader;
147  unsigned int L2Result[32]; /* Result from L2 CPU */
148 } TrgSumData; /* 480 bytes total */
149 
150 /* Data structure passed between L1ANA and L2 */
151 
152 typedef struct {
153  EvtDescData EvtDesc; /* L1 Event Descriptor Data */
154  TrgSumData TrgSum; /* Summary data */
155 } L1dataType; /* 520 bytes */
156 
157 /* Raw Trigger Detector data structures */
158 
159 typedef struct {
160  unsigned short RawDetBytes;
161  char RawDetHeader[2];
162  unsigned short CTBdataBytes;
163  char CTBdataHeader[2];
164  unsigned char CTB[256]; /* CTB raw data */
165  unsigned short MWCdataBytes;
166  char MWCdataHeader[2];
167  unsigned int MWCfiller; /* Dummy to bring header to mod 8 */
168  unsigned char MWC[128]; /* MWC raw data */
169  unsigned short BEMCdataBytes;
170  char BEMCdataHeader[2];
171  unsigned int BEMCfiller; /* Dummy to bring header to mod 8 */
172  unsigned char BEMCEast[240]; /* next year there will be 15 DSMs covering the East half, all in one crate */
173  unsigned char BEMCWest[240]; /* this year there will be 15 DSMs covering the West half, all in one crate */
174  unsigned short BEMClayer1[48]; /* there will be 6 DSMs at layer1 even if only 3 of them have input this year*/
175  unsigned short EEMCdataBytes;
176  char EEMCdataHeader[2];
177  unsigned int EEMCfiller; /* Dummy to bring header to mod 8 */
178  unsigned short EEMClayer1[16]; /* the two layer1 DSMs are at the LHS of the crate so they get read first */
179  unsigned char EEMC[144]; /* next there are the 9 layer0 DSMs, of which only 4-5 have input this year */
180  unsigned short FPDdataBytes;
181  char FPDdataHeader[2];
182  unsigned int FPDfiller; /* Dummy to bring header to mod 8 */
183  unsigned char FPDEastNSLayer0[112]; /* fpd east north/south layer 0 */
184  unsigned short FPDEastNSLayer1[8]; /* fpd east north/south layer 1 */
185  unsigned char FPDEastTBLayer0[64]; /* fpd east top/bottom layer 0 */
186  unsigned short FPDEastTBLayer1[8]; /* fpd east north/south layer 1 */
187  unsigned char FPDWestNSLayer0[112]; /* fpd east north/south layer 0 */
188  unsigned short FPDWestNSLayer1[8]; /* fpd east north/south layer 1 */
189  unsigned char FPDWestTBLayer0[64]; /* fpd east north/south layer 0 */
190  unsigned short FPDWestTBLayer1[8]; /* fpd east north/south layer 1 */
191  unsigned short BBCdataBytes;
192  char BBCdataHeader[2];
193  unsigned int BBCfiller; /* Dummy to bring header to mod 8 */
194  unsigned char BBC[80]; /* this stays as is */
195  unsigned short BBClayer1[16]; /* this is the layer1 DSM that feeds the VTX DSM */
196  unsigned char ZDCSMD[32]; /* this is the 2 layer0 DSM for the ZDC SMD detector */
197  unsigned char ZDC[16]; /* this is the original ZDC DSM */
198  unsigned short ZDClayer1[8]; /* this is the new layer1 ZDC DSM that also feeds the VTX DSM */
199 } RawTrgDet; /* 1776 bytes total */
200 
201 /* Trigger Event Structure */
202 
203 typedef struct {
204  EvtDescData EvtDesc; /* L1 Event Descriptor Data */
205  TrgSumData TrgSum; /* Summary data */
206  RawTrgDet rawTriggerDet[MAX_RAW_DATA_BLOCKS]; /* Raw Detector Data with pre and post History */
207 } TrgDataType; /* 19704 bytes */
208 
209 /* Data block for DSMs and L1 to pass to L2 via myriMemcpy2 */
210 
211 typedef struct {
212  int cur_token;
213  int Npre,Npost;
214  unsigned int localClock; /* Local DSM clock */
215  int numGroup; /* Number of DSMs in first group */
216  int numDSM; /* Total number of DSMs */
217  long long dsmData[RAW_MAX_LEN*MAX_RAW_DATA_BLOCKS/8]; /* Make this 8-byte aligned */
218 } dsmMemcpy2Buf;
219 
220 #endif
L0_DSM_Data
Definition: trgStructures-Jan2002.h:167
Generated by   doxygen 1.8.5