Data Structures
struct	tCIvfgStateEntry
	Structure used for array of VFG state info. More...

Macros
#define	CiSysBrdEnum CiSysVFGenum

#define	CiSysBrdInfo CiSysVFGinfo

#define	CiSysBrdInfo2 CiSysVFGinfo2

#define	CiBrdOpen CiVFGopen

#define	CiBrdIndex CiVFGindex

#define	CiBrdFileDescriptor CiVFGfileDescriptor

#define	CiBrdQueryInfo CiVFGqueryInfo

#define	CiBrdQueryState CiVFGqueryState

#define	kBFDEFAULTCFGFILE NULL

#define	CiBrdInitialize CiVFGinitialize

#define	CiBrdInquire CiVFGinquire

#define	CiBrdInquire2 CiVFGinquire2

Typedefs
typedef struct tCIvfgStateEntry *	tCIVFGSEP

Enumerations
enum	tCImaxDevEnum { kCIlibMaxDevScan = 25 }

enum	tCIcamTypeEnums { kCICT_Neon = 1, kCICT_NeonDIF, kCICT_Karbon, kCICT_Alta, kCICT_KbnCXP, kCICT_CtnCXP, kCICT_AxnCL, kCICT_AonCXP, kCICT_ClxCXP, kCICT_VFGmask = 31, kCICT_isMaster = 0x1000 }

enum	tCIboardOpenEnums { kCIBO_readOnly = 0, kCIBO_writeAccess = 1, kCIBO_exclusiveWrAccess = 1 << 1 }

enum	tCIboardQueryEnums { kCIBQ_shuttingDown = 1, kCIBQ_startingUp, kCIBQ_usrDMAerr, kCIBQ_needsFirmware, kCIBQ_firmwareLoaded, kCIBQ_dmaBufferReady, kCIBQ_dmaIsActive, kCIBQ_dmaIsAborted, kCIBQ_stateUnknown = 9999 }

enum	tCIinitFlagsEnums { kCIIF_default = 0, kCIIF_noGenTLinit = 1 }

enum	tCIvfgTestTraitEnums { kCIVTT_R64 = 0, kCIVTT_CL, kCIVTT_CXP, kCIVTT_Kbn, kCIVTT_Kbn2, kCIVTT_Kbn4, kCIVTT_KbnBase, kCIVTT_KbnFull, kCIVTT_Neon, kCIVTT_NeonBase, kCIVTT_NeonD, kCIVTT_NeonQ, kCIVTT_NeonDif, kCIVTT_Master, kCIVTT_Slave, kCIVTT_EncDiv, kCIVTT_NTG, kCIVTT_Gn2, kCIVTT_Ctn, kCIVTT_CtnCXP2, kCIVTT_CtnCXP4, kCIVTT_CtnII, kCIVTT_Axn, kCIVTT_AxnBase, kCIVTT_Axn1xE, kCIVTT_Axn2xE, kCIVTT_Axn1xB, kCIVTT_Axn2xB, kCIVTT_Axn4xB, kCIVTT_AxnII, kCIVTT_Aon, kCIVTT_AonCXP1, kCIVTT_AonII, kCIVTT_Clx, kCIVTT_ClxCXP1, kCIVTT_ClxCXP2, kCIVTT_ClxCXP4, kCIVTT_HasSerialPort, kCIVTT_Synthetic, kCIVTT_CXPlinkPowerUp, kCIVTT_CXPlinkAlive, kCIVTT_CLclockDetected, kCIVTT_CameraReady, kCIVTT_traitCount }

enum	tCIcamFileQueryEnums { kCIcamFile_bitsPerPix = 0, kCIcamFile_packed, kCIcamFile_hROIoffset, kCIcamFile_hROIsize, kCIcamFile_vROIoffset, kCIcamFile_vROIsize, kCIcamFile_format, kCIcamFile_acqTimeout, kCIcamFile_acqOffWhenClosing, kCIcamFile_maxCXPversion, kCIcamFile_bitDepthOption, kCIcamFile_requiresTLParamsLocked, kCIcamFile_loadedToDrvr = 0x1000, kCIcamFile_appliedToVFG, kCIcamFile_isDefault = 0x80000000 }

