USRP Hardware Driver and USRP Manual

https://files.ettus.com/manual/
Admin
The USRP Hardware Driver (UHD) provides an API for connecting to and controlling Ettus Research...
Tokens:463,957
Snippets:4,833
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### ModelSim/Questa Not Found Error

Source: https://files.ettus.com/manual/usrp3_sim_running_testbenches.html

Example output when the environment setup script fails to locate ModelSim or Questa.

```text
Setting up a 64-bit FPGA build environment for the USRP-X3x0...
- Vivado: Found (/opt/Xilinx/Vivado/2019.1/bin)
- ModelSim/Questa: Not found! (WARNING: Simulations with ModelSim/Questa might not work!)

Environment successfully initialized.
```

```text
Setting up a 64-bit FPGA build environment for the USRP-X3x0...
- Vivado: Found (/opt/Xilinx/Vivado/2019.1/bin)

Environment successfully initialized.
```

--------------------------------

### Build and Install UHD

Source: https://files.ettus.com/manual/page_build_guide.html

Compile the source code, run optional tests, and install the binaries to the system.

```bash
make
make test # This step is optional
sudo make install
```

--------------------------------

### Query UHD installation configuration

Source: https://files.ettus.com/manual/page_usrp_x4xx.html

Displays all UHD configuration information, including the installation path for pre-built images.

```bash
uhd_config_info --print-all
```

--------------------------------

### Install ni-usrp-rio Package

Source: https://files.ettus.com/manual/page_ni_rio_kernel.html

Install the NI USRP RIO driver package.

```bash
dnf install ni-usrp-rio
```

```bash
apt install ni-usrp-rio
```

--------------------------------

### Configure Custom ModelSim Path

Source: https://files.ettus.com/manual/usrp3_sim_running_testbenches.html

Use this command if the setup script fails to automatically detect the simulator installation path.

```bash
$ source <repo>/fpga/usrp3/top/<product>/setupenv.sh --modelsim-path=/path/to/modelsim
```

--------------------------------

### Install build dependencies on Ubuntu

Source: https://files.ettus.com/manual/page_build_guide.html

Use apt-get to install the necessary development libraries and tools for building UHD on Ubuntu systems.

```bash
sudo apt-get install autoconf automake build-essential ccache cmake cpufrequtils doxygen ethtool \
g++ git inetutils-tools libboost-all-dev libncurses5 libncurses5-dev libusb-1.0-0 libusb-1.0-0-dev \
libusb-dev python3-dev python3-mako python3-numpy python3-requests python3-scipy python3-setuptools \
python3-ruamel.yaml 
```

--------------------------------

### Install Compiled UHD

Source: https://files.ettus.com/manual/page_build_guide.html

Install the successfully compiled UHD binaries to the system.

```bash
$ sudo make install
```

--------------------------------

### Install Repository Package

Source: https://files.ettus.com/manual/page_ni_rio_kernel.html

Install the NI driver repository package for your specific Linux distribution.

```bash
rpm -i {ni drivers repository}.rpm
```

```bash
dpkg -i {ni drivers repository}.deb
```

--------------------------------

### Install Kernel Headers

Source: https://files.ettus.com/manual/page_ni_rio_kernel.html

Install the necessary kernel headers required for building the NI RIO kernel modules.

```bash
dnf install kernel-devel
```

```bash
apt install linux-headers-$(uname -r)
```

--------------------------------

### Install Xcode Command Line Tools

Source: https://files.ettus.com/manual/page_build_guide.html

Command to trigger the installation of Xcode Command Line Tools via the terminal.

```bash
xcode-select --install
```

--------------------------------

### SSH prompt example

Source: https://files.ettus.com/manual/page_usrp_x4xx.html

The expected command prompt after successfully logging into the device.

```text
root@ni-x4xx-1234ABC:~#
```

--------------------------------

### Install Mako via pip3

Source: https://files.ettus.com/manual/page_build_guide.html

Command to install the Mako template library using pip3 on Windows systems.

```bash
pip3 install mako
```

--------------------------------

### Install Build Dependencies on Linux

Source: https://files.ettus.com/manual/gen3_fpga_build.html

Commands to install required build utilities for B200 images on Ubuntu/Debian and Fedora systems.

```bash
sudo apt-get install python3 bash build-essential doxygen # Ubuntu, Debian
sudo dnf -y install python bash make doxygen # Fedora
```

--------------------------------

### Install DPDK on Debian-based systems

Source: https://files.ettus.com/manual/page_dpdk.html

Use the package manager to install DPDK and development headers on supported Debian or Ubuntu distributions.

```bash
sudo apt install dpdk dpdk-dev
```

--------------------------------

### Install UHD Python API via Poetry

Source: https://files.ettus.com/manual/page_python.html

Use this command within the build directory to install the Python API as a package using poetry.

```bash
cd <build directory>\python
<python> -m poetry install
```

--------------------------------

### init()

Source: https://files.ettus.com/manual/classuhd_1_1rfnoc_1_1mb__controller.html

Initializes the motherboard controller.

```APIDOC
### Method
void init()

### Description
Performs necessary motherboard initializations that must occur after block initialization.
```

--------------------------------

### List FPGA build options

Source: https://files.ettus.com/manual/gen3_fpga_build.html

Displays available build targets and options for X410 and X440 devices.

```bash
make help
```

--------------------------------

### Vivado Path Error Message

Source: https://files.ettus.com/manual/usrp3_sim_running_testbenches.html

Example of the error message displayed when Vivado is not found during environment setup.

```text
Vivado: Not found! (ERROR.. Builds and simulations will not work)
```

--------------------------------

### Configure USRP Device via Command Line Arguments

Source: https://files.ettus.com/manual/page_configuration.html

Example of passing device type and master clock rate settings to the rx_samples_to_file utility.

```bash
$ rx_samples_to_file --args type=b200,master_clock_rate=16e6
```

--------------------------------

### Define a test case

Source: https://files.ettus.com/manual/usrp3_sim_legacy_testbenches.html

Example of wrapping a test case with start and done macros, including packet validation.

