CXP io

Data Structures
struct	tCiCXPheartbeat
struct	tCiCXPeventPacket
struct	tCiCXPeventMessage

Typedefs
typedef struct tCiCXPheartbeat *	tCICXPHBP
typedef struct tCiCXPeventPacket *	tCICXPEP
typedef struct tCiCXPeventMessage *	tCICXPEM

Enumerations
enum	tCXPlinkEnums { kCiCXPlinkBitMask = 0x0F, kCiCXPlinkSpeedMask = 0xFF000000, kCiCXPuseMasterLink = 0x0FF }
enum	tCiCXPeventPacketEnum { kCImaxEventPayload = 256 }
enum	tCiCXPeventNamespaceEnum { kCICXPEnamespaceGenICam = 0, kCICXPEnamespaceCXP = 1, kCICXPEnamespaceDevice = 2, kCICXPEnamespaceReserved = 3 }

Functions
tCIRC	CiCXPwriteReg (tCIp cip, tCIU32 link, tCIU32 address, tCIU32 value)
	Write to CXP register. More...
tCIRC	CiCXPreadReg (tCIp cip, tCIU32 link, tCIU32 address, tCIU32 *value)
	Read from CXP register. More...
tCIRC	CiCXPwriteData (tCIp cip, tCIU32 link, tCIU32 address, tCIU8 *data, tCIU32 byteCount)
	Write to CXP data space. More...
tCIRC	CiCXPreadData (tCIp cip, tCIU32 link, tCIU32 address, tCIU8 *buffer, tCIU32 readBytes, tCIU32 *actualSz)
	Read from CXP data space (buffer size should be multiple of 4) More...
tCIRC	CiCXPgetLink (tCIp cip, tCIU32 *links)
	Retrieve link affinity for VFG. More...
tCIRC	CiCXPsetLink (tCIp cip, tCIU32 links)
	Assign link affinity for VFG. More...
tCIRC	CiCXPgetHostTime (tCIp cip, tCIU32 link, tCIU64 *hostTime)
	Retrieve the host time value. More...
tCIRC	CiCXPgetLastHeartbeat (tCIp cip, tCIU32 link, tCIU32 recSize, tCICXPHBP storeHere)
	Retrieve the latest CXP heartbeat value. More...
tCIRC	CiCXPreadEventPacket (tCIp cip, tCIU32 link, tCIU32 recSize, tCICXPEP storeHere)
	Read a CXP event packet from the event packet queue. More...
tCIRC	CiCXPparseEventPacket (tCIp cip, tCIU32 index, tCIU32 evtPktSize, tCICXPEP evtPkt, tCIU32 recSize, tCICXPEM storeHere)
	Parse one message stored in an event packet. More...

Detailed Description

Typedef Documentation

tCICXPEM

typedef struct tCiCXPeventMessage * tCICXPEM

tCICXPEP

typedef struct tCiCXPeventPacket * tCICXPEP

tCICXPHBP

typedef struct tCiCXPheartbeat * tCICXPHBP

Enumeration Type Documentation

tCiCXPeventNamespaceEnum

enum tCiCXPeventNamespaceEnum

Enumerator
kCICXPEnamespaceGenICam	GenICam event message.
kCICXPEnamespaceCXP	CXP event message.
kCICXPEnamespaceDevice	Device event message.
kCICXPEnamespaceReserved	Reserved event message namespace.

tCiCXPeventPacketEnum

enum tCiCXPeventPacketEnum

Enumerator
kCImaxEventPayload	maximum event packet data size in 32-bit words.

tCXPlinkEnums

enum tCXPlinkEnums

Enumerator
kCiCXPlinkBitMask
kCiCXPlinkSpeedMask
kCiCXPuseMasterLink

Function Documentation

CiCXPgetHostTime()

tCIRC CiCXPgetHostTime	(	tCIp	cip,
		tCIU32	link,
		tCIU64 *	hostTime
	)

Retrieve the host time value.

Retrieve the current host time value for the grabber and link.

