aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/coding.rst
diff options
context:
space:
mode:
authorPhilip Balister <philip@opensdr.com>2011-02-01 05:42:36 -0800
committerPhilip Balister <philip@opensdr.com>2011-02-01 05:42:36 -0800
commit781cddee31078e461202c2cf16f3de2f1f236a27 (patch)
treedcd8e1ff8e696dc00b91b425928a3367f05c9a25 /host/docs/coding.rst
parentcd45fb6be615a6f133e2c62a46f7c5eba76f72c1 (diff)
parent52e9c8f8027d0bbe1e6b0f57e30f985613e48be2 (diff)
downloaduhd-781cddee31078e461202c2cf16f3de2f1f236a27.tar.gz
uhd-781cddee31078e461202c2cf16f3de2f1f236a27.tar.bz2
uhd-781cddee31078e461202c2cf16f3de2f1f236a27.zip
Merge branch 'usrp_e100_devel' of ettus.sourcerepo.com:ettus/uhdpriv into usrp_e100_devel
Conflicts: host/lib/usrp/usrp_e100/clock_ctrl.cpp
Diffstat (limited to 'host/docs/coding.rst')
-rw-r--r--host/docs/coding.rst34
1 files changed, 2 insertions, 32 deletions
diff --git a/host/docs/coding.rst b/host/docs/coding.rst
index 7533445ea..ecca4e8b8 100644
--- a/host/docs/coding.rst
+++ b/host/docs/coding.rst
@@ -23,40 +23,10 @@ The device API provides ways to:
See the documentation in *device.hpp* for reference.
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-High-Level: The single usrp
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The goal of the single usrp API is to wrap high level functions around the device properties.
-The single usrp provides a fat interface to access the most common properties.
-The single usrp provides ways to:
-
-* Set and get daughterboard gains.
-* Set and get daughterboard antennas.
-* Set and get the streaming rates.
-* Tune the DSPs and daughterboards.
-* Issue stream commands.
-* Set the clock configuration.
-* Set the usrp time registers.
-* Get the underlying device (as discussed above).
-
-See the documentation in *usrp/single_usrp.hpp* for reference.
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
High-Level: The multi usrp
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-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 multi usrp provides ways to:
-
-* Set and get the sample rate across all channels.
-* Issue a stream command across all channels.
-* Set the time registers across all channels.
-* Set and get individual daughterboard gains.
-* Set and get individual daughterboard antennas.
-* Tune individual DSPs and daughterboards.
-* Get the underlying device (as discussed above).
-
+The Multi-USRP class provides a FAT interface to a single USRP with
+one or more channels, or multiple USRPs in a homogeneous setup.
See the documentation in *usrp/multi_usrp.hpp* for reference.
------------------------------------------------------------------------