EBF_err.h File Reference

Maps out the TEM error contribution. More...

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

Classes

struct _EBF_errTemSummary_bf

The error summary word as bit fields. More...

union _EBF_errTemSummary

The TEM error summary word as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...

struct _EBF_errGCCC_bf

The GCCC cable error as bit fields. More...

union _EBF_errGCCC

The TEM CAL Common Cable error parameter as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...

struct _EBF_errGTRC_bf

The GTRC cable error as bit fields. More...

union _EBF_errGTRC

The TEM TKR Common Cable error summary word as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...

struct _EBF_errGTRC_Phase_bf

The GTRC cable GTRC phasing error parameter as bit fields. More...

union _EBF_errGTRC_Phase

The TEM TKR Common Cable error for the GTRC phasing error as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...

struct _EBF_errTemPhase_bf

The structure of a common cable controller phasing error message. More...

union _EBF_errTemPhase

The TEM common Cable phase error message as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...

struct _EBF_errTemTimeout_bf

The structure of a common cable controller timeout error message. More...

union _EBF_errTemTimeout

The TEM TKR Common Cable Timeout error word as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...

Defines

#define EBF_ERR_CAL_ORDER

#define EBF_ERR_TKR_ORDER

#define EBF_ERR_GTRC_STACK_COUNTS

Typedefs

typedef struct _EBF_tkr EBF_tkr

Typedef for struct _EBF_tkr.

typedef enum _EBF_ERR_TEM_SUMMARY_S EBF_ERR_TEM_SUMMARY_S

Typedef for enum _EBF_ERR_TEM_SUMMARY_S.

typedef enum _EBF_ERR_TEM_SUMMARY_V EBF_ERR_TEM_SUMMARY_V

Typedef for enum _EBF_ERR_TEM_SUMMARY_V.

typedef enum _EBF_ERR_TEM_SUMMARY_M EBF_ERR_TEM_SUMMARY_M

Typedef for enum _EBF_ERR_TEM_SUMMARY_M.

typedef struct
_EBF_errTemSummary_bf EBF_errTemSummary_bf

Typedef for struct _EBF_errSummary_bf.

typedef union _EBF_errTemSummary EBF_errTemSummary

Typedef for union _EBF_errTemSummary.

typedef enum _EBF_ERR_GCCC_TYPE_K EBF_ERR_GCCC_TYPE_K

Typedef for enum _EBF_ERR_GCCC_TYPE_K.

typedef enum _EBF_ERR_GCCC_S EBF_ERR_GCCC_S

Typedef for enum _EBF_ERR_GCCC_S.

typedef enum _EBF_ERR_GCCC_V EBF_ERR_GCCC_V

Typedef for enum _EBF_ERR_GCCC_V.

typedef enum _EBF_ERR_GCCC_M EBF_ERR_GCCC_M

Typedef for enum _EBF_ERR_GCCC_M.

typedef struct _EBF_errGCCC_bf EBF_errGCCC_bf

Typedef struct _EBF_errGCCC_bf.

typedef union _EBF_errGCCC EBF_errGCCC

Typedef for union _EBF_errGCCC.

typedef enum _EBF_ERR_GTCC_K EBF_ERR_GTCC_K

Typedef for enum _EBF_GTCC_K.

typedef enum _EBF_ERR_GTRC_S EBF_ERR_GTRC_S

Typedef for enum _EBF_ERR_GTRC_S.

typedef enum _EBF_ERR_GTRC_V EBF_ERR_GTRC_V

Typedef for enum _EBF_ERR_GTRC_V.

typedef enum _EBF_ERR_GTRC_M EBF_ERR_GTRC_M

Typedef for enum _EBF_ERR_GTRC_M.

typedef struct _EBF_errGTRC_bf EBF_errGTRC_bf

Typedef struct _EBF_errGTRC_bf.

typedef union _EBF_errGTRC EBF_errGTRC

Typedef for union _EBF_errGTRC.

typedef enum _EBF_ERR_GTRC_PHASE_S EBF_ERR_GTRC_PHASE_S

Typedef struct _EBF_ERR_GTRC_PHASE_S.

typedef enum _EBF_ERR_GTRC_PHASE_V EBF_ERR_GTRC_PHASE_V

Typedef struct _EBF_ERR_GTRC_PHASE_V.

typedef enum _EBF_ERR_GTRC_PHASE_M EBF_ERR_GTRC_PHASE_M

Typedef struct _EBF_ERR_GTRC_PHASE_M.

typedef struct
_EBF_errGTRC_Phase_bf EBF_errGTRC_Phase_bf

Typedef struct _EBF_errGTRC_Phase_bf.

typedef union _EBF_errGTRC_Phase EBF_errGTRC_Phase

Typedef for union _EBF_errGTRC_Phase.

typedef enum _EBF_ERR_TEM_PHASE_S EBF_ERR_TEM_PHASE_S

Typedef for enum _EBF_ERR_TEM_PHASE_S.

typedef enum _EBF_ERR_TEM_PHASE_V EBF_ERR_TEM_PHASE_V

TYpedef for enum _EBF_ERR_TEM_PHASE_V.

typedef enum _EBF_ERR_TEM_PHASE_M EBF_ERR_TEM_PHASE_M

TYpedef for enum _EBF_ERR_TEM_PHASE_M.

typedef struct _EBF_errTemPhase_bf EBF_errTemPhase_bf

TYpedef for struct _EBF_errTemPhase_bf.

typedef union _EBF_errTemPhase EBF_errTemPhase

Typedef for union _EBF_errTemPhase.

typedef enum _EBF_ERR_TEM_TIMEOUT_S EBF_ERR_TEM_TIMEOUT_S

Typedef for enum _EBF_ERR_TEM_TIMEOUT_S.

typedef enum _EBF_ERR_TEM_TIMEOUT_V EBF_ERR_TEM_TIMEOUT_V

Typedef for enum _EBF_ERR_TEM_TIMEOUT_V.

typedef enum _EBF_ERR_TEM_TIMEOUT_M EBF_ERR_TEM_TIMEOUT_M

Typedef for enum _EBF_ERR_TEM_TIMEOUT_M.

typedef struct
_EBF_errTemTimeout_bf EBF_errTemTimeout_bf

TYpedef for struct _EBF_errTemTimeout_bf.

typedef union _EBF_errTemTimeout EBF_errTemTimeout

Typedef for union _EBF_errTemTimeout.

typedef unsigned short int EBF_err

Enumerations

enum _EBF_ERR_TEM_SUMMARY_S {
  EBF_ERR_TEM_SUMMARY_S_CAL = 4,
  EBF_ERR_TEM_SUMMARY_S_TKR = 8,
  EBF_ERR_TEM_SUMMARY_S_PE = 1,
  EBF_ERR_TEM_SUMMARY_S_TO = 1,
  EBF_ERR_TEM_SUMMARY_S_MBZ = 2
}

Enumerates the sizes of the various bit fields in the TEM error summary word. More...

enum _EBF_ERR_TEM_SUMMARY_V {
  EBF_ERR_TEM_SUMMARY_V_CAL = 0,
  EBF_ERR_TEM_SUMMARY_V_TKR = 4,
  EBF_ERR_TEM_SUMMARY_V_PE = 12,
  EBF_ERR_TEM_SUMMARY_V_TO = 13,
  EBF_ERR_TEM_SUMMARY_V_MBZ = 14
}

