LIH_command.c File Reference

LIH command functions. More...

#include <CDM/CDM_pubdefs.h>
#include <FBS/FBS_pubrtos.h>
#include <ITC/ITC_pubdefs.h>
#include <LIH/LIH_cmddefs.h>
#include <LIH/LIH_msgs.h>
#include <PBI/Endianness.h>
#include <LIH_prvdefs.h>

Functions
unsigned int	LIH_DumpLimits (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "enable/disable actions on an ADC" command.
unsigned int	LIH_DumpLimitsAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "enable/disable actions on an ADC" command.
unsigned int	LIH_EnableActions (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "enable/disable actions on an ADC" command.
unsigned int	LIH_LoadLimits (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function to "load a new limits file" command.
unsigned int	LIH_Noop (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "Noop" command.
unsigned int	LIH_SetActionsAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set new actions for an ADC" command.
unsigned int	LIH_SetLimitsAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set new limits for an ADC" command.
unsigned int	LIH_SetNagTimesAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set new limits for an ADC" command.
unsigned int	LIH_SetPersistAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set persistence for an ADC" command.
unsigned int	LIH_SetSettleAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set persistence for an ADC" command.

---

Detailed Description

LIH command functions.

CVS $Id: LIH_command.c,v 1.4 2011/03/29 22:38:00 apw Exp $

Author:

A.P.Waite

---

Function Documentation

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

Callback function for the "enable/disable actions on an ADC" command.

Parameters:

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

Returns:

Return value from LIH_limitSendAll()

References _LIH_DumpLimits_Prm::ident, LIH_K_SRC_COMMAND, LIH_limitSendAll(), _LIH_DumpLimits_Pkt::pay, and _LIH_DumpLimits_Prm::reason.

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

Callback function for the "enable/disable actions on an ADC" command.

Parameters:

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

Returns:

Return value from LIH_limitSendAdc()

References _LIH_DumpLimitsAdc_Prm::adx, LIH_limitSendAdc(), and _LIH_DumpLimitsAdc_Pkt::pay.

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

Callback function for the "enable/disable actions on an ADC" command.

Parameters:

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

Returns:

Return value from LIH_limitAble()

References LIH_limitAble(), _LIH_EnableActions_Pkt::pay, and _LIH_EnableActions_Prm::state.

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

Callback function to "load a new limits file" command.

Parameters:

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

Returns:

References _LIH_LoadLimits_Prm::fileID, LIH_hcb, LIH_limitCheckCDM(), LIH_limitExternalDefault(), LIH_limitExternalTable(), and _LIH_LoadLimits_Pkt::pay.

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

LIH_SUCCESS

Success

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

Callback function for the "set new actions for an ADC" command.

Parameters:

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

Returns:

Return code from LIH_limitAction()

References _LIH_SetActionsAdc_Prm::adx, _LIH_SetActionsAdc_Prm::alert, _LIH_SetActionsAdc_Prm::diag, _LIH_SetActionsAdc_Prm::from, LIH_limitAction(), LIH_limitSendAdc(), _LIH_SetActionsAdc_Prm::msg, _LIH_SetActionsAdc_Pkt::pay, and _LIH_SetActionsAdc_Prm::to.

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

Callback function for the "set new limits for an ADC" command.

Parameters:

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

Returns:

Return code from LIH_limitLimit()

References _LIH_SetLimitsAdc_Prm::adx, LIH_limitLimit(), LIH_limitSendAdc(), _LIH_SetLimitsAdc_Prm::limit, and _LIH_SetLimitsAdc_Pkt::pay.

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

Callback function for the "set new limits for an ADC" command.

Parameters:

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

Returns:

Return code from LIH_limitNag()

References _LIH_SetNagTimesAdc_Prm::adx, LIH_limitNag(), LIH_limitSendAdc(), _LIH_SetNagTimesAdc_Prm::nag, and _LIH_SetNagTimesAdc_Pkt::pay.

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

Callback function for the "set persistence for an ADC" command.

Parameters:

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

Returns:

Return code from LIH_limitPersist()

References _LIH_SetPersistAdc_Prm::adx, LIH_limitPersist(), LIH_limitSendAdc(), _LIH_SetPersistAdc_Pkt::pay, and _LIH_SetPersistAdc_Prm::persist.

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

Callback function for the "set persistence for an ADC" command.

Parameters:

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

Returns:

Return code from LIH_limitSettle()

References _LIH_SetSettleAdc_Prm::adx, LIH_limitSendAdc(), LIH_limitSettle(), _LIH_SetSettleAdc_Pkt::pay, and _LIH_SetSettleAdc_Prm::settle.