GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LIM / V1-20-0

Constituent: lim     Tag: rad750

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

LIM_gbm.h File Reference

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

#include "ITC/ITC_pubdefs.h"
#include "LIM/LIM_pubdefs.h"
#include "LIM_DB/LIM_DB_schema.h"
#include "LIM_action.h"
#include "LIM_bulk.h"
#include "LIM_lpa.h"
#include "LIM_pkt_send.h"
#include "LIM_sc.h"
#include "LIM_task.h"

Include dependency graph for LIM_gbm.h:

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


Typedefs

typedef _LIM_Gbm LIM_Gbm
 Typedef for opaque GBM interface object handle.

Functions

unsigned int LIM_gbm_new (LIM_Gbm **object_pp, LIM_Action *action_p, LIM_Lpa *lpa_p, LIM_Sc *sc_p, LIM_Bulk *bulk_p, LIM_Pkt_Send *calcinfo_p, LIM_Pkt_Send *closeout_p, LIM_Pkt_Send *repoint_p, const LIM_DB_Schema *db_p)
 Create and initialize a new GBM interface object.
unsigned int LIM_gbm_delete (LIM_Gbm *object_p)
 Shutdown and delete a GBM interface object.
unsigned int LIM_gbm_change_pri_int_allowed (LIM_Gbm *object_p, int new_value, LIM_Task *task_p)
 Change the value of the pri_int_allowed flag.
unsigned int LIM_gbm_change_red_int_allowed (LIM_Gbm *object_p, int new_value, LIM_Task *task_p)
 Change the value of the red_int_allowed flag.
unsigned int LIM_gbm_change_rep_allowed (LIM_Gbm *object_p, int new_value, LIM_Task *task_p)
 Change the value of the GBM-Repoint-Allowed flag.
unsigned int LIM_gbm_get_info (LIM_Gbm *object_p, LIM_Info *info_p)
 Return GBM interface information.
unsigned int LIM_gbm_configure_interrupts (LIM_Gbm *object_p)
 Enable and disable the GBM interrupts.
unsigned int LIM_gbm_enable_interrupts (LIM_Gbm *object_p)
 Enable the GBM interrupts.
unsigned int LIM_gbm_handle_bulk (LIM_Gbm *object_p, LIM_Grb_State grb_state, int *int_occur_p)
 Handle a message on the BULK queue.
unsigned int LIM_gbm_handle_grb_idle (LIM_Gbm *object_p)
 Handle a transition to the GRB-Idle state.
int LIM_gbm_calcinfo_fcode (void)
 Return the function code of the GBM-Calcinfo command.
unsigned int LIM_gbm_sizeof_calcinfo (void)
 Return the size of a GBM-Calcinfo command.
unsigned int LIM_gbm_handle_calcinfo (LIM_Gbm *object_p, const ITC_QueueItem *qitem_p, int forward_ok, int *is_valid_p)
 Handle a GBM-Calcinfo command.
int LIM_gbm_closeout_fcode (void)
 Return the function code of the GBM-Closeout command.
unsigned int LIM_gbm_sizeof_closeout (void)
 Return the size of a GBM-Closeout command.
unsigned int LIM_gbm_handle_closeout (LIM_Gbm *object_p, const ITC_QueueItem *qitem_p, int forward_ok, int *is_valid_p)
 Handle a GBM-Closeout command.
int LIM_gbm_repoint_fcode (void)
 Return the function code of the GBM-Repoint command.
unsigned int LIM_gbm_sizeof_repoint (void)
 Return the size of a GBM-Repoint command.
unsigned int LIM_gbm_handle_repoint (LIM_Gbm *object_p, const ITC_QueueItem *qitem_p, int forward_ok, int slew_req_ok, int *is_valid_p)
 Handle a GBM-Repoint command.

Detailed Description

Interface to the functions found in LIM_gbm.c. 

**  CVS $Id: LIM_gbm.h,v 1.4 2007/12/16 23:03:09 dmay Exp $
**

Function Documentation

int LIM_gbm_calcinfo_fcode (  void   ) 
 

Return the function code of the GBM-Calcinfo command.

Returns:
GBM-Calcinfo command function code.

unsigned int LIM_gbm_change_pri_int_allowed (  LIM_Gbm *  object_p,
int  new_value,
LIM_Task *  task_p
) 
 

Change the value of the pri_int_allowed flag.

Parameters:
object_p Pointer to GBM interface object.
new_value New flag value.
task_p Pointer to task control object.
Returns:
MSG code.

unsigned int LIM_gbm_change_red_int_allowed (  LIM_Gbm *  object_p,
int  new_value,
LIM_Task *  task_p
) 
 

Change the value of the red_int_allowed flag.

Parameters:
object_p Pointer to GBM interface object.
new_value New flag value.
task_p Pointer to task control object.
Returns:
MSG code.

unsigned int LIM_gbm_change_rep_allowed (  LIM_Gbm *  object_p,
int  new_value,
LIM_Task *  task_p
) 
 

