Doxygen Page for LRA / V5-2-0 / test

#include "LRA/LRA.h"
#include "PBS/FPA.h"
#include "PBS/MTX.h"
#include "PBS/SEM.h"
#include "PBS/WUT.h"
#include "ITC/ITC_pubdefs.h"
#include "IMM/RBM_pubdefs.h"
#include "LEM/list.h"


Classes
struct	_LRA_return
	Request return block. More...
struct	_LRA_cmdList
	Command list structure. More...
struct	_LRA_rspList
	Response list structure. More...
struct	_LRA_dataItem
	Read data item structure. More...
struct	_LRA_dcdItem
	Decode list item structure. More...
struct	_LRA_crl
struct	_LRA_sregData
	Structure to hold raw statistics registers. More...
struct	_LRA_crReg
	Command/response statistics register. More...
struct	_LRA_rcvReg
	Receive statistics register. More...
struct	_LRA_xmtReg
	Transmit statistics register. More...
struct	_LRA_aemCstReg
	AEM common status register. More...
struct	_LRA_aemFstReg
	AEM FREE board status register. More...
struct	_LRA_aemTstReg
	AEM trigger message statistics register. More...
struct	_LRA_temStReg
	TEM status register. More...
struct	_LRA_ticStReg
	TIC status register. More...
struct	_LRA_cccStReg
	CCC status register. More...
struct	_LRA_tccStReg
	TCC status register. More...
struct	_LRA_control
	Control structure. More...
struct	_LRA_whiteBox
	White-box access structure. More...
Defines
#define	NELEM(x) (sizeof x / sizeof x[0])
	Array size macro.
Typedefs
typedef enum _LRA_function	LRA_function
	Function codes.
typedef enum _LRA_miscP	LRA_miscP
	Miscellaneous private constants.
typedef enum _LRA_gctWidth	LRA_gctWidth
	GEM counter register widths.
typedef struct _LRA_return	LRA_return
	Request return block.
typedef struct _LRA_cmdList	LRA_cmdList
	Command list structure.
typedef struct _LRA_rspList	LRA_rspList
	Response list structure.
typedef void(*	LRA_decodeFn )(const unsigned short pkt, void data)
	Decode function type.
typedef struct _LRA_dataItem	LRA_dataItem
	Read data item structure.
typedef struct _LRA_dcdItem	LRA_dcdItem
	Decode list item structure.
typedef struct _LRA_crl	LRA_crl
	Command/response list anchor block.
typedef struct _LRA_sregData	LRA_sregData
	Structure to hold raw statistics registers.
typedef struct _LRA_crReg	LRA_crReg
	Command/response statistics register.
typedef struct _LRA_rcvReg	LRA_rcvReg
	Receive statistics register.
typedef struct _LRA_xmtReg	LRA_xmtReg
	Transmit statistics register.
typedef struct _LRA_aemCstReg	LRA_aemCstReg
	AEM common status register.
typedef struct _LRA_aemFstReg	LRA_aemFstReg
	AEM FREE board status register.
typedef struct _LRA_aemTstReg	LRA_aemTstReg
	AEM trigger message statistics register.
typedef struct _LRA_temStReg	LRA_temStReg
	TEM status register.
typedef struct _LRA_ticStReg	LRA_ticStReg
	TIC status register.
typedef struct _LRA_cccStReg	LRA_cccStReg
	CCC status register.
typedef struct _LRA_tccStReg	LRA_tccStReg
	TCC status register.
typedef struct _LRA_control	LRA_control
	Control structure.
typedef unsigned	LRA_fnCheck (int func, const LRA_regSpec rSpec, const LRA_cmptDesc *desc)
	Typedefs for private functions.
typedef void	LRA_fnDecodeAFE (const unsigned short pkt, unsigned short value)
typedef void	LRA_fnDecodeARC (const unsigned short pkt, unsigned short value)
typedef void	LRA_fnDecodeCFE (const unsigned short pkt, unsigned short value)
typedef void	LRA_fnDecodeCRC (const unsigned short pkt, unsigned short value)
typedef void	LRA_fnDecodeTDC (const unsigned short pkt, long long value)
typedef void	LRA_fnDecodeTFE (const unsigned short pkt, long long value)
typedef void	LRA_fnDecodeTRC (const unsigned short pkt, long long value)
typedef unsigned	LRA_fnDoCtrl (LEM_micr crl, const LRA_regSpec rSpec)
typedef unsigned	LRA_fnDoLam (LEM_micr *crl, unsigned cmpt, unsigned tem)
typedef unsigned	LRA_fnDoLamLcb (LEM_micr *crl, unsigned cmpt, unsigned value, unsigned mask)
typedef unsigned	LRA_fnDoLoad (LEM_micr crl, const LRA_regSpec rSpec, const long long *value)
typedef unsigned	LRA_fnDoRead (LEM_micr crl, const LRA_regSpec rSpec, LRA_regData *data)
typedef unsigned	LRA_fnDoReadEsr (LEM_micr crl, LRA_esrData esr)
typedef unsigned	LRA_fnDoSend (const LRA_regSpec *rSpec, int ssr)
typedef unsigned	LRA_fnDoSendEsr (void)
typedef unsigned	LRA_fnDoSendStats (void)
typedef unsigned	LRA_fnFreeStats (LRA_control *ctrl)
typedef unsigned	LRA_fnInitCrl (void lists, unsigned int len, LEM_micr crl)
typedef unsigned	LRA_fnInitStats (LRA_control *ctrl)
typedef unsigned	LRA_fnGetCtrl (LRA_control **ctrl)
typedef unsigned	LRA_fnProcess (void prm, const ITC_QueueItem qItem, void *pay, unsigned len)
typedef unsigned	LRA_fnUpdateStats (LRA_control *ctrl, int clear)
typedef struct _LRA_whiteBox	LRA_whiteBox
	White-box access structure.
