GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LRA / V5-2-1 > lra_cli / mv2304

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » APP » source » LRA » V5-2-1 » LRA

LRA_cli.h File Reference

Public definitions for the user-friendly register access routines. More...

#include "LRA/LRA.h"

Typedefs

typedef enum _LRA_cli LRA_cli
 Miscellaneous definitions.

Enumerations

enum  _LRA_cli {
  LRA_DOPT_PLAIN = 0x01,
  LRA_DOPT_NOHDR = 0x02
}
 Miscellaneous definitions. More...

Functions

unsigned LRA_ctl (const char *cmpnt, const char *block, int tem, int cc, int rc, int fe, int func)
 Perform a control function.
unsigned LRA_dump (const char *cmpnt, const char *block, int tem, int cc, int rc, int fe, int reg)
 Dump the contents of LAT registers to the SSR.
unsigned LRA_set (long long value, const char *cmpnt, const char *block, int tem, int cc, int rc, int fe, int reg)
 Set the contents of LAT registers.
unsigned LRA_show (const char *cmpnt, const char *block, int tem, int cc, int rc, int fe, int reg, int optns)
 Display the contents of LAT registers.
unsigned LRA_time (const char *cmpnt, const char *block, int tem, int cc, int rc, int fe, int reg, int count)
 Time the reading of LAT registers.

Detailed Description

Public definitions for the user-friendly register access routines.

Author:
Owen H Saxton
$Id: LRA_cli.h,v 1.6 2009/07/31 22:09:11 saxton Exp $

Enumeration Type Documentation

enum _LRA_cli

Miscellaneous definitions.

Enumerator:
LRA_DOPT_PLAIN  Do plain display.
LRA_DOPT_NOHDR  Don't display header line.

Function Documentation

unsigned LRA_ctl ( const char *  cmpnt,
const char *  block,
int  tem,
int  cc,
int  rc,
int  fe,
int  func 
)

Perform a control function.

This routine performs the specified control function on the specified LAT component.

Parameters:
cmpnt The LAT component name or number
block The register block name or number (EBM only)
tem The TEM number for TEM-based components, or LRA_WILD for all TEMs
cc The cable controller number, or LRA_WILD for all cable controllers
rc The readout controller number, or LRA_WILD for all RCs
fe The front end number, or LRA_WILD for all FEs
func The function to perform
Return values:
LRA_SUCCESS The operation was successful
LRA_INVCMPT Invalid component number
LRA_INVCNTRL Invalid control operation
LRA_INVTEM Invalid TEM number
LRA_INVCC Invalid cable controller number
LRA_INVRC Invalid readout controller number
LRA_INVFE Invalid front-end number
ITC_SENDTID Destination task (LRA) not started
LCBD_RTOERR Operation timed out

unsigned LRA_dump ( const char *  cmpnt,
const char *  block,
int  tem,
int  cc,
int  rc,
int  fe,
int  reg 
)

Dump the contents of LAT registers to the SSR.

This routine reads the contents of the specified LAT registers and sends the results to the SSR.

Parameters:
cmpnt The LAT component name or number
block The register block name or number
tem The TEM number for TEM-based components, LRA_WILD to read all TEMs, or LRA_ACTIVE to read all available TEMs
cc The cable controller number, or LRA_WILD for all cable controllers
rc The readout controller number, or LRA_WILD for all RCs
fe The front end number, or LRA_WILD for all FEs
reg The register number, or LRA_WILD for all registers
Return values:
LRA_SUCCESS The dump was successful
LRA_INVCMPNM Invalid component name
LRA_INVCMPT Invalid component number
LRA_INVBLKNM Invalid register block name
LRA_INVBLOCK Invalid register block number
LRA_INVTEM Invalid TEM number
LRA_INVCC Invalid cable controller number
LRA_INVRC Invalid readout controller number
LRA_INVFE Invalid front-end number
LRA_INVREG Invalid register number
LCBD_RTOERR Operation timed out
ITC_SENDNID Destination node not reachable
ITC_SENDPRX Proxy task for destination node not started
ITC_SENDQID Destination queue not available
ITC_SENDTID Destination task (LRA) not started

