LHK_command.c File Reference

Telecommand handlers for LHK. More...

#include <ITC/ITC_apidefs.h>
#include <ITC/ITC_pubdefs.h>
#include <LHK/LHK_cmddefs.h>
#include <LHK/LHK_cmdxtrn.h>
#include <LHK/LHK_msgs.h>
#include <MDB/MDB_pubdefs.h>
#include <LHK_prvdefs.h>

Functions
unsigned int	LHK_CancelDiag (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the CancelDiag command.
unsigned int	LHK_NewSchedFile (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the ReqDiagPacket command.
unsigned int	LHK_NewSchedInst (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the ReqDiagPacket command.
unsigned int	LHK_Noop (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the ReqDiagPacket command.
unsigned int	LHK_ReqDiagPacket (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the ReqDiagPacket command.
unsigned int	LHK_StopDiag (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the (deprecated) StopDiag command.
unsigned int	LHK_SysReset (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the ReqDiagPacket command.

---

Detailed Description

Telecommand handlers for LHK.

CVS $Id: LHK_command.c,v 1.5 2011/03/29 01:45:00 apw Exp $

Author:

A.P.Waite

LHK_command.c provides the command handling for commands to LHK.

---

Function Documentation

unsigned int LHK_CancelDiag	(	void *	prm,
		const ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the CancelDiag command.

Parameters:

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

Returns:

Warning:

This command is deprecated. Please migrate to the "CancelDiag" command which adds a parameter to specify which APID to cancel/stop.

References _LHK_CancelDiag_Prm::apid, LHK_diagnosticCancel(), and _LHK_CancelDiag_Pkt::pay.

unsigned int LHK_NewSchedFile	(	void *	prm,
		const ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the ReqDiagPacket command.

Parameters:

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

Returns:

References _LHK_NewSchedFile_Prm::file, LHK_scheduleReplaceByFile(), and _LHK_NewSchedFile_Pkt::pay.

unsigned int LHK_NewSchedInst	(	void *	prm,
		const ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the ReqDiagPacket command.

Parameters:

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

Returns:

References _LHK_NewSchedInst_Prm::instance, LHK_scheduleReplaceByInstance(), and _LHK_NewSchedInst_Pkt::pay.

unsigned int LHK_Noop	(	void *	prm,
		const ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the ReqDiagPacket command.

Parameters:

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

Returns:

unsigned int LHK_ReqDiagPacket	(	void *	prm,
		const ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the ReqDiagPacket command.

Parameters:

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

Returns:

References _LHK_ReqDiagPacket_Prm::apid, _LHK_ReqDiagPacket_Prm::count, _LHK_ReqDiagPacket_Prm::interval, LHK_diagnosticStart(), and _LHK_ReqDiagPacket_Pkt::pay.

unsigned int LHK_StopDiag	(	void *	prm,
		const ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the (deprecated) StopDiag command.

Parameters:

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

Returns:

Warning:

This command is deprecated. Please migrate to the "CancelDiag" command which adds a parameter to specify which APID to cancel/stop. This command assumes that only one diagnostic request (for one APID) can be serviced at a time. This is no longer true.

References _LHK_Control::aidx, LHK_diagnosticCancel(), and LHK_lcb.

unsigned int LHK_SysReset	(	void *	prm,
		const ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the ReqDiagPacket command.

Parameters:

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

Returns:

References _LHK_SysReset_Prm::file0, LHK_scheduleReplaceByFile(), LHK_scheduleReplaceByInstance(), and _LHK_SysReset_Pkt::pay.