GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QLRA / dev > qlra / rhel5-64

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QLRA » dev » QLRA

QLRA.h File Reference

Public definitions for the register display routines. More...

#include <PBS/WCT.h>

Classes

struct  _QLRA_regSpec
 Structure to specify a register, or set of registers. More...
struct  _QLRA_regData
 Structure to hold returned register data. More...
struct  _QLRA_esrData
 Structure to hold returned error and status register data. More...
struct  _QLRA_cmdStats
 Structure to hold command statistics. More...
struct  _QLRA_rcvStats
 Structure to hold receive statistics. More...
struct  _QLRA_trcvStats
 Structure to hold TEM receive statistics. More...
struct  _QLRA_xmtStats
 Structure to hold transmit/response statistics. More...
struct  _QLRA_aemTrgStats
 Structure to hold AEM trigger statistics. More...
struct  _QLRA_arcErrStats
 Structure to hold ARC event error statistics. More...
struct  _QLRA_fifoStats
 Structure to hold CC FIFO statistics. More...
struct  _QLRA_cntrStats
 Structure to hold simple counter statistics. More...
struct  _QLRA_gemStats
 Structure to hold GEM statistics. More...
struct  _QLRA_gemStats_V2
 Structure to hold GEM statistics, version 2. More...
struct  _QLRA_gemStats_V1
 Structure to hold GEM statistics, version 1. More...
struct  _QLRA_cruStats
 Structure to hold CRU statistics. More...
struct  _QLRA_pduStats
 Structure to hold PDU statistics. More...
struct  _QLRA_ebmStats
 Structure to hold EBM statistics. More...
struct  _QLRA_ebmStats_V3
 Structure to hold EBM statistics, version 3 and lower. More...
struct  _QLRA_aemStats
 Structure to hold AEM statistics. More...
struct  _QLRA_temStats
 Structure to hold TEM statistics. More...
struct  _QLRA_ticStats
 Structure to hold TIC statistics. More...
struct  _QLRA_cccStats
 Structure to hold CCC statistics. More...
struct  _QLRA_tccStats
 Structure to hold TCC statistics. More...
struct  _QLRA_stats
 Structure to hold complete statistics. More...
struct  _QLRA_stats_V3
 Structure to hold complete statistics, version 3. More...
struct  _QLRA_stats_V2
 Structure to hold complete statistics, version 2. More...
struct  _QLRA_stats_V1
 Structure to hold complete statistics, version 1. More...

Typedefs

typedef enum _QLRA_disp QLRA_disp
 Display options.
typedef enum _QLRA_misc QLRA_misc
 Miscellaneous definitions.
typedef enum _QLRA_component QLRA_component
 Component identifiers.
typedef enum _QLRA_counts QLRA_counts
 Conponent counts.
typedef enum _QLRA_statsVersion QLRA_statsVersion
 Statistics block version.
typedef struct _QLRA_regSpec QLRA_regSpec
 Structure to specify a register, or set of registers.
typedef struct _QLRA_regData QLRA_regData
 Structure to hold returned register data.
typedef struct _QLRA_esrData QLRA_esrData
 Structure to hold returned error and status register data.
typedef struct _QLRA_cmdStats QLRA_cmdStats
 Structure to hold command statistics.
typedef struct _QLRA_rcvStats QLRA_rcvStats
 Structure to hold receive statistics.
typedef struct _QLRA_trcvStats QLRA_trcvStats
 Structure to hold TEM receive statistics.
typedef struct _QLRA_xmtStats QLRA_xmtStats
 Structure to hold transmit/response statistics.
typedef struct _QLRA_aemTrgStats QLRA_aemTrgStats
 Structure to hold AEM trigger statistics.
typedef struct _QLRA_arcErrStats QLRA_arcErrStats
 Structure to hold ARC event error statistics.
typedef struct _QLRA_fifoStats QLRA_fifoStats
 Structure to hold CC FIFO statistics.
typedef struct _QLRA_cntrStats QLRA_cntrStats
 Structure to hold simple counter statistics.
typedef struct _QLRA_gemStats QLRA_gemStats
 Structure to hold GEM statistics.
typedef struct _QLRA_gemStats_V2 QLRA_gemStats_V2
 Structure to hold GEM statistics, version 2.
typedef struct _QLRA_gemStats_V1 QLRA_gemStats_V1
 Structure to hold GEM statistics, version 1.
typedef struct _QLRA_cruStats QLRA_cruStats
 Structure to hold CRU statistics.
typedef struct _QLRA_pduStats QLRA_pduStats
 Structure to hold PDU statistics.
typedef struct _QLRA_ebmStats QLRA_ebmStats
 Structure to hold EBM statistics.
typedef struct _QLRA_ebmStats_V3 QLRA_ebmStats_V3
 Structure to hold EBM statistics, version 3 and lower.
typedef struct _QLRA_aemStats QLRA_aemStats
 Structure to hold AEM statistics.
typedef struct _QLRA_temStats QLRA_temStats
 Structure to hold TEM statistics.
