EDR_err.h File Reference

Defines the structure containing the unpacked error records. More...

#include <EDS/EBF_err.h>

Classes
struct	_EDR_errStatusConditions_bf
	The conditions part of the status word. More...
union	_EDR_errStatusConditions
struct	_EDR_errStatus_ci
union	_EDR_errStatus
	Union of the different representations of the error unpacking status. More...
struct	_EDR_errTemSummary
	The unpacked TEM error summary record. More...
struct	_EDR_errGCCCStatus_bf
	The status word as bit fields. More...
union	_EDR_errGCCCStatus
	The status word as union between an uninterpretted 32-bit integer an its bit field representation. More...
struct	_EDR_errGCCC
struct	_EDR_errCalStatus_bf
	The status word as bit fields. More...
union	_EDR_errCalStatus
	The status word as union between an uninterpretted 32-bit integer an its bit field representation. More...
struct	_EDR_errCal
	The unpacked CAL error record. More...
struct	_EDR_errGTCCStatus_bf
	The status word as bit fields. More...
union	_EDR_errGTCCStatus
	The status word as union between an uninterpretted 32-bit integer an its bit field representation. More...
struct	_EDR_errGTRC
	The unpacked GTRC information. More...
struct	_EDR_errGTCC
	The unpacked GTCC information. More...
struct	_EDR_errTkrStatus_bf
	The status word as bit fields. More...
union	_EDR_errTkrStatus
	The status word as union between an uninterpretted 32-bit integer an its bit field representation. More...
struct	_EDR_errTkr
	The unpacked TKR error record. More...
struct	_EDR_errTemPhaseStatus_bf
	The status word as bit fields. More...
union	_EDR_errTemPhaseStatus
	The status word as union between an uninterpretted 32-bit integer an its bit field representation. More...
struct	_EDR_errTemPhase
	The unpacked data for the TEM PHASE error component. More...
struct	_EDR_errTemTimeoutStatus_bf
	The status word as bit fields. More...
union	_EDR_errTemTimeoutStatus
	The status word as union between an uninterpretted 32-bit integer an its bit field representation. More...
struct	_EDR_errTemTimeout
	The unpacked data for the TEM TIMEOUT error component. More...
struct	_EDR_errTem
	The unpacked error record for one TEM. More...
struct	_EDR_err
	The unpacked error records. More...
Typedefs
typedef enum _EDR_ERR_COMPONENT_K	EDR_ERR_COMPONENT_K
	Typedef for enum _EDR_ERR_COMPONENT_K.
typedef struct _EDR_errStatusConditions_bf	EDR_errStatusConditions_bf
	Typedef for struct _EDR_errStatusConditions_bf.
typedef union _EDR_errStatusConditions	EDR_errStatusConditions
typedef struct _EDR_errStatus_ci	EDR_errStatus_ci
typedef union _EDR_errStatus	EDR_errStatus
	Typedef for union _EDR_errStatus.
typedef struct _EDR_errTemSummary	EDR_errTemSummary
	Typedef for struct _EDR_errTemSummary.
typedef enum _EDR_ERR_GCCC_REASON_K	EDR_ERR_GCCC_REASON_K
	Typedef for enum _EDR_ERR_GCCC_REASON.
typedef struct _EDR_errGCCCStatus_bf	EDR_errGCCCStatus_bf
	Typedef for struct _EDR_errGTCCStatus_bf.
typedef union _EDR_errGCCCStatus	EDR_errGCCCStatus
	Typedef for struct _EDR_errGCCCStatus.
typedef struct _EDR_errGCCC	EDR_errGCCC
	Typedef for EDR_errGCCC.
typedef enum _EDR_ERR_CAL_REASON_K	EDR_ERR_CAL_REASON_K
	Typedef for enum _EDR_ERR_CAL_REASON.
typedef struct _EDR_errCalStatus_bf	EDR_errCalStatus_bf
	Typedef for struct _EDR_errCalStatus_bf.
typedef union _EDR_errCalStatus	EDR_errCalStatus
	Typedef for struct _EDR_errCalStatus.
typedef struct _EDR_errCal	EDR_errCal
	Typedef for EDR_errCal.
typedef enum _EDR_ERR_GTCC_REASON_K	EDR_ERR_GTCC_REASON_K
	Typedef for enum _EDR_ERR_GTCC_REASON.
typedef struct _EDR_errGTCCStatus_bf	EDR_errGTCCStatus_bf
	Typedef for struct _EDR_errGTCCStatus_bf.
typedef union _EDR_errGTCCStatus	EDR_errGTCCStatus
	Typedef for struct _EDR_errGTCCStatus.
typedef struct _EDR_errGTRC	EDR_errGTRC
	Typedef for struct _EDR_errGTRC.
typedef struct _EDR_errGTCC	EDR_errGTCC
	Typedef for struct _EDR_errGTCC.