enum	tCIbitDepthOptionEnums { kCIBPP_formatterNormal = 0, kCIBPP_formatterRGBSwap = 1, kCIBPP_formatterManual = 1 << 1, kCIBPP_formatterIgnore = 1 << 2 }

Functions
void	CiSetMaxDevices (tCIU32 maxDev)
	Max /dev/video<n> to scan. More...

tCIRC	CiSysGetVersions (tCIU32 libVers, tCIU32 drvVers)
	Return library revision level. More...

tCIRC	CiSysVFGenum (tCIU32 *nFound)
	Count the BitFlow VFG. More...

tCIRC	CiSysVFGinfo (tCIU32 which, tCIU32 ifaceType, tCIU32 switches, tCIU32 *devNdx, tCISTRZ busName)
	Identify a single VFG. More...

tCIRC	CiSysVFGinfo2 (tCIU32 which, tCIU32 ifaceType, tCIU32 switches, tCIU32 devNdx, tCISTRZ busName, tCIU32 infoHi, tCIU32 infoLo, tCISTRZ VFGname, tCIU32 NUMAnode)
	More info on a single VFG. More...

tCIRC	CiSysFindLiveVFGs (tCIU32 recSize, tCIVFGSEP vfgAry)
	Query live status of VFGs and connected cameras. More...

tCIRC	CiVFGopen (tCIU32 devNdx, tCIU32 modeFlags, tCIp *cip)
	Open a VFG. More...

tCIU32	CiVFGindex (tCIp cip)
	Returns devNdx of CiVFGopen() More...

tCIRC	CiVFGfileDescriptor (tCIp cip, int *fdp)
	Return file descriptor for VFG. More...

tCIRC	CiVFGqueryInfo (tCIp cip, tCIU32 ifaceType, tCIU32 switches, tCIU32 devNdx, tCISTRZ busName, tCIU32 infoHi, tCIU32 infoLo, tCISTRZ VFGname, tCIU32 NUMAnode)
	Return SysVFGinfo for open VFG. More...

tCIRC	CiGetOpenCount (tCIp cip, tCIU32 *nOpen)
	Get count of open file descriptors for this VFG. More...

tCIRC	CiVFGqueryState (tCIp cip, tCIU32 *state)
	? Is frame grabber initialized ? More...

tCIRC	CiVFGinitialize (tCIp cip, tCISTRZ cfgFN)
	Initialize board or VFG. More...

tCIRC	CiVFGapplyCameraFile (tCIp cip, tCISTRZ camFN)
	Initialize a VFG directly from a camera file. More...

tCIRC	CiVFGloadConfig (tCIp cip, tCISTRZ cfgFN)
	Load configuration data into the VFG driver data store. More...

tCIRC	CiVFGloadCameraFile (tCIp cip, tCISTRZ camFN)
	Load camera file data into the VFG driver data store. More...

tCIRC	CiVFGapplyCurrent (tCIp cip, tCIU32 initFlags)
	Initialize a VFG from its driver data store. More...

tCIRC	CiVFGinquire (tCIp cip, tCITDP cfgFN, tCITDP config, tCITDP cameraFN, tCITDP camera, tCITDP firmFN, tCITDP firmware, tCITDP *serial)
	Interrogate configuration. More...

tCIRC	CiVFGinquire2 (tCIp cip, tCITDP cfgFN, tCITDP config, tCITDP cameraFN, tCITDP camera, tCITDP firmFN, tCITDP firmware, tCITDP serial, tCITDP cxpLink, tCITDP spare, char *fmtPtr)

tCIU8	CiVFGtest (tCIp cip, tCIU32 trait, tCIU32 opt)
	Test the VFG to determine whether or not it matches the trait. More...

tCIRC	CiCamFileInquire (tCIp cip, tCIU32 param, tCIU32 *value)
	Query camera file parameters initialized on the VFG. More...

tCIRC	CiVFGclose (tCIp cip)
	Close a VFG. More...

Detailed Description

Macro Definition Documentation

◆ CiBrdFileDescriptor

#define CiBrdFileDescriptor CiVFGfileDescriptor

