uhd: docs on building and installing images

4 files changed, 106 insertions, 36 deletions

diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index d0041f71c..b4383f88d 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -24,6 +24,7 @@ SET(manual_sources
     coding.rst
     dboards.rst
     general.rst
+    images.rst
     usrp2.rst
 )
 
diff --git a/host/docs/images.rst b/host/docs/images.rst
new file mode 100644
index 000000000..ff5c5404e
--- /dev/null
+++ b/host/docs/images.rst
@@ -0,0 +1,104 @@
+========================================================================
+UHD - Firmware and FPGA Image Application Notes
+========================================================================
+
+.. contents:: Table of Contents
+
+------------------------------------------------------------------------
+Images Overview
+------------------------------------------------------------------------
+Every USRP device must be loaded with special firmware and FPGA images.
+The methods of loading images into the device varies among devices:
+
+* **USRP1:** The host code will automatically load the firmware and FPGA at runtime.
+* **USRP2:** The user must manually write the images onto the USRP2 SD card.
+
+------------------------------------------------------------------------
+Pre-built images
+------------------------------------------------------------------------
+
+Pre-built images are available for download.
+See the UHD wiki for the download link.
+
+The pre-built images come in platform-specific installer packages
+and platform-independent archive files:
+
+* **Linux:** DEB or RPM installer
+* **Windows:** not available yet...
+* **Macintosh:** not available yet...
+* **Platform-independent:** ZIP or TAR.GZ archive
+
+^^^^^^^^^^^^^^^^^^
+Linux installers
+^^^^^^^^^^^^^^^^^^
+The Linux-based installers will install the images into /usr/share/uhd/images.
+On a Linux system, the UHD will always search this path for image files.
+
+Commands to install a linux rpm or deb package:
+
+::
+
+    sudo rpm -i <linux-images-installer>.rpm
+
+    -- OR --
+
+    sudo dpkg -i <linux-images-installer>.deb
+
+^^^^^^^^^^^^^^^^^^^^^^
+Archive install
+^^^^^^^^^^^^^^^^^^^^^^
+When installing images from an archive, there are two options:
+
+**Option 1:**
+
+Unpack the archive into the UHD installation prefix.
+The UHD will always search <prefix>/share/uhd/images for image files.
+Where <prefix> was set by the CMAKE_INSTALL_PREFIX at configure-time.
+
+**Option 2:**
+
+Unpack the archive anywhere and set the UHD_IMAGE_PATH environment variable.
+The UHD_IMAGE_PATH may contain a list of directories to search for image files,
+or paths to specific image files.
+
+------------------------------------------------------------------------
+Building images
+------------------------------------------------------------------------
+
+The UHD source repository comes with the source code necessary to build
+both firmware and FPGA images for all supported devices.
+The build commands for a particular image can be found in <uhd-repo-path>/images/Makefile.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Xilinx FPGA builds
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Xilinx ISE 12.x and up is required to build the Xilinx FPGA images.
+The build requires that you have a unix-like environment with make.
+Make sure that xtclsh from the Xilinx ISE bin directory is in your $PATH.
+
+See <uhd-repo-path>/fpga/usrp2/top/*
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Microblaze firmware builds
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The Microblaze GCC compiler from the Xilinx EDK is required to build the Microblaze firmware images.
+The build requires that you have a unix-like environment with autotools and make.
+Make sure that mb-gcc from the Xilinx EDK/microblaze directory is in your $PATH.
+
+See <uhd-repo-path>/firmware/microblaze
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Altera FPGA builds
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Quartus is required to build the Altera FPGA images.
+Pre-built images can also be found in <uhd-repo-path>/fpga/usrp1/rbf
+
+See <uhd-repo-path>/fpga/usrp1/toplevel/*
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+FX2 firmware builds
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The sdcc compiler is required to build the FX2 firmware images.
+The build requires that you have a unix-like environment with autotools and make.
+
+See <uhd-repo-path>/firmware/fx2
diff --git a/host/docs/index.rst b/host/docs/index.rst
index b31a3d0ac..6973ede19 100644
--- a/host/docs/index.rst
+++ b/host/docs/index.rst
@@ -21,6 +21,7 @@ Building the UHD
 Application Notes
 ^^^^^^^^^^^^^^^^^^^^^
 * `General App Notes <./general.html>`_
+* `Firmware and FPGA Image Notes <./images.html>`_
 * `USRP2 App Notes <./usrp2.html>`_
 * `Daughterboard App Notes <./dboards.html>`_
 
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index bc4ea0e44..3ac326f58 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -5,42 +5,6 @@ UHD - USRP2 Application Notes
 .. contents:: Table of Contents
 
 ------------------------------------------------------------------------
-Building firmware and FPGA images
-------------------------------------------------------------------------
-
-^^^^^^^^^^^^^^^^^^
-FPGA Image
-^^^^^^^^^^^^^^^^^^
-Xilinx ISE 10.1 and up is required to build the FPGA image for the USRP2.
-The build requires that you have a unix-like environment with make.
-Make sure that xtclsh from the Xilinx ISE bin directory is in your $PATH.
-
-Run the following commands:
-::
-
-    cd <uhd-repo-path>/fpga/usrp2/top/u2_rev3
-    make -f Makefile.udp bin
-
-*The image file will be ./build/u2_rev3.bin*
-
-^^^^^^^^^^^^^^^^^^
-Firmware Image
-^^^^^^^^^^^^^^^^^^
-The Microblaze GCC compiler from the Xilinx EDK is required to build the firmware.
-The build requires that you have a unix-like environment with autotools and make.
-Make sure that mb-gcc from the Xilinx EDK/microblaze directory is in your $PATH.
-
-Run the following commands:
-::
-
-    cd <uhd-repo-path>/firmware/microblaze
-    ./boostrap
-    ./configure --host=mb
-    make
-
-*The image file will be ./usrp2/usrp2_txrx_uhd.bin*
-
-------------------------------------------------------------------------
 Load the images onto the SD card
 ------------------------------------------------------------------------
 **Warning!**