Added documentation for subdevice specifications

3 files changed, 89 insertions, 56 deletions

diff --git a/host/docs/dboards.rst b/host/docs/dboards.rst
index 593dd3a42..218498dd2 100644
--- a/host/docs/dboards.rst
+++ b/host/docs/dboards.rst
@@ -15,12 +15,12 @@ properties of each board as well.
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Basic RX and and LFRX
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The Basic RX and LFRX boards have 4 subdevices:
+The Basic RX and LFRX boards have 4 frontends:
 
-* **Subdevice A:** real signal on antenna RXA
-* **Subdevice B:** real signal on antenna RXB
-* **Subdevice AB:** quadrature subdevice using both antennas (IQ)
-* **Subdevice BA:** quadrature subdevice using both antennas (QI)
+* **Frontend A:** real signal on antenna RXA
+* **Frontend B:** real signal on antenna RXB
+* **Frontend AB:** quadrature frontend using both antennas (IQ)
+* **Frontend BA:** quadrature frontend using both antennas (QI)
 
 The boards have no tunable elements or programmable gains.
 Though the magic of aliasing, you can down-convert signals
@@ -28,23 +28,23 @@ greater than the Nyquist rate of the ADC.
 
 BasicRX Bandwidth (Hz): 
 
-* For Real-Mode (A or B subdevice): 250M
-* For Complex (AB or BA subdevice): 500M
+* For Real-Mode (A or B frontend): 250M
+* For Complex (AB or BA frontend): 500M
 
 LFRX Bandwidth (Hz):
 
-* For Real-Mode (A or B subdevice): 33M
-* For Complex (AB or BA subdevice): 66M
+* For Real-Mode (A or B frontend): 33M
+* For Complex (AB or BA frontend): 66M
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Basic TX and and LFTX
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The Basic TX and LFTX boards have 4 subdevices:
+The Basic TX and LFTX boards have 4 frontends:
 
-* **Subdevice A:** real signal on antenna TXA
-* **Subdevice B:** real signal on antenna TXB
-* **Subdevice AB:** quadrature subdevice using both antennas (IQ)
-* **Subdevice BA:** quadrature subdevice using both antennas (QI)
+* **Frontend A:** real signal on antenna TXA
+* **Frontend B:** real signal on antenna TXB
+* **Frontend AB:** quadrature frontend using both antennas (IQ)
+* **Frontend BA:** quadrature frontend using both antennas (QI)
 
 The boards have no tunable elements or programmable gains.
 Though the magic of aliasing, you can up-convert signals
@@ -52,22 +52,24 @@ greater than the Nyquist rate of the DAC.
 
 BasicTX Bandwidth (Hz): 250M
 
-* For Real-Mode (A or B subdevice): 250M
-* For Complex (AB or BA subdevice): 500M
+* For Real-Mode (A or B frontend): 250M
+* For Complex (AB or BA frontend): 500M
 
 LFTX Bandwidth (Hz): 33M
 
-* For Real-Mode (A or B subdevice): 33M
-* For Complex (AB or BA subdevice): 66M
+* For Real-Mode (A or B frontend): 33M
+* For Complex (AB or BA frontend): 66M
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 DBSRX
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The DBSRX board has 1 quadrature subdevice.  
+The DBSRX board has 1 quadrature frontend.  
 It defaults to direct conversion, but can use a low IF through lo_offset in uhd::tune_request_t
 
 Receive Antennas: **J3**
 
+* **Frontend 0:** Complex baseband signal from antenna J3
+
 The board has no user selectable antenna setting
 
 Receive Gains:
@@ -84,11 +86,13 @@ Sensors:
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 DBSRX2
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The DBSRX2 board has 1 quadrature subdevice.
+The DBSRX2 board has 1 quadrature frontend.
 It defaults to direct conversion, but can use a low IF through lo_offset in uhd::tune_request_t
 
 Receive Antennas: **J3**
 
+* **Frontend 0:** Complex baseband signal from antenna J3
+
 The board has no user selectable antenna setting
 
 Receive Gains:
@@ -105,7 +109,7 @@ Sensors:
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 RFX Series
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The RFX Series boards have 2 quadrature subdevices, one transmit, one receive.
+The RFX Series boards have 2 quadrature frontends, one transmit, one receive.
 Transmit defaults to low IF and Receive defaults to direct conversion.
 The IF can be adjusted through lo_offset in uhd::tune_request_t
 
