.. BitFlow Linux SDK documentation master file, created by
   sphinx-quickstart on Tue Feb 25 16:31:33 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

BitFlow Linux SDK Documentation
=============================================

This documentation is part of the **BitFlow Linux Driver Distribution Package**.

The driver works with x86 and x86-64 linux systems; other hardware platforms are not supported.

The driver supports BitFlow Neon, Karbon, Axion, Cyton, Aon and Claxon frame grabbers.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quickstart
   folderStructure
   installScript
   manualBuild
   firmwareAndCamFiles
   configFiles
   loadModule
   testing
   bft4lin
   notes

API Reference
===============

The API reference documentation can be found `here <https://www.bitflow.com/LinuxHelp/index.html>`_.

Distribution Compatibility
============================

.. |check_| raw:: html

    <input checked=""  disabled="" type="checkbox">

.. csv-table::
  :file: LinuxDistrosSupportList.csv
  :header-rows: 1


Kernel Compatibility
======================

The latest linux kernel tested with this SDK is kernel **6.12.28**.
   
Examples
==========

.. toctree::
   :maxdepth: 1
   :hidden:

   CIexample
   CIpassive
   CIsimple
   CIsimpleCB
   CIsimpleCBSIP
   CIsimpleSG
   CIsimpleSIP
   CIsimpleUserDMA
   CIsimpleFile
   CIsimpleUserDMAfile
   CIsimpleTwoVFG
   SimpleCom
   CIsimpleGPUD
   CIsimpleCUDAGPUD
   CIsimpleDGMA
   CIsimpleCLDGMA
   BFLogCollector
   CIeventMonitor
   CIsignalMonitor

* :doc:`CIexample`
* :doc:`CIpassive`
* :doc:`CIsimple`
* :doc:`CIsimpleCB`
* :doc:`CIsimpleCBSIP`
* :doc:`CIsimpleSG`
* :doc:`CIsimpleSIP`
* :doc:`CIsimpleUserDMA`
* :doc:`CIsimpleFile`
* :doc:`CIsimpleUserDMAfile`
* :doc:`CIsimpleTwoVFG`
* :doc:`SimpleCom`
* :doc:`CIsimpleGPUD`
* :doc:`CIsimpleCUDAGPUD`
* :doc:`CIsimpleDGMA`
* :doc:`CIsimpleCLDGMA`
* :doc:`BFLogCollector`
* :doc:`CIeventMonitor`
* :doc:`CIsignalMonitor`