CDF_tkr_def.h File Reference

Compress structures for the TKR contribution. More...

#include <EDS/EDA_tkr.h>
#include <LSE/LFR_refdef.h>
#include <PBI/Endianness.h>

Classes
struct	_CDF_tkr_splits_limit
	Defines the low and high strip numbers for each layer end. More...
union	_CDF_tkr_splits_layer
	The lo and hi splits for one layer expressed as a union of field definition and an array definition. More...
union	_CDF_tkr_splits_tower
	The lo and hi splits for one tower expressed as a union of field definition and an array definition. More...
union	_CDF_tkr_splits
	The lo and hi splits for entire TKR expressed as a union of field definition and an array definition. More...
struct	_CDF_tkr_refs
	Structure containing all the file reference keys. More...
struct	_CDF_tkr_std_mon_lyr
	Captures the monitoring context of a single layer. More...
struct	_CDF_tkr_std_mon_twr
	Captures the monitoring context for a single tower. More...
struct	_CDF_tkr_std_mon
	Captures the monitoring context for the entire tracker. More...
struct	_CDF_tkr_err_status_bf
	Gives the rc, reason and bit offset for a decoding failure. More...
union	_CDF_tkr_err_status
	Gives the rc, reason and bit offset for a decoding failure. More...
struct	_CDF_tkr_err_dsc
	Captures the information of one decoding RC. More...
struct	_CDF_tkr_err_tot
	Captures the TOT value and whether it is from a timeout'd CC. More...
struct	_CDF_tkr_err
	Captures the high level information about the TKR data in towers with readout errors used to compress the data for one tower. More...
struct	_CDF_tkr
	The TKR compression context. More...
Defines
#define	CDF_TKR_STD_MON
#define	cdf_tkr_std_mon(statement,...)   statement ## __VA_ARGS__
Typedefs
typedef struct _EBF_tkr	EBF_tkr
typedef struct _EDR_tkrLayer	EDR_tkrLayer
typedef struct _EDR_tkrTower	EDR_tkrTower
typedef struct _CDF_tkr_splits_limit	CDF_tkr_splits_limit
	Typedef for _CDF_tkr_splits_limit.
typedef union _CDF_tkr_splits_layer	CDF_tkr_splits_layer
	Typedef for union _CDF_tkr_splits_layer.
typedef union _CDF_tkr_splits_tower	CDF_tkr_splits_tower
	Typedef for union _CDF_tkr_splits_tower.
typedef union _CDF_tkr_splits	CDF_tkr_splits
	Typedef for union _CDF_tkr_splits.
typedef struct _CDF_tkr_refs	CDF_tkr_refs
	Typedef for struct _CDF_tkr_refs.
typedef struct _CDF_tkr_std_mon_lyr	CDF_tkr_std_mon_lyr
	Typedef for struct _CDF_tkr_std_mon_lyr.
typedef struct _CDF_tkr_std_mon_twr	CDF_tkr_std_mon_twr
	Typedef for struct _CDF_tkr_std_mon_twr.
typedef struct _CDF_tkr_std_mon	CDF_tkr_std_mon
	Typedef for struct _CDF_tkr_std_mon.
typedef enum _CDF_TKR_ERR_REASON_K	CDF_TKR_ERR_REASON_K
typedef struct _CDF_tkr_err_status_bf	CDF_tkr_err_status_bf
	Typedef for struct _CDF_tkr_err_status_bf.
typedef union _CDF_tkr_err_status	CDF_tkr_err_status
typedef struct _CDF_tkr_err_dsc	CDF_tkr_err_dsc
	Typedef for struct _CDF_tkr_err_dsc.
typedef struct _CDF_tkr_err_tot	CDF_tkr_err_tot
	Typedef for struct _CDF_tkr_err_tot.
typedef struct _CDF_tkr_err	CDF_tkr_err
	Typedef for struct _CDF_tkr_err.
typedef struct _CDF_tkr	CDF_tkr
	Typedef for struct _CDF_tkr.
Enumerations
enum	_CDF_TKR_ERR_REASON_K {   CDF_TKR_ERR_REASON_K_OVRRUN = 0x10,   CDF_TKR_ERR_REASON_K_UNDRUN = 0x11,   CDF_TKR_ERR_REASON_K_TO_RC = 0x20,   CDF_TKR_ERR_REASON_K_TO_ERROR = 0x21,   CDF_TKR_ERR_REASON_K_TO_TAG = 0x22,   CDF_TKR_ERR_REASON_K_TO_SPARE = 0x23,   CDF_TKR_ERR_REASON_K_TO_PE_HDR = 0x24,   CDF_TKR_ERR_REASON_K_TO_PE_CNT = 0x25,   CDF_TKR_ERR_REASON_K_TO_PE_DAT = 0x26,   CDF_TKR_ERR_REASON_K_TO_UND_LEN = 0x27,   CDF_TKR_ERR_REASON_K_TO_OVR_LEN = 0x28,   CDF_TKR_ERR_REASON_K_TO_STRIP_SEQ = 0x29,   CDF_TKR_ERR_REASON_K_TO_STRIP_INVALID = 0x2a,   CDF_TKR_ERR_REASON_K_TO_CNT_INS_DAV = 0x30,   CDF_TKR_ERR_REASON_K_TO_CNT_OVR_DAV = 0x31,   CDF_TKR_ERR_REASON_K_TO_CNT_INS_TAG_ERR = 0x32,   CDF_TKR_ERR_REASON_K_TO_CNT_OVR_TAG_ERR = 0x33,   CDF_TKR_ERR_REASON_K_TO_CNT_INS_BOTH = 0x34,   CDF_TKR_ERR_REASON_K_TO_CNT_OVR_BOTH = 0x35,   CDF_TKR_ERR_REASON_K_TO_ET_HDR = 0x38,   CDF_TKR_ERR_REASON_K_TO_ET_HDRX = 0x39,   CDF_TKR_ERR_REASON_K_TO_ET_CNT = 0x3A,   CDF_TKR_ERR_REASON_K_TO_ET_CNTX = 0x3B,   CDF_TKR_ERR_REASON_K_TO_ET_DAT = 0x3C,   CDF_TKR_ERR_REASON_K_TO_ET_DATX = 0x3D,   CDF_TKR_ERR_REASON_K_STRIP_SEQ = 0x40,   CDF_TKR_ERR_REASON_K_STRIP_INVALID = 0x41 }
enum	ET {   ET_HDR = CDF_TKR_ERR_REASON_K_TO_ET_HDR,   ET_HDRX = CDF_TKR_ERR_REASON_K_TO_ET_HDRX,   ET_CNT = CDF_TKR_ERR_REASON_K_TO_ET_CNT,   ET_CNTX = CDF_TKR_ERR_REASON_K_TO_ET_CNTX,   ET_DAT = CDF_TKR_ERR_REASON_K_TO_ET_DAT,   ET_DATX = CDF_TKR_ERR_REASON_K_TO_ET_DATX }
	Short names for the early termination reason codes. More...
