Merge branch 'usrp1' into next

1 files changed, 76 insertions, 0 deletions

diff --git a/host/docs/usrp1.rst b/host/docs/usrp1.rst
new file mode 100644
index 000000000..c960b928b
--- /dev/null
+++ b/host/docs/usrp1.rst
@@ -0,0 +1,76 @@
+========================================================================
+UHD - USRP1 Application Notes
+========================================================================
+
+.. contents:: Table of Contents
+
+------------------------------------------------------------------------
+Addressing the device
+------------------------------------------------------------------------
+A USRP1 can be identified though its serial number,
+designated by the "serial" key in the device address.
+
+The device address string representation for a USRP1 with serial 1234
+
+::
+
+    serial=1234
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Change the USRP1's serial number
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+TODO
+
+------------------------------------------------------------------------
+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
+