◆ CiBrdIndex

#define CiBrdIndex CiVFGindex

◆ CiBrdInitialize

#define CiBrdInitialize CiVFGinitialize

◆ CiBrdInquire

#define CiBrdInquire CiVFGinquire

◆ CiBrdInquire2

#define CiBrdInquire2 CiVFGinquire2

◆ CiBrdOpen

#define CiBrdOpen CiVFGopen

◆ CiBrdQueryInfo

#define CiBrdQueryInfo CiVFGqueryInfo

◆ CiBrdQueryState

#define CiBrdQueryState CiVFGqueryState

◆ CiSysBrdEnum

#define CiSysBrdEnum CiSysVFGenum

◆ CiSysBrdInfo

#define CiSysBrdInfo CiSysVFGinfo

◆ CiSysBrdInfo2

#define CiSysBrdInfo2 CiSysVFGinfo2

◆ kBFDEFAULTCFGFILE

#define kBFDEFAULTCFGFILE NULL

Typedef Documentation

◆ tCIVFGSEP

typedef struct tCIvfgStateEntry * tCIVFGSEP

Enumeration Type Documentation

◆ tCIbitDepthOptionEnums

enum tCIbitDepthOptionEnums

Enumerator
kCIBPP_formatterNormal	No special processing.
kCIBPP_formatterRGBSwap	Swap R&B.
kCIBPP_formatterManual	use the manual tap format
kCIBPP_formatterIgnore	ignore bpp; assume 8b

◆ tCIboardOpenEnums

enum tCIboardOpenEnums

Enumerator
kCIBO_readOnly	cannot modify board state
kCIBO_writeAccess	can modify board state
kCIBO_exclusiveWrAccess	no previous/subsequent wr access

◆ tCIboardQueryEnums

enum tCIboardQueryEnums

Enumerator
kCIBQ_shuttingDown
kCIBQ_startingUp
kCIBQ_usrDMAerr
kCIBQ_needsFirmware
kCIBQ_firmwareLoaded
kCIBQ_dmaBufferReady
kCIBQ_dmaIsActive
kCIBQ_dmaIsAborted
kCIBQ_stateUnknown

◆ tCIcamFileQueryEnums

enum tCIcamFileQueryEnums

Enumerator
kCIcamFile_bitsPerPix	bit-depth
kCIcamFile_packed	pixel packing (non-zero if packed)
kCIcamFile_hROIoffset	horizontal ROI offset
kCIcamFile_hROIsize	horizontal ROI size (aka, width)
kCIcamFile_vROIoffset	vertical ROI offset
kCIcamFile_vROIsize	vertical ROI size (aka, height)
kCIcamFile_format	format of the image sensor
kCIcamFile_acqTimeout	acquisition timeout in ms
kCIcamFile_acqOffWhenClosing	camera acq stopped at close
kCIcamFile_maxCXPversion	maximum supported CXP version
kCIcamFile_bitDepthOption	bit-depth options (see tCIbitDepthOptionEnums)
kCIcamFile_requiresTLParamsLocked	whether or not TLParamsLocked is required by the camera
kCIcamFile_loadedToDrvr	whether or not a camera file has been loaded to the driver store
kCIcamFile_appliedToVFG	whether or not a camera file has been applied to the VFG
kCIcamFile_isDefault	determine if a parameter is Default/Auto

◆ tCIcamTypeEnums

enum tCIcamTypeEnums

Enumerator
kCICT_Neon	Neon frame grabber.
kCICT_NeonDIF	NeonDIF frame grabber.
kCICT_Karbon	Karbon frame grabber.
kCICT_Alta	Alta frame grabber (deprecated)
kCICT_KbnCXP	Karbon CXP frame grabber (deprecated)
kCICT_CtnCXP	Cyton CXP frame grabber.
kCICT_AxnCL	Axion CL frame grabber.
kCICT_AonCXP	Aon CXP frame grabber.
kCICT_ClxCXP	Claxon CXP frame grabber.
kCICT_VFGmask	Neon/Karbon/Alta/KCXP/Ctn/Axn/Aon/Clx.
kCICT_isMaster	master frame grabber for board Flag to identify master interface on multi-interface board

