bladeRF/host
Robert Ghilduta 09c8208778 libbladeRF: bump version to 2.6.0
v2.6.0 (2025-05-06)
--------------------------------

This version of libbladeRF is intended for use with:

  FX3 Firmware v2.6.0
  FPGA         v0.16.0

New Features:
 * Added SC16_Q11 packed sample format support, improving sample efficiency
 * Increased FX3 GPIF buffer sizes, significantly boosting USB throughput (~356MB/s)
 * Implemented dynamic Nios base address assignment based on RAM size
 * Added parallel build support for hosted FPGA variants (40, 115, A4, A5, A9)
 * Enabled elf-gdb and gdb-server support for improved FPGA debugging capability
 * Added git revision information to FPGA build outputs
 * bladeRF 2.0: Added support for gain calibration loading, enabling, and management
 * bladeRF 2.0: Introduced bladeRF-power CLI tool for managing gain calibration
 * bladeRF 2.0: Added bladerf_get_gain_target function for gain management
 * bladeRF 2.0: Added bladerf_format_to_string API call
 * bladeRF 2.0: Added bladerf_image_print_metadata API to display image metadata
 * bladeRF 2.0: Improved compatibility checking between FPGA and FX3 firmware GPIF buffers

Improvements:
 * libbladeRF now compiles and runs under MinGW and MSVC on Windows platforms
 * Replaced libpthreadswin32 dependency with native libbladeRF threading macros
 * Improved error handling and reporting for out-of-range frequency and sample rate settings
 * Added detailed logging for USB transfer and Nios access timeouts
 * Updated Doxygen to v1.9.8, adding support for light/dark modes and modernized configuration
 * Improved GPIF buffer alignment handling for larger FX3 buffer sizes
 * Added CMake find_package() support for easier integration into external projects
 * Streamlined internal error checking macros, simplifying codebase
 * Enhanced sync_rx_meta example with additional argument parsing and MIMO support
 * Improved FPGA simulations for bladeRF 1.0 and bladeRF 2.0 micro

Bug Fixes:
 * Fixed delayed sample and off-by-one timestamp issues on bladeRF 1.0
 * Corrected TX meta sample gap issue when timestamp set to META_NOW
 * Resolved corrupted UART buffer in command_uart component
 * Fixed TX deadlock scenarios by refactoring RX/TX DMA prioritization
 * Addressed SC16_Q11 packed RX discontinuity issue on overflow condition
 * Fixed false timing paths and resolved multiple timing violations
 * Fixed calibration load check in bladerf_get_gain_calibration
 * Corrected RX meta packet timestamp and flags assignment
 * Fixed sync TX initialization bug

Miscellaneous:
 * Updated API documentation to reflect larger GPIF buffer sizes
 * Improved FX3 SDK setup instructions in README
 * Minor typo and documentation corrections throughout the codebase
2025-05-11 04:22:46 -07:00
..
cmake host: finish off cross-platform support for Windows 2025-04-24 04:36:36 -07:00
common host: final pthread migration to make linux compile 2025-04-24 04:36:36 -07:00
drivers host: windows/cyusb3: add bladeRF 2.0 PIDs to .inf 2017-12-21 12:55:07 -05:00
examples bladeRF-cli: added sc16q11 packed mimo tx example 2025-04-09 23:17:40 -07:00
libraries libbladeRF: bump version to 2.6.0 2025-05-11 04:22:46 -07:00
misc host: clean up windows build script, remove pthreads 2025-04-24 04:36:36 -07:00
utilities bladeRF-cli: bump version to 1.10.0 2025-05-11 04:17:01 -07:00
CMakeLists.txt host: begin removing libpthreadswin32 from cmakes 2025-04-24 04:36:36 -07:00
README.md host: clean up README, and misc files to indicate remove libpthreadswin32 2025-04-24 04:36:36 -07:00

bladeRF Host Source

This directory contains the items outlined in the following table. Note that this structure includes some items planned for future development.

Directory Description
cmake CMake scripts and modules
drivers Device drivers for supported operating systems
libraries The main bladeRF support library and supplemental libraries
misc Miscellaneous files
utilities Applications and tools

Dependencies

libusb

libusb and its development headers are required. >= v1.0.16 is recommended for Linux, and >= v1.0.19 is recommended for Windows.

Ideally, the latest released version is always recommended. Please see the libusb ChangeLog for more information.

