mirror of https://github.com/saymrwulf/uhd.git synced 2026-05-16 21:10:10 +00:00

The USRP™ Hardware Driver Repository

Find a file

Brent Stapleton 601e0ed87b examples: utils: skip formatting program options Turning off clang formatting around the program option declarations. clang-format makes them looks bad an unreadable because it thinks the options are function calls or something.		2019-01-16 11:40:23 -08:00
.github	Github: Create Pull Request Template	2018-12-19 16:44:16 -08:00
firmware	cmake: Update coding style to use lowercase commands	2018-11-14 14:10:09 -08:00
fpga-src@f2151e8101	fpga: update images and submodule pointer	2019-01-02 17:25:13 -08:00
host	examples: utils: skip formatting program options	2019-01-16 11:40:23 -08:00
images	fpga: update images and submodule pointer	2019-01-02 17:25:13 -08:00
mpm	rh: general code cleanup	2019-01-10 09:50:16 -08:00
tools	Debian: Minor change to convert_changelog.py	2019-01-09 17:48:13 -08:00
.clang-format	uhd: add .clang-format file	2018-11-12 11:29:38 -08:00
.gitignore	Ignore .pyc files	2016-04-22 18:14:10 -07:00
.gitmodules	Merge branch 'maint'	2015-01-27 09:10:05 +01:00
CHANGELOG	CHANGELOG: Cherry-pick changes from UHD-3.13 branch	2019-01-09 17:41:18 -08:00
CODING.md	coding guidelines: change URLs to hyperlinks	2019-01-02 17:26:42 -08:00
CONTRIBUTING.md	Update README.md, LICENSE.md, and CONTRIBUTING.md	2018-06-26 08:56:32 -07:00
LICENSE.md	Update README.md, LICENSE.md, and CONTRIBUTING.md	2018-06-26 08:56:32 -07:00
README.md	Update README.md, LICENSE.md, and CONTRIBUTING.md	2018-06-26 08:56:32 -07:00

README.md

USRP Hardware Driver (UHD™) Software

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.

Documentation

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.

OS Support

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.

Applications

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

Directories

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.