aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2011-01-24 10:29:40 -0800
committerJosh Blum <josh@joshknows.com>2011-01-24 10:30:56 -0800
commitff796f519df11111f028a505125ce95f060c897e (patch)
tree732856853ca5e62e83bc5bacd48a02ed129c46ca /host/docs
parentcd5631ff194ae8b8ca6308286e44704785ef792a (diff)
downloaduhd-ff796f519df11111f028a505125ce95f060c897e.tar.gz
uhd-ff796f519df11111f028a505125ce95f060c897e.tar.bz2
uhd-ff796f519df11111f028a505125ce95f060c897e.zip
uhd: added docs on usrp2/n, removed empty n2xx doc page, misc
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/CMakeLists.txt1
-rw-r--r--host/docs/build.rst13
-rw-r--r--host/docs/usrp2.rst17
-rw-r--r--host/docs/usrp_nxxx.rst5
4 files changed, 22 insertions, 14 deletions
diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index ace48f008..0c2cadfc2 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -29,7 +29,6 @@ SET(manual_sources
transport.rst
usrp1.rst
usrp2.rst
- usrp_nxxx.rst
)
########################################################################
diff --git a/host/docs/build.rst b/host/docs/build.rst
index 74ebc9ee4..de7c544f2 100644
--- a/host/docs/build.rst
+++ b/host/docs/build.rst
@@ -30,10 +30,13 @@ On windows, install cygwin with git support to checkout the repository,
or install msysgit from http://code.google.com/p/msysgit/downloads/list
^^^^^^^^^^^^^^^^
-C++
+C++ compiler
^^^^^^^^^^^^^^^^
-On Unix, this is GCC 4.0 and above. On Windows, this is MSVC 2008.
-Other compilers have not been tested yet or confirmed working.
+The following compilers are known to work:
+
+* GCC
+* Clang
+* MSVC
^^^^^^^^^^^^^^^^
CMake
@@ -78,6 +81,10 @@ Cheetah
* **Download URL:** http://www.cheetahtemplate.org/download.html
* **Download URL (windows installer):** http://feisley.com/python/cheetah/
+**Alternative method:**
+Install setuptools, and use the easy_install command to install Cheetah.
+http://pypi.python.org/pypi/setuptools
+
^^^^^^^^^^^^^^^^
Doxygen
^^^^^^^^^^^^^^^^
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 3031a0075..2ee49646f 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -50,6 +50,8 @@ Load the images onto the on-board flash (USRP-N Series only)
------------------------------------------------------------------------
The USRP-N Series can be reprogrammed over the network
to update or change the firmware and FPGA images.
+When updating images, always burn both the FPGA and firmware images before power cycling.
+This ensures that when the device reboots, it has a compatible set of images to boot into.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Use the net burner tool (unix)
@@ -75,8 +77,11 @@ Its possible to put the device into an unusable state by loading bad images.
Fortunately, the USRP-N Series can be booted into a safe (read-only) image.
Once booted into the safe image, the user can once again load images onto the device.
-To boot into the safe image, hold down the reset button while power-cycling the device.
-The reset button is a pushbutton switch (S2) located inside the enclosure.
+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
------------------------------------------------------------------------
Setup networking
@@ -163,13 +168,15 @@ The USRP2 will reply to icmp echo requests.
ping 192.168.10.2
-**Monitor the USRP2:**
-You can read the serial port on the rear of the USRP2
-to get debug verbose from the embedded microcontroller.
+**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.
+* **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.
diff --git a/host/docs/usrp_nxxx.rst b/host/docs/usrp_nxxx.rst
deleted file mode 100644
index 733078915..000000000
--- a/host/docs/usrp_nxxx.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-========================================================================
-UHD - USRP-N Series Application Notes
-========================================================================
-
-* `USRP2 and N Series Application Notes <./usrp2.html>`_