```SystemVerilog
`TEST_CASE_START("Fill up empty FIFO then drain (short packet)");
  chdr_o.axis.tready = 0;
  chdr_i.push_ramp_pkt(16, 64'd0, 64'h100, header);
  chdr_o.axis.tready = 1;
  chdr_o.wait_for_pkt_get_info(header_out, stats);
  `ASSERT_ERROR(stats.count==16,            "Bad packet: Length mismatch");
  `ASSERT_ERROR(header.sid==header_out.sid, "Bad packet: Wrong SID");
  `ASSERT_ERROR(chdr_i.axis.tready,         "Bus not ready");
`TEST_CASE_DONE(1);
```

--------------------------------

### Unpack the SDK

Source: https://files.ettus.com/manual/page_usrp_e3xx.html

Execute the SDK installer script after navigating to the directory where the image files are stored.

```bash
$ cd /usr/local/share/uhd/images # Change this to where your images are stored
$ ./oecore-x86_64-cortexa9hf-neon-toolchain-nodistro.0.sh
```

--------------------------------

### Install UHD Python Package

Source: https://files.ettus.com/manual/page_install_binary.html

Commands to identify the installed UHD version and install the corresponding Python wheel.

```bash
<UHD Install Dir>\bin\uhd_config_info.exe --version #find the version of UHD
<python> -m pip install uhd==<version_from_config_info> #install matching wheel
```

--------------------------------

### Configure USRP3 Simulation Environment

Source: https://files.ettus.com/manual/usrp3_sim_running_testbenches.html

Execute the setup script to initialize the environment variables required for the specific USRP product.

```bash
$ source <repo>/fpga/usrp3/top/<product>/setupenv.sh
```

--------------------------------

### Verify Firmware Installation

Source: https://files.ettus.com/manual/page_octoclock.html

Expected output from uhd_find_devices after successful firmware installation.

```text
--------------------------------------------------
-- UHD Device 0
--------------------------------------------------
Device Address:
    addr: 192.168.10.3
    type: octoclock
    name:
    serial:
```

--------------------------------

### Initialize Build Environment

Source: https://files.ettus.com/manual/gen3_fpga_build.html

Run this script to set up the environment variables required for executing direct make targets.

```bash
source ./setupenv.sh
```

--------------------------------

### Receive samples to file in Python

Source: https://files.ettus.com/manual/page_python.html

Example of using the convenience API to acquire a specific number of samples and write them to a file.

```python
import uhd
def recv_to_file():
"""RX samples and write to file"""
usrp = uhd.usrp.MultiUSRP("type=b200")
num_samps = 1e6
if not isinstance(args.channels, list):
args.channels = [args.channels]
samps = usrp.recv_num_samps(
1e6, # Number of samples
2.4e9, # Frequency in Hz
1e6, # Sampling rate
[0], # Receive on channel 0
80, # 80 dB of RX gain
)
samps.tofile('samples.dat')
```

--------------------------------

### Property Definitions

Source: https://files.ettus.com/manual/mock__nodes_8hpp_source.html

Example of defining global properties for a node.

```cpp
property_t<double> _samp_rate_in{
"samp_rate", DEFAULT_RATE, {res_source_info::INPUT_EDGE}};
property_t<double> _samp_rate_out{
"samp_rate", DEFAULT_RATE, {res_source_info::OUTPUT_EDGE}};
property_t<int> _decim{"decim", DEFAULT_DECIM, {res_source_info::USER}};
```

--------------------------------

### Setting properties with instance overrides

Source: https://files.ettus.com/manual/classuhd_1_1rfnoc_1_1node__t.html

Demonstrates how to set multiple properties at once, including the use of the instance parameter and the colon-delimited override syntax for specific property instances.

```cpp
node->set_properties("dog=10,cat:2=5,bird:0=0.5", 1)
```

--------------------------------

### Install Digilent Drivers

Source: https://files.ettus.com/manual/page_usrp_x3x0.html

Execute the Digilent driver installation script for Vivado on Linux.

```bash
sudo `find /opt/Xilinx/Vivado/<Version> -name install_digilent.sh`
```

--------------------------------

### View uhd_image_loader help

Source: https://files.ettus.com/manual/page_usrp_e3xx.html

Display all available command line options for the FPGA image loader.

```bash
$ uhd_image_loader --help
```

--------------------------------

### Install AVRDude on Linux

Source: https://files.ettus.com/manual/page_octoclock.html

Commands to install the AVRDude utility on Ubuntu or Fedora systems.

```bash
sudo apt-get install avrdude
```

```bash
sudo yum install avrdude
```

--------------------------------

### Install UHD via MacPorts

Source: https://files.ettus.com/manual/page_install_binary.html

Installs the stable version of UHD and all required dependencies.

```bash
sudo port install uhd
```

--------------------------------

### Install Python curses package

Source: https://files.ettus.com/manual/page_build_guide.html

Command to install the curses package using the pip module.

```bash
python3 -m pip3 install python_curses-2.2.3-cp310-cp310-win_amd64.whl
```

--------------------------------

### Set Time Source Usage Example

Source: https://files.ettus.com/manual/classuhd_1_1rfnoc_1_1mb__controller.html

Demonstrates setting the time source and notes that subsequent calls with the same value may return immediately without reconfiguring hardware.

```cpp
auto usrp = uhd::usrp::multi_usrp::make(device_args);
// This may or may not cause the hardware to reconfigure, depending on
// the default state of the device
usrp->set_time_source("internal");
// Now, the time source is definitely set to "internal"!
// The next call probably won't do anything but will return immediately,
// because the time source was already set to "internal"
usrp->set_time_source("internal");
// The time source is still guaranteed to be "internal" at this point
```

--------------------------------

### Install UHD via Fedora Package Manager

Source: https://files.ettus.com/manual/page_install_binary.html

Installs UHD and development files on Fedora systems.

```bash
sudo yum install uhd uhd-devel
```

--------------------------------

### Enable Salt Minion at Boot

Source: https://files.ettus.com/manual/page_usrp_n3xx.html

Command to configure the Salt minion service to start automatically upon system boot.

```bash
$ systemctl enable salt-minion
```

--------------------------------

### Configure Grub for IOMMU and Hugepages

Source: https://files.ettus.com/manual/page_dpdk.html

Add these parameters to the Grub configuration to enable IOMMU and allocate hugepages at boot.

```text
iommu=pt intel_iommu=on hugepages=2048
```

--------------------------------

### Verify UHD Installation

Source: https://files.ettus.com/manual/page_install_binary.html

Check if the UHD module is correctly installed by attempting to import it in a Python shell.

```python
<python>
>>> import uhd
```

--------------------------------

### Set clock source usage example

Source: https://files.ettus.com/manual/classuhd_1_1rfnoc_1_1mb__controller.html

Demonstrates how to set the clock source and notes that redundant calls may return immediately without reconfiguring hardware.

```cpp
auto usrp = uhd::usrp::multi_usrp::make(device_args);
// This may or may not cause the hardware to reconfigure, depending on
// the default state of the device
usrp->set_clock_source("internal");
// Now, the clock source is definitely set to "internal"!
// The next call probably won't do anything but will return immediately,
// because the clock source was already set to "internal"
usrp->set_clock_source("internal");
// The clock source is still guaranteed to be "internal" at this point
```

--------------------------------

### Configure CMake with Custom Install Prefix

Source: https://files.ettus.com/manual/page_build_guide.html

Pass the CMAKE_INSTALL_PREFIX variable to specify a custom installation directory.

```bash
cmake -DCMAKE_INSTALL_PREFIX=/opt/uhd ../
```

--------------------------------

### Initialize SDK Environment

Source: https://files.ettus.com/manual/page_usrp_e3xx.html

Run this command in a new shell to configure environment variables like PATH, CC, and CXX for cross-compilation.

```bash
$ . $SDKPATH/environment-setup-armv7ahf-vfp-neon-oe-linux-gnueabi
```

--------------------------------

### Install UHD with PyBOMBS

Source: https://files.ettus.com/manual/page_build_guide.html

Use this command to install UHD and its dependencies automatically via the PyBOMBS tool.

```bash
$ pybombs install uhd
```

--------------------------------

### Install Python wheel package

Source: https://files.ettus.com/manual/page_build_guide.html

Command to install the wheel package required for managing Python distributions.

```bash
pip3 install wheel
```

--------------------------------

### initialize_dboards

Source: https://files.ettus.com/manual/classuhd_1_1usrp_1_1dboard__manager.html

Initializes the daughterboards.

```APIDOC
## virtual void initialize_dboards()

