trgStructures2008.h

/* Header Number: x.y                                                                 
* Package Name: All                                                                  
* Created: z. milosevich 06Dec99                                                     
* Description: Global trigger structure header file.                                 
*              Contains definitions of trigger data structures                       
* History:                                                                           
*                                                                                    
*  06Dec99 zm  Created so offline can use and after modification for mod 8 DMA reads 
*  08Dec99 zm  Changed Event Descriptor Structure to previous length                 
*  03Feb00 zm  Changed "ushort ZDCDSM[8]" to "BYTE ZDC[16]" in L0_DSM_Data structure 
*  22Jul00 egj Added L0RegBytes and L0RegHeader to trgDataHeaders and TrgSumData.    
*              Also added Mult_Reg, ZDC_Reg and Spare_Reg to TrgSumData, making a    
*              total of 16 extra bytes. I compensated for this by removing 16 bytes, 
*              (4 uints) from L2Result, wich is currently unused.                    
*  08Dec00 JMN Changed char hdr[2] in  TrgSummary to unsigned short, which is packed 
*  25Feb01 JMN Redesigned and expanded abbreviations to full.                        
*  12Mar01 JMN Added additional changes from ZM                                      
*  30May01 JMN NBNBNBNB Changed FORMAT version from 0x12 to 0x13                     
*  02Jun01 zm  defined bit 6 in addBits info FIFO3 for L2.5 abort                    
*  27Jun01 JMN Added definition of number of bytes used in trigger summary headers   
*  28Jun01 JMN Added definition of ADD_BITs                                          
*  10Apr02 zm  basic strawman for new structures with new TCU and added detectors
*  22May02 zm  removed references to current non-existent trigger event header
*  24May02 zm  incorporated eleanor's comments
*  24May02 zm  the L0_DSM_Data instance changed from DSM to DSMdata to be able to compile on linux
*  19Jun02 zm  removed or commented out references to TrgEvtHeader
*  05Aug02 JMN changes in event descriptor - moved filler word to end
*  15Aug02 HjC correct bytes for FPD
*  21Nov02 zm  corrections based on eleanor's email: L0 layout for bunch xing, 
*              special and fpd elements; fpd broken down for east/west nort/south 
*              vs top/bottom and layer 1 or 0;
*              also finished XXX_DATA_OFFSET and RAW_XXX_LEN for passing data from
*              dsm
*  30Aug03 JMN Added RAW_MAX_LEN being maximum length possible in chain block transfer
*  14Sep03 JMN Added new dsmMemcpy2Buf
*  02Nov03 JMN Modified dsmMemcpy2Buf to ensure dsmData is 8-byte aligned.
*  04Nov03 EGJ Modified RawTrgDet to add in ZDCSMD[32]
*  28Oct04 JMN Modified RawTrgDet to increased BBC storage from 80 to 96
*              Format version changed from 0x21 to 0x22
*  14Nov05 JMN Added source NodeID as first word of data buffer to L2
*  16Mar06 CWP Added offsets into L2Result
*  20Dec06 JMN Added changes:  L2Result increased to 64 ints,
*                              MWC name changed to MIX with 7 DSMs from MTD, VPD and TOF (112 bytes)
*                              FPE changed to 9 DSMs (144 bytes)
*                              FPW changed to 16 DSMs (256) bytes
*                              new array QQT installed after BBC
*              Block of commented OFFSETs and LEN removed.
*              Commented out xx_SUM_LEN where xx is L0, L1, L2; and L0_REG_LEN.  Unused?
*              Since these are significant changes, Format changed to 3.0
*  05Jan07 JMN Changed CPA[32] to MTD[8],VPD[8],CPA[16]
*  29Mar07 JMN Updated L2_Results offsets for CP
*  03Apr07 JMN Order MTD,VPD,CPA is changed to CPA,MTD,VPD to reflect order of DSMs in the L1 crate
*  07Oct07 JMN Added new TrgTowerTrnfer structure to define combined trigger and EMC data that will 
*              be transmitted from L2 to DAQ in from November 2007.
*  24Oct07 JMN Version number changed from 3.1 to 3.2 following re-arrangement of DSMs in MIX and
*              BBC crates.   Two extra DSMs for PP2PP are in the MIX crate ahead of TOF, so total
*              length increases by 32 bytes.
*  25Oct07 JMN A new set of L2_RESULTS offsets have been defined by Jan Balewski
*  27Oct07 JMN Added BTOW_LEN and ETOW_LEN
*  29Oct07 JMN Corrected above - removed 4 bytes for CRC not sent.
*  30Oct07 JMN Now added 4 byte hole to BTOW and ETOW lengths
*  13Nov07 JMN DAQ Headers no longer in EMC data - change definition of BTOW_LEN and ETOW_LEN
*              Pre/post data will not be sent to DAQ - change definition of TRG_TOWER_LEN
*/