typedef enum _EDR_ERR_TKR_REASON_K	EDR_ERR_TKR_REASON_K
	Typedef for enum _EDR_ERR_TKR_REASON.
typedef struct _EDR_errTkrStatus_bf	EDR_errTkrStatus_bf
	Typedef for struct _EDR_errTkrStatus_bf.
typedef union _EDR_errTkrStatus	EDR_errTkrStatus
	Typedef for struct _EDR_errTkrStatus.
typedef struct _EDR_errTkr	EDR_errTkr
	Typedef for EDR_errTkr.
typedef enum _EDR_ERR_TEM_PHASE_REASON_K	EDR_ERR_TEM_PHASE_REASON_K
	Typedef for enum _EDR_ERR_TEM_PHASE_REASON.
typedef struct _EDR_errTemPhaseStatus_bf	EDR_errTemPhaseStatus_bf
	Typedef for struct _EDR_errPhaseStatus_bf.
typedef union _EDR_errTemPhaseStatus	EDR_errTemPhaseStatus
	Typedef for struct _EDR_errTemPhaseStatus.
typedef struct _EDR_errTemPhase	EDR_errTemPhase
	Typedef for struct _EDR_errTemPhase.
typedef enum _EDR_ERR_TEM_TIMEOUT_REASON_K	EDR_ERR_TEM_TIMEOUT_REASON_K
	Typedef for enum _EDR_ERR_TEM_TIMEOUT_REASON.
typedef struct _EDR_errTemTimeoutStatus_bf	EDR_errTemTimeoutStatus_bf
	Typedef for struct _EDR_errTimeoutStatus_bf.
typedef union _EDR_errTemTimeoutStatus	EDR_errTemTimeoutStatus
	Typedef for struct _EDR_errTemTimeoutStatus.
typedef struct _EDR_errTemTimeout	EDR_errTemTimeout
	Typedef for struct _EDR_errTemTimeout.
typedef struct _EDR_errTem	EDR_errTem
	Typedef for struct _EDR_errTem.
typedef struct _EDR_err	EDR_err
	Typedef for _struct _EDR_err.
Enumerations
enum	_EDR_ERR_COMPONENT_K {   EDR_ERR_COMPONENT_K_NONE = 0,   EDR_ERR_COMPONENT_K_SUM = 1,   EDR_ERR_COMPONENT_K_CAL = 2,   EDR_ERR_COMPONENT_K_TKR = 3,   EDR_ERR_COMPONENT_K_TEM_PHASE = 4,   EDR_ERR_COMPONENT_K_TEM_TIMEOUT = 5 }
	Enumerates the offending component. More...
enum	_EDR_ERR_GCCC_REASON_K {   EDR_ERR_GCCC_REASON_K_MBZ = 0,   EDR_ERR_GCCC_REASON_K_TYPE = 1 }
	Enumerates the error reasons when decoding a GCCC record. More...
enum	_EDR_ERR_CAL_REASON_K {   EDR_ERR_CAL_REASON_K_ILLWC = 0,   EDR_ERR_CAL_REASON_K_OVRRUN = 1 }
	Enumerates the error reasons when decoding a CAL record. More...
enum	_EDR_ERR_GTCC_REASON_K {   EDR_ERR_GTCC_REASON_K_BADRC = 0,   EDR_ERR_GTCC_REASON_K_ORDERRC = 1,   EDR_ERR_GTCC_REASON_K_NOERR = 2,   EDR_ERR_GTCC_REASON_K_OVRFLW = 3 }
	Enumerates the error reasons when decoding a GTCC record. More...
enum	_EDR_ERR_TKR_REASON_K {   EDR_ERR_TKR_REASON_K_ILLWC = 0,   EDR_ERR_TKR_REASON_K_OVRRUN = 1 }
	Enumerates the error reasons when decoding a TKR record. More...
enum	_EDR_ERR_TEM_PHASE_REASON_K { EDR_ERR_TEM_PHASE_REASON_K_OVRRUN = 0 }
	Enumerates the error reasons when decoding a TEM PHASE record. More...
enum	_EDR_ERR_TEM_TIMEOUT_REASON_K {   EDR_ERR_TEM_TIMEOUT_REASON_K_OVRRUN = 0,   EDR_ERR_TEM_TIMEOUT_REASON_K_NOERR = 1,   EDR_ERR_TEM_TIMEOUT_REASON_K_MBZ = 2 }
	Enumerates the error reasons when decoding a TEM TIMEOUT record. More...
Functions
static __inline int	EDR__errStatusIsAbort (int status)
	Tests if the parsing status is bad, i.e. is the error record unparseable.

---

Detailed Description

Defines the structure containing the unpacked error records.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: EDR_err.h,v 1.3 2011/08/04 19:46:11 russell Exp $

---

Typedef Documentation

EDR_errCal

Typedef for EDR_errCal.

