1uhd_image_loader(1)              User Commands             uhd_image_loader(1)
2
3
4

NAME

6       uhd_image_loader - UHD Image Loader
7
8

DESCRIPTION

10       Burn firmware and FPGA images onto connected Ettus Research devices.
11
12

SYNOPSIS

14       uhd_image_loader [OPTIONS]
15
16

OPTIONS

18       List options:
19              --help
20
21       Device and loader arguments:
22              --args=""
23
24       Custom firmware filepath:
25              --fw-path=""
26
27       Custom FPGA filepath:
28              --fpga-path=""
29
30       Don't burn firmware:
31              --no-fw
32
33       Don't burn FPGA:
34              --no-fpga
35
36

SPECIFYING A PARTICULAR DEVICE

38       Without  any  arguments  given through the args="" option, this utility
39       will start a session with the first Ettus Research device it sees.  The
40       arguments  shown below will narrow down the utility's search for a par‐
41       ticular device:
42
43
44   All devices
45       The name= and serial= arguments can  be  used  to  specify  any  device
46       except  an  uninitialized  USB  device  or an OctoClock bootloader. The
47       type= argument can be used to specify any device, as described below:
48
49       "type=" argument
50
51       Argument       |     Device
52
53       type=usrp2     |     USRP N200, USRP N210
54
55       type=b200      |     USRP B200, USRP B210
56
57       type=e3x0      |     USRP E310
58
59       type=octoclock |     OctoClock
60
61
62       NOTE: The USRP1, USRP2, and USRP B100 are not supported.
63
64
65   Network devices
66       By default, this utility will check all network interfaces for network-
67       based  devices,  but  a  specific  IP address can be specified with the
68       addr= argument.
69
70
71   NI-RIO devices
72       An X-Series devices connected via PCIe can be specified by  its  NI-RIO
73       resource through the resource= argument, and the RPC port through which
74       to communicate with it can be specified with  the  rpc-port=  argument.
75       Using  these  options  is  not recommended, as their default values are
76       almost always used.
77
78
79   OctoClock devices
80       An OctoClock's name and serial are only exposed when  the  firmware  is
81       loaded, so if the device only has a bootloader, only the addr= argument
82       can be used to find it.
83
84

DEVICE-SPECIFIC LOADER OPTIONS

86       Certain devices have specific options for customizing their image load‐
87       ing  process,  and these can be passed in through the --args="" option.
88       These arguments are specified below:
89
90
91   USRP N200, USRP N210
92       The  overwrite-safe  option  will  overwrite  the  device's   safe-mode
93       firmware  and  FPGA  images.  This  is NOT RECOMMENDED, as these images
94       serve as the backup if the device's primary images are corrupted.
95
96
97       The reset option will automatically reset the device once  the  loading
98       process  finishes.  When the device resets, it will have its new images
99       loaded.
100
101
102   USRP X300, USRP X310 (Ethernet only)
103       The configure option will automatically reset the device once the load‐
104       ing process finishes. When the device resets, it will have its new FPGA
105       image loaded.
106
107
108       The verify option  will  tell  the  device  to  internally  verify  the
109       integrity of the image as it loads.  This greatly increases the loading
110       time.
111
112

EXAMPLES

114   Load only the default FPGA image onto a specific N2x0 device and reset
115       uhd_image_loader --args="type=usrp2,addr=192.168.10.2,reset" --no-fw
116
117
118   Load a custom FPGA image onto a specific X3x0 device
119       uhd_image_loader      --args="type=x300,addr=192.168.40.2"      --fpga-
120       path="/home/user/my_x300_fpga_image.bit"
121
122
123

SEE ALSO

125       UHD documentation: http://files.ettus.com/manual/
126
127       GR-UHD documentation: http://gnuradio.org/doc/doxygen/page_uhd.html
128
129       Other UHD programs:
130
131       uhd_images_downloader(1) usrp2_card_burner(1)
132

AUTHOR

134       This  manual page was written by Nicholas Corgan for the Debian project
135       (but may be used by others).
136
138       Copyright (c) 2015 Ettus Research LLC
139
140       This program is free software: you can redistribute it and/or modify it
141       under  the  terms of the GNU General Public License as published by the
142       Free Software Foundation, either version 3 of the License, or (at  your
143       option) any later version.
144
145       This  program  is  distributed  in the hope that it will be useful, but
146       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
147       CHANTABILITY  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
148       Public License for more details.
149
150
151
152UHD                                  3.9.0                 uhd_image_loader(1)
Impressum