EBF_esw.h File Reference

Describes the Event Summary Word put on each contributor by The Event Builder Module. More...

#include <EDS/EBF_ebw.h>
#include <PBI/Endianness.h>

Classes
struct	_EBF_esw_bf
	Defines the contributor's event summary word as a bit field structure. More...
union	_EBF_esw
	Defines the contributor's event summary word as a union between an unsigned int and the bit field structure. More...
Defines
#define	EBF_ESW_SEQ(_esw)
	Reassembles the sequence number in the event summary word.
Typedefs
typedef enum _EBF_ESW_S	EBF_ESW_S
	Typedef for enum EBF_ESW_S.
typedef enum _EBF_ESW_V	EBF_ESW_V
	Typedef for enum EBF_ESW_V.
typedef enum _EBF_ESW_M	EBF_ESW_M
	Typedef for enum EBF_ESW_M.
typedef struct _EBF_esw_bf	EBF_esw_bf
	Typedef for struct _EBF_esw_bf.
typedef union _EBF_esw	EBF_esw
	Typedef for union _EBF_esw.
Enumerations
enum	_EBF_ESW_S {   EBF_ESW_S_TRGPERR = 1,   EBF_ESW_S_SEQHI = 15,   EBF_ESW_S_MBZ = 4,   EBF_ESW_S_DGNBLK = 1,   EBF_ESW_S_ERRBLK = 1,   EBF_ESW_S_MARKER = 3,   EBF_ESW_S_SUPPRESS = 1,   EBF_ESW_S_RANGE = 1,   EBF_ESW_S_TACK = 1,   EBF_ESW_S_SEQLO = 2,   EBF_ESW_S_CALSTROBE = 1,   EBF_ESW_S_MB1 = 1 }
	Defines the sizes for each of the bit fields in the contributor's event summary header word. More...
enum	_EBF_ESW_V {   EBF_ESW_V_TRGPERR = 0,   EBF_ESW_V_SEQHI = SHIFT (EBF_ESW, TRGPERR),   EBF_ESW_V_MBZ = SHIFT (EBF_ESW, SEQHI),   EBF_ESW_V_DGNBLK = SHIFT (EBF_ESW, MBZ),   EBF_ESW_V_ERRBLK = SHIFT (EBF_ESW, DGNBLK),   EBF_ESW_V_MARKER = SHIFT (EBF_ESW, ERRBLK),   EBF_ESW_V_SUPPRESS = SHIFT (EBF_ESW, MARKER),   EBF_ESW_V_RANGE = SHIFT (EBF_ESW, SUPPRESS),   EBF_ESW_V_TACK = SHIFT (EBF_ESW, RANGE),   EBF_ESW_V_SEQLO = SHIFT (EBF_ESW, TACK),   EBF_ESW_V_CALSTROBE = SHIFT (EBF_ESW, SEQLO),   EBF_ESW_V_MB1 = SHIFT (EBF_ESW, CALSTROBE) }
	Defines the shift amount to right justify each of the bit fields in the contributor's event summary header word. More...
enum	_EBF_ESW_M {   EBF_ESW_M_TRGPERR = MASK (EBF_ESW, TRGPERR),   EBF_ESW_M_SEQHI = MASK (EBF_ESW, SEQHI),   EBF_ESW_M_MBZ = MASK (EBF_ESW, MBZ),   EBF_ESW_M_DGNBLK = MASK (EBF_ESW, DGNBLK),   EBF_ESW_M_ERRBLK = MASK (EBF_ESW, ERRBLK),   EBF_ESW_M_MARKER = MASK (EBF_ESW, MARKER),   EBF_ESW_M_SUPPRESS = MASK (EBF_ESW, SUPPRESS),   EBF_ESW_M_RANGE = MASK (EBF_ESW, RANGE),   EBF_ESW_M_TACK = MASK (EBF_ESW, TACK),   EBF_ESW_M_SEQLO = MASK (EBF_ESW, SEQLO),   EBF_ESW_M_CALSTROBE = MASK (EBF_ESW, CALSTROBE),   EBF_ESW_M_MB1 = MASK (EBF_ESW, MB1) }
	Defines the in place mask for each of the bit fields in the contributor's event summary header word. More...
