summaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorPhilip Balister <philip@opensdr.com>2010-10-20 20:00:09 -0400
committerPhilip Balister <philip@opensdr.com>2010-10-20 20:00:09 -0400
commit635440c5990e7a27fdb38f694123258633e85427 (patch)
tree603ff2312dd612ea7759432f51ffb7a6c7db3448 /host/docs
parent6b203950d9583ab882628311402e26cf40838aa0 (diff)
parente0c48ba5cc1033cd330e2ce73ceb03740923e954 (diff)
downloaduhd-635440c5990e7a27fdb38f694123258633e85427.tar.gz
uhd-635440c5990e7a27fdb38f694123258633e85427.tar.bz2
uhd-635440c5990e7a27fdb38f694123258633e85427.zip
Merge branch 'master' of ettus.sourcerepo.com:ettus/uhdpriv into usrp_e_mmap_b2
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/build.rst2
-rw-r--r--host/docs/coding.rst8
-rw-r--r--host/docs/dboards.rst38
-rw-r--r--host/docs/transport.rst10
-rw-r--r--host/docs/usrp2.rst2
5 files changed, 43 insertions, 17 deletions
diff --git a/host/docs/build.rst b/host/docs/build.rst
index 9cf37db4a..a41ce8331 100644
--- a/host/docs/build.rst
+++ b/host/docs/build.rst
@@ -47,7 +47,7 @@ CMake
Boost
^^^^^^^^^^^^^^^^
* **Purpose:** C++ library
-* **Version:** at least 3.6 unix, at least 4.0 windows
+* **Version:** at least 1.36 unix, at least 1.40 windows
* **Usage:** build time + run time (required)
* **Download URL:** http://www.boost.org/users/download/
* **Download URL (windows installer):** http://www.boostpro.com/download
diff --git a/host/docs/coding.rst b/host/docs/coding.rst
index d6a19d250..7533445ea 100644
--- a/host/docs/coding.rst
+++ b/host/docs/coding.rst
@@ -41,13 +41,13 @@ The single usrp provides ways to:
See the documentation in *usrp/single_usrp.hpp* for reference.
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-High-Level: The mimo usrp
+High-Level: The multi usrp
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The mimo usrp API provides a wrapper around a device that represents several motherboards.
+The multi usrp API provides a wrapper around a device that represents several motherboards.
This API provides convenience calls just like the single usrp,
however the calls either work across all channels in the configuration,
or take a channel argument to specify which channel to configure.
-The mimo usrp provides ways to:
+The multi usrp provides ways to:
* Set and get the sample rate across all channels.
* Issue a stream command across all channels.
@@ -57,7 +57,7 @@ The mimo usrp provides ways to:
* Tune individual DSPs and daughterboards.
* Get the underlying device (as discussed above).
-See the documentation in *usrp/mimo_usrp.hpp* for reference.
+See the documentation in *usrp/multi_usrp.hpp* for reference.
------------------------------------------------------------------------
Integrating custom hardware
diff --git a/host/docs/dboards.rst b/host/docs/dboards.rst
index 738a0696d..080117651 100644
--- a/host/docs/dboards.rst
+++ b/host/docs/dboards.rst
@@ -49,10 +49,12 @@ Receive Antennas: **J3**
The board has no user selectable antenna setting
-Recieve Gains:
+Receive Gains:
**GC1**, Range: 0-56dB
**GC2**, Range: 0-24dB
+Low-Pass Filter Bandwidth (Hz): 4M-33M
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
RFX Series
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -64,26 +66,25 @@ 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.
-Recieve Gains: **PGA0**, Range: 0-70dB (except RFX400 range is 0-45dB)
+Receive Gains: **PGA0**, Range: 0-70dB (except RFX400 range is 0-45dB)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
XCVR 2450
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The XCVR2450 has a non-contiguous tuning range consisting of a high band and a low band.
-The high band consists of frequencies between...TODO
+The XCVR2450 has a non-contiguous tuning range consisting of a
+high band (4.9-6.0GHz) and a low band (2.4-2.5GHz).
Transmit Antennas: **J1** or **J2**
Receive Antennas: **J1** or **J2**
-When using the XCVR2450 in full-duplex mode,
-the user must set the receive antenna and the transmit antenna to be different;
-not doing so will yeild undefined results.
-
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.
+The XCVR2450 does not support full-duplex mode, attempting to operate
+in full-duplex will result in transmit-only operation.
+
Transmit Gains:
* **VGA**, Range: 0-30dB
* **BB**, Range: 0-5dB
@@ -92,6 +93,10 @@ Receive Gains:
* **LNA**, Range: 0-30.5dB
* **VGA**, Range: 0-62dB
+Low-Pass Filter Bandwidths (Hz):
+ * **RX**: 7.5M, 9.5M, 14M, 18M; (each +-0, 5, or 10%)
+ * **TX**: 12M, 18M, 24M
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
WBX Series
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -105,7 +110,22 @@ the receive antenna will always be set to RX2, regardless of the settings.
Transmit Gains: **PGA0**, Range: 0-25dB
-Recieve Gains: **PGA0**, Range: 0-31.5dB
+Receive Gains: **PGA0**, Range: 0-31.5dB
+
+Low-Pass Filter Bandwidths (Hz):
+ * **RX**: 20M (Fixed)
+ * **TX**: 20M (Fixed)
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+TVRX
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Receive Antennas: RX
+
+Receive Gains:
+ * **RF**, Range: -13.3-50.3dB (frequency-dependent)
+ * **IF**, Range: -1.5-32.5dB
+
+Bandpass Filter Bandwidth: 6MHz
------------------------------------------------------------------------
Daughterboard Modifications
diff --git a/host/docs/transport.rst b/host/docs/transport.rst
index 30fc1d78f..432db4bb5 100644
--- a/host/docs/transport.rst
+++ b/host/docs/transport.rst
@@ -4,6 +4,10 @@ UHD - Transport Application Notes
.. contents:: Table of Contents
+------------------------------------------------------------------------
+Introduction
+------------------------------------------------------------------------
+A transport is the layer between the packet interface and a device IO interface.
The advanced user can pass optional parameters
into the underlying transport layer through the device address.
These optional parameters control how the transport object allocates memory,
@@ -32,6 +36,9 @@ The following parameters can be used to alter the transport's default behavior:
* **num_send_frames:** The number of send buffers to allocate
* **concurrency_hint:** The number of threads to run the IO service
+**Note:** num_send_frames and concurrency_hint will not have an effect
+as the asynchronous send implementation is currently disabled.
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Resize socket buffers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -67,8 +74,7 @@ The USB transport is implemented with libusb.
Libusb provides an asynchronous API for USB bulk transfers.
The transport implementation allocates a number of buffers
and submits asynchronous requests through libusb.
-A single thread runs in the background
-and executes the libusb event handler to process these requests.
+Event handler threads run in the background to process these requests.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Transport parameters
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 1ebab388a..0ddcaa4e5 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -158,7 +158,7 @@ The value for the addr key is a white-space separated list
of IPv4 addresses or resolvable hostnames.
The first address in the list will represent channel 0,
the second channel 1, and so on...
-Use this addressing scheme with the *mimo_usrp* interface.
+Use this addressing scheme with the *multi_usrp* interface.
The device address string representation for 2 USRP2s with IPv4 addresses 192.168.10.2 and 192.168.20.2
::