### Description
Executes daughterboard post-constructor initializations if they were deferred during the make process.
```

--------------------------------

### Fedora Network Configuration File

Source: https://files.ettus.com/manual/page_usrp_x3x0_config.html

Example configuration file for a network interface on Fedora systems.

```text
/etc/sysconfig/network-scripts/
```

```text
TYPE="Ethernet"
BOOTPROTO="none"
IPADDR0="192.168.10.1"
DEFROUTE="yes"
IPV4_FAILURE_FATAL="no"
IPV6INIT="no"
IPV6_FAILURE_FATAL="no"
NAME="em1"
UUID="<specific to your device>"
ONBOOT="no"
HWADDR"<specific to your device>"
PEERDNS="yes"
PEERROUTES="yes"
ZONE="trusted"
MTU="9000"
NM_MANAGED="no"
```

--------------------------------

### Soft Register Usage Example

Source: https://files.ettus.com/manual/soft__register_8hpp_source.html

Example of defining a custom register class using UHD_DEFINE_SOFT_REG_FIELD and initializing it.

```cpp
class example_reg_t : public soft_reg32_wo_sync_t (or soft_reg32_wo_t) {
public:
//===Define all the fields===
UHD_DEFINE_SOFT_REG_FIELD(FIELD0, 1, 0); //[0]
UHD_DEFINE_SOFT_REG_FIELD(FIELD1, 15, 1); //[15:1]
UHD_DEFINE_SOFT_REG_FIELD(FIELD2, 16, 16); //[31:16]

example_reg_t(): //ctor with no args
soft_reg32_wo_t(SR_CORE_EXAMPLE_REG_OFFSET)) //===Bind to offset===
{
//===Set Initial values===
set(FIELD0, 0);
set(FIELD1, 1);
set(FIELD2, 0xFFFF);
}
};

void main() {
example_reg_t reg_obj;
reg_obj.initialize(iface);
reg_obj.write(example_reg_t::FIELD2, 0x1234);

example_reg_t::sptr reg_sptr = std::make_shared<example_reg_t>();
reg_obj->initialize(iface);
reg_obj->write(example_reg_t::FIELD2, 0x1234);
}
```

--------------------------------

### Manage Salt Minion Service

Source: https://files.ettus.com/manual/page_usrp_e3xx.html

Start or enable the Salt minion service on the device.

```bash
$ systemctl start salt-minion
```

```bash
$ systemctl enable salt-minion
```

--------------------------------

### Install UHD Python API via Pip

Source: https://files.ettus.com/manual/page_python.html

Install the generated wheel file directly using pip.

```bash
<python> -m pip install <build directory>\python\dist\uhd-4.x.x-cp3xx-cp3xx-win_amd64.whl
```

--------------------------------

### Run standard calibration utilities

Source: https://files.ettus.com/manual/page_calibration.html

Execute these commands from the command line to perform IQ balance and DC offset calibration. Ensure all external hardware is disconnected from RF antenna ports before running.

```bash
uhd_cal_rx_iq_balance --verbose --args=<optional device args>
uhd_cal_tx_iq_balance --verbose --args=<optional device args>
uhd_cal_tx_dc_offset --verbose --args=<optional device args>
```

--------------------------------

### Perform RX Streaming in Python

Source: https://files.ettus.com/manual/page_stream.html

Demonstrates initializing a MultiUSRP, configuring stream arguments, issuing a continuous stream command, and receiving samples in a loop.

```python
import uhd
import numpy as np
usrp = uhd.usrp.MultiUSRP("type=x300")
stream_args = uhd.usrp.StreamArgs("fc32", "sc16")
stream_args.args = "spp=200" # Note this setting is not valid for all USRPs
rx_streamer = usrp.get_rx_stream(stream_args)
rx_metadata = uhd.types.RXMetadata()
recv_buffer = np.zeros(rx_streamer.get_max_num_samps(), dtype=np.complex64)
stream_cmd = uhd.types.StreamCMD(uhd.types.StreamMode.start_cont)
stream_cmd.stream_now = True
rx_streamer.issue_stream_cmd(stream_cmd)
while run_condition:
samps = rx_streamer.recv(recv_buffer, rx_metadata)
stream_cmd = uhd.types.StreamCMD(uhd.types.StreamMode.stop_cont)
rx_streamer.issue_stream_cmd(stream_cmd)
```

--------------------------------

### device::make

Source: https://files.ettus.com/manual/classuhd_1_1device.html

Creates a new device instance from a device address hint.

```APIDOC
## static sptr make(const device_addr_t &hint, device_filter_t filter=ANY, size_t which=0)