Enumerates the right justified bit offsets of the various bit fields in the TEM error summary word. More...

enum _EBF_ERR_TEM_SUMMARY_M {
  EBF_ERR_TEM_SUMMARY_M_CAL = 0x000f,
  EBF_ERR_TEM_SUMMARY_M_TKR = 0x0ff0,
  EBF_ERR_TEM_SUMMARY_M_PE = 0x1000,
  EBF_ERR_TEM_SUMMARY_M_TO = 0x2000,
  EBF_ERR_TEM_SUMMARY_M_MBZ = 0xC000
}

Enumerates the in place masks of the various bit fields in the TEM error summary word. More...

enum _EBF_ERR_GCCC_TYPE_K {
  EBF_ERR_GCCC_TYPE_K_START_BIT = 0,
  EBF_ERR_GCCC_TYPE_K_PARITY_ERR = 1,
  EBF_ERR_GCCC_TYPE_K_RSVD_2 = 2,
  EBF_ERR_GCCC_TYPE_K_RSVD_3 = 3
}

Enumerates the possible GCCC error types. More...

enum _EBF_ERR_GCCC_S {
  EBF_ERR_GCCC_S_TYPE = 4,
  EBF_ERR_GCCC_S_MBZ = 2,
  EBF_ERR_GCCC_S_NUM = 2,
  EBF_ERR_GCCC_S_GCRCS = 8
}

Enumerates the sizes of the fields in the GCCC error word. More...

enum _EBF_ERR_GCCC_V {
  EBF_ERR_GCCC_V_TYPE = 0,
  EBF_ERR_GCCC_V_MBZ = 4,
  EBF_ERR_GCCC_V_NUM = 6,
  EBF_ERR_GCCC_V_GCRCS = 8
}

Enumerates the right justified bit offsets of the fields in the GCCC error word. More...

enum _EBF_ERR_GCCC_M {
  EBF_ERR_GCCC_M_TYPE = 0x000f,
  EBF_ERR_GCCC_M_MBZ = 0x0030,
  EBF_ERR_GCCC_M_NUM = 0x00C0,
  EBF_ERR_GCCC_M_GCRCS = 0xff00
}

Enumerates the in place masks of the fields in the GCCC error word. More...

enum _EBF_ERR_GTCC_K {
  EBF_ERR_GTRC_K_MAX_WC = 9,
  EBF_ERR_GTCC_K_MAX_WC = 81
}

Enumerates the constants of the TKR error contribution. More...

enum _EBF_ERR_GTRC_S {
  EBF_ERR_GTRC_S_ID = 8,
  EBF_ERR_GTRC_S_RC_PE = 1,
  EBF_ERR_GTRC_S_FE_PE = 1,
  EBF_ERR_GTRC_S_FIFOFULL = 1,
  EBF_ERR_GTRC_S_TIMEOUT = 1,
  EBF_ERR_GTRC_S_HPARITY = 1,
  EBF_ERR_GTRC_S_WCPARITY = 1,
  EBF_ERR_GTRC_S_SUMMARY = 1,
  EBF_ERR_GTRC_S_DPARITY = 1
}

Enumerates the sizes of the fields in the GTRC error word. More...

enum _EBF_ERR_GTRC_V {
  EBF_ERR_GTRC_V_ID = 0,
  EBF_ERR_GTRC_V_RC_PE = 8,
  EBF_ERR_GTRC_V_FE_PE = 9,
  EBF_ERR_GTRC_V_FIFOFULL = 10,
  EBF_ERR_GTRC_V_TIEMOUT = 11,
  EBF_ERR_GTRC_V_HPARITY = 12,
  EBF_ERR_GTRC_V_WCPARITY = 13,
  EBF_ERR_GTRC_V_SUMMARY = 14,
  EBF_ERR_GTRC_V_DPARITY = 15
}

Enumerates the right justified offsets of the fields in the GTRC error word. More...

enum _EBF_ERR_GTRC_M {
  EBF_ERR_GTRC_M_ID = 0x00ff,
  EBF_ERR_GTRC_M_RC_PE = 0x0100,
  EBF_ERR_GTRC_M_FE_PE = 0x0200,
  EBF_ERR_GTRC_M_FIFOFULL = 0x0400,
  EBF_ERR_GTRC_M_TIMEOUT = 0x0800,
  EBF_ERR_GTRC_M_HPARITY = 0x1000,
  EBF_ERR_GTRC_M_WCPARITY = 0x2000,
  EBF_ERR_GTRC_M_SUMMARY = 0x4000,
  EBF_ERR_GTRC_M_DPARITY = 0x8000
}

Enumerates the in place masks of the fields in the GTRC error word. More...

enum _EBF_ERR_GTRC_PHASE_S {
  EBF_ERR_GTRC_PHASE_S_TAG_EXP = 2,
  EBF_ERR_GTRC_PHASE_S_TAG_RCV = 2,
  EBF_ERR_GTRC_PHASE_S_MBZ = 4,
  EBF_ERR_GTRC_PHASE_S_LYR_EXP = 4,
  EBF_ERR_GTRC_PHASE_S_LYR_RCV = 4
}

Enumerates the sizes of the bit fields in the GTRC cable GTRC phasing error parameter word. More...

enum _EBF_ERR_GTRC_PHASE_V {
  EBF_ERR_GTRC_PHASE_V_TAG_EXP = 0,
  EBF_ERR_GTRC_PHASE_V_TAG_RCV = 2,
  EBF_ERR_GTRC_PHASE_V_MBZ = 4,
  EBF_ERR_GTRC_PHASE_V_LYR_EXP = 8,
  EBF_ERR_GTRC_PHASE_V_LYR_RCV = 12
}

Enumerates the right-justified offsets of the bit fields in the GTRC cable GTRC phasing error parameter word. More...

enum _EBF_ERR_GTRC_PHASE_M {
  EBF_ERR_GTRC_PHASE_M_TAG_EXP = 0x0003,
  EBF_ERR_GTRC_PHASE_M_TAG_RCV = 0x000c,
  EBF_ERR_GTRC_PHASE_M_MBZ = 0x00f0,
  EBF_ERR_GTRC_PHASE_M_LYR_EXP = 0x0ff0,
  EBF_ERR_GTRC_PHASE_M_LYR_RCV = 0xf000
}

Enumerates the in place masks of the bit fields in the GTRC cable GTRC phasing error parameter word. More...

enum _EBF_ERR_TEM_PHASE_S {
  EBF_ERR_TEM_PHASE_S_GTCC3 = 2,
  EBF_ERR_TEM_PHASE_S_GTCC6 = 2,
  EBF_ERR_TEM_PHASE_S_GTCC2 = 2,
  EBF_ERR_TEM_PHASE_S_GTCC7 = 2,
  EBF_ERR_TEM_PHASE_S_GTCC0 = 2,
  EBF_ERR_TEM_PHASE_S_GTCC5 = 2,
  EBF_ERR_TEM_PHASE_S_GTCC1 = 2,
  EBF_ERR_TEM_PHASE_S_GTCC4 = 2
}

Enumerates the sizes of the fields in common cable controller phasing error message. More...

