aboutsummaryrefslogtreecommitdiffstats
path: root/host
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2016-08-16 15:56:09 -0700
committerMartin Braun <martin.braun@ettus.com>2016-08-16 15:56:09 -0700
commit1712228b54e13dc51eefd376f1d3f49efa842a6d (patch)
treefd6225b5fca648edabb432900f4925e705e60ffc /host
parente2f779983eb15ebe4b1b8c12e008e9f4e77ff840 (diff)
downloaduhd-1712228b54e13dc51eefd376f1d3f49efa842a6d.tar.gz
uhd-1712228b54e13dc51eefd376f1d3f49efa842a6d.tar.bz2
uhd-1712228b54e13dc51eefd376f1d3f49efa842a6d.zip
docs: Some X3x0-related updates
Diffstat (limited to 'host')
-rw-r--r--host/docs/configuration.dox4
-rw-r--r--host/docs/usrp_x3x0.dox26
-rw-r--r--host/docs/usrp_x3xx_fpga_burner.14
3 files changed, 21 insertions, 13 deletions
diff --git a/host/docs/configuration.dox b/host/docs/configuration.dox
index e16d1979e..baec4c6e9 100644
--- a/host/docs/configuration.dox
+++ b/host/docs/configuration.dox
@@ -27,9 +27,13 @@ and possible more options.
fw | Provide alternative firmware | All USB Devices, X3x0 | fw=/path/to/fw.bin
ignore-cal-file | Ignores existing device calibration files | All Devices with cal-file support| See \ref ignore_cal_file
master_clock_rate | Master Clock Rate in Hz | X3x0, B2x0, B1x0, E3x0, E1x0 | master_clock_rate=16e6
+ dboard_clock_rate | Daughterboard clock rate in Hz | X3x0 | dboard_clock_rate=50e6
mcr | Override master clock rate settings (see \ref usrp1_hw_extclk) | USRP1 | mcr=52e6
niusrprpc_port | RPC Port for NI USRP RIO | X3x0 | niusrprpc_port=5445
system_ref_rate | Reference Clock Rate in Hz | X3x0 | system_ref_rate=10e6
+ self_cal_adc_delay | Run ADC transfer delay self-calibration. | X3x0 | self_cal_adc_delay=1
+ ext_adc_self_test | Run an extended ADC self test (more than the usual) | X3x0 | ext_adc_self_test=1
+ recover_mb_eeprom | Disable version checks. Can damage hardware. Only recommended for recovering devices with corrupted EEPROMs. | X3x0, N230 | recover_mb_eeprom=1
In addition, many of the streaming-related options can be set per-device at configuration time.
diff --git a/host/docs/usrp_x3x0.dox b/host/docs/usrp_x3x0.dox
index ae3647641..db19ca551 100644
--- a/host/docs/usrp_x3x0.dox
+++ b/host/docs/usrp_x3x0.dox
@@ -91,11 +91,11 @@ number, you will have to update the FPGA image before you can start using your U
with UHD (see also \ref page_images).
2. Use the `uhd_image_loader` utility to update the FPGA image. On the command line, run:
- uhd_image_loader --args="type=x300,addr=192.168.10.2,fpga=HGS"
+ uhd_image_loader --args="type=x300,addr=192.168.10.2,fpga=HG"
If you have installed the images to a non-standard location, you might need to run (change the filename according to your device):
- uhd_image_loader --args="type=x300,addr=192.168.10.2" --fpga-path="<path_to_images>/usrp_x310_fpga_HGS.bit"
+ uhd_image_loader --args="type=x300,addr=192.168.10.2" --fpga-path="<path_to_images>/usrp_x310_fpga_HG.bit"
The process of updating the FPGA image will take several minutes. Make sure the process of flashing the image does not get interrupted.
@@ -134,7 +134,7 @@ The LEDs on the front panel can be useful in debugging hardware and software iss
### Dual 10 Gigabit Ethernet
In order to utilize the X-series USRP over dual 10 Gigabit Ethernet interfaces, ensure
-either the XG or XGS image is installed (see \ref x3x0_load_fpga_imgs_fpga_flavours).
+either the XG image is installed (see \ref x3x0_load_fpga_imgs_fpga_flavours).
In addition to burning the prerequisite FPGA image, it may also be necessary
to tune the network interface card (NIC) to eliminate drops (Ds) and reduce overflows (Os).
This is done by increasing the number of RX descriptors (see \ref transport_udp_linux).
@@ -266,8 +266,12 @@ behavior of the above interfaces.
|  FPGA Image Flavor  |  SFP+ Port 0 Interface |  SFP+ Port 1 Interface |
|---------------------|------------------------|------------------------|
-|  HGS (Default)  |  1 Gigabit Ethernet |  10 Gigabit Ethernet   |
-|  XGS   |  10 Gigabit Ethernet |  10 Gigabit Ethernet   |
+|  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    |
+
+Note: The Aurora images need to be built manually from the FPGA source code.
FPGA images are shipped in 2 formats:
@@ -276,7 +280,7 @@ FPGA images are shipped in 2 formats:
To get the latest images, simply use the uhd_images_downloader script. On Unix systems, use this command:
- sudo uhd_images_downloader
+ $ [sudo] uhd_images_downloader
On Windows, use:
@@ -330,7 +334,7 @@ images.
uhd_image_loader --args="type=x300,addr=<IP address>"
Automatic FPGA path, select image type:
- uhd_image_loader --args="type=x300,addr=<IP address>,fpga=<HGS or XGS>"
+ uhd_image_loader --args="type=x300,addr=<IP address>,fpga=<HG or XG>"
Manual FPGA path:
uhd_image_loader --args="type=x300,addr=<IP address>" --fpga-path="<path to FPGA image>"
@@ -341,7 +345,7 @@ images.
uhd_image_loader --args="type=x300,resource=<NI-RIO resource>"
Automatic FPGA path, select image type:
- uhd_image_loader --args="type=x300,resource=<NI-RIO resource>,fpga=<HGS or XGS>"
+ uhd_image_loader --args="type=x300,resource=<NI-RIO resource>,fpga=<HG or XG>"
Manual FPGA path:
uhd_image_loader --args="type=x300,resource=<NI-RIO resource>" --fpga-path="<path to FPGA image>"
@@ -371,9 +375,9 @@ device to enable communication, as shown in the following table:
 Ethernet Interface | USRP Ethernet Port |  Default USRP IP Address |  Host Static IP Address | Host Static Subnet Mask | Address EEPROM key