### Description
Creates and returns a new device instance based on the provided address hint.

### Parameters
- **hint** (device_addr_t) - Required - The device address hint.
- **filter** (device_filter_t) - Optional - The device type filter.
- **which** (size_t) - Optional - The index of the device to create.
```

--------------------------------

### View EEPROM Keys

Source: https://files.ettus.com/manual/page_usrp2.html

Example output from the probe utility showing device EEPROM configuration.

```text
Mboard: N210r4
 hardware: 2577
 mac-addr: a0:36:fa:25:34:a7
 ip-addr: 192.168.10.4
 subnet: 255.255.255.255
 gateway: 255.255.255.255
 gpsdo: none
 serial: EAR14U7UP
```

--------------------------------

### Install UHD via Debian/Ubuntu Package Manager

Source: https://files.ettus.com/manual/page_install_binary.html

Installs the base UHD library, headers, and utilities on Debian-based systems.

```bash
sudo apt-get install libuhd-dev uhd-host
```

--------------------------------

### make

Source: https://files.ettus.com/manual/classuhd_1_1usrp_1_1multi__usrp.html

Creates a new instance of the multi_usrp device.

```APIDOC
## static sptr make(const device_addr_t &dev_addr)

### Description
Creates a new instance of the multi_usrp device using the provided device address.

### Parameters
- **dev_addr** (device_addr_t) - Required - The device address configuration.
```

--------------------------------

### Perform TX Streaming in Python

Source: https://files.ettus.com/manual/page_stream.html

Demonstrates initializing a MultiUSRP, configuring stream arguments, and continuously sending data buffers to the device.

```python
import uhd
import numpy as np
usrp = uhd.usrp.MultiUSRP("type=x300")
stream_args = uhd.usrp.StreamArgs("fc32", "sc16")
stream_args.args = "spp=200" # Note this setting is not valid for all USRPs
tx_streamer = usrp.get_tx_stream(stream_args)
tx_metadata = uhd.types.TXMetadata()
tx_buffer = np.zeros(1000000, dtype=np.complex64)
while True:
samps = tx_streamer.send(tx_buffer, tx_metadata)
```

--------------------------------

### Install UHD via Ubuntu PPA

Source: https://files.ettus.com/manual/page_install_binary.html

Adds the Ettus Research PPA to receive package updates and installs the UHD software.

```bash
sudo add-apt-repository ppa:ettusresearch/uhd
sudo apt-get update
sudo apt-get install libuhd-dev uhd-host
```

--------------------------------

### Download and use a custom manifest file

Source: https://files.ettus.com/manual/page_usrp_x4xx.html

Fetch the latest manifest from the UHD repository and use it to download the most recent filesystem version.

```bash
$ wget https://raw.githubusercontent.com/EttusResearch/uhd/master/images/manifest.txt
```

```bash
$ uhd_images_downloader -t mender -t x4xx -m manifest.txt
```

--------------------------------

### Run benchmark_rate for USRP X3x0 and E3xx

Source: https://files.ettus.com/manual/page_rdtesting.html

Example commands for executing the benchmark_rate utility on X3x0 and E3xx series devices.

```bash
benchmark_rate --tx_rate 1e6 --rx_rate 1e6 --channels 0,1 --duration 120
```

```bash
benchmark_rate --args="master_clock_rate=10e6" --tx_rate 1e6 --rx_rate 1e6 --channels 0,1 --duration 120
```

--------------------------------

### Install Python dependencies on Windows

Source: https://files.ettus.com/manual/page_build_guide.html

Commands to install required Python packages using pip3 within the Python scripts directory.

```bash
pip3 install requests
pip3 install numpy
pip3 install ruamel.yaml
pip3 install setuptools
pip3 install poetry
```

--------------------------------

### Configure N3xx Device Arguments

Source: https://files.ettus.com/manual/page_usrp_n3xx.html

Example configuration for uhd.conf to set gain profiles and custom band edges for N3xx devices.

```ini
[type=n3xx]
rx_gain_profile=default_rf_filter_bypass_always_off
tx_gain_profile=default_rf_filter_bypass_always_on
rx_band_map=0.0;431e6;601e6;1051e6;1601e6;2101e6;2701e6
tx_band_map=0.0;723.18e6;1623.18e6;3323.18e6
#  In this example, the second Rx band would start at 431 MHz.
```

--------------------------------

### UHD Python Import Error Example

Source: https://files.ettus.com/manual/page_python.html

Example of the error message encountered when DLL dependencies are not found on Windows with Python 3.8+.

```text
ImportError: DLL load failed while importing libpyuhd: The specified module could not be found.
```

--------------------------------

### Configuring and Using stream_args_t

Source: https://files.ettus.com/manual/structuhd_1_1stream__args__t.html

Demonstrates initializing a stream_args_t object, setting channels, and configuring optional arguments before creating an RX streamer.

```cpp
// 1. Create the stream args object and initialize the data formats to fc32 and sc16:
uhd::stream_args_t stream_args("fc32", "sc16");
// 2. Set the channel list, we want 3 streamers coming from channels
// 0, 1 and 2, in that order:
stream_args.channels = {0, 1, 2};
// 3. Set optional args:
stream_args.args["spp"] = "200"; // 200 samples per packet
// Now use these args to create an rx streamer:
// (We assume that usrp is a valid uhd::usrp::multi_usrp)
uhd::rx_streamer::sptr rx_stream = usrp->get_rx_stream(stream_args);
// Now, any calls to rx_stream must provide a vector of 3 buffers,
// one per channel.
```

--------------------------------

### Install build dependencies on Fedora

Source: https://files.ettus.com/manual/page_build_guide.html

Use yum or dnf to install the necessary development libraries and tools for building UHD on Fedora systems.

```bash
sudo yum -y install boost-devel libusb1-devel doxygen python3-docutils python3-mako python3-numpy python3-requests python3-ruamel-yaml python3-setuptools cmake make gcc gcc-c++
```

```bash
sudo dnf -y install boost-devel libusb1-devel doxygen python3-docutils python3-mako python3-numpy python3-requests python3-ruamel-yaml python3-setuptools cmake make gcc gcc-c++
```

--------------------------------

### Build UHD via Visual Studio Command Line

Source: https://files.ettus.com/manual/page_build_guide.html

Commands to build the project and install it using the Visual Studio command line interface.

```bash
cd <uhd-repo-path>\host\build
DevEnv uhd.sln /build Release /project ALL_BUILD
DevEnv uhd.sln /build Release /project INSTALL
```

--------------------------------

### Legacy SystemVerilog Testbench Example

Source: https://files.ettus.com/manual/usrp3_sim_legacy_testbenches.html

A sample testbench utilizing legacy simulation macros for clock/reset definition and test case management.

```SystemVerilog
//
// Copyright 2015 Ettus Research LLC
//

`timescale 1ns/1ps
`define NS_PER_TICK     1
`define NUM_TEST_CASES  3

`include "sim_clks_rsts.vh"
`include "sim_exec_report.vh"
`include "sim_cvita_lib.sv"

module example_fifo_tb();
  `TEST_BENCH_INIT("example_fifo_tb",`NUM_TEST_CASES,`NS_PER_TICK)

  // Define all clocks and resets
  `DEFINE_CLK(bus_clk, 1000/166.6667, 50) //166MHz bus_clk
  `DEFINE_RESET(bus_rst, 0, 100)          //100ns for GSR to deassert

  cvita_stream_t chdr_i (.clk(bus_clk));
  cvita_stream_t chdr_o (.clk(bus_clk));

  // Initialize DUT
  axi_fifo #(.WIDTH(65), .SIZE(24)) dut_single (
    .clk(bus_clk),
    .reset(bus_rst),
    .clear(1'b0),

    .i_tdata({chdr_i.axis.tlast, chdr_i.axis.tdata}),
    .i_tvalid(chdr_i.axis.tvalid),
    .i_tready(chdr_i.axis.tready),

    .o_tdata({chdr_o.axis.tlast, chdr_o.axis.tdata}),
    .o_tvalid(chdr_o.axis.tvalid),
    .o_tready(chdr_o.axis.tready),

    .space(),
    .occupied()
  );

  //Testbench variables
  cvita_hdr_t   header, header_out;
  cvita_stats_t stats;

  //------------------------------------------
  //Main thread for testbench execution
  //------------------------------------------
  initial begin : tb_main

    `TEST_CASE_START("Wait for reset");
    while (bus_rst) @(posedge bus_clk);
    `TEST_CASE_DONE((~bus_rst));

    repeat (200) @(posedge bus_clk);

    header = '{
      pkt_type:DATA, has_time:0, eob:0, seqno:12'h666,
      length:0, sid:$random, timestamp:64'h0};

    `TEST_CASE_START("Fill up empty FIFO then drain (short packet)");
      chdr_o.axis.tready = 0;
      chdr_i.push_ramp_pkt(16, 64'd0, 64'h100, header);
      chdr_o.axis.tready = 1;
      chdr_o.wait_for_pkt_get_info(header_out, stats);
      `ASSERT_ERROR(stats.count==16,            "Bad packet: Length mismatch");
      `ASSERT_ERROR(header.sid==header_out.sid, "Bad packet: Wrong SID");
      `ASSERT_ERROR(chdr_i.axis.tready,         "Bus not ready");
    `TEST_CASE_DONE(1);

    header = '{
      pkt_type:DATA, has_time:1, eob:0, seqno:12'h666, 
      length:0, sid:$random, timestamp:64'h0};

    `TEST_CASE_START("Concurrent read and write (single packet)");
      chdr_o.axis.tready = 1;
      fork
          begin
            chdr_i.push_ramp_pkt(20, 64'd0, 64'h100, header);
          end
          begin
            chdr_o.wait_for_pkt_get_info(header_out, stats);
          end
      join
    `ASSERT_ERROR(stats.count==20,      "Bad packet: Length mismatch");
    `TEST_CASE_DONE(1);
  end
endmodule
```

--------------------------------

### Install Build Dependencies on Windows via Cygwin

Source: https://files.ettus.com/manual/gen3_fpga_build.html

Required packages to select during the Cygwin GUI installation process for Windows build support.

```bash
python3 patch patchutils bash make gcc-core doxygen
```

--------------------------------

### Configure CPU Governor on Ubuntu

Source: https://files.ettus.com/manual/page_usrp_x3x0_config.html

Commands to install cpufrequtils, set the governor to performance, and restart the service.

```bash
sudo apt-get install cpufrequtils
```

```bash
sed -i s/^GOVERNOR=.*$/GOVERNOR="performance"/g /etc/init.d/cpufrequtils > /etc/init.d/cpufrequtils
```

```bash
sudo /etc/init.d/cpufrequtils restart
```

--------------------------------

### Install UHD Development Version via MacPorts

Source: https://files.ettus.com/manual/page_install_binary.html

Installs the latest development version of UHD. Note that this is considered beta software and may contain bugs.

```bash
sudo port install uhd-devel
```

--------------------------------

### Load FPGA and Firmware Images

Source: https://files.ettus.com/manual/page_usrp2.html

Use the image loader utility to flash firmware and FPGA images to the device.

```bash
uhd_image_loader --args="type=usrp2,addr=192.168.10.2,overwrite-safe" --fw-path=usrp_n210_fw.bin --fpga-path=usrp_n210_r4_fpga.bin
```

--------------------------------

### uhd_usrp_get_rx_subdev_name

