LSM_command.c File Reference

LSM command functions. More...

#include <LSM/LSM_cmddefs.h>
#include <LSM/LSM_cmdxtrn.h>
#include <LSM/LSM_msgs.h>
#include <LSM_prvdefs.h>
#include <LSM_ssrdefs.h>
#include <LSF/LSF.h>
#include <ITC/ITC_pubdefs.h>
#include <ITC/ITC_msgs.h>
#include <CCSDS/CCSDS_pkt.h>
#include <ATT/ATT.h>
#include <THS/THS.h>
#include <MSG/MSG_pubdefs.h>
#include <LIM/LIM_cmddefs.h>
#include <PBS/WCT.h>
#include <stdlib.h>
#include <CLI/CLI_pubdefs.h>

Defines
#define	ANC_FLAGS_IN_SAA   0x1
	Bit in flags flield of Magic7 Anc Packet that determines if in SAA.
#define	LIM_APID_FOR_SAA_ENTER_EXIT   0x663
	APID define for telemetry packet to send to LIM.
Functions
unsigned int	LSM_getAncillary (void)
	To dump or not to dump.
unsigned int	LSM_getAttitude (void)
	To dump or not to dump.
unsigned int	LSM_getTimetone (void)
	To dump or not to dump.
unsigned int	LSM_getSsrOutOff (void)
	To dump or not to dump.
unsigned int	LSM_getSsrOutOn (void)
	To dump or not to dump.
void	LSM_setAncillary (unsigned int cnt)
	Set the ancillary packet dump count.
void	LSM_setAttitude (unsigned int cnt)
	Set the attitude packet dump count.
void	LSM_setTimetone (unsigned int cnt)
	Set the timetone packet dump count.
void	LSM_setSsrOutOff (unsigned int cnt)
	Set the SsrOutOff packet dump count.
void	LSM_setSsrOutOn (unsigned int cnt)
	Set the SsrOutOn packet dump count.
unsigned int	LSM_SIANCILLARY (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Processor for the SIANCILLARY telecommand.
unsigned int	LSM_SIATTITUDE (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Processor for the SIATTITIDE telecommand.
unsigned int	LSM_SITIMETONE (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Processor for the SITIMETONE telecommand.
unsigned int	LSM_SSRoutputOff (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Processor for the LSMSSROUTPUTOFF telecommand.
unsigned int	LSM_SSRoutputOn (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Processor for the LSMSSROUTPUTON telecommand.
unsigned int	LSM_Noop (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the noop command.
static unsigned int	LSM_setAncillary_cli (CLI_Control *cli, void *prm)
	CLI callback for "LSM_sendAttitude" command.
static unsigned int	LSM_setAttitude_cli (CLI_Control *cli, void *prm)
	CLI callback for "LSM_sendAttitude" command.
static unsigned int	LSM_setTimetone_cli (CLI_Control *cli, void *prm)
	CLI callback for "LSM_sendAttitude" command.
static unsigned int	LSM_setSsrOutOff_cli (CLI_Control *cli, void *prm)
	CLI callback for "LSM_sendSsrOutOff" command.
static unsigned int	LSM_setSsrOutOn_cli (CLI_Control *cli, void *prm)
	CLI callback for "LSM_sendSsrOutOn" command.
unsigned int	LSM_addSyntaxLCP (CLI_Syntax *syntax)
	Contribute the LSM section to the LCP command line syntax.
Variables
static int	LSM_cntAncillary
	Count-down counter for ancillary dumps.
static int	LSM_cntAttitude
	Count-down counter for attitude dumps.
static int	LSM_cntTimetone
	Count-down counter for timetone dumps.
static int	LSM_cntSsrOutOff
	Count-down counter for SsrOutOff dumps.
static int	LSM_cntSsrOutOn
	Count-down counter for SsrOutOn dumps.
const char *	d_0 = "$0"
	The string "$0".

---

Detailed Description

LSM command functions.

CVS $Id: LSM_command.c,v 1.25 2011/03/29 21:44:12 russell Exp $

Author:

A.P.Waite

---

Function Documentation

unsigned int LSM_addSyntaxLCP

(

CLI_Syntax *

syntax

)

Contribute the LSM section to the LCP command line syntax.

Parameters:

syntax

Syntax handle

Returns:

CLI_SUCCESS

References LSM_setAncillary_cli(), LSM_setAttitude_cli(), LSM_setSsrOutOff_cli(), LSM_setSsrOutOn_cli(), and LSM_setTimetone_cli().

unsigned int LSM_getAncillary

(

void

)

To dump or not to dump.

Return values:

	0	Do not dump
	1	Dump

Referenced by LSM_SIANCILLARY().

unsigned int LSM_getAttitude

(

void

)

To dump or not to dump.

Return values:

	0	Do not dump
	1	Dump

Referenced by LSM_SIATTITUDE().

unsigned int LSM_getSsrOutOff

(

void

)

To dump or not to dump.

Return values:

	0	Do not dump
	1	Dump

Referenced by LSM_SSRoutputOff().

unsigned int LSM_getSsrOutOn

(

void

)

To dump or not to dump.

Return values:

	0	Do not dump
	1	Dump

Referenced by LSM_SSRoutputOn().

unsigned int LSM_getTimetone

(

void

)

To dump or not to dump.

Return values:

	0	Do not dump
	1	Dump

Referenced by LSM_SITIMETONE().

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

Callback function for the noop command.

Parameters:

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

Return values:

	ITC_VARRNG	ITC destination node invalid
	ITC_FORWARD	Command forwarded to another node
	LSM_SUCCESS	Success

References _LSM_NODETRANID::bf, _LSM_Noop_Prm::flag, _LSM_Noop_Pkt::pay, and _LSM_NODETRANID::us.

static unsigned int LSM_setAncillary_cli	(	CLI_Control *	cli,
		void *	prm
	)			[static]

CLI callback for "LSM_sendAttitude" command.

Parameters:

	cli	CLI control handle
	prm	User parameter (unused)

Returns:

CLI_SUCCESS

References LSM_setAncillary().

Referenced by LSM_addSyntaxLCP().

static unsigned int LSM_setAttitude_cli	(	CLI_Control *	cli,
		void *	prm
	)			[static]

CLI callback for "LSM_sendAttitude" command.

Parameters:

	cli	CLI control handle
	prm	User parameter (unused)

Returns:

CLI_SUCCESS

References LSM_setAttitude().

Referenced by LSM_addSyntaxLCP().

static unsigned int LSM_setSsrOutOff_cli	(	CLI_Control *	cli,
		void *	prm
	)			[static]

CLI callback for "LSM_sendSsrOutOff" command.

Parameters:

	cli	CLI control handle
	prm	User parameter (unused)

Returns:

CLI_SUCCESS

References LSM_setSsrOutOff().

Referenced by LSM_addSyntaxLCP().

static unsigned int LSM_setSsrOutOn_cli	(	CLI_Control *	cli,
		void *	prm
	)			[static]

CLI callback for "LSM_sendSsrOutOn" command.

Parameters:

	cli	CLI control handle
	prm	User parameter (unused)

Returns:

CLI_SUCCESS

References LSM_setSsrOutOn().

Referenced by LSM_addSyntaxLCP().

static unsigned int LSM_setTimetone_cli	(	CLI_Control *	cli,
		void *	prm
	)			[static]

CLI callback for "LSM_sendAttitude" command.

Parameters:

	cli	CLI control handle
	prm	User parameter (unused)

Returns:

CLI_SUCCESS

References LSM_setTimetone().

Referenced by LSM_addSyntaxLCP().

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

Processor for the SIANCILLARY telecommand.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Queue item payload pointer
	len	(in) Queue item payload length

Returns:

An LSM MSG code.

References ANC_FLAGS_IN_SAA, _LSM_Control::ancFlags, _LSM_Control::ancSync, _LSM_Control::cmd_hdr_size, _LSM_Ancillary_SsrTlm::flags, _LSM_SIANCILLARY_Prm::flags, LIM_APID_FOR_SAA_ENTER_EXIT, LSM_getAncillary(), LSM_getSsrOut(), LSM_ID_ANC, LSM_ID_ANC_VER, LSM_sendSsrOut(), _LSM_SIANCILLARY_Prm::mode, _LSM_Ancillary_SsrTlm::mode, _LSM_Ancillary_SsrTlm::pos, _LSM_SIANCILLARY_Prm::pos, _LSM_Ancillary_SsrTlm::sec, _LSM_SIANCILLARY_Prm::sec, _LSM_SIANCILLARY_Prm::ssr, _LSM_Ancillary_SsrTlm::ssr, _LSM_Control::ssrOutEnable, _LSM_Ancillary_SsrTlm::sub, _LSM_SIANCILLARY_Prm::sub, _LSM_Ancillary_SsrTlm::vel, and _LSM_SIANCILLARY_Prm::vel.

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

Processor for the SIATTITIDE telecommand.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Queue item payload pointer
	len	(in) Queue item payload length

Returns:

An LSM MSG code.

References _LSM_Control::att, _LSM_Attitude_SsrTlm::avel, _LSM_SIATTITUDE_Prm::avel, _LSM_Control::cmd_hdr_size, LSM_getAttitude(), LSM_getSsrOut(), LSM_ID_ATT, LSM_ID_ATT_VER, LSM_sendSsrOut(), _LSM_Attitude_SsrTlm::quat, _LSM_SIATTITUDE_Prm::quat, _LSM_Attitude_SsrTlm::sec, _LSM_SIATTITUDE_Prm::sec, _LSM_Control::ssrOutEnable, _LSM_Attitude_SsrTlm::sub, _LSM_SIATTITUDE_Prm::sub, and _LSM_Attitude_SsrTlm::unused.

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

Processor for the SITIMETONE telecommand.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Queue item payload pointer
	len	(in) Queue item payload length

Returns:

An LSM MSG code.

References _LSM_Timetone_SsrTlm::flags, _LSM_SITIMETONE_Prm::flags, LSM_getSsrOut(), LSM_getTimetone(), LSM_ID_TT, LSM_ID_TT_VER, LSM_sendSsrOut(), _LSM_SITIMETONE_Pkt::pay, _LSM_SITIMETONE_Prm::sec, _LSM_Control::ssrOutEnable, _LSM_Timetone_SsrTlm::timetone, and _LSM_Timetone_SsrTlm::unused.

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

Processor for the LSMSSROUTPUTOFF telecommand.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Queue item payload pointer
	len	(in) Queue item payload length

Returns:

An LSM MSG code.

References LSM_getSsrOutOff(), and _LSM_Control::ssrOutEnable.

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

Processor for the LSMSSROUTPUTON telecommand.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Queue item payload pointer
	len	(in) Queue item payload length

Returns:

An LSM MSG code.

References LSM_getSsrOutOn(), and _LSM_Control::ssrOutEnable.