---------------------|-------------------------|--------------------------|-------------------------|-------------------------|-------------------
-  Gigabit  |  Port 0 (HGS Image) |  192.168.10.2 | 192.168.10.1 | 255.255.255.0 | `ip-addr0`
-  Ten Gigabit  |  Port 0 (XGS Image) |  192.168.30.2 | 192.168.30.1 | 255.255.255.0 | `ip-addr2`
-  Ten Gigabit  |  Port 1 (HGS/XGS Image) |  192.168.40.2 | 192.168.40.1 | 255.255.255.0 | `ip-addr3`
+  Gigabit  |  Port 0 (HG Image) |  192.168.10.2 | 192.168.10.1 | 255.255.255.0 | `ip-addr0`
+  Ten Gigabit  |  Port 0 (XG Image) |  192.168.30.2 | 192.168.30.1 | 255.255.255.0 | `ip-addr2`
+  Ten Gigabit  |  Port 1 (HG/XG Image) |  192.168.40.2 | 192.168.40.1 | 255.255.255.0 | `ip-addr3`
As you can see, the X300/X310 actually stores different IP addresses, which all address the device differently: Each combination of Ethernet port and interface type (i.e., Gigabit or Ten Gigabit) has its own IP address. As an example, when addressing the device through 1 Gigabit Ethernet on its first port (Port 0), the relevant IP address is the one stored in the EEPROM with key `ip-addr0`, or 192.168.10.2 by default.
diff --git a/host/docs/usrp_x3xx_fpga_burner.1 b/host/docs/usrp_x3xx_fpga_burner.1
index f07e52401..6b4e8c322 100644
--- a/host/docs/usrp_x3xx_fpga_burner.1
+++ b/host/docs/usrp_x3xx_fpga_burner.1
@@ -16,7 +16,7 @@ of that type and model, or a custom FPGA image path.
--resource=\fI"Resource"\fR
. IP "RPC Port:"
--rpc-port=\fI"Port"\fR (default=5444)
-. IP "Image Type (1G, HGS, or XGS):"
+. IP "Image Type (1G, HG, or XG):"
--type=\fI"Type"\fR
. IP "Custom FPGA path:"
--fpga-path=\fI"Path"\fR
@@ -33,7 +33,7 @@ of that type and model, or a custom FPGA image path.
.sp
usrp_x3xx_fpga_burner --addr=192.168.10.2 --type=1G
.SS Burning a Hybrid image over PCIe
-usrp_x3xx_fpga_burner --resource=RIO0 --type=HGS
+usrp_x3xx_fpga_burner --resource=RIO0 --type=HG
.SS Burning a custom FPGA image over Ethernet
usrp_x3xx_fpga_burner --addr=192.168.10.2 --fpga=path="custom_image.bit"
.ft