LIM_lci.c File Reference

Handle LIM interactions with the LCI task. More...

#include <string.h>
#include <ITC/ITC_pubdefs.h>
#include <LCI/LCI_cmddefs.h>
#include <LIM/LIM_msgs.h>
#include <LIM/LIM_pubdefs.h>
#include <LIM_action.h>
#include <LIM_lci.h>
#include <LIM_other_task.h>
#include <LIM_pkt_send.h>
#include <LIM_task.h>

Functions
unsigned int	LIM_lci_new (LIM_Lci **object_pp, LIM_Task *task_p, LIM_Action *action_p, LIM_Pkt_Send *pkt_start_p, LIM_Pkt_Send *pkt_abort_p)
	Create and initialize a new LCI interface object.
unsigned int	LIM_lci_delete (LIM_Lci *object_p)
	Shutdown and delete an LCI interface object.
LIM_Other_State	LIM_lci_get_state (LIM_Lci *object_p)
	Return the current state of the LCI task.
int	LIM_lci_abort_fcode (void)
	Return the function code of the Cal-Abort command.
int	LIM_lci_start_fcode (void)
	Return the function code of the Cal-Start command.
unsigned int	LIM_lci_fwd_abort (LIM_Lci *object_p, LIM_Pkt_Send *pkt_send_p, const ITC_QueueItem *qitem_p)
	Forward an Abort command to the LCI task.
unsigned int	LIM_lci_fwd_other (LIM_Lci *object_p, LIM_Pkt_Send *pkt_send_p, const ITC_QueueItem *qitem_p)
	Forward an 'other' command to the LCI task.
unsigned int	LIM_lci_handle_bulk (LIM_Lci *object_p, const ITC_QueueItem *qitem_p)
	Handle a message on the BULK queue.
unsigned int	LIM_lci_handle_complete (LIM_Lci *object_p, const ITC_QueueItem *qitem_p)
	Handle a Complete message from the LCI task.
unsigned int	LIM_lci_send_abort (LIM_Lci *object_p)
	Send an Abort command to the LCI task.
unsigned int	LIM_lci_send_start (LIM_Lci *object_p, const unsigned char *pkt_p, unsigned int pkt_bytes)
	Send a Start command to the LCI task.

---

Detailed Description

Handle LIM interactions with the LCI task.

**  CVS $Id: LIM_lci.c,v 1.9 2011/03/29 21:20:28 apw Exp $
**  

These are functions related to the interface with the LCI task.

---

Function Documentation

int LIM_lci_abort_fcode

(

void

)

Return the function code of the Cal-Abort command.

Returns:

Cal-Abort command function code.

Referenced by LIM_capture_cal_with_db().

unsigned int LIM_lci_delete

(

LIM_Lci *

object_p

)

Shutdown and delete an LCI interface object.

Parameters:

object_p

Pointer to object.

Returns:

MSG code.

References LIM_other_delete().

Referenced by LIM_mode_delete().

unsigned int LIM_lci_fwd_abort	(	LIM_Lci *	object_p,
		LIM_Pkt_Send *	pkt_send_p,
		const ITC_QueueItem *	qitem_p
	)

Forward an Abort command to the LCI task.

Parameters:

	object_p	Pointer to LCI interface object.
	pkt_send_p	Pointer to packet sending object for the command.
	qitem_p	Pointer to queue item containing the command.

Returns:

MSG code.

References LIM_other_fwd_stop().

Referenced by lim_mode_cal_abort().

unsigned int LIM_lci_fwd_other	(	LIM_Lci *	object_p,
		LIM_Pkt_Send *	pkt_send_p,
		const ITC_QueueItem *	qitem_p
	)

Forward an 'other' command to the LCI task.

Parameters:

	object_p	Pointer to LCI interface object.
	pkt_send_p	Pointer to packet sending object for the command.
	qitem_p	Pointer to queue item containing the command.

Returns:

MSG code.

References LIM_ACTION_CAL_OTHER, and LIM_other_fwd_active().

Referenced by lim_mode_cal_active().

LIM_Other_State LIM_lci_get_state

(

LIM_Lci *

object_p

)

Return the current state of the LCI task.

Parameters:

object_p

Pointer to LCI interface object.

Returns:

Current state of the LCI task.

References LIM_other_get_state().

Referenced by LIM_mode_get_info(), lim_mode_handle_cal(), lim_mode_stop_activity(), and lim_mode_target_mode().

unsigned int LIM_lci_handle_bulk	(	LIM_Lci *	object_p,
		const ITC_QueueItem *	qitem_p
	)

Handle a message on the BULK queue.

Parameters:

	object_p	Pointer to LCI interface object.
	qitem_p	Pointer to queue item containing the message.

Returns:

MSG code.

References LIM_other_handle_bulk().

Referenced by lim_mode_bulk().

unsigned int LIM_lci_handle_complete	(	LIM_Lci *	object_p,
		const ITC_QueueItem *	qitem_p
	)

Handle a Complete message from the LCI task.

Parameters:

	object_p	Pointer to LCI interface object.
	qitem_p	Pointer to queue item containing the message.

Returns:

MSG code.

References LIM_other_handle_complete().

Referenced by lim_mode_cal_complete().

unsigned int LIM_lci_new	(	LIM_Lci **	object_pp,
		LIM_Task *	task_p,
		LIM_Action *	action_p,
		LIM_Pkt_Send *	pkt_start_p,
		LIM_Pkt_Send *	pkt_abort_p
	)

Create and initialize a new LCI interface object.

Parameters:

	object_pp	Location to return pointer to new object.
	task_p	Pointer to a task object.
	action_p	Pointer to an action reporting object.
	pkt_start_p	Pointer to Start command packet sending object.
	pkt_abort_p	Pointer to Abort command packet sending object.

Returns:

MSG code.

References LIM_ACTION_CAL_ABORT, LIM_ACTION_CAL_ABORT_STATUS, LIM_ACTION_CAL_START, LIM_ACTION_CAL_START_STATUS, LIM_ACTION_LCI_STATE_CHANGE, LIM_ACTION_UNKNOWN, and LIM_other_new().

Referenced by LIM_mode_new().

unsigned int LIM_lci_send_abort

(

LIM_Lci *

object_p

)

Send an Abort command to the LCI task.

Parameters:

object_p

Pointer to LCI interface object.

Returns:

MSG code.

References LIM_other_send_stop().

Referenced by lim_mode_stop_activity().

unsigned int LIM_lci_send_start	(	LIM_Lci *	object_p,
		const unsigned char *	pkt_p,
		unsigned int	pkt_bytes
	)

Send a Start command to the LCI task.

Parameters:

	object_p	Pointer to LCI interface object.
	pkt_p	Pointer to Start command packet.
	pkt_bytes	Size, in bytes, of Start command packet.

Returns:

MSG code.

References LIM_other_send_start().

Referenced by lim_mode_cal_start().

int LIM_lci_start_fcode

(

void

)

Return the function code of the Cal-Start command.

Returns:

Cal-Start command function code.

Referenced by LIM_capture_cal_with_db().