From ca6417739de4e5344325e96887dcdbf8311e265b Mon Sep 17 00:00:00 2001
From: Josh Blum <josh@joshknows.com>
Date: Tue, 15 Jun 2010 15:06:18 -0700
Subject: uhd: added ability to boost rt priority, added general app notes

---
 host/docs/CMakeLists.txt |  1 +
 host/docs/general.rst    | 79 ++++++++++++++++++++++++++++++++++++++++++++++++
 host/docs/index.rst      |  3 +-
 3 files changed, 82 insertions(+), 1 deletion(-)
 create mode 100644 host/docs/general.rst

(limited to 'host/docs')

diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index 61eede8b7..d0041f71c 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -23,6 +23,7 @@ SET(manual_sources
     build.rst
     coding.rst
     dboards.rst
+    general.rst
     usrp2.rst
 )
 
diff --git a/host/docs/general.rst b/host/docs/general.rst
new file mode 100644
index 000000000..7d1f467a0
--- /dev/null
+++ b/host/docs/general.rst
@@ -0,0 +1,79 @@
+========================================================================
+UHD - General Application Notes
+========================================================================
+
+.. contents:: Table of Contents
+
+------------------------------------------------------------------------
+Finding devices
+------------------------------------------------------------------------
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Device addressing
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Deviced are addressed through key/value string pairs.
+These string pairs can be used to narrow down the search for a specific device or group of devices.
+Most UHD utility applications and examples have a --args parameter that takes a device address;
+where the device address is expressed as a delimited string.
+
+* See the documentation in types/device_addr.hpp for reference.
+* See device-specific application notes for usage.
+
+**Example:**
+::
+
+    serial=0x1234, type=usrpx
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Device discovery
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Devices attached to your system can be discovered using the "uhd_find_devices" program.
+The find devices program scans your system for supported devices and prints
+out an enumerated list of discovered devices and their addresses.
+The list of discovered devices can be narrowed down by specifying device address args.
+
+**Usage:**
+::
+
+    uhd_find_devices
+
+    -- OR --
+
+    uhd_find_devices --args <device-specific-address-args>
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Device properties
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Properties of devices attached to your system can be probed with the "uhd_usrp_probe" program.
+The usrp probe program contructs an instance of the device and prints out its properties;
+properties such as detected daughter-boards, frequency range, gain ranges, etc...
+
+**Usage:**
+::
+
+    uhd_usrp_probe --args <device-specific-address-args>
+
+------------------------------------------------------------------------
+Misc notes
+------------------------------------------------------------------------
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Process scheduling
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The UHD will try to automatically boost the process's scheduling priority.
+Currently, this is only supported on platforms with *sched.h*.
+
+When setting the priority fails, the UHD prints out an error.
+This error is harmless, it simply means that your process will have a normal scheduling priority.
+
+**Linux Notes:**
+
+Non-privileged users need special permission to change the scheduling priority.
+Add the following line to */etc/security/limits.conf*:
+::
+
+    @<my_group>    -    rtprio    99
+
+Replace <my_group> with a group to which your user belongs.
+Settings will not take effect until the user has logged in and out.
diff --git a/host/docs/index.rst b/host/docs/index.rst
index 3dc7a2d98..b31a3d0ac 100644
--- a/host/docs/index.rst
+++ b/host/docs/index.rst
@@ -18,8 +18,9 @@ Building the UHD
 * `Build Guide <./build.html>`_
 
 ^^^^^^^^^^^^^^^^^^^^^
-Supported Devices
+Application Notes
 ^^^^^^^^^^^^^^^^^^^^^
+* `General App Notes <./general.html>`_
 * `USRP2 App Notes <./usrp2.html>`_
 * `Daughterboard App Notes <./dboards.html>`_
 
-- 
cgit v1.2.3