---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > MEM / V5-7-1

Constituent: mem_unit_test     Tag: sun-gcc

---

         

---

mem_util_wrap.h File Reference

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

#include "ITC/ITC_pubdefs.h"
#include "MEM/MEM_pubdefs.h"
#include "mem_unit_test.h"
#include "mem_util_tlm.h"

Include dependency graph for mem_util_wrap.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	_WRAP_Info
	Wrapper control information. More...
Typedefs
typedef _WRAP_Info	WRAP_Info
	Typedef for _WRAP_Info.
Functions
int	WRAP_check_telem (test_Test_Descriptor *td_p, int id, WRAP_Info *info_p, unsigned int max_msecs)
	Verify expected telemetry.
int	WRAP_get_info (test_Test_Descriptor *td_p, int id, WRAP_Info *info_p)
	Call MEM_getInfo() and validate the results.
int	WRAP_init (test_Test_Descriptor *td_p, int id, WRAP_Info *info_p)
	Call MEM_init() and validate the results.
int	WRAP_initialize (test_Test_Descriptor *td_p, int id, WRAP_Info *info_p)
	Call MEM_initialize() and validate the results.
void	WRAP_init_info (WRAP_Info *info_p)
	Init a wrap info structure.
int	WRAP_read_surom (test_Test_Descriptor *td_p, int id, WRAP_Info *info_p)
	Call MEM_readSurom() and validate the results.
int	WRAP_shutdown (test_Test_Descriptor *td_p, int id, WRAP_Info *info_p)
	Call MEM_shutdown() and validate the results.
void	WRAP_exp_dump_data (WRAP_Info *info_p, unsigned int start_word, unsigned int num_words, unsigned int data_start, unsigned int data_delta)
	Expect memory dump data.
void	WRAP_exp_dump_tlm (WRAP_Info *info_p, unsigned int exp_lat_unit, unsigned int exp_tran_id, unsigned int exp_address, unsigned int exp_num_words, unsigned int exp_cmd_fcode)
	Expect memory dump telemetry.

---

Detailed Description

Interface to the functions found in mem_util_wrap.c.

**  CVS $Id: mem_util_wrap.h,v 1.3 2006/05/10 19:40:13 dmay Exp $
**  

---

Function Documentation

int WRAP_check_telem (  test_Test_Descriptor *  td_p, int  id, WRAP_Info *  info_p, unsigned int  max_msecs )

Verify expected telemetry. Parameters: td_p  Pointer to test descriptor. id  ID to use for user messages. info_p  Pointer to wrap control info. max_msecs  Max time to wait for telemetry, in milliseconds. Return values: 0  Success. -1  Failure.

void WRAP_exp_dump_data (  WRAP_Info *  info_p, unsigned int  start_word, unsigned int  num_words, unsigned int  data_start, unsigned int  data_delta )

Expect memory dump data. Parameters: info_p  Pointer to wrap control info. start_word  First word to expect. num_words  Number of words to expect. data_start  Starting expected data value. data_delta  Expected data stride. Returns: Nothing.

void WRAP_exp_dump_tlm (  WRAP_Info *  info_p, unsigned int  exp_lat_unit, unsigned int  exp_tran_id, unsigned int  exp_address, unsigned int  exp_num_words, unsigned int  exp_cmd_fcode )

Expect memory dump telemetry. Parameters: info_p  Pointer to wrap control info. exp_lat_unit  Expected LAT unit value. exp_tran_id  Expected transaction ID value. exp_address  Expected address value. exp_num_words  Expected word count value. exp_cmd_fcode  Expected command fcode value. Returns: Nothing.

int WRAP_get_info (  test_Test_Descriptor *  td_p, int  id, WRAP_Info *  info_p )

Call MEM_getInfo() and validate the results. Parameters: td_p  Pointer to test descriptor. id  ID to use for user messages. info_p  Pointer to wrap control info. Return values: 0  Success. -1  Failure.

int WRAP_init (  test_Test_Descriptor *  td_p, int  id, WRAP_Info *  info_p )

Call MEM_init() and validate the results. Parameters: td_p  Pointer to test descriptor. id  ID to use for user messages. info_p  Pointer to wrap control info. Return values: 0  Success. -1  Failure.

int WRAP_init_info (  WRAP_Info *  info_p  )

Init a wrap info structure. Parameters: info_p  Pointer to wrap info. Returns: Nothing.

int WRAP_initialize (  test_Test_Descriptor *  td_p, int  id, WRAP_Info *  info_p )

Call MEM_initialize() and validate the results. Parameters: td_p  Pointer to test descriptor. id  ID to use for user messages. info_p  Pointer to wrap control info. Return values: 0  Success. -1  Failure.

int WRAP_read_surom (  test_Test_Descriptor *  td_p, int  id, WRAP_Info *  info_p )

Call MEM_readSurom() and validate the results. Parameters: td_p  Pointer to test descriptor. id  ID to use for user messages. info_p  Pointer to wrap control info. Return values: 0  Success. -1  Failure.

int WRAP_shutdown (  test_Test_Descriptor *  td_p, int  id, WRAP_Info *  info_p )

Call MEM_shutdown() and validate the results. Parameters: td_p  Pointer to test descriptor. id  ID to use for user messages. info_p  Pointer to wrap control info. Return values: 0  Success. -1  Failure.

---