bladeRF/host
Jon Szymaniak 625694eaa5 license: License changes on various portions of the codebase
Where possible (and with contributor permission), items have been
changed to LGPLv2.1 or MIT licenses to avoid issues with any proprietary
libraries from vendors (HDL and FW), allow static linking (with headless
mode operation in mind), and to generally present users with more
permissive licenses.

File headers and the COPYING have been updated accordingly. Third party
sources have been either removed, replaced, or relocated in the source
tree, in accordance with the licenses decided upon for each part of the tree.

Contributor Assignment Agreements have been added, and it is required
that these be submitted before significant patches and pull requests
are accepted.
2013-10-27 00:17:35 -04:00
..
cmake license: License changes on various portions of the codebase 2013-10-27 00:17:35 -04:00
common license: License changes on various portions of the codebase 2013-10-27 00:17:35 -04:00
drivers/linux license: License changes on various portions of the codebase 2013-10-27 00:17:35 -04:00
libraries license: License changes on various portions of the codebase 2013-10-27 00:17:35 -04:00
misc udev: Default install option to sane default (Linux=ON, else=FALSE) 2013-10-21 23:32:59 -04:00
utilities license: License changes on various portions of the codebase 2013-10-27 00:17:35 -04:00
CMakeLists.txt cmake: Copyright/attibution cleanup 2013-10-21 21:00:15 -04:00
README.md misc: Group associated with device in udev rule is now configurable 2013-10-19 11:01:20 -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-1.0 and its development headers are required. >= v1.0.12 is recommended for Linux, and >= v1.0.13 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.3 is required.

Ubuntu/Debian:

sudo apt-get install libusb-1.0.0 libusb-1.0.0-dev cmake

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 variable list in CMake's documentation for more information.

Option Description
-DCMAKE_BUILD_TYPE=<type> Set to "Debug" to enable a debug build. "Release" is the default.
-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. Disabled by default.
-DENABLE_BACKEND_LIBUSB=<ON/OFF> Enables libusb backend in libbladeRF. Enabled by default.
-DENABLE_BACKEND_LINUX_DRIVER=<ON/OFF> Enables Linux driver in libbladeRF. Disabled by default.
-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.
-DBLADERF_GROUP=<group> Sets the group associated with the bladeRF in the installed udev rules. The default is plugdev.