◆ tCIinitFlagsEnums

enum tCIinitFlagsEnums

Enumerator
kCIIF_default	default VFG intiailization
kCIIF_noGenTLinit	skip GenTL device_commands

◆ tCImaxDevEnum

enum tCImaxDevEnum

Enumerator
kCIlibMaxDevScan

◆ tCIvfgTestTraitEnums

enum tCIvfgTestTraitEnums

Enumerator
kCIVTT_R64	VFG belongs to the R64 family.
kCIVTT_CL	VFG interface is Camera Link.
kCIVTT_CXP	VFG interface is CoaXPress.
kCIVTT_Kbn	VFG is Karbon CL.
kCIVTT_Kbn2	VFG is Karbon CL 2.
kCIVTT_Kbn4	VFG is Karbon CL 4.
kCIVTT_KbnBase	VFG is Karbon CL base configuration.
kCIVTT_KbnFull	VFG is Karbon CL full configuration.
kCIVTT_Neon	VFG is Neon CL.
kCIVTT_NeonBase	VFG is Neon CL base configuration.
kCIVTT_NeonD	VFG is Neon CL Dual.
kCIVTT_NeonQ	VFG is Neon CL Quad.
kCIVTT_NeonDif	VFG is Neon Dif.
kCIVTT_Master	VFG is master.
kCIVTT_Slave	VFG is slave.
kCIVTT_EncDiv	VFG supports the encoder-divider.
kCIVTT_NTG	VFG supports the NTG.
kCIVTT_Gn2	VFG is Gen 2.
kCIVTT_Ctn	VFG is Cyton CXP.
kCIVTT_CtnCXP2	VFG is Cyton CXP 2.
kCIVTT_CtnCXP4	VFG is Cyton CXP 4.
kCIVTT_CtnII	VFG is Cyton CXP Mark II.
kCIVTT_Axn	VFG is Axion CL.
kCIVTT_AxnBase	VFG is Axion CL base configuration.
kCIVTT_Axn1xE	VFG is Axion CL 1xE.
kCIVTT_Axn2xE	VFG is Axion CL 2xE.
kCIVTT_Axn1xB	VFG is Axion CL 1xB.
kCIVTT_Axn2xB	VFG is Axion CL 2xB.
kCIVTT_Axn4xB	VFG is Axion CL 4xB.
kCIVTT_AxnII	VFG is Axion CL Mark II.
kCIVTT_Aon	VFG is Aon CXP.
kCIVTT_AonCXP1	VFG is Aon CXP 1.
kCIVTT_AonII	VFG is Aon CXP Mark II.
kCIVTT_Clx	VFG is Claxon CXP.
kCIVTT_ClxCXP1	VFG is Claxon CXP 1.
kCIVTT_ClxCXP2	VFG is Claxon CXP 2.
kCIVTT_ClxCXP4	VFG is Claxon CXP 4.
kCIVTT_HasSerialPort	VFG has a serial port.
kCIVTT_Synthetic	VFG is configured for synthetic acquisition.
kCIVTT_CXPlinkPowerUp	CXP link has power up (opt = link)
kCIVTT_CXPlinkAlive	CXP link is aligned (opt = link)
kCIVTT_CLclockDetected	Camera Link clock detected.
kCIVTT_CameraReady	Camera is connected and has power up.
kCIVTT_traitCount

Function Documentation

◆ CiCamFileInquire()

tCIRC CiCamFileInquire	(	tCIp	cip,
		tCIU32	param,
		tCIU32 *	value
	)

Query camera file parameters initialized on the VFG.

Parameters

cip	this frame grabber
param	tCIcamFileQueryEnums parameter to query
value	returns value of the inquiry parameter

◆ CiGetOpenCount()

tCIRC CiGetOpenCount	(	tCIp	cip,
		tCIU32 *	nOpen
	)

Get count of open file descriptors for this VFG.

Parameters

cip	this frame grabber
nOpen	number of open descriptors

◆ CiSetMaxDevices()

void CiSetMaxDevices ( tCIU32 maxDev )

