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

6 files changed, 145 insertions, 1 deletions

diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index b4383f88d..bbb8812b0 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -25,6 +25,7 @@ SET(manual_sources
     dboards.rst
     general.rst
     images.rst
+    usrp1.rst
     usrp2.rst
 )
 
diff --git a/host/docs/build.rst b/host/docs/build.rst
index 8f0d0db59..d7dfd05e5 100644
--- a/host/docs/build.rst
+++ b/host/docs/build.rst
@@ -53,6 +53,14 @@ Boost
 * **Download URL (windows installer):** http://www.boostpro.com/download
 
 ^^^^^^^^^^^^^^^^
+LibUSB
+^^^^^^^^^^^^^^^^
+* **Purpose:** USB userspace library
+* **Version:** at least 1.0
+* **Required for:** build time + run time (optional)
+* **Download URL:** http://www.libusb.org/
+
+^^^^^^^^^^^^^^^^
 Python
 ^^^^^^^^^^^^^^^^
 * **Purpose:** used by Cheetah and utility scripts
diff --git a/host/docs/dboards.rst b/host/docs/dboards.rst
index b66fd2069..0f6d1cfeb 100644
--- a/host/docs/dboards.rst
+++ b/host/docs/dboards.rst
@@ -28,7 +28,11 @@ greater than the Nyquist rate of the ADC.
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Basic TX and and LFTX
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The Basic TX and LFTX boards have 1 quadrature subdevice using both antennas.
+The Basic TX and LFTX boards have 3 subdevices:
+
+* **Subdevice A:** real signal on antenna TXA
+* **Subdevice B:** real signal on antenna TXB
+* **Subdevice AB:** quadrature subdevice using both antennas
 
 The boards have no tunable elements or programmable gains.
 Though the magic of aliasing, you can up-convert signals
diff --git a/host/docs/index.rst b/host/docs/index.rst
index 6973ede19..bd55edc0b 100644
--- a/host/docs/index.rst
+++ b/host/docs/index.rst
@@ -22,6 +22,7 @@ Application Notes
 ^^^^^^^^^^^^^^^^^^^^^
 * `General App Notes <./general.html>`_
 * `Firmware and FPGA Image Notes <./images.html>`_
+* `USRP1 App Notes <./usrp1.html>`_
 * `USRP2 App Notes <./usrp2.html>`_
 * `Daughterboard App Notes <./dboards.html>`_
 
diff --git a/host/docs/usrp1.rst b/host/docs/usrp1.rst
new file mode 100644
index 000000000..3c1431d30
--- /dev/null
+++ b/host/docs/usrp1.rst
@@ -0,0 +1,115 @@
+========================================================================
+UHD - USRP1 Application Notes
+========================================================================
+
+.. contents:: Table of Contents
+
+------------------------------------------------------------------------
+Addressing the device
+------------------------------------------------------------------------
+A USRP1 can be identified though its 8 digit serial number,
+designated by the "serial" key in the device address.
+
+The device address string representation for a USRP1 with serial 12345678:
+
+::
+
+    serial=12345678
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Change the serial number
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The USRP1 serial number can be changed to any 8 byte string. Examples:
+
+::
+
+    cd <prefix>/share/uhd/utils
+    ./usrp1_serial_burner --new=87654321
+
+    -- OR --
+
+    ./usrp1_serial_burner --new=Beatrice
+
+    -- OR --
+
+    ./usrp1_serial_burner --old=12345678 --new=87654321
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Specify a non-standard image
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The standard USRP1 images installer comes with two FPGA images:
+ * **usrp1_fpga.rbf:** 2 DDCs + 2 DUCs
+ * **usrp1_fpga_4rx.rbf:** 4 DDCs + 0 DUCs
+
+By default, the USRP1 uses the FPGA image with 2 DDCs and 2 DUCs.
+However, a device address parameter can be used to override
+the FPGA image selection to use an alternate or a custom FPGA image.
+See the images application notes for installing custom images.
+
+Example device address string representations to specify non-standard firmware and/or FPGA images:
+
+::
+
+    fpga=usrp1_fpga_4rx.rbf
+
+    -- OR --
+
+    fw=usrp1_fw_custom.ihx
+
+    -- OR --
+
+    fpga=usrp1_fpga_4rx.rbf, fw=usrp1_fw_custom.ihx
+
+------------------------------------------------------------------------
+Specifying the subdevice to use
+------------------------------------------------------------------------
+The USRP1 has multiple daughterboard slots, known as slot A and slot B.
+The subdevice specification can be used to select
+the daughterboard and subdevice for each channel.
+For daughterboards with one one subdevice,
+the subdevice name may be left blank for automatic selection.
+
+Ex: The subdev spec markup string to select a WBX on slot B.
+Notice the use of the blank subdevice name for automatic selection.
+
+::
+
+    B:
+
+    -- OR --
+
+    B:0
+
+Ex: The subdev spec markup string to select a BasicRX on slot B.
+Notice that the subdevice name is always specified in the 3 possible cases.
+
+::
+
+    B:AB
+
+    -- OR --
+
+    B:A
+
+    -- OR --
+
+    B:B
+
+------------------------------------------------------------------------
+OS Specific Notes
+------------------------------------------------------------------------
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Setup Udev on Linux
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+On Linux, Udev handles USB plug and unplug events.
+The following command creates a Udev rule for the USRP1
+so that non-root users may access the device:
+
+::
+
+    echo 'ACTION=="add", BUS=="usb", SYSFS{idVendor}=="fffe", SYSFS{idProduct}=="0002", MODE:="0666"' > tmpfile
+    sudo chown root.root tmpfile
+    sudo mv tmpfile /etc/udev/rules.d/10-usrp.rules
+    sudo udevadm control --reload-rules
+
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 3ac326f58..0d48209be 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -205,3 +205,18 @@ Example, set the args string to the following:
 ::
 
     addr=192.168.10.2, recv_buff_size=100e6
+
+------------------------------------------------------------------------
+Hardware setup notes
+------------------------------------------------------------------------
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Ref Clock - 10MHz
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Using an external 10MHz reference clock requires a signal level between +5dBm and +20dBm at 10MHz applied to the Ref Clock SMA port on the front panel.
+
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+PPS - Pulse Per Second
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Using a PPS signal for timestamp synchronization requires a 5Vpp square wave signal