Folder Structure¶
The driver is distributed as a compressed linux tar file named BitFlow_linux_driver_vX.X.tar.bz2, where X.X is the distribution version code.
After you have downloaded the compressed tar file you should open a terminal window and create an empty directory somewhere on your file system. Change to this directory and type
$ cat BitFlow_linux_driver_vX.X.tar.bz2 | bunzip2 | tar xfBp -
where X.X is replaced by the version information of the file you have downloaded.
This document will assume you have extracted these files in to “/bitflow/driver”.
After this your directory will be populated with:
| /bitflow/driver | ├── 32b directory of x86 specific files | │ ├── bin tools for testing/exercising BitFlow frame grabbers | │ │ ├── AxionStats libBFciLib.a exercise tool; scriptable | │ │ ├── BFLogCollector utility to print BFLog SDK debug messages; src included in distribution | │ │ ├── CIcmdln libBFciLib.a exercise tool; scriptable | │ │ ├── CIeventMonitor utility to monitor CXP event packet and heartbeat signals | │ │ ├── CIexample frame grabber exerciser; src included in distribution | │ │ ├── CIpassive frame grabber accesser; src included in distribution | │ │ ├── CIsignalMonitor utility to monitor hi-level signals | │ │ ├── CIsimple frame grabber exerciser; src included in distribution | │ │ ├── CIsimpleCB consume-buffer exerciser; src included in distribution | │ │ ├── CIsimpleCBSIP consume-buffer+SIP exerciser; src included in dist | │ │ ├── CIsimpleSG scatter-gather exerciser; src included in distribution | │ │ ├── CIsimpleSIP start-stop processing (SIP); source included | │ │ ├── CIsimpleTwoVFG single camera data acquired by 2 VFG; source included | │ │ ├── CISOcmdln shared object library version of CIcmdln | │ │ ├── CISOexample shared object library version of CIexample | │ │ ├── CISOsimple shared object library version of CIsimple | │ │ ├── CISOsimpleCB shared object library version of CIsimpleCB | │ │ ├── CISOsimpleCBSIP shared object library version of CIsimpleCBSIP | │ │ ├── CISOsimpleSG shared object library version of CIsimpleSG | │ │ ├── CISOsimpleSIP shared object library version of CIsimpleSIP | │ │ ├── CytonStats display AonCXP, CtnCXP, ClxCXP, and ClxFXP info | │ │ └── SimpleCom CL serial comm; source included | │ └── lib lib archives for user executables and kernel modules | │ ├── libBFciLib.a library supporting user code access to BitFlow devices | │ ├── libBFmodule.o_shipped library supporting kernel-specific bitflow.ko modules | │ └── libBFSOciLib.9.103.so shared object version of libBFciLib.a | │ | ├── 64b directory of x86-64 specific files | │ ├── bin tools for testing/exercising BitFlow frame grabbers | │ │ ├── AxionStats libBFciLib.a exercise tool; scriptable | │ │ ├── BFLogCollector utility to print BFLog SDK debug messages; src included in distribution | │ │ ├── CIcmdln libBFciLib.a exercise tool; scriptable | │ │ ├── CIeventMonitor utility to monitor CXP event packet and heartbeat signals | │ │ ├── CIexample frame grabber exerciser; src included in distribution | │ │ ├── CIpassive frame grabber accesser; src included in distribution | │ │ ├── CIsignalMonitor utility to monitor hi-level signals | │ │ ├── CIsimple frame grabber exerciser; src included in distribution | │ │ ├── CIsimpleCB consume-buffer exerciser; src included in distribution | │ │ ├── CIsimpleCBSIP consume-buffer+SIP exerciser; src included in dist | │ │ ├── CIsimpleSG scatter-gather exerciser; src included in distribution | │ │ ├── CIsimpleSIP start-stop processing (SIP); source included | │ │ ├── CIsimpleTwoVFG single camera data acquired by 2 VFG; source included | │ │ ├── CISOcmdln shared object library version of CIcmdln | │ │ ├── CISOexample shared object library version of CIexample | │ │ ├── CISOsimple shared object library version of CIsimple | │ │ ├── CISOsimpleCB shared object library version of CIsimpleCB | │ │ ├── CISOsimpleCBSIP shared object library version of CIsimpleCBSIP | │ │ ├── CISOsimpleSG shared object library version of CIsimpleSG | │ │ ├── CISOsimpleSIP shared object library version of CIsimpleSIP | │ │ ├── CytonStats display AonCXP, CtnCXP, ClxCXP, and ClxFXP info | │ │ └── SimpleCom CL serial comm; source included | │ └── lib lib archives for user executables and kernel modules | │ ├── libBFciLib.a library supporting user code access to BitFlow devices | │ ├── libBFmodule.o_shipped library supporting kernel-specific bitflow.ko modules | │ └── libBFSOciLib.9.103.so shared object version of libBFciLib.a | │ | ├── camf frame grabber camera files | │ | ├── config frame grabber configuration files | │ | ├── drv files for building custom kernel modules | │ ├── bfgpud.c implementation for BitFlow interface to GPUD | │ ├── bfgpud.h declarations for BitFlow interface to GPUD | │ ├── bflki.c linux interface source code for BitFlow driver | │ ├── bflki.h linux interface declarations for BitFlow driver | │ ├── Makefile_32b Makefile for building kernel-specific bitflow.ko module | │ ├── Makefile_64b Makefile for building kernel-specific bitflow.ko module | │ └── Makefile_gpud build rules for GPUD compatible driver | │ | ├── fshf frame grabber firmware files | │ | ├── inc include files for frame grabber access | │ ├── BF_AonCXP_field.h AonCL-specific register field enumerates | │ ├── BF_AxnCL_field.h AxionCL-specific register field enumerates | │ ├── BFciLib.h include file for user program access to BitFlow devices | │ ├── BF_ClxCXP_field.h ClaxonCXP-specific register field enumerates | │ ├── BF_ClxFXP_field.h ClaxonFXP-specific register field enumerates | │ ├── BF_CtnCXP_field.h CytonCXP-specific register field enumerates | │ ├── BF_Karbon_field.h Karbon-specific register field enumerates | │ ├── BFLogIODef.h include file for BFLogIO definitions | │ ├── BFLogIOMessageApi.h include file for BFLogIO messages | │ ├── BFLogIOSyncApi.h include file for BFLogIO sync server | │ ├── BF_NeonDIF_field.h NeonDIF-specific register field enumerates | │ ├── BF_Neon_field.h Neon-specific register field enumerates | │ └── BFUniversalDef.h include file for cross platform definitions | │ | ├── src source files for example programs | │ ├── BFciDefault.c used by install script to set path for camf/config/fshf | │ ├── BFciDefault.h -likewise- | │ ├── BFLogCollector.cpp example file for BFLogIO message reading | │ ├── BFPCI2PCI.h DirectGMA and DMADirect interface | │ ├── CIeventMonitor.c example file for CXP event packet and heartbeat monitoring | │ ├── CIexample.c example file for BitFlow device access | │ ├── CIpassive.c example file for passive BitFlow device access | │ ├── CIsignalMonitor.c example file for hi-level signal monitoring | │ ├── CIsimple.c example file for BitFlow device access | │ ├── CIsimpleCB.c example file for BitFlow device access; consume-buffers | │ ├── CIsimpleCBSIP.c example file for BitFlow dev access; con-buf+SIP | │ ├── CIsimpleCLDGMA.c example which uses DirectGMA+OpenCL to clamp pixels | │ ├── CIsimpleCUDAGPUD.cu example which uses GPUDirect+CUDA to clamp pixels | │ ├── CIsimpleDGMA.c example which uses DirectGMA to DMA pixels to GPU | │ ├── CIsimpleFile.c example file for storing frames to file(s) | │ ├── CIsimpleGPUD.cu example which uses GPUDirect to DMA pixels to GPU | │ ├── CIsimpleSG.c example file for BitFlow dev access; scatter-gather | │ ├── CIsimpleSIP.c example file for BitFlow dev access; start-stop (SIP) | │ ├── CIsimpleTwoVFG.c example file for single camera data acquired by 2 VFG | │ ├── CIsimpleUserDMA.c example file for user-allocated DMA buffers | │ ├── CIsimpleUserDMAfile.c example file for storing frames to file(s) | │ ├── Makefile_32b Makefile for examples (static/.so) on 32b sys | │ ├── Makefile_64b Makefile for examples (static/.so) on 64b sys | │ ├── Makefile_DGMA makefile for DGMA | │ ├── Makefile_GPUD makefile for GPUD | │ └── SimpleCom.c basic interactive CL serial communication | │ | ├── install script to build/install BitFlow files | │ | └── README_dist README file
