CON Register Field Access

Functions
int	CiFieldNdxFromStr (tCIp cip, char *str)
	Return enumerate from string. More...
int	CiFieldWidth (tCIp cip, int fieldNdx)
	Return field width. More...
char *	CiFieldNameFromNdx (tCIp cip, int ndx)
	Return label for enumerate. More...
tCIRC	CiFieldPeek (tCIp cip, tCIU32 ndx, tCIU32 *result)
	Read a CON register field. More...
tCIRC	CiFieldPoke (tCIp cip, tCIU32 ndx, tCIU32 value)
	Write a CON register field. More...

Detailed Description

Function Documentation

CiFieldNameFromNdx()

char* CiFieldNameFromNdx	(	tCIp	cip,
		int	ndx
	)

Return label for enumerate.

A way to map an enumerate to a label. Do not modify the returned string since it is static store.

Parameters

cip	this frame grabber
ndx	index of the field

CiFieldNdxFromStr()

int CiFieldNdxFromStr	(	tCIp	cip,
		char *	str
	)

Return enumerate from string.

A way to map a label to a register field enumerate. Pass, e.g., "HCOUNT" to get the field enumerate associated with the HCOUNT field in CON6.

Parameters

cip	this frame grabber
str	name of the field enumerate

CiFieldPeek()

tCIRC CiFieldPeek	(	tCIp	cip,
		tCIU32	ndx,
		tCIU32 *	result
	)

Read a CON register field.

Parameters

cip	this frame grabber
ndx	index of the field to peek
result	contents of register field

CiFieldPoke()

tCIRC CiFieldPoke	(	tCIp	cip,
		tCIU32	ndx,
		tCIU32	value
	)

Write a CON register field.

Parameters

cip	this frame grabber
ndx	index of the field to poke
value	new field value

CiFieldWidth()

int CiFieldWidth	(	tCIp	cip,
		int	fieldNdx
	)

Return field width.

Return the width of this field enumerate.

Parameters

cip	this frame grabber
fieldNdx	index of the field