lci.h File Reference

Interface to the LAT Charge Injection package. More...

#include <PBS/TASK.h>

Classes
struct	_LCI_runInfo
	Structure to hold information about the last LCI run Must match the layout of LHK telemetry. More...
Typedefs
typedef struct _LCI_runInfo	LCI_runInfo
	Structure to hold information about the last LCI run Must match the layout of LHK telemetry.
Functions
unsigned	LCI_getRunInfo (LCI_runInfo *info)
	Get extended information about the calibration run.
unsigned	LCI_initialise (void)
	Initialize the calibration system from its config database.
unsigned	LCI_sizeofRunInfo ()
	Get the size of the extended calibration run information.
unsigned	LCI_startTask (void)
	Start the LCI task using its config database.
unsigned	LCI_stopTask (void)
	Stop the LCI task.
unsigned	LCI_teardown (void)
	Tear down the calibration system.

---

Detailed Description

Interface to the LAT Charge Injection package.

Author:

James Swain & Owen Saxton

Id

lci.h,v 1.8 2011/03/29 19:23:13 saxton Exp

---

Function Documentation

unsigned LCI_getRunInfo

(

LCI_runInfo *

info

)

Get extended information about the calibration run.

This routine fills a block of information detailing the current state of calibration runs.

Parameters:

info

The address of a block to be filled with the current run information.

Return values:

LCI_SUCCESS

success always

References _LCI_runInfo::cfgFid, _LCI_runInfo::endSec, _LCI_runInfo::endSub, _LCI_runInfo::latcFid, _LCI_runInfo::runId, _LCI_runInfo::spare, _LCI_runInfo::startSec, _LCI_runInfo::startSub, and _LCI_runInfo::status.

unsigned LCI_initialise

(

void

)

Initialize the calibration system from its config database.

This routine is normally called at system initialization time to initialize the calibration system . It uses a configuration database to supply the capacity, cpuid and srcid parameters.

Returns:

Any of the return codes from LCI_init

References LCI_init().

unsigned LCI_sizeofRunInfo

(

void

)

Get the size of the extended calibration run information.

This routine returns the size of the area needed to hold the extended run information for the last calibration.

Returns:

The size, in bytes, of the extended run information.

unsigned LCI_startTask

(

void

)

Start the LCI task using its config database.

This routine is normally called during system initialization. It starts the LCI task using the CPU configuration database to supply its attributes.

Returns:

Any of the return codes from LCI_startTask

References LCI_start().

unsigned LCI_stopTask

(

void

)

Stop the LCI task.

This routine stops the LCI task and sets the state to INITIALISED.

Returns:

LCI_STATE if the state is not WAITING, an error status code from ITC_stopTask or LCI_SUCCESS if all goes well

unsigned LCI_teardown

(

void

)

Tear down the calibration system.

This routine frees all the resources associated with the LCI task.

Return values:

	LCI_STATE	If the LCI task is not in the INITIALISED state
	LCI_SUCCESS	If all goes well

References LCI_Apid67c, LCI_Apid67d, and LCI_deleteController().

Referenced by LCI_init().