Source: https://files.ettus.com/manual/usrp_8h.html

Get the name for the RX frontend.

```APIDOC
## uhd_usrp_get_rx_subdev_name

### Description
Get the name for the RX frontend.

### Signature
uhd_error uhd_usrp_get_rx_subdev_name(uhd_usrp_handle h, size_t chan, char *rx_subdev_name_out, size_t strbuffer_len)
```

--------------------------------

### Initialize USRP with device arguments

Source: https://files.ettus.com/manual/page_configfiles.html

Demonstrates passing device arguments directly during the initialization of a multi_usrp object.

```cpp
auto usrp = uhd::usrp::multi_usrp::make("type=x300,ext_adc_self_test=1");
```

--------------------------------

### uhd_string_vector_size

Source: https://files.ettus.com/manual/string__vector_8h_source.html

Gets the number of strings in the vector.

```APIDOC
## uhd_string_vector_size

### Description
Get the number of strings in this list.

### Parameters
- **h** (uhd_string_vector_handle) - Required - The string vector handle.
- **size_out** (size_t*) - Required - Pointer to store the size of the vector.
```

--------------------------------

### Accessing the User Settings Interface

Source: https://files.ettus.com/manual/classuhd_1_1usrp_1_1multi__usrp.html

Demonstrates how to retrieve and use the user settings interface, specifically for B2xx series devices. Always check for a null pointer before accessing the interface to avoid dereferencing errors.

```cpp
auto usrp = multi_usrp::make(device_args);
const size_t chan = 0;
auto user_settings = usrp->get_user_settings_iface(chan);
if (!user_settings) {
std::cout << "No user settings!" << std::endl;
} else {
user_settings->poke32(0, 23); // Write value 23 to register 0
}
```

--------------------------------

### Initialize MultiUSRP in C++ and Python

Source: https://files.ettus.com/manual/page_python.html

Comparison of initializing a MultiUSRP device in C++ versus the equivalent Python implementation.

```cpp
#include <uhd/usrp/multi_usrp.hpp>
// ...
auto usrp = uhd::usrp::multi_usrp::make("type=b200");
usrp->set_rx_freq(100e6);
```

```python
import uhd
# ...
usrp = uhd.usrp.MultiUSRP("type=b200")
usrp.set_rx_freq(100e6)
```

--------------------------------

### get_tx_subdev_spec

Source: https://files.ettus.com/manual/classuhd_1_1usrp_1_1multi__usrp.html

Get the TX frontend specification.

```APIDOC
## get_tx_subdev_spec(size_t mboard = 0)

### Description
Retrieves the TX frontend specification for a given motherboard.

### Parameters
- **mboard** (size_t) - Optional - The motherboard index (0 to M-1). Defaults to 0.

### Returns
- **uhd::usrp::subdev_spec_t** - The frontend specification in use.
```

--------------------------------

### Mount and Copy Firmware

Source: https://files.ettus.com/manual/page_usrp_x4xx.html

Commands to mount an alternative filesystem and copy the required RPD firmware file.

```bash
mkdir /mnt/other
mount /dev/mmcblk0p3 /mnt/other
cp /mnt/other/lib/firmware/ni/<rpd file matching your device> ~
umount /mnt/other
```

--------------------------------

### get_tx_subdev_name

Source: https://files.ettus.com/manual/classuhd_1_1usrp_1_1multi__usrp.html

Get the name of the TX frontend.

```APIDOC
## get_tx_subdev_name(size_t chan = 0)

### Description
Retrieves the name of the TX frontend for a given channel.

### Parameters
- **chan** (size_t) - Optional - The channel index (0 to N-1). Defaults to 0.

### Returns
- **std::string** - The frontend name.
```

--------------------------------

### get()

Source: https://files.ettus.com/manual/classuhd_1_1property.html

Retrieves the current value of the property.

```APIDOC
## get()

### Description
Gets the current value of this property. The publisher yields the value if provided, otherwise an internal coerced value is returned.

### Returns
- **const T** - The current value in the property.

### Exceptions
- **uhd::assertion_error**
```

--------------------------------

### load

Source: https://files.ettus.com/manual/classuhd_1_1image__loader.html

Loads firmware and/or FPGA images onto a device.

```APIDOC
## static bool load(const image_loader_args_t &image_loader_args)

### Description
Initiates the loading process for firmware or FPGA images based on the provided arguments.

### Parameters
- **image_loader_args** (image_loader_args_t) - The arguments defining the image loading parameters.

### Returns
- **bool** - Returns true if the image load was successful, or false if no applicable device was found.
```

--------------------------------

### Initialize meta_range_t with initializer lists

Source: https://files.ettus.com/manual/ranges_8hpp_source.html

Examples of initializing meta_range_t using different initializer list formats.

```cpp
meta_range_t r1{0.0, 2.0};
// Same as:
meta_range_t r2(0.0, 2.0);
```

```cpp
meta_range_t r1{0.0, 1.0, 2.0, 3.0};
// Same as:
meta_range_t r2{range_t(0.0), range_t(1.0), range_t(2.0), range_t(3.0)};
```

```cpp
meta_range_t mr{range_t(0.0, 1.0), range_t(2.0), range_t(3.0, 4.0)};
```

```cpp
meta_range_t mr{{0.0, 1.0}, range_t(2.0), {3.0, 4.0}};
```

--------------------------------

### get

Source: https://files.ettus.com/manual/classuhd_1_1property.html

Retrieves the current property value.

```APIDOC
## get

### Description
Returns the current value of the property.

### Signature
`virtual const T get (void) const =0`
```

--------------------------------

### uhd_usrp_get_tx_lo_sources

Source: https://files.ettus.com/manual/usrp_8h.html

Get a list of possible LO sources.

```APIDOC
## uhd_usrp_get_tx_lo_sources

### Description
Get a list of possible LO sources.

### Parameters
- **h** (uhd_usrp_handle) - The USRP handle.
- **name** (const char *) - The LO name.
- **chan** (size_t) - The channel index.
- **tx_lo_sources_out** (uhd_string_vector_handle *) - Pointer to store the list of sources.
```

--------------------------------

### Discover Devices via Command Line