typedef struct _QLRA_ticStats QLRA_ticStats
 Structure to hold TIC statistics.
typedef struct _QLRA_cccStats QLRA_cccStats
 Structure to hold CCC statistics.
typedef struct _QLRA_tccStats QLRA_tccStats
 Structure to hold TCC statistics.
typedef struct _QLRA_stats QLRA_stats
 Structure to hold complete statistics.
typedef struct _QLRA_stats_V3 QLRA_stats_V3
 Structure to hold complete statistics, version 3.
typedef struct _QLRA_stats_V2 QLRA_stats_V2
 Structure to hold complete statistics, version 2.
typedef struct _QLRA_stats_V1 QLRA_stats_V1
 Structure to hold complete statistics, version 1.
typedef void(* QLRA_regsCb )(unsigned int secs, QLRA_regData *rData, void *parm)
 Callback routines to process LRA data.
typedef void(* QLRA_esrCb )(unsigned int secs, QLRA_esrData *rData, void *parm)
typedef void(* QLRA_statsCb )(unsigned int secs, QLRA_stats *sData, void *parm)

Enumerations

enum  _QLRA_disp {
  QLRA_DOPT_PLAIN = 0x01,
  QLRA_DOPT_NOHDR = 0x02
}
 Display options. More...
enum  _QLRA_misc {
  QLRA_WILD = 255,
  QLRA_ACTIVE = 254
}
 Miscellaneous definitions. More...
enum  _QLRA_component {
  QLRA_CPT_GEM = 1,
  QLRA_CPT_EBM = 2,
  QLRA_CPT_PDU0 = 3,
  QLRA_CPT_PDU1 = 4,
  QLRA_CPT_CRU = 5,
  QLRA_CPT_TEM = 6,
  QLRA_CPT_TIC = 7,
  QLRA_CPT_CCC = 8,
  QLRA_CPT_CRC = 9,
  QLRA_CPT_CFE = 10,
  QLRA_CPT_TCC = 11,
  QLRA_CPT_TRC = 12,
  QLRA_CPT_TFE = 13,
  QLRA_CPT_AEM = 14,
  QLRA_CPT_ARC = 15,
  QLRA_CPT_AFE = 16,
  QLRA_CPT_SIUE = 33,
  QLRA_CPT_SIU0 = 34,
  QLRA_CPT_SIU1 = 35,
  QLRA_CPT_EPU0 = 36,
  QLRA_CPT_EPU1 = 37,
  QLRA_CPT_EPU2 = 38,
  QLRA_CPT_BCST = QLRA_WILD
}
 Component identifiers.
enum  _QLRA_counts {
  QLRA_N_TEM = 16,
  QLRA_N_CCC = 4,
  QLRA_N_TCC = 8,
  QLRA_N_CRC = 4,
  QLRA_N_TRC = 9,
  QLRA_N_ARC = 12,
  QLRA_N_CFE = 12,
  QLRA_N_TFE = 24,
  QLRA_N_AFE = 18
}
 Conponent counts. More...
enum  _QLRA_statsVersion {
  QLRA_STATS_MAJOR = 4,
  QLRA_STATS_MINOR = 0
}
 Statistics block version. More...

Functions

void QLRA_dispEsrData (unsigned int secs, QLRA_esrData *rData, void *parm)
 Display error and status register data.
void QLRA_dispRegData (unsigned int secs, QLRA_regData *rData, void *parm)
 Display register data.
void QLRA_dispStats (unsigned int secs, QLRA_stats *sData, void *parm)
 Display statistics data.
unsigned QLRA_readDiag (char *fName, void *parm, QLRA_regsCb regsRtn)
 Read the contents of an LRA packet file.
unsigned QLRA_readSci (char *fName, void *parm, QLRA_regsCb regsRtn, QLRA_esrCb esrRtn, QLRA_statsCb statsRtn)
 Read the contents of an LRA datagram file.

Detailed Description

Public definitions for the register display routines.

Author:
Owen H Saxton
Id
QLRA.h,v 1.4 2011/03/29 21:10:35 saxton Exp

Enumeration Type Documentation

enum _QLRA_counts

Conponent counts.

Enumerator:
QLRA_N_TEM  Number of TEMs.
QLRA_N_CCC  Number of CAL cable controllers.
QLRA_N_TCC  Number of TKR cable controllers.
QLRA_N_CRC  Number of CAL readout controllers.
QLRA_N_TRC  Number of TKR readout controllers.
QLRA_N_ARC  Number of ACD readout controllers.
QLRA_N_CFE  Number of CAL front-ends.
QLRA_N_TFE  Number of TKR front-ends.
QLRA_N_AFE  Number of ACD front-ends.

enum _QLRA_disp

Display options.

Enumerator:
QLRA_DOPT_PLAIN  Do plain display.
QLRA_DOPT_NOHDR  Don't display header line.

enum _QLRA_misc

Miscellaneous definitions.

Enumerator:
QLRA_WILD  General purpose wild-card value.
QLRA_ACTIVE  TEM or ARC specifier, active only.

enum _QLRA_statsVersion

Statistics block version.

