0cc18f7e8b
This adds two tools to the ./tools/ subdirectory:
== clang-formatter.sh ==
This is simply a small shell script that can be executed from the top of
the UHD repository, and it will format all files according the the
.clang-format file. It can be executed as such:
$ CLANG_FORMAT=clang-format-14 ./tools/clang-formatter.sh apply
Specifying a clang-format executable is optional, but note that
clang-format 14.0 should be used.
== run-clang-format.py ==
This is a Python script that is a modified version from
https://github.com/gnuradio/clang-format-lint-action/blob/ \
0b0cb14cf220a070d2a8b2610bd74ad1546252a1/run-clang-format.py
It was modified to add --patch-file option.
Alongside this file is a .clang-format-ignore file, which is sourced
from this script. The command can be run as such:
$ ./tools/run-clang-format.py \
--clang-format-executable clang-format-14 \
--extensions c,cpp,h,hpp,hpp.in,ipp \
-r \
--patch-file format.patch \
/path/to/uhd-repo
It will provide both a nice output summary as well as a patch file that
can be consumed with `patch -p0 < format.patch`.
|
||
|---|---|---|
| .ci | ||
| .github | ||
| firmware | ||
| fpga | ||
| host | ||
| images | ||
| mpm | ||
| tools | ||
| .clang-format | ||
| .clang-format-ignore | ||
| .clang-tidy | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .readthedocs.yaml | ||
| CHANGELOG | ||
| CODING.md | ||
| CONTRIBUTING.md | ||
| LICENSE.md | ||
| 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 10
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:
- GNU Radio
- NI LabVIEW
- MathWorks Matlab and Simulink
- REDHAWK
- OpenBTS GSM
- Osmocom GSM
- Amarisoft LTE
- Software Radio Systems srsRAN
- Eurecom OpenAirInterface
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/
The source code for the UHD FPGA images.
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.