lim_util_tlm.h File Reference

Interface to the functions found in lim_util_tlm.c. More...

#include <ITC/ITC_pubdefs.h>
#include <LIM/LIM_pubdefs.h>
#include <lim_unit_test.h>

Classes
struct	_TLM_Data
	Incoming packet data. More...
Typedefs
typedef struct _TLM_Data	TLM_Data
	Typedef for _TLM_Data.
Functions
int	TLM_init (test_Test_Descriptor *td_p)
	Initialize the telemetry handler.
int	TLM_start (test_Test_Descriptor *td_p)
	Start the telemetry handler task.
int	TLM_stop (test_Test_Descriptor *td_p)
	Stop the telemetry handler task.
int	TLM_shutdown (test_Test_Descriptor *td_p)
	Shutdown the telemetry handler task.
int	TLM_tlm_rcvd (test_Test_Descriptor *td_p, int id)
	Check for received telemetry.
int	TLM_check_tlm (test_Test_Descriptor *td_p, int id, TLM_Data *exp_tlm_p)
	Compare actual and expected packet data.
int	TLM_check_no_tlm (test_Test_Descriptor *td_p)
	Verify that no packets were received.

---

Detailed Description

Interface to the functions found in lim_util_tlm.c.

**  CVS $Id: lim_util_tlm.h,v 1.8 2011/03/29 21:20:28 apw Exp $
**  

---

Function Documentation

unsigned int TLM_check_no_tlm

(

test_Test_Descriptor *

td_p

)

Verify that no packets were received.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References _TLM_Data::apid, _TLM_Control::cmd_data, _TLM_Control::cmd_head, _TLM_Control::cmd_tail, _TLM_Control::ctl_data, _TLM_Control::ctl_head, _TLM_Control::ctl_tail, _TLM_Control::ctl_x_data, _TLM_Control::ctl_x_head, _TLM_Control::ctl_x_tail, DIM, _TLM_Data::info, LIM_task_get_extra_ptr(), _TLM_Data::slew, test_Generic_Error(), test_Show_Info(), test_Show_Slew(), test_Status_Success(), and _test_Test_Descriptor::tlm_task_p.

Referenced by WRAP_check_telem().

int TLM_check_tlm	(	test_Test_Descriptor *	td_p,
		int	id,
		TLM_Data *	exp_tlm_p
	)

Compare actual and expected packet data.

Parameters:

	td_p	Pointer to test descriptor.
	id	ID to use for user messages.
	exp_tlm_p	Pointer to expected packet data.

Return values:

	0	Success.
	-1	Failure.

References _TLM_Data::apid, _TLM_Control::cmd_data, _TLM_Control::cmd_head, _TLM_Control::cmd_tail, _TLM_Control::ctl_data, _TLM_Control::ctl_head, _TLM_Control::ctl_tail, _TLM_Control::ctl_x_data, _TLM_Control::ctl_x_head, _TLM_Control::ctl_x_tail, DIM, _TLM_Data::fc, _LIM_Load_Shed_Alert_Tlm::hdr, _LIM_Repoint_Response_Tlm::hdr, _LIM_Repoint_Request_Tlm::hdr, _LIM_SC_Slew_Request_Pkt::hdr, _LIM_State_Tlm::hdr, _TLM_Data::info, LIM_task_get_extra_ptr(), _TLM_Data::pay_len, _TLM_Data::pkt_len, _TLM_Data::queue, _TLM_Data::slew, test_Generic_Error(), test_Info_Compare(), test_Pop_State(), test_Push_State(), test_Slew_Compare(), test_Status_Success(), test_Value32_Compare(), and _test_Test_Descriptor::tlm_task_p.

Referenced by WRAP_check_telem().

int TLM_init

(

test_Test_Descriptor *

td_p

)

Initialize the telemetry handler.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References _TLM_Control::cmd_head, _TLM_Control::cmd_tail, _TLM_Control::ctl_head, _TLM_Control::ctl_tail, _TLM_Control::ctl_x_head, _TLM_Control::ctl_x_tail, LIM_pool_alloc(), LIM_pool_init(), LIM_task_add_queue(), LIM_task_get_extra_ptr(), LIM_task_init_begin(), LIM_task_init_end(), test_Pop_State(), test_Push_State(), test_Status_Success(), tlm_dispatch_cmd(), tlm_dispatch_ctl(), tlm_dispatch_ctl_x(), _test_Test_Descriptor::tlm_pool_p, and _test_Test_Descriptor::tlm_task_p.

Referenced by lim_test_arr(), lim_test_cal(), lim_test_command(), lim_test_control(), lim_test_diag(), lim_test_gbm(), lim_test_init(), lim_test_load_shed(), lim_test_mode(), lim_test_physics(), lim_test_pids(), lim_test_pig(), lim_test_saa(), lim_test_shutdown(), lim_test_too(), and lim_test_use_cases().

int TLM_shutdown

(

test_Test_Descriptor *

td_p

)

Shutdown the telemetry handler task.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References LIM_pool_alloc(), LIM_pool_shutdown(), LIM_task_remove_queue(), LIM_task_shutdown_begin(), LIM_task_shutdown_end(), test_Pop_State(), test_Push_State(), test_Status_Success(), _test_Test_Descriptor::tlm_pool_p, and _test_Test_Descriptor::tlm_task_p.

Referenced by lim_test_arr(), lim_test_cal(), lim_test_command(), lim_test_control(), lim_test_diag(), lim_test_gbm(), lim_test_init(), lim_test_load_shed(), lim_test_mode(), lim_test_physics(), lim_test_pids(), lim_test_pig(), lim_test_saa(), lim_test_shutdown(), lim_test_too(), and lim_test_use_cases().

int TLM_start

(

test_Test_Descriptor *

td_p

)

Start the telemetry handler task.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References LIM_task_start(), test_Pop_State(), test_Push_State(), test_Status_Success(), and _test_Test_Descriptor::tlm_task_p.

Referenced by lim_test_arr(), lim_test_cal(), lim_test_command(), lim_test_control(), lim_test_diag(), lim_test_gbm(), lim_test_init(), lim_test_load_shed(), lim_test_mode(), lim_test_physics(), lim_test_pids(), lim_test_pig(), lim_test_saa(), lim_test_shutdown(), lim_test_too(), and lim_test_use_cases().

int TLM_stop

(

test_Test_Descriptor *

td_p

)

Stop the telemetry handler task.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References LIM_task_stop(), test_Delay(), test_Pop_State(), test_Push_State(), test_Status_Success(), and _test_Test_Descriptor::tlm_task_p.

Referenced by lim_test_arr(), lim_test_cal(), lim_test_command(), lim_test_control(), lim_test_diag(), lim_test_gbm(), lim_test_init(), lim_test_load_shed(), lim_test_mode(), lim_test_physics(), lim_test_pids(), lim_test_pig(), lim_test_saa(), lim_test_shutdown(), lim_test_too(), and lim_test_use_cases().

int TLM_tlm_rcvd	(	test_Test_Descriptor *	td_p,
		int	id
	)

Check for received telemetry.

Parameters:

	td_p	Pointer to test descriptor.
	id	ID to use for user messages.

Returns:

Nonzero value if any telemetry packets have been received.

References LIM_task_get_extra_ptr(), test_Pop_State(), test_Push_State(), test_Status_Success(), and _test_Test_Descriptor::tlm_task_p.

Referenced by WRAP_check_telem().