PBC_pubdefs.h File Reference

Public interface to the PBC package functions. More...

#include <ITC/ITC_pubdefs.h>

Functions
unsigned int	PBC_initialize (ITC_Task *task, ITC_TaskID tid)
	Initialize the PBC application-level functions.
unsigned int	PBC_init (void)
	Initialize the PBC application-level functions using CDM.
unsigned int	PBC_shutdown (void)
	Shut down the PBC application-level functions.

---

Detailed Description

Public interface to the PBC package functions.

  CVS $Id: PBC_pubdefs.h,v 1.7 2011/03/29 23:14:58 apw Exp $
  

---

Function Documentation

unsigned int PBC_init

(

void

)

Initialize the PBC application-level functions using CDM.

This function is a wrapper for PBC_initialize() that uses CDM to determine its parameters.

Returns:

Zero if successful.

A MSG code if an error occurs.

References PBC_initialize().

unsigned int PBC_initialize	(	ITC_Task *	task_p,
		ITC_TaskID	tid
	)

Initialize the PBC application-level functions.

This function initializes the application-level portion of the PBC package. At the application level, there is no PBC task. Instead, the handlers for the PBC telecommands are attached to another task. If a valid value is provided for either the task_p or the tid parameter, then this function will attach the PBC command handlers to the corresponding task. If neither parameter is specified (by setting task_p to NULL and tid to -1), then it is assumed that the controlling task is responsible for attaching the PBC command handlers.

Parameters:

	task_p	Pointer to controlling task's description block.
	tid	ID of the controlling task.

Returns:

MSG code.

References PBC_Apid640, PBC_bootTlmCb(), pbc_change_state(), pbc_create_control_block(), PBC_CTL_INITIALIZED, PBC_CTL_INITIALIZING, PBC_CTL_UNINITIALIZED, pbc_pool_alloc(), pbc_pool_init(), _PBC_Control::pkt_buf_p, _PBC_Control::pkt_bytes, _PBC_Control::pkt_fcb_p, _PBC_Control::pkt_in_use, _PBC_Control::state, and _PBC_Control::task_p.

Referenced by PBC_init().

unsigned int PBC_shutdown

(

void

)

Shut down the PBC application-level functions.

Returns:

MSG code.

References PBC_Apid640, pbc_change_state(), PBC_CTL_INITIALIZED, PBC_CTL_SHUTDOWN, PBC_CTL_UNINITIALIZED, pbc_pool_release(), _PBC_Control::pkt_buf_p, _PBC_Control::pkt_fcb_p, _PBC_Control::pkt_in_use, _PBC_Control::state, and _PBC_Control::task_p.