LMC_cmddefs.h File Reference

Structures associated with CCSDS commands to subsystem LMC \ This file was auto-generated on Fri Jul 18 09:10:18 2008 \ LCAT version: V1-23-1. More...

#include <PBI/Endianness.h>

Classes
struct	_LMC_dead_mask_Bfl
	TEM Deadtime Mask. More...
union	_LMC_dead_mask
	Union for command bitfield _LMC_dead_mask_Bfl. More...
struct	_LMC_cal_lrs_Prm
	CAL Low Rate Science Counters \ APID 0x69c \ function code 0. More...
struct	_LMC_tkr_lrs_Prm
	TKR Low Rate Science Counters \ APID 0x69c \ function code 1. More...
struct	_LMC_acd_tile_pair_Prm
	ACD Tile Counter (Pair) \ APID 0x69c \ function code 2. More...
struct	_LMC_acd_tile_all_Prm
	ACD Tile Counters (All) \ APID 0x69c \ function code 3. More...
struct	_LMC_stop_count_Prm
	Stop Active Counter \ APID 0x69c \ function code 4. More...
struct	_LMC_tem_deadtime_Prm
	TEM Deadtime Low Rate Science Counter \ APID 0x69c \ function code 5. More...
struct	_LMC_cal_lrs_Pkt
	CAL Low Rate Science Counters \ APID 0x69c \ function code 0. More...
struct	_LMC_tkr_lrs_Pkt
	TKR Low Rate Science Counters \ APID 0x69c \ function code 1. More...
struct	_LMC_acd_tile_pair_Pkt
	ACD Tile Counter (Pair) \ APID 0x69c \ function code 2. More...
struct	_LMC_acd_tile_all_Pkt
	ACD Tile Counters (All) \ APID 0x69c \ function code 3. More...
struct	_LMC_stop_count_Pkt
	Stop Active Counter \ APID 0x69c \ function code 4. More...
struct	_LMC_tem_deadtime_Pkt
	TEM Deadtime Low Rate Science Counter \ APID 0x69c \ function code 5. More...
struct	_LMC_noop_Pkt
	No-op \ APID 0x69c \ function code 6. More...
Typedefs
typedef struct _LMC_dead_mask_Bfl	LMC_dead_mask_Bfl
	Typedef for command bitfield structure _LMC_dead_mask_Bfl.
typedef union _LMC_dead_mask	LMC_dead_mask
	Typedef for union _LMC_dead_mask.
typedef struct _LMC_cal_lrs_Prm	LMC_cal_lrs_Prm
	Typedef for structure _LMC_cal_lrs_Prm.
typedef struct _LMC_tkr_lrs_Prm	LMC_tkr_lrs_Prm
	Typedef for structure _LMC_tkr_lrs_Prm.
typedef struct _LMC_acd_tile_pair_Prm	LMC_acd_tile_pair_Prm
	Typedef for structure _LMC_acd_tile_pair_Prm.
typedef struct _LMC_acd_tile_all_Prm	LMC_acd_tile_all_Prm
	Typedef for structure _LMC_acd_tile_all_Prm.
typedef struct _LMC_stop_count_Prm	LMC_stop_count_Prm
	Typedef for structure _LMC_stop_count_Prm.
typedef struct _LMC_tem_deadtime_Prm	LMC_tem_deadtime_Prm
	Typedef for structure _LMC_tem_deadtime_Prm.
typedef struct _LMC_cal_lrs_Pkt	LMC_cal_lrs_Pkt
	Typedef for packet _LMC_cal_lrs_Pkt.
typedef struct _LMC_tkr_lrs_Pkt	LMC_tkr_lrs_Pkt
	Typedef for packet _LMC_tkr_lrs_Pkt.
typedef struct _LMC_acd_tile_pair_Pkt	LMC_acd_tile_pair_Pkt
	Typedef for packet _LMC_acd_tile_pair_Pkt.
typedef struct _LMC_acd_tile_all_Pkt	LMC_acd_tile_all_Pkt
	Typedef for packet _LMC_acd_tile_all_Pkt.
typedef struct _LMC_stop_count_Pkt	LMC_stop_count_Pkt
	Typedef for packet _LMC_stop_count_Pkt.
typedef struct _LMC_tem_deadtime_Pkt	LMC_tem_deadtime_Pkt
	Typedef for packet _LMC_tem_deadtime_Pkt.
typedef struct _LMC_noop_Pkt	LMC_noop_Pkt
	Typedef for packet _LMC_noop_Pkt.
typedef enum _LMC_Apid69cFcodes	LMC_Apid69cFcodes
	Typedef for enumeration _LMC_Apid69cFcodes.
Enumerations
enum	_LMC_Apid69cFcodes {   LMC_CAL_LRS_FCODE = 0,   LMC_TKR_LRS_FCODE = 1,   LMC_ACD_TILE_PAIR_FCODE = 2,   LMC_ACD_TILE_ALL_FCODE = 3,   LMC_STOP_COUNT_FCODE = 4,   LMC_TEM_DEADTIME_FCODE = 5,   LMC_NOOP_FCODE = 6 }
	Function code enumerations for apid 0x69c. More...
Functions
unsigned int	LMC_cal_lrs (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Process the cal_lrs command.
unsigned int	LMC_tkr_lrs (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Process the tkr_lrs command.
unsigned int	LMC_acd_tile_pair (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Process the acd_tile_pair command.
unsigned int	LMC_acd_tile_all (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Process the acd_tile_all command.
unsigned int	LMC_stop_count (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Process the stop_count command.
unsigned int	LMC_tem_deadtime (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Process the tem_deadtime command.
unsigned int	LMC_noop (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Process the noop command.

---

Detailed Description

Structures associated with CCSDS commands to subsystem LMC \ This file was auto-generated on Fri Jul 18 09:10:18 2008 \ LCAT version: V1-23-1.

Warning:

Machine generated code - NEVER edit by hand

---

Enumeration Type Documentation

enum _LMC_Apid69cFcodes

Function code enumerations for apid 0x69c.

Enumerator:

LMC_CAL_LRS_FCODE	APID 0x69c function code 0
LMC_TKR_LRS_FCODE	APID 0x69c function code 1
LMC_ACD_TILE_PAIR_FCODE	APID 0x69c function code 2
LMC_ACD_TILE_ALL_FCODE	APID 0x69c function code 3
LMC_STOP_COUNT_FCODE	APID 0x69c function code 4
LMC_TEM_DEADTIME_FCODE	APID 0x69c function code 5
LMC_NOOP_FCODE	APID 0x69c function code 6

---

Function Documentation

unsigned int LMC_acd_tile_all	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pkt,
		unsigned int	len
	)

Process the acd_tile_all command.

Parameters:

	prm	User context parameter (not used)
	qitem	Queue item (not used)
	pkt	Packet pointer
	len	Packet length (not used)

Return values:

	LMC_SUCCESS	Success
	LMC_NOTINIT	LMC not initialized
	LMC_CNTRACTV	Counter already active
	LMC_PRMERROR	Invalid parameter value
	LMC_NODGPKT	No diagnostic packet available
	LMC_NOSCIPKT	No science data packet available
	LMC_LCBDFAIL	Register load failed

References _LMC_reset_valid_bf::acd_all, _LMC_Reset_Row::acd_all, _LMC_Control::acd_cnt, _LMC_reset_valid_bf::acd_pair, _LMC_Counter::all_tile, _LMC_reset_valid::bf, _LMC_Counter::busy, _LMC_acd_tile_all_Prm::cnt, _LMC_Counter::cur_cnt, _LMC_acd_tile_all_Prm::dest, _LMC_Counter::intv, _LMC_acd_tile_all_Prm::intv, _LMC_Counter::ld, _LMC_Counter::ld_xcb, LMC_CNT_FOREVER, LMC_freeBuffer(), LMC_getBuffer(), LMC_getCtrl(), LMC_K_RESET_FORMAT_0, LMC_MIN_INTERVAL, N_ACD_TILES, _LMC_Counter::name, LMC_rd::nci, LMC_ld::nci, NEXT_CI, _LMC_acd_tile_all_Pkt::pay, _LMC_Counter::rd, _LMC_Counter::rem_cnt, _LMC_Control::reset, _LMC_Counter::stop, _LMC_Reset::trd, _LMC_Reset::trd_cache, _LMC_Counter::use_ssr, and _LMC_Reset_Row::valid.

unsigned int LMC_acd_tile_pair	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pkt,
		unsigned int	len
	)

Process the acd_tile_pair command.

Parameters:

	prm	User context parameter (not used)
	qitem	Queue item (not used)
	pkt	Packet pointer
	len	Packet length (not used)

Return values:

	LMC_SUCCESS	Success
	LMC_NOTINIT	LMC not initialized
	LMC_CNTRACTV	Counter already active
	LMC_PRMERROR	Invalid parameter value
	LMC_NODGPKT	No diagnostic packet available
	LMC_NOSCIPKT	No science data packet available
	LMC_LCBDFAIL	Register load failed

References _LMC_reset_valid_bf::acd_all, _LMC_Control::acd_cnt, _LMC_reset_valid_bf::acd_pair, _LMC_Reset_Row::acd_pair, _LMC_Counter::all_tile, _LMC_reset_valid::bf, _LMC_Counter::busy, _LMC_acd_tile_pair_Prm::cnt, _LMC_Counter::cur_cnt, _LMC_acd_tile_pair_Prm::dest, _LMC_Counter::intv, _LMC_acd_tile_pair_Prm::intv, _LMC_Counter::ld, _LMC_Counter::ld_xcb, LMC_CNT_FOREVER, LMC_freeBuffer(), LMC_getBuffer(), LMC_getCtrl(), LMC_K_RESET_FORMAT_0, LMC_MIN_INTERVAL, N_ACD_TILES, _LMC_Counter::name, LMC_rd::nci, LMC_ld::nci, NEXT_CI, _LMC_acd_tile_pair_Pkt::pay, _LMC_Counter::rd, _LMC_Counter::rem_cnt, _LMC_Control::reset, _LMC_Counter::stop, _LMC_acd_tile_pair_Prm::tile_0, _LMC_acd_tile_pair_Prm::tile_1, _LMC_Reset::trd, _LMC_Reset::trd_cache, _LMC_Counter::use_ssr, and _LMC_Reset_Row::valid.

unsigned int LMC_cal_lrs	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pkt,
		unsigned int	len
	)

Process the cal_lrs command.

Parameters:

	prm	User context parameter (not used)
	qitem	Queue item (not used)
	pkt	Packet pointer
	len	Packet length (not used)

Return values:

	LMC_SUCCESS	Success
	LMC_NOTINIT	LMC not initialized
	LMC_CNTRACTV	Counter already active
	LMC_PRMERROR	Invalid parameter value
	LMC_NODGPKT	No diagnostic packet available
	LMC_NOSCIPKT	No science data packet available
	LMC_LCBDFAIL	Register load failed

References _LMC_reset_valid::bf, _LMC_Counter::busy, _LMC_reset_valid_bf::cal, _LMC_Reset_Row::cal, _LMC_Control::cal_cnt, _LMC_cal_lrs_Prm::cal_mask, _LMC_cal_lrs_Prm::cnt, _LMC_Counter::cur_cnt, _LMC_cal_lrs_Prm::dest, _LMC_Counter::intv, _LMC_cal_lrs_Prm::intv, _LMC_Counter::ld, _LMC_Counter::ld_xcb, LMC_CNT_FOREVER, LMC_freeBuffer(), LMC_getBuffer(), LMC_getCtrl(), LMC_K_RESET_FORMAT_0, LMC_MIN_INTERVAL, _LMC_Counter::lrs_mask, N_TEMS, _LMC_Counter::name, LMC_rd::nci, LMC_ld::nci, NEXT_CI, _LMC_cal_lrs_Pkt::pay, _LMC_Counter::rd, _LMC_Counter::rem_cnt, _LMC_Control::reset, _LMC_Counter::stop, _LMC_cal_lrs_Prm::tem_mask, _LMC_Counter::tem_mask, _LMC_Reset::trd, _LMC_Reset::trd_cache, _LMC_Counter::use_ssr, and _LMC_Reset_Row::valid.

unsigned int LMC_noop	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pkt,
		unsigned int	len
	)

Process the noop command.

Parameters:

	prm	User context parameter (not used)
	qitem	Queue item (not used)
	pkt	Packet pointer
	len	Packet length (not used)

Return values:

LMC_SUCCESS

Success

unsigned int LMC_stop_count	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pkt,
		unsigned int	len
	)

Process the stop_count command.

Parameters:

	prm	User context parameter (not used)
	qitem	Queue item (not used)
	pkt	Packet pointer
	len	Packet length (not used)

Return values:

	LMC_SUCCESS	Success
	LMC_NOTINIT	LMC not initialized

References _LMC_reset_valid_bf::acd_all, _LMC_Control::acd_cnt, _LMC_reset_valid_bf::acd_pair, _LMC_reset_valid::bf, _LMC_reset_valid_bf::cal, _LMC_Control::cal_cnt, _LMC_Control::dead_cnt, _LMC_reset_valid_bf::deadtime, LMC_getCtrl(), LMC_K_RESET_FORMAT_0, LMC_OP_ALL, LMC_OP_CAL, LMC_OP_DEAD, LMC_OP_TILE_ALL, LMC_OP_TILE_PAIR, LMC_OP_TKR, _LMC_stop_count_Prm::opcode, _LMC_stop_count_Pkt::pay, _LMC_Control::reset, _LMC_reset_valid_bf::tkr, _LMC_Control::tkr_cnt, _LMC_Reset::trd, _LMC_Reset::trd_cache, and _LMC_Reset_Row::valid.

unsigned int LMC_tem_deadtime	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pkt,
		unsigned int	len
	)

Process the tem_deadtime command.

Parameters:

	prm	User context parameter (not used)
	qitem	Queue item (not used)
	pkt	Packet pointer
	len	Packet length (not used)

Return values:

	LMC_SUCCESS	Success
	LMC_NOTINIT	LMC not initialized
	LMC_CNTRACTV	Counter already active
	LMC_PRMERROR	Invalid parameter value
	LMC_NODGPKT	No diagnostic packet available
	LMC_NOSCIPKT	No science data packet available
	LMC_LCBDFAIL	Register load failed

References _LMC_reset_valid::bf, _LMC_Counter::busy, _LMC_tem_deadtime_Prm::cnt, _LMC_Counter::cur_cnt, _LMC_Control::dead_cnt, _LMC_tem_deadtime_Prm::dead_mask, _LMC_reset_valid_bf::deadtime, _LMC_Reset_Row::deadtime, _LMC_tem_deadtime_Prm::dest, _LMC_Counter::intv, _LMC_tem_deadtime_Prm::intv, _LMC_Counter::ld, _LMC_Counter::ld_xcb, LMC_CNT_FOREVER, LMC_freeBuffer(), LMC_getBuffer(), LMC_getCtrl(), LMC_K_RESET_FORMAT_0, LMC_MIN_INTERVAL, _LMC_Counter::lrs_mask, N_TEMS, _LMC_Counter::name, LMC_rd::nci, LMC_ld::nci, NEXT_CI, _LMC_tem_deadtime_Pkt::pay, _LMC_Counter::rd, _LMC_Counter::rem_cnt, _LMC_Control::reset, _LMC_Counter::stop, _LMC_tem_deadtime_Prm::tem_mask, _LMC_Counter::tem_mask, _LMC_Reset::trd, _LMC_Reset::trd_cache, _LMC_dead_mask::us, _LMC_Counter::use_ssr, and _LMC_Reset_Row::valid.

unsigned int LMC_tkr_lrs	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pkt,
		unsigned int	len
	)

Process the tkr_lrs command.

Parameters:

	prm	User context parameter (not used)
	qitem	Queue item (not used)
	pkt	Packet pointer
	len	Packet length (not used)

Return values:

	LMC_SUCCESS	Success
	LMC_NOTINIT	LMC not initialized
	LMC_CNTRACTV	Counter already active
	LMC_PRMERROR	Invalid parameter value
	LMC_NODGPKT	No diagnostic packet available
	LMC_NOSCIPKT	No science data packet available
	LMC_LCBDFAIL	Register load failed

References _LMC_reset_valid::bf, _LMC_Counter::busy, _LMC_tkr_lrs_Prm::cnt, _LMC_Counter::cur_cnt, _LMC_tkr_lrs_Prm::dest, _LMC_Counter::intv, _LMC_tkr_lrs_Prm::intv, _LMC_Counter::ld, _LMC_Counter::ld_xcb, LMC_CNT_FOREVER, LMC_freeBuffer(), LMC_getBuffer(), LMC_getCtrl(), LMC_K_RESET_FORMAT_0, LMC_MIN_INTERVAL, _LMC_Counter::lrs_mask, N_TEMS, _LMC_Counter::name, LMC_rd::nci, LMC_ld::nci, NEXT_CI, _LMC_tkr_lrs_Pkt::pay, _LMC_Counter::rd, _LMC_Counter::rem_cnt, _LMC_Control::reset, _LMC_Counter::stop, _LMC_tkr_lrs_Prm::tem_mask, _LMC_Counter::tem_mask, _LMC_reset_valid_bf::tkr, _LMC_Reset_Row::tkr, _LMC_Control::tkr_cnt, _LMC_tkr_lrs_Prm::tkr_mask, _LMC_Reset::trd, _LMC_Reset::trd_cache, _LMC_Counter::use_ssr, and _LMC_Reset_Row::valid.