aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/dboards.dox
diff options
context:
space:
mode:
authormattprost <matt.prost@ni.com>2020-03-19 17:39:22 -0500
committerAaron Rossetto <aaron.rossetto@ni.com>2020-03-31 15:06:03 -0500
commit6728ec40be65ce3e329dcf559d0b330905354dab (patch)
tree0a6b3ab7d1e6abc37d56225bbef4b9fc2b2a5cc5 /host/docs/dboards.dox
parentf894cf0c0dea22a214de44219d954adeb851dfb1 (diff)
downloaduhd-6728ec40be65ce3e329dcf559d0b330905354dab.tar.gz
uhd-6728ec40be65ce3e329dcf559d0b330905354dab.tar.bz2
uhd-6728ec40be65ce3e329dcf559d0b330905354dab.zip
docs: Update Basic/LF dboard references to use new operating mode
On the new RFNoC with UHD 4.0 architecture, Basic/LF dboards use a new operating paradigm. The streaming mode (real mode or complex) is determined by setting the antennas (to A/B or AB/BA respectively). Basic/LF RX dboards also support 2 frontends (0 and 1), and Basic/LF TX dboards support 1 frontend (0). This new behavior only applies to applicable RFNoC devices (currently X300/X310). All pre-RFNoC devices (i.e. USRP2/N200 and earlier) maintain legacy behavior. RFNoC with UHD 3.xx branches also maintains old behavior. Signed-off-by: mattprost <matt.prost@ni.com>
Diffstat (limited to 'host/docs/dboards.dox')
-rw-r--r--host/docs/dboards.dox50
1 files changed, 30 insertions, 20 deletions
diff --git a/host/docs/dboards.dox b/host/docs/dboards.dox
index e8ee4a8ca..e12a7daff 100644
--- a/host/docs/dboards.dox
+++ b/host/docs/dboards.dox
@@ -13,17 +13,27 @@ of each board as well.
The Basic RX and LFRX boards have four modes of operation:
-- **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)
+- **Antenna Mode A:** real signal from antenna RXA
+- **Antenna Mode B:** real signal from antenna RXB
+- **Antenna Mode AB:** complex signal using both antennas (IQ)
+- **Antenna Mode BA:** complex signal using both antennas (QI)
-The way in which you select the mode depends on the USRP type. On the X310,
-selecting the mode is done using the antenna API:
+The way in which you select the mode depends on the USRP type.
+
+The X300 series will create subdevices 0 and 1 for each BasicRX or LFRX board.
+The default is to make a channel for each subdevice. That can be controlled by
+setting the subdev spec:
+
+```cpp
+auto usrp = uhd::usrp::multi_usrp::make("type=x300");
+usrp->set_rx_subdev_spec("A:1"); // Only 1 channel using subdevice 1 on Radio A
+```
+
+The antenna mode is selected for each channel using the antenna API:
```cpp
auto usrp = uhd::usrp::multi_usrp::make("type=x300");
-usrp->set_rx_antenna("A"); // Disable RXB port
+usrp->set_rx_antenna("A", 0); // Disable RXB port on channel 0
```
On the USRP2, the N200 series, the B100 series, the E100, and the USRP1 the mode
@@ -40,22 +50,22 @@ rate of the ADC.
BasicRX Bandwidth:
-- **For Real-Mode (A or B frontend)**: 250 MHz
-- **For Complex (AB or BA frontend)**: 500 MHz
+- **For Real-Mode (Antenna Mode A or B)**: 250 MHz
+- **For Complex (Antenna Mode AB or BA)**: 500 MHz
LFRX Bandwidth:
-- **For Real-Mode (A or B frontend)**: 33 MHz
-- **For Complex (AB or BA frontend)**: 66 MHz
+- **For Real-Mode (Antenna Mode A or B)**: 33 MHz
+- **For Complex (Antenna Mode AB or BA)**: 66 MHz
\subsection dboards_basictx Basic TX and LFTX
-The Basic TX and LFTX boards have 4 frontends:
+The Basic TX and LFTX boards have 4 modes of operation:
-- **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)
+- **Antenna Mode A:** real signal from antenna TXA
+- **Antenna Mode B:** real signal from antenna TXB
+- **Antenna Mode AB:** complex signal using both antennas (IQ)
+- **Antenna Mode BA:** complex signal using both antennas (QI)
The boards have no tunable elements or programmable gains. Through the
magic of aliasing, you can up-convert signals greater than the Nyquist
@@ -63,13 +73,13 @@ rate of the DAC.
BasicTX Bandwidth:
-- **For Real-Mode (A or B frontend**): 250 MHz
-- **For Complex (AB or BA frontend)**: 500 MHz
+- **For Real-Mode (Antenna Mode A or B**): 250 MHz
+- **For Complex (Antenna Mode AB or BA)**: 500 MHz
LFTX Bandwidth:
-- **For Real-Mode (A or B frontend)**: 33 MHz
-- **For Complex (AB or BA frontend)**: 66 MHz
+- **For Real-Mode (Antenna Mode A or B)**: 33 MHz
+- **For Complex (Antenna Mode AB or BA)**: 66 MHz
\subsection dboards_dbsrx DBSRX