GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LIM / V1-19-1

Constituent: lim_unit_test     Tag: sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » APP » source » LIM » V1-19-1 » LIM

LIM_pubdefs.h File Reference

Public interface to the LAT Instrument Manager (LIM) functions. More...

#include "ITC/ITC_pubdefs.h"
#include "PBS/TASK.h"

Include dependency graph for LIM_pubdefs.h:

This graph shows which files directly or indirectly include this file:


Data Structures

struct  _LIM_Info
 LIM state information. More...

Typedefs

typedef enum _LIM_Operating_Mode LIM_Operating_Mode
 Typedef for _LIM_Operating_Mode.
typedef enum _LIM_Virtual_Mode LIM_Virtual_Mode
 Typedef for _LIM_Virtual_Mode.
typedef enum _LIM_Other_State LIM_Other_State
 Typedef for _LIM_Other_State.
typedef enum _LIM_Grb_State LIM_Grb_State
 Typedef for _LIM_Grb_State.
typedef enum _LIM_Action_Id LIM_Action_Id
 Typedef for _LIM_Action_Id.
typedef _LIM_Info LIM_Info
 Typedef for _LIM_Info.

Enumerations

enum  _LIM_Operating_Mode {
  LIM_OP_MODE_TERMINAL = 0,
  LIM_OP_MODE_QUIESCENT = 1,
  LIM_OP_MODE_CALIBRATION = 2,
  LIM_OP_MODE_PHYSICS = 4,
  LIM_OP_MODE_TOO = 6,
  LIM_OP_MODE_ARR = 8,
  LIM_OP_MODE_HOLD = 10
}
 LIM operating modes. More...
enum  _LIM_Virtual_Mode {
  LIM_VIRT_MODE_IDLE = 0,
  LIM_VIRT_MODE_READY = 1,
  LIM_VIRT_MODE_STARTED = 2,
  LIM_VIRT_MODE_UNKNOWN = 3
}
 LIM virtual modes. More...
enum  _LIM_Other_State {
  LIM_OTHER_STATE_IDLE = 0,
  LIM_OTHER_STATE_RUNNING = 1,
  LIM_OTHER_STATE_STOPPING = 2,
  LIM_OTHER_STATE_UNKNOWN = 3
}
 States of tasks other than LIM. More...
enum  _LIM_Grb_State {
  LIM_GRB_STATE_IDLE = 0,
  LIM_GRB_STATE_0 = 4,
  LIM_GRB_STATE_1 = 5,
  LIM_GRB_STATE_2 = 6
}
 State of the GRB handler. More...
