summaryrefslogtreecommitdiffstats
path: root/host/docs/usrp2.rst
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-04-18 00:37:24 -0700
committerJosh Blum <josh@joshknows.com>2010-04-18 00:37:24 -0700
commit77c578fc639bb3d54c6730402de04a22636b1d6d (patch)
treeb20154e5337ff498c831a2472f834bb3087f85e9 /host/docs/usrp2.rst
parent1ee33acace699a5374d605c71dbe4075b85aecc9 (diff)
downloaduhd-77c578fc639bb3d54c6730402de04a22636b1d6d.tar.gz
uhd-77c578fc639bb3d54c6730402de04a22636b1d6d.tar.bz2
uhd-77c578fc639bb3d54c6730402de04a22636b1d6d.zip
Created a docs directory to house restructured text documentation.
Moved doxygen build rules into the docs build directory. Created rst docs for building and burning usrp2.
Diffstat (limited to 'host/docs/usrp2.rst')
-rw-r--r--host/docs/usrp2.rst63
1 files changed, 63 insertions, 0 deletions
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
new file mode 100644
index 000000000..1de61b734
--- /dev/null
+++ b/host/docs/usrp2.rst
@@ -0,0 +1,63 @@
+========================================================================
+UHD - USRP2 App Notes
+========================================================================
+
+.. contents:: Table of Contents
+
+------------------------------------------------------------------------
+Building firmware and FPGA images
+------------------------------------------------------------------------
+
+^^^^^^^^^^^^^^^^^^
+FPGA Image
+^^^^^^^^^^^^^^^^^^
+Xilinx ISE 10.1 is required to build the FPGA image for the USRP2
+(newer version of ISE are known to build buggy 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.
+
+Run the following commands:
+::
+
+ cd <uhd-repo-path>/fpga/usrp2/top/u2_rev3
+ make 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 ./apps/txrx.bin*
+
+------------------------------------------------------------------------
+Load the images onto the SD card
+------------------------------------------------------------------------
+**Warning!**
+Use the u2_flash_tool with caution. If you specify the wrong device node,
+you could overwrite your hard drive. Make sure that --dev= specifies the SD card.
+
+Load the FPGA image:
+
+::
+
+ cd <uhd-repo-path>/firmware/microblaze
+ sudo ./u2_flash_tool --dev=/dev/sd<XXX> -t fpga -w <path_to_fpga_image>
+
+Load the firmware image:
+
+::
+
+ cd <uhd-repo-path>/firmware/microblaze directory
+ sudo ./u2_flash_tool --dev=/dev/sd<XXX> -t s/w -w <path_to_firmware_image>