RIM_data_le.ic File Reference

Functions to set and get field and register values. More...

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 regId register 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 fldId field of the regId 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 *cpt, const FldDescription *fd, int regId, int fldId, unsigned short *value)
	Assumes the registers are unsigned shorts and puts the contents of the target field fldId of 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 fldId field of the regId 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 longlong and puts the contents of the target field fldId of register regId into value.

---

Detailed Description

Functions to set and get field and register values.

Author:

James Swain & Owen Saxton

$Id: RIM_data_le.ic,v 1.3 2011/03/27 06:53:19 saxton Exp $

---

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 longlong and puts the contents of the target field fldId of register regId into value.

Parameters:

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

References getLngLngReg(), FldDescription::offset, and FldDescription::width.

Referenced by RIM_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 register Id
	value	Location to put the contents of the target tgt

Referenced by getLngLngFld(), RIM_getReg(), and setLngLngFld().

void getShortFld	(	const unsigned *	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 field fldId of register regId into value.

Parameters:

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

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

Referenced by RIM_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 register Id
	value	Location to put the contents of the target tgt

Referenced by RIM_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 fldId field of the regId 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	Pointer to the value to be set

Return values:

	RIM_SUCCESS	Success
	RIM_FLDRANGE	The value was too large for the field

References getLngLngReg(), FldDescription::offset, setLngLngReg(), and FldDescription::width.

Referenced by RIM_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	Pointer to the value to set the register to

Referenced by RIM_setReg(), and setLngLngFld().

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 fldId field of the regId 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	Pointer to the value to be set

Return values:

	RIM_SUCCESS	Success
	RIM_FLDRANGE	The value was too large for the field

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

Referenced by RIM_setFld().

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

Assumes the registers are unsigned shorts 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	Pointer to the value to set the register to

Referenced by RIM_setReg().