enum  _LIM_Action_Id {
  LIM_ACTION_UNKNOWN = 0,
  LIM_ACTION_START = 1,
  LIM_ACTION_OP_MODE_CHANGE = 2,
  LIM_ACTION_MAIN_FEED_ON = 3,
  LIM_ACTION_POWER_ON = 4,
  LIM_ACTION_POWER_OFF = 5,
  LIM_ACTION_EVENT_INSERT = 7,
  LIM_ACTION_EVENT_REMOVE = 8,
  LIM_ACTION_SHED_BEGIN = 9,
  LIM_ACTION_SHED_END = 10,
  LIM_ACTION_PHYSICS_START = 13,
  LIM_ACTION_PHYSICS_SET_MODE = 14,
  LIM_ACTION_PHYSICS_STOP = 15,
  LIM_ACTION_LTC_STOP = 16,
  LIM_ACTION_SIU_REBOOT = 17,
  LIM_ACTION_SAA_CONFIG = 19,
  LIM_ACTION_NON_SAA_CONFIG = 21,
  LIM_ACTION_CAL_START = 22,
  LIM_ACTION_CAL_ABORT = 23,
  LIM_ACTION_CAL_OTHER = 24,
  LIM_ACTION_CAL_COMPLETE = 30,
  LIM_ACTION_PHYSICS_COMPLETE = 32,
  LIM_ACTION_LCI_STATE_CHANGE = 33,
  LIM_ACTION_LPA_STATE_CHANGE = 35,
  LIM_ACTION_ARR_STATE_CHANGE = 37,
  LIM_ACTION_TOO_STATE_CHANGE = 40,
  LIM_ACTION_PHYSICS_ACTIVE = 42,
  LIM_ACTION_PHYSICS_IDLE = 43,
  LIM_ACTION_SAA_CHANGE = 45,
  LIM_ACTION_RCV_GBM_REP_REC = 47,
  LIM_ACTION_RCV_GBM_REP_NOREC = 48,
  LIM_ACTION_GBM_COMMAND = 49,
  LIM_ACTION_SEND_SLEW_REQ = 50,
  LIM_ACTION_RCV_SLEW_ACCEPT = 51,
  LIM_ACTION_RCV_SLEW_REJECT = 52,
  LIM_ACTION_PID_SELECT_PRI = 53,
  LIM_ACTION_PID_SELECT_RED = 54,
  LIM_ACTION_STOP = 55,
  LIM_ACTION_BIAS_ACD = 56,
  LIM_ACTION_BIAS_CAL = 57,
  LIM_ACTION_BIAS_TKR = 58,
  LIM_ACTION_GBM_STATE_CHANGE = 59,
  LIM_ACTION_HV_STATE_CHANGE = 60,
  LIM_ACTION_CAL_START_STATUS = 61,
  LIM_ACTION_PHYSICS_START_STATUS = 63,
  LIM_ACTION_CAL_ABORT_STATUS = 64,
  LIM_ACTION_PHYSICS_STOP_STATUS = 66,
  LIM_ACTION_PID_EN_GBM_PRI = 67,
  LIM_ACTION_PID_EN_GBM_RED = 68,
  LIM_ACTION_GBM_INT_PRI = 69,
  LIM_ACTION_GBM_INT_RED = 70,
  LIM_ACTION_REP_REQ_STATE_CHANGE = 71,
  LIM_ACTION_RCV_GBM_CALCINFO = 72,
  LIM_ACTION_RCV_GBM_CLOSEOUT = 73,
  LIM_ACTION_PID_DIS_GBM_PRI = 74,
  LIM_ACTION_PID_DIS_GBM_RED = 75,
  LIM_ACTION_RCV_GRB_SUSPECT = 76,
  LIM_ACTION_RCV_GRB_CONFIRM = 77,
  LIM_ACTION_RCV_GRB_FINISH = 78,
  LIM_ACTION_PHYSICS_GBM_INT = 79
}
 Identifiers for actions that can be reported. More...

Functions

unsigned int LIM_initialize (ITC_TaskID tid)
 Initialize the LIM package.
unsigned int LIM_init_with_db (void)
 Initialize the LIM package using CDM.
unsigned int LIM_shutdown (void)
 Shutdown the LIM package.
unsigned int LIM_start (TASK_attr *attr_p)
 Start the LIM task.
unsigned int LIM_start_with_db (void)
 Start the LIM task using CDM.
unsigned int LIM_stop (void)
 Stop the LIM task.
unsigned int LIM_get_info (LIM_Info *info_p)
 Get current LIM state information.
unsigned int LIM_capture_cal (unsigned int apid, int start_fc, int abort_fc)
 Capture calibration telecommands with the specified APID.
unsigned int LIM_capture_cal_with_db (void)
 Capture calibration telecommands using the LIM_DB configuration.
unsigned int LIM_capture_diag (unsigned int apid, int start_fc, int abort_fc)
 Capture diagnostic telecommands with the specified APID.
unsigned int LIM_capture_diag_with_db (void)
 Capture diagnostic telecommands using the LIM_DB configuration.
unsigned int LIM_capture_physics (unsigned int apid, int start_fc, int config_fc, int stop_fc)
 Capture physics telecommands with the specified APID.
unsigned int LIM_capture_physics_with_db (void)
 Capture physics telecommands using the LIM_DB configuration.

Detailed Description

Public interface to the LAT Instrument Manager (LIM) functions. 

**  CVS $Id: LIM_pubdefs.h,v 1.29 2007/03/16 10:23:34 dmay Exp $
**

Defines the public interface to the functions found in the LIM package.

Enumeration Type Documentation

enum _LIM_Action_Id
 

Identifiers for actions that can be reported.

