GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LIM / V1-22-0 > lim / linux-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » APP » source » LIM » V1-22-0 » src

LIM_lpa.h File Reference

Interface to the functions found in LIM_lpa.c. More...

#include "ITC/ITC_pubdefs.h"
#include "LPA_DB/LPA_DB_modes.h"
#include "LIM_action.h"
#include "LIM_pkt_send.h"
#include "LIM_task.h"
#include "LPA/LPA_siu.h"

Typedefs

typedef struct _LIM_Lpa LIM_Lpa
 Typedef for opaque LPA interface object handle.
typedef enum
_LIM_Lpa_Mode 		LIM_Lpa_Mode
 Typedef for _LIM_Lpa_Mode.

Enumerations

enum  _LIM_Lpa_Mode {
  LIM_LPA_MODE_UNKNOWN = -1,
  LIM_LPA_MODE_NORMAL = LPA_DB_MODE_K_NORMAL,
  LIM_LPA_MODE_TOO = LPA_DB_MODE_K_TOO,
  LIM_LPA_MODE_GRB0 = LPA_DB_MODE_K_GRB0,
  LIM_LPA_MODE_GRB1 = LPA_DB_MODE_K_GRB1,
  LIM_LPA_MODE_GRB2 = LPA_DB_MODE_K_GRB2
}
 LIM LPA task configuration modes. More...

Functions

unsigned int LIM_lpa_new (LIM_Lpa **object_pp, LIM_Task *task_p, LIM_Action *action_p, LIM_Pkt_Send *pkt_start_p, LIM_Pkt_Send *pkt_stop_p)
 Create and initialize a new LPA interface object.
unsigned int LIM_lpa_delete (LIM_Lpa *object_p)
 Shutdown and delete an LPA interface object.
int LIM_lpa_bulk_is_grb_confirmed (const ITC_QueueItem *qitem_p)
 Check a BULK queue message to see if it's GRB-Confirmed.
int LIM_lpa_bulk_is_grb_finished (const ITC_QueueItem *qitem_p)
 Check a BULK queue message to see if it's GRB-Finished.
int LIM_lpa_bulk_is_grb_suspected (const ITC_QueueItem *qitem_p)
 Check a BULK queue message to see if it's GRB-Suspected.
int LIM_lpa_bulk_is_complete (const ITC_QueueItem *qitem_p)
 Check a BULK queue message to see if it's Physics-Complete.
LIM_Other_State LIM_lpa_get_state (LIM_Lpa *object_p)
 Return the current state of the LPA task.
LIM_Lpa_Mode LIM_lpa_get_mode (LIM_Lpa *object_p)
 Return the current LPA task mode.
unsigned int LIM_lpa_get_confirmed_parms (const ITC_QueueItem *qitem_p, unsigned int *transaction_id_p, unsigned int *dwell_time_p, double *ra_p, double *dec_p)
 Extract the parameters from an ARR-Start command.
unsigned int LIM_lpa_get_start_parms (const ITC_QueueItem *qitem_p, unsigned int *observation_id_p, LIM_Lpa_Mode *mode_id_p, unsigned int *latc_p, unsigned int *ignore_p, unsigned int *db_p, unsigned int *consign_p, unsigned int *cpu_mask_p)
 Extract the parameters from a Physics-Start command.
int LIM_lpa_config_fcode (void)
 Return the function code of the Physics-Config command.
int LIM_lpa_start_fcode (void)
 Return the function code of the Physics-Start command.
int LIM_lpa_stop_fcode (void)
 Return the function code of the Physics-Stop command.
unsigned int LIM_lpa_sizeof_grb_confirmed (void)
 Return the size of an GRB-Confirmed command.
unsigned int LIM_lpa_sizeof_grb_finished (void)
 Return the size of an GRB-Finished command.
unsigned int LIM_lpa_sizeof_grb_suspected (void)
 Return the size of an GRB-Suspected command.
unsigned int LIM_lpa_sizeof_complete (void)
 Return the size of a Physics-Complete message.
unsigned int LIM_lpa_sizeof_start (void)
 Return the size of a Physics-Start command.
unsigned int LIM_lpa_sizeof_stop (void)
 Return the size of a Physics-Stop command.
