GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > RIM / V0-0-2

Constituent: rim     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

data_p.h File Reference

Accessor functions. More...

#include "RIM/rim.h"

Include dependency graph for data_p.h:

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


Functions

int RIM_regEnum (RIM_type type, int regId)
 Convert the public register ID in to the RIM internal register ID.
void RIM_setReg (void *cpt, RIM_type type, int regId, const void *value)
 Sets the regIdister of cpt structure to value.
void RIM_getReg (const void *cpt, RIM_type type, int regId, void *value)
 Puts the contents of the target register regId into value.
void RIM_setFld (void *cpt, RIM_type type, int regId, int fldId, const void *value)
 Sets the tgtFiels of the register of cpt structure to value.
void RIM_getFld (const void *cpt, RIM_type type, int regId, int fldId, void *value)
 Puts the contents of the target register regId into value.

Detailed Description

Accessor functions.

Author:
James Swain -- jswain@slac.stanford.edu

Function Documentation

void RIM_getFld const void *  cpt,
RIM_type  type,
int  regId,
int  fldId,
void *  value
 

Puts the contents of the target register regId into value.

Parameters:
type Type of data sought
cpt Pointer to start of the component data.
regId Target tgt
fldId Target field
value Location to put the contents of the target field

void RIM_getReg const void *  cpt,
RIM_type  type,
int  regId,
void *  value
 

Puts the contents of the target register regId into value.

Parameters:
cpt Pointer to start of the component data.
type Type of data sought
regId Target tgt
value Location to put the contents of the target reg

int RIM_regEnum RIM_type  type,
int  regId
 

Convert the public register ID in to the RIM internal register ID.

Parameters:
type Component type
regId Register ID in terms of hardware numbering (the Huffer docs and LEM)
Returns:
The index of the register in the array of register descriptions within the component description

void RIM_setFld void *  cpt,
RIM_type  type,
int  regId,
int  fldId,
const void *  value
 

Sets the tgtFiels of the register of cpt structure to value.

Parameters:
type Type of data sought
cpt Pointer to start of the component data.
regId Enum specifying register to write to
fldId Enum specifying field to write to
value Value to set the field to.

void RIM_setReg void *  cpt,
RIM_type  type,
int  regId,
const void *  value
 

Sets the regIdister of cpt structure to value.

Parameters:
cpt Pointer to start of the component data.
type Type of data sought
regId Enum specifing register to write to
value Value to set register to


Generated on Thu Apr 13 23:39:32 2006 by  doxygen 1.4.4