Enumerator:
LIM_ACTION_UNKNOWN  Unknown action.
LIM_ACTION_START  The LIM task started.
LIM_ACTION_OP_MODE_CHANGE  The operating mode changed.
LIM_ACTION_MAIN_FEED_ON  LIM enabled power to the main feed and initialized the SIU.
LIM_ACTION_POWER_ON  LIM enabled power to one or more components of the LAT.
LIM_ACTION_POWER_OFF  LIM disabled power from one or more components of the LAT.
LIM_ACTION_EVENT_INSERT  LIM added one or more components to the event fabric.
LIM_ACTION_EVENT_REMOVE  LIM removed one or more components from the event fabric.
LIM_ACTION_SHED_BEGIN  LIM started disabling instrument power in response to a Load-Shed command.
LIM_ACTION_SHED_END  LIM finished disabling instrument power in response to a Load-Shed command.
LIM_ACTION_PHYSICS_START  LIM sent the Physics-Start command to the LPA task.
LIM_ACTION_PHYSICS_SET_MODE  LIM called the LPA_set_mode() function to change the observation mode.
LIM_ACTION_PHYSICS_STOP  LIM sent the Physics-Stop command to the LPA task.
LIM_ACTION_LTC_STOP  LIM sent the LTC-Stop command to the LTC task.
LIM_ACTION_SIU_REBOOT  LIM is about to reboot the SIU.
LIM_ACTION_SAA_CONFIG  LIM configured the LAT instrument for SAA transit.
LIM_ACTION_NON_SAA_CONFIG  LIM configured the LAT instrument for non-SAA operation.
LIM_ACTION_CAL_START  LIM sent the Calibration-Start command to the LCI task.
LIM_ACTION_CAL_ABORT  LIM sent the Calibration-Abort command to the LCI task.
LIM_ACTION_CAL_OTHER  LIM sent some 'other' command to the LCI task.
LIM_ACTION_CAL_COMPLETE  LIM received the Calibration-Complete command from the LCI task.
LIM_ACTION_PHYSICS_COMPLETE  LIM received the Physics-Complete command from the LPA task.
LIM_ACTION_LCI_STATE_CHANGE  LIM changed the state of the LCI task.
LIM_ACTION_LPA_STATE_CHANGE  LIM changed the state of the LPA task.
LIM_ACTION_ARR_STATE_CHANGE  The ARR observation state changed.
LIM_ACTION_TOO_STATE_CHANGE  The TOO observation state changed.
LIM_ACTION_PHYSICS_ACTIVE  LIM sent an 'active' command to the LPA task.
LIM_ACTION_PHYSICS_IDLE  LIM sent an 'idle' command to the LPA task.
LIM_ACTION_SAA_CHANGE  The SAA transit state changed.
LIM_ACTION_RCV_GBM_REP_REC  LIM received a GBM Candidate Repoint Recommendation command which recommended a repoint.
LIM_ACTION_RCV_GBM_REP_NOREC  LIM received a GBM Candidate Repoint Recommendation command which did not recommend a repoint.
LIM_ACTION_GBM_COMMAND  LIM forwarded a GBM command to the LPA task.
LIM_ACTION_SEND_SLEW_REQ  LIM sent a Slew-Request command to the spacecraft.
LIM_ACTION_RCV_SLEW_ACCEPT  LIM received a Slew-Request-Reply from the spacecraft which indicated that the request was accepted.
LIM_ACTION_RCV_SLEW_REJECT  LIM received a Slew-Request-Reply from the spacecraft which indicated that the request was rejected.
LIM_ACTION_PID_SELECT_PRI  LIM selected the primary PID input signals.
LIM_ACTION_PID_SELECT_RED  LIM selected the redundant PID input signals.
LIM_ACTION_STOP  The LIM task was stopped.
LIM_ACTION_BIAS_ACD  LIM configured the ACD bias voltages.
LIM_ACTION_BIAS_CAL  LIM configured the CAL bias voltages.
LIM_ACTION_BIAS_TKR  LIM configured the TKR bias voltages.
LIM_ACTION_GBM_STATE_CHANGE  The configuration of the GBM interface changed.
LIM_ACTION_HV_STATE_CHANGE  The configuration of the high-voltage interface changed.
LIM_ACTION_CAL_START_STATUS  LIM received a status code for a Calibration-Start command that it sent to the LCI task.
LIM_ACTION_PHYSICS_START_STATUS  LIM received a status code for a Physics-Start command that it sent to the LPA task.
LIM_ACTION_CAL_ABORT_STATUS  LIM received a status code for a Calibration-Abort command that it sent to the LCI task.
LIM_ACTION_PHYSICS_STOP_STATUS  LIM received a status code for a Physics-Stop command that it sent to the LPA task.
LIM_ACTION_PID_EN_GBM_PRI  LIM enabled the primary GBM interrupt signal.
LIM_ACTION_PID_EN_GBM_RED  LIM enabled the redundant GBM interrupt signal.
LIM_ACTION_GBM_INT_PRI  LIM received an interrupt on the primary GBM interrupt signal.
LIM_ACTION_GBM_INT_RED  LIM received an interrupt on the redundant GBM interrupt signal.
LIM_ACTION_REP_REQ_STATE_CHANGE  The repoint request PENDING status changed.
LIM_ACTION_RCV_GBM_CALCINFO  LIM received a GBM Calculated Information command.
LIM_ACTION_RCV_GBM_CLOSEOUT  LIM received a GBM Closeout command.
LIM_ACTION_PID_DIS_GBM_PRI  LIM disabled the primary GBM interrupt signal.
LIM_ACTION_PID_DIS_GBM_RED  LIM disabled the redundant GBM interrupt signal.
LIM_ACTION_RCV_GRB_SUSPECT  LIM received a GRB-Suspected message from LPA.
LIM_ACTION_RCV_GRB_CONFIRM  LIM received a GRB-Confirmed message from LPA.
LIM_ACTION_RCV_GRB_FINISH  LIM received a GRB-Finished message from LPA.
LIM_ACTION_PHYSICS_GBM_INT  LIM called the LPA_gbm_int() function to notify LPA of a GBM interrupt.

