Welcome to the UHD™ software distribution! UHD is the free & open-source software driver and API for the Universal Software Radio Peripheral (USRP™) SDR platform, created and sold by Ettus Research.

UHD supports all Ettus Research USRP™ hardware, including all motherboards and daughterboards, and the combinations thereof.

For technical documentation related to USRP™ hardware or UHD system design, check out the UHD and USRP Manual. That is where you can find Installation Instructions, help on how to build UHD from source on different platforms, development guidelines and reference documentation as well as device usage guidance.

Additionally, be sure to check out the Ettus Research FAQ, and the Knowledge Base for useful application notes and tutorials.

UHD is primarily developed on Linux, but we also test and support the following operating systems.

• Linux (Fedora and Ubuntu)
• Mac OS X (Intel)
• Windows 7

Other operating systems will most likely work, too, but are not officially supported.

UHD can be used to build stand-alone applications with USRP™ hardware, or with third-party applications. Some common toolkits / frameworks are:

• GNU Radio
• NI LabVIEW
• MathWorks Simulink
• REDHAWK
• OpenBTS GSM
• Osmocom GSM
• Amarisoft LTE
• Software Radio Systems LTE

host/

The source code for the user-space driver.

mpm/

The source code for the module peripheral manager (MPM). This is code that is run on embedded devices.

firmware/

The source code for all microprocessors in USRP hardware.

fpga-src/

The source code for the UHD FPGA images. Note this is a git submodule, if you are cloning the repository and want to modify the FPGA code, you will need to run 'git clone --recursive' to automatically populate this directory. Alternatively, you can run 'git submodule init' followed by 'git submodule update' to populate it after cloning the repository without '--recursive'.

Note that this subdirectory is very large, and not necessary for building applications that link against UHD.

images/

This contains the package builder for FPGA and firmware images. We provide other tools to download image packages, the scripts in here are mainly relevant for UHD maintainers and -developers.

tools/

Additional tools, mainly for debugging purposes. See the readme-file in that directory for more details on the individual tools.