Source: https://files.ettus.com/manual/page_identification.html

Use uhd_find_devices to list connected devices, optionally filtering by specific arguments.

```bash
uhd_find_devices
```

```bash
uhd_find_devices --args="type=usrp1"
```

```bash
uhd_find_devices --args="serial=12345678"
```

--------------------------------

### uhd_usrp_get_tx_lo_source

Source: https://files.ettus.com/manual/usrp_8h.html

Get the currently set LO source.

```APIDOC
## uhd_usrp_get_tx_lo_source

### Description
Get the currently set LO source.

### Parameters
- **h** (uhd_usrp_handle) - The USRP handle.
- **name** (const char *) - The LO name.
- **chan** (size_t) - The channel index.
- **tx_lo_source_out** (char *) - Buffer to store the source name.
- **strbuffer_len** (size_t) - Length of the buffer.
```

--------------------------------

### uhd_usrp_get_tx_lo_freq

Source: https://files.ettus.com/manual/usrp_8h.html

Get the current Tx LO frequency.

```APIDOC
## uhd_usrp_get_tx_lo_freq

### Description
Get the current Tx LO frequency.

### Parameters
- **h** (uhd_usrp_handle) - The USRP handle.
- **name** (const char *) - The LO name.
- **chan** (size_t) - The channel index.
- **tx_lo_freq_out** (double *) - Pointer to store the frequency.
```

--------------------------------

### Initialize X3X0 USRP in C++

Source: https://files.ettus.com/manual/page_usrp_x3x0.html

Use the multi_usrp::make method to instantiate an X3X0 device within a C++ application.

```cpp
auto usrp = uhd::usrp::multi_usrp::make("type=x300");
```

--------------------------------

### uhd_usrp_get_rx_sensor

Source: https://files.ettus.com/manual/usrp_8h.html

Get the value for the given RX sensor.

```APIDOC
## uhd_usrp_get_rx_sensor

### Description
Get the value for the given RX sensor.

### Signature
uhd_error uhd_usrp_get_rx_sensor(uhd_usrp_handle h, const char *name, size_t chan, uhd_sensor_value_handle *sensor_value_out)
```

--------------------------------

### Device Arguments

Source: https://files.ettus.com/manual/page_usrp_x4xx.html

Configuration keys and descriptions for initializing USRP X4x0 devices.

```APIDOC
## Device Arguments

### Description
Key-value pairs used to configure the USRP X4x0 during initialization.

### Available Arguments
- **addr** (string) - IPv4 address of primary SFP+ port.
- **second_addr** (string) - IPv4 address of secondary SFP+ port.
- **third_addr** (string) - IPv4 address of tertiary SFP+ port.
- **fourth_addr** (string) - IPv4 address of quaternary SFP+ port.
- **mgmt_addr** (string) - IPv4 address or hostname for RPC client.
- **find_all** (int) - Find all devices when using broadcast.
- **master_clock_rate** (float) - Master Clock Rate in Hz.
- **serialize_init** (int) - Force serial initialization of motherboards.
- **skip_init** (int) - Skip the initialization process.
- **time_source** (string) - Specify the time (PPS) source.
- **clock_source** (string) - Specify the reference clock source.
- **ext_clock_freq** (float) - Specify the external reference clock frequency.
- **discovery_port** (int) - Override default MPM discovery port.
- **rpc_port** (int) - Override default MPM RPC port.
- **force_reinit** (int) - Force reinitialization of clocking.
- **converter_rate** (float) - Specify the rate of the ADC/DAC (X440 only).
- **cal_freq** (float) - Frequency for self-calibration (X440 only).
- **cal_dac_mux_i** (int) - 16 bit I value for self calibration tone.
- **cal_dac_mux_q** (int) - 16 bit Q value for self calibration tone.
- **cal_tone_duration** (int) - Duration in ms for self-calibration.
- **cal_delay** (int) - Delay for calibration threshold status.
- **cal_ch_list** (string) - Selects channels to be calibrated.
- **skip_adc_selfcal** (bool) - Skips ADC self-cal on clock-reconfig.
- **skip_mpm_reboot** (int) - Skips MPM rebooting (X440 only).
- **force_mtu** (int) - Manually sets a network MTU.
```

--------------------------------

### uhd_usrp_get_rx_lo_sources

Source: https://files.ettus.com/manual/usrp_8h.html

Get a list of possible LO sources.

```APIDOC
## uhd_usrp_get_rx_lo_sources

### Description
Get a list of possible LO sources.

### Parameters
- **h** (uhd_usrp_handle) - USRP handle
- **name** (const char *) - LO name
- **chan** (size_t) - Channel index
- **rx_lo_sources_out** (uhd_string_vector_handle *) - Pointer to store the list of sources
```

--------------------------------

### Example mpm.conf configuration file

Source: https://files.ettus.com/manual/page_configfiles.html

This file controls MPM behavior and device-specific settings. A restart of MPM is required to apply changes.

```ini
; This section is for any MPM behaviour
[mpm]
; Default log level for journald, can be overwritten by -v when starting manually
log_level=info
; Number of log records to buffer for the next get_log_buf() API call
log_buf_size=100
; Device-specific behaviour is set here. This allows having the same file for
; different device types, e.g., when a fleet of different devices are
; managed via Salt or similar tools. The key here is the same as what you would
; use in device args as a type value.
[n3xx]
KEY=VALUE
; Alternatively, specify a product value.
[n310]
KEY=VALUE
```

--------------------------------

### uhd_usrp_get_rx_lo_source

Source: https://files.ettus.com/manual/usrp_8h.html

Get the currently set LO source.

```APIDOC
## uhd_usrp_get_rx_lo_source

### Description
Get the currently set LO source.

### Parameters
- **h** (uhd_usrp_handle) - USRP handle
- **name** (const char *) - LO name
- **chan** (size_t) - Channel index
- **rx_lo_source_out** (char *) - Buffer to store the source name
- **strbuffer_len** (size_t) - Length of the buffer
```

--------------------------------

### Configure External Synchronization

Source: https://files.ettus.com/manual/page_usrp_n3xx.html

Example of initializing a multi_usrp object with external clock and time sources.

