aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2015-04-14 14:05:19 -0500
committerMartin Braun <martin.braun@ettus.com>2015-04-14 14:05:19 -0500
commit2f760ac0f883e1de9adca48449498deab72a9359 (patch)
treeffe52eeabe9f265dd0471b20d670091091f8dcc8 /host/docs
parent2f48c9bb979c8777cc8a3d3a0de03e9cf2958b14 (diff)
parent19716045c60f00296f24e115580da154e5ddef8d (diff)
downloaduhd-2f760ac0f883e1de9adca48449498deab72a9359.tar.gz
uhd-2f760ac0f883e1de9adca48449498deab72a9359.tar.bz2
uhd-2f760ac0f883e1de9adca48449498deab72a9359.zip
Merge branch 'maint'
Conflicts: host/lib/usrp/b200/b200_io_impl.cpp host/lib/usrp/common/ad9361_driver/ad9361_device.cpp host/lib/usrp/common/ad9361_driver/ad9361_device.h
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/octoclock.dox34
-rw-r--r--host/docs/sync.dox6
2 files changed, 22 insertions, 18 deletions
diff --git a/host/docs/octoclock.dox b/host/docs/octoclock.dox
index 9c1ca7b47..45a12e93a 100644
--- a/host/docs/octoclock.dox
+++ b/host/docs/octoclock.dox
@@ -29,14 +29,15 @@ schematics</a>. Once you verify that the programmer is properly connected, run t
cd <install path>/share/uhd/images
avrdude -p atmega128 -c <programmer name> -P usb -U efuse:w:0xFF:m -U hfuse:w:0x80:m -U lfuse:w:0xFF:m -U flash:w:octoclock_bootloader.hex:i
-**Note:** On Linux, **sudo** must be used with the **avrdude** command.
+\b Note:
+On Linux, `sudo avrdude ...` might be necessary to gain access to the programmer.
Once the bootloader has been burned, power-cycle your OctoClock device and refer to the below instructions on burning the OctoClock's
primary firmware.
\subsection application Primary Octoclock firmware
-To load firmware onto the OctoClock, you must use the *octoclock_firmware_burner* utility, specifying the IP
+To load firmware onto the OctoClock, you must use the `octoclock_firmware_burner` utility, specifying the IP
address of the OctoClock device, as follows:
octoclock_firmware_burner --addr=192.168.10.3
@@ -45,12 +46,13 @@ address of the OctoClock device, as follows:
\subsection host_interface Setting up the host interface
-The OctoClock communicates with the host machine at the UDP layer over Gigabit Ethernet. The default device
-of the OctoClock is **192.168.10.3**. You will need to configure the host machine's Ethernet interface with
-a static IP address to enable communication. An address of **192.168.10.1** and a subnet mask of
-**255.255.255.0** is recommended.
+The OctoClock communicates with the host machine at the UDP layer over Ethernet. The default device
+of the OctoClock is `192.168.10.3`. You will need to configure the host machine's Ethernet interface with
+a static IP address to enable communication. An address of `192.168.10.1` and a subnet mask of
+`255.255.255.0` is recommended.
-**Note:** When using UHD software, if an IP address for the OctoClock is not specified, the software will
+\b Note:
+When using UHD software, if an IP address for the OctoClock is not specified, the software will
use UDP broadcast packets to locate the OctoClock. On some systems, the firewall will block UDP broadcast
packets. It is recommended that you change your firewall settings.
@@ -110,17 +112,17 @@ The same applies for an external signal.
The following sensors are available on both the OctoClock and Octoclock-G; these can be queried through the
<a href="classuhd_1_1octoclock.html">API</a>.
-- **ext_ref_detected:** whether or not the device detects an external reference
-- **gps_detected:** whether or not the device detects an internal GPSDO
-- **using_ref:** which reference the device is using (internal or external)
-- **switch_pos:** the position of the front switch (internal or external)
+- `ext_ref_detected:` whether or not the device detects an external reference
+- `gps_detected:` whether or not the device detects an internal GPSDO
+- `using_ref:` which reference the device is using (internal or external)
+- `switch_pos:` the position of the front switch (internal or external)
On the OctoClock-G, the following sensors are added:
-- **gps_gpgga:** the latest GPGGA string sent by the GPSDO
-- **gps_gprmc:** the latest GPRMC string sent by the GPSDO
-- **gps_time:** the time reported by the GPSDO
-- **gps_locked:** whether or not the GPSDO is locked (true/false)
-- **gps_servo:** the latest debug trace information sent by the GPSDO
+- `gps_gpgga:` the latest GPGGA string sent by the GPSDO
+- `gps_gprmc:` the latest GPRMC string sent by the GPSDO
+- `gps_time:` the time reported by the GPSDO
+- `gps_locked:` whether or not the GPSDO is locked (true/false)
+- `gps_servo:` the latest debug trace information sent by the GPSDO
*/
diff --git a/host/docs/sync.dox b/host/docs/sync.dox
index 8c16eb046..aaae88702 100644
--- a/host/docs/sync.dox
+++ b/host/docs/sync.dox
@@ -152,7 +152,7 @@ metadata should have a time spec set: :
size_t num_tx_samps = tx_streamer->send(buffs, samps_to_send, md);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-\subsection sync_phase_lo Align LOs in the front-end (SBX, WBX, CBX)
+\subsection sync_phase_lo Align LOs in the front-end (SBX, WBX, UBX)
Using timed commands, multiple frontends can be tuned at a specific
time. This timed-tuning ensures that the phase offsets between VCO/PLL
@@ -161,7 +161,9 @@ chains will remain constant after each re-tune. See notes below:
- There is a random phase offset between any two frontends
- This phase offset is different for different LO frequencies
- This phase offset remains constant after retuning
- - Due to a divider, WBX phase offset will be randomly +/- 180 deg after re-tune
+ - Due to a divider, WBX phase offset will be randomly +/- 180 deg after re-tune on all USRPs.
+ - Due to a divider, UBX phase offset will be randomly +/- 180 deg after re-tune on N200/N210.
+ On X300/X310, phase sync with UBX fully works.
- This phase offset will drift over time due to thermal and other characteristics
- Periodic calibration will be necessary for phase-coherent applications