The CAL error record may experience the following types of errors

• Word count is invalid, it may either exceed the maximum of 8 per GCCC or it may be 0
• MBZ fields of a given error word maybe invalid
• Type field of a given error word maybe invalid

EDR_errGCCC

Typedef for EDR_errGCCC.

For each GCCC there can be up to 4 messages for each a missing start bit and a parity error for each of the four possible sweeps. My guess is that these are mutually exclusive,

The start and parity fields are contain the status of the 32 GTRCs. The order is

     y1- y0- y1+ y1+ x3- x2- x3+ x2- y3- y2- y3+ y2- x1- x0- x1+ x0+  

Where each field is 2-bits wide.

EDR_errStatusConditions_bf

Typedef for struct _EDR_errStatusConditions_bf.

This summarizes the status of each parsed component (SUMMARY, CAL, TKR, PHASE ERROR, TIMEOUT). The component is expected to declare

• Whether it wishes the parsing to be aborted
• Whether it's internal record is fatally flawed. In many cases these errors are serious enough to abort the parsing
• Whether it's internal record contains errors. The parsing of other components may continue, but the internal unpacking of the information for this record is likely not complete

The parsing status consumes 4 bits, on for the abort and 3 for the aborting component.

The fatal and warning fields each contain 5 bits, one per component.

---

Enumeration Type Documentation

enum _EDR_ERR_CAL_REASON_K

Enumerates the error reasons when decoding a CAL record.

Enumerator:

EDR_ERR_CAL_REASON_K_ILLWC	The word count is illegal, it be either 0 or greater than 8
EDR_ERR_CAL_REASON_K_OVRRUN	The decoding of the CAL record carried one past the end of legitimate data

enum _EDR_ERR_COMPONENT_K

Enumerates the offending component.

Enumerator:

EDR_ERR_COMPONENT_K_NONE	No component is in error
EDR_ERR_COMPONENT_K_SUM	The summary word is in error
EDR_ERR_COMPONENT_K_CAL	The CAL record is in error
EDR_ERR_COMPONENT_K_TKR	The TKR record is in error
EDR_ERR_COMPONENT_K_TEM_PHASE	The phasing word is in error
EDR_ERR_COMPONENT_K_TEM_TIMEOUT	The timeout word is in error

enum _EDR_ERR_GCCC_REASON_K

Enumerates the error reasons when decoding a GCCC record.

Enumerator:

EDR_ERR_GCCC_REASON_K_MBZ	The MBZ field is not zero
EDR_ERR_GCCC_REASON_K_TYPE	The error type field is illegal, it must 0 or 1

enum _EDR_ERR_GTCC_REASON_K

Enumerates the error reasons when decoding a GTCC record.

Enumerator:

EDR_ERR_GTCC_REASON_K_BADRC	The RC is greater than 8
EDR_ERR_GTCC_REASON_K_ORDERRC	The RC in the GTCC error message is not properly ordered. The RCs must be in decreasing order as one parses the error words from the highest addresses to the lowest addresses
EDR_ERR_GTCC_REASON_K_NOERR	The GTCC error message word does not have any error conditions set
EDR_ERR_GTCC_REASON_K_OVRFLW	Decoding the GTRC error stack attempted to consume more words than were available as specified by the count. Note that any underflow (not consuming enough words) cannot happen. One always continues to consume stack words until either one precisely exhausts the available words or an overflow occurs

enum _EDR_ERR_TEM_PHASE_REASON_K

Enumerates the error reasons when decoding a TEM PHASE record.

Enumerator:

EDR_ERR_TEM_PHASE_REASON_K_OVRRUN

The decoding of the TEM_PHASE record carried one past the end of legitimate data

enum _EDR_ERR_TEM_TIMEOUT_REASON_K

Enumerates the error reasons when decoding a TEM TIMEOUT record.

Enumerator:

EDR_ERR_TEM_TIMEOUT_REASON_K_OVRRUN	The decoding of the TEM TIMEOUT record carried one past the end of legitimate data
EDR_ERR_TEM_TIMEOUT_REASON_K_NOERR	The tem timeout error word did not specify any errors
EDR_ERR_TEM_TIMEOUT_REASON_K_MBZ	The tem timeout error word's mbz field was not 0

enum _EDR_ERR_TKR_REASON_K

Enumerates the error reasons when decoding a TKR record.

Enumerator:

EDR_ERR_TKR_REASON_K_ILLWC	The word count is illegal, it must not be either 0 or greater than ???
EDR_ERR_TKR_REASON_K_OVRRUN	The decoding of the TKR record carried one past the end of legitimate data

---

Function Documentation

static __inline int EDR__errStatusIsAbort

(

int

status

)

[static]

Tests if the parsing status is bad, i.e. is the error record unparseable.

Return values:

	==	0, okay
	!=	0, is bad

Parameters:

status

The parsing status to check