summaryrefslogtreecommitdiffstats
path: root/host/docs/coding.rst
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-07-07 02:23:38 +0000
committerJosh Blum <josh@joshknows.com>2010-07-07 02:23:38 +0000
commitf2e9d3ed0941dc5738149dd82d1eac158bdf0a0f (patch)
tree82a350987e32cd329ab5fe56b6dd9fbfef08230f /host/docs/coding.rst
parent998fee6ef064f1d53a61dd0eec79276d1e85291e (diff)
parent5c2cccfe8c4a9c6c912a4d18dc1e7a6f84c79609 (diff)
downloaduhd-f2e9d3ed0941dc5738149dd82d1eac158bdf0a0f.tar.gz
uhd-f2e9d3ed0941dc5738149dd82d1eac158bdf0a0f.tar.bz2
uhd-f2e9d3ed0941dc5738149dd82d1eac158bdf0a0f.zip
Merge branch 'master' of ettus.sourcerepo.com:ettus/uhdpriv into usrp_e
Conflicts: host/examples/rx_timed_samples.cpp
Diffstat (limited to 'host/docs/coding.rst')
-rw-r--r--host/docs/coding.rst37
1 files changed, 29 insertions, 8 deletions
diff --git a/host/docs/coding.rst b/host/docs/coding.rst
index 689667f30..84f9abf3e 100644
--- a/host/docs/coding.rst
+++ b/host/docs/coding.rst
@@ -5,8 +5,11 @@ UHD - Coding to the API
.. contents:: Table of Contents
------------------------------------------------------------------------
-Low-Level: The device API
+Various API interfaces
------------------------------------------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Low-Level: The device API
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
A device is an abstraction for hardware that is connected to the host system.
For a USRP, this means that the motherboard and everything on it would be considered to be a "device".
The device API provides ways to:
@@ -17,12 +20,12 @@ The device API provides ways to:
* Streaming samples with metadata into and out of the device.
* Set and get properties on the device object.
-See the documentation in device.hpp for reference.
+See the documentation in *device.hpp* for reference.
-------------------------------------------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
High-Level: The simple usrp
-------------------------------------------------------------------------
-The goal of the simple usrp is to wrap high level functions around the device properties.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The goal of the simple usrp API is to wrap high level functions around the device properties.
The simple usrp provides a fat interface to access the most common properties.
The simple usrp provides ways to:
@@ -35,14 +38,32 @@ The simple usrp provides ways to:
* Set the usrp time registers.
* Get the underlying device (as discussed above).
-It is recommended that users code to the simple_usrp api when possible.
-See the documentation in usrp/simple_usrp.hpp for reference.
+See the documentation in *usrp/simple_usrp.hpp* for reference.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+High-Level: The mimo usrp
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The mimo usrp API provides a wrapper around a device that represents several motherboards.
+This API provides convenience calls just like the simple 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:
+
+* 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).
+
+See the documentation in *usrp/mimo_usrp.hpp* for reference.
------------------------------------------------------------------------
Integrating custom hardware
------------------------------------------------------------------------
Creators of custom hardware can create drivers that use the UHD API.
-These drivers can be built as dynamically lodable modules that the UHD will load at runtime.
+These drivers can be built as dynamically loadable modules that the UHD will load at runtime.
For a module to be loaded at runtime, it must be found in the UHD_MODULE_PATH environment variable.
^^^^^^^^^^^^^^^^^^^^^^^^^^^