libbladeRF  2.4.0-git
Nuand bladeRF library
API Sections
libbladeRF is divided into the following sections. Click one of these section names to view information about the macros, enumerations, data structures, and functions within the section.
[detail level 1234]
 InitializationThe functions in this section provide the ability query and inspect available devices, initialize them, and deinitialize them
 Device propertiesThese functions provide the ability to query various pieces of information from an attached device
 Channel controlThe RX and TX channels are independently configurable. As such, many libbladeRF functions require a bladerf_channel parameter to specify the desired channel
 GainThese functions provide control over the device's RX and TX gain stages
 Sample rateThis section presents functionality pertaining to configuring the sample rate and mode of the device's RX and TX channels
 BandwidthThis section defines functionality for configuring a channel's bandwidth. In most cases, one should define the bandwidth to be less than the sample rate to minimize the impact of aliasing
 FrequencyThese functions provide the ability to tune the RX and TX channels
 Internal loopbackThe bladeRF provides a variety of loopback modes to aid in development and testing
 TriggersTrigger functionality introduced in bladeRF FPGA v0.6.0 allows TX and/or RX samples to be gated via a trigger signal. This allows multiple devices to synchronize their TX/RX operations upon the reception of a trigger event
 Receive MuxThese functions are thread-safe
 Scheduled TuningThese functions are thread-safe
 CorrectionThis group provides routines for applying manual offset, gain, and phase corrections
 StreamingThis section defines the streaming APIs
 FormatsThis section defines the available sample formats and metadata flags
 Metadata structure and flags
 Synchronous APIThis group of functions presents synchronous, blocking calls (with optional timeouts) for transmitting and receiving samples
 Asynchronous APIThis interface gives the API user full control over the stream and buffer management, at the cost of added complexity
 Firmware and FPGAThese functions provide the ability to load and program devices on the bladeRF board
 Flash image formatThis section contains a file format and associated routines for storing and loading flash contents with metadata
 Flash image format constants
 Low-level FunctionsThis section defines low-level APIs
 VCTCXO Tamer ModeThis group provides routines for controlling the VTCTXO tamer
 VCTCXO Trim DACThese functions provide the ability to manipulate the VCTCXO Trim DAC
 Tuning ModeThese functions provide the ability to select the tuning mode
 Trigger ControlThese functions provide the ability to read and write the trigger control registers
 Configuration GPIOThese functions provide the ability to read and write the configuration GPIO
 SPI FlashThese functions provide the ability to erase, read, and write the SPI flash
 RF PortsThese functions provide the ability to select various RF ports for RX and TX channels. This is normally handled automatically
 Expansion board supportThis group of functions provides the ability to attach and detach expansion boards
 LoggingThis section contains various helper/utility functions for library logging facilities
 Library version
 Error codesBladeRF library routines return negative values to indicate errors. Values >= 0 are used to indicate success
 bladeRF1-specific APIThese functions are thread-safe
 Constants (deprecated)
 Flash image format constants
 Gain stages (deprecated)These functions provide control over the device's RX and TX gain stages
 Sampling MuxThese functions provide control over internal and direct sampling modes of the LMS6002D
 LPF BypassThese functions provide control over the LPF bypass mode of the LMS6002D
 SMB clock port controlThe SMB clock port (J62) may be used to synchronize sampling on multiple devices, or to generate an arbitrary clock output for a different device
 Expansion I/OThese definitions and functions provide high-level functionality for manipulating pins on the bladeRF1 U74 Expansion Header, and the associated mappings on expansion boards
 Expansion board supportThis group of functions provides the ability to control and configure expansion boards such as the XB-100, XB-200, and XB-300
 DC CalibrationThese functions are thread-safe
 Low-level accessorsIn a most cases, higher-level routines should be used. These routines are only intended to support development and testing
 bladeRF2-specific APIThese functions are thread-safe
 Bias Tee Control
 Low-level accessorsIn most cases, higher-level routines should be used. These routines are only intended to support development and testing
 RF Integrated Circuit
 Phase Detector/Freq. Synth ControlReference: http://www.analog.com/media/en/technical-documentation/data-sheets/ADF4002.pdf
 Power Multiplexer
 Clock Buffer
 Clock input selection
 Clock output control
 Power Monitoring
 RF Switching Control