bladeRF/host/libraries/libbladeRF
Rey Tucker 10d0f549b2
host: add bladerf_adf4002_{get,set}_refclk and related functionality (#15)
* host: libbladeRF: add functions to get/set ADF4002 refclk frequency

* host: bladeRF-cli: add print/set adf_refclk

* host: python: add adf4002_refclk functions

This permits getting and setting the ADF4002 reference clock
frequency.

>>> import bladerf
>>> b = bladerf.BladeRF()
ad9361_init : AD936x Rev 2 successfully initialized
>>> b.adf4002_refclk
10000000
>>> b.adf4002_refclk = 9000000
>>> b.adf4002_refclk
9000000
>>> b.adf4002_refclk = 900000000
[ERROR @
"/home/rtucker/dev/privatebladeRF/host/libraries/libbladeRF/src/board/bladerf2/bladerf2.c":4360]
bladerf_adf4002_set_refclk: bladerf_adf4002_calculate_ratio failed:
Provided parameter was out of the allowable range
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File
"/home/rtucker/dev/privatebladeRF/host/libraries/libbladeRF_bindings/python/bladerf.py",
line 1581, in set_adf4002_refclk
    _check_error(ret)
  File
"/home/rtucker/dev/privatebladeRF/host/libraries/libbladeRF_bindings/python/bladerf.py",
line 998, in _check_error
    raise globals()[errorval.name](err)
bladerf.RangeError: Provided parameter was out of the allowable range
>>> b.adf4002_refclk
9000000
>>> b.adf4002_refclk = 10000000
>>> b.adf4002_refclk
10000000

* host: libbladeRF: make ADF convenience functions static

bladerf_adf4002_set_refclk is much nicer (and safer) than calculating
the R/N ratio and then doing a bladerf_adf4002_configure.

* host: python: update cffi header block
2018-03-23 11:10:14 -04:00
..
doc libbladeRF: update docs and examples with new API 2017-12-21 12:55:04 -05:00
include host: add bladerf_adf4002_{get,set}_refclk and related functionality (#15) 2018-03-23 11:10:14 -04:00
src host: add bladerf_adf4002_{get,set}_refclk and related functionality (#15) 2018-03-23 11:10:14 -04:00
bladerf.rc.in libbladeRF: Updated some metadata files 2015-12-30 22:45:58 -05:00
CHANGELOG libbladeRF: bump API version and add changelog for v1.9.0 2017-12-07 21:26:28 -08:00
CMakeLists.txt host: libbladeRF: fix dependencies for doxygen 2018-03-15 18:24:07 -04:00
libbladeRF.pc.in libbladeRF: Updated some metadata files 2015-12-30 22:45:58 -05:00
README.md libbladeRF: Added API docs link to README 2016-06-29 11:42:22 -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

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.