aboutsummaryrefslogtreecommitdiffstats
path: root/tools/README.md
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2014-10-09 10:53:14 +0200
committerMartin Braun <martin.braun@ettus.com>2014-10-09 19:56:43 +0200
commitd61baf0aea29645d75fc2bf6484f84530e0033a5 (patch)
treeccc40c846b465231c9844ccf2deaabed7b5d0138 /tools/README.md
parentb5ff2da82efb8c6fe2ef011da611c1fb42bb2ec7 (diff)
downloaduhd-d61baf0aea29645d75fc2bf6484f84530e0033a5.tar.gz
uhd-d61baf0aea29645d75fc2bf6484f84530e0033a5.tar.bz2
uhd-d61baf0aea29645d75fc2bf6484f84530e0033a5.zip
tools: Added Balints kitchen sink debug util
Diffstat (limited to 'tools/README.md')
-rw-r--r--tools/README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/tools/README.md b/tools/README.md
index cdd4bcba8..b4cc28ebe 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -2,7 +2,7 @@ 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
+your USRP™ device. Tools in this directory are not part of 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`.
@@ -10,18 +10,18 @@ For UHD™ software tools, look in `uhd/host/utils`.
## List of Tools
-__chdr-dissector/__
+`__chdr-dissector/__`
This is a packet dissector for [Wireshark](http://www.wireshark.org/). It allows
you to view the details of a Compressed HeaDeR (CHDR) formatted-packet in
Wireshark. The USRP™ B2xx and X3xx use the CHDR format.
-__uhd_dump/__
+`__uhd_dump/__`
This tool can be used with `tcpdump` to make sense of packet dumps from your
network-connected USRP™ device.
-__usrp_x3xx_fpga_jtag_programmer.sh__
+`__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
@@ -31,3 +31,7 @@ refer to `uhd/host/utils/usrp_x3xx_fpga_burner`.
This tool requires that Xilinx iMPACT has been installed on your system.
+`__kitchen_sink__`
+
+This is a debugging tool designed to test and stress connections to USRP
+devices.