TFC_trigger.h File Reference

Defines the contents of the 32 bit word returned by the TKR trigger formation routines. This word includes an 18 bit coincidence pattern, the start, length and type of the coincidence. The word is arranged such that negative values indicate no 6/6 or 7/8 coincidence. More...

#include <PBI/Endianness.h>

Classes
struct	_TFC_trigger_bf
	Structure to map out the bit fields of the trigger summary word. More...
union	_TFC_trigger
	Union of the bit field definition of the trigger coincidence results and plain 32 bit integers. More...
Typedefs
typedef enum _TFC_K_triggerType	TFC_K_triggerType
	Typedef for enum _TFC_K_triggerType.
typedef enum _TFC_S_trigger	TFC_S_trigger
	Typedef for enum _TFC_S_trigger.
typedef enum _TFC_V_trigger	TFC_V_trigger
	Typedef for enum _TFC_V_trigger.
typedef enum _TFC_M_trigger	TFC_M_trigger
	Typedef for enum _TFC_M_trigger.
typedef struct _TFC_trigger_bf	TFC_trigger_bf
	Typedef for struct _TFC_trigger_bf.
typedef union _TFC_trigger	TFC_trigger
	Typedef for union _TFC_trigger.
Enumerations
enum	_TFC_K_triggerType {   TFC_K_TRIGGER_TYPE_NONE = 0,   TFC_K_TRIGGER_TYPE_4_OF_4 = 1,   TFC_K_TRIGGER_TYPE_6_OF_6 = 2,   TFC_K_TRIGGER_TYPE_7_OF_8 = 3 }
	Enumerates the type of coincidence achieved. More...
enum	_TFC_S_trigger {   TFC_S_TRIGGER_LAYERS = 18,   TFC_S_TRIGGER_START = 5,   TFC_S_TRIGGER_LENGTH = 5,   TFC_S_TRIGGER_RSVD = 2,   TFC_S_TRIGGER_TYPE = 2 }
	Maps out the size of the trigger coincidence word. More...
enum	_TFC_V_trigger {   TFC_V_TRIGGER_LAYERS = 0,   TFC_V_TRIGGER_START = TFC_V_TRIGGER_LAYERS + TFC_S_TRIGGER_LAYERS,   TFC_V_TRIGGER_LENGTH = TFC_V_TRIGGER_START + TFC_S_TRIGGER_START,   TFC_V_TRIGGER_RSVD = TFC_V_TRIGGER_LENGTH + TFC_S_TRIGGER_LENGTH,   TFC_V_TRIGGER_TYPE = TFC_V_TRIGGER_RSVD + TFC_S_TRIGGER_RSVD }
	Defines the shift needed to right justify the field.
enum	_TFC_M_trigger {   TFC_M_TRIGGER_LAYERS = ((1<<TFC_S_TRIGGER_LAYERS)-1)<<TFC_V_TRIGGER_LAYERS,   TFC_M_TRIGGER_START = ((1<<TFC_S_TRIGGER_START )-1)<<TFC_V_TRIGGER_START,   TFC_M_TRIGGER_LENGTH = ((1<<TFC_S_TRIGGER_LENGTH)-1)<<TFC_V_TRIGGER_LENGTH,   TFC_M_TRIGGER_RSVD = ((1<<TFC_S_TRIGGER_RSVD )-1)<<TFC_V_TRIGGER_RSVD,   TFC_M_TRIGGER_TYPE = ((1<<TFC_S_TRIGGER_TYPE )-1)<<TFC_V_TRIGGER_TYPE }
	Defines in place mask for the specified field.

---

Detailed Description

Defines the contents of the 32 bit word returned by the TKR trigger formation routines. This word includes an 18 bit coincidence pattern, the start, length and type of the coincidence. The word is arranged such that negative values indicate no 6/6 or 7/8 coincidence.

The word is defined both in terms of the standard shifts and masks needed to extract the fields and in terms of a bit field structure.

Author:

JJRussell - russell@slac.stanford.edu

---

Typedef Documentation

TFC_K_triggerType

Typedef for enum _TFC_K_triggerType.

This defines the values that the type field of the trigger coincidence can assume.

TFC_S_trigger

Typedef for enum _TFC_S_trigger.

The trigger results summarizes the layer hit information from a single tower. The low 17 bits summarizes the X/Y coincidence. The level of the coincidence is always just before any failing step.

      Level Type Layers
        4/4    3 Failure: Return the 2/2 coincidence bits
                 Success: Try 7/8

        7/8      Failure: Try 6/6
               1 Success: Return the 7/8 coincidence bits

        6/6    2 Failure: Return the 4/4 coincidence bits
               0 Success: Return The 6/6 coincidence bits

      The \e start and \e length fields are relevant only for types
      0 and 1.
  

---

Enumeration Type Documentation

enum _TFC_K_triggerType

Enumerates the type of coincidence achieved.

Enumerator:

TFC_K_TRIGGER_TYPE_NONE	No coincidence of 4/4 or greater
TFC_K_TRIGGER_TYPE_4_OF_4	Achieved a 4/4 coincidence
TFC_K_TRIGGER_TYPE_6_OF_6	Achieved a 6/6 coincidence
TFC_K_TRIGGER_TYPE_7_OF_8	Achieved a 7/8 coincidence

enum _TFC_S_trigger

Maps out the size of the trigger coincidence word.

Enumerator:

TFC_S_TRIGGER_LAYERS	The layer coincidence bits
TFC_S_TRIGGER_START	Start of coincidence (nearest ACD
TFC_S_TRIGGER_LENGTH	Number of layers in coincidence
TFC_S_TRIGGER_RSVD	Reserved for future expansion
TFC_S_TRIGGER_TYPE	See TFC_K_triggerType for the definitions of the values of this field