aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2019-11-07 09:40:31 -0800
committerMartin Braun <martin.braun@ettus.com>2019-11-07 13:44:39 -0800
commitcfb8760204dee5c34a0b7ed3d06344dd1cccd621 (patch)
tree653bdda845da5fdbf7941128767a54e50465fead
parent00c3dc29c227b11c86ce3fc1854858e999f5cb76 (diff)
downloaduhd-cfb8760204dee5c34a0b7ed3d06344dd1cccd621.tar.gz
uhd-cfb8760204dee5c34a0b7ed3d06344dd1cccd621.tar.bz2
uhd-cfb8760204dee5c34a0b7ed3d06344dd1cccd621.zip
docs: Add info on FPGA flavours for E320 and N3xx
This explains what the various FPGA flavours (XG, HG, 1G) are.
-rw-r--r--host/docs/usrp_e3xx.dox27
-rw-r--r--host/docs/usrp_n3xx.dox24
2 files changed, 50 insertions, 1 deletions
diff --git a/host/docs/usrp_e3xx.dox b/host/docs/usrp_e3xx.dox
index e9cac8e65..22db5bfa3 100644
--- a/host/docs/usrp_e3xx.dox
+++ b/host/docs/usrp_e3xx.dox
@@ -170,7 +170,32 @@ It is possible to log into the STM32 using the serial interface
controls, such as remote power cycling should the CPU have become unresponsive
for whatever reason.
-\subsection e3xx_sdcard The SD card
+\subsection e320_fpga_flavours FPGA Image Flavors
+
+The USRP E320 Series devices has an SFP+ port for Ethernet.
+Because the SFP+ port supports both 1 Gigabit (SFP) and 10 Gigabit (SFP+)
+transceivers, several FPGA images are shipped with UHD to determine the
+behavior of the interface.
+
+|  FPGA Image Flavor  |  SFP+ Port 0 Interface |
+|---------------------|------------------------|
+|  1G (Default)   |  1 Gigabit Ethernet |
+|  XG   |  10 Gigabit Ethernet |
+|  AA   |  Aurora |
+
+The Aurora image can be used to run BISTs on the SFP.
+
+Images can be updated and swapped using the image loader tool. First, make sure
+your version of UHD is running the correct images by downloading them from the
+internet:
+
+ [sudo] uhd_images_downloader
+
+Then, use the image loader tool to pick an FPGA image:
+
+ uhd_image_loader -a type=e3xx,addr=<IP Address>,fpga=XG
+
+\section e3xx_sdcard The SD card
The E310/E312/E313/E320 use a micro SD card as its main storage. The entire root file
system (Linux kernel, libraries) and any user data are stored on this SD card.
diff --git a/host/docs/usrp_n3xx.dox b/host/docs/usrp_n3xx.dox
index 18a8a023b..7c3471efe 100644
--- a/host/docs/usrp_n3xx.dox
+++ b/host/docs/usrp_n3xx.dox
@@ -389,6 +389,30 @@ will force a reload of the FPGA, which will temporarily take down the SFP
network interfaces (and temporary settings, such as applied via `ifconfig` on
the command line, will be lost).
+\subsubsection n3xx_getting_started_fpga_update_flavors FPGA Image Flavors
+
+The USRP-N300 Series devices contains two SFP+ ports for the two Ethernet channels.
+Because SFP+ ports can be used for either 1 Gigabit (SFP) or 10 Gigabit (SFP+)
+transceivers, several FPGA images are shipped with UHD to determine the
+behavior of the above interfaces.
+
+Interfaces can be used for either 1 Gigabit Ethernet, 10 Gigabit Ethernet,
+Aurora (using 10 Gigabit speeds), and White Rabbit (the White Rabbit interface
+does *not* support streaming, it only provides a time reference). See also
+\ref n3xx_synchronization_whiterabbit. We provide the following flavors of FPGA
+images in our default image set:
+
+|  FPGA Image Flavor  |  SFP+ Port 0 Interface |  SFP+ Port 1 Interface |
+|---------------------|------------------------|------------------------|
+|  HG (Default)   |  1 Gigabit Ethernet |  10 Gigabit Ethernet   |
+|  XG   |  10 Gigabit Ethernet |  10 Gigabit Ethernet   |
+|  HA   |  1 Gigabit Ethernet |  Aurora    |
+|  XA   |  10 Gigabit Ethernet |  Aurora    |
+|  AA   |  Aurora |  Aurora    |
+|  WX   |  White Rabbit |  10 Gigabit Ethernet   |
+
+The N320 has an additional QSFP port, and therefore has additional FPGA flavors
+(AQ, XQ). For more information on those, see \ref n3xx_rh_sfp_protocols.
\section n3xx_usage Using an N3XX USRP from UHD