StRoot: RTS/include/TRG/trgStructures-Jan2002.h Source File

00001 /***************************************************************************************/
00002 /* Header Name: trgStructures.h                                                        */
00003 /* Header Number: x.y                                                                  */
00004 /* Package Name: All                                                                   */
00005 /* Created: z. milosevich 06Dec99                                                      */
00006 /* Description: Global trigger structure header file.                                  */
00007 /*              Contains definitions of trigger data structures                        */
00008 /* History:                                                                            */
00009 /*                                                                                     */
00010 /*  06Dec99 zm  Created so offline can use and after modification for mod 8 DMA reads  */
00011 /*  08Dec99 zm  Changed Event Descriptor Structure to previous length                  */
00012 /*  03Feb00 zm  Changed "ushort ZDCDSM[8]" to "BYTE ZDC[16]" in L0_DSM_Data structure  */
00013 /*  22Jul00 egj Added L0RegBytes and L0RegHeader to trgDataHeaders and TrgSumData.     */
00014 /*              Also added Mult_Reg, ZDC_Reg and Spare_Reg to TrgSumData, making a     */
00015 /*              total of 16 extra bytes. I compensated for this by removing 16 bytes,  */
00016 /*              (4 uints) from L2Result, wich is currently unused.                     */
00017 /***************************************************************************************/
00018 #ifndef _TRG_STRUCTURES_H_
00019 #define _TRG_STRUCTURES_H_
00020 
00021 /* several shortcut definitions */
00022 
00023 #ifndef uint
00024 #define uint unsigned int
00025 #endif
00026 
00027 #ifndef ushort
00028 #define ushort unsigned short
00029 #endif
00030 
00031 #ifndef ulong
00032 #define ulong unsigned long
00033 #endif
00034 
00035 typedef unsigned char BYTE;
00036 typedef unsigned int  WORD;
00037 
00038 #define MAX_RAW_DATA_BLOCKS   11   /* Maximum number of Raw Data Blocks:  current + npre + npost */
00039                                
00040 #define FORMAT_VERSION   0x12                 /* Format Version number for trigger data */
00041 #define EVT_HEAD_LEN     sizeof(TrgEvtHeader) /* Trigger Event Header Length */
00042 #define EV_DESC_LEN      sizeof(EvtDescData)  /* Number of bytes in event descriptor */
00043 #define L0DSM_DATA_LEN   sizeof(L0_DSM_Data)  /* Size of data block in L0 DSM Tree */
00044 #define RAW_DET_DATA_LEN sizeof(RawTrgDet)    /* Size of Raw Detector Data from CTB, MWC with headers */
00045 #define TRG_SUM_LEN      sizeof(TrgSumData)   /* Number of bytes in the trigger summary for DAQ with headers */
00046 
00047 #define L1_DATA_LEN  (EVT_HEAD_LEN+EV_DESC_LEN+TRG_SUM_LEN)   /* Size of data passed from L1ANA to L1DC */ 
00048 
00049 #define TRG_EVT_LEN  (L1_DATA_LEN+(MAX_RAW_DATA_BLOCKS*RAW_DET_DATA_LEN))  /* Max size of a trigger event */
00050 #define TDI_EVT_LEN  (EV_DESC_LEN+TRG_SUM_LEN+(MAX_RAW_DATA_BLOCKS*RAW_DET_DATA_LEN)) /* size of event sent to TDI */
00051 
00052 #define CTB_DATA_OFFSET        8  /* Number of bytes CTB Raw data is offset in raw trigger structure */
00053 #define RAW_CTB_LEN          256  /* Number of bytes in raw CTB DSMs */
00054 
00055 /********** trigger structures ***********/
00056 
00057 /*
00058  *
00059  *  Trigger Data Headers
00060  *
00061  */
00062 
00063 typedef struct {
00064   unsigned short TrgDataBytes;
00065   unsigned short TrgFiller;
00066   unsigned short TCUdataBytes;
00067   BYTE           TrgDataFmtVer;
00068   char           TCUEvtDesc;
00069   unsigned short TrgSumBytes;
00070   char           TrgSumHeader[2];
00071   unsigned short L0SumBytes;
00072   char           L0SumHeader[2];
00073   unsigned short L1SumBytes;
00074   char           L1SumHeader[2];
00075   unsigned short L2SumBytes;
00076   char           L2SumHeader[2];
00077   unsigned short L0RegBytes;
00078   char           L0RegHeader[2];
00079   unsigned short RawDetBytes;
00080   char           RawDetHeader[2];
00081   unsigned short CTBdataBytes;
00082   char           CTBdataHeader[2];
00083   unsigned short MWCdataBytes;
00084   char           MWCdataHeader[2];
00085   unsigned short EMCdataBytes;
00086   char           EMCdataHeader[2];
00087 } trgDataHeaders;
00088 
00089 /* Trigger Event Header */
00090 
00091 typedef struct {
00092   unsigned short TrgDataBytes;  /* total bytes in trigger data */
00093   unsigned short TrgFiller;
00094 } TrgEvtHeader;     /* 4 Bytes total */
00095 
00096 /* Event Descriptor Data Structures */
00097 
00098 typedef union {      /*  The contents of Info Fifo 1 */
00099   struct {
00100     unsigned short      DetectorsIn;     /* Trigger Token */
00101     BYTE                TRG_DAQ_cmd;  /* Trigger Word */  
00102     BYTE                empty8 ;
00103   } FIFO1;
00104   unsigned long      fifo1;
00105 } Info1;             /* 32 bits total */
00106 
00107 typedef union {      /*  The contents of Info Fifo 1 */
00108   struct {
00109     unsigned short   token ;     /* Trigger Token */
00110     unsigned short   empty16 ;
00111   } FIFO2;
00112   unsigned long      fifo;
00113 } Info2;             /* 32 bits total */
00114 
00115 
00116 typedef union {      /* The contents of Info Fifo 2 */
00117   struct {
00118     unsigned short   DSMInput;      /*   Last DSM  */
00119     unsigned short   ExternalBusy;    /*   DSM address */
00120   } FIFO3;
00121   unsigned long      fifo;
00122 } Info3;             /* 32 bits total */
00123 
00124 typedef union {      /* The contents of Info Fifo 3 */
00125   struct {
00126     unsigned short   ModifiedBusy;      /* detector Busy Bits */
00127     unsigned short   PhysicsWord ;
00128   } FIFO4;
00129   unsigned long      fifo;
00130 } Info4;             /* 32 bits total */
00131 
00132 typedef union {      /* The contents of Info Fifo 3 */
00133   struct {
00134     unsigned short   TriggerWd ;
00135     unsigned short   addBits;           /* filler Bits - bit 0=pileup; bit 1=priority; bit 7=1 is fake data */
00136   } FIFO5;
00137   unsigned long      fifo;
00138 } Info5;             /* 32 bits total */
00139 
00140 typedef union {      /* The contents of Info Fifo 3 */
00141   struct {
00142     unsigned short      DSMAddress ;
00143     unsigned short      ContaminationBusy ;
00144   } FIFO6;
00145   unsigned long      fifo;
00146 } Info6;             /* 32 bits total */
00147 
00148 /* Data structure passed from L1CTL to L1ANA */
00149 
00150 typedef struct {
00151   unsigned short TCUdataBytes;
00152   char           TCUEvtDesc;
00153   BYTE           TrgDataFmtVer;
00154   uint           bunchXing_hi;
00155   uint           bunchXing_lo;   /* Two parts of RHIC bunch crossing number */
00156   Info1          TCU1;           /* TCU Info Fifo's */  
00157   Info2          TCU2;
00158   Info5          TCU5;
00159   ushort         npre;
00160   ushort         npost;          /* Dummy to bring total size of struct to modulo 8 bytes */
00161 } EvtDescData;          /* 28 bytes total */ 
00162 
00163 /* Trigger Summary  Data Structures */
00164 
00165 /* L0 DSM data structures */
00166 
00167 typedef struct {
00168   ushort             CPA[32];        /* Contents of 4 CTB+MWC DSM Input Buffers (IB's) - coarse pixel array*/
00169   ushort             quadDSM[8];     /* Contents of 1 CTB+MWC DSM IB - outputs of previous 4 */
00170   ushort             lastDSM[8];     /* Contents of last DSM IB - results of all DSM trees */
00171   BYTE               ZDC[16];        /* Contents of ZDC DSM IB - raw data from ZDC */
00172   ushort             BCdata[16];     /* Contents of 2 Bunch Crossing DSMs IB's */
00173 } L0_DSM_Data;          /* 144 bytes total */
00174 
00175 
00176 /* summary data */
00177 
00178 typedef struct {
00179   unsigned short TrgSumBytes;
00180   char           TrgSumHeader[2];
00181   uint           L1Sum[2];        /* L1 Summary */
00182   uint           L2Sum[2];        /* L2 Summary */
00183   unsigned short L0SumBytes;
00184   char           L0SumHeader[2];
00185   L0_DSM_Data    DSM;             /* L0 DSM Data from DSM Tree */
00186   unsigned short L1SumBytes;
00187   char           L1SumHeader[2];
00188   uint           L1Result[32];       /* Result from L1 CPU */
00189   unsigned short L2SumBytes;
00190   char           L2SumHeader[2];
00191   uint           L2Result[28];       /* Result from L2 CPU */
00192   unsigned short L0RegBytes;
00193   char           L0RegHeader[2];
00194   unsigned short Mult_Reg[3];        /* The 3 multiplcity thresholds */
00195   unsigned short ZDC_Reg[2];         /* The 2 ZDC thresholds */
00196   unsigned short Spare_Reg ;         /* A spare, brings total for Reg to 16 bytes */
00197 } TrgSumData;        /* 432 bytes total */
00198 
00199 
00200 /* Data structure passed between L1ANA and L1DC */
00201 
00202 typedef struct {
00203   TrgEvtHeader   TrgHead; 
00204   EvtDescData    EvtDesc;       /* L1 Event Descriptor Data */  
00205   TrgSumData     TrgSum;        /* summary data */
00206 } L1dataType;           /* 464 bytes */
00207   
00208 /* Raw Trigger detector data structures */
00209 
00210 typedef struct {
00211   unsigned short RawDetBytes;
00212   char           RawDetHeader[2];
00213   unsigned short CTBdataBytes;
00214   char           CTBdataHeader[2];
00215   BYTE           CTB[256];         /* CTB raw data */
00216   unsigned short MWCdataBytes;
00217   char           MWCdataHeader[2];
00218   unsigned long  MWCfiller;        /* dummy to bring header to mod 8 */
00219   BYTE           MWC[128];         /* MWC raw data */
00220   unsigned short EMCdataBytes;
00221   char           EMCdataHeader[2];
00222   unsigned long  EMCfiller;        /* dummy to bring header to mod 8 */
00223 } RawTrgDet;            /* 408 bytes total */
00224 
00225 /*  Trigger Event Structure */
00226 
00227 typedef struct {
00228   TrgEvtHeader   TrgHead; 
00229   EvtDescData    EvtDesc;       /* L1 Event Descriptor Data */  
00230   TrgSumData     TrgSum;        /* summary data */
00231   RawTrgDet      raw[MAX_RAW_DATA_BLOCKS]; /* raw Detector Data with pre and post History */
00232 } TrgDataType;          /* 4952 bytes */
00233 
00234 
00235 
00236 //struct TRGD {
00237 //      bankHeader bh ;
00238 //      EvtDescData desc ;
00239 //      TrgSumData sum ;
00240 //      RawTrgDet  raw[MAX_RAW_DATA_BLOCKS]; /* raw Detector Data with pre and post History */
00241 //}  ;
00242 
00243 
00244 #endif