---

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

Constituent: mem     Tag: sun-gcc

---

         

---

MEM_load.h File Reference

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

#include "MEM/MEM.h"

Include dependency graph for MEM_load.h:

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

Data Structures
struct	_MEM_LoadInfo
	Information about a Memory Load context. More...
Typedefs
typedef void *	MEM_LoadHandle
	Handle for a Memory Load context.
typedef _MEM_LoadInfo	MEM_LoadInfo
	Typedef for # _MEM_LoadInfo.
Functions
unsigned int	MEM_loadInit (void)
	Start the Memory Load system.
unsigned int	MEM_loadGetContext (MEM_LoadHandle *handle_p)
	Allocate a Memory Load context.
unsigned int	MEM_loadReleaseContext (MEM_LoadHandle handle)
	Release a Memory Load context.
unsigned int	MEM_loadGetInfo (const MEM_LoadHandle handle, MEM_LoadInfo *info_p)
	Get detailed information about a Memory Load context.
unsigned int	MEM_loadPktMemory (MEM_LoadHandle handle, const void *pkt_p, const unsigned int len)
	Handle Memory Write telecommand packets.
unsigned int	MEM_loadPktPci (MEM_LoadHandle handle, const void *pkt_p, const unsigned int len)
	Handle Memory PCI Device Header Write telecommand packets.
unsigned int	MEM_loadPktReg (MEM_LoadHandle handle, const void *pkt_p, const unsigned int len)
	Handle Memory Processor Register Write telecommand packets.
unsigned int	MEM_loadWrite (MEM_LoadHandle handle)
	Write data for a Memory Load context.

---

Detailed Description

Public interface to the Memory Load functions.

This is the public interface to the functions that handle Memory Load telecommands and the resulting load operations.

  CVS $Id: MEM_load.h,v 1.5 2005/08/12 15:47:20 dmay Exp $
  

---

Typedef Documentation

MEM_LoadHandle

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

---

Function Documentation

unsigned int MEM_loadGetContext (  MEM_LoadHandle *  handle_p  )

Allocate a Memory Load context. Allocate a Memory Load 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_loadGetInfo() 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_loadGetInfo (  const MEM_LoadHandle  handle, MEM_LoadInfo *  info_p )

Get detailed information about a Memory Load context. Get information about a Memory Load 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_loadInit (  void   )

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

unsigned int MEM_loadPktMemory (  MEM_LoadHandle  handle, const void *  pkt_p, const unsigned int  len )

Handle Memory Write telecommand packets. Announces the arrival of a new Memory Write telecommand CCSDS packet. Parameters: handle  Handle for load context. pkt_p  Pointer to packet. len  Length of packet, in bytes. Returns: A MSG code.

unsigned int MEM_loadPktPci (  MEM_LoadHandle  handle, const void *  pkt_p, const unsigned int  len )

Handle Memory PCI Device Header Write telecommand packets. Announces the arrival of a new Memory PCI Device Header Write telecommand CCSDS packet. Parameters: handle  Handle for load context. pkt_p  Pointer to packet. len  Length of packet, in bytes. Returns: A MSG code.

unsigned int MEM_loadPktReg (  MEM_LoadHandle  handle, const void *  pkt_p, const unsigned int  len )

Handle Memory Processor Register Write telecommand packets. Announces the arrival of a new Memory Processor Register Write telecommand CCSDS packet. Parameters: handle  Handle for load context. pkt_p  Pointer to packet. len  Length of packet, in bytes. Returns: A MSG code.

unsigned int MEM_loadReleaseContext (  MEM_LoadHandle  handle  )

Release a Memory Load context. Release a Memory Load 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_loadWrite (  MEM_LoadHandle  handle  )

Write data for a Memory Load context. Write another chunk of data for the specified Memory Load context. This function should be called repeatedly until all the data associated with the context has been written to memory. The status of the Memory Load operation can be obtained with the MEM_loadGetInfo() function. Parameters: handle  Handle for context in which to write the data. Returns: A MEM MSG code.

---