---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > MEM / V5-8-0

Constituent: mem     Tag: rad750

---

         

---

MEM_pubdefs.h File Reference

Public interface to the MEM package functions. More...

#include "ITC/ITC_pubdefs.h"

Include dependency graph for MEM_pubdefs.h:

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

Data Structures
struct	_MEM_Info
	Information about the state of the MEM system. More...
Typedefs
typedef _MEM_Info	MEM_Info
	Typedef for # _MEM_Info.
Functions
unsigned int	MEM_initialize (ITC_Task *task_p, ITC_TaskID tid)
	Initialize the MEM application-level functions.
unsigned int	MEM_init (void)
	Initialize the MEM application-level functions using CDM.
unsigned int	MEM_shutdown (void)
	Shutdown the MEM functions.
unsigned int	MEM_getInfo (MEM_Info *info_p)
	Get current state of the MEM application-level functions.
void *	MEM_readSurom (void *dst_p, const void *src_p, const unsigned int num_bytes)
	Read RAD750 SUROM.

---

Detailed Description

Public interface to the MEM package functions.

  CVS $Id: MEM_pubdefs.h,v 1.6 2005/11/08 20:26:12 dmay Exp $
  

---

Function Documentation

unsigned int MEM_getInfo (  MEM_Info *  info_p  )

Get current state of the MEM application-level functions. Parameters: info_p  Pointer to location to return state information. Returns: MSG code.

unsigned int MEM_init (  void   )

Initialize the MEM application-level functions using CDM. This function is a wrapper for MEM_initialize() that uses CDM to determine its parameters. Returns: Zero if successful. A MSG code if an error occurs.

unsigned int MEM_initialize (  ITC_Task *  task_p, ITC_TaskID  tid )

Initialize the MEM application-level functions. This function initializes the application-level portion of the MEM package and transitions it to the INITIALIZED state. It should be the first MEM function called when using the MEM package. At the application level, there is no MEM task. Instead, the handlers for the MEM telecommands are attached to another task. If a valid value is provided for either the task_p or the tid parameter, then this function will attach the MEM command handlers to the corresponding task. If neither parameter is specified (by setting task_p to NULL and tid to -1), then it is assumed that the controlling task will attach the MEM command handlers. Parameters: task_p  Pointer to controlling task's description block. tid  ID of the controlling task. Returns: Zero if successful. An error MSG code if the MEM package has already been initialized or an error occurs.

void* MEM_readSurom (  void *  dst_p, const void *  src_p, const unsigned int  num_bytes )

Read RAD750 SUROM. Parameters: dst_p  Pointer to destination of the memory read. src_p  Pointer to source of the memory read. num_bytes  Number of bytes to read. Returns: dest_p if no error occurred, NULL if an error occurred.

unsigned int MEM_shutdown (  void   )

Shutdown the MEM functions. This function shuts down the MEM package and transitions it back to the UNINITIALIZED state. It can be called only if the current MEM state is INITIALIZED, INIT_FAIL, or SHUTDOWN_FAIL. Returns: Zero if successful. An error MSG code if the MEM package is in an invalid state or an error occurs.

---