LIM_send.h File Reference

Interface to the LIM_send.c functions. More...

#include <CLI/CLI_pubdefs.h>

Functions
unsigned int	LIM_sendBiasAcdHv (unsigned int arc_id, unsigned int bias)
	Send the Bias-ACD command to set an ARC's HV bias.
unsigned int	LIM_sendBiasAcdSaa (unsigned int arc_id, unsigned int bias)
	Send the Bias-ACD command to set an ARC's SAA bias.
unsigned int	LIM_sendBiasCal (unsigned int tower_id, unsigned int bias)
	Send the Bias-CAL command.
unsigned int	LIM_sendBiasTkr (unsigned int tower_id, unsigned int bias)
	Send the Bias-TKR command.
unsigned int	LIM_sendCalStart (unsigned int latc_config, unsigned int lci_config, unsigned int dest)
	Send the Calibration-Start command.
unsigned int	LIM_sendConfigGbm (int rep_allowed, int pri_int_allowed, int red_int_allowed)
	Send the Configure-GBM command.
unsigned int	LIM_sendConfigHv (int hv_allowed)
	Send the Configure-HV command.
unsigned int	LIM_sendConfigPid (int primary)
	Send the Configure-PID command.
unsigned int	LIM_sendEpuOff (unsigned int epu_id)
	Send the Power-Off command to disable power from an EPU.
unsigned int	LIM_sendEpuOn (unsigned int epu_id, unsigned int pdu_id)
	Send the Power-On command to enable power to an EPU.
unsigned int	LIM_sendHoldEnter (void)
	Send the Hold-Enter command.
unsigned int	LIM_sendHoldExit (void)
	Send the Hold-Exit command.
unsigned int	LIM_sendLatcRecord (unsigned int dest)
	Send the Latc-Record command.
unsigned int	LIM_sendLoadShed (void)
	Send the Load-Shed command.
unsigned int	LIM_sendMainFeedOnPrimary (unsigned int siu_id, unsigned int pdu, unsigned int pps)
	Send the Main-Feed-On command to enable primary component power.
unsigned int	LIM_sendPigRecord (unsigned int dest)
	Send the Pig-Record command.
unsigned int	LIM_sendSaaEnter (void)
	Send the SAA-Enter command.
unsigned int	LIM_sendSaaExit (void)
	Send the SAA-Exit command.
unsigned int	LIM_sendSafeMode (void)
	Send the Safe-Mode command.
unsigned int	LIM_sendTemOn (unsigned int tem_id, unsigned int pdu_id)
	Send the Power-On command to enable power to a TEM.
int	LIM_setDisplayLevelCmd (int level)
	Set the verbosity level of the LIM command display.
unsigned int	LIM_addSyntaxSCP (CLI_Syntax *syntax)
	Add LIM commands to the command-line syntax.

---

Detailed Description

Interface to the LIM_send.c functions.

**    CVS $Id: LIM_send.h,v 1.10 2011/03/29 21:20:27 apw Exp $
**    

Defines the interface to the functions found in LIM_send.c.

---

Function Documentation

unsigned int LIM_addSyntaxSCP

(

CLI_Syntax *

syntax

)

Add LIM commands to the command-line syntax.

Parameters:

syntax

Syntax handle.

Returns:

MSG code.

References LIM_sendBiasAcdHv_cli(), LIM_sendBiasAcdSaa_cli(), LIM_sendBiasCal_cli(), LIM_sendBiasTkr_cli(), LIM_sendCalStart_cli(), LIM_sendConfigPid_cli(), LIM_sendEpuOff_cli(), LIM_sendEpuOn_cli(), LIM_sendHoldEnter_cli(), LIM_sendHoldExit_cli(), LIM_sendLoadShed_cli(), LIM_sendMainFeedOnPrimary_cli(), LIM_sendSaaEnter_cli(), LIM_sendSaaExit_cli(), LIM_sendSafeMode_cli(), LIM_sendTemOn_cli(), and LIM_setDisplayLevelCmd_cli().

unsigned int LIM_sendBiasAcdHv	(	unsigned int	arc_id,
		unsigned int	bias
	)

Send the Bias-ACD command to set an ARC's HV bias.

Parameters:

	arc_id	ID of the ARC (0 - 11).
	bias	Bias voltage value (0 - 0xfff).

Return values:

	0	Success.
	Nonzero	Failure.

References lim_sendBiasAcd().

Referenced by LIM_sendBiasAcdHv_cli().

unsigned int LIM_sendBiasAcdSaa	(	unsigned int	arc_id,
		unsigned int	bias
	)

Send the Bias-ACD command to set an ARC's SAA bias.

Parameters:

	arc_id	ID of the ARC (0 - 11).
	bias	Bias voltage value (0 - 0xfff).

Return values:

	0	Success.
	Nonzero	Failure.

References lim_sendBiasAcd().

Referenced by LIM_sendBiasAcdSaa_cli().

unsigned int LIM_sendBiasCal	(	unsigned int	tower_id,
		unsigned int	bias
	)

Send the Bias-CAL command.

Parameters:

	tower_id	ID of the tower (0 - 15).
	bias	Bias voltage value (0 - 0xffff).

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpBiasCal(), and lim_send_command().

Referenced by LIM_sendBiasCal_cli().

