summaryrefslogtreecommitdiffstats
path: root/host
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-11-11 19:40:58 -0800
committerJosh Blum <josh@joshknows.com>2010-11-11 19:40:58 -0800
commite84b198c0b323f6eab7dd8557d13cab312602e84 (patch)
tree88027b3b755ef6fa96b395f7015b160b0e5a21f4 /host
parentb08ac6273fa6dd1e757ecaeb0b316592696099f7 (diff)
downloaduhd-e84b198c0b323f6eab7dd8557d13cab312602e84.tar.gz
uhd-e84b198c0b323f6eab7dd8557d13cab312602e84.tar.bz2
uhd-e84b198c0b323f6eab7dd8557d13cab312602e84.zip
usrp-n: renamed docs and burner app, added burner app documentation
Diffstat (limited to 'host')
-rw-r--r--host/docs/CMakeLists.txt2
-rw-r--r--host/docs/index.rst2
-rw-r--r--host/docs/usrp_nxxx.rst (renamed from host/docs/usrp2.rst)37
-rwxr-xr-xhost/utils/usrp_n2xx_net_burner.py (renamed from host/utils/usrp2p_fw_update.py)0
4 files changed, 37 insertions, 4 deletions
diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index 4d3269543..c649dbb61 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -28,7 +28,7 @@ SET(manual_sources
images.rst
transport.rst
usrp1.rst
- usrp2.rst
+ usrp_nxxx.rst
)
########################################################################
diff --git a/host/docs/index.rst b/host/docs/index.rst
index 9d6d14d0f..c491c5da6 100644
--- a/host/docs/index.rst
+++ b/host/docs/index.rst
@@ -24,7 +24,7 @@ Application Notes
* `Device Identification Notes <./identification.html>`_
* `Firmware and FPGA Image Notes <./images.html>`_
* `USRP1 Application Notes <./usrp1.html>`_
-* `USRP2 Application Notes <./usrp2.html>`_
+* `USRP2 and USRP-N Series Application Notes <./usrp_nxxx.html>`_
* `Daughterboard Application Notes <./dboards.html>`_
* `Transport Application Notes <./transport.html>`_
diff --git a/host/docs/usrp2.rst b/host/docs/usrp_nxxx.rst
index d07175ce4..617555b56 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp_nxxx.rst
@@ -1,11 +1,11 @@
========================================================================
-UHD - USRP2 Application Notes
+UHD - USRP2 and USRP-N Series Application Notes
========================================================================
.. contents:: Table of Contents
------------------------------------------------------------------------
-Load the images onto the SD card
+Load the images onto the SD card (USRP2 only)
------------------------------------------------------------------------
**Warning!**
Use the usrp2_card_burner.py with caution. If you specify the wrong device node,
@@ -46,6 +46,39 @@ Use the card burner tool (windows)
------------------------------------------------------------------------
+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.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Use the net burner tool (unix)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+::
+
+ cd <prefix>/share/uhd/utils
+ ./usrp_n2xx_net_burner.py --ip=<ip address> --fw=<path for firmware image>
+ ./usrp_n2xx_net_burner.py --ip=<ip address> --fpga=<path to FPGA image>
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Use the net burner tool (Windows)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+::
+
+ <path_to_python.exe> <prefix>/share/uhd/utils/usrp_n2xx_net_burner.py --ip=<ip address> --fw=<path for firmware image>
+ <path_to_python.exe> <prefix>/share/uhd/utils/usrp_n2xx_net_burner.py --ip=<ip address> --fpga=<path to FPGA image>
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Device recovery and bricking
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+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.
+
+------------------------------------------------------------------------
Setup networking
------------------------------------------------------------------------
The USRP2 only supports gigabit ethernet, and
diff --git a/host/utils/usrp2p_fw_update.py b/host/utils/usrp_n2xx_net_burner.py
index 456f273df..456f273df 100755
--- a/host/utils/usrp2p_fw_update.py
+++ b/host/utils/usrp_n2xx_net_burner.py