summaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/CMakeLists.txt1
-rw-r--r--host/docs/index.rst1
-rw-r--r--host/docs/usrp1.rst41
3 files changed, 43 insertions, 0 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/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..ebc33cbfa
--- /dev/null
+++ b/host/docs/usrp1.rst
@@ -0,0 +1,41 @@
+========================================================================
+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
+
+------------------------------------------------------------------------
+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
+