unsigned LRA_set ( long long  value,
const char *  cmpnt,
const char *  block,
int  tem,
int  cc,
int  rc,
int  fe,
int  reg 
)

Set the contents of LAT registers.

This routine sets a value into the specified LAT registers.

Parameters:
value The value to be set
cmpnt The LAT component name or number
block The register block name or number
tem The TEM number for TEM-based components, or LRA_WILD for all TEMs
cc The cable controller number, or LRA_WILD for all cable controllers
rc The readout controller number, or LRA_WILD for all RCs
fe The front end number, or LRA_WILD for all FEs
reg The register number
Return values:
LRA_SUCCESS Register setting was successful
LRA_INVCMPNM Invalid component name
LRA_INVCMPT Invalid component number
LRA_INVBLKNM Invalid register block name
LRA_INVBLOCK Invalid register block number
LRA_INVTEM Invalid TEM number
LRA_INVCC Invalid cable controller number
LRA_INVRC Invalid readout controller number
LRA_INVFE Invalid front-end number
LRA_INVREG Invalid register number
ITC_SENDTID Destination task (LRA) not started
LCBD_RTOERR Operation timed out

unsigned LRA_show ( const char *  cmpnt,
const char *  block,
int  tem,
int  cc,
int  rc,
int  fe,
int  reg,
int  optns 
)

Display the contents of LAT registers.

This routine displays the contents of the specified LAT registers.

Parameters:
cmpnt The LAT component name or number
block The register block name or number
tem The TEM number for TEM-based components, LRA_WILD to read all TEMs, or LRA_ACTIVE to read all available TEMs
cc The cable controller number, or LRA_WILD for all cable controllers
rc The readout controller number, or LRA_WILD for all RCs
fe The front end number, or LRA_WILD for all FEs
reg The register number, or LRA_WILD for all registers
optns Display options
Return values:
LRA_SUCCESS Display was successful
LRA_INVCMPNM Invalid component name
LRA_INVCMPT Invalid component number
LRA_INVBLKNM Invalid register block name
LRA_INVBLOCK Invalid register block number
LRA_INVTEM Invalid TEM number
LRA_INVCC Invalid cable controller number
LRA_INVRC Invalid readout controller number
LRA_INVFE Invalid front-end number
LRA_INVREG Invalid register number
ITC_SENDTID Destination task (LRA) not started
LCBD_RTOERR Operation timed out

unsigned LRA_time ( const char *  cmpnt,
const char *  block,
int  tem,
int  cc,
int  rc,
int  fe,
int  reg,
int  count 
)

Time the reading of LAT registers.

This routine reads the contents of the specified LAT registers, and displays the time taken to do so.

Parameters:
cmpnt The LAT component name or number
block The register block name or number
tem The TEM number for TEM-based components, LRA_WILD to read all TEMs, or LRA_ACTIVE to read all available TEMs
cc The cable controller number, or LRA_WILD to read all cable controllers.
rc The readout controller number, or LRA_WILD to read all RCs.
fe The front end number, or LRA_WILD to read all FEs.
reg The register number, or LRA_WILD to read all registers.
count The number of times to perform the read operation.
Return values:
LRA_SUCCESS Timing was successful
LRA_INVCMPNM Invalid component name
LRA_INVCMPT Invalid component number
LRA_INVBLKNM Invalid register block name
LRA_INVBLOCK Invalid register block number
LRA_INVTEM Invalid TEM number
LRA_INVCC Invalid cable controller number
LRA_INVRC Invalid readout controller number
LRA_INVFE Invalid front-end number
LRA_INVREG Invalid register number
ITC_SENDTID Destination task (LRA) not started
LCBD_RTOERR Operation timed out

Generated on Fri Aug 14 10:36:34 2009 by  doxygen 1.5.3