FindLibUSB.cmake now fetches the libusb version via libusb_get_version()
so that we can warn (or error out) about the system containing an
outdated libusb version.
The following policies have been based upon support experiences and the
libusb changelog:
Windows: Error out for libusb < 1.0.19
v1.0.19 provides Windows 8 SuperSpeed detection support,
and appears to address a number of issues bladeRF users
have reported with v1.0.18 and earlier.
We force users to update here, given that some of the failures
on earlier versions were yielding corrupted samples.
OSX: Warn for libusb < 1.0.18:
v1.0.16 - v1.0.18 introduced SuperSpeed and 64-bit support,
as well as fixes for compile-time and run-time issues.
Linux: Warn for libusb < 1.0.16:
This is largely based upon feedback from bladeRF users. While
older versions may work, a number of users reported that issues
appeared to be resolved after updating libusb to >= 1.0.16.
(It isn't always clear if the reported update included Linux
distro upgrades that included kernel updates.)
The version check may be skipped via LIBUSB_SKIP_VERSION_CHECK=Yes.
This is intentionally not noted in the warnings/errors, as it's
preferred that users update libusb rather than just skip the check.
|
||
|---|---|---|
| .. | ||
| cmake | ||
| common | ||
| drivers | ||
| libraries | ||
| misc | ||
| utilities | ||
| CMakeLists.txt | ||
| README.md | ||
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 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
Windows
- Create a build directory
- Run the CMake GUI, pointing the source location to this
hostdirectory and the build directory to thebuilddirectory 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, ensure items such as LIBUSB_PATH are defined correctly, and re-run after updating them.
- Adjust options as desired and re-run the "Configure" command as needed.
- Click the CMake GUI's "Generate" button.
- In the
builddirectory, a Visual Studio solution will now exist. - 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 |