RIM_data.ic File Reference

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

#include <RIM/RIM_msgs.h>
#include <PBI/Endianness.h>
#include <string.h>

Functions
static void	setLongReg (unsigned *cpt, int regId, const unsigned *value)
	Assumes the registers are unsigned ints and sets the regId register 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 fldId field of the regId register of cpt structure to value.
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 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.ic,v 1.3 2011/03/27 06:53:19 saxton Exp $

---

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

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

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