Merge branch 'next'

Conflicts:
	host/lib/usrp/usrp2/codec_impl.cpp

4 files changed, 103 insertions, 13 deletions

diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index 592d66526..ace48f008 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -1,5 +1,5 @@
 #
-# Copyright 2010 Ettus Research LLC
+# Copyright 2010-2011 Ettus Research LLC
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -36,7 +36,7 @@ SET(manual_sources
 # Setup Manual
 ########################################################################
 MESSAGE(STATUS "")
-FIND_PACKAGE(Docutils REQUIRED)
+FIND_PACKAGE(Docutils)
 
 LIBUHD_REGISTER_COMPONENT("Manual" ENABLE_MANUAL ON "DOCUTILS_FOUND" OFF)
 
diff --git a/host/docs/transport.rst b/host/docs/transport.rst
index d9abd4923..018f909c1 100644
--- a/host/docs/transport.rst
+++ b/host/docs/transport.rst
@@ -36,7 +36,7 @@ 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
+**Note:** num_send_frames will not have an effect
 as the asynchronous send implementation is currently disabled.
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/host/docs/usrp1.rst b/host/docs/usrp1.rst
index 9038616a8..0a8224850 100644
--- a/host/docs/usrp1.rst
+++ b/host/docs/usrp1.rst
@@ -4,9 +4,9 @@ UHD - USRP1 Application Notes
 
 .. contents:: Table of Contents
 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------------------------------------------------------------
 Specify a non-standard image
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------------------------------------------------------------
 The standard USRP1 images installer comes with two FPGA images:
  * **usrp1_fpga.rbf:** 2 DDCs + 2 DUCs
  * **usrp1_fpga_4rx.rbf:** 4 DDCs + 0 DUCs
@@ -66,7 +66,37 @@ Notice that the subdevice name is always specified in the 3 possible cases.
     B:B
 
 ------------------------------------------------------------------------
-OS Specific Notes
+Missing and emulated features
+------------------------------------------------------------------------
+The USRP1 FPGA does not have the necessary space to support the advanced
+streaming capabilities that are possible with the newer USRP devices.
+Some of these features are emulated in software to support the API.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+List of emulated features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* Setting the current device time
+* Getting the current device time
+* Transmitting at a specific time
+* Receiving at a specific time
+* Receiving a specific number of samples
+* End of burst flags for transmit/receive
+
+**Note:**
+These emulated features rely on the host system's clock for timed operations,
+and therefore may not have sufficient precision for the application.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+List of missing features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* Notification on late stream command
+* Notification on late transmit packet
+* Notification on broken chain error
+* Notification on underflow or overflow
+* Start of burst flags for transmit/receive
+
+------------------------------------------------------------------------
+OS specific notes
 ------------------------------------------------------------------------
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -90,13 +120,13 @@ On Windows, a driver must be installed the first time the USRP1 is attached to t
 A download link for this driver can be found on the UHD wiki page.
 Download and unpack the driver, and direct the Windows driver install wizard to the .inf file.
 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Hardware setup notes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
 ------------------------------------------------------------------------
-External Clock Modification
+Hardware setup notes
 ------------------------------------------------------------------------
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+External clock modification
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 The USRP can be modified to accept an external clock reference instead of the 64MHz onboard reference.
  * Solder SMA (LTI-SASF54GT) connector to J2001
  * Move 0 ohm 0603 resistor R2029 to R2930
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 8e5743102..3031a0075 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -101,7 +101,7 @@ On some systems, the firewall will block UDP broadcast packets.
 It is recommended that you change or disable your firewall settings.
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Multiple device configuration
+Multiple devices per host
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 For maximum throughput, one ethernet interface per USRP2 is recommended,
 although multiple devices may be connected via a gigabit ethernet switch.
@@ -210,6 +210,66 @@ Example device address string representation for 2 USRP2s with IPv4 addresses 19
     addr0=192.168.10.2, addr1=192.168.20.2
 
 ------------------------------------------------------------------------
+Using the MIMO Cable
+------------------------------------------------------------------------
+The MIMO cable allows two USRP devices to share reference clocks,
+time synchronization, and the ethernet interface.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Shared ethernet mode
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+In shared ethernet mode,
+only one device in the configuration can be attached to the ethernet.
+This device will be referred to as the master, and the other device, the slave.
+
+* The master provides reference clock and time synchronization to the slave.
+* All data passing between the host and the slave is routed over the MIMO cable.
+* Both master and slave must have different IPv4 addresses in the same subnet.
+* The master and slave may be used individually or in a multi-device configuration.
+* External clocking is optional, and should only be supplied to the master device.
+* The role of slave and master may be switched with the "mimo_mode" device address (see dual ethernet mode).
+
+Example device address string representation for 2 USRP2s with IPv4 addresses 192.168.10.2 (master) and 192.168.10.3 (slave)
+::
+
+    -- Multi-device example --
+
+    addr0=192.168.10.2, addr1=192.168.10.3
+
+    -- Two single devices example --
+
+    addr=192.168.10.2
+
+    addr=192.168.10.3
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Dual ethernet mode
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+In dual ethernet mode,
+both devices in the configuration must be attached to the ethernet.
+One of the devices in the configuration will be configured to provide synchronization.
+This device will be referred to as the master, and the other device, the slave.
+
+* The master provides reference clock and time synchronization to the slave.
+* The devices require the special device address argument "mimo_mode" set.
+* Both master and slave must have different IPv4 addresses in different subnets.
+* The master and slave may be used individually or in a multi-device configuration.
+* External clocking is optional, and should only be supplied to the master device.
+
+Example device address string representation for 2 USRP2s with IPv4 addresses 192.168.10.2 (master) and 192.168.20.2 (slave)
+::
+
+    -- Multi-device example --
+
+    addr0=192.168.10.2, mimo_mode0=master, addr1=192.168.20.2, mimo_mode1=slave
+
+    -- Two single devices example --
+
+    addr=192.168.10.2, mimo_mode=master
+
+    addr=192.168.20.2, mimo_mode=slave
+
+------------------------------------------------------------------------
 Hardware setup notes
 ------------------------------------------------------------------------
 
@@ -220,7 +280,7 @@ The LEDs on the front panel can be useful in debugging hardware and software iss
 The LEDs reveal the following about the state of the device:
 
 * **LED A:** transmitting
-* **LED B:** serdes link
+* **LED B:** mimo cable link
 * **LED C:** receiving
 * **LED D:** firmware loaded
 * **LED E:** reference lock