unsigned int LIM_lpa_fwd_active (LIM_Lpa *object_p, const ITC_QueueItem *qitem_p, LIM_Pkt_Send *pkt_send_p)
 Forward an 'active' command to the LPA task.
unsigned int LIM_lpa_fwd_gbm_cmd (LIM_Lpa *object_p, const ITC_QueueItem *qitem_p, LIM_Pkt_Send *pkt_send_p)
 Forward a command from the GBM to the LPA task.
unsigned int LIM_lpa_fwd_idle (LIM_Lpa *object_p, const ITC_QueueItem *qitem_p, LIM_Pkt_Send *pkt_send_p)
 Forward an 'idle' command to the LPA task.
unsigned int LIM_lpa_fwd_stop (LIM_Lpa *object_p, const ITC_QueueItem *qitem_p, LIM_Pkt_Send *pkt_send_p, LIM_Operating_Mode op_mode)
 Forward a Stop command to the LPA task.
unsigned int LIM_lpa_gbm_int (LIM_Lpa *object_p)
 Notify LPA of a GBM interrupt.
unsigned int LIM_lpa_handle_bulk (LIM_Lpa *object_p, const ITC_QueueItem *qitem_p)
 Handle a message on the BULK queue.
unsigned int LIM_lpa_handle_complete (LIM_Lpa *object_p, const ITC_QueueItem *qitem_p)
 Handle a Complete message from the LPA task.
unsigned int LIM_lpa_restart (LIM_Lpa *object_p, unsigned int observation_id, LIM_Lpa_Mode mode_id)
 Re-send the most recent Start command to the LPA task.
unsigned int LIM_lpa_set_mode (LIM_Lpa *object_p, LIM_Lpa_Mode mode_id)
 Change an observation's mode.
unsigned int LIM_lpa_send_start (LIM_Lpa *object_p, unsigned int observation_id, LIM_Lpa_Mode mode_id, unsigned int latc, unsigned int ignore, unsigned int db, unsigned int consign, unsigned int cpu_mask)
 Send a Start command to the LPA task.
unsigned int LIM_lpa_send_stop (LIM_Lpa *object_p, LIM_Operating_Mode op_mode)
 Stop an observation.

Detailed Description

Interface to the functions found in LIM_lpa.c. 

**  CVS $Id: LIM_lpa.h,v 1.21 2007/12/16 23:03:54 dmay Exp $
**

Enumeration Type Documentation

enum _LIM_Lpa_Mode

LIM LPA task configuration modes.

Enumerator:
LIM_LPA_MODE_UNKNOWN  The configuration mode is not known.
LIM_LPA_MODE_NORMAL  The NORMAL configuration mode.
LIM_LPA_MODE_TOO  The TOO configuration mode.
LIM_LPA_MODE_GRB0  The GRB0 configuration mode.
LIM_LPA_MODE_GRB1  The GRB1 configuration mode.
LIM_LPA_MODE_GRB2  The GRB2 configuration mode.

Function Documentation

int LIM_lpa_bulk_is_complete ( const ITC_QueueItem *  qitem_p  ) 

Check a BULK queue message to see if it's Physics-Complete.

Parameters:
qitem_p Pointer to queue item containing the message.
Returns:
Nonzero if the message is Physics-Complete.

int LIM_lpa_bulk_is_grb_confirmed ( const ITC_QueueItem *  qitem_p  ) 

Check a BULK queue message to see if it's GRB-Confirmed.

Parameters:
qitem_p Pointer to queue item containing the message.
Returns:
Nonzero if the message is GRB-Confirmed.

int LIM_lpa_bulk_is_grb_finished ( const ITC_QueueItem *  qitem_p  ) 

Check a BULK queue message to see if it's GRB-Finished.

Parameters:
qitem_p Pointer to queue item containing the message.
Returns:
Nonzero if the message is GRB-Finished.

int LIM_lpa_bulk_is_grb_suspected ( const ITC_QueueItem *  qitem_p  ) 

Check a BULK queue message to see if it's GRB-Suspected.

Parameters:
qitem_p Pointer to queue item containing the message.
Returns:
Nonzero if the message is GRB-Suspected.

