data.ic File Reference

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

#include <descriptions.ic>

Functions
static void	setLongReg (unsigned *cpt, int regId, const unsigned *value)
	Assumes the registers are unsigned ints and Sets the regIdister of cpt structure to value.
static unsigned	setLongFld (unsigned *cpt, const FldDescription *fd, int regId, int fldId, const unsigned *value)
	Assumes the registers are unsigned ints and sets the target field.
static void	getLongReg (const unsigned *cpt, int regId, unsigned *value)
	Assumes the registers are unsigned ints and puts the contents of the target register regId into value.
static void	getLongFld (const unsigned *cpt, const FldDescription *fd, int regId, int fldId, unsigned *value)
	Assumes the registers are unsigned ints 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 getLongFld	(	const unsigned *	cpt,
		const FldDescription *	fd,
		int	regId,
		int	fldId,
		unsigned *	value
	)			[inline, static]

Assumes the registers are unsigned ints 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, and FldDescription::width.

Referenced by LATC_getFld().

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

Assumes the registers are unsigned ints 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().

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

Assumes the registers are unsigned ints and sets the target field.

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_LNGRNG	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 setLongReg	(	unsigned *	cpt,
		int	regId,
		const unsigned *	value
	)			[inline, static]

Assumes the registers are unsigned ints 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	Set the target registers to cpt.

Referenced by LATC_setReg().