Functions
static __inline unsigned int	CDF_tkr_err_status_compose (int rc, CDF_TKR_ERR_REASON_K reason, unsigned int doff)
void	CDF_tkr_std_mon_print (const CDF_tkr_std_mon *cdf)

---

Detailed Description

Compress structures for the TKR contribution.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: CDF_tkr_def.h,v 1.4 2011/03/26 17:35:24 russell Exp $

---

Enumeration Type Documentation

enum _CDF_TKR_ERR_REASON_K

Enumerator:

CDF_TKR_ERR_REASON_K_OVRRUN	Decode process overran the the available data
CDF_TKR_ERR_REASON_K_UNDRUN	Decode process underran the the available data, that is, more than the expected amount of data was left in the buffer when decoding claimed it was done
CDF_TKR_ERR_REASON_K_TO_RC	Decoded rc number did not match the expected rc
CDF_TKR_ERR_REASON_K_TO_ERROR	The error field was not 0 as expected
CDF_TKR_ERR_REASON_K_TO_TAG	The tag filed was not as predicted from the event tag
CDF_TKR_ERR_REASON_K_TO_SPARE	Decoded spare bits were not 0 as expected
CDF_TKR_ERR_REASON_K_TO_PE_HDR	The decoded header message had the wrong parity
CDF_TKR_ERR_REASON_K_TO_PE_CNT	The decoded count message had the wrong parity
CDF_TKR_ERR_REASON_K_TO_PE_DAT	The decoded data had the wrong parity
CDF_TKR_ERR_REASON_K_TO_UND_LEN	The decoded length of a TO RC was less than 127
CDF_TKR_ERR_REASON_K_TO_OVR_LEN	The decoded length of a TO RC was greater than 127
CDF_TKR_ERR_REASON_K_TO_STRIP_SEQ	Strip addresses not properly sequenced. They must be in ascending order.
CDF_TKR_ERR_REASON_K_TO_STRIP_INVALID	Strip address is larger than 1535
CDF_TKR_ERR_REASON_K_TO_CNT_INS_DAV	The count message specified less than the minimum of 2 data words to follow, 1 strip address + 1 TOT
CDF_TKR_ERR_REASON_K_TO_CNT_OVR_DAV	The count message specified more than the maximum of 128 data words to follow, 127 strip addresses + 1 TOT
CDF_TKR_ERR_REASON_K_TO_CNT_INS_TAG_ERR	The count message specified less than the minimum of 5 tag error words to follow, strip address + TOT
CDF_TKR_ERR_REASON_K_TO_CNT_OVR_TAG_ERR	The count message specified less than the minimum of 5 tag error words to follow, strip address + TOT
CDF_TKR_ERR_REASON_K_TO_CNT_INS_BOTH	The count message specified less than the minimum of 7 words, 5 tag error words + 1 strip + 1 TOT to follow
CDF_TKR_ERR_REASON_K_TO_CNT_OVR_BOTH	The count message specified less than the maximum of 133 words, 5 tag error words + 127 strip + 1 TOT to follow
CDF_TKR_ERR_REASON_K_TO_ET_HDR	Premature terminator during read of the initial header message word.
CDF_TKR_ERR_REASON_K_TO_ET_HDRX	Premature terminator during read of the extra header message word. This word is not always present.
CDF_TKR_ERR_REASON_K_TO_ET_CNT	Premature terminator during read of the initial count message word.
CDF_TKR_ERR_REASON_K_TO_ET_CNTX	Premature terminator during read of the extra count message word. This word is not always present.
CDF_TKR_ERR_REASON_K_TO_ET_DAT	Premature terminator during read of the data words.
CDF_TKR_ERR_REASON_K_TO_ET_DATX	Premature terminator during read of the extra data word to get the final data parity bit. This word is not always present.
CDF_TKR_ERR_REASON_K_STRIP_SEQ	Strip addresses not properly sequenced. They must be in ascending order.
CDF_TKR_ERR_REASON_K_STRIP_INVALID	Strip address is larger than 1535

enum ET

Short names for the early termination reason codes.

Enumerator:

ET_HDR	Premature terminator during read of the initial header message word.
ET_HDRX	Premature terminator during read of the extra header message word. This word is not always present.
ET_CNT	Premature terminator during read of the initial count message word.
ET_CNTX	Premature terminator during read of the extra count message word. This word is not always present.
ET_DAT	Premature terminator during read of the data words.
ET_DATX	Premature terminator during read of the extra data word to get the final data parity bit. This word is not always present.