int LIM_lpa_config_fcode ( void   ) 

Return the function code of the Physics-Config command.

Returns:
Physics-Config command function code.

unsigned int LIM_lpa_delete ( LIM_Lpa *  object_p  ) 

Shutdown and delete an LPA interface object.

Parameters:
object_p Pointer to object.
Returns:
MSG code.

unsigned int LIM_lpa_fwd_active ( LIM_Lpa *  object_p,
const ITC_QueueItem *  qitem_p,
LIM_Pkt_Send *  pkt_send_p 
)

Forward an 'active' command to the LPA task.

Parameters:
object_p Pointer to LPA interface object.
qitem_p Pointer to queue item containing the command.
pkt_send_p Pointer to packet sending object for the command.
Returns:
MSG code.

unsigned int LIM_lpa_fwd_gbm_cmd ( LIM_Lpa *  object_p,
const ITC_QueueItem *  qitem_p,
LIM_Pkt_Send *  pkt_send_p 
)

Forward a command from the GBM to the LPA task.

Parameters:
object_p Pointer to LPA interface object.
qitem_p Pointer to queue item containing the command.
pkt_send_p Pointer to packet sending object for the command.
Returns:
MSG code.

unsigned int LIM_lpa_fwd_idle ( LIM_Lpa *  object_p,
const ITC_QueueItem *  qitem_p,
LIM_Pkt_Send *  pkt_send_p 
)

Forward an 'idle' command to the LPA task.

Parameters:
object_p Pointer to LPA interface object.
qitem_p Pointer to queue item containing the command.
pkt_send_p Pointer to packet sending object for the command.
Returns:
MSG code.

unsigned int LIM_lpa_fwd_stop ( LIM_Lpa *  object_p,
const ITC_QueueItem *  qitem_p,
LIM_Pkt_Send *  pkt_send_p,
LIM_Operating_Mode  op_mode 
)

Forward a Stop command to the LPA task.

Parameters:
object_p Pointer to LPA interface object.
qitem_p Pointer to queue item containing the command.
pkt_send_p Pointer to packet sending object for the command.
op_mode Current operating mode.
Returns:
MSG code.

unsigned int LIM_lpa_gbm_int ( LIM_Lpa *  object_p  ) 

Notify LPA of a GBM interrupt.

Parameters:
object_p Pointer to LPA interface object.
Returns:
MSG code.

unsigned int LIM_lpa_get_confirmed_parms ( const ITC_QueueItem *  qitem_p,
unsigned int *  transaction_id_p,
unsigned int *  dwell_time_p,
double *  ra_p,
double *  dec_p 
)

Extract the parameters from an ARR-Start command.

Parameters:
qitem_p Pointer to queue item containing the command.
transaction_id_p Location to return transaction ID value.
dwell_time_p Location to return dwell time value.
ra_p Location to return RA value.
dec_p Location to return DEC value.
Returns:
MSG code.

LIM_Lpa_Mode LIM_lpa_get_mode ( LIM_Lpa *  object_p  ) 

Return the current LPA task mode.

Parameters:
object_p Pointer to LPA interface object.
Returns:
Current LPA task mode.

unsigned int LIM_lpa_get_start_parms ( const ITC_QueueItem *  qitem_p,
unsigned int *  observation_id_p,
LIM_Lpa_Mode *  mode_id_p,
unsigned int *  latc_p,
unsigned int *  ignore_p,
unsigned int *  db_p,
unsigned int *  consign_p,
unsigned int *  cpu_mask_p 
)

Extract the parameters from a Physics-Start command.

Parameters:
qitem_p Pointer to queue item containing the command.
observation_id_p Location to return observation ID value.
mode_id_p Location to return mode ID value.
latc_p Location to return LATC config file ID value.
ignore_p Location to return LATC ignore file ID value.
db_p Location to return LPA_DB instance ID value.
consign_p Location to return LATC consign flag value.
cpu_mask_p Location to return CPU mask value.
Returns:
MSG code.

LIM_Other_State LIM_lpa_get_state ( LIM_Lpa *  object_p  ) 

Return the current state of the LPA task.

Parameters:
object_p Pointer to LPA interface object.
Returns:
Current state of the LPA task.

