mem_util_tlm.h File Reference

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

#include <MEM/MEM_tlmdefs.h>
#include <mem_unit_test.h>

Classes
struct	_TLM_Data
	Incoming telemetry 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 task.
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 mem_util_tlm.c.

**  CVS $Id: mem_util_tlm.h,v 1.3 2011/03/29 01:58:52 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_Data::data, DIM, test_Generic_Error(), test_NULL_Compare(), test_Show_Tlm(), and _test_Test_Descriptor::tlm_ctl_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_Data::data, DIM, _MEM_LMEMSIUDATA_Tlm::hdr, _TLM_Data::pay_len, _TLM_Data::pkt_len, test_DumpTlm_Compare(), test_Generic_Error(), test_NULL_Compare(), test_Pop_State(), test_Push_State(), test_Value32_Compare(), _test_Test_Descriptor::tlm_ctl_p, and TLM_tlm_rcvd().

Referenced by WRAP_check_telem().

int TLM_init

(

test_Test_Descriptor *

td_p

)

Initialize the telemetry handler task.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References TASK_add_queue(), TASK_init(), test_NULL_Compare(), test_Pop_State(), test_Push_State(), test_Status_Success(), _test_Test_Descriptor::tlm_ctl_p, and tlm_dispatch().

Referenced by mem_unit_test_func().

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 TASK_remove_queue(), TASK_shutdown(), test_NULL_Compare(), test_Pop_State(), test_Push_State(), test_Status_Success(), and _test_Test_Descriptor::tlm_ctl_p.

Referenced by mem_unit_test_func().

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 TASK_start(), test_NULL_Compare(), test_Pop_State(), test_Push_State(), and _test_Test_Descriptor::tlm_ctl_p.

Referenced by mem_unit_test_func().

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 TASK_stop(), test_NULL_Compare(), test_Pop_State(), test_Push_State(), and _test_Test_Descriptor::tlm_ctl_p.

Referenced by mem_unit_test_func().

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 test_NULL_Compare(), test_Pop_State(), test_Push_State(), and _test_Test_Descriptor::tlm_ctl_p.

Referenced by TLM_check_tlm(), and WRAP_check_telem().