(Optional) FX3 SDK - Windows-only

Windows users that wish to use a Cypress driver/library based libbladeRF backend will need to download and install the Cypress FX3 SDK.

CMake

CMake is used to build the items in this directory. >= v2.8.5 is required, but the latest available version is recommended.

Build

Linux and OSX

From this directory, create a build directory. This is personal preference, of course. It allows for all build files to be cleaned up via a single rm -r build/ command.

Next, run cmake to configure the build, followed by make and sudo make install to build and install libraries and applications.

mkdir -p build
cd build
cmake [options] ../
make
sudo make install
sudo ldconfig

Fedora Note: By default, libbladeRF will install to /usr/local/{lib,lib64}, which is not listed in /etc/ld.so.conf. On these systems, it is recommended to create a /etc/ld.so.conf.d/local.conf specifying these directories:

sudo tee /etc/ld.so.conf.d/local.conf <<EOF
/usr/local/lib
/usr/local/lib64
EOF

Then, run sudo ldconfig again.

Windows

This process was most recently validated on Windows 10 Enterprise with CMake 3.9.0, libusb 1.0.21, and Microsoft Visual Studio Community 2017 (Version 15.2).

bladeRF

  • Create a build directory under host
  • Run the CMake GUI, pointing the source location to this host directory and the build directory to the build directory you just created.
  • Click the CMake GUI's "Configure" button. Select the Visual Studio version installed on your system when prompted for a "generator."
    • If you run into any failures, check these items, then re-run Configure:
      • LIBUSB_PATH (and ENABLE_BACKEND_LIBUSB) - for using libusb
      • FX3_SDK_PATH (and ENABLE_BACKEND_CYAPI) - for using the Cypress driver
  • Adjust options as desired and re-run the "Configure" command as needed. Values in red are new, and should be reviewed before running "Configure" again to get the red out.
  • Click the CMake GUI's "Generate" button.
  • In the build directory, a Visual Studio solution will now exist. You can click "Open Project" to get there.
  • Build the solution (right-click Solution 'bladeRF' and click "Build Solution")
  • Upon building the solution, build artifacts will be present in: build\output\<build type>
    • <build_type> may refer to Debug or Release, for example

CMake Options and Flags

Below is a list of useful and project-specific CMake options. Please see the CMake documentation for more information.

Option Description
-DCMAKE_INSTALL_PREFIX=</prefix/path> Override system-specific path to install output files. Default depends on system; see cmake -L
-DCMAKE_BUILD_TYPE=<type> Set to "Debug" to enable a debug build. Default: "Release"
-DBUILD_DOCUMENTATION=<ON/OFF> Build libbladeRF API documentation and manpages for utilities. Default: OFF
-DCMAKE_C_COMPILER=<compiler> Specify the compiler to use. Otherwise, CMake will determine a default.
-DENABLE_GDB_EXTENSIONS=<ON/OFF> GCC & GDB users may want to set this to use -ggdb3 instead of -g. Default: OFF
-DENABLE_BACKEND_LIBUSB=<ON/OFF> Enables libusb backend in libbladeRF. Default: ON if libusb is available, OFF otherwise.
-DENABLE_BACKEND_CYAPI=<ON/OFF>a Enables (Windows-only) Cypress driver/library based backend in libbladeRF. Default: ON if the FX3 SDK is available, OFF otherwise.
-DENABLE_BACKEND_DUMMY=<ON/OFF> Enables dummy backend support in libbladeRF. Only useful for some developers. Default: OFF
-DENABLE_LIBTECLA=<ON/OFF> Enable libtecla support in the bladeRF-cli program. Default: ON if libtecla is detected, OFF otherwise.
-DINSTALL_UDEV_RULES=<ON/OFF> Install udev rules to /etc/udev/rules.d/. Default: ON for Linux, OFF default otherwise.
-DUDEV_RULES_PATH=</path/to/udev/rules> Override the path for installing udev rules. Default: /etc/udev/rules.d
-DBLADERF_GROUP=<group> Sets the group associated with the bladeRF in the installed udev rules. Default: plugdev
-DTREAT_WARNINGS_AS_ERRORS=<ON/OFF> Treat compiler warnings as errors. Contributors should keep this enabled. Default: ON
-DENABLE_LOG_FILE_INFO=<ON/OFF> Enable source file and line number information in log messages. Default: ON