aboutsummaryrefslogtreecommitdiffstats
path: root/tools/README.md
diff options
context:
space:
mode:
authorBen Hilburn <ben.hilburn@ettus.com>2014-04-21 13:28:37 -0700
committerBen Hilburn <ben.hilburn@ettus.com>2014-04-21 13:28:37 -0700
commitb3e8dfd2ac678ebf25d0744a65979b3c90c0461b (patch)
tree0b8f638170e894529af85e8f91786d3bff35ecc8 /tools/README.md
parent18b3a5b458ef3b6de3c52c946ef82c06e070dbc4 (diff)
downloaduhd-b3e8dfd2ac678ebf25d0744a65979b3c90c0461b.tar.gz
uhd-b3e8dfd2ac678ebf25d0744a65979b3c90c0461b.tar.bz2
uhd-b3e8dfd2ac678ebf25d0744a65979b3c90c0461b.zip
UHD: Updating README in tools/ directory.
Diffstat (limited to 'tools/README.md')
-rw-r--r--tools/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 000000000..d58577589
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,22 @@
+USRP™ Tools
+============================
+
+This folder contains tools that are useful for working with and/or debugging
+your USRP™ device. Tools in this directory do **not** link against UHD. They are
+either stand-alone programs or software to be used in third-party applications.
+
+For UHD™ software tools, look in `uhd/host/utils`.
+
+
+## List of Tools
+
+__usrp_x3xx_fpga_jtag_programmer.sh__
+
+This tool is to be used with the USRP™ X300 and X310 devices. It allows you to
+program the X3x0 FPGA via JTAG. Note that loading the FPGA image via JTAG does
+**not** store the FPGA in the on-device flash storage. Thus, as soon as you
+cycle power, the image will be lost. To permanently burn an FPGA image, please
+refer to `uhd/host/utils/usrp_x3xx_fpga_burner`.
+
+This tool requires that Xilinx iMPACT has been installed on your system.
+