bladeRF/host/libraries/libbladeRF
Ryan Tucker 15c689c935 libbladeRF: update README cmake options
Build flags changed with 7b0cc24f, so updating README.md
accordingly.
2014-08-03 14:49:03 -04:00
..
doc/doxygen libbladeRF: Re-implemented sync interface, updated API docs, renamed timeout function 2014-03-08 19:55:21 -05:00
include libbladeRF: Introduced thread-safety to the API 2014-08-02 19:22:49 -04:00
src libbladeRF: Moved system gain functions, deadlock fix 2014-08-02 23:55:45 -04:00
tests libbladeRF_test_ctrl: Added threaded test 2014-08-02 19:25:15 -04:00
bladerf.rc.in libbladeRF: Added windows resource file with version information 2014-03-12 00:11:05 -04:00
CHANGELOG libbladeRF: Bumped patch version (v0.16.2) 2014-07-24 20:27:03 -04:00
CMakeLists.txt libbladeRF: Moved system gain functions, deadlock fix 2014-08-02 23:55:45 -04:00
libbladeRF.pc.in libbladeRF & bladeRF-CLI: Fixed build issues. Moved backend config info. 2013-08-13 23:44:42 -04:00
README.md libbladeRF: update README cmake options 2014-08-03 14:49:03 -04:00

bladeRF Library (libbladeRF)

This is the source for the library which interacts with the bladeRF device.

It is meant to be used as a simple and intuitive way to think about not just the bladeRF device itself, but most any radio hardware. Fundamental operations such as setting the tuning frequency, manipulating switches on the board for different paths, and changing the different transmit and receive gains are all parts of a radio system which need to be exposed at a library level.

Functionality provided by this library includes:

  • Opening/closing devices and querying information about them
  • Tuning to various frequencies
  • Configuring the sample rate
  • Configuring the bandwidth and gain of the RF chain
  • Configuring RF gains
  • Transmitting and receiving complex baseband samples
  • Updating the device's firmware and FPGA
  • Low-level access to on-board devices, for testing and debugging

For more information, please generate and view the doxygen documentation. From your host/build directory, run:

cmake -DBUILD_DOCUMENTATION=ON ../
make libbladeRF-doxygen

The HTML documentation will be placed in <build dir>/libraries/libbladerf/doc/doxygen/html. The index.html file is the "main" documentation page.

Please see the CHANGELOG file for a summary of changes across libbladeRF versions.

Build Variables

Below is a list of useful and project-specific CMake options. Please see the CMake [variable list] in CMake's documentation for more information.

Option Description
-DBUILD_LIBBLADERF_DOCUMENTATION=<ON/OFF> Builds API documentation using Doxygen. Default: equal to BUILD_DOCUMENTATION
-DENABLE_BACKEND_LIBUSB=<ON/OFF> Enables libusb backend in libbladeRF. Default: ON
-DENABLE_BACKEND_USB=<ON/OFF> Enables USB backends in libbladeRF. Default: ON
-DENABLE_BACKEND_LINUX_DRIVER=<ON/OFF> Enables Linux driver in libbladeRF. Default: OFF
-DENABLE_BACKEND_DUMMY=<ON/OFF> Enables dummy backend support in libbladeRF. Only useful for some developers. Default: OFF
-DENABLE_LIBBLADERF_LOGGING=<ON/OFF> Enable log messages in libbladeRF. Default: ON
-DENABLE_LIBBLADERF_SYNC_LOG_VERBOSE=<ON/OFF> Enable log_verbose() calls in the sync interface's data path. Note that this may harm performance. Default: OFF
-DENABLE_LOCK_CHECKS=<ON/OFF> Enable checks for lock acquistion failures (e.g., deadlock). Default: OFF
-DLIBUSB_DETACH_KERNEL_DRIVER=<ON/OFF> Enable calls to libusb_detach_kernel_driver(). Not supported in Windows. Default: ON
-DLIBUSB_PATH=</path/to/libusb> Path to libusb files. (This is generally only needed for Windows users who downloaded binary distributions.)