Change the value of the GBM-Repoint-Allowed flag.

Parameters:
object_p Pointer to GBM interface object.
new_value New flag value.
task_p Pointer to task control object.
Returns:
MSG code.

int LIM_gbm_closeout_fcode (  void   ) 
 

Return the function code of the GBM-Closeout command.

Returns:
GBM-Closeout command function code.

unsigned int LIM_gbm_configure_interrupts (  LIM_Gbm *  object_p  ) 
 

Enable and disable the GBM interrupts.

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

unsigned int LIM_gbm_delete (  LIM_Gbm *  object_p  ) 
 

Shutdown and delete a GBM interface object.

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

unsigned int LIM_gbm_enable_interrupts (  LIM_Gbm *  object_p  ) 
 

Enable the GBM interrupts.

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

unsigned int LIM_gbm_get_info (  LIM_Gbm *  object_p,
LIM_Info *  info_p
) 
 

Return GBM interface information.

Parameters:
object_p Pointer to GBM interface object.
info_p Location to return GBM interface information (must not be NULL).
Returns:
MSG code.

unsigned int LIM_gbm_handle_bulk (  LIM_Gbm *  object_p,
LIM_Grb_State  grb_state,
int *  int_occur_p
) 
 

Handle a message on the BULK queue.

Parameters:
object_p Pointer to GBM interface object.
grb_state Current GRB state.
int_occur_p Location to return interrupt status.
Returns:
MSG code.

unsigned int LIM_gbm_handle_calcinfo (  LIM_Gbm *  object_p,
const ITC_QueueItem *  qitem_p,
int  forward_ok,
int *  is_valid_p
) 
 

Handle a GBM-Calcinfo command.

Parameters:
object_p Pointer to GBM interface object.
qitem_p Pointer to queue item containing the command.
forward_ok Flag indicating that command can be forwarded to LPA.
is_valid_p Location to return validity indication.
Returns:
MSG code.

unsigned int LIM_gbm_handle_closeout (  LIM_Gbm *  object_p,
const ITC_QueueItem *  qitem_p,
int  forward_ok,
int *  is_valid_p
) 
 

Handle a GBM-Closeout command.

Parameters:
object_p Pointer to GBM interface object.
qitem_p Pointer to queue item containing the command.
forward_ok Flag indicating that command can be forwarded to LPA.
is_valid_p Location to return validity indication.
Returns:
MSG code.

unsigned int LIM_gbm_handle_grb_idle (  LIM_Gbm *  object_p  ) 
 

Handle a transition to the GRB-Idle state.

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

unsigned int LIM_gbm_handle_repoint (  LIM_Gbm *  object_p,
const ITC_QueueItem *  qitem_p,
int  forward_ok,
int  slew_req_ok,
int *  is_valid_p
) 
 

Handle a GBM-Repoint command.

Parameters:
object_p Pointer to GBM interface object.
qitem_p Pointer to queue item containing the command.
forward_ok Flag indicating that cmd can be forwarded to LPA.
slew_req_ok Flag indicating that slew-req can be sent to S/C.
is_valid_p Location to return validity indication.
Returns:
MSG code.

unsigned int LIM_gbm_new (  LIM_Gbm **  object_pp,
LIM_Action *  action_p,
LIM_Lpa *  lpa_p,
LIM_Sc *  sc_p,
LIM_Bulk *  bulk_p,
LIM_Pkt_Send *  calcinfo_p,
LIM_Pkt_Send *  closeout_p,
LIM_Pkt_Send *  repoint_p,
const LIM_DB_Schema *  db_p
) 
 

Create and initialize a new GBM interface object.

Parameters:
object_pp Location to return pointer to new object.
action_p Pointer to an action reporting object.
lpa_p Pointer to an LPA interface object.
sc_p Pointer to a spacecraft interface object.
bulk_p Pointer to a BULK queue object.
calcinfo_p Pointer to pkt sending object for GBM-Calcinfo cmd.
closeout_p Pointer to pkt sending object for GBM-Closeout cmd.
repoint_p Pointer to pkt sending object for GBM-Repoint cmd.
db_p Pointer to configuration information.
Returns:
MSG code.

int LIM_gbm_repoint_fcode (  void   ) 
 

Return the function code of the GBM-Repoint command.

Returns:
GBM-Repoint command function code.

unsigned int LIM_gbm_sizeof_calcinfo (  void   ) 
 

Return the size of a GBM-Calcinfo command.

Returns:
GBM-Calcinfo command size, in bytes.

unsigned int LIM_gbm_sizeof_closeout (  void   ) 
 

Return the size of a GBM-Closeout command.

Returns:
GBM-Closeout command size, in bytes.

unsigned int LIM_gbm_sizeof_repoint (  void   ) 
 

Return the size of a GBM-Repoint command.

Returns:
GBM-Repoint command size, in bytes.

Generated on Thu Oct 30 01:44:41 2008 by  doxygen 1.4.4