GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QSE / V2-3-0 > qse / sun-gcc


Interface   Data Structures   File List   Data Fields   Globals  

QDF_esb_def.h File Reference

Maps out the event summary block. This block captures information global to the entire event and is packed, just like the GEM, TEM and AEM data, to form the output event. The difference is that this information is global to the event, not a particular contributor. More...

#include "EDS/EBF_esw.h"
#include "PBI/Endianness.h"

Classes

struct  _QDF_esw_bf
 The summary word mapped out by bit fields. More...
union  _QDF_esw
 Union of an unsigned 32-bit integer with the bit field representation of the first header summary word. More...
struct  _QDF_esbEvt
 Event Summary Block, binds together all the information used by the higher compression levels to format an event. More...
struct  _QDF_esbCtx
 Event Summary Block, decoding context. More...

Typedefs

typedef struct _QSE_ctx QSE_ctx
typedef struct _QDF_exc QDF_exc
typedef enum _QDF_ESW_S QDF_ESW_S
 Typedef for enum _QDF_ESW_S.
typedef enum _QDF_ESW_V QDF_ESW_V
 Typedef for enum _QDF_ESW_V.
typedef enum _QDF_ESW_M QDF_ESW_M
 Typedef for enum _QDF_ESW_M.
typedef struct
_QDF_esw_bf 
QDF_esw_bf
 Typedef for struct _QDF_esw_bf.
typedef union _QDF_esw QDF_esw
 Typedef for union _QDF_esw.
typedef struct
_QDF_esbEvt 
QDF_esbEvt
typedef struct
_QDF_esbCtx 
QDF_esbCtx
 Typedef for struct _QDF_esbEvt.

Enumerations

enum  _QDF_ESW_S {
  QDF_ESW_S_GSB_CXB = 1,
  QDF_ESW_S_GSB_NOTACK = 1,
  QDF_ESW_S_GSB_XCB = 1,
  QDF_ESW_S_GSB = 3,
  QDF_ESW_S_SEQUENCE = 0x11,
  QDF_ESW_S_CXB_CALSTROBE = 0x01,
  QDF_ESW_S_CXB_LATP_DST = 0x01,
  QDF_ESW_S_CXB_MARKER = 0x01,
  QDF_ESW_S_CXB_ABS_IDS = 0x01,
  QDF_ESW_S_CXB_DGN_IDS = 0x01,
  QDF_ESW_S_CXB_ERR_IDS = 0x01,
  QDF_ESW_S_CXB_NOSUPPRESS = 0x01,
  QDF_ESW_S_CXB_RANGE = 0x01,
  QDF_ESW_S_CXB = 0x08,
  QDF_ESW_S_RSVD = 0x04,
  QDF_ESW_S_LATP_DST = 4
}
 Defines the sizes of the first summary word bit fields. More...
enum  _QDF_ESW_V {
  QDF_ESW_V_GSB_CXB = 0x1f,
  QDF_ESW_V_GSB_NOTACK = 0x1e,
  QDF_ESW_V_GSB_XCB = 0x1d,
  QDF_ESW_V_GSB = 0x1d,
  QDF_ESW_V_SEQUENCE = 0x0c,
  QDF_ESW_V_CXB_CALSTROBE = 0x0b,
  QDF_ESW_V_CXB_LATP_DST = 0x0a,
  QDF_ESW_V_CXB_MARKER = 0x09,
  QDF_ESW_V_CXB_ABS_IDS = 0x08,
  QDF_ESW_V_CXB_DGN_IDS = 0x07,
  QDF_ESW_V_CXB_ERR_IDS = 0x06,
  QDF_ESW_V_CXB_NOSUPPRESS = 0x05,
  QDF_ESW_V_CXB_RANGE = 0x04,
  QDF_ESW_V_CXB = 0x04,
  QDF_ESW_V_RSVD = 0x00
}
 Defines the right justified shifts for the first summary word. More...
enum  _QDF_ESW_M {
  QDF_ESW_M_GSB_CXB,
  QDF_ESW_M_GSB_NOTACK,
  QDF_ESW_M_GSB_XCB,
  QDF_ESW_M_GSB,
  QDF_ESW_M_SEQUENCE,
  QDF_ESW_M_CXB_CALSTROBE,
  QDF_ESW_M_CXB_LATP_DST,
  QDF_ESW_M_CXB_MARKER,
  QDF_ESW_M_CXB_ABS_IDS,
  QDF_ESW_M_CXB_DGN_IDS,
  QDF_ESW_M_CXB_ERR_IDS,
  QDF_ESW_M_CXB_NOSUPPRESS,
  QDF_ESW_M_CXB_RANGE,
  QDF_ESW_M_CXB,
  QDF_ESW_M_RSVD
}
 Defines the in place mask for the first summary word bit fields. More...


