bladeRF/host
Jon Szymaniak 513ad1bcd5 host: Removed extraneous configure_file() from CMakeLists.txt
This appears to have been a copy+paste error introduced in 4f0808a6.
2014-08-13 20:52:48 -04:00
..
cmake cmake: Defaulted Windows LIBUSB_PATH to libusb-1.0.19 2014-07-22 23:26:58 -04:00
common libbladeRF: Introduced thread-safety to the API 2014-08-02 19:22:49 -04:00
drivers/linux driver/linux: Updated README.md 2014-07-05 12:20:10 -04:00
libraries libbladeRF: update README cmake options 2014-08-03 14:49:03 -04:00
misc host/misc: Added a Windows build script 2014-07-22 02:10:04 -04:00
utilities bladeRF-cli: some minor doc cleanup 2014-07-27 20:36:29 -04:00
CMakeLists.txt host: Removed extraneous configure_file() from CMakeLists.txt 2014-08-13 20:52:48 -04:00
README.md host: Corrected libusb ChangeLog link in README.md 2014-07-27 13:47:31 -04: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.

CMake

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

Build

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

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

Option Description
-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.
-DCMAKE_INSTALL_PREFIX=</prefix/path> Override system-specific path to install output files. Default depends on system; see cmake -L
-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
-DENABLE_BACKEND_USB=<ON/OFF> Enables USB backends in libbladeRF. Default: ON
-DENABLE_BACKEND_LINUX_DRIVER=<ON/OFF> Enables Linux driver in libbladeRF. Default: OFF
-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: OFF