Parameters

cip	this frame grabber
link	CXP link or kCiCXPuseMasterLink
hostTime	return value of host time

CiCXPgetLastHeartbeat()

tCIRC CiCXPgetLastHeartbeat	(	tCIp	cip,
		tCIU32	link,
		tCIU32	recSize,
		tCICXPHBP	storeHere
	)

Retrieve the latest CXP heartbeat value.

Retrieve the device and host timestamps of the latest CXP heartbeat packet. This may be used for high precision synchronization of acquisition data.

Parameters

cip	this frame grabber
link	CXP link or kCiCXPuseMasterLink
recSize	size of storage available
storeHere	caller's storage

CiCXPgetLink()

tCIRC CiCXPgetLink	(	tCIp	cip,
		tCIU32 *	links
	)

Retrieve link affinity for VFG.

If this VFG has no assigned link the return bitmask is 0

Otherwise it is a bitmask for which links affiliate w/this VFG.

MS8B describes link speed index (set by library).

Parameters

cip	this frame grabber
links	CXP link bitmask

CiCXPparseEventPacket()

tCIRC CiCXPparseEventPacket	(	tCIp	cip,
		tCIU32	index,
		tCIU32	evtPktSize,
		tCICXPEP	evtPkt,
		tCIU32	recSize,
		tCICXPEM	storeHere
	)

Parse one message stored in an event packet.

Parse the contents of the event packet to retrieve the message at index. If index exceeds packet size, message size is set to zero, and kCIEnoErr is returned.

Parameters

cip	this frame grabber
index	index of message to parse
evtPktSize	size of the CXP event packet structure
evtPkt	CXP event packet to parse
recSize	size of storage available
storeHere	caller's storage

CiCXPreadData()

tCIRC CiCXPreadData	(	tCIp	cip,
		tCIU32	link,
		tCIU32	address,
		tCIU8 *	buffer,
		tCIU32	readBytes,
		tCIU32 *	actualSz
	)

Read from CXP data space (buffer size should be multiple of 4)

Parameters

cip	this frame grabber
link	CXP link or kCiCXPuseMasterLink
address	CXP data address
buffer	CXP data goes here
readBytes	data size requested
actualSz	data size returned

CiCXPreadEventPacket()

tCIRC CiCXPreadEventPacket	(	tCIp	cip,
		tCIU32	link,
		tCIU32	recSize,
		tCICXPEP	storeHere
	)

Read a CXP event packet from the event packet queue.

Read a CXP event packet from the event packet queue. Parse event packet data using the CiCXPparseEventPacket method.

Parameters

cip	this frame grabber
link	CXP link or kCiCXPuseMasterLink
recSize	size of storage available
storeHere	caller's storage

CiCXPreadReg()

tCIRC CiCXPreadReg	(	tCIp	cip,
		tCIU32	link,
		tCIU32	address,
		tCIU32 *	value
	)

Read from CXP register.

Parameters

cip	this frame grabber
link	CXP link or kCiCXPuseMasterLink
address	CXP register address
value	value from read

CiCXPsetLink()

tCIRC CiCXPsetLink	(	tCIp	cip,
		tCIU32	links
	)

Assign link affinity for VFG.

Parameters

cip	this frame grabber
links	CXP link bitmask

CiCXPwriteData()

tCIRC CiCXPwriteData	(	tCIp	cip,
		tCIU32	link,
		tCIU32	address,
		tCIU8 *	data,
		tCIU32	byteCount
	)

Write to CXP data space.

Parameters

cip	this frame grabber
link	CXP link or kCiCXPuseMasterLink
address	CXP data address
data	data to be written
byteCount	number of bytes to write

CiCXPwriteReg()

tCIRC CiCXPwriteReg	(	tCIp	cip,
		tCIU32	link,
		tCIU32	address,
		tCIU32	value
	)

Write to CXP register.

Parameters

cip	this frame grabber
link	CXP link or kCiCXPuseMasterLink
address	CXP register address
value	value to be written