summaryrefslogtreecommitdiffstats
path: root/host/docs/general.rst
diff options
context:
space:
mode:
authorJason Abele <jason@ettus.com>2011-07-22 15:57:31 -0700
committerJosh Blum <josh@joshknows.com>2011-08-05 11:18:41 -0700
commit885cc430ae9b7a3c877484cdb396109c63261694 (patch)
tree13eddfe330ebb60ff495168c429b265d3c6e8f29 /host/docs/general.rst
parentcbd7ff3ad330af66152dea04559910a013dd7a87 (diff)
downloaduhd-885cc430ae9b7a3c877484cdb396109c63261694.tar.gz
uhd-885cc430ae9b7a3c877484cdb396109c63261694.tar.bz2
uhd-885cc430ae9b7a3c877484cdb396109c63261694.zip
Added documentation for subdevice specifications
Diffstat (limited to 'host/docs/general.rst')
-rw-r--r--host/docs/general.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/host/docs/general.rst b/host/docs/general.rst
index 7952abb8b..e1c93b13a 100644
--- a/host/docs/general.rst
+++ b/host/docs/general.rst
@@ -61,6 +61,52 @@ Pseudo-code for dealing with settling time after tuning on receive:
usrp->issue_stream_command(...);
------------------------------------------------------------------------
+Specifying the subdevice to use
+------------------------------------------------------------------------
+A subdevice specification string for USRP family devices is composed of:
+
+::
+
+ <motherboard slot name>:<daughterboard frontend name>
+
+Ex: The subdev spec markup string to select a WBX on slot B.
+
+::
+
+ B:0
+
+Ex: The subdev spec markup string to select a BasicRX on slot B.
+
+::
+
+ B:AB
+
+ -- OR --
+
+ B:A
+
+ -- OR --
+
+ B:B
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+USRP Family Motherboard Slot Names
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+All USRP family motherboards have a first slot named **A:**. The USRP1 has
+two daughterboard subdevice slots, known as **A:** and **B:**.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Daughterboard Frontend Names
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Daughterboard frontend names can be used to specify which signal path is used
+from a daughterboard. Most daughterboards have only one frontend **:0**. A few
+daughterboards (Basic, LF and TVRX2) have multiple frontend names available.
+The frontend names are documented in the
+`Daughterboard Application Notes <./dboards.html>`_
+
+------------------------------------------------------------------------
Overflow/Underflow notes
------------------------------------------------------------------------
**Note:** The following overflow/underflow notes do not apply to USRP1,