data_be.ic File Reference

Set and get field and register functions. More...

#include <MSG/MSG_pubdefs.h>

Classes
union	ull_mask
	union of an unsigned long long and a two element array of unsigneds used to create bit masks for the ull routines More...
Functions
static void	setShortReg (unsigned short *cpt, int regId, const unsigned short *value)
	Assumes the registers are unsigned shorts and Sets the regIdister of cpt structure to value.
static unsigned	setShortFld (unsigned short *cpt, const FldDescription *fd, int regId, int fldId, const unsigned short *value)
	Assumes the registers are unsigned shorts and sets the tgtFiels of the register of cpt structure to value.
static void	getShortReg (const unsigned short *cpt, int regId, unsigned short *value)
	Assumes the registers are unsigned shorts and puts the contents of the target register regId into value.
static void	getShortFld (const unsigned short *cpt, const FldDescription *fd, int regId, int fldId, unsigned short *value)
	Assumes the registers are unsigned shorts and puts the contents of the target register regId into value.
static void	setLngLngReg (unsigned long long *cpt, int regId, const unsigned long long *value)
	Assumes the registers are unsigned long long and sets the regId register of cpt structure to value.
static unsigned	setLngLngFld (unsigned long long *cpt, const FldDescription *fd, int regId, int fldId, const unsigned long long *value)
	Assumes the registers are unsigned long long and sets the tgtFields of the register of cpt structure to value.
static void	getLngLngReg (const unsigned long long *cpt, int regId, unsigned long long *value)
	Assumes the registers are unsigned long long and puts the contents of the target register regId into value.
static void	getLngLngFld (const unsigned long long *cpt, const FldDescription *fd, int regId, int fldId, unsigned long long *value)
	Assumes the registers are unsigned long long and puts the contents of the target register regId into value.

---

Detailed Description

Set and get field and register functions.

Author:

James Swain -- jswain@slac.stanford.edu

---

Function Documentation

void getLngLngFld	(	const unsigned long long *	cpt,
		const FldDescription *	fd,
		int	regId,
		int	fldId,
		unsigned long long *	value
	)			[inline, static]

Assumes the registers are unsigned long long and puts the contents of the target register regId into value.

Parameters:

	cpt	Pointer to start of the component data.
	fd	Description of the register fields
	regId	Target tgt
	fldId	Target field
	value	Location to put the contents of the target tgt

References FldDescription::offset, ull_mask::uia, ull_mask::ull, and FldDescription::width.

Referenced by LATC_getFld().

void getLngLngReg	(	const unsigned long long *	cpt,
		int	regId,
		unsigned long long *	value
	)			[inline, static]

Assumes the registers are unsigned long long and puts the contents of the target register regId into value.

Parameters:

	cpt	Pointer to start of the component data.
	regId	Target tgt
	value	Location to put the contents of the target tgt

Referenced by LATC_getReg().

void getShortFld	(	const unsigned short *	cpt,
		const FldDescription *	fd,
		int	regId,
		int	fldId,
		unsigned short *	value
	)			[inline, static]

Assumes the registers are unsigned shorts and puts the contents of the target register regId into value.

Parameters:

	cpt	Pointer to start of the component data.
	fd	Description of the register fields
	regId	Target tgt
	fldId	Target field
	value	Location to put the contents of the target field

References FldDescription::offset, and FldDescription::width.

Referenced by LATC_getFld().

void getShortReg	(	const unsigned short *	cpt,
		int	regId,
		unsigned short *	value
	)			[inline, static]

Assumes the registers are unsigned shorts and puts the contents of the target register regId into value.

Parameters:

	cpt	Pointer to start of the component data.
	regId	Target tgt
	value	Location to put the contents of the target register

Referenced by LATC_getReg().

unsigned setLngLngFld	(	unsigned long long *	cpt,
		const FldDescription *	fd,
		int	regId,
		int	fldId,
		const unsigned long long *	value
	)			[inline, static]

Assumes the registers are unsigned long long and sets the tgtFields of the register of cpt structure to value.

Parameters:

	cpt	Pointer to start of the component data.
	fd	Description of the fields in the register
	regId	Enum specifying register to write to (previously bounds checked)
	fldId	Enum specifying field to write to (previously bounds checked)
	value	Set the target registers to cpt.

Return values:

	LATC_LLRNG	If the value supplied will not fit within the target field
	LATC_SUCCESS	If the value supplied is good

References FldDescription::offset, ull_mask::uia, ull_mask::ull, and FldDescription::width.

Referenced by LATC_setFld().

void setLngLngReg	(	unsigned long long *	cpt,
		int	regId,
		const unsigned long long *	value
	)			[inline, static]

Assumes the registers are unsigned long long and sets the regId register of cpt structure to value.

Parameters:

	cpt	Pointer to start of the component data.
	regId	Enum specifing register to write to (previously bounds checked)
	value	Set the target registers to cpt.

Referenced by LATC_setReg().

unsigned setShortFld	(	unsigned short *	cpt,
		const FldDescription *	fd,
		int	regId,
		int	fldId,
		const unsigned short *	value
	)			[inline, static]

Assumes the registers are unsigned shorts and sets the tgtFiels of the register of cpt structure to value.

Parameters:

	cpt	Pointer to start of the component data.
	fd	Description of the fields in the register
	regId	Enum specifying register to write to (previously bounds checked)
	fldId	Enum specifying field to write to (previously bounds checked)
	value	Value to set the field to.

Return values:

	LATC_SHTRNG	If the value supplied will not fit within the target field
	LATC_SUCCESS	If the value supplied is good

References FldDescription::offset, and FldDescription::width.

Referenced by LATC_setFld().

void setShortReg	(	unsigned short *	cpt,
		int	regId,
		const unsigned short *	value
	)			[inline, static]

Assumes the registers are unsigned shorts and Sets the regIdister of cpt structure to value.

Parameters:

	cpt	Pointer to start of the component data.
	regId	Enum specifing register to write to (previously bounds checked)
	value	Value to set the field to.

Referenced by LATC_setReg().