enum _EBF_ERR_TEM_PHASE_V {
  EBF_ERR_TEM_PHASE_V_GTCC3 = 0,
  EBF_ERR_TEM_PHASE_V_GTCC6 = 2,
  EBF_ERR_TEM_PHASE_V_GTCC2 = 4,
  EBF_ERR_TEM_PHASE_V_GTCC7 = 6,
  EBF_ERR_TEM_PHASE_V_GTCC0 = 8,
  EBF_ERR_TEM_PHASE_V_GTCC5 = 10,
  EBF_ERR_TEM_PHASE_V_GTCC1 = 12,
  EBF_ERR_TEM_PHASE_V_GTCC4 = 14
}

Enumerates the right-justified offsets of the fields in common cable controller. More...

enum _EBF_ERR_TEM_PHASE_M {
  EBF_ERR_TEM_PHASE_M_GTCC3 = 0x0003,
  EBF_ERR_TEM_PHASE_M_GTCC6 = 0x000c,
  EBF_ERR_TEM_PHASE_M_GTCC2 = 0x0030,
  EBF_ERR_TEM_PHASE_M_GTCC7 = 0x00c0,
  EBF_ERR_TEM_PHASE_M_GTCC0 = 0x0300,
  EBF_ERR_TEM_PHASE_M_GTCC5 = 0x0c00,
  EBF_ERR_TEM_PHASE_M_GTCC1 = 0x3000,
  EBF_ERR_TEM_PHASE_M_GTCC4 = 0xc000
}

Enumerates the in place masks of the fields in common cable controller. More...

enum _EBF_ERR_TEM_TIMEOUT_S {
  EBF_ERR_TEM_TIMEOUT_S_CAL = 4,
  EBF_ERR_TEM_TIMEOUT_S_TKR = 8,
  EBF_ERR_TEM_TIMEOUT_S_MBZ = 4
}

Enumerates the sizes of the fields in common cable controller timeout error message. More...

enum _EBF_ERR_TEM_TIMEOUT_V {
  EBF_ERR_TEM_TIMEOUT_V_CAL = 0,
  EBF_ERR_TEM_TIMEOUT_V_TKR = 4,
  EBF_ERR_TEM_TIMEOUT_V_MBZ = 12
}

Enumerates the right-justified offsets of the fields in common cable controller timeout error message. More...

enum _EBF_ERR_TEM_TIMEOUT_M {
  EBF_ERR_TEM_TIMEOUT_M_CAL = 0x000f,
  EBF_ERR_TEM_TIMEOUT_M_TKR = 0x0ff0,
  EBF_ERR_TEM_TIMEOUT_M_MBZ = 0xf000
}

Enumerates the in place masks of the fields in common cable controller timeout error message. More...

Functions

static __inline const EBF_err * EBF__errLocate (const EBF_tkr *tkr, int tkrLen, unsigned int has_dgn)

Locates the error contribution. This routine starts with the knowledge of the TKR contribution and its length.

static __inline int EBF__errCalBeg (const EBF_err *err, int idx)

Returns the index of the word of the first CAL error word.

static __inline int EBF__errCalEnd (const EBF_err *err, int idx)

Returns the index of the word after the last CAL error word.

static __inline int EBF__errTkrBeg (const EBF_err *err, int idx)

Returns the index of the word of the first TKR error word.

static __inline int EBF__errTkrEnd (const EBF_err *err, int idx)

Returns the index of the word after the last TKR error word.

static __inline int EBF__errTemPhaseBeg (const EBF_err *err, int idx)

Returns the index of the first word of the TEM phasing error contribution.

static __inline int EBF__errTemPhaseEnd (const EBF_err *err, int idx)

Returns the index of the last word of the TEM phasing error contribution.

static __inline int EBF__errTemTimeoutBeg (const EBF_err *err, int idx)

Returns the index of the first word of the TEM phasing error contribution.

static __inline int EBF__errTemTimeoutEnd (const EBF_err *err, int idx)

Returns the index of the last word of the TEM timeout error contribution.

static __inline int EBF__errEnd (const EBF_err *err)

