bladeRF/host
Jon Szymaniak ff0fcecda2 libbladeRF: Flash interface cleanup and flash-related API changes
Performed cleanup and reorganization of flash-related code. The following
items have been changed in the libbladeRF API:

 - Fixed "sector" vs "erase block" misnomer. While the SPI flash on the
   bladeRF has "sectors", these are not the units actually being used
   in the firmware to perform erase operations. As such, the API and
   underlying code has been updated to perform erases in terms of the
   "erase block" unit.

 - Renamed bladerf_program_flash_unaligned() to
   bladerf_write_flash_unaligned() for consistency.

 - Flash-related API calls now only return 0 on success, or a
   BLADERF_ERR_* value upon failure. They no longer return the number of
   bytes read/written/erased. This is intended to be more consistent
   with the rest of the API. The requested size of the read/erase/write
   is guaranteed to be performed at requested size, so returning a byte
   count merely complicates the API "contract" and offers no usefulness.

 - To erase the FPGA stored in SPI flash for autoloading, a new
   function, bladerf_erase_stored_fpga(), has been introduced. This
   replaces the use of bladerf_flash_fpga(dev, "X").

Internally, the following changes have been made:

 - All flash-related code has been moved to flash.c (e.g., from bladerf.c).
   This is part of the ongoing effort to move logic out of bladerf.c and
   into the associated module, with the intent of the bladerf.c
   "API top-level" of only acquiring a per-device lock (in the future)
   and delegate actions to the module implementations.

 - Backend flash operations are now in units of erase blocks and pages,
   to alleviate backend code needing to deal with conversions.
2014-05-06 21:59:42 -04:00
..
cmake host: Added check for libc version 2014-03-08 03:05:03 -05:00
common libbladeRF: Refactored backend i/f to allow for new USB drivers 2014-05-06 21:59:41 -04:00
drivers/linux linux driver: fix RX routines 2014-04-29 05:57:27 -04:00
libraries libbladeRF: Flash interface cleanup and flash-related API changes 2014-05-06 21:59:42 -04:00
misc udev: Default install option to sane default (Linux=ON, else=FALSE) 2013-10-21 23:32:59 -04:00
utilities libbladeRF: add GPIO direction support to expansion board 2014-04-01 22:41:29 -07:00
CMakeLists.txt libbladeRF: Include required OSX common/ directory items in build 2014-03-08 19:55:22 -05:00
README.md host: Updated README.md to include CMake TREAT_WARNINGS_AS_ERRORS option 2013-11-24 17:08:13 -05: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
-DENABLE_HOST_BUILD=<ON/OFF> Enables building of the Host components overall. Default is ON.
-DCMAKE_BUILD_TYPE=<type> Set to "Debug" to enable a debug build. "Release" is the default.
-DBUILD_DOCUMENTATION=<ON/OFF> Build libbladeRF API documentation and manpages for utilities. OFF by 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.
-DTREAT_WARNINGS_AS_ERRORS=<Yes/No> Treat compiler warnings as errors, defaults to Yes. Contributors should keep this enabled.