Max /dev/video<n> to scan.

Each physical frame grabber will have from 1 to 4 virtual frame grabber (VFG) interfaces. Each VFG is a separate linux device (/dev/video<n>).

If for some reason there are more than kCIlibMaxDevScan /dev/videoNN devices then use this call to reset the library default scan limit.

This would imply more than 6 quad VFG framegrabbers installed in one PC...

◆ CiSysFindLiveVFGs()

tCIRC CiSysFindLiveVFGs	(	tCIU32	recSize,
		tCIVFGSEP	vfgAry
	)

Query live status of VFGs and connected cameras.

vfgAry should must be large enough to store one every for every installed VFG.

NOTE: VFGs loaded with synthetic camera files will be considered valid, even if no camera is connected. Camera file data is that loaded in the VFG driver store.

Parameters

recSize	byte size of vfgAry
vfgAry	VFG state array large enough to store all results

◆ CiSysGetVersions()

tCIRC CiSysGetVersions	(	tCIU32 *	libVers,
		tCIU32 *	drvVers
	)

Return library revision level.

Parameters

libVers	CI library version info
drvVers	BitFlow driver version info

◆ CiSysVFGenum()

tCIRC CiSysVFGenum ( tCIU32 * nFound )

Count the BitFlow VFG.

Parameters

nFound returns number of interfaces

◆ CiSysVFGinfo()

tCIRC CiSysVFGinfo	(	tCIU32	which,
		tCIU32 *	ifaceType,
		tCIU32 *	switches,
		tCIU32 *	devNdx,
		tCISTRZ	busName
	)

Identify a single VFG.

NOTE: DIP switch value only valid after firmware is loaded.

NOTE: CiSysVFGinfo2() supplies a superset of this information

This call is retained only for compatibility w/previous SDK releases.

Parameters

which	0..nFound
ifaceType	Neon, Karbon, etc.
switches	DIP switch value for board
devNdx	/dev/video<Ndx> access
busName	user-supplied storage (64 char)

◆ CiSysVFGinfo2()

tCIRC CiSysVFGinfo2	(	tCIU32	which,
		tCIU32 *	ifaceType,
		tCIU32 *	switches,
		tCIU32 *	devNdx,
		tCISTRZ	busName,
		tCIU32 *	infoHi,
		tCIU32 *	infoLo,
		tCISTRZ	VFGname,
		tCIU32 *	NUMAnode
	)

More info on a single VFG.

ifaceType is one one tCIcamTypeEnums (see above)

NOTE: DIP switch value only valid after firmware is loaded.

Parameters

which	0..nFound
ifaceType	Neon, Karbon, etc.
switches	DIP switch value for board
devNdx	/dev/video<Ndx> access
busName	user-supplied storage (64 char)
infoHi	VFG INFOHI value
infoLo	VFG INFOLO value
VFGname	user supplied storage (64 char)
NUMAnode	node for this VFG

◆ CiVFGapplyCameraFile()

tCIRC CiVFGapplyCameraFile	(	tCIp	cip,
		tCISTRZ	camFN
	)

Initialize a VFG directly from a camera file.

The environment variable BITFLOW_INSTALL_DIRS must be set if path does not contain a '/'. If path contains a '/' then the fileName is relative to the current directory. If path begins with '/' then it is absolute.

If the path contains a '/' then the file name is case sensitive.

Parameters

cip	this VFG
camFN	[path][mode@]fileName

◆ CiVFGapplyCurrent()

tCIRC CiVFGapplyCurrent	(	tCIp	cip,
		tCIU32	initFlags
	)

Initialize a VFG from its driver data store.

The environment variable BITFLOW_INSTALL_DIRS must be set

If kBFDEFAULTCFGFILE is used then the board DIP switches determine the appropriate config file.

NOTE: Only the master interface on a VFG board can download firmware.

NOTE: All slave VFG camera files must be compatible w/master VFG.

NOTE: This method requires that camera configuration data is first loaded using CiVFGloadConfig or CiVFGloadCameraFile. Data stored during a previous initialization with CiVFGinitialize or CiVFGapplyCameraFile may also be used, in which case the VFG is reinitialized.