Returns the index of the last error word (actually one past the the last error word.

static __inline int EBF__errSize (const EBF_err *err)

Return the size, in bytes, of the error contribution.

static __inline int EBF__errGCCCNumber (int cc)

Translates a CAL cable controller readout order index to its cable controller electronics number.

static __inline char EBF__errGCCCLabel (int cc)

Translates a CAL cable controller readout order index to its cable controller electronics label.

static __inline int EBF__errGTCCNumber (int cc)

Translates a CAL cable controller readout order index to its cable controller electronics number.

static __inline char EBF__errGTCCLabel (int cc)

Translates a CAL cable controller readout order index to its cable controller electronics label.

static __inline int EBF__errGTRCStackCount (unsigned int gtrc)

Returns the number of stack words that this GTRC error word will consume.

Detailed Description

Maps out the TEM error contribution.

Author:: JJRussell - russell@slac.stanford.edu


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

Define Documentation

#define EBF_ERR_CAL_ORDER

Value:

( (0 << (0*2)) | (2 << (1*2)) |                 \
                            (3 << (2*2)) | (1 << (3*2)) )

#define EBF_ERR_GTRC_STACK_COUNTS

Value:

((0 << 0*4) |  /*    0     0     0 */   \
                                   (1 << 1*4) |  /*    0     0     1 */   \
                                   (5 << 2*4) |  /*    0     5     0 */   \
                                   (6 << 3*4) |  /*    0     5     1 */   \
                                   (1 << 4*4) |  /*    1     0     0 */   \
                                   (2 << 5*4) |  /*    1     0     1 */   \
                                   (6 << 6*4) |  /*    1     5     0 */   \
                                   (7 << 7*4))

#define EBF_ERR_TKR_ORDER

Value:

( (3 << (0*4)) | (6 << (1*4)) | \
                            (2 << (2*4)) | (7 << (3*4)) | \
                            (0 << (4*4)) | (5 << (5*4)) | \
                            (1 << (6*4)) | (4 << (7*4)) )

Typedef Documentation

EBF_ERR_GCCC_TYPE_K

Typedef for enum _EBF_ERR_GCCC_TYPE_K.

This enumerates the type field of the GCCC error word. Its value is used to interpret the meaning of the GCCC parameter

EBF_ERR_GTCC_K

Typedef for enum _EBF_GTCC_K.

Note:: These are done as enums, rather than #defines, not so much as for any organizational or abstraction reason, but simply to make them accessiable in the debugger. (Newer versions of gdb allow one to examine the values of enums.)

EBF_errTemSummary_bf

Typedef for struct _EBF_errSummary_bf.

This provides a summary of which error parameter blocks are present. There are 4 distinct parameter blocks, 2 associated with the common cable controller and 1 each for the CAL and TKR cable controllers

Enumeration Type Documentation

enum _EBF_ERR_GCCC_M

Enumerates the in place masks of the fields in the GCCC error word.

Enumerator:

EBF_ERR_GCCC_M_TYPE	Error type
EBF_ERR_GCCC_M_MBZ	Must be zero
EBF_ERR_GCCC_M_NUM	Sweep number
EBF_ERR_GCCC_M_GCRCS	Bit mask of which GTRCs are in error

enum _EBF_ERR_GCCC_S

Enumerates the sizes of the fields in the GCCC error word.

Enumerator:

EBF_ERR_GCCC_S_TYPE	Error type
EBF_ERR_GCCC_S_MBZ	Must be zero
EBF_ERR_GCCC_S_NUM	Sweep number
EBF_ERR_GCCC_S_GCRCS	Bit mask of which GTRCs are in error

enum _EBF_ERR_GCCC_TYPE_K

Enumerates the possible GCCC error types.

Enumerator:

EBF_ERR_GCCC_TYPE_K_START_BIT	Bit list of missing start bits
EBF_ERR_GCCC_TYPE_K_PARITY_ERR	Bit list of parity error flags
EBF_ERR_GCCC_TYPE_K_RSVD_2	Unused
EBF_ERR_GCCC_TYPE_K_RSVD_3	Unused

enum _EBF_ERR_GCCC_V

Enumerates the right justified bit offsets of the fields in the GCCC error word.

Enumerator:

EBF_ERR_GCCC_V_TYPE	Error type
EBF_ERR_GCCC_V_MBZ	Must be zero
EBF_ERR_GCCC_V_NUM	Sweep number
EBF_ERR_GCCC_V_GCRCS	Bit mask of which GTRCs are in error

enum _EBF_ERR_GTCC_K

Enumerates the constants of the TKR error contribution.

Enumerator:

EBF_ERR_GTRC_K_MAX_WC

The maximum word count for a GTRC is

1 word for a timeout message
1 word for all other messages +
- 1 additional word for an RC FIFO full
- 5 additional words for an RC FE error
- additional word for an RC PE error Note that, if a timeout error occurs, it always appears in its own message, even though, logically, it could be grouped with the other error bits. This has to do with details in the timing of when the hardware pushes this message out.

EBF_ERR_GTCC_K_MAX_WC

The maximum word count is the Maximum word count/GTRC * # of GTRCs = 9 * 9 = 81

enum _EBF_ERR_GTRC_M

Enumerates the in place masks of the fields in the GTRC error word.

Enumerator:

EBF_ERR_GTRC_M_ID	GTFC id/number
EBF_ERR_GTRC_M_RC_PE	GTRC phasing error
EBF_ERR_GTRC_M_FE_PE	GTFE phasing error
EBF_ERR_GTRC_M_FIFOFULL	FIFO full error
EBF_ERR_GTRC_M_TIMEOUT	Cable timeout
EBF_ERR_GTRC_M_HPARITY	Header parity error
EBF_ERR_GTRC_M_WCPARITY	Word count parity error
EBF_ERR_GTRC_M_SUMMARY	GTRC summary error
EBF_ERR_GTRC_M_DPARITY	Data parity error

enum _EBF_ERR_GTRC_PHASE_M

Enumerates the in place masks of the bit fields in the GTRC cable GTRC phasing error parameter word.

Enumerator:

EBF_ERR_GTRC_PHASE_M_TAG_EXP	Tag expected by the TEM
EBF_ERR_GTRC_PHASE_M_TAG_RCV	Tag received by the TEM
EBF_ERR_GTRC_PHASE_M_MBZ	Must be zero
EBF_ERR_GTRC_PHASE_M_LYR_EXP	Layer number expected by the TEM
EBF_ERR_GTRC_PHASE_M_LYR_RCV	Layer number received by the TEM

enum _EBF_ERR_GTRC_PHASE_S

Enumerates the sizes of the bit fields in the GTRC cable GTRC phasing error parameter word.

Enumerator:

EBF_ERR_GTRC_PHASE_S_TAG_EXP	Tag expected by the TEM
EBF_ERR_GTRC_PHASE_S_TAG_RCV	Tag received by the TEM
EBF_ERR_GTRC_PHASE_S_MBZ	Must be zero
EBF_ERR_GTRC_PHASE_S_LYR_EXP	Layer number expected by the TEM
EBF_ERR_GTRC_PHASE_S_LYR_RCV	Layer number received by the TEM

enum _EBF_ERR_GTRC_PHASE_V

Enumerates the right-justified offsets of the bit fields in the GTRC cable GTRC phasing error parameter word.

Enumerator:

EBF_ERR_GTRC_PHASE_V_TAG_EXP	Tag expected by the TEM
EBF_ERR_GTRC_PHASE_V_TAG_RCV	Tag received by the TEM
EBF_ERR_GTRC_PHASE_V_MBZ	Must be zero
EBF_ERR_GTRC_PHASE_V_LYR_EXP	Layer number expected by the TEM
EBF_ERR_GTRC_PHASE_V_LYR_RCV	Layer number received by the TEM

enum _EBF_ERR_GTRC_S

Enumerates the sizes of the fields in the GTRC error word.

Enumerator:

EBF_ERR_GTRC_S_ID	GTFC id/number
EBF_ERR_GTRC_S_RC_PE	GTRC phasing error
EBF_ERR_GTRC_S_FE_PE	GTFE phasing error
EBF_ERR_GTRC_S_FIFOFULL	FIFO full error
EBF_ERR_GTRC_S_TIMEOUT	Cable timeout
EBF_ERR_GTRC_S_HPARITY	Header parity error
EBF_ERR_GTRC_S_WCPARITY	Word count parity error
EBF_ERR_GTRC_S_SUMMARY	GTRC summary error
EBF_ERR_GTRC_S_DPARITY	Data parity error

enum _EBF_ERR_GTRC_V

Enumerates the right justified offsets of the fields in the GTRC error word.

Enumerator:

EBF_ERR_GTRC_V_ID	GTFC id/number
EBF_ERR_GTRC_V_RC_PE	GTRC phasing error
EBF_ERR_GTRC_V_FE_PE	GTFE phasing error
EBF_ERR_GTRC_V_FIFOFULL	FIFO full error
EBF_ERR_GTRC_V_TIEMOUT	Cable timeout
EBF_ERR_GTRC_V_HPARITY	Header parity error
EBF_ERR_GTRC_V_WCPARITY	Word count parity error
EBF_ERR_GTRC_V_SUMMARY	GTRC summary error
EBF_ERR_GTRC_V_DPARITY	Data parity error

enum _EBF_ERR_TEM_PHASE_M

Enumerates the in place masks of the fields in common cable controller.

Enumerator:

EBF_ERR_TEM_PHASE_M_GTCC3	GTCC3 tag field
EBF_ERR_TEM_PHASE_M_GTCC6	GTCC6 tag field
EBF_ERR_TEM_PHASE_M_GTCC2	GTCC6 tag field
EBF_ERR_TEM_PHASE_M_GTCC7	GTCC7 tag field
EBF_ERR_TEM_PHASE_M_GTCC0	GTCC0 tag field
EBF_ERR_TEM_PHASE_M_GTCC5	GTCC5 tag field
EBF_ERR_TEM_PHASE_M_GTCC1	GTCC1 tag field
EBF_ERR_TEM_PHASE_M_GTCC4	GTCC4 tag field

enum _EBF_ERR_TEM_PHASE_S

Enumerates the sizes of the fields in common cable controller phasing error message.

Enumerator:

EBF_ERR_TEM_PHASE_S_GTCC3	GTCC3 tag field
EBF_ERR_TEM_PHASE_S_GTCC6	GTCC6 tag field
EBF_ERR_TEM_PHASE_S_GTCC2	GTCC6 tag field
EBF_ERR_TEM_PHASE_S_GTCC7	GTCC7 tag field
EBF_ERR_TEM_PHASE_S_GTCC0	GTCC0 tag field
EBF_ERR_TEM_PHASE_S_GTCC5	GTCC5 tag field
EBF_ERR_TEM_PHASE_S_GTCC1	GTCC1 tag field
EBF_ERR_TEM_PHASE_S_GTCC4	GTCC4 tag field

enum _EBF_ERR_TEM_PHASE_V

Enumerates the right-justified offsets of the fields in common cable controller.

Enumerator:

EBF_ERR_TEM_PHASE_V_GTCC3	GTCC3 tag field
EBF_ERR_TEM_PHASE_V_GTCC6	GTCC6 tag field
EBF_ERR_TEM_PHASE_V_GTCC2	GTCC6 tag field
EBF_ERR_TEM_PHASE_V_GTCC7	GTCC7 tag field
EBF_ERR_TEM_PHASE_V_GTCC0	GTCC0 tag field
EBF_ERR_TEM_PHASE_V_GTCC5	GTCC5 tag field
EBF_ERR_TEM_PHASE_V_GTCC1	GTCC1 tag field
EBF_ERR_TEM_PHASE_V_GTCC4	GTCC4 tag field

enum _EBF_ERR_TEM_SUMMARY_M

Enumerates the in place masks of the various bit fields in the TEM error summary word.

Enumerator:

EBF_ERR_TEM_SUMMARY_M_CAL	CAL error component bit mask
EBF_ERR_TEM_SUMMARY_M_TKR	TKR error component bit mask
EBF_ERR_TEM_SUMMARY_M_PE	Cable phasing error
EBF_ERR_TEM_SUMMARY_M_TO	Cable timeout error
EBF_ERR_TEM_SUMMARY_M_MBZ	Must be zero field

enum _EBF_ERR_TEM_SUMMARY_S

Enumerates the sizes of the various bit fields in the TEM error summary word.

Enumerator:

EBF_ERR_TEM_SUMMARY_S_CAL	CAL error component bit mask
EBF_ERR_TEM_SUMMARY_S_TKR	TKR error component bit mask
EBF_ERR_TEM_SUMMARY_S_PE	Cable phasing error
EBF_ERR_TEM_SUMMARY_S_TO	Cable timeout error
EBF_ERR_TEM_SUMMARY_S_MBZ	Must be zero

enum _EBF_ERR_TEM_SUMMARY_V

Enumerates the right justified bit offsets of the various bit fields in the TEM error summary word.

Enumerator:

EBF_ERR_TEM_SUMMARY_V_CAL	CAL error component bit mask
EBF_ERR_TEM_SUMMARY_V_TKR	TKR error component bit mask
EBF_ERR_TEM_SUMMARY_V_PE	Cable phasing error
EBF_ERR_TEM_SUMMARY_V_TO	Cable timeout error
EBF_ERR_TEM_SUMMARY_V_MBZ	Must be zero

enum _EBF_ERR_TEM_TIMEOUT_M

Enumerates the in place masks of the fields in common cable controller timeout error message.

Enumerator:

EBF_ERR_TEM_TIMEOUT_M_CAL	Bit list of which TKR cable timed out
EBF_ERR_TEM_TIMEOUT_M_TKR	Bit list of which TKR cable timed out
EBF_ERR_TEM_TIMEOUT_M_MBZ	Must be zero

enum _EBF_ERR_TEM_TIMEOUT_S

Enumerates the sizes of the fields in common cable controller timeout error message.

Enumerator:

EBF_ERR_TEM_TIMEOUT_S_CAL	Bit list of which TKR cable timed out
EBF_ERR_TEM_TIMEOUT_S_TKR	Bit list of which TKR cable timed out
EBF_ERR_TEM_TIMEOUT_S_MBZ	Must be zero

enum _EBF_ERR_TEM_TIMEOUT_V

Enumerates the right-justified offsets of the fields in common cable controller timeout error message.

Enumerator:

EBF_ERR_TEM_TIMEOUT_V_CAL	Bit list of which TKR cable timed out
EBF_ERR_TEM_TIMEOUT_V_TKR	Bit list of which TKR cable timed out
EBF_ERR_TEM_TIMEOUT_V_MBZ	Must be zero

Function Documentation

static __inline int EBF__errCalBeg	(	const EBF_err *	err,
		int	idx
	)			`[static]`

Returns the index of the word of the first CAL error word.

Returns:: The index of the first CAL error word, always 1

Parameters:

	err	Pointer to the beginning of the error contribution
	idx	Ignored

Referenced by EBF__errEnd().

static __inline int EBF__errCalEnd	(	const EBF_err *	err,
		int	idx
	)			`[static]`

Returns the index of the word after the last CAL error word.

Returns:: The index of the word after the last CAL error word

Parameters:

	err	Pointer to the beginning of the error contribution
	idx	The index to the first cal error word (always 1)

References _EBF_errTemSummary::bf, _EBF_errTemSummary_bf::cal, and _EBF_errTemSummary::us.

Referenced by EBF__errTkrBeg().

static __inline int EBF__errEnd ( const EBF_err * err ) [static]

Returns the index of the last error word (actually one past the the last error word.

Parameters:

err

The error contribution

References EBF__errCalBeg(), EBF__errTemPhaseBeg(), EBF__errTemTimeoutBeg(), EBF__errTemTimeoutEnd(), and EBF__errTkrBeg().

Referenced by EBF__errSize().

static __inline char EBF__errGCCCLabel ( int cc ) [static]

Translates a CAL cable controller readout order index to its cable controller electronics label.

Returns:: The cable controller number

Parameters:

cc

The CAL cable controller readont order index to translate. This must be between 0 and 3.

static __inline int EBF__errGCCCNumber ( int cc ) [static]

Translates a CAL cable controller readout order index to its cable controller electronics number.

Returns:: The cable controller number

Parameters:

cc

The CAL cable controller readont order index to translate. This must be between 0 and 3.

static __inline char EBF__errGTCCLabel ( int cc ) [static]

Translates a CAL cable controller readout order index to its cable controller electronics label.

Returns:: The cable controller number

Parameters:

cc

The CAL cable controller readont order index to translate. This must be between 0 and 3.

static __inline int EBF__errGTCCNumber ( int cc ) [static]

Translates a CAL cable controller readout order index to its cable controller electronics number.

Returns:: The cable controller number

Parameters:

cc

The TKR cable controller readont order index to translate. This must be between 0 and 7.

static __inline int EBF__errGTRCStackCount ( unsigned int gtrc ) [static]

Returns the number of stack words that this GTRC error word will consume.

Returns:: The count of stack words that this GTCC error word will consume.

Parameters:

gtrc

The GTRC error message word

References EBF_ERR_GTRC_M_FE_PE, EBF_ERR_GTRC_M_FIFOFULL, EBF_ERR_GTRC_M_RC_PE, and EBF_ERR_GTRC_V_RC_PE.

Referenced by edr_err_tkr_parse().

static __inline const EBF_err * EBF__errLocate	(	const EBF_tkr *	tkr,
		int	tkrLen,
		unsigned int	has_dgn
	)			`[static]`

Locates the error contribution. This routine starts with the knowledge of the TKR contribution and its length.

Returns:: Address of the error contribution

Parameters:

	tkr	The address of the TKR contribution
	tkrLen	The TKR length, in bytes
	has_dgn	If non-zero, this contributor has a diagnostic block

Referenced by EBF_dirAuxFill(), and EDR_errUnpack().

static __inline int EBF__errSize ( const EBF_err * err ) [static]

Return the size, in bytes, of the error contribution.

Returns:: The size, in bytes, of the error contribution.

Parameters:

err

The error contribution

References EBF__errEnd().

Referenced by EBF_dirAuxFill().

static __inline int EBF__errTemPhaseBeg	(	const EBF_err *	err,
		int	idx
	)			`[static]`

Returns the index of the first word of the TEM phasing error contribution.

Returns:: The index of the first word of the TEM phasing error contribution

Parameters:

	err	Pointer to the beginning of the error contribution
	idx	The index to the first TKR error word. This can be gotten from EBF__errTkrBeg

References EBF__errTkrEnd().

Referenced by EBF__errEnd().

static __inline int EBF__errTemPhaseEnd	(	const EBF_err *	err,
		int	idx
	)			`[static]`

Returns the index of the last word of the TEM phasing error contribution.

Returns:: The index of the last word of the TEM phasing error contribution

Parameters:

	err	Pointer to the beginning of the error contribution
	idx	The index to the first phase error word. This can be gotten from EBF__errTemPhaseBeg

References _EBF_errTemSummary::bf, _EBF_errTemSummary_bf::phase, and _EBF_errTemSummary::us.

Referenced by EBF__errTemTimeoutBeg().

static __inline int EBF__errTemTimeoutBeg	(	const EBF_err *	err,
		int	idx
	)			`[static]`

Returns the index of the first word of the TEM phasing error contribution.

Returns:: The index of the first word of the TEM phasing error contribution

Parameters:

	err	Pointer to the beginning of the error contribution
	idx	The index to the first timeout error word. This can be gotten from EBF__errTkrEnd

References EBF__errTemPhaseEnd().

Referenced by EBF__errEnd().

static __inline int EBF__errTemTimeoutEnd	(	const EBF_err *	err,
		int	idx
	)			`[static]`

Returns the index of the last word of the TEM timeout error contribution.

Returns:: The index of the last word of the TEM timeout error contribution

Parameters:

	err	Pointer to the beginning of the error contribution
	idx	The index to the first phase error word. This can be gotten from EBF__errTimeoutBeg

References _EBF_errTemSummary::bf, _EBF_errTemSummary_bf::timeout, and _EBF_errTemSummary::us.

Referenced by EBF__errEnd().

static __inline int EBF__errTkrBeg	(	const EBF_err *	err,
		int	idx
	)			`[static]`

Returns the index of the word of the first TKR error word.

Returns:: The index of the first TKR error word

Parameters:

	err	Pointer to the beginning of the error contribution
	idx	The index to the first cal error word (always 1)

References EBF__errCalEnd().

Referenced by EBF__errEnd().

static __inline int EBF__errTkrEnd	(	const EBF_err *	err,
		int	idx
	)			`[static]`

Returns the index of the word after the last TKR error word.

Returns:: The index of the word after the last TKR error word

Parameters:

	err	Pointer to the beginning of the error contribution
	idx	The index to the first TKR error word. This can be gotten from EBF__errTkrBeg

References _EBF_errTemSummary::bf, _EBF_errTemSummary_bf::tkr, and _EBF_errTemSummary::us.

Referenced by EBF__errTemPhaseBeg().


Classes
struct	_EBF_errTemSummary_bf
	The error summary word as bit fields. More...
union	_EBF_errTemSummary
	The TEM error summary word as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...
struct	_EBF_errGCCC_bf
	The GCCC cable error as bit fields. More...
union	_EBF_errGCCC
	The TEM CAL Common Cable error parameter as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...
struct	_EBF_errGTRC_bf
	The GTRC cable error as bit fields. More...
union	_EBF_errGTRC
	The TEM TKR Common Cable error summary word as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...
struct	_EBF_errGTRC_Phase_bf
	The GTRC cable GTRC phasing error parameter as bit fields. More...
union	_EBF_errGTRC_Phase
	The TEM TKR Common Cable error for the GTRC phasing error as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...
struct	_EBF_errTemPhase_bf
	The structure of a common cable controller phasing error message. More...
union	_EBF_errTemPhase
	The TEM common Cable phase error message as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...
struct	_EBF_errTemTimeout_bf
	The structure of a common cable controller timeout error message. More...
union	_EBF_errTemTimeout
	The TEM TKR Common Cable Timeout error word as a union between its bit field representation and an uninterpretted 16-bit unsigned integer. More...
Defines
#define	EBF_ERR_CAL_ORDER
#define	EBF_ERR_TKR_ORDER
#define	EBF_ERR_GTRC_STACK_COUNTS
Typedefs
typedef struct _EBF_tkr	EBF_tkr
	Typedef for struct _EBF_tkr.
typedef enum _EBF_ERR_TEM_SUMMARY_S	EBF_ERR_TEM_SUMMARY_S
	Typedef for enum _EBF_ERR_TEM_SUMMARY_S.
typedef enum _EBF_ERR_TEM_SUMMARY_V	EBF_ERR_TEM_SUMMARY_V
	Typedef for enum _EBF_ERR_TEM_SUMMARY_V.
typedef enum _EBF_ERR_TEM_SUMMARY_M	EBF_ERR_TEM_SUMMARY_M
	Typedef for enum _EBF_ERR_TEM_SUMMARY_M.
typedef struct _EBF_errTemSummary_bf	EBF_errTemSummary_bf
	Typedef for struct _EBF_errSummary_bf.
typedef union _EBF_errTemSummary	EBF_errTemSummary
	Typedef for union _EBF_errTemSummary.
typedef enum _EBF_ERR_GCCC_TYPE_K	EBF_ERR_GCCC_TYPE_K
	Typedef for enum _EBF_ERR_GCCC_TYPE_K.
typedef enum _EBF_ERR_GCCC_S	EBF_ERR_GCCC_S
	Typedef for enum _EBF_ERR_GCCC_S.
typedef enum _EBF_ERR_GCCC_V	EBF_ERR_GCCC_V
	Typedef for enum _EBF_ERR_GCCC_V.
typedef enum _EBF_ERR_GCCC_M	EBF_ERR_GCCC_M
	Typedef for enum _EBF_ERR_GCCC_M.
typedef struct _EBF_errGCCC_bf	EBF_errGCCC_bf
	Typedef struct _EBF_errGCCC_bf.
typedef union _EBF_errGCCC	EBF_errGCCC
	Typedef for union _EBF_errGCCC.
typedef enum _EBF_ERR_GTCC_K	EBF_ERR_GTCC_K
	Typedef for enum _EBF_GTCC_K.
typedef enum _EBF_ERR_GTRC_S	EBF_ERR_GTRC_S
	Typedef for enum _EBF_ERR_GTRC_S.
typedef enum _EBF_ERR_GTRC_V	EBF_ERR_GTRC_V
	Typedef for enum _EBF_ERR_GTRC_V.
typedef enum _EBF_ERR_GTRC_M	EBF_ERR_GTRC_M
	Typedef for enum _EBF_ERR_GTRC_M.
typedef struct _EBF_errGTRC_bf	EBF_errGTRC_bf
	Typedef struct _EBF_errGTRC_bf.
typedef union _EBF_errGTRC	EBF_errGTRC
	Typedef for union _EBF_errGTRC.
typedef enum _EBF_ERR_GTRC_PHASE_S	EBF_ERR_GTRC_PHASE_S
	Typedef struct _EBF_ERR_GTRC_PHASE_S.
typedef enum _EBF_ERR_GTRC_PHASE_V	EBF_ERR_GTRC_PHASE_V
	Typedef struct _EBF_ERR_GTRC_PHASE_V.
typedef enum _EBF_ERR_GTRC_PHASE_M	EBF_ERR_GTRC_PHASE_M
	Typedef struct _EBF_ERR_GTRC_PHASE_M.
typedef struct _EBF_errGTRC_Phase_bf	EBF_errGTRC_Phase_bf
	Typedef struct _EBF_errGTRC_Phase_bf.
typedef union _EBF_errGTRC_Phase	EBF_errGTRC_Phase
	Typedef for union _EBF_errGTRC_Phase.
typedef enum _EBF_ERR_TEM_PHASE_S	EBF_ERR_TEM_PHASE_S
	Typedef for enum _EBF_ERR_TEM_PHASE_S.
typedef enum _EBF_ERR_TEM_PHASE_V	EBF_ERR_TEM_PHASE_V
	TYpedef for enum _EBF_ERR_TEM_PHASE_V.
typedef enum _EBF_ERR_TEM_PHASE_M	EBF_ERR_TEM_PHASE_M
	TYpedef for enum _EBF_ERR_TEM_PHASE_M.
typedef struct _EBF_errTemPhase_bf	EBF_errTemPhase_bf
	TYpedef for struct _EBF_errTemPhase_bf.
typedef union _EBF_errTemPhase	EBF_errTemPhase
	Typedef for union _EBF_errTemPhase.
typedef enum _EBF_ERR_TEM_TIMEOUT_S	EBF_ERR_TEM_TIMEOUT_S
	Typedef for enum _EBF_ERR_TEM_TIMEOUT_S.
typedef enum _EBF_ERR_TEM_TIMEOUT_V	EBF_ERR_TEM_TIMEOUT_V
	Typedef for enum _EBF_ERR_TEM_TIMEOUT_V.
typedef enum _EBF_ERR_TEM_TIMEOUT_M	EBF_ERR_TEM_TIMEOUT_M
	Typedef for enum _EBF_ERR_TEM_TIMEOUT_M.
typedef struct _EBF_errTemTimeout_bf	EBF_errTemTimeout_bf
	TYpedef for struct _EBF_errTemTimeout_bf.
typedef union _EBF_errTemTimeout	EBF_errTemTimeout
	Typedef for union _EBF_errTemTimeout.
typedef unsigned short int	EBF_err
Enumerations
enum	_EBF_ERR_TEM_SUMMARY_S { EBF_ERR_TEM_SUMMARY_S_CAL = 4, EBF_ERR_TEM_SUMMARY_S_TKR = 8, EBF_ERR_TEM_SUMMARY_S_PE = 1, EBF_ERR_TEM_SUMMARY_S_TO = 1, EBF_ERR_TEM_SUMMARY_S_MBZ = 2 }
	Enumerates the sizes of the various bit fields in the TEM error summary word. More...
enum	_EBF_ERR_TEM_SUMMARY_V { EBF_ERR_TEM_SUMMARY_V_CAL = 0, EBF_ERR_TEM_SUMMARY_V_TKR = 4, EBF_ERR_TEM_SUMMARY_V_PE = 12, EBF_ERR_TEM_SUMMARY_V_TO = 13, EBF_ERR_TEM_SUMMARY_V_MBZ = 14 }
	Enumerates the right justified bit offsets of the various bit fields in the TEM error summary word. More...
enum	_EBF_ERR_TEM_SUMMARY_M { EBF_ERR_TEM_SUMMARY_M_CAL = 0x000f, EBF_ERR_TEM_SUMMARY_M_TKR = 0x0ff0, EBF_ERR_TEM_SUMMARY_M_PE = 0x1000, EBF_ERR_TEM_SUMMARY_M_TO = 0x2000, EBF_ERR_TEM_SUMMARY_M_MBZ = 0xC000 }
	Enumerates the in place masks of the various bit fields in the TEM error summary word. More...
enum	_EBF_ERR_GCCC_TYPE_K { EBF_ERR_GCCC_TYPE_K_START_BIT = 0, EBF_ERR_GCCC_TYPE_K_PARITY_ERR = 1, EBF_ERR_GCCC_TYPE_K_RSVD_2 = 2, EBF_ERR_GCCC_TYPE_K_RSVD_3 = 3 }
	Enumerates the possible GCCC error types. More...
enum	_EBF_ERR_GCCC_S { EBF_ERR_GCCC_S_TYPE = 4, EBF_ERR_GCCC_S_MBZ = 2, EBF_ERR_GCCC_S_NUM = 2, EBF_ERR_GCCC_S_GCRCS = 8 }
	Enumerates the sizes of the fields in the GCCC error word. More...
enum	_EBF_ERR_GCCC_V { EBF_ERR_GCCC_V_TYPE = 0, EBF_ERR_GCCC_V_MBZ = 4, EBF_ERR_GCCC_V_NUM = 6, EBF_ERR_GCCC_V_GCRCS = 8 }
	Enumerates the right justified bit offsets of the fields in the GCCC error word. More...
enum	_EBF_ERR_GCCC_M { EBF_ERR_GCCC_M_TYPE = 0x000f, EBF_ERR_GCCC_M_MBZ = 0x0030, EBF_ERR_GCCC_M_NUM = 0x00C0, EBF_ERR_GCCC_M_GCRCS = 0xff00 }
	Enumerates the in place masks of the fields in the GCCC error word. More...
enum	_EBF_ERR_GTCC_K { EBF_ERR_GTRC_K_MAX_WC = 9, EBF_ERR_GTCC_K_MAX_WC = 81 }
	Enumerates the constants of the TKR error contribution. More...
enum	_EBF_ERR_GTRC_S { EBF_ERR_GTRC_S_ID = 8, EBF_ERR_GTRC_S_RC_PE = 1, EBF_ERR_GTRC_S_FE_PE = 1, EBF_ERR_GTRC_S_FIFOFULL = 1, EBF_ERR_GTRC_S_TIMEOUT = 1, EBF_ERR_GTRC_S_HPARITY = 1, EBF_ERR_GTRC_S_WCPARITY = 1, EBF_ERR_GTRC_S_SUMMARY = 1, EBF_ERR_GTRC_S_DPARITY = 1 }
	Enumerates the sizes of the fields in the GTRC error word. More...
enum	_EBF_ERR_GTRC_V { EBF_ERR_GTRC_V_ID = 0, EBF_ERR_GTRC_V_RC_PE = 8, EBF_ERR_GTRC_V_FE_PE = 9, EBF_ERR_GTRC_V_FIFOFULL = 10, EBF_ERR_GTRC_V_TIEMOUT = 11, EBF_ERR_GTRC_V_HPARITY = 12, EBF_ERR_GTRC_V_WCPARITY = 13, EBF_ERR_GTRC_V_SUMMARY = 14, EBF_ERR_GTRC_V_DPARITY = 15 }
	Enumerates the right justified offsets of the fields in the GTRC error word. More...
enum	_EBF_ERR_GTRC_M { EBF_ERR_GTRC_M_ID = 0x00ff, EBF_ERR_GTRC_M_RC_PE = 0x0100, EBF_ERR_GTRC_M_FE_PE = 0x0200, EBF_ERR_GTRC_M_FIFOFULL = 0x0400, EBF_ERR_GTRC_M_TIMEOUT = 0x0800, EBF_ERR_GTRC_M_HPARITY = 0x1000, EBF_ERR_GTRC_M_WCPARITY = 0x2000, EBF_ERR_GTRC_M_SUMMARY = 0x4000, EBF_ERR_GTRC_M_DPARITY = 0x8000 }
	Enumerates the in place masks of the fields in the GTRC error word. More...
enum	_EBF_ERR_GTRC_PHASE_S { EBF_ERR_GTRC_PHASE_S_TAG_EXP = 2, EBF_ERR_GTRC_PHASE_S_TAG_RCV = 2, EBF_ERR_GTRC_PHASE_S_MBZ = 4, EBF_ERR_GTRC_PHASE_S_LYR_EXP = 4, EBF_ERR_GTRC_PHASE_S_LYR_RCV = 4 }
	Enumerates the sizes of the bit fields in the GTRC cable GTRC phasing error parameter word. More...
enum	_EBF_ERR_GTRC_PHASE_V { EBF_ERR_GTRC_PHASE_V_TAG_EXP = 0, EBF_ERR_GTRC_PHASE_V_TAG_RCV = 2, EBF_ERR_GTRC_PHASE_V_MBZ = 4, EBF_ERR_GTRC_PHASE_V_LYR_EXP = 8, EBF_ERR_GTRC_PHASE_V_LYR_RCV = 12 }
	Enumerates the right-justified offsets of the bit fields in the GTRC cable GTRC phasing error parameter word. More...
enum	_EBF_ERR_GTRC_PHASE_M { EBF_ERR_GTRC_PHASE_M_TAG_EXP = 0x0003, EBF_ERR_GTRC_PHASE_M_TAG_RCV = 0x000c, EBF_ERR_GTRC_PHASE_M_MBZ = 0x00f0, EBF_ERR_GTRC_PHASE_M_LYR_EXP = 0x0ff0, EBF_ERR_GTRC_PHASE_M_LYR_RCV = 0xf000 }
	Enumerates the in place masks of the bit fields in the GTRC cable GTRC phasing error parameter word. More...
enum	_EBF_ERR_TEM_PHASE_S { EBF_ERR_TEM_PHASE_S_GTCC3 = 2, EBF_ERR_TEM_PHASE_S_GTCC6 = 2, EBF_ERR_TEM_PHASE_S_GTCC2 = 2, EBF_ERR_TEM_PHASE_S_GTCC7 = 2, EBF_ERR_TEM_PHASE_S_GTCC0 = 2, EBF_ERR_TEM_PHASE_S_GTCC5 = 2, EBF_ERR_TEM_PHASE_S_GTCC1 = 2, EBF_ERR_TEM_PHASE_S_GTCC4 = 2 }
	Enumerates the sizes of the fields in common cable controller phasing error message. More...
enum	_EBF_ERR_TEM_PHASE_V { EBF_ERR_TEM_PHASE_V_GTCC3 = 0, EBF_ERR_TEM_PHASE_V_GTCC6 = 2, EBF_ERR_TEM_PHASE_V_GTCC2 = 4, EBF_ERR_TEM_PHASE_V_GTCC7 = 6, EBF_ERR_TEM_PHASE_V_GTCC0 = 8, EBF_ERR_TEM_PHASE_V_GTCC5 = 10, EBF_ERR_TEM_PHASE_V_GTCC1 = 12, EBF_ERR_TEM_PHASE_V_GTCC4 = 14 }
	Enumerates the right-justified offsets of the fields in common cable controller. More...
enum	_EBF_ERR_TEM_PHASE_M { EBF_ERR_TEM_PHASE_M_GTCC3 = 0x0003, EBF_ERR_TEM_PHASE_M_GTCC6 = 0x000c, EBF_ERR_TEM_PHASE_M_GTCC2 = 0x0030, EBF_ERR_TEM_PHASE_M_GTCC7 = 0x00c0, EBF_ERR_TEM_PHASE_M_GTCC0 = 0x0300, EBF_ERR_TEM_PHASE_M_GTCC5 = 0x0c00, EBF_ERR_TEM_PHASE_M_GTCC1 = 0x3000, EBF_ERR_TEM_PHASE_M_GTCC4 = 0xc000 }
	Enumerates the in place masks of the fields in common cable controller. More...
enum	_EBF_ERR_TEM_TIMEOUT_S { EBF_ERR_TEM_TIMEOUT_S_CAL = 4, EBF_ERR_TEM_TIMEOUT_S_TKR = 8, EBF_ERR_TEM_TIMEOUT_S_MBZ = 4 }
	Enumerates the sizes of the fields in common cable controller timeout error message. More...
enum	_EBF_ERR_TEM_TIMEOUT_V { EBF_ERR_TEM_TIMEOUT_V_CAL = 0, EBF_ERR_TEM_TIMEOUT_V_TKR = 4, EBF_ERR_TEM_TIMEOUT_V_MBZ = 12 }
	Enumerates the right-justified offsets of the fields in common cable controller timeout error message. More...
enum	_EBF_ERR_TEM_TIMEOUT_M { EBF_ERR_TEM_TIMEOUT_M_CAL = 0x000f, EBF_ERR_TEM_TIMEOUT_M_TKR = 0x0ff0, EBF_ERR_TEM_TIMEOUT_M_MBZ = 0xf000 }
	Enumerates the in place masks of the fields in common cable controller timeout error message. More...
Functions
static __inline const EBF_err *	EBF__errLocate (const EBF_tkr *tkr, int tkrLen, unsigned int has_dgn)
	Locates the error contribution. This routine starts with the knowledge of the TKR contribution and its length.
static __inline int	EBF__errCalBeg (const EBF_err *err, int idx)
	Returns the index of the word of the first CAL error word.
static __inline int	EBF__errCalEnd (const EBF_err *err, int idx)
	Returns the index of the word after the last CAL error word.
static __inline int	EBF__errTkrBeg (const EBF_err *err, int idx)
	Returns the index of the word of the first TKR error word.
static __inline int	EBF__errTkrEnd (const EBF_err *err, int idx)
	Returns the index of the word after the last TKR error word.
static __inline int	EBF__errTemPhaseBeg (const EBF_err *err, int idx)
	Returns the index of the first word of the TEM phasing error contribution.
static __inline int	EBF__errTemPhaseEnd (const EBF_err *err, int idx)
	Returns the index of the last word of the TEM phasing error contribution.
static __inline int	EBF__errTemTimeoutBeg (const EBF_err *err, int idx)
	Returns the index of the first word of the TEM phasing error contribution.
static __inline int	EBF__errTemTimeoutEnd (const EBF_err *err, int idx)
	Returns the index of the last word of the TEM timeout error contribution.
static __inline int	EBF__errEnd (const EBF_err *err)
	Returns the index of the last error word (actually one past the the last error word.
static __inline int	EBF__errSize (const EBF_err *err)
	Return the size, in bytes, of the error contribution.
static __inline int	EBF__errGCCCNumber (int cc)
	Translates a CAL cable controller readout order index to its cable controller electronics number.
static __inline char	EBF__errGCCCLabel (int cc)
	Translates a CAL cable controller readout order index to its cable controller electronics label.
static __inline int	EBF__errGTCCNumber (int cc)
	Translates a CAL cable controller readout order index to its cable controller electronics number.
static __inline char	EBF__errGTCCLabel (int cc)
	Translates a CAL cable controller readout order index to its cable controller electronics label.
static __inline int	EBF__errGTRCStackCount (unsigned int gtrc)
	Returns the number of stack words that this GTRC error word will consume.