#ifndef trgStructures2008_h
#define trgStructures2008_h

#define y8MAX_OFFSET            25              /* Maximum number of offsets in TrgTowerTrnfer OffsetBlock */
#define y8MAX_L0_DATA_BLOCKS    11              /* Maximum number of L0 Data Blocks:  current + npre + npost */
#define y8MAX_RAW_DATA_BLOCKS   11              /* Maximum number of Raw Data Blocks:  current + npre + npost */
#define y8FORMAT_VERSION      0x32              /* Format Version number for trigger data */
#define y8TRANSFER_VERSION    0x10              /* Format Version number for definition of TrgTowerTrnfer structure */
#define y8EV_DESC_LEN      sizeof(EvtDescData2008)  /* Number of bytes in event descriptor */
#define y8L0DSM_DATA_LEN   sizeof(L0_DSM_Data2008)  /* Size of data block in L0 DSM Tree */
#define y8RAW_DET_DATA_LEN sizeof(RawTrgDet2008)    /* Size of Raw Detector Data from DSM clients and QT boards */
#define y8TRG_SUM_LEN      sizeof(TrgSumData2008)   /* Number of bytes in the trigger summary for DAQ with headers */
#define y8BTOW_LEN   ((64 + 2 + 30*164)*2)      /* BTOW header + 4 byte hole + data */
#define y8ETOW_LEN   ((64 + 2 +  6*164)*2)      /* ETOW header + 4 byte hole + data */
#define y8L1_DATA_LEN  (y8EV_DESC_LEN+y8TRG_SUM_LEN) /* Size of data passed from L1ANA to L2 */ 
#define y8TRG_EVT_LEN  (y8L1_DATA_LEN+(y8MAX_RAW_DATA_BLOCKS*y8RAW_DET_DATA_LEN))       /* Max size of a trigger event */
#define y8TRG_TOWER_LEN (4 + (y8MAX_OFFSET*8) + y8L1_DATA_LEN + y8RAW_DET_DATA_LEN + y8BTOW_LEN + y8ETOW_LEN)  /* Max size of Trg/DAQ transfer data */

#define y8RAW_MAX_LEN          272              /* Maximum length of any Chain Block Transfer */

#define y8TRG_INDEX              0              /* Offset/length of trigger data:  TrgDataType */
#define y8BTOW_INDEX             1              /* Offset/length of BTOW data: */
#define y8ETOW_INDEX             2              /* Offset/length of ETOW data: */
#define y8RAW_TRG_INDEX          3              /* Block of 11 contiguous offsets to rawTriggerDet[] */

#define L2RESULTS_2008_OFFSET_TRG         0
#define L2RESULTS_2008_OFFSET_EMC_CHECK   1
#define L2RESULTS_2008_OFFSET_JPSI        2
#define L2RESULTS_2008_OFFSET_UPS         8
#define L2RESULTS_2008_OFFSET_EMC_PED     14
#define L2RESULTS_2008_OFFSET_GAMMA       20
#define L2RESULTS_2008_OFFSET_DIJET       32

#define y8ADD_BIT_PILEUP         0              /* Contamination/Pileup bit in event descriptor add-bits */
#define y8ADD_BIT_FORCE          5              /* Force store of this event */
#define y8ADD_BIT_L2_5           6              /* Level 2.5 abort */
#define y8ADD_BIT_SIM            7              /* Simulated event - used by DAQ */

