v2.0.1 (2018-08-24)
--------------------------------
This version of libbladeRF is intended for use with:
FX3 Firmware v2.2.0
FPGA v0.7.3
This release contains minor fixes since v2.0.0.
Note to bladeRF2 users: If you are using bladerf_{get,set}_clock_select(),
please note that the enum for bladerf_clock_select has changed.
CLOCK_SELECT_VCTCXO has been replaced with CLOCK_SELECT_ONBOARD.
Changes:
* FreeBSD build fixes (#561)
* 32-bit architecture fixes (#573)
* Detect and handle a bladeRF Micro that is running old firmware to allow
re-flashing without recovery mode (#578)
* bladeRF1: bladerf_set_gain_mode returning BLADERF_ERR_UNSUPPORTED is no
longer fatal (#542)
* bladeRF1: only check AGC DC LUT setting when enabling AGC
* bladeRF1: typo fix in set_tx_gain (#580)
* xb200: check for null xb_data before dereferencing it (#575)
* bladeRF2: cache factory trimdac value at initialization; preserve trimdac
disable state on bladerf2_trim_dac_write (#582)
* bladeRF2: bladerf_clock_select: replace CLOCK_SELECT_VCTCXO with
CLOCK_SELECT_ONBOARD for clarity (#585)
* Improvements to the release notes (#583)
* bladeRF-cli: Add 200 ms delay before probing PLL lock status (#587)
* Windows: add a nanosleep() shim (#589)
|
||
|---|---|---|
| .. | ||
| doc | ||
| include | ||
| src | ||
| bladerf.rc.in | ||
| CHANGELOG | ||
| CMakeLists.txt | ||
| libbladeRF.pc.in | ||
| README.md | ||
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
Please see the CHANGELOG file for a summary of changes across libbladeRF versions.
Documentation
For more information, one can generate and view the API 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.
This API documentation is available online at: https://nuand.com/libbladeRF-doc
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. |