Enumerations
enum	_LRA_function { LRA_FNC_READ = 0, LRA_FNC_LOAD = 1, LRA_FNC_CONTROL = 2, LRA_FNC_SEND = 10, LRA_FNC_SENDESR = 11, LRA_FNC_SENDSTATS = 12 }
	Function codes. More...
enum	_LRA_miscP { LRA_NUM_RQSTS = 4, LRA_NUM_UPDATE = 1, LRA_NUM_PKTS = 10, LRA_MAX_DATA = 4096, LRA_NUM_DGMS = 5, LRA_MAX_CNTRL = 15, LRA_MAX_CRL = 160, LRA_CTR_OFLOW = 0x3fff, LRA_DFLT_PRD = 100, LRA_DFLT_TEMS = 0xffff }
	Miscellaneous private constants. More...
enum	_LRA_gctWidth { LRA_GCW_TIMEBASE = 25, LRA_GCW_LIVETIME = 25, LRA_GCW_PRESCALE = 24, LRA_GCW_DISCARD = 24, LRA_GCW_SENT = 16, LRA_GCW_DEADZONE = 16 }
	GEM counter register widths. More...
Functions
unsigned	LRA_check (int func, const LRA_regSpec rSpec, const LRA_cmptDesc *desc)
void	LRA_decodeAFE (const unsigned short pkt, unsigned short value)
void	LRA_decodeARC (const unsigned short pkt, unsigned short value)
void	LRA_decodeCFE (const unsigned short pkt, unsigned short value)
void	LRA_decodeCRC (const unsigned short pkt, unsigned short value)
void	LRA_decodeTDC (const unsigned short pkt, long long value)
void	LRA_decodeTFE (const unsigned short pkt, long long value)
void	LRA_decodeTRC (const unsigned short pkt, long long value)
unsigned	LRA_doCtrl (LEM_micr crl, const LRA_regSpec rSpec)
unsigned	LRA_doLam (LEM_micr *crl, unsigned cmpt, unsigned tem)
unsigned	LRA_doLamLcb (LEM_micr *crl, unsigned cmpt, unsigned value, unsigned mask)
unsigned	LRA_doLoad (LEM_micr crl, const LRA_regSpec rSpec, const long long *value)
unsigned	LRA_doRead (LEM_micr crl, const LRA_regSpec rSpec, LRA_regData *data)
unsigned	LRA_doReadEsr (LEM_micr crl, LRA_esrData esr)
unsigned	LRA_doSend (const LRA_regSpec *rSpec, int ssr)
unsigned	LRA_doSendEsr (void)
unsigned	LRA_doSendStats (void)
unsigned	LRA_freeStats (LRA_control *ctrl)
unsigned	LRA_initCrl (void lists, unsigned int len, LEM_micr crl)
unsigned	LRA_initStats (LRA_control *ctrl)
unsigned	LRA_getCtrl (LRA_control **ctrl)
unsigned	LRA_process (void prm, const ITC_QueueItem qItem, void *pay, unsigned len)
unsigned	LRA_updateStats (LRA_control *ctrl, int clear)

Detailed Description

Enumeration Type Documentation

enum _LRA_function

Function codes.

Enumerator:

LRA_FNC_READ	Read registers.
LRA_FNC_LOAD	Load registers.
LRA_FNC_CONTROL	Perform control (dataless) operation.
LRA_FNC_SEND	Send registers on science interface.
LRA_FNC_SENDESR	Send ESR data on science interface.
LRA_FNC_SENDSTATS	Send statistics data on science interface.

enum _LRA_gctWidth

GEM counter register widths.

Enumerator:

LRA_GCW_TIMEBASE	Timebase.
LRA_GCW_LIVETIME	Livetime.
LRA_GCW_PRESCALE	Prescaled.
LRA_GCW_DISCARD	Discarded.
LRA_GCW_SENT	Sent.
LRA_GCW_DEADZONE	Deadzoned.

enum _LRA_miscP

Miscellaneous private constants.

Enumerator:

LRA_NUM_RQSTS	Number of available request packets.
LRA_NUM_UPDATE	Number of available update request packets.
LRA_NUM_PKTS	Number of diagnostic packets in pool.
LRA_MAX_DATA	Maximum diagnostic data size.
LRA_NUM_DGMS	Number of science datagrams in pool.
LRA_MAX_CNTRL	Maximum value of control function.
LRA_MAX_CRL	Maximum number of items in a C/R list.
LRA_CTR_OFLOW	Saturating counter overflow value.
LRA_DFLT_PRD	Default statistics update period (1/100 sec).
LRA_DFLT_TEMS	Default mask of TEMs RCV stats to sample.

LRA_p.h File Reference

Classes

Defines

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation