CDF_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 <PBI/Endianness.h>
|
Classes |
| struct | _CDF_esw_bf |
| | The summary word mapped out by bit fields. More...
|
| union | _CDF_esw |
| | Union of an unsigned 32-bit integer with the bit field representation of the first header summary word. More...
|
| struct | _CDF_esb |
| | Event Summary Block, binds together all the information used by the higher compression levels to format an event. More...
|
Typedefs |
|
typedef enum _CDF_ESW_S | CDF_ESW_S |
| | Typedef for enum _CDF_ESW_S.
|
|
typedef enum _CDF_ESW_V | CDF_ESW_V |
| | Typedef for enum _CDF_ESW_V.
|
|
typedef enum _CDF_ESW_M | CDF_ESW_M |
| | Typedef for enum _CDF_ESW_M.
|
|
typedef struct _CDF_esw_bf | CDF_esw_bf |
| | Typedef for struct _CDF_esw_bf.
|
|
typedef union _CDF_esw | CDF_esw |
| | Typedef for union _CDF_esw.
|
|
typedef struct _CDF_esb | CDF_esb |
Enumerations |
| enum | _CDF_ESW_S {
CDF_ESW_S_GSB_CXB = 1,
CDF_ESW_S_GSB_NOTACK = 1,
CDF_ESW_S_GSB_XCB = 1,
CDF_ESW_S_GSB = 3,
CDF_ESW_S_SEQUENCE = 0x11,
CDF_ESW_S_CXB_CALSTROBE = 0x01,
CDF_ESW_S_CXB_LATP_DST = 0x01,
CDF_ESW_S_CXB_MARKER = 0x01,
CDF_ESW_S_CXB_ABS_IDS = 0x01,
CDF_ESW_S_CXB_DGN_IDS = 0x01,
CDF_ESW_S_CXB_ERR_IDS = 0x01,
CDF_ESW_S_CXB_NOSUPPRESS = 0x01,
CDF_ESW_S_CXB_RANGE = 0x01,
CDF_ESW_S_CXB = 0x08,
CDF_ESW_S_LATP_DST = 0x04
} |
| | Defines the sizes of the first summary word bit fields. More...
|
| enum | _CDF_ESW_V {
CDF_ESW_V_GSB_CXB = 0x1f,
CDF_ESW_V_GSB_NOTACK = 0x1e,
CDF_ESW_V_GSB_XCB = 0x1d,
CDF_ESW_V_GSB = 0x1d,
CDF_ESW_V_SEQUENCE = 0x0c,
CDF_ESW_V_CXB_CALSTROBE = 0x0b,
CDF_ESW_V_CXB_LATP_DST = 0x0a,
CDF_ESW_V_CXB_MARKER = 0x09,
CDF_ESW_V_CXB_ABS_IDS = 0x08,
CDF_ESW_V_CXB_DGN_IDS = 0x07,
CDF_ESW_V_CXB_ERR_IDS = 0x06,
CDF_ESW_V_CXB_NOSUPPRESS = 0x05,
CDF_ESW_V_CXB_RANGE = 0x04,
CDF_ESW_V_CXB = 0x04,
CDF_ESW_V_LATP_DST = 0x00
} |
| | Defines the right justified shifts for the first summary word. More...
|
| enum | _CDF_ESW_M {
CDF_ESW_M_GSB_CXB,
CDF_ESW_M_GSB_NOTACK,
CDF_ESW_M_GSB_XCB,
CDF_ESW_M_GSB,
CDF_ESW_M_SEQUENCE,
CDF_ESW_M_CXB_CALSTROBE,
CDF_ESW_M_CXB_LATP_DST,
CDF_ESW_M_CXB_MARKER,
CDF_ESW_M_CXB_ABS_IDS,
CDF_ESW_M_CXB_DGN_IDS,
CDF_ESW_M_CXB_ERR_IDS,
CDF_ESW_M_CXB_NOSUPPRESS,
CDF_ESW_M_CXB_RANGE,
CDF_ESW_M_CXB,
CDF_ESW_M_LATP_DST
} |
| | 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: CDF_esb_def.h,v 1.3 2011/03/26 17:35:24 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
Defines the in place mask for the first summary word bit fields.
- Enumerator:
-
| CDF_ESW_M_GSB_CXB |
Configuration exception block is present |
| CDF_ESW_M_GSB_NOTACK |
Not tack bit value |
| CDF_ESW_M_GSB_XCB |
Indicates Extension block is present |
| CDF_ESW_M_GSB |
Optional Block Flags, in-place mask |
| CDF_ESW_M_SEQUENCE |
Event sequence number (17 bits) |
| CDF_ESW_M_CXB_CALSTROBE |
Reserved for future use |
| CDF_ESW_M_CXB_LATP_DST |
LATp address in not round robin |
| CDF_ESW_M_CXB_MARKER |
Marker field is not 0 |
| CDF_ESW_M_CXB_ABS_IDS |
Reserved for future use |
| CDF_ESW_M_CXB_DGN_IDS |
Diagnostic blocks are present |
| CDF_ESW_M_CXB_ERR_IDS |
Error block(s) are present |
| CDF_ESW_M_CXB_NOSUPPRESS |
Zero suppression is disabled |
| CDF_ESW_M_CXB_RANGE |
4-Range readout in effect |
| CDF_ESW_M_CXB |
Base of configuration exception field |
| CDF_ESW_M_LATP_DST |
LATp node address, present iff CXB_LATP_DST == 1 |
Defines the sizes of the first summary word bit fields.
- Enumerator:
-
| CDF_ESW_S_GSB_CXB |
Configuration exception block present |
| CDF_ESW_S_GSB_NOTACK |
NOT tack bit value |
| CDF_ESW_S_GSB_XCB |
Indicates another extension block |
| CDF_ESW_S_GSB |
Sizeof of Global Status Block |
| CDF_ESW_S_SEQUENCE |
Event sequence number (17 bits) |
| CDF_ESW_S_CXB_CALSTROBE |
CAL strobe bit |
| CDF_ESW_S_CXB_LATP_DST |
LATp address is not round robin |
| CDF_ESW_S_CXB_MARKER |
Marker field is not 0 |
| CDF_ESW_S_CXB_ABS_IDS |
Contributors that are absent |
| CDF_ESW_S_CXB_DGN_IDS |
Diagnostic blocks are present |
| CDF_ESW_S_CXB_ERR_IDS |
Error block(s) are present |
| CDF_ESW_S_CXB_NOSUPPRESS |
Zero suppression is disabled |
| CDF_ESW_S_CXB_RANGE |
4-Range readout in effect |
| CDF_ESW_S_CXB |
Configuration exception block, size |
| CDF_ESW_S_LATP_DST |
LATp node address, present iff CXB_LATP_DST == 1 |
Defines the right justified shifts for the first summary word.
- Enumerator:
-
| CDF_ESW_V_GSB_CXB |
Configuration exception block is present |
| CDF_ESW_V_GSB_NOTACK |
Not tack bit value |
| CDF_ESW_V_GSB_XCB |
Indicates another extension block |
| CDF_ESW_V_GSB |
Size of global status block |
| CDF_ESW_V_SEQUENCE |
Event sequence number (17 bits) |
| CDF_ESW_V_CXB_CALSTROBE |
CAL strobe bit |
| CDF_ESW_V_CXB_LATP_DST |
LATp address in not round robin |
| CDF_ESW_V_CXB_MARKER |
Marker field is not 0 |
| CDF_ESW_V_CXB_ABS_IDS |
Contributors that are absent |
| CDF_ESW_V_CXB_DGN_IDS |
Diagnostic block(s) are present |
| CDF_ESW_V_CXB_ERR_IDS |
Error block(s) are present |
| CDF_ESW_V_CXB_NOSUPPRESS |
Zero suppression is disabled |
| CDF_ESW_V_CXB_RANGE |
4-Range readout in effect |
| CDF_ESW_V_CXB |
Configuration exception block, base |
| CDF_ESW_V_LATP_DST |
LATp node address, present iff CXB_LATP_DST == 1 |