enum _LIM_Grb_State
 

State of the GRB handler.

Enumerator:
LIM_GRB_STATE_IDLE  No GRB in progress.
LIM_GRB_STATE_0  GRB0 state - a GRB is suspected, but the spacecraft has not been repointed.
LIM_GRB_STATE_1  GRB1 state - a GRB has been confirmed and the spacecraft has been repointed.
LIM_GRB_STATE_2  GRB2 state - a GRB has ended, but the spacecraft is still repointed.

enum _LIM_Operating_Mode
 

LIM operating modes.

Enumerator:
LIM_OP_MODE_TERMINAL  The TERMINAL operating mode.
LIM_OP_MODE_QUIESCENT  The QUIESCENT operating mode.
LIM_OP_MODE_CALIBRATION  The CALIBRATION operating mode.
LIM_OP_MODE_PHYSICS  The PHYSICS operating mode.
LIM_OP_MODE_TOO  The TOO (target of opportunity) operating mode.
LIM_OP_MODE_ARR  The ARR (autonomous repoint request) operating mode.
LIM_OP_MODE_HOLD  The HOLD operating mode.

enum _LIM_Other_State
 

States of tasks other than LIM.

Enumerator:
LIM_OTHER_STATE_IDLE  The IDLE task state.
LIM_OTHER_STATE_RUNNING  The RUNNING task state.
LIM_OTHER_STATE_STOPPING  The STOPPING task state.
LIM_OTHER_STATE_UNKNOWN  The state of the other task is unknown.

enum _LIM_Virtual_Mode
 

LIM virtual modes.

Enumerator:
LIM_VIRT_MODE_IDLE  The IDLE virtual mode.
LIM_VIRT_MODE_READY  The READY virtual mode.
LIM_VIRT_MODE_STARTED  The STARTED virtual mode.
LIM_VIRT_MODE_UNKNOWN  The virtual mode is unknown.

Function Documentation

unsigned int LIM_capture_cal (  unsigned int  apid,
int  start_fc,
int  abort_fc
) 
 

Capture calibration telecommands with the specified APID.

