mem_util_cmd.h File Reference

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

#include <ITC/ITC_pubdefs.h>
#include <mem_unit_test.h>
#include <mem_util_wrap.h>

Functions
int	CMD_init (test_Test_Descriptor *td_p)
	Initialize the command handler.
int	CMD_start (test_Test_Descriptor *td_p)
	Start the command handler task.
int	CMD_stop (test_Test_Descriptor *td_p)
	Stop the command handler task.
int	CMD_shutdown (test_Test_Descriptor *td_p)
	Shutdown the command handler.
int	CMD_send_dump_mem (test_Test_Descriptor *td_p, int id, WRAP_Info *info_p, unsigned int lat_unit, unsigned int tran_id, unsigned int address, unsigned int num_words, unsigned int short_bytes)
	Send the Dump-Memory command.
int	CMD_send_load_mem (test_Test_Descriptor *td_p, int index, WRAP_Info *info_p, unsigned int lat_unit, unsigned int tran_id, unsigned int address, unsigned int num_words, unsigned int data_start, unsigned int data_delta, unsigned int short_bytes)
	Send the Load-Memory command.

---

Detailed Description

Interface to the functions found in mem_util_cmd.c.

**  CVS $Id: mem_util_cmd.h,v 1.2 2011/03/29 01:58:52 apw Exp $
**  

---

Function Documentation

int CMD_init

(

test_Test_Descriptor *

td_p

)

Initialize the command handler.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References _test_Test_Descriptor::cmd_task_p, TASK_init(), test_Pop_State(), and test_Push_State().

Referenced by mem_RamAccess_test().

int CMD_send_dump_mem	(	test_Test_Descriptor *	td_p,
		int	id,
		WRAP_Info *	info_p,
		unsigned int	lat_unit,
		unsigned int	tran_id,
		unsigned int	address,
		unsigned int	num_words,
		unsigned int	short_bytes
	)

Send the Dump-Memory command.

Parameters:

	td_p	Pointer to test descriptor.
	id	ID to use for user messages.
	info_p	Pointer to wrap control info.
	lat_unit	LAT Unit parameter value.
	tran_id	Transaction ID parameter value.
	address	Address parameter value.
	num_words	Word Count parameter value.
	short_bytes	Number of bytes to remove from the command.

Return values:

	0	Success.
	-1	Failure.

References cmd_send(), DIM, _WRAP_Info::exp_cmd_sts_in, _WRAP_Info::exp_info, test_Pop_State(), and test_Push_State().

Referenced by mem_RamAccess_test().

int CMD_send_load_mem	(	test_Test_Descriptor *	td_p,
		int	id,
		WRAP_Info *	info_p,
		unsigned int	lat_unit,
		unsigned int	tran_id,
		unsigned int	address,
		unsigned int	num_words,
		unsigned int	data_start,
		unsigned int	data_delta,
		unsigned int	short_bytes
	)

Send the Load-Memory command.

Parameters:

	td_p	Pointer to test descriptor.
	id	ID to use for user messages.
	info_p	Pointer to wrap control info.
	lat_unit	LAT Unit parameter value.
	tran_id	Transaction ID parameter value.
	address	Address parameter value.
	num_words	Word Count parameter value.
	data_start	Value of first Data parameter.
	data_delta	Difference between adjacent Data parameter values.
	short_bytes	Number of bytes to remove from the command.

Return values:

	0	Success.
	-1	Failure.

References cmd_send(), DIM, _WRAP_Info::exp_cmd_sts_in, _WRAP_Info::exp_info, test_Pop_State(), and test_Push_State().

Referenced by mem_RamAccess_test().

unsigned int CMD_shutdown

(

test_Test_Descriptor *

td_p

)

Shutdown the command handler.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References _test_Test_Descriptor::cmd_task_p, TASK_shutdown(), test_Pop_State(), and test_Push_State().

Referenced by mem_RamAccess_test().

int CMD_start

(

test_Test_Descriptor *

td_p

)

Start the command handler task.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References _test_Test_Descriptor::cmd_task_p, TASK_start(), test_Pop_State(), and test_Push_State().

Referenced by mem_RamAccess_test().

int CMD_stop

(

test_Test_Descriptor *

td_p

)

Stop the command handler task.

Parameters:

td_p

Pointer to test descriptor.

Return values:

	0	Success.
	-1	Failure.

References _test_Test_Descriptor::cmd_task_p, TASK_stop(), test_Pop_State(), and test_Push_State().

Referenced by mem_RamAccess_test().