GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LRA / V5-2-0 > lra / rad750

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

LRA_cmnd.c File Reference

Telecommand interface routines for register access. More...

#include "LRA_p.h"
#include "LRA/LRA_cmddefs.h"
#include "LRA/LRA_msgs.h"

Functions

unsigned LRA_CONTROL (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the CONTROL telecommand.
unsigned LRA_ESRSEND (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the ESRSEND telecommand.
unsigned LRA_LAM (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the LAM telecommand.
unsigned LRA_LAMLCB (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the LAMLCB telecommand.
unsigned LRA_LATRESET (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the LATRESET telecommand.
unsigned LRA_LOAD (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the LOAD telecommand.
unsigned LRA_NOOP (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the NOOP telecommand.
unsigned LRA_READ (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the READ telecommand.
unsigned LRA_STATCLEAR (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the STATCLEAR telecommand.
unsigned LRA_STATPERIOD (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the STATPERIOD telecommand.
unsigned LRA_STATSEND (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the STATSEND telecommand.
unsigned LRA_STATTEMS (void *prm, const struct _ITC_QueueItem *qitem, void *pkt, unsigned len)
 Process the STATTEMS telecommand.

Detailed Description

Telecommand interface routines for register access.

Author:
Owen H Saxton
$Id: LRA_cmnd.c,v 1.8 2009/07/31 22:07:05 saxton Exp $

Function Documentation

unsigned LRA_CONTROL ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the CONTROL telecommand.

This routine is called whenever a CONTROL telecommand arrives. It calls the control operation routine.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer
len Packet length (not used)
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
LCBD_RTOERR Operation timed out

unsigned LRA_ESRSEND ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the ESRSEND telecommand.

This routine is called whenever an ESRSEND telecommand arrives. It reads the error and status registers and sends the data to the SSR.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer (not used)
len Packet length (not used)
Return values:
LRA_SUCCESS The registers were read and sent successfully
LRA_NOTINIT LRA not initialized
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 not started

unsigned LRA_LAM ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the LAM telecommand.

This routine is called whenever a LAM telecommand arrives. It calls the look-at-me routine.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer
len Packet length (not used)
Return values:
LRA_SUCCESS The operation was successful
LRA_INVCMPT Invalid component number
LRA_INVTEM Invalid TEM number
LCBD_RTOERR Operation timed out

unsigned LRA_LAMLCB ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the LAMLCB telecommand.

This routine is called whenever a LAMLCB telecommand arrives. It calls the look-at-me LCB routine.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer
len Packet length (not used)
Return values:
LRA_SUCCESS The operation was successful
LRA_INVCMPT Invalid component number
LCBD_RTOERR Operation timed out

unsigned LRA_LATRESET ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the LATRESET telecommand.

This routine is called whenever a LATRESET telecommand arrives. It performs a LAT reset operation.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer (not used)
len Packet length (not used)
Return values:
LRA_SUCCESS The reset was successful
LCBD_RTOERR Operation timed out

unsigned LRA_LOAD ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the LOAD telecommand.

This routine is called whenever a LOAD telecommand arrives. It calls the register load routine.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer
len Packet length (not used)
Return values:
LRA_SUCCESS The registers were loaded successfully
LRA_INVCMPT Invalid component number
LRA_INVREG Invalid register number
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
LCBD_RTOERR Operation timed out

unsigned LRA_NOOP ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the NOOP telecommand.

This routine is called whenever a NOOP telecommand arrives. It just returns success.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer (not used)
len Packet length (not used)
Return values:
LRA_SUCCESS Always

unsigned LRA_READ ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the READ telecommand.

This routine is called whenever a READ telecommand arrives. It calls the register read routine and sends back the register data.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer
len Packet length (not used)
Return values:
LRA_SUCCESS The read and send were successful
LRA_INVCMPT Invalid component number
LRA_INVREG Invalid register number
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
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

unsigned LRA_STATCLEAR ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the STATCLEAR telecommand.

This routine is called whenever a STATCLEAR telecommand arrives. It clears the statistics data.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer (not used)
len Packet length (not used)
Return values:
LRA_SUCCESS The statistics were cleared successfully
LRA_NOTINIT LRA not initialized

unsigned LRA_STATPERIOD ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the STATPERIOD telecommand.

This routine is called whenever a STATPERIOD telecommand arrives. It sets the value of the statistics update period.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer (not used)
len Packet length (not used)
Return values:
LRA_SUCCESS Success
LRA_NOTINIT LRA not initialized

unsigned LRA_STATSEND ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the STATSEND telecommand.

This routine is called whenever a STATSEND telecommand arrives. It sends the current statistics data to the SSR.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer (not used)
len Packet length (not used)
Return values:
LRA_SUCCESS The statistics were sent successfully
LRA_NOTINIT LRA not initialized
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 not started

unsigned LRA_STATTEMS ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pkt,
unsigned  len 
)

Process the STATTEMS telecommand.

This routine is called whenever a STATTEMS telecommand arrives. It sets the value of the EBM statistics TEMs mask.

Parameters:
prm User context parameter (not used)
qitem Queue item (not used)
pkt Packet pointer (not used)
len Packet length (not used)
Return values:
LRA_SUCCESS Success
LRA_NOTINIT LRA not initialized

Generated on Fri Jul 31 15:37:09 2009 by  doxygen 1.5.3