aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2011-01-31 18:05:16 -0800
committerJosh Blum <josh@joshknows.com>2011-01-31 18:05:16 -0800
commit52e9c8f8027d0bbe1e6b0f57e30f985613e48be2 (patch)
tree44bb54695dfc8a0ba552085a1f9625d7d85d37ab /host/docs
parent572a64f0acb459583abfccbc8288158822fa2f77 (diff)
parent67bba008255f98367cf19dba518dceb40f763c25 (diff)
downloaduhd-52e9c8f8027d0bbe1e6b0f57e30f985613e48be2.tar.gz
uhd-52e9c8f8027d0bbe1e6b0f57e30f985613e48be2.tar.bz2
uhd-52e9c8f8027d0bbe1e6b0f57e30f985613e48be2.zip
Merge branch 'multi_usrp_only' into usrp_e100_devel
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/coding.rst34
-rw-r--r--host/docs/usrp2.rst46
2 files changed, 36 insertions, 44 deletions
diff --git a/host/docs/coding.rst b/host/docs/coding.rst
index 7533445ea..ecca4e8b8 100644
--- a/host/docs/coding.rst
+++ b/host/docs/coding.rst
@@ -23,40 +23,10 @@ The device API provides ways to:
See the documentation in *device.hpp* for reference.
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-High-Level: The single usrp
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The goal of the single usrp API is to wrap high level functions around the device properties.
-The single usrp provides a fat interface to access the most common properties.
-The single usrp provides ways to:
-
-* Set and get daughterboard gains.
-* Set and get daughterboard antennas.
-* Set and get the streaming rates.
-* Tune the DSPs and daughterboards.
-* Issue stream commands.
-* Set the clock configuration.
-* Set the usrp time registers.
-* Get the underlying device (as discussed above).
-
-See the documentation in *usrp/single_usrp.hpp* for reference.
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
High-Level: The multi usrp
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The multi usrp API provides a wrapper around a device that represents several motherboards.
-This API provides convenience calls just like the single usrp,
-however the calls either work across all channels in the configuration,
-or take a channel argument to specify which channel to configure.
-The multi usrp provides ways to:
-
-* Set and get the sample rate across all channels.
-* Issue a stream command across all channels.
-* Set the time registers across all channels.
-* Set and get individual daughterboard gains.
-* Set and get individual daughterboard antennas.
-* Tune individual DSPs and daughterboards.
-* Get the underlying device (as discussed above).
-
+The Multi-USRP class provides a FAT interface to a single USRP with
+one or more channels, or multiple USRPs in a homogeneous setup.
See the documentation in *usrp/multi_usrp.hpp* for reference.
------------------------------------------------------------------------
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 2ee49646f..70101bd87 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -81,7 +81,7 @@ The safe-mode button is a pushbutton switch (S2) located inside the enclosure.
To boot into the safe image, hold-down the safe-mode button while power-cycling the device.
Continue to hold-down the button until the front-panel LEDs blink and remain solid.
-When in safe-mode, the USRP-N Series will always have the IP address 192.168.10.2
+When in safe-mode, the USRP-N device will always have the IP address 192.168.10.2
------------------------------------------------------------------------
Setup networking
@@ -154,31 +154,53 @@ Run the following commands:
cd <prefix>/share/uhd/utils
sudo ./usrp2_recovery.py --ifc=eth0 --new-ip=192.168.10.3
+------------------------------------------------------------------------
+Communication problems
+------------------------------------------------------------------------
+When setting up a development machine for the first time,
+you may have various difficulties communicating with the USRP device.
+The following tips are designed to help narrow-down and diagnose the problem.
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Debugging networking problems
+Firewall issues
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**Disable the firewall:**
-If uhd_find_devices gives you nothing
-but uhd_find_devices --args addr=192.168.10.2 yeilds a discovered device,
+When the IP address is not specified,
+the device discovery sends broadcast UDP packets from each ethernet interface.
+Many firewalls will block the replies to these broadcast packets.
+If disabling your system's firewall,
+or specifying the IP address yeilds a discovered device,
then your firewall may be blocking replies to UDP broadcast packets.
+If this is the case, we recommend that you disable the firewall,
+or create a rule to allow all incoming packets with UDP source port 49152.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Ping the device
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The USRP will reply to icmp echo requests.
+A successful ping response means that the device has booted properly,
+and that it is using the expected IP address.
-**Ping the USRP2:**
-The USRP2 will reply to icmp echo requests.
::
ping 192.168.10.2
-**Monitor the serial output:**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Monitor the serial output
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read the serial port to get debug verbose from the embedded microcontroller.
-Use a standard USB to 3.3v-level serial converter at 230400 baud.
The microcontroller prints useful information about IP addresses,
-MAC addresses, control packets, and fast-path settings.
+MAC addresses, control packets, fast-path settings, and bootloading.
+Use a standard USB to 3.3v-level serial converter at 230400 baud.
+Connect GND to the converter ground, and connect TXD to the converter receive.
+The RXD pin can be left unconnected as this is only a one-way communication.
* **USRP2:** Serial port located on the rear edge
* **N210:** Serial port located on the left side
-**Monitor the host network traffic:**
-Use wireshark to monitor packets sent to and received from the USRP2.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Monitor the host network traffic
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Use wireshark to monitor packets sent to and received from the device.
------------------------------------------------------------------------
Addressing the device