@@ -116,6 +120,8 @@ Transmit Antennas: **TX/RX**
 
 Receive Antennas: **TX/RX** or **RX2**
 
+* **Frontend 0:** Complex baseband signal for selected antenna
+
 The user may set the receive antenna to be TX/RX or RX2.
 However, when using an RFX board in full-duplex mode,
 the receive antenna will always be set to RX2, regardless of the settings.
@@ -135,7 +141,7 @@ Sensors:
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 XCVR 2450
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The XCVR2450 has 2 quadrature subdevices, one transmit, one receive.
+The XCVR2450 has 2 quadrature frontends, one transmit, one receive.
 Transmit and Receive default to direct conversion but
 can be used in low IF mode through lo_offset in uhd::tune_request_t
 
@@ -146,6 +152,8 @@ Transmit Antennas: **J1** or **J2**
 
 Receive Antennas: **J1** or **J2**
 
+* **Frontend 0:** Complex baseband signal for selected antenna
+
 The XCVR2450 uses a common LO for both receive and transmit.
 Even though the API allows the RX and TX LOs to be individually set,
 a change of one LO setting will be reflected in the other LO setting.
@@ -176,7 +184,7 @@ Sensors:
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 WBX Series
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The WBX Series boards have 2 quadrature subdevices, one transmit, one receive.
+The WBX Series boards have 2 quadrature frontends, one transmit, one receive.
 Transmit and Receive default to direct conversion but
 can be used in low IF mode through lo_offset in uhd::tune_request_t
 
@@ -187,6 +195,8 @@ Transmit Antennas: **TX/RX**
 
 Receive Antennas: **TX/RX** or **RX2**
 
+* **Frontend 0:** Complex baseband signal for selected antenna
+
 The user may set the receive antenna to be TX/RX or RX2.
 However, when using an WBX board in full-duplex mode,
 the receive antenna will always be set to RX2, regardless of the settings.
@@ -207,7 +217,7 @@ Sensors:
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 SBX Series
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The SBX Series boards have 2 quadrature subdevices, one transmit, one receive.
+The SBX Series boards have 2 quadrature frontends, one transmit, one receive.
 Transmit and Receive default to direct conversion but
 can be used in low IF mode through lo_offset in uhd::tune_request_t
 
@@ -218,6 +228,8 @@ Transmit Antennas: **TX/RX**
 
 Receive Antennas: **TX/RX** or **RX2**
 
+* **Frontend 0:** Complex baseband signal for selected antenna
+
 The user may set the receive antenna to be TX/RX or RX2.
 However, when using an SBX board in full-duplex mode,
 the receive antenna will always be set to RX2, regardless of the settings.
@@ -246,11 +258,13 @@ LEDs:
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 TVRX
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The TVRX board has 1 real-mode subdevice.
+The TVRX board has 1 real-mode frontend.
 It is operated at a low IF.
 
 Receive Antennas: RX
 
+* **Frontend 0:** real-mode baseband signal from antenna RX
+
 Receive Gains:
 
 * **RF**, Range: -13.3-50.3dB (frequency-dependent)
@@ -261,13 +275,13 @@ Bandwidth: 6MHz
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 TVRX2
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The TVRX2 board has 2 real-mode subdevices.
+The TVRX2 board has 2 real-mode frontends.
 It is operated at a low IF.
 
-Receive Subdevices:
+Receive Frontends:
 
-* **Subdevice RX1:** real signal on antenna J100
-* **Subdevice RX2:** real signal on antenna J140
+* **Frontend RX1:** real-mode baseband from antenna J100
+* **Frontend RX2:** real-mode baseband from antenna J140
 
 Note: The TVRX2 has always-on AGC, the software controllable gain is the
 final gain stage which controls the AGC set-point for output to ADC.
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,
diff --git a/host/docs/usrp1.rst b/host/docs/usrp1.rst
index 71b4f6779..de9950c7c 100644
--- a/host/docs/usrp1.rst
+++ b/host/docs/usrp1.rst
@@ -31,33 +31,6 @@ Example device address string representations to specify non-standard firmware a
     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 map an RF frontend to a DSP.
-An RF frontend is identified by the daughterboard slot name and subdevice 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
-
-------------------------------------------------------------------------
 Missing and emulated features
 ------------------------------------------------------------------------
 The USRP1 FPGA does not have the necessary space to support the advanced