Merge branch 'master' of ettus.sourcerepo.com:ettus/uhdpriv into usrp_e

Conflicts:
	host/utils/CMakeLists.txt

3 files changed, 56 insertions, 13 deletions

diff --git a/host/docs/build.rst b/host/docs/build.rst
index d28682764..f5a8dac8d 100644
--- a/host/docs/build.rst
+++ b/host/docs/build.rst
@@ -8,9 +8,14 @@ UHD - Build Guide
 Build Dependencies
 ------------------------------------------------------------------------
 
-**Unix Notes:**
+**Linux Notes:**
 The dependencies can be acquired through the package manager.
 
+**Mac OS X Notes:**
+Install the "Xcode Developer Tools" to get the build tools (gcc and make).
+Use MacPorts to get the Boost and Cheetah dependencies.
+Other dependencies can be downloaded as dmg installers from the web.
+
 **Windows Notes:**
 The dependencies can be acquired through installable exe files.
 Usually, the windows installer can be found on the project's website.
@@ -27,12 +32,13 @@ or install msysgit from http://code.google.com/p/msysgit/downloads/list
 ^^^^^^^^^^^^^^^^
 C++
 ^^^^^^^^^^^^^^^^
-On unix, this is GCC 4.0 and above. On windows, this is MSVC 2008.
+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.
 
 ^^^^^^^^^^^^^^^^
 CMake
 ^^^^^^^^^^^^^^^^
+* **Purpose:** generates project build files
 * **Version:** at least 2.8
 * **Required for:** build time
 * **Download URL:** http://www.cmake.org/cmake/resources/software.html
@@ -40,6 +46,7 @@ CMake
 ^^^^^^^^^^^^^^^^
 Boost
 ^^^^^^^^^^^^^^^^
+* **Purpose:** C++ library
 * **Version:** at least 3.6 unix, at least 4.0 windows
 * **Required for:** build time + run time
 * **Download URL:** http://www.boost.org/users/download/
@@ -48,13 +55,15 @@ Boost
 ^^^^^^^^^^^^^^^^
 Python
 ^^^^^^^^^^^^^^^^
+* **Purpose:** used by Cheetah and utility scripts
 * **Version:** at least 2.6
-* **Required for:** build time
+* **Required for:** build time + run time utility scripts
 * **Download URL:** http://www.python.org/download/
 
 ^^^^^^^^^^^^^^^^
 Cheetah
 ^^^^^^^^^^^^^^^^
+* **Purpose:** source code generation
 * **Version:** at least 2.0
 * **Required for:** build time
 * **Download URL:** http://www.cheetahtemplate.org/download.html
@@ -63,9 +72,17 @@ Cheetah
 ^^^^^^^^^^^^^^^^
 Doxygen
 ^^^^^^^^^^^^^^^^
+* **Purpose:** generates html api documentation
 * **Required for:** build time (optional)
 * **Download URL:** http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
 
+^^^^^^^^^^^^^^^^
+Docutils
+^^^^^^^^^^^^^^^^
+* **Purpose:** generates html user manual
+* **Required for:** build time (optional)
+* **Download URL:** http://docutils.sourceforge.net/
+
 ------------------------------------------------------------------------
 Build Instructions (Unix)
 ------------------------------------------------------------------------
@@ -80,7 +97,7 @@ Generate Makefiles with cmake
     cd build
     cmake ../
 
-For a custom prefix, use: cmake -DCMAKE_INSTALL_PREFIX=<myprefix> ../
+For a custom prefix, use: cmake -DCMAKE_INSTALL_PREFIX=<prefix> ../
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Build and install
@@ -92,11 +109,15 @@ Build and install
     sudo make install
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Setup the library path
+Setup the library path (Linux)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Make sure that libuhd.so is in your LD_LIBRARY_PATH
 or add it to /etc/ld.so.conf and make sure to run sudo ldconfig
 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Setup the library path (Mac OS X)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Make sure that libuhd.dylib is in your DYLD_LIBRARY_PATH
 
 ------------------------------------------------------------------------
 Build Instructions (Windows)
diff --git a/host/docs/dboards.rst b/host/docs/dboards.rst
index d08b752a6..a320f86cb 100644
--- a/host/docs/dboards.rst
+++ b/host/docs/dboards.rst
@@ -62,3 +62,14 @@ not doing so will yeild undefined results.
 The XCVR2450 uses a common LO for both receive and transmit.
 Even though the API allows the RX and TX LOs to be individually set,
 a change of one LO setting will be reflected in the other LO setting.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+WBX Series
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Transmit Antennas: **TX/RX**
+
+Receive Antennas: **TX/RX** or **RX2**
+
+The user may set the receive antenna to be TX/RX or RX2.
+However, when using an RFX board in full-duplex mode,
+the receive antenna will always be set to RX2, regardless of the settings.
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index dfde06b27..1bd95cefa 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -45,22 +45,33 @@ Run the following commands:
 Load the images onto the SD card
 ------------------------------------------------------------------------
 **Warning!**
-Use the u2_flash_tool with caution. If you specify the wrong device node,
+Use the usrp2_card_burner.py 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:
+Use the *--list* option to get a list of possible raw devices.
+The list result will filter out disk partitions and devices too large to be the sd card.
+The list option has been implemented on Linux, Mac OS X, and Windows.
 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Use the card burner tool (unix)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 ::
 
-    cd <uhd-repo-path>/firmware/microblaze
-    sudo ./u2_flash_tool --dev=/dev/sd<XXX> -t fpga -w <path_to_fpga_image>
+    sudo <prefix>/share/uhd/utils/usrp2_card_burner_gui.py
+
+    -- OR --
 
-Load the firmware image:
+    cd <prefix>/share/uhd/utils
+    sudo ./usrp2_card_burner.py --dev=/dev/sd<XXX> --fpga=<path_to_fpga_image>
+    sudo ./usrp2_card_burner.py --dev=/dev/sd<XXX> --fw=<path_to_firmware_image>
 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Use the card burner tool (windows)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 ::
 
-    cd <uhd-repo-path>/firmware/microblaze directory
-    sudo ./u2_flash_tool --dev=/dev/sd<XXX> -t s/w -w <path_to_firmware_image>
+    <path_to_python.exe> <prefix>/share/uhd/utils/usrp2_card_burner_gui.py
+
 
 ------------------------------------------------------------------------
 Setup networking
@@ -103,7 +114,7 @@ Run the following commands:
 ::
 
     cd <prefix>/share/uhd/utils
-    ./usrp_burner --addr=192.168.10.2 --new-ip=192.168.10.3
+    ./usrp_addr_burner --addr=192.168.10.2 --new-ip=192.168.10.3
 
 **Method 2 (Linux Only):**
 This method assumes that you do not know the IP address of your USRP2.