aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/images.rst1
-rw-r--r--host/docs/usrp1.rst20
-rw-r--r--host/docs/usrp2.rst56
-rw-r--r--host/docs/usrp_e1xx.rst15
4 files changed, 26 insertions, 66 deletions
diff --git a/host/docs/images.rst b/host/docs/images.rst
index adfa6d530..c0645a821 100644
--- a/host/docs/images.rst
+++ b/host/docs/images.rst
@@ -14,6 +14,7 @@ The methods of loading images into the device varies among devices:
* **USRP2:** The user must manually write the images onto the USRP2 SD card.
* **USRP-N Series:** The user must manually transfer the images over ethernet.
* **USRP-E Series:** The host code will automatically load the FPGA at runtime.
+* **USRP-B Series:** The host code will automatically load the FPGA at runtime.
------------------------------------------------------------------------
Pre-built images
diff --git a/host/docs/usrp1.rst b/host/docs/usrp1.rst
index 97a8c3bb5..71b4f6779 100644
--- a/host/docs/usrp1.rst
+++ b/host/docs/usrp1.rst
@@ -34,24 +34,16 @@ Example device address string representations to specify non-standard firmware a
Specifying the subdevice to use
------------------------------------------------------------------------
The USRP1 has multiple daughterboard slots, known as slot A and slot B.
-The subdevice specification can be used to select
-the daughterboard and subdevice for each channel.
-For daughterboards with one one subdevice,
-the subdevice name may be left blank for automatic selection.
+The subdevice specification can be used to map an RF frontend to a DSP.
+An RF frontend is identified by the daughterboard slot name and subdevice name.
Ex: The subdev spec markup string to select a WBX on slot B.
-Notice the use of the blank subdevice name for automatic selection.
::
- B:
-
- -- OR --
-
B:0
Ex: The subdev spec markup string to select a BasicRX on slot B.
-Notice that the subdevice name is always specified in the 3 possible cases.
::
@@ -82,6 +74,10 @@ List of emulated features
* Receiving at a specific time
* Receiving a specific number of samples
* End of burst flags for transmit/receive
+* Notification on late stream command
+* Notification on late transmit packet
+* Notification on underflow or overflow
+* Notification on broken chain error
**Note:**
These emulated features rely on the host system's clock for timed operations,
@@ -90,10 +86,6 @@ 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
------------------------------------------------------------------------
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 1b07834fb..025cdd198 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -246,60 +246,42 @@ Using the MIMO Cable
------------------------------------------------------------------------
The MIMO cable allows two USRP devices to share reference clocks,
time synchronization, and the ethernet interface.
+One of the devices will sink its clock and time references to the MIMO cable.
+This device will be referred to as the slave, and the other device, the master.
+
+* The slave device acquires the clock and time references from the master device.
+* 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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
+* Clock reference, time reference, and data are communicated 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.
+* Only clock reference and time reference are communicated over the MIMO cable.
* 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)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configuring the slave
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+In order for the slave to synchronize to the master over MIMO cable,
+the following clock configuration must be set on the slave device:
::
- -- 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
+ uhd::clock_config_t clock_config;
+ clock_config.ref_source = uhd::clock_config_t::REF_MIMO;
+ clock_config.pps_source = uhd::clock_config_t::PPS_MIMO;
+ usrp->set_clock_config(clock_config, slave_index);
------------------------------------------------------------------------
Hardware setup notes
@@ -406,11 +388,11 @@ In the single channel case, only one chain is ever used.
To receive from both channels,
the user must set the RX subdevice specification.
This hardware has only one daughterboard slot,
-which has been aptly named slot "0".
+which has been aptly named slot "A".
In the following example, a TVRX2 is installed.
Channel 0 is sourced from subdevice RX1,
channel 1 is sourced from subdevice RX2:
::
- usrp->set_rx_subdev_spec("0:RX1 0:RX2");
+ usrp->set_rx_subdev_spec("A:RX1 A:RX2");
diff --git a/host/docs/usrp_e1xx.rst b/host/docs/usrp_e1xx.rst
index fcaa57716..4ac9d133a 100644
--- a/host/docs/usrp_e1xx.rst
+++ b/host/docs/usrp_e1xx.rst
@@ -53,21 +53,6 @@ Example:
uhd_usrp_probe --args="master_clock_rate=52e6"
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Clock rate recovery - unbricking
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-It is possible to set a clock rate such that the UHD can no longer communicate with the FPGA.
-When this occurs, it is necessary to use the usrp-e-utility to recover the clock generator.
-The recovery utility works by loading a special pass-through FPGA image so the computer
-can talk directly to the clock generator over a SPI interface.
-
-Run the following commands to restore the clock generator to a usable state:
-::
-
- cd <install-path>/share/uhd/usrp_e_utilities
- ./usrp-e-utility --fpga=../images/usrp_e100_pt_fpga.bin --reclk
-
-
------------------------------------------------------------------------
Clock Synchronization
------------------------------------------------------------------------