```cpp
auto usrp = uhd::usrp::multi_usrp::make(
"type=n3xx,clock_source=external,time_source=external");
```

--------------------------------

### uhd_rx_streamer_num_channels

Source: https://files.ettus.com/manual/usrp_8h.html

Get the number of channels associated with this streamer.

```APIDOC
## uhd_rx_streamer_num_channels

### Description
Get the number of channels associated with this streamer.

### Parameters
- **h** (uhd_rx_streamer_handle) - RX streamer handle
- **num_channels_out** (size_t *) - pointer to output variable for number of channels
```

--------------------------------

### make

Source: https://files.ettus.com/manual/classuhd_1_1property__tree.html

Creates a new, empty property tree instance.

```APIDOC
### static sptr make(void)

Creates and returns a new empty property tree instance.
```

--------------------------------

### uhd_usrp_get_rx_lo_freq

Source: https://files.ettus.com/manual/usrp_8h_source.html

Gets the current RX LO frequency.

```APIDOC
## uhd_usrp_get_rx_lo_freq

### Description
Get the current RX LO frequency.

### Signature
uhd_error uhd_usrp_get_rx_lo_freq(uhd_usrp_handle h, const char *name, size_t chan, double *rx_lo_freq_out)
```

--------------------------------

### uhd::usrp::multi_usrp::make

Source: https://files.ettus.com/manual/page_usrp_n3xx.html

Initializes a USRP N3XX device using the UHD C++ API.

```APIDOC
## uhd::usrp::multi_usrp::make

### Description
Creates a UHD device instance for N3XX hardware. This is the primary entry point for controlling N3XX USRPs in C++ applications.

### Signature
`static sptr make(const device_addr_t &dev_addr)`

### Parameters
- **dev_addr** (device_addr_t) - Required - A device address object containing configuration keys and values (e.g., "type=n3xx,addr=192.168.30.2").

### Supported Device Arguments
- **addr** (string) - IPv4 address of primary SFP+ port.
- **second_addr** (string) - IPv4 address of secondary SFP+ port.
- **mgmt_addr** (string) - IPv4 address or hostname for RPC client connection.
- **find_all** (int) - Find all devices even if unreachable via CHDR.
- **force_reinit** (int) - Force full reinitialization of all subsystems (N310 only).
- **master_clock_rate** (double) - Master Clock Rate in Hz (N310 only).
- **identify** (int) - Duration in seconds to blink front-panel LEDs (N310 only).
- **serialize_init** (int) - Force serial initialization of motherboards.
- **skip_init** (int) - Skip the initialization process.
- **time_source** (string) - Specify the time (PPS) source.
- **clock_source** (string) - Specify the reference clock source.
- **ref_clk_freq** (double) - External reference clock frequency (N310 only).
- **init_cals** (string) - Bitmask for initial RFIC calibrations (N310 only).
- **init_cals_timeout** (int) - Timeout for initial calibrations in ms (N310 only).
- **discovery_port** (int) - Override default MPM discovery port.
- **rpc_port** (int) - Override default MPM RPC port.
- **tracking_cals** (string) - Bitmask for tracking RFIC calibrations (N310 only).
- **rx_lo_source** (string) - Source for RX LO (N310 only).
- **tx_lo_source** (string) - Source for TX LO (N310 only).
- **rfic_digital_loopback** (int) - Enable digital data loopback inside RFIC (N310 only).
- **tx_gain_profile** (string) - TX gain profile (N310 only).
- **rx_gain_profile** (string) - RX gain profile (N310 only).
- **tx_band_map** (string) - Semicolon-separated list of TX band edges (N310 only).
- **rx_band_map** (string) - Semicolon-separated list of RX band edges (N310 only).
- **force_mtu** (int) - Manually set network MTU.
```

--------------------------------

### uhd_usrp_get_pp_string

Source: https://files.ettus.com/manual/usrp_8h.html

Get a pretty-print representation of the USRP device.

```APIDOC
## uhd_usrp_get_pp_string

### Description
Retrieves a human-readable string representation of the USRP device configuration.

### Signature
uhd_error uhd_usrp_get_pp_string(uhd_usrp_handle h, char *pp_string_out, size_t strbuffer_len)
```

--------------------------------

### Download FPGA Images

Source: https://files.ettus.com/manual/page_fpga.html

Use this command to download pre-built FPGA and firmware images for USRP devices.

```bash
$ uhd_images_downloader
```

--------------------------------

### uhd_range_to_pp_string

Source: https://files.ettus.com/manual/ranges_8h.html

Get a string representation of the given range.

```APIDOC
## uhd_range_to_pp_string

### Description
Get a string representation of the given range.

### Signature
uhd_error uhd_range_to_pp_string(const uhd_range_t *range, char *pp_string_out, size_t strbuffer_len)
```

--------------------------------

### Build with GUI mode

Source: https://files.ettus.com/manual/gen3_fpga_build.html

Executes the build process for the X310 target using the Vivado GUI.

```bash
$ make X310 GUI=1
```

--------------------------------

### get_tx_rates

Source: https://files.ettus.com/manual/classuhd_1_1usrp_1_1multi__usrp.html

Get a range of possible TX rates.

```APIDOC
## meta_range_t get_tx_rates(size_t chan = 0)

### Description
Get a range of possible TX rates for the specified channel.

### Parameters
- **chan** (size_t) - Optional - The channel index 0 to N-1.

### Returns
- **meta_range_t** - The meta range of rates.
```

--------------------------------

### get_tx_rate

Source: https://files.ettus.com/manual/classuhd_1_1usrp_1_1multi__usrp.html

Gets the current TX sample rate.

```APIDOC
## double get_tx_rate(size_t chan = 0)

### Description
Gets the TX sample rate in samples per second (Sps).

### Parameters
- **chan** (size_t) - Optional - The channel index 0 to N-1.

### Returns
- **double** - The rate in Sps.
```

--------------------------------

### Download N3xx SDK

Source: https://files.ettus.com/manual/page_usrp_n3xx.html

Use the uhd_images_downloader utility to fetch the appropriate SDK for N3xx hardware.

```bash
$ uhd_images_downloader -t sdk -t n3xx
```
Tokens:
Raw