Parameters

cip	this frame grabber
initFlags	bitmask combo of tCIinitFlagsEnums

◆ CiVFGclose()

tCIRC CiVFGclose ( tCIp cip )

Close a VFG.

Parameters

cip	from CiVFGopen()

◆ CiVFGfileDescriptor()

tCIRC CiVFGfileDescriptor	(	tCIp	cip,
		int *	fdp
	)

Return file descriptor for VFG.

Parameters

cip	this frame grabber
fdp	file descriptor for poll()

◆ CiVFGindex()

tCIU32 CiVFGindex ( tCIp cip )

Returns devNdx of CiVFGopen()

◆ CiVFGinitialize()

tCIRC CiVFGinitialize	(	tCIp	cip,
		tCISTRZ	cfgFN
	)

Initialize board or VFG.

The environment variable BITFLOW_INSTALL_DIRS must be set

If kBFDEFAULTCFGFILE is used then the board DIP switches determine the appropriate config file.

NOTE: Only the master interface on a VFG board can download firmware.

NOTE: All slave VFG camera files must be compatible w/master VFG.

Parameters

cip	this frame grabber
cfgFN	kBFDEFAULTCFGFILE -- or -- file within BITFLOW_INSTALL_DIRS -- or -- full path to config file

◆ CiVFGinquire()

tCIRC CiVFGinquire	(	tCIp	cip,
		tCITDP *	cfgFN,
		tCITDP *	config,
		tCITDP *	cameraFN,
		tCITDP *	camera,
		tCITDP *	firmFN,
		tCITDP *	firmware,
		tCITDP *	serial
	)

Interrogate configuration.

NOTE: Passing a NULL *tCITDP ptr is OK; information not returned.

NOTE: If the board is not initialized or not configured then some or all of the returned values will be NULL.

NOTE: The tCITDP content should not be modified in any way.

NOTE: CiSysVFGinquire2() supplies a superset of this information

This call is retained only for compatibility w/previous SDK releases.

Parameters

cip	this frame grabber
cfgFN	configuration file path
config	configuration file content
cameraFN	camera file path
camera	camera file content
firmFN	firmware file path
firmware	firmware file content
serial	serial port owner

◆ CiVFGinquire2()

tCIRC CiVFGinquire2	(	tCIp	cip,
		tCITDP *	cfgFN,
		tCITDP *	config,
		tCITDP *	cameraFN,
		tCITDP *	camera,
		tCITDP *	firmFN,
		tCITDP *	firmware,
		tCITDP *	serial,
		tCITDP *	cxpLink,
		tCITDP *	spare,
		char **	fmtPtr
	)

Parameters

cip	this frame grabber
cfgFN	configuration file path
config	configuration file content
cameraFN	camera file path
camera	camera file content
firmFN	firmware file path
firmware	firmware file content
serial	serial port owner
cxpLink	CXP link affinity
spare	whatever
fmtPtr	format str ptr

◆ CiVFGloadCameraFile()

tCIRC CiVFGloadCameraFile	(	tCIp	cip,
		tCISTRZ	camFN
	)

Load camera file data into the VFG driver data store.

The environment variable BITFLOW_INSTALL_DIRS must be set if path does not contain a '/'. If path contains a '/' then the fileName is relative to the current directory. If path begins with '/' then it is absolute.

If the path contains a '/' then the file name is case sensitive.

NOTE: This method only loads the configuration file data. It does not apply that data to the VFG registry, nor send any commands to the camera. Loaded data may be applied at a later time using CiVFGapplyCurrent.

Parameters

cip	this VFG
camFN	[path][mode@]fileName

◆ CiVFGloadConfig()

tCIRC CiVFGloadConfig	(	tCIp	cip,
		tCISTRZ	cfgFN
	)

Load configuration data into the VFG driver data store.

The environment variable BITFLOW_INSTALL_DIRS must be set

If kBFDEFAULTCFGFILE is used then the board DIP switches determine the appropriate config file.

NOTE: This method only loads the configuration file data. It does not apply that data to the VFG registry, nor send any commands to the camera. Loaded data may be applied at a later time using CiVFGapplyCurrent.