unsigned int LIM_sendBiasTkr	(	unsigned int	tower_id,
		unsigned int	bias
	)

Send the Bias-TKR command.

Parameters:

	tower_id	ID of the tower (0 - 15).
	bias	Bias voltage value (0 - 0xffff).

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpBiasTkr(), and lim_send_command().

Referenced by LIM_sendBiasTkr_cli().

unsigned int LIM_sendCalStart	(	unsigned int	latc_config,
		unsigned int	lci_config,
		unsigned int	dest
	)

Send the Calibration-Start command.

Parameters:

	latc_config	LATC configuration.
	lci_config	LCI configuration.
	dest	Destination.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpCalStart(), and lim_send_command().

Referenced by LIM_sendCalStart_cli().

unsigned int LIM_sendConfigGbm	(	int	rep_allowed,
		int	pri_int_allowed,
		int	red_int_allowed
	)

Send the Configure-GBM command.

Parameters:

	rep_allowed	Flag to allow repoint requests.
	pri_int_allowed	Flag to allow primary GBM interrupts.
	red_int_allowed	Flag to allow redundant GBM interrupts.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpConfigGbm(), and lim_send_command().

unsigned int LIM_sendConfigHv

(

int

hv_allowed

)

Send the Configure-HV command.

Parameters:

hv_allowed

Flag to allow high-voltage enabling.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpConfigHv(), and lim_send_command().

unsigned int LIM_sendConfigPid

(

int

primary

)

Send the Configure-PID command.

Parameters:

primary

Flag to select primary PID input signals.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpConfigPid(), and lim_send_command().

Referenced by LIM_sendConfigPid_cli().

unsigned int LIM_sendEpuOff

(

unsigned int

epu_id

)

Send the Power-Off command to disable power from an EPU.

Parameters:

epu_id

ID of the EPU (0 - 2).

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpPowerOff(), and lim_send_command().

Referenced by LIM_sendEpuOff_cli().

unsigned int LIM_sendEpuOn	(	unsigned int	epu_id,
		unsigned int	pdu_id
	)

Send the Power-On command to enable power to an EPU.

Parameters:

	epu_id	ID of the EPU (0 - 2).
	pdu_id	ID of the PDU to use (0 or 1).

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpPowerOn(), and lim_send_command().

Referenced by LIM_sendEpuOn_cli().

unsigned int LIM_sendHoldEnter

(

void

)

Send the Hold-Enter command.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpHoldEnter(), and lim_send_command().

Referenced by LIM_sendHoldEnter_cli().

unsigned int LIM_sendHoldExit

(

void

)

Send the Hold-Exit command.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpHoldExit(), and lim_send_command().

Referenced by LIM_sendHoldExit_cli().

unsigned int LIM_sendLatcRecord

(

unsigned int

dest

)

Send the Latc-Record command.

Parameters:

dest

Destination parameter value.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpLatcRecord(), and lim_send_command().

unsigned int LIM_sendLoadShed

(

void

)

Send the Load-Shed command.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpLoadShed(), and lim_send_command().

Referenced by LIM_sendLoadShed_cli().

unsigned int LIM_sendMainFeedOnPrimary	(	unsigned int	siu_id,
		unsigned int	pdu,
		unsigned int	pps
	)

Send the Main-Feed-On command to enable primary component power.

This command sends the Main-Feed-On command to enable power using the primary main feed and primary DAB. It also selects the primary paths to the SSR and GBM.

Parameters:

	siu_id	ID of the SIU (0 - 2).
	pdu	Bitmask of PDUs to power (0 = none, 1 = PDU-0, 2 = PDU-1, 3 = both).
	pps	Bitmask of PPS source (0 = primary external, 1 = internal, 2 = redundant external, 3 = internal)

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpMainFeedOn(), and lim_send_command().

Referenced by LIM_sendMainFeedOnPrimary_cli().

unsigned int LIM_sendPigRecord

(

unsigned int

dest

)

Send the Pig-Record command.

Parameters:

dest

Destination parameter value.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpPigRecord(), and lim_send_command().

unsigned int LIM_sendSaaEnter

(

void

)

Send the SAA-Enter command.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpSaaEnter(), and lim_send_command().

Referenced by LIM_sendSaaEnter_cli().

unsigned int LIM_sendSaaExit

(

void

)

Send the SAA-Exit command.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpSaaExit(), and lim_send_command().

Referenced by LIM_sendSaaExit_cli().

unsigned int LIM_sendSafeMode

(

void

)

Send the Safe-Mode command.

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpSafeMode(), and lim_send_command().

Referenced by LIM_sendSafeMode_cli().

unsigned int LIM_sendTemOn	(	unsigned int	tem_id,
		unsigned int	pdu_id
	)

Send the Power-On command to enable power to a TEM.

Parameters:

	tem_id	ID of the TEM (0 - 15).
	pdu_id	ID of the PDU to use (0 or 1).

Return values:

	0	Success.
	Nonzero	Failure.

References LIM_dumpPowerOn(), and lim_send_command().

Referenced by LIM_sendTemOn_cli().

int LIM_setDisplayLevelCmd

(

int

level

)

Set the verbosity level of the LIM command display.

Parameters:

level

Level of verbosity - set higher to display more.

Returns:

Previous verbosity level.

References LIM_displayLevelCmd.

Referenced by LIM_setDisplayLevelCmd_cli().