Enumerator:
QLRA_STATS_MAJOR  Major version number.
QLRA_STATS_MINOR  Minor version number.

Function Documentation

void QLRA_dispEsrData ( unsigned int  secs,
QLRA_esrData *  rData,
void *  parm 
)

Display error and status register data.

This routine produces a formatted display of the contents of a block of error and status register data.

Parameters:
secs The time the register data was obtained, in spacecraft units.
rData The register data to be displayed.
parm Options to modify the display.

References _QLRA_esrData::afe, _QLRA_esrData::arc, _QLRA_esrData::crc, QLRA_DOPT_PLAIN, QLRA_N_AFE, QLRA_N_ARC, QLRA_N_CCC, QLRA_N_CRC, QLRA_N_TCC, QLRA_N_TEM, QLRA_N_TRC, and _QLRA_esrData::trc.

void QLRA_dispRegData ( unsigned int  secs,
QLRA_regData *  rData,
void *  parm 
)

Display register data.

This routine produces a formatted display of the contents of a block of register data.

Parameters:
secs The time the register data was obtained, in spacecraft units.
rData The register data to be displayed.
parm Options to modify the display.

void QLRA_dispStats ( unsigned int  secs,
QLRA_stats *  sData,
void *  parm 
)

Display statistics data.

This routine produces a formatted display of the contents of a block of statistics data.

Parameters:
secs The time the data was sent, in spacecraft units.
sData The statistics data to be displayed.
parm Options to modify the display.

References _QLRA_stats::aem, _QLRA_ebmStats::aemR, _QLRA_gemStats::base, _QLRA_stats::ccc, _QLRA_temStats::cmd, _QLRA_aemStats::cmd, _QLRA_ebmStats::cmd, _QLRA_pduStats::cmd, _QLRA_cruStats::cmd, _QLRA_gemStats::cmd, _QLRA_stats::cru, _QLRA_gemStats::dead, _QLRA_gemStats::disc, _QLRA_stats::ebm, _QLRA_stats::endTime, _QLRA_ebmStats::epu0R, _QLRA_ebmStats::epu0S, _QLRA_ebmStats::epu1R, _QLRA_ebmStats::epu1S, _QLRA_ebmStats::epu2R, _QLRA_ebmStats::epu2S, _QLRA_temStats::evt, _QLRA_aemStats::evt, _QLRA_gemStats::evt, _QLRA_stats::gem, _QLRA_ebmStats::gemR, _QLRA_gemStats::live, _QLRA_stats::nFail, _QLRA_stats::nRead, _QLRA_stats::pdu0, _QLRA_stats::pdu1, _QLRA_gemStats::pres, QLRA_DOPT_PLAIN, QLRA_N_CCC, QLRA_N_TCC, QLRA_N_TEM, QLRA_STATS_MAJOR, _QLRA_stats::resetTime, _QLRA_temStats::rsp, _QLRA_aemStats::rsp, _QLRA_ebmStats::rsp, _QLRA_pduStats::rsp, _QLRA_cruStats::rsp, _QLRA_gemStats::rsp, _QLRA_gemStats::sent, _QLRA_ebmStats::siu0R, _QLRA_ebmStats::siu0S, _QLRA_ebmStats::siu1R, _QLRA_ebmStats::siu1S, _QLRA_ebmStats::siueR, _QLRA_ebmStats::siueS, _QLRA_ebmStats::ssrS, _QLRA_stats::tcc, _QLRA_stats::tem, _QLRA_ebmStats::temR, _QLRA_stats::tic, and _QLRA_stats::version.

unsigned QLRA_readDiag ( char *  fName,
void *  parm,
QLRA_regsCb  regsRtn 
)

Read the contents of an LRA packet file.

This routine reads a file of LRA diagnostic data returned from the LAT and calls a processing routine whenever a complete set of data has been assemnled.

Parameters:
fName The name of the file to be processed
parm User parameter to pass to the processing routine.
regsRtn Routine to process a set of register data. May be NULL.
Return values:
QLRA_SUCCESS Success

References _QLRA_regData::nCc, _QLRA_regData::nFe, _QLRA_regData::nRc, _QLRA_regData::nReg, _QLRA_regData::nTem, _QLRA_regData::tMask, _QLRA_regData::value, and _QLRA_regData::width.

unsigned QLRA_readSci ( char *  fName,
void *  parm,
QLRA_regsCb  regsRtn,
QLRA_esrCb  esrRtn,
QLRA_statsCb  statsRtn 
)

Read the contents of an LRA datagram file.

This routine reads a file of LRA datagrams returned from the LAT, and calls a user-supplied processing routine for each type of data found.

Parameters:
fName The name of the file to be displayed
parm User parameter to pass to the processing routine.
regsRtn Routine to call when a set of register values is read. Can be NULL.
esrRtn Routine to call when a set of ESR data is read. Can be NULL.
statsRtn Routine to call when a set of statistics data is read. Can be NULL.
Return values:
QLRA_SUCCESS Success

Generated on Tue Mar 29 14:23:26 2011 by  doxygen 1.5.8