/********** Trigger Structures ***********/

/* Event Descriptor Data Structures */

typedef struct {
unsigned short TCUdataBytes;
char           TCUEvtDesc;
unsigned char  TrgDataFmtVer;
unsigned int   bunchXing_hi;
unsigned int   bunchXing_lo;                /* Two parts of RHIC bunch crossing number */
unsigned short actionWdDetectorBitMask;     /* from Fifo 1 */
unsigned char  actionWdTrgCommand;          /* from Fifo 1 */
unsigned char  actionWdDaqCommand;          /* from Fifo 1 */  
unsigned short TrgToken;                    /* from Fifo 2 */
unsigned short addBits;                     /* from Fifo 2 - bit 0=Contamination; bit 6=L2.5 abort; bit 7=1 is fake data */
unsigned short DSMInput;                    /* from Fifo 3 */
unsigned short externalBusy;                /* from Fifo 3 */
unsigned short modifiedBusyStatus;          /* from Fifo 4 */
unsigned short physicsWord;                 /* from Fifo 4 */
unsigned short TriggerWord;                 /* from Fifo 5 */
unsigned short DSMAddress;                  /* from Fifo 6 */
unsigned short contaminationBusyStatus;     /* from Fifo 6 */
unsigned short npre;                        /* pre value for detector raw data */
unsigned short npost;                       /* post value for detector raw data */
unsigned short dummy;                       /* dummy - filler */
} EvtDescData2008;        /* 40 bytes total */ 

/* Trigger Summary Data Structures */

/* L0 DSM data structures */

typedef struct {
unsigned short     CPA[16];                 /* Contents of 2 CTB DSM Input Buffers (IB's) - coarse pixel array */
unsigned short     MTD[8];                  /* TAC values for MTD's MRPCs and overlapping CTB trays */
unsigned short     VPD[8];                  /* ADC & TAC values for VPD detectors*/
unsigned short     CTB[8];                  /* CTB ADC sums and topology for East & West combined */ 
unsigned short     lastDSM[8];              /* Contents of last DSM IB - results of all DSM trees */
unsigned short     VTX[8];                  /* Separate ZDC and BBC DSMs have been replaced with this one */
unsigned short     EMC[8];                  /* Contents of 1 EMC IB - results of separate BEMC and EEMC DSMs */
unsigned short     BCdata[16];              /* Contents of 2 Bunch Crossing DSMs IB's */       
unsigned short     specialTriggers[8];      /* Contents of 1 Special Trigger DSM - all the special trigger requests */
unsigned short     FPD[8];                  /* Contents of 1 FPD IB - we are installing this DSM this year but it */
} L0_DSM_Data2008;       /* 192 bytes total */


/* Summary data */

typedef struct {
unsigned short TrgSumBytes;
unsigned short TrgSumHeader;
unsigned int   L1Sum[2];          /* L1 Summary */
unsigned int   L2Sum[2];          /* L2 Summary */
unsigned short L0SumBytes;
unsigned short L0SumHeader;
L0_DSM_Data2008    DSMdata;           /* L0 DSM Data from DSM Tree */
unsigned short L1SumBytes;
unsigned short L1SumHeader;
unsigned int   L1Result[32];      /* Result from L1 CPU */
unsigned short L2SumBytes;
unsigned short L2SumHeader;
unsigned int   L2Result[64];      /* Result from L2 CPU. Increased by 128 bytes from version 3.0 */
} TrgSumData2008;     /* 608 bytes total */

/* Data structure passed between L1ANA and L2 */

typedef struct {
EvtDescData2008    EvtDesc;           /* L1 Event Descriptor Data */  
TrgSumData2008     TrgSum;            /* Summary data */
} L1dataType2008;     /* 648 bytes */

/* Raw Trigger Detector data structures */

typedef struct {
unsigned short RawDetBytes;
char           RawDetHeader[2];
unsigned short CTBdataBytes;
char           CTBdataHeader[2];
unsigned char  CTB[256];              /* CTB raw data. Data address must be 8-byte aligned for DMA transfer */
unsigned short MIXdataBytes;
char           MIXdataHeader[2];
unsigned int   MIXfiller;             /* Dummy to bring data address to mod 8 */
unsigned char  MTD[32];               /* MTD raw data from 2 DSMs */
unsigned char  VPD[64];               /* VPD raw data from 4 DSMs */
unsigned char  P2P[32];               /* P2P raw data from 2 DSMs */
unsigned char  TOF[16];               /* TOF raw data from 1 DSM  */
unsigned short BEMCdataBytes;
char           BEMCdataHeader[2];
unsigned int   BEMCfiller;            /* Dummy to bring data address to mod 8 */
unsigned char  BEMCEast[240];         /* next year there will be 15 DSMs covering the East half, all in one crate   */
unsigned char  BEMCWest[240];         /* this year there will be 15 DSMs covering the West half, all in one crate   */
unsigned short BEMClayer1[48];        /* there will be 6 DSMs at layer1 even if only 3 of them have input this year*/
unsigned short EEMCdataBytes;
char           EEMCdataHeader[2];
unsigned int   EEMCfiller;            /* Dummy to bring data address to mod 8 */
unsigned short EEMClayer1[16];        /* the two layer1 DSMs are at the LHS of the crate so they get read first    */
unsigned char  EEMC[144];             /* next there are the 9 layer0 DSMs, of which only 4-5 have input this year  */
unsigned short FPDdataBytes;
char           FPDdataHeader[2];
unsigned int   FPDfiller;             /* Dummy to bring data address to mod 8 */
unsigned char  FPDEastNSLayer0[112];  /* fpd east north/south layer 0  */
unsigned short FPDEastNSLayer1[8];    /* fpd east north/south layer 1  */
unsigned char  FPDEastTBLayer0[16];   /* fpd east top/bottom  layer 0  */
unsigned char  FPDW[256];             /* fpd west */
unsigned short BBCdataBytes;
char           BBCdataHeader[2];
unsigned int   BBCfiller;             /* Dummy to bring data address to mod 8 */
unsigned char  BBC[96];               /* increased from 80 to 96 for the addition of a DSM after layer 0 DSMs */
unsigned short BBClayer1[16];         /* this is the layer1 DSM that feeds the VTX DSM  */
unsigned char  ZDC[16];               /* this is the original ZDC DSM   */
unsigned short ZDClayer1[8];          /* this is the new layer1 ZDC DSM that also feeds the VTX DSM    */
unsigned char  ZDCSMD[32];            /* this is the 2 layer0 DSM for the ZDC SMD detector */
unsigned short QQTdataBytes;          /* this is new in version 3.0 for data from QT boards */
char           QQTdataHeader[2];
unsigned int   QQTfiller;             /* Dummy to bring data address to mod 8 */
unsigned int   QQTdata[1600];         /* data block for FMS.  New in version 3.0 */
} RawTrgDet2008;           /* 8200  bytes total */

/*  Trigger Event Structure */

struct TrgDataType2008 {
EvtDescData2008    EvtDesc;               /* L1 Event Descriptor Data : 40 bytes */  
TrgSumData2008     TrgSum;                /* Summary data: 608 bytes */
RawTrgDet2008      rawTriggerDet[y8MAX_RAW_DATA_BLOCKS];    /* Raw Detector Data with pre and post History: 11*8200 bytes */
} ;         /* 90848  bytes */

/*  Combined Trigger and EMC data block transferred from L2 to DAQ */

typedef struct {
  int offset;                           /* Offset (in bytes) from the start of TrgTowerTrnfer to data */
  int length;                           /* Length (in bytes) of data */
} TrgOfflen2008; 

typedef struct {
  int byteCount_Version;                    /* Transfer count in MS 24 bits; Version in LS 8 bits */
  TrgOfflen2008 OffsetBlock[y8MAX_OFFSET];  /* Offset/length into transferData */
  int transferData[1];                      /* Place holder array for trigger, BTOW and ETOW */
} TrgTowerTrnfer2008;                       /* Maximum possible length 103124 bytes */ 

#endif