Functions
static __inline unsigned int	EBF__eswSequence (unsigned int esw)
	Reassembles the sequence number in the event summary word.

---

Detailed Description

Describes the Event Summary Word put on each contributor by The Event Builder Module.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: EBF_esw.h,v 1.5 2011/03/25 22:16:54 russell Exp $

---

Define Documentation

#define EBF_ESW_SEQ

(

_esw

)

Value:

(((((_esw) & EBF_ESW_M_SEQHI) >> EBF_ESW_V_SEQHI) << EBF_ESW_S_SEQLO) |  \
   (((_esw) & EBF_ESW_M_SEQLO) >> EBF_ESW_V_SEQLO))

Reassembles the sequence number in the event summary word.

Returns:

The event sequence number

Parameters:

_esw

The event summary word, expressed as a 32-bit integer

Referenced by EBF__eswSequence().

---

Enumeration Type Documentation

enum _EBF_ESW_M

Defines the in place mask for each of the bit fields in the contributor's event summary header word.

Enumerator:

EBF_ESW_M_TRGPERR	Trigger parity error, mask
EBF_ESW_M_SEQHI	Bits 2-17 of the event number, mask
EBF_ESW_M_MBZ	Reserved, must be zero, mask
EBF_ESW_M_DGNBLK	Diagnostic block present, mask
EBF_ESW_M_ERRBLK	Error block present, mask
EBF_ESW_M_MARKER	Marker ID, used to demark events, mask
EBF_ESW_M_SUPPRESS	Zero suppression enable flag, mask
EBF_ESW_M_RANGE	Four range readout flag, mask
EBF_ESW_M_TACK	Internal bit used by triggering, mask
EBF_ESW_M_SEQLO	Bits 0-1 of the event number, mask
EBF_ESW_M_CALSTROBE	Internal bit used by triggering, mask
EBF_ESW_M_MB1	Reserved, must be one, mask

enum _EBF_ESW_S

Defines the sizes for each of the bit fields in the contributor's event summary header word.

Enumerator:

EBF_ESW_S_TRGPERR	Trigger parity error field size
EBF_ESW_S_SEQHI	Bits 2-17 of the event number
EBF_ESW_S_MBZ	Reserved, must be zero
EBF_ESW_S_DGNBLK	Diagnostic block present
EBF_ESW_S_ERRBLK	Error block present
EBF_ESW_S_MARKER	Marker ID, used to demark events
EBF_ESW_S_SUPPRESS	Zero suppression enable flage
EBF_ESW_S_RANGE	Four range readout flag
EBF_ESW_S_TACK	Internal bit used by triggering
EBF_ESW_S_SEQLO	Bits 0-1 of the event number
EBF_ESW_S_CALSTROBE	Internal bit used by triggering
EBF_ESW_S_MB1	Must be 1

enum _EBF_ESW_V

Defines the shift amount to right justify each of the bit fields in the contributor's event summary header word.

Enumerator:

EBF_ESW_V_TRGPERR	Trigger parity error, right shift
EBF_ESW_V_SEQHI	Bits 2-17, event number, right shift
EBF_ESW_V_MBZ	Reserved, must be zero, right shift
EBF_ESW_V_DGNBLK	Diagnostic block present, right shift
EBF_ESW_V_ERRBLK	Error block present, right shift
EBF_ESW_V_MARKER	Marker ID, right shift
EBF_ESW_V_SUPPRESS	Zero suppression enable flag, right shift
EBF_ESW_V_RANGE	Four range readout flag, right shift
EBF_ESW_V_TACK	Internal bit used by triggering,right shift
EBF_ESW_V_SEQLO	Bits 0-1 of the event number, right shift
EBF_ESW_V_CALSTROBE	Internal bit used by triggering, right shift
EBF_ESW_V_MB1	Reserved, must be one, right shift

---

Function Documentation

static __inline unsigned int EBF__eswSequence

(

unsigned int

esw

)

[static]

Reassembles the sequence number in the event summary word.

Returns:

The event sequence number

Parameters:

esw

The event summary word, expressed as a 32-bit integer

References EBF_ESW_SEQ.