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

Constituent: mem_base     Tag: mv2304


Interface   Data Structures   File List   Data Fields   Globals  

mempriv.h File Reference

Private MEM package definitions. More...

#include "MEM/MEM_map.h"
#include "MSG/MSG_pubdefs.h"

Include dependency graph for mempriv.h:

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


Data Structures

struct  _mem_mapEntry
 Memory map entry. More...

Defines

#define TRUE   (1)
 Boolean true.
#define FALSE   (0)
 Boolean false.
#define MIN(a, b)   (((a) < (b) ) ? (a) : (b))
 Standard definition for data minimum.
#define MAX(a, b)   (((a) > (b) ) ? (a) : (b))
 Standard definition for data maximum.
#define MEM_MSG(_status,)   _msg_report ((_status), 0, __VA_ARGS__)
 MSG signaller.

Typedefs

typedef _mem_mapEntry mem_mapEntry
 Typedef for struct _mem_mapEntry.

Functions

unsigned int Mem_ValidateMemoryRange (const MEM_Descriptor *md, const MEM_mapAccessType accessType, const mem_mapEntry **mapEntry)
 Validate memory descriptor against memory map table.
void * Mem_WriteRegisterSet (void *data_p, void *mask_p)
 Write CPU registers.

Detailed Description

Private MEM package definitions.

Interface to functions that are private to the MEM package.

  CVS $Id: mempriv.h,v 1.8 2005/08/12 15:55:54 dmay Exp $
  

Define Documentation

#define MEM_MSG _status   )     _msg_report ((_status), 0, __VA_ARGS__)
 

MSG signaller.

Configuration-dependent message signaller. For boot configuration, returns _status. For application configuration, calls _msg_report().

Parameters:
_status The variable holding the status code.
... The message specific parameter values.


Function Documentation

unsigned int Mem_ValidateMemoryRange const MEM_Descriptor md,
const MEM_mapAccessType  accessType,
const mem_mapEntry **  mapEntry
 

Validate memory descriptor against memory map table.

This function verifies that a memory descriptor is valid for a given set of access types. Potential access types are specified in accessType as a bitfield. If at least one of the access types specified is legal for the memory descriptor, a handle to the appropriate memory map entry is passed back for future use. If, instead, the caller wants to know if *all* specified access types are valid, then this function must be called once for each type.

Parameters:
md Pointer to memory descriptor to be validated.
accessType Bitfield of types of accesses to validate.
mapEntry Pointer to location to return map table entry handle.
Return values:
MEM_SUCCESS md is OK for accessType.
MEM_OUTOFRNG md does not fit in any memory map.
MEM_BADMAP md does not contain a legal memory map type.
MEM_BADACC accessType is not legal for md.

void * Mem_WriteRegisterSet void *  data_p,
void *  mask_p
 

Write CPU registers.

Writes a subset of the CPU registers.

Parameters:
data_p Pointer to array of data values to write.
mask_p Pointer to array of mask values to apply to the data.
Returns:
Sum of data_p and the number of bytes written.


Generated on Tue Nov 8 22:36:32 2005 by  doxygen 1.4.4