---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > CTS / V2-2-0

Constituent: cts_scp_enet     Tag: sun-gcc

---

         

---

CTS_pubdefs.h File Reference

Public definitions for the CTS package. More...

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

Include dependency graph for CTS_pubdefs.h:

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

Defines
#define	CRX_L_SVC_TYPES   (2)
	Number of CRX service types.
Typedefs
typedef enum _CRX_ServiceType	CRX_ServiceType
	Typedef for enum _CRX_ServiceType.
typedef unsigned int	CRX_cb_Driver (void *prm, unsigned char *pkt)
	Signature for an callback buried in the CTDB receive task.
Enumerations
enum	_CRX_ServiceType {   CRX_TYP_CMD = 0,   CRX_TYP_TLM = 1 }
	Enumeration of CRX service types. More...
Functions
unsigned int	CRX_createService (CRX_ServiceType typ, CRX_cb_Driver *rtn, void *prm)
	Create a CTDB (1553) receive service block.
unsigned int	CRX_deleteService (CRX_ServiceType typ)
	Delete a CTDB (1553) receive service block.
unsigned int	CRX_dispatch (void *prm, unsigned char *pkt)
	Driver level packet dispatch (used in CTDB driver).
unsigned int	CRX_startService (CRX_ServiceType typ, TASK_attr *attr)
	Start a CTDB (1553) receive service.
unsigned int	CRX_stopService (CRX_ServiceType typ)
	Start a CTDB (1553) receive service.
unsigned int	CTS_createDevice (void *addr)
	Create and initialize a CTDB (1553) device.
unsigned int	CTS_deleteDevice (void)
	Delete a CTDB (1553) device.
void *	CTS_getDevice (void)
	Return the CTDB (1553) device handle.
unsigned int	CTS_initialize (void)
	Initialize the CTS master control block.
unsigned int	CTS_shutdown (void)
	Shut down the CTS master control block and release resources.
unsigned int	CTS_startDevice (void)
	Start a CTDB (1553) device.
unsigned int	CTS_stopDevice (void)
	Stop a CTDB (1553) device.
unsigned int	CTX_createService (ITC_TaskID tid, unsigned int nim, ITC_cb_Memory *rtn, void *prm)
	Initialize an CTX service control block.
unsigned int	CTX_deleteService (void)
	Delete an CTX task block and release the associated resources.
unsigned int	CTX_startService (TASK_attr *attr)
	Start the CTX service task.
unsigned int	CTX_stopService (void)
	Stop the task implementing the CTX service layer.

---

Detailed Description

Public definitions for the CTS package.

CVS $Id: CTS_pubdefs.h,v 1.7 2005/05/12 01:23:17 apw Exp $

Author:

A.P.Waite

---

Enumeration Type Documentation

enum _CRX_ServiceType

Enumeration of CRX service types. Enumeration values: CRX_TYP_CMD  Service to receive telecommands CRX_TYP_TLM  Service to receive telemetry

---

Function Documentation

unsigned int CRX_createService (  CRX_ServiceType  typ, CRX_cb_Driver *  rtn, void *  prm )

Create a CTDB (1553) receive service block. Parameters: typ  (in) Service type (command or telemetry) rtn  (in) Dispatch callback routine prm  (in) Dispatch callback routine parameter Return values: CTS_ALOCFAIL  Memory allocation failure CTS_BADSTAT  Not in state "uninitialized" (bad state transition) CTS_MUALOCFL  Cannot allocate a mutex CTS_SUCCESS  Success CRX_createService() allocates and initializes a CTDB (1553) receive service block.

Here is the call graph for this function:

unsigned int CRX_deleteService (  CRX_ServiceType  typ  )

Delete a CTDB (1553) receive service block. Parameters: typ  (in) Service type (command or telemetry) Return values: CTS_ALOCFAIL  Memory allocation failure CTS_BADSTAT  Not in state "uninitialized" (bad state transition) CTS_MUALOCFL  Cannot allocate a mutex CTS_SUCCESS  Success CRX_deleteService() frees resources associated with a CTDB (1553) receive service block.

Here is the call graph for this function:

unsigned int CRX_dispatch (  void *  prm, unsigned char *  pkt )

