Miscellaneous

Data Structures
union	tCIdiagStruct

Typedefs
typedef void(*	tCIstrDisplayF) (char *fmt,...)

Enumerations
enum	tCIszCTABenum { kCIszCTAB = 16 }

Functions
tCIRC	CiSetDebug (tCIp cip, int drvDebug, tCIstrDisplayF dispFunc)
tCIRC	CiSetDebugCL (tCIp cip, tCIstrDisplayF dispFunc)
	Allow debug display of all CameraLink init, term, and i/o. More...
tCIRC	CiDriverLog (tCIp cip, tCIU32 level, char *str)
	String to system log via driver. More...
tCIRC	CiReadHWrev (tCIp cip, char *str)
	Get the hardware revision string for this VFG (if it exists). More...
tCIRC	CiReadSerialNo (tCIp cip, char *str)
	Get the board serial number for this VFG (if it exists). More...
tCIRC	CiLoadFirmware (tCIp cip, char *fName)
	Load a specific firmware file to VFG. More...
tCIRC	CiConfigROI (tCIU32 devNdx, tCIU32 hROIoffset, tCIU32 hROIsize, tCIU32 vROIoffset, tCIU32 vROIsize)
	Attempt to configure for xawtv. More...
tCIRC	CiConfigROI2 (tCIU32 devNdx, tCIU32 nBuff, tCIU32 hROIoffset, tCIU32 hROIsize, tCIU32 vROIoffset, tCIU32 vROIsize)
	Attempt to config for xawtv(v4l2). More...
tCIRC	CiVerifyCIP (tCIp cip)
	Check integrity of token. More...
tCISTRZ	CiErrStr (tCIRC circ)
	Text description of error code. More...
tCISTRZ	CiFmtStr (int fmtCode)
	Text description of format code. More...
tCIRC	CiGetDiag (tCIp cip, tCIdiagStruct *ds)
	Retrieve diagnostic information. More...
tCIRC	CiReadCTABcompressed (tCIp cip, tCIU32 horizVERT, tCIU32 *data)
	Read the compressed CTAB information. More...
tCIRC	CiWriteCTABcompressed (tCIp cip, tCIU32 horizVERT, tCIU32 *data)
	Write the compressed CTAB information. More...

Detailed Description

 The driver debug levels range from 0 (no debug) up with higher levels
 providing more verbose output.  A value of -1 signals no change to the
 current driver debug level.

 The bitflow.ko driver sends this debug information to the system log.

 WARNING!   Extreme debug logging (values > 2) implements a delay on each
                    log statement.  The user process may seem to be "hung" but
                    there is no error: the OS is logging a flood of strings.



 The BFciLib library sends strings to a printf() style display function

Typedef Documentation

tCIstrDisplayF

typedef void(* tCIstrDisplayF) (char *fmt,...)

Enumeration Type Documentation

tCIszCTABenum

enum tCIszCTABenum

Enumerator
kCIszCTAB	length of compressed CTAB

Function Documentation

CiConfigROI()

tCIRC CiConfigROI	(	tCIU32	devNdx,
		tCIU32	hROIoffset,
		tCIU32	hROIsize,
		tCIU32	vROIoffset,
		tCIU32	vROIsize
	)

Attempt to configure for xawtv.

This call will reconfigure the interface for a NxM window with 8 bits per pixel. The window is is offset by hOffset and vOffset.

This is intended to support xawtv (v4l1) display from the camera.

Parameters

devNdx	from CiSysVFGinfo()
hROIoffset	skipped pixels at start of line
hROIsize	horizontal pixels count
vROIoffset	skipped lines at start of frame
vROIsize	vertical pixel count

CiConfigROI2()

tCIRC CiConfigROI2	(	tCIU32	devNdx,
		tCIU32	nBuff,
		tCIU32	hROIoffset,
		tCIU32	hROIsize,
		tCIU32	vROIoffset,
		tCIU32	vROIsize
	)

Attempt to config for xawtv(v4l2).

This call will reconfigure the interface for a NxM window with 8 bits per pixel. The window is is offset by hOffset and vOffset.

This is intended to support xawtv (v4l2) display from the camera.

Parameters

devNdx	from CiSysVFGinfo()
nBuff	number of DMA buffers
hROIoffset	skipped pixels at start of line
hROIsize	horizontal pixels count
vROIoffset	skipped lines at start of frame
vROIsize	vertical pixel count

CiDriverLog()

tCIRC CiDriverLog	(	tCIp	cip,
		tCIU32	level,
		char *	str
	)

String to system log via driver.

Parameters

cip	this frame grabber
level	iff driver debug >= this value
str	this string

CiErrStr()

tCISTRZ CiErrStr

(

tCIRC

circ

)

Text description of error code.

CiFmtStr()

tCISTRZ CiFmtStr

(

int

fmtCode

)

Text description of format code.

CiGetDiag()

tCIRC CiGetDiag	(	tCIp	cip,
		tCIdiagStruct *	ds
	)

Retrieve diagnostic information.

Parameters

cip	this frame grabber
ds	info to here

CiLoadFirmware()

tCIRC CiLoadFirmware	(	tCIp	cip,
		char *	fName
	)

Load a specific firmware file to VFG.

Parameters

cip	this frame grabber board
fName	this firmware file

CiReadCTABcompressed()

tCIRC CiReadCTABcompressed	(	tCIp	cip,
		tCIU32	horizVERT,
		tCIU32 *	data
	)

Read the compressed CTAB information.

Parameters

cip	this VFG
horizVERT	0 for H-CTAB, else V-CTAB
data	put data here (kCIszCTAB len)

CiReadHWrev()

tCIRC CiReadHWrev	(	tCIp	cip,
		char *	str
	)

Get the hardware revision string for this VFG (if it exists).

Parameters

cip	this frame grabber
str	caller's storage (32 bytes min)

CiReadSerialNo()

tCIRC CiReadSerialNo	(	tCIp	cip,
		char *	str
	)

Get the board serial number for this VFG (if it exists).

Parameters

cip	this frame grabber
str	caller's storage (32 bytes min)

CiSetDebug()

tCIRC CiSetDebug	(	tCIp	cip,
		int	drvDebug,
		tCIstrDisplayF	dispFunc
	)

• For library and driver.

Parameters

cip	this frame grabber
drvDebug	driver debug level (0 default)
dispFunc	library debug display

CiSetDebugCL()

tCIRC CiSetDebugCL	(	tCIp	cip,
		tCIstrDisplayF	dispFunc
	)

Allow debug display of all CameraLink init, term, and i/o.

Parameters

cip	this VFG
dispFunc	library debug display for CL

CiVerifyCIP()

tCIRC CiVerifyCIP

(

tCIp

cip

)

Check integrity of token.

CiWriteCTABcompressed()

tCIRC CiWriteCTABcompressed	(	tCIp	cip,
		tCIU32	horizVERT,
		tCIU32 *	data
	)

Write the compressed CTAB information.

Parameters

cip	this VFG
horizVERT	0 for H-CTAB, else V-CTAB
data	data from here (kCIszCTAB len)