This function instructs LIM to capture calibration telecommands with the specified APID. If non-negative, LIM handles the telecommands with the start_fc function code as Calibration-Start commands. Likewise, if abort_fc is non-negative, LIM handles the telecommands with that function code as Calibration-Abort commands.

Parameters:
apid APID to capture.
start_fc Func code of Calibration-Start cmd (-1 if none).
abort_fc Func code of Calibration-Abort cmd (-1 if none).
Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_capture_cal_with_db (  void   ) 
 

Capture calibration telecommands using the LIM_DB configuration.

This function is a wrapper for LIM_capture_cal() that uses the LIM_DB configuration database to determine its parameters.

Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_capture_diag (  unsigned int  apid,
int  start_fc,
int  abort_fc
) 
 

Capture diagnostic telecommands with the specified APID.

This function instructs LIM to capture diagnostic telecommands with the specified APID. If non-negative, LIM handles the telecommands with the start_fc function code as Diagnostic-Start commands. Likewise, if abort_fc is non-negative, LIM handles the telecommands with that function code as Diagnostic-Abort commands.

Parameters:
apid APID to capture.
start_fc Func code of Diagnostic-Start command (-1 if none).
abort_fc Func code of Diagnostic-Abort command (-1 if none).
Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_capture_diag_with_db (  void   ) 
 

Capture diagnostic telecommands using the LIM_DB configuration.

This function is a wrapper for LIM_capture_diag() that uses the LIM_DB configuration database to determine its parameters.

Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_capture_physics (  unsigned int  apid,
int  start_fc,
int  config_fc,
int  stop_fc
) 
 

Capture physics telecommands with the specified APID.

This function instructs LIM to capture physics observation telecommands with the specified APID. If non-negative, LIM handles the telecommand with the start_fc function code as the Physics-Start command. Likewise, if config_fc or stop_fc is non-negative, LIM handles the telecommands with those function codes as the Physics-Reconfig and Physics-Abort commands.

Parameters:
apid APID to capture.
start_fc Function code of Physics-Start cmd (-1 if none).
config_fc Function code of Physics-Config cmd (-1 if none).
stop_fc Function code of Physics-Stop cmd (-1 if none).
Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_capture_physics_with_db (  void   ) 
 

Capture physics telecommands using the LIM_DB configuration.

This function is similar to LIM_capture_physics() except that it uses the LIM_DB configuration database to determine its parameters.

Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_get_info (  LIM_Info *  info_p  ) 
 

Get current LIM state information.

This function returns selected items from the current LIM state.

Parameters:
info_p Location to return state information (must not be NULL).
Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_init_with_db (  void   ) 
 

Initialize the LIM package using CDM.

This function is a wrapper for LIM_initialize that uses CDM to determine its parameters.

Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_initialize (  ITC_TaskID  tid  ) 
 

Initialize the LIM package.

This function initializes the LIM package using the functions found in LIM_task.c. It should be the first LIM function called when using the LIM package.

Parameters:
tid ID of the LIM task.
Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_shutdown (  void   ) 
 

Shutdown the LIM package.

This function shuts down the LIM package using the functions found in LIM_task.c. It can be called only if the current LIM task state is INITIALIZED, INIT_FAIL, or SHUTDOWN_FAIL. This function should be called when the LIM package is no longer needed.

Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_start (  TASK_attr *  attr_p  ) 
 

Start the LIM task.

This function starts the LIM task and transitions LIM to the STARTED state. It can be called only if the current LIM state is INITIALIZED. This function should be called after LIM_initialize().

Parameters:
attr_p Pointer to task attributes. CPU_DB task attributes will be used if this value is NULL.
Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_start_with_db (  void   ) 
 

Start the LIM task using CDM.

This function is a wrapper for LIM_start that uses CDM to determine its parameters.

Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int LIM_stop (  void   ) 
 

Stop the LIM task.

This function stops the LIM task and transitions LIM back to the INITIALIZED state. It can be called only if the current LIM state is STARTED, START_FAIL, or STOP_FAIL. This function should be called before LIM_shutdown().

Returns:
Zero if successful.

A MSG code if an error occurs.

Generated on Mon Jan 14 12:15:47 2008 by  doxygen 1.4.4