Revision a67486ff host/docs/usrp2.rst

b/host/docs/usrp2.rst
21 21
For these reasons, we recommend that you use the SD card that was supplied with the USRP2.
22 22

  
23 23
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24
Use the card burner tool (unix)
24
Use the card burner tool (UNIX)
25 25
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26 26
::
27 27

  
......
38 38
The list option has been implemented on Linux, Mac OS X, and Windows.
39 39

  
40 40
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
41
Use the card burner tool (windows)
41
Use the card burner tool (Windows)
42 42
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43 43
::
44 44

  
......
58 58
Use this number to select the correct FPGA image for your device.
59 59

  
60 60
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
61
Use the net burner tool (unix)
61
Use the net burner tool (UNIX)
62 62
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
63 63
::
64 64

  
......
88 88
To boot into the safe image, hold-down the safe-mode button while power-cycling the device.
89 89
Continue to hold-down the button until the front-panel LEDs blink and remain solid.
90 90

  
91
When in safe-mode, the USRP-N device will always have the IP address 192.168.10.2
91
When in safe-mode, the USRP-N device will always have the IP address **192.168.10.2**.
92 92

  
93 93
------------------------------------------------------------------------
94 94
Setup networking
95 95
------------------------------------------------------------------------
96
The USRP2 only supports gigabit ethernet,
96
The USRP2 only supports Gigabit Ethernet
97 97
and will not work with a 10/100 Mbps interface.
98 98
However, a 10/100 Mbps interface can be connected indirectly
99
to a USRP2 through a gigabit ethernet switch.
99
to a USRP2 through a Gigabit Ethernet switch.
100 100

  
101 101
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
102 102
Setup the host interface
103 103
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
104 104
The USRP2 communicates at the IP/UDP layer over the gigabit ethernet.
105 105
The default IP address of the USRP2 is **192.168.10.2**
106
You will need to configure the host's ethernet interface with a static IP
106
You will need to configure the host's Ethernet interface with a static IP
107 107
address to enable communication.  An address of **192.168.10.1** and a subnet
108 108
mask of **255.255.255.0** is recommended.
109 109

  
......
129 129
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
130 130
Multiple devices per host
131 131
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
132
For maximum throughput, one ethernet interface per USRP2 is recommended,
133
although multiple devices may be connected via a gigabit ethernet switch.
134
In any case, each ethernet interface should have its own subnet,
132
For maximum throughput, one Ethernet interface per USRP2 is recommended,
133
although multiple devices may be connected via a Gigabit Ethernet switch.
134
In any case, each Ethernet interface should have its own subnet,
135 135
and the corresponding USRP2 device should be assigned an address in that subnet.
136 136
Example:
137 137

  
138 138
**Configuration for USRP2 device 0:**
139 139

  
140
* Ethernet interface IPv4 address: 192.168.10.1
141
* Ethernet interface subnet mask: 255.255.255.0
142
* USRP2 device IPv4 address: 192.168.10.2
140
* Ethernet interface IPv4 address: **192.168.10.1**
141
* Ethernet interface subnet mask: **255.255.255.0**
142
* USRP2 device IPv4 address: **192.168.10.2**
143 143

  
144 144
**Configuration for USRP2 device 1:**
145 145

  
146
* Ethernet interface IPv4 address: 192.168.20.1
147
* Ethernet interface subnet mask: 255.255.255.0
148
* USRP2 device IPv4 address: 192.168.20.2
146
* Ethernet interface IPv4 address: **192.168.20.1**
147
* Ethernet interface subnet mask: **255.255.255.0**
148
* USRP2 device IPv4 address: **192.168.20.2**
149 149

  
150 150
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
151 151
Change the USRP2's IP address
......
157 157
* to set a known IP address into USRP2 (in case you forgot)
158 158

  
159 159
**Method 1:**
160
To change the USRP2's IP address
160
To change the USRP2's IP address,
161 161
you must know the current address of the USRP2,
162 162
and the network must be setup properly as described above.
163 163
Run the following commands:
......
180 180
------------------------------------------------------------------------
181 181
When setting up a development machine for the first time,
182 182
you may have various difficulties communicating with the USRP device.
183
The following tips are designed to help narrow-down and diagnose the problem.
183
The following tips are designed to help narrow down and diagnose the problem.
184 184

  
185 185
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
186 186
RuntimeError: no control response
......
188 188
This is a common error that occurs when you have set the subnet of your network
189 189
interface to a different subnet than the network interface of the USRP.  For
190 190
example, if your network interface is set to 192.168.20.1, and the USRP is
191
192.168.10.2 (note the difference in the third numbers of the IP addresses), you
191
**192.168.10.2** (note the difference in the third numbers of the IP addresses), you
192 192
will likely see a 'no control response' error message.
193 193

  
194 194
Fixing this is simple - just set the your host PC's IP address to the same
195
subnet as your USRP. Instructions for setting your IP address are in the
195
subnet as that of your USRP. Instructions for setting your IP address are in the
196 196
previous section of this documentation.
197 197

  
198 198

  
......
200 200
Firewall issues
201 201
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202 202
When the IP address is not specified,
203
the device discovery sends broadcast UDP packets from each ethernet interface.
203
the device discovery broadcasts UDP packets from each ethernet interface.
204 204
Many firewalls will block the replies to these broadcast packets.
205
If disabling your system's firewall,
206
or specifying the IP address yeilds a discovered device,
205
If disabling your system's firewall
206
or specifying the IP address yields a discovered device,
207 207
then your firewall may be blocking replies to UDP broadcast packets.
208
If this is the case, we recommend that you disable the firewall,
208
If this is the case, we recommend that you disable the firewall
209 209
or create a rule to allow all incoming packets with UDP source port 49152.
210 210

  
211 211
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
212 212
Ping the device
213 213
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
214
The USRP will reply to icmp echo requests.
215
A successful ping response means that the device has booted properly,
214
The USRP will reply to ICMP echo requests.
215
A successful ping response means that the device has booted properly
216 216
and that it is using the expected IP address.
217 217

  
218 218
::
......
222 222
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
223 223
Monitor the serial output
224 224
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
225
Read the serial port to get debug verbose from the embedded microcontroller.
225
Read the serial port to get debug verbose output from the embedded microcontroller.
226 226
The microcontroller prints useful information about IP addresses,
227 227
MAC addresses, control packets, fast-path settings, and bootloading.
228 228
Use a standard USB to 3.3v-level serial converter at 230400 baud.
......
235 235
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
236 236
Monitor the host network traffic
237 237
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
238
Use wireshark to monitor packets sent to and received from the device.
238
Use Wireshark to monitor packets sent to and received from the device.
239 239

  
240 240
------------------------------------------------------------------------
241 241
Addressing the device
......
250 250
See the application notes on `device identification <./identification.html>`_.
251 251
Use this addressing scheme with the *single_usrp* interface.
252 252

  
253
Example device address string representation for a USRP2 with IPv4 address 192.168.10.2
253
Example device address string representation for a USRP2 with IPv4 address **192.168.10.2**:
254 254

  
255 255
::
256 256

  
......
268 268
* The order in which devices are indexed corresponds to the indexing of the transmit and receive channels.
269 269
* The key indexing provides the same granularity of device identification as in the single device case.
270 270

  
271
Example device address string representation for 2 USRP2s with IPv4 addresses 192.168.10.2 and 192.168.20.2
271
Example device address string representation for 2 USRP2s with IPv4 addresses **192.168.10.2** and **192.168.20.2**:
272 272
::
273 273

  
274 274
    addr0=192.168.10.2, addr1=192.168.20.2
