StRoot: StDaqLib/TRG/trgStructures.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 /*  08Dec00 JMN Changed char hdr[2] in  TrgSummary to unsigned short, which is packed  */
00018 /*  25Feb01 JMN Redesigned and expanded abbreviations to full.                         */
00019 /*  12Mar01 JMN Added additional changes from ZM                                       */
00020 /*  30May01 JMN NBNBNBNB Changed FORMAT version from 0x12 to 0x13                      */
00021 /*  02Jun01 zm  defined bit 6 in addBits info FIFO3 for L2.5 abort                     */
00022 /*  27Jun01 JMN Added definition of number of bytes used in trigger summary headers    */
00023 /*  28Jun01 JMN Added definition of ADD_BITs                                           */
00024 /***************************************************************************************/
00025 
00026 #ifndef trgStructures_h
00027 #define trgStructures_h
00028 #define MAX_RAW_DATA_BLOCKS   11              /* Maximum number of Raw Data Blocks:  current + npre + npost */
00029 #define FORMAT_VERSION   0x13                 /* Format Version number for trigger data */
00030 #define EVT_HEAD_LEN     sizeof(TrgEvtHeader) /* Trigger Event Header Length */
00031 #define EV_DESC_LEN      sizeof(EvtDescData)  /* Number of bytes in event descriptor */
00032 #define L0DSM_DATA_LEN   sizeof(L0_DSM_Data)  /* Size of data block in L0 DSM Tree */
00033 #define RAW_DET_DATA_LEN sizeof(RawTrgDet)    /* Size of Raw Detector Data from CTB, MWC with headers */
00034 #define TRG_SUM_LEN      sizeof(TrgSumData)   /* Number of bytes in the trigger summary for DAQ with headers */
00035 
00036 #define L1_DATA_LEN  (EVT_HEAD_LEN+EV_DESC_LEN+TRG_SUM_LEN)   /* Size of data passed from L1ANA to L1DC */ 
00037 #define TRG_EVT_LEN  (L1_DATA_LEN+(MAX_RAW_DATA_BLOCKS*RAW_DET_DATA_LEN))  /* Max size of a trigger event */
00038 #define TDI_EVT_LEN  (EV_DESC_LEN+TRG_SUM_LEN+(MAX_RAW_DATA_BLOCKS*RAW_DET_DATA_LEN)) /* size of event sent to TDI */
00039 
00040 #define L0_SUM_LEN           148              /* Number of bytes in L0 Summary + Header */
00041 #define L1_SUM_LEN           132              /* Number of bytes in L1 Summary + Header */
00042 #define L2_SUM_LEN           116              /* Number of bytes in L2 Summary + Header */
00043 #define L0_REG_LEN            16              /* Number of bytes in L0 Register + Header */
00044 
00045 #define CTB_DATA_OFFSET        8              /* Number of bytes CTB Raw data is offset in raw trigger structure */
00046 #define RAW_CTB_LEN          256              /* Number of bytes in raw CTB DSMs */
00047 #define MWC_DATA_OFFSET      272              /* Number of bytes MWC Raw data is offset in raw trigger structure */
00048 #define RAW_MWC_LEN          128              /* Number of bytes in raw CTB DSMs */
00049 #define BEMC_DATA_OFFSET     408              /* Number of bytes MWC Raw data is offset in raw trigger structure */
00050 #define RAW_BEMC_LEN         128              /* Number of bytes in raw CTB DSMs */
00051 
00052 #define ADD_BIT_PILEUP         0              /* Pileup bit in event descriptor add-bits */
00053 #define ADD_BIT_PRIORITY       1              /* Priority bit */
00054 #define ADD_BIT_FORCE          5              /* Force store of this event */
00055 #define ADD_BIT_L2_5           6              /* Level 2.5 abort */
00056 #define ADD_BIT_SIM            7              /* Simulated event - used by DAQ */
00057 /********** Trigger Structures ***********/
00058 
00059 /*
00060  *
00061  *  Trigger Data Headers
00062  *
00063  */
00064 
00065 typedef struct {
00066   unsigned short TrgDataBytes;
00067   unsigned short TrgFiller;
00068   unsigned short TCUdataBytes;
00069   unsigned char  TrgDataFmtVer;
00070   char           TCUEvtDesc;
00071   unsigned short TrgSumBytes;
00072   unsigned short TrgSumHeader;
00073   unsigned short L0SumBytes;
00074   unsigned short L0SumHeader;
00075   unsigned short L1SumBytes;
00076   unsigned short L1SumHeader;
00077   unsigned short L2SumBytes;
00078   unsigned short L2SumHeader;
00079   unsigned short L0RegBytes;
00080   unsigned short L0RegHeader;
00081   unsigned short RawDetBytes;
00082   char           RawDetHeader[2];
00083   unsigned short CTBdataBytes;
00084   char           CTBdataHeader[2];
00085   unsigned short MWCdataBytes;
00086   char           MWCdataHeader[2];
00087   unsigned short EMCdataBytes;
00088   char           EMCdataHeader[2];
00089 } trgDataHeaders;
00090 
00091 /* Trigger Event Header */
00092 
00093 typedef struct {
00094   unsigned short TrgDataBytes;                /* Total bytes in trigger data */
00095   unsigned short TrgFiller;
00096 } TrgEvtHeader;                               /* 4 Bytes total */
00097 
00098 /* Event Descriptor Data Structures */
00099 
00100 typedef union {                               /* The contents of Info Fifo 1 */
00101   struct {
00102     unsigned short   TrgToken;                /* Trigger Token */
00103     unsigned short   TrgActionWd;             /* Trigger Action Word */  
00104   } FIFO1;
00105   unsigned int       fifo1;
00106 } Info1;                                      /* 32 bits total */
00107 
00108 
00109 typedef union {                               /* The contents of Info Fifo 2 */
00110   struct {
00111     unsigned short   DSMInput;                /* Last DSM  */
00112     unsigned short   DSMAddress;              /* DSM address */
00113   } FIFO2;
00114   unsigned int       fifo2;
00115 } Info2;                                      /* 32 bits total */
00116 
00117 
00118 typedef union {                               /* The contents of Info Fifo 3 */
00119   struct {
00120     unsigned char    DetectorBusy;            /* Detector Busy Bits */
00121     unsigned char    addBits;                 /* Filler Bits - bit 0=pileup; bit 1=priority; bit 6=L2.5 abort; bit 7=1 is fake data */
00122     unsigned short   TriggerWd;               /* Trigger Word */
00123   } FIFO3;
00124   unsigned int       fifo3;
00125 } Info3;                                      /* 32 bits total */
00126 
00127 /* Data structure passed from L1CTL to L1ANA */
00128 
00129 typedef struct {
00130   unsigned short TCUdataBytes;
00131   char           TCUEvtDesc;
00132   unsigned char  TrgDataFmtVer;
00133   unsigned int   bunchXing_hi;
00134   unsigned int   bunchXing_lo;                /* Two parts of RHIC bunch crossing number */
00135   Info1          TCU1;                        /* TCU Info Fifo's */  
00136   Info2          TCU2;
00137   Info3          TCU3;
00138   unsigned short npre;
00139   unsigned short npost;                       /* Dummy to bring total size of struct to modulo 8 bytes */
00140 } EvtDescData;                                /* 28 bytes total */ 
00141 
00142 /* Trigger Summary Data Structures */
00143 
00144 /* L0 DSM data structures */
00145 
00146 typedef struct {
00147   unsigned short     CPA[32];                 /* Contents of 4 CTB+MWC DSM Input Buffers (IB's) - coarse pixel array*/
00148   unsigned short     quadDSM[8];              /* Contents of 1 CTB+MWC DSM IB - outputs of previous 4 */
00149   unsigned short     lastDSM[8];              /* Contents of last DSM IB - results of all DSM trees */
00150   unsigned char      ZDC[16];                 /* Contents of ZDC DSM IB - raw data from ZDC */
00151   unsigned short     BCdata[16];              /* Contents of 2 Bunch Crossing DSMs IB's */
00152 } L0_DSM_Data;                                /* 144 bytes total */
00153 
00154 /* Summary data */
00155 
00156 typedef struct {
00157   unsigned short TrgSumBytes;
00158   unsigned short TrgSumHeader;
00159   unsigned int   L1Sum[2];                    /* L1 Summary */
00160   unsigned int   L2Sum[2];                    /* L2 Summary */
00161   unsigned short L0SumBytes;
00162   unsigned short L0SumHeader;
00163   L0_DSM_Data    DSM;                         /* L0 DSM Data from DSM Tree */
00164   unsigned short L1SumBytes;
00165   unsigned short L1SumHeader;
00166   unsigned int   L1Result[32];                /* Result from L1 CPU */
00167   unsigned short L2SumBytes;
00168   unsigned short L2SumHeader;
00169   unsigned int   L2Result[28];                /* Result from L2 CPU */
00170   unsigned short L0RegBytes;
00171   unsigned short L0RegHeader;
00172   unsigned short Mult_Reg[3];                 /* The 3 multiplcity thresholds */
00173   unsigned short ZDC_Reg[2];                  /* The 2 ZDC thresholds */
00174   unsigned short Spare_Reg;                   /* A spare, brings total for Reg to 16 bytes */
00175 } TrgSumData;                                 /* 432 bytes total */
00176 
00177 /* Data structure passed between L1ANA and L1DC */
00178 
00179 typedef struct {
00180   TrgEvtHeader   TrgHead; 
00181   EvtDescData    EvtDesc;                     /* L1 Event Descriptor Data */  
00182   TrgSumData     TrgSum;                      /* Summary data */
00183 } L1dataType;                                 /* 464 bytes */
00184   
00185 /* Raw Trigger Detector data structures */
00186 
00187 typedef struct {
00188   unsigned short RawDetBytes;
00189   char           RawDetHeader[2];
00190   unsigned short CTBdataBytes;
00191   char           CTBdataHeader[2];
00192   unsigned char  CTB[256];                    /* CTB raw data */
00193   unsigned short MWCdataBytes;
00194   char           MWCdataHeader[2];
00195   unsigned int   MWCfiller;                   /* Dummy to bring header to mod 8 */
00196   unsigned char  MWC[128];                    /* MWC raw data */
00197   unsigned short EMCdataBytes;
00198   char           EMCdataHeader[2];
00199   unsigned int   EMCfiller;                   /* Dummy to bring header to mod 8 */
00200   unsigned char  BEMC[128];                   /* BEMC raw data */ /* NOTE!!!! THIS IS TEMPORARY _ MAY CHANGE */
00201 } RawTrgDet;                                  /* 536 bytes total */
00202 
00203 /*  Trigger Event Structure */
00204 
00205 struct TrgDataType {
00206   TrgEvtHeader   TrgHead; 
00207   EvtDescData    EvtDesc;                     /* L1 Event Descriptor Data */  
00208   TrgSumData     TrgSum;                      /* Summary data */
00209   RawTrgDet      RAW[MAX_RAW_DATA_BLOCKS];    /* Raw Detector Data with pre and post History */
00210 } ;                                /* 6360 bytes */
00211 
00212 #endif