NOTE: Only the master interface on a VFG board can download firmware.

NOTE: All slave VFG camera files must be compatible w/master VFG.

Parameters

cip	this frame grabber
cfgFN	kBFDEFAULTCFGFILE -- or -- file within BITFLOW_INSTALL_DIRS -- or -- full path to config file

◆ CiVFGopen()

tCIRC CiVFGopen	(	tCIU32	devNdx,
		tCIU32	modeFlags,
		tCIp *	cip
	)

Open a VFG.

Parameters

devNdx	from CiSysVFGinfo()
modeFlags	access mode flags
cip	access token

◆ CiVFGqueryInfo()

tCIRC CiVFGqueryInfo	(	tCIp	cip,
		tCIU32 *	ifaceType,
		tCIU32 *	switches,
		tCIU32 *	devNdx,
		tCISTRZ	busName,
		tCIU32 *	infoHi,
		tCIU32 *	infoLo,
		tCISTRZ	VFGname,
		tCIU32 *	NUMAnode
	)

Return SysVFGinfo for open VFG.

Parameters

cip	this frame grabber
ifaceType	Neon, Karbon, etc.
switches	DIP switch value for board
devNdx	/dev/video<Ndx> access
busName	user-supplied storage (64 char)
infoHi	VFG INFOHI value
infoLo	VFG INFOLO value
VFGname	user supplied storage (64 char)
NUMAnode	node for this VFG

◆ CiVFGqueryState()

tCIRC CiVFGqueryState	(	tCIp	cip,
		tCIU32 *	state
	)

? Is frame grabber initialized ?

NOTE: State usrDMAerr indicates that the frame grabber initialized user DMA frame buffers and that both a) the initializing process has released the buffers and b) another thread/process has an active mmap() of the buffers The frame grabber will remain in this error state until all of the mmap() to the user DMA frame buffers are released.

NOTE: State dmaIsAborted indicates software aborted DMA because, e.g., SIP processing did not finish previous frame's DMA in time.

Parameters

cip	this frame grabber
state	return state information

◆ CiVFGtest()

tCIU8 CiVFGtest	(	tCIp	cip,
		tCIU32	trait,
		tCIU32	opt
	)

Test the VFG to determine whether or not it matches the trait.

On error, returns FALSE (0)

opt parameter is optional, and unused unless otherwise noted. Pass value 0, when unused.

Parameters

cip	this frame grabber
trait	tCIvfgTestTraitEnums trait to test
opt	optional parameter

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ CiBrdFileDescriptor

◆ CiBrdIndex

◆ CiBrdInitialize

◆ CiBrdInquire

◆ CiBrdInquire2

◆ CiBrdOpen

◆ CiBrdQueryInfo

◆ CiBrdQueryState

◆ CiSysBrdEnum

◆ CiSysBrdInfo

◆ CiSysBrdInfo2

◆ kBFDEFAULTCFGFILE

Typedef Documentation

◆ tCIVFGSEP

Enumeration Type Documentation

◆ tCIbitDepthOptionEnums

◆ tCIboardOpenEnums

◆ tCIboardQueryEnums

◆ tCIcamFileQueryEnums

◆ tCIcamTypeEnums

◆ tCIinitFlagsEnums

◆ tCImaxDevEnum

◆ tCIvfgTestTraitEnums

Function Documentation

◆ CiCamFileInquire()

◆ CiGetOpenCount()

◆ CiSetMaxDevices()

◆ CiSysFindLiveVFGs()

◆ CiSysGetVersions()

◆ CiSysVFGenum()

◆ CiSysVFGinfo()

◆ CiSysVFGinfo2()

◆ CiVFGapplyCameraFile()

◆ CiVFGapplyCurrent()

◆ CiVFGclose()

◆ CiVFGfileDescriptor()

◆ CiVFGindex()

◆ CiVFGinitialize()

◆ CiVFGinquire()

◆ CiVFGinquire2()

◆ CiVFGloadCameraFile()

◆ CiVFGloadConfig()

◆ CiVFGopen()

◆ CiVFGqueryInfo()

◆ CiVFGqueryState()

◆ CiVFGtest()