......
277 277
Using the MIMO Cable
278 278
------------------------------------------------------------------------
279 279
The MIMO cable allows two USRP devices to share reference clocks,
280
time synchronization, and the ethernet interface.
281
One of the devices will sink its clock and time references to the MIMO cable.
280
time synchronization, and the Ethernet interface.
281
One of the devices will sync its clock and time references to the MIMO cable.
282 282
This device will be referred to as the slave, and the other device, the master.
283 283

  
284 284
* The slave device acquires the clock and time references from the master device.
285 285
* The master and slave may be used individually or in a multi-device configuration.
286
* External clocking is optional, and should only be supplied to the master device.
286
* External clocking is optional and should only be supplied to the master device.
287 287

  
288 288
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
289 289
Shared ethernet mode
290 290
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
291
In shared ethernet mode,
292
only one device in the configuration can be attached to the ethernet.
291
In shared Ethernet mode,
292
only one device in the configuration can be attached to the Tthernet.
293 293

  
294 294
* Clock reference, time reference, and data are communicated over the MIMO cable.
295
* Both master and slave must have different IPv4 addresses in the same subnet.
295
* Master and slave must have different IPv4 addresses in the same subnet.
296 296

  
297 297
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
298 298
Dual ethernet mode
299 299
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
300
In dual ethernet mode,
301
both devices in the configuration must be attached to the ethernet.
300
In dual Ethernet mode,
301
both devices in the configuration must be attached to the Ethernet.
302 302

  
303 303
* Only clock reference and time reference are communicated over the MIMO cable.
304
* Both master and slave must have different IPv4 addresses in different subnets.
304
* The master and slave must have different IPv4 addresses in different subnets.
305 305

  
306 306
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
307 307
Configuring the slave
......
336 336
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
337 337
Ref Clock - 10MHz
338 338
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
339
Using an external 10MHz reference clock, square wave will offer the best phase
340
noise performance, but sinusoid is acceptable.  The reference clock requires the following power level:
339
Using an external 10MHz reference clock, a square wave will offer the best phase
340
noise performance, but a sinusoid is acceptable.  The reference clock requires the following power level:
341 341

  
342 342
* **USRP2** 5 to 15dBm
343 343
* **N2XX** 0 to 15dBm
......
376 376
The following sensors are available for the USRP2/N-Series motherboards;
377 377
they can be queried through the API.
378 378

  
379
* mimo_locked - clock reference locked over the MIMO cable
380
* ref_locked - clock reference locked (internal/external)
379
* **mimo_locked** - clock reference locked over the MIMO cable
380
* **ref_locked** - clock reference locked (internal/external)
381 381
* other sensors are added when the GPSDO is enabled
382 382

  
383 383
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Also available in: Unified diff