GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LIM / dev > lim_unit_test_lpa / rad750
#include <ITC/ITC_pubdefs.h>
#include <PBS/TASK.h>
** CVS $Id: LIM_pubdefs.h,v 1.31 2011/03/29 21:20:27 apw Exp $ **
Defines the public interface to the functions found in the LIM package.
enum _LIM_Action_Id |
Identifiers for actions that can be reported.
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. |
LIM_ACTION_BIAS_ACD_ON | LIM turned on the ACD bias voltages. |
LIM_ACTION_BIAS_CAL_ON | LIM turned on the CAL bias voltages. |
LIM_ACTION_BIAS_TKR_ON | LIM turned on the TKR bias voltages. |
LIM_ACTION_BIAS_ACD_OFF | LIM turned off the ACD bias voltages. |
LIM_ACTION_BIAS_CAL_OFF | LIM turned off the CAL bias voltages. |
LIM_ACTION_BIAS_TKR_OFF | LIM turned off the TKR bias voltages. |
enum _LIM_Grb_State |
State of the GRB handler.
enum _LIM_Operating_Mode |
LIM operating modes.
enum _LIM_Other_State |
enum _LIM_Virtual_Mode |
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.
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). |
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.
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.
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). |
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.
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.
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). |
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.
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.
info_p | Location to return state information (must not be NULL). |
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.
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.
tid | ID of the LIM task. |
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.
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().
attr_p | Pointer to task attributes. CPU_DB task attributes will be used if this value is NULL. |
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.
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().
A MSG code if an error occurs.