bladeRF/host/libraries/libbladeRF
Jon Szymaniak ba561a4aa1 libbladeRF: Fixed race condition in TX buffer submission
It is possible that the buffer completion callback occurs before
advance_tx_buffer() acts upon a successful return code from
async_submit_stream_buffer().

We must ensure the buffer is in the IN_FLIGHT state before
we temporarily drop the buffer lock (so a stream lock can be acquired),
or else the assertion at sync_worker.c:150 may not be upheld.

Therefore, we default the buffer state to being IN_FLIGHT before
dropping the lock, and revert it to FULL if the buffer submission
fails (due to an error or a need to block in a non-blocking call).

This fixes #458. The associated defect was introduced in:
    6b197881 libbladeRF: Utilize all available TX buffers
2016-02-27 11:47:14 -05:00
..
doc libbladeRF/doc: Fixed link to forums 2016-01-12 13:50:46 -05:00
include libbladeRF: Updated to v1.5.1 2016-01-07 16:49:57 -05:00
src libbladeRF: Fixed race condition in TX buffer submission 2016-02-27 11:47:14 -05:00
bladerf.rc.in libbladeRF: Updated some metadata files 2015-12-30 22:45:58 -05:00
CHANGELOG libbladeRF: Updated to v1.5.1 2016-01-07 16:49:57 -05:00
CMakeLists.txt libbladeRF: Updated to v1.5.1 2016-01-07 16:49:57 -05:00
libbladeRF.pc.in libbladeRF: Updated some metadata files 2015-12-30 22:45:58 -05:00
README.md libbladeRF: Prepend installation prefix to file search paths 2015-07-22 12:06:05 -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_USB=<ON/OFF> Enables USB backends in libbladeRF. Default: ON
-DENABLE_BACKEND_LIBUSB=<ON/OFF> Enables libusb backend. Default: ON if libusb is available, OFF otherwise.
-DENABLE_BACKEND_CYAPI=<ON/OFF>a Enables (Windows-only) Cypress driver/library based backend. Default: ON if the FX3 SDK is available, OFF otherwise.
-DENABLE_BACKEND_DUMMY=<ON/OFF> Enables dummy backend support. Only useful for some developers. Default: OFF
-DENABLE_LIBBLADERF_LOGGING=<ON/OFF> Enable log messages. Default: ON
-DENABLE_LIBBLADERF_SYSLOG=<ON/OFF> Enable log messages to syslog (Linux/OSX) if ENABLE_LIBBLADERF_LOGGING is enabled. Default: OFF
-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
-DENABLE_USB_DEV_RESET_ON_OPEN=<ON/OFF> Enable USB port reset when opening a device. Defaults to ON for Linux, OFF otherwise.
-DLIBUSB_PATH=</path/to/libusb> Path to libusb files. This is generally only needed for Windows users who downloaded binary distributions.
-DLIBBLADERF_SEARCH_PREFIX_OVERRIDE=<path> Override path prefix used by libbladeRF to search for files (e.g., FPGA bitstreams). If not specified, ${CMAKE_INSTALL_PREFIX} is used as the default search prefix. This may be required when cross-compiling.