unsigned int LIM_lpa_handle_bulk ( LIM_Lpa *  object_p,
const ITC_QueueItem *  qitem_p 
)

Handle a message on the BULK queue.

Parameters:
object_p Pointer to LPA interface object.
qitem_p Pointer to queue item containing the message.
Returns:
MSG code.

unsigned int LIM_lpa_handle_complete ( LIM_Lpa *  object_p,
const ITC_QueueItem *  qitem_p 
)

Handle a Complete message from the LPA task.

Parameters:
object_p Pointer to LPA interface object.
qitem_p Pointer to queue item containing the message.
Returns:
MSG code.

unsigned int LIM_lpa_new ( LIM_Lpa **  object_pp,
LIM_Task *  task_p,
LIM_Action *  action_p,
LIM_Pkt_Send *  pkt_start_p,
LIM_Pkt_Send *  pkt_stop_p 
)

Create and initialize a new LPA interface object.

Parameters:
object_pp Location to return pointer to new object.
task_p Pointer to a task object.
action_p Pointer to an action reporting object.
pkt_start_p Pointer to Start cmd packet sending object.
pkt_stop_p Pointer to Stop cmd packet sending object.
Returns:
MSG code.

unsigned int LIM_lpa_restart ( LIM_Lpa *  object_p,
unsigned int  observation_id,
LIM_Lpa_Mode  mode_id 
)

Re-send the most recent Start command to the LPA task.

Parameters:
object_p Pointer to LPA interface object.
observation_id Observation ID value for the command.
mode_id Mode ID value for the command.
Returns:
MSG code.

unsigned int LIM_lpa_send_start ( LIM_Lpa *  object_p,
unsigned int  observation_id,
LIM_Lpa_Mode  mode_id,
unsigned int  latc,
unsigned int  ignore,
unsigned int  db,
unsigned int  consign,
unsigned int  cpu_mask 
)

Send a Start command to the LPA task.

Parameters:
object_p Pointer to LPA interface object.
observation_id Observation ID value for the command.
mode_id Mode ID value for the command.
latc LATC config file ID value for the command.
ignore LATC ignore file ID value for the command.
db LPA_DB instance ID value for the command.
consign LATC consign flag value for the command.
cpu_mask CPU mask value for the command.
Returns:
MSG code.

unsigned int LIM_lpa_send_stop ( LIM_Lpa *  object_p,
LIM_Operating_Mode  op_mode 
)

Stop an observation.

Parameters:
object_p Pointer to LPA interface object.
op_mode Current operating mode.
Returns:
MSG code.

unsigned int LIM_lpa_set_mode ( LIM_Lpa *  object_p,
LIM_Lpa_Mode  mode_id 
)

Change an observation's mode.

Parameters:
object_p Pointer to LPA interface object.
mode_id New observation mode.
Returns:
MSG code.

unsigned int LIM_lpa_sizeof_complete ( void   ) 

Return the size of a Physics-Complete message.

Returns:
Physics-Complete message size, in bytes.

unsigned int LIM_lpa_sizeof_grb_confirmed ( void   ) 

Return the size of an GRB-Confirmed command.

Returns:
GRB-Confirmed command size, in bytes.

unsigned int LIM_lpa_sizeof_grb_finished ( void   ) 

Return the size of an GRB-Finished command.

Returns:
GRB-Finished command size, in bytes.

unsigned int LIM_lpa_sizeof_grb_suspected ( void   ) 

Return the size of an GRB-Suspected command.

Returns:
GRB-Suspected command size, in bytes.

unsigned int LIM_lpa_sizeof_start ( void   ) 

Return the size of a Physics-Start command.

Returns:
Physics-Start command size, in bytes.

unsigned int LIM_lpa_sizeof_stop ( void   ) 

Return the size of a Physics-Stop command.

Returns:
Physics-Stop command size, in bytes.

int LIM_lpa_start_fcode ( void   ) 

Return the function code of the Physics-Start command.

Returns:
Physics-Start command function code.

int LIM_lpa_stop_fcode ( void   ) 

Return the function code of the Physics-Stop command.

Returns:
Physics-Stop command function code.

Generated on Tue Sep 22 16:21:19 2009 by  doxygen 1.5.3