libbladerf-rs 0.4.0

Pure Rust driver for the Nuand BladeRF1 (x40/x115) SDR. No C libbladeRF dependency. USB transport via nusb. Supports Windows, macOS, and Linux.

Feature flags

* Enabled implicitly by xb100, xb200, or xb300.

Usage

The device is accessed through session types that switch the FX3 USB alternate setting and borrow &mut NiosCore. The borrow checker enforces exclusive access at compile time.

use libbladerf_rs::bladerf1::{BladeRf1, RfLinkSession, RxStream, SampleFormat};

let mut dev = BladeRf1::from_first()?;
let mut sess = dev.rf_link_session()?;
sess.initialize(false)?;

let mut rx = RxStream::builder(&mut sess)
    .buffer_size(65536)
    .buffer_count(8)
    .format(SampleFormat::Sc16Q11)
    .build()?;
rx.start(&mut sess)?;

let buf = rx.read(None)?;
println!("Got {} bytes", buf.len());
rx.recycle(buf);

rx.close(&mut sess)?;

Session types

FlashSession and ConfigSession return Error::StreamsActive if any stream is running.

Examples

Git-tracked examples (build and run from the repository root):

cargo run -p info
cargo run -p rx_tx

Supported features

• RF control: frequency (host/FPGA tuning, quick-tune), gain (per-stage apportioning, gain modes, gain stage control), sample rate (integer and rational), bandwidth, LPF mode, RF port selection
• Streaming: zero-copy DMA via BufferPool (RX/TX), metadata headers, multiple sample formats (Sc16Q11, Sc8Q7, Sc16Q11Packed, *Meta variants), pack/unpack helpers
• DC calibration: on-demand LMS6002D calibration, flash-stored JSON calibration tables with auto-load on open and frequency-specific apply
• Flash: erase/write/verify, calibration region (DAC trim, FPGA size)
• FPGA: host-based loading, flash autoload, source query, firmware log reading
• Expansion boards: XB-100 (GPIO/LED), XB-200 (filter bank, upconverter, auto filter), XB-300 (amplifier, TRX, output power)
• Other: SMB clock, VCTCXO tamer, triggers, loopback (LMS + FPGA), corrections (DC/phase), RX mux, retune scheduling, timestamps, firmware flashing

Not supported (vs C libbladeRF)

• BladeRF2 — stub only, not implemented
• Synchronous API — bladerf_sync_config/rx/tx not implemented
• Bootloader — jump to bootloader, load firmware from bootloader
• OTP (one-time programmable) — read/write/lock
• Image helpers — flash image allocate/free/read/write
• Byte-level flash — byte-addressed erase/read/write (page/sector only)
• Wishbone — master read/write
• USB reset on open — configuration option
• Multi-device / MIMO — clock sync helpers
• Tuning mode get — missing getter
• Gain calibration tables — bladeRF2-specific (not applicable to BladeRF1)

Developers

Contributions are welcome. The architecture is documented in AGENTS.md.

For debugging, compare USB traffic between libbladeRF and [libbladerf-rs] using Wireshark:

sudo usermod -a -G wireshark <your_user>
sudo modprobe usbmon
sudo setfacl -m u:<your_user>:r /dev/usbmon*

Filter example:

usb.bus_id == 1 and usb.device_address == 2

Datasheets

• SI5338 Datasheet
• SI5338 Reference Manual
• LMS6002D Datasheet
• LMS6002D Programming and Calibration Guide
• DAC161S055 Datasheet

Documentation

cargo doc --features bladerf1 --no-deps --lib --bins --examples

Testing

Unit tests (no hardware)

cargo test --lib
cargo test --test unit

Integration tests (requires BladeRF1)

cargo test --features bladerf1 --tests -- --test-threads=1

Specific test

cargo test --features bladerf1 --test bladerf1 -- frequency -- --test-threads=1