aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorBen Hilburn <ben.hilburn@ettus.com>2015-01-28 13:23:42 -0800
committerBen Hilburn <ben.hilburn@ettus.com>2015-01-28 13:23:42 -0800
commitb92662d5780f3a2d872e5ab96efc0760cce1fe53 (patch)
tree2a4b03ad89ea68619010ecee0115c702fb2354d8 /host/docs
parentebe7169dcecd1b6899734cefdf5771612067fd48 (diff)
parentdb3fac73beb30ceaaf6a275d9668a38af3b839f5 (diff)
downloaduhd-b92662d5780f3a2d872e5ab96efc0760cce1fe53.tar.gz
uhd-b92662d5780f3a2d872e5ab96efc0760cce1fe53.tar.bz2
uhd-b92662d5780f3a2d872e5ab96efc0760cce1fe53.zip
Merge branch 'maint' into master
Resolved Conflicts: host/docs/usrp_e3x0.dox host/include/uhd/utils/paths.hpp host/lib/transport/nirio/nifpga_lvbitx.cpp host/lib/usrp/b200/b200_impl.cpp host/lib/utils/paths.cpp
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/images.dox6
-rw-r--r--host/docs/usrp_e3x0.dox16
2 files changed, 16 insertions, 6 deletions
diff --git a/host/docs/images.dox b/host/docs/images.dox
index e00f599b5..bd2ffacf6 100644
--- a/host/docs/images.dox
+++ b/host/docs/images.dox
@@ -65,9 +65,9 @@ configure-time.
<b>Option 2:</b>
-Unpack the archive anywhere and set the `UHD_IMAGES_PATH`
-environment variable. `UHD_IMAGES_PATH` may contain a list of
-directories to search for image files.
+Unpack the archive anywhere and set the `UHD_IMAGES_DIR` environment variable.
+The `UHD_IMAGES_DIR` environment variable may contain a list of paths. They
+should be ordered by preference.
\section images_building Building Images
diff --git a/host/docs/usrp_e3x0.dox b/host/docs/usrp_e3x0.dox
index 01b0fd929..68ffc0122 100644
--- a/host/docs/usrp_e3x0.dox
+++ b/host/docs/usrp_e3x0.dox
@@ -132,7 +132,7 @@ which should return 'arm-oe-linux-gnueabi'.
-# Setup your environment as described in \ref e3x0_sdk_usage
-# Type the following in the build directory (assuming a build in host/build):
- $ cmake -DCMAKE_TOOLCHAIN_FILE=<youruhdsrc>/host/cmake/Toolchains/oe-sdk_cross.cmake -DENABLE_E300=On ..
+ $ cmake -DCMAKE_TOOLCHAIN_FILE=<youruhdsrc>/host/cmake/Toolchains/oe-sdk_cross.cmake -DCMAKE_INSTALL_PREFIX=/usr -DENABLE_E300=ON ..
$ make
\subsubsection e3x0_sdk_usage_gnuradio Building GNU Radio
@@ -143,7 +143,7 @@ which should return 'arm-oe-linux-gnueabi'.
\code{.sh}
$ mkdir build-arm
-$ cmake -Wno-dev -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/oe-sdk_cross.cmake \-DCMAKE_INSTALL_PREFIX=/usr -DENABLE_GR_VOCODER=OFF -DGR_ENABLE_ATSC=OFF \
+$ cmake -Wno-dev -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/oe-sdk_cross.cmake \-DCMAKE_INSTALL_PREFIX=/usr -DENABLE_GR_VOCODER=OFF -DENABLE_GR_ATSC=OFF \
-DENABLE_GR_DTV=OFF -DENABLE_DOXYGEN=OFF ../
\endcode
@@ -274,8 +274,18 @@ You may need to change the USRP's IP address for several reasons:
- **USB**: USB 2.0 Port
- **SERIAL**: Micro USB connection for serial uart console
+\subsection e3x0_hw_sync Clock and Time Synchronization
+Unlike most USRP devices, the E310 does not have independent reference clock and time source inputs.
+It is possible, however, to discipline the internal reference clock using an external time (PPS) source
+connected to the SYNC input pin. The E310 FPGA has a subsystem that can use the PPS signal from the
+SYNC pin or the internal GPS to align edges of the reference clock to edges of a shared PPS signal.
+This alignment happens automatically when the time source in UHD is set to "gpsdo" or "external".
+Please note that because the SYNC input can only accept a PPS signal, the only supported value for
+the reference clock source is "internal".
+
+
\subsection e3x0_hw_pps PPS - Pulse Per Second
-Using a PPS signal for timestamp synchronization requires a square wave signal with the following a 5Vpp amplitude.
+Using a PPS signal for timestamp synchronization requires a LVCMOS or a 5V logic input signal.
An external PPS can be used to discipline the internal reference clock. This feature is automatically
enabled with the time source is set to "external".