---

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

Constituent: mem     Tag: sun-gcc

---

         

---

MEM_dump.h File Reference

Public interface to the Memory Dump functions. More...

#include "MEM/MEM.h"

Include dependency graph for MEM_dump.h:

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

Data Structures
struct	_MEM_DumpInfo
	Information about a Memory Dump context. More...
Typedefs
typedef void *	MEM_DumpHandle
	Handle for a Memory Dump context.
typedef _MEM_DumpInfo	MEM_DumpInfo
	Typedef for # _MEM_DumpInfo.
Functions
unsigned int	MEM_dumpInit (void)
	Start the Memory Dump system.
unsigned int	MEM_dumpGetContext (MEM_DumpHandle *handle_p)
	Allocate a Memory Dump context.
unsigned int	MEM_dumpReleaseContext (MEM_DumpHandle handle)
	Release a Memory Dump context.
unsigned int	MEM_dumpGetInfo (const MEM_DumpHandle handle, MEM_DumpInfo *info_p)
	Get detailed information about a Memory Dump context.
unsigned int	MEM_dumpStart (MEM_DumpHandle handle, const MEM_Descriptor *md_p)
unsigned int	MEM_dumpGetData (MEM_DumpHandle handle, size_t req_bytes, caddr_t *addr_p, size_t *act_bytes_p, void *dest_p)
	Read data for a Memory Dump operation.
unsigned int	MEM_CancelDump (MEM_DumpHandle handle)
	Cancel a Memory Dump operation.

---

Detailed Description

Public interface to the Memory Dump functions.

This is the public interface to the functions that handle Memory Dump telecommands and the resulting dump operations.

  CVS $Id: MEM_dump.h,v 1.4 2005/08/12 15:46:47 dmay Exp $
  

---

Typedef Documentation

MEM_DumpHandle

Handle for a Memory Dump context. Opaque handle for a Memory Dump context.

---

Function Documentation

unsigned int MEM_CancelDump (  MEM_DumpHandle  handle  )

Cancel a Memory Dump operation. Parameters: handle  Handle for dump context. Returns: A MEM MSG code.

unsigned int MEM_dumpGetContext (  MEM_DumpHandle *  handle_p  )

Allocate a Memory Dump context. Allocate a Memory Dump context. This is analogous to a constructor for a context. This function returns only a handle to a context. The details of the context are hidden from the user. The MEM_dumpGetInfo() function can be used to get detailed information about the context. Parameters: handle_p  Pointer to location to return context handle. Returns: A MEM MSG code.

unsigned int MEM_dumpGetData (  MEM_DumpHandle  handle, size_t  req_bytes, caddr_t *  addr_p, size_t *  act_bytes_p, void *  dest_p )

Read data for a Memory Dump operation. Read a chunk of data for the specified Memory Dump context. This function should be called repeatedly until all the data associated with the context has been dumped. It returns the address from which the dumped data was read and the actual number of bytes dumped (which may be less than the number of bytes requested). Parameters: handle  Handle for dump context. req_bytes  Amount of data to dump, in bytes. addr_p  Pointer to location to return address of dumped data. act_bytes_p  Pointer to location to return num bytes dumped. dest_p  Pointer to location to store dumped data. Returns: A MEM MSG code.

unsigned int MEM_dumpGetInfo (  const MEM_DumpHandle  handle, MEM_DumpInfo *  info_p )

Get detailed information about a Memory Dump context. Get information about a Memory Dump context. The information returned is a subset of the context details that are normally hidden from the user. Parameters: handle  Handle for context. info_p  Pointer to location to return context info. Returns: A MEM MSG code.

unsigned int MEM_dumpInit (  void   )

Start the Memory Dump system. Start the Memory Dump system. This function should be called once to initialize the internal state associated with the Memory Dump telecommand handler. Returns: A MEM MSG code.

unsigned int MEM_dumpReleaseContext (  MEM_DumpHandle  handle  )

Release a Memory Dump context. Release a Memory Dump context so that the memory associated to it can be re-allocated. This is analogous to a destructor for a context. Parameters: handle  Handle for context to release. Returns: A MEM MSG code.

unsigned int MEM_dumpStart (  MEM_DumpHandle  handle, const MEM_Descriptor *  md_p )

Start a Memory Dump operation. Updates the Memory Dump context to reflect the start of a dump operation. Parameters: handle  Handle for dump context. md_p  Pointer to dump memory descriptor. Returns: A MEM MSG code.

---