Driver level packet dispatch (used in CTDB driver). Parameters: prm  (in) User context parameter pkt  (in) CCSDS telecommand (first byte of primary header) Return values: CTS_SUCCESS  Success CTS_ALOCFAIL  Cannot allocate packet to forward the command CTS_APIDRNG  APID invalid as spacecraft command CTS_APIDTBL  APID has no associated APID table entry CTS_QUEUTBL  APID does not map to a queue table entry CTS_GENERROR  Generic error Warning: This dispatcher can only be used on a LAT SIU. It will fail if it's made the dispatcher on an emulated spacecraft. CRX_dispatch() is the dispatcher operating inside the CTDB command receive task. If dispatches to an application task based on APID.

unsigned int CRX_startService (  CRX_ServiceType  typ, TASK_attr *  attr )

Start a CTDB (1553) receive service. Parameters: typ  (in) Service type (command or telemetry) attr  (in) Task attributes Return values: CTS_BADSTAT  Not in state "initialized" (bad state transition) CTS_NOTINIT  Control block has not been allocated/initialized CTS_SUCCESS  Success CTS_TASKSTRT  Cannot start receive task CRX_startService() starts a CTDB (1553) receive service

Here is the call graph for this function:

unsigned int CRX_stopService (  CRX_ServiceType  typ  )

Start a CTDB (1553) receive service. Parameters: typ  (in) Service type (command or telemetry) Return values: CTS_BADSTAT  Not in state "initialized" (bad state transition) CTS_NOTINIT  Control block has not been allocated/initialized CTS_SUCCESS  Success CTS_TASKSTRT  Cannot start receive task CRX_stopService() stops a CTDB (1553) receive service

Here is the call graph for this function:

unsigned int CTS_createDevice (  void *  addr  )

Create and initialize a CTDB (1553) device. Parameters: addr  (in) Address of remote terminal Return values: CTS_ALOCFAIL  Memory allocation failure CTS_BADSTAT  Not in state "uninitialized" (bad state transition) CTS_MUALOCFL  Cannot allocate a mutex CTS_SUCCESS  Success CTS_createDevice() creates and initializes a CTDB (1553) device

Here is the call graph for this function:

unsigned int CTS_deleteDevice (  void   )

Delete a CTDB (1553) device. Return values: LCS_SUCCESS  Success LCS_GENERROR  Generic error CTS_deleteDevice() deletes a CTDB (1553) device

Here is the call graph for this function:

void * CTS_getDevice (  void   )

Return the CTDB (1553) device handle. Returns: The CTDB device handle

unsigned int CTS_initialize (  void   )

Initialize the CTS master control block. Return values: CTS_SUCCESS  Success CTS_GENERROR  Generic error CTS_initialize() initializes the CTS master control block.

unsigned int CTS_shutdown (  void   )

Shut down the CTS master control block and release resources. Return values: CTS_SUCCESS  Success CTS_GENERROR  Generic error CTS_shutdown() shuts down the CTS master control block and releases assocoated resources

unsigned int CTS_startDevice (  void   )

Start a CTDB (1553) device. Return values: LCS_SUCCESS  Success LCS_GENERROR  Generic error CTS_startDevice() starts a CTDB (1553) device

Here is the call graph for this function:

unsigned int CTS_stopDevice (  void   )

Stop a CTDB (1553) device. Return values: LCS_SUCCESS  Success LCS_GENERROR  Generic error CTS_stopDevice() stops a CTDB (1553) device

Here is the call graph for this function:

unsigned int CTX_createService (  ITC_TaskID  tid, unsigned int  nim, ITC_cb_Memory *  rtn, void *  prm )

Initialize an CTX service control block. Parameters: tid  (in) ITC task ID for this service nim  (in) Mask of ITC nodes served by this service (not implemented) rtn  (in) Memory allocator for diagnostic stream prm  (in) Memory allocator for diagnostic stream - parameter Return values: CTS_SUCCESS  Success CTS_GENERROR  Generic error CTX_createService() creates and intializes an CTX service control block

Here is the call graph for this function:

unsigned int CTX_deleteService (  void   )

Delete an CTX task block and release the associated resources. Return values: CTS_SUCCESS  Success CTS_GENERROR  Generic error CTX_deleteTask() deletes an CTX task block and releases the associated resources.

Here is the call graph for this function:

unsigned int CTX_startService (  TASK_attr *  attr  )

Start the CTX service task. Parameters: attr  (in) Task attributes Return values: LCS_SUCCESS  Success LCS_GENERROR  Generic error CTX_startService() starts the CTX service task.

Here is the call graph for this function:

unsigned int CTX_stopService (  void   )

Stop the task implementing the CTX service layer. Return values: LCS_SUCCESS  Success LCS_GENERROR  Generic error CTX_stopService() stops the task implementing the CTX service layer.

Here is the call graph for this function:

---