LCI_cmddefs.h File Reference

Structures associated with CCSDS commands to subsystem LCI \ This file was auto-generated on Wed Nov 08 11:21:23 2006 \ LCAT version: V1-17-1. More...

#include <PBI/Endianness.h>

Classes
struct	_LCI_CALIBRATE_Prm
	Initiate the calibration \ APID 0x67c \ function code 1. More...
struct	_LCI_CALIBRATE_Pkt
	Initiate the calibration \ APID 0x67c \ function code 1. More...
struct	_LCI_ABORT_Pkt
	Abort a running calibration \ APID 0x67c \ function code 2. More...
struct	_LCI_NOOP_Pkt
	No operation \ APID 0x67d \ function code 0. More...
Typedefs
typedef struct _LCI_CALIBRATE_Prm	LCI_CALIBRATE_Prm
	Typedef for structure _LCI_CALIBRATE_Prm.
typedef struct _LCI_CALIBRATE_Pkt	LCI_CALIBRATE_Pkt
	Typedef for packet _LCI_CALIBRATE_Pkt.
typedef struct _LCI_ABORT_Pkt	LCI_ABORT_Pkt
	Typedef for packet _LCI_ABORT_Pkt.
typedef struct _LCI_NOOP_Pkt	LCI_NOOP_Pkt
	Typedef for packet _LCI_NOOP_Pkt.
typedef enum _LCI_Apid67cFcodes	LCI_Apid67cFcodes
	Typedef for enumeration _LCI_Apid67cFcodes.
typedef enum _LCI_Apid67dFcodes	LCI_Apid67dFcodes
	Typedef for enumeration _LCI_Apid67dFcodes.
Enumerations
enum	_LCI_Apid67cFcodes {   LCI_CALIBRATE_FCODE = 1,   LCI_ABORT_FCODE = 2 }
	Function code enumerations for apid 0x67c. More...
enum	_LCI_Apid67dFcodes { LCI_NOOP_FCODE = 0 }
	Function code enumerations for apid 0x67d. More...
Functions
unsigned int	LCI_CALIBRATE (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the CALIBRATE command.
unsigned int	LCI_ABORT (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the ABORT command.
unsigned int	LCI_NOOP (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the NOOP command.

---

Detailed Description

Structures associated with CCSDS commands to subsystem LCI \ This file was auto-generated on Wed Nov 08 11:21:23 2006 \ LCAT version: V1-17-1.

Warning:

Machine generated code - NEVER edit by hand

---

Enumeration Type Documentation

enum _LCI_Apid67cFcodes

Function code enumerations for apid 0x67c.

Enumerator:

LCI_CALIBRATE_FCODE	APID 0x67c function code 1
LCI_ABORT_FCODE	APID 0x67c function code 2

enum _LCI_Apid67dFcodes

Function code enumerations for apid 0x67d.

Enumerator:

LCI_NOOP_FCODE

APID 0x67d function code 0

---

Function Documentation

unsigned int LCI_ABORT	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the ABORT command.

Parameters:

	prm	User context parameter
	qitem	Queue item
	pay	Payload pointer
	len	Payload length

Return values:

LCI_SUCCESS

Always

References LCI_abort().

unsigned int LCI_CALIBRATE	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the CALIBRATE command.

Parameters:

	prm	User context parameter
	qitem	Queue item
	pay	Payload pointer
	len	Payload length

Returns:

Return status from LCI_calibrate

References _LCI_CALIBRATE_Prm::LATCCFG, LCI_calibrate(), _LCI_CALIBRATE_Prm::LCICFG, _LCI_CALIBRATE_Prm::LCIRUNID, and _LCI_CALIBRATE_Pkt::pay.

unsigned int LCI_NOOP	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the NOOP command.

Parameters:

	prm	User context parameter
	qitem	Queue item
	pay	Payload pointer
	len	Payload length

Return values:

LCI_SUCCESS

Always