Detailed Description

Maps out the event summary block. This block captures information global to the entire event and is packed, just like the GEM, TEM and AEM data, to form the output event. The difference is that this information is global to the event, not a particular contributor.

Author:
JJRussell - russell@slac.stanford.edu

   CVS $Id: QDF_esb_def.h,v 1.2 2007/04/08 22:40:55 russell Exp $

The summary header word is mapped out into the following major blocks

Block Present Field, this indicates whether certain optional major blocks are present

CPU Physical Id , this is used to identify the physical CPU that sourced the data. It used to index configuration information that may be CPU specific. This may be useful when merging events from multiple sources allowing one to associate a configuration, not with the instrument, not with the CPU as it should be.

CPU exceptions , This is an optional block indicating that something unusual happened in this event. This is usually a dynamic condition, such as the zero-suppress flag being disabled or 4-range readout or (more seriously, but harmless from a data packing viewpoint), one or more of the contributors has reported an error.


Enumeration Type Documentation

enum _QDF_ESW_M

Defines the in place mask for the first summary word bit fields.

Enumerator:
QDF_ESW_M_GSB_CXB  Configuration exception block is present
QDF_ESW_M_GSB_NOTACK  Not tack bit value
QDF_ESW_M_GSB_XCB  Indicates Extension block is present
QDF_ESW_M_GSB  Optional Block Flags, in-place mask
QDF_ESW_M_SEQUENCE  Event sequence number (17 bits)
QDF_ESW_M_CXB_CALSTROBE  Value of the CALSTROBE bit
QDF_ESW_M_CXB_LATP_DST  LATp address in not round robin
QDF_ESW_M_CXB_MARKER  Marker field is not 0
QDF_ESW_M_CXB_ABS_IDS  Reserved for future use
QDF_ESW_M_CXB_DGN_IDS  Diagnostic blocks are present
QDF_ESW_M_CXB_ERR_IDS  Error block(s) are present
QDF_ESW_M_CXB_NOSUPPRESS  Zero suppression is disabled
QDF_ESW_M_CXB_RANGE  4-Range readout in effect
QDF_ESW_M_CXB  Base of configuration exception field
QDF_ESW_M_RSVD  Unused

enum _QDF_ESW_S

Defines the sizes of the first summary word bit fields.

Enumerator:
QDF_ESW_S_GSB_CXB  Configuration exception block present
QDF_ESW_S_GSB_NOTACK  Not tack bit value
QDF_ESW_S_GSB_XCB  Indicates another extension block
QDF_ESW_S_GSB  Sizeof of Global Status Block
QDF_ESW_S_SEQUENCE  Event sequence number (17 bits)
QDF_ESW_S_CXB_CALSTROBE  Value of the CALSTROBE bit
QDF_ESW_S_CXB_LATP_DST  LATp address is not round robin
QDF_ESW_S_CXB_MARKER  Marker field is not 0
QDF_ESW_S_CXB_ABS_IDS  Contributors that are absent
QDF_ESW_S_CXB_DGN_IDS  Diagnostic blocks are present
QDF_ESW_S_CXB_ERR_IDS  Error block(s) are present
QDF_ESW_S_CXB_NOSUPPRESS  Zero suppression is disabled
QDF_ESW_S_CXB_RANGE  4-Range readout in effect
QDF_ESW_S_CXB  Configuration exception block, size
QDF_ESW_S_RSVD  Unused
QDF_ESW_S_LATP_DST  Technically not part of this word, but is used in the decode process

enum _QDF_ESW_V

Defines the right justified shifts for the first summary word.

Enumerator:
QDF_ESW_V_GSB_CXB  Configuration exception block is present
QDF_ESW_V_GSB_NOTACK  Not tack bit value
QDF_ESW_V_GSB_XCB  Indicates another extension block
QDF_ESW_V_GSB  Size of global status block
QDF_ESW_V_SEQUENCE  Event sequence number (17 bits)
QDF_ESW_V_CXB_CALSTROBE  Value of the CALSTROBE bit
QDF_ESW_V_CXB_LATP_DST  LATp address in not round robin
QDF_ESW_V_CXB_MARKER  Marker field is not 0
QDF_ESW_V_CXB_ABS_IDS  Contributors that are absent
QDF_ESW_V_CXB_DGN_IDS  Diagnostic block(s) are present
QDF_ESW_V_CXB_ERR_IDS  Error block(s) are present
QDF_ESW_V_CXB_NOSUPPRESS  Zero suppression is disabled
QDF_ESW_V_CXB_RANGE  4-Range readout in effect
QDF_ESW_V_CXB  Configuration exception block, base
QDF_ESW_V_RSVD  Unused


Generated on Thu Sep 2 14:54:54 2010 by  doxygen 1.5.3