LCM_cmd.c.ux-xxx-xxx File Reference

LCM command functions (host systems). More...

#include <string.h>
#include <CCSDS/CCSDS_pkt.h>
#include <CMX/CMX_asBuiltPub.h>
#include <ITC/ITC_msgs.h>
#include <ITC/ITC_pubdefs.h>
#include <LCM/LCM_cmddefs.h>
#include <LCM/LCM_cmdxtrn.h>
#include <LCM/LCM_msgs.h>
#include <LCM/LCM_tlmdefs.h>
#include <MSG/MSG_pubdefs.h>
#include <PBI/Endianness.h>
#include <PBI/TBD_id.h>
#include <PBS/MBA.h>
#include <PBS/RW.h>
#include <PBS/RW.ih>
#include <PBS/SEM.h>
#include <PBS/TBD.ih>
#include <PBS/WCT.h>
#include <LCM_prvdefs.h>

Functions
unsigned int	LCM_CmdResponse (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the CmdResponse command.
unsigned int	LCM_MsgResponse (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the MsgResponse command.
unsigned int	LCM_ImageDump (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the ImageDump command.
unsigned int	LCM_ModuleDump (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the ModuleDump command.
unsigned int	LCM_TaskDump (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the TaskDump command.
unsigned int	LCM_MsgOutCfg (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the MsgOutCfg command.
unsigned int	LCM_Stats (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the Stats command.
unsigned int	LCM_Noop (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the Noop command.

---

Detailed Description

LCM command functions (host systems).

CVS $Id: LCM_cmd.c.ux-xxx-xxx,v 1.2 2011/03/29 21:59:33 apw Exp $

Author:

D.Wood

A.P.Waite

---

Function Documentation

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

Callback function for the CmdResponse command.

Parameters:

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

Return values:

	ITC_SUCCESS	S Success
	ITC_TASKMISS	E No entry in task table for task
	ITC_TASKPTR	E Task pointer check failed
	ITC_VARRNG	E Out of range variable detected

References LCM_CmdResponse_common().

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

Callback function for the ImageDump command.

Parameters:

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

Returns:

LCM_ECMDIMPL Command not implemented

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

Callback function for the ModuleDump command.

Parameters:

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

Returns:

References _LCM_DUMPFLAGS::bf, _LCM_NODETRANID::bf, _LCM_LLCMMODLIST_Tlm::bssAddr, _LCM_LLCMMODLIST_Tlm::bssSize, _LCM_Control::cmd_hdr_size, _LCM_LLCMMODLIST_Tlm::constit, _LCM_LLCMMODLIST_Tlm::dataAddr, _LCM_LLCMMODLIST_Tlm::dataSize, _LCM_LLCMMODLIST_Tlm::dmpFlags, _LCM_LLCMMODLIST_Tlm::fileId, _LCM_ModuleDump_Prm::flag, _LCM_Control::image, _LCM_Control::itc_hdr_size, LCM_freeTelem(), LCM_LLCMMODLIST_TLM_APID, _LCM_LLCMMODLIST_Tlm::majVer, _LCM_LLCMMODLIST_Tlm::mid, _LCM_LLCMMODLIST_Tlm::minVer, _LCM_Control::node_id, _LCM_LLCMMODLIST_Tlm::package, _LCM_LLCMMODLIST_Tlm::patVer, _LCM_ImageControl::telem_buf, _LCM_Control::telem_hdr_size, _LCM_ImageControl::telem_pool, _LCM_ImageControl::telem_sem, _LCM_LLCMMODLIST_Tlm::textAddr, _LCM_LLCMMODLIST_Tlm::textSize, _LCM_DUMPFLAGS::us, and _LCM_NODETRANID::us.

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

Callback function for the MsgOutCfg command.

Parameters:

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

Returns:

Return value from LCM_MsgOutCfg_common()

References LCM_MsgOutCfg_common().

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

Callback function for the MsgResponse command.

Parameters:

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

Return values:

	ITC_SUCCESS	S Success
	ITC_TASKMISS	E No entry in task table for task
	ITC_TASKPTR	E Task pointer check failed
	ITC_VARRNG	E Out of range variable detected

References LCM_MsgResponse_common().

unsigned int LCM_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:

LCM_SUCCES

Success (always)

References LCM_Noop_common().

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

Callback function for the Stats command.

Parameters:

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

Returns:

Return value from LCM_Stats_common()

References LCM_Stats_common().

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

Callback function for the TaskDump command.

Parameters:

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

Returns:

LCM_ECMDIMPL Command not implemented