IRegister Access

The functions in this section provide access to register nodes. This includes access to the node, its address and length, and reference. More...

Functions
SPINNAKERC_API	spinRegisterGet (spinNodeHandle hNode, uint8_t *pBuf, int64_t length)
	Retrieves the value of a register node. More...
SPINNAKERC_API	spinRegisterGetEx (spinNodeHandle hNode, bool8_t bVerify, bool8_t bIgnoreCache, uint8_t *pBuf, int64_t length)
	Retrieves the value of a register node; manually set whether to verify the node and whether to ignore the cache. More...
SPINNAKERC_API	spinRegisterGetAddress (spinNodeHandle hNode, int64_t *pAddress)
	Retrieves the address of a register node. More...
SPINNAKERC_API	spinRegisterGetLength (spinNodeHandle hNode, int64_t *pLength)
	Retrieves the length (in bytes) of the value of a register node. More...
SPINNAKERC_API	spinRegisterSet (spinNodeHandle hNode, const uint8_t *pBuf, int64_t length)
	Sets the value of a register node. More...
SPINNAKERC_API	spinRegisterSetEx (spinNodeHandle hNode, bool8_t bVerify, const uint8_t *pBuf, int64_t length)
	Sets the value of a register node; manually set whether to verify the node. More...
SPINNAKERC_API	spinRegisterSetReference (spinNodeHandle hNode, spinNodeHandle hRef)
	Uses a second node as a reference for a register node. More...

Detailed Description

The functions in this section provide access to register nodes. This includes access to the node, its address and length, and reference.

Function Documentation

spinRegisterGet()

SPINNAKERC_API spinRegisterGet	(	spinNodeHandle	hNode,
		uint8_t *	pBuf,
		int64_t	length
	)

Retrieves the value of a register node.

See also

spinError

Parameters

hNode	The register node of the value to retrieve
pBuf	The unsigned integer buffer in which the value is returned
length	The integer pointer in which the length of the register array is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinRegisterGetAddress()

SPINNAKERC_API spinRegisterGetAddress	(	spinNodeHandle	hNode,
		int64_t *	pAddress
	)

Retrieves the address of a register node.

See also

spinError

Parameters

hNode	The register node of the address to retrieve
pAddress	The integer pointer in which the address is returned

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinRegisterGetEx()

SPINNAKERC_API spinRegisterGetEx	(	spinNodeHandle	hNode,
		bool8_t	bVerify,
		bool8_t	bIgnoreCache,
		uint8_t *	pBuf,
		int64_t	length
	)

Retrieves the value of a register node; manually set whether to verify the node and whether to ignore the cache.

See also

spinError

Parameters

hNode	The register node of the value to retrieve
bVerify	The boolean of whether to verify the node
IgnoreCache	The boolean of whether to ignore the cache
pBuf	The unsigned integer buffer in which the value is returned
length	The integer pointer in which the length of the register array is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinRegisterGetLength()

SPINNAKERC_API spinRegisterGetLength	(	spinNodeHandle	hNode,
		int64_t *	pLength
	)

Retrieves the length (in bytes) of the value of a register node.

See also

spinError

Parameters

hNode	The register node of the length to retrieve
plength	The integer in which the number of bytes is returned

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinRegisterSet()

SPINNAKERC_API spinRegisterSet	(	spinNodeHandle	hNode,
		const uint8_t *	pBuf,
		int64_t	length
	)

Sets the value of a register node.

See also

spinError

Parameters

hNode	The register node of the value to set
pBuf	The unsigned integer buffer of the value to set
length	The number of bytes of the value to set

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinRegisterSetEx()

SPINNAKERC_API spinRegisterSetEx	(	spinNodeHandle	hNode,
		bool8_t	bVerify,
		const uint8_t *	pBuf,
		int64_t	length
	)

Sets the value of a register node; manually set whether to verify the node.

See also

spinError

Parameters

hNode	The register node of the value to set
bVerify	The boolean of whether to verify the node
pBuf	The unsigned integer buffer of the value to set
length	The number of bytes of the value to set

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinRegisterSetReference()

SPINNAKERC_API spinRegisterSetReference	(	spinNodeHandle	hNode,
		spinNodeHandle	hRef
	)

Uses a second node as a reference for a register node.

See also

spinError

Parameters

hNode	The register node that houses the reference
hRef	The reference node

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error