Merge branch 'origin/uhd/readme_fix' into maint

12 files changed, 155 insertions, 38 deletions

diff --git a/README.md b/README.md
index 45903b4b5..791d0c16b 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@ USRP Hardware Driver (UHD™) Software
 
 Welcome to the UHD™ software distribution! UHD is the free & open-source
 software driver and API for the Universal Software Radio Peripheral (USRP™) SDR
-platform, created and sold by Ettus Research, LLC.
+platform, created and sold by Ettus Research.
 
 UHD supports all Ettus Research USRP™ hardware, including all motherboards and
 daughterboards, and the combinations thereof.
diff --git a/host/CMakeLists.txt b/host/CMakeLists.txt
index c45058562..7620d2446 100644
--- a/host/CMakeLists.txt
+++ b/host/CMakeLists.txt
@@ -200,7 +200,7 @@ ADD_CUSTOM_TARGET(uninstall
 # Install Package Docs
 ########################################################################
 UHD_INSTALL(FILES
-    ${CMAKE_CURRENT_SOURCE_DIR}/../README.md
+    ${CMAKE_CURRENT_SOURCE_DIR}/README.md
     ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE
     DESTINATION ${PKG_DOC_DIR}
     COMPONENT readme
diff --git a/host/README.md b/host/README.md
new file mode 100644
index 000000000..e80b10b49
--- /dev/null
+++ b/host/README.md
@@ -0,0 +1,38 @@
+Host UHD™ Software Source Code
+============================================
+
+This directory tree contains the source code that builds the UHD software
+library on your host computer. This library contains the drivers for all Ettus
+Research products, and the framework and API that make them usable to
+application-level programs. The UHD library runs entirely in user-space.
+
+## Documentation
+
+For documentation, please refer to the following resources:
+
+For technical documentation related UHD check out the 
+[UHD Manual](http://files.ettus.com/uhd_docs/manual/html/).
+
+If you are looking for API documentation, check out the following resources:
+
+* [Doxygen](http://files.ettus.com/uhd_docs/doxygen/html/index.html)
+* [Coding to the API](http://files.ettus.com/uhd_docs/manual/html/coding.html)
+* [Device Streaming](http://files.ettus.com/uhd_docs/manual/html/stream.html)
+
+Additionally, be sure to check out the Ettus Research
+[FAQ](http://www.ettus.com/kb/detail/frequently-asked-questions), and the
+[Knowledge Base](http://www.ettus.com/kb) for useful application notes and
+tutorials.
+
+## Support
+
+If you have purchased an Ettus Research USRP™ product and need technical support
+using the device or using this UHD™ software, please e-mail the `USRP-Users`
+mailing list, which is where Ettus Research, and our community, provide support
+to users.
+
+Note that you must be *subscribed* to the list in order to post a message to the
+list. This is to prevent spammers from just sending garbage messages out over
+the listserve.
+
+* [Ettus Research USRP-Users Mailing List](http://lists.ettus.com/mailman/listinfo/usrp-users_lists.ettus.com)
diff --git a/host/cmake/Modules/UHDPackage.cmake b/host/cmake/Modules/UHDPackage.cmake
index a98a52fc7..8422c24d6 100644
--- a/host/cmake/Modules/UHDPackage.cmake
+++ b/host/cmake/Modules/UHDPackage.cmake
@@ -99,7 +99,7 @@ SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Ettus Research - USRP Hardware Driver")
 SET(CPACK_PACKAGE_VENDOR              "Ettus Research LLC")
 SET(CPACK_PACKAGE_CONTACT             "Ettus Research <support@ettus.com>")
 SET(CPACK_PACKAGE_VERSION "${UHD_VERSION}")
-SET(CPACK_RESOURCE_FILE_WELCOME ${CMAKE_SOURCE_DIR}/../README.md)
+SET(CPACK_RESOURCE_FILE_WELCOME ${CMAKE_SOURCE_DIR}/README.md)
 SET(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_SOURCE_DIR}/LICENSE)
 
 ########################################################################
diff --git a/tools/README b/tools/README
deleted file mode 100644
index 7c23a1fff..000000000
--- a/tools/README
+++ /dev/null
@@ -1,31 +0,0 @@
-#
-# Copyright 2014 Ettus Research LLC
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-
-UHD Tools
-=========
-
-This folder contains tools which might be useful when debugging or
-working on USRPs. None of these tools actually require UHD to be installed!
-
-
-List of tools:
--------------
-
-impact_jtag_programmer.sh    - Program the X3x0 FPGA via JTAG. Requires Xilinx iMPACT.
-
-
diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 000000000..cdd4bcba8
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,33 @@
+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
+
+__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/__
+
+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__
+
+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.
+
diff --git a/tools/uhd_dump/Makefile b/tools/uhd_dump/Makefile
index 93181570b..b793776d4 100644
--- a/tools/uhd_dump/Makefile
+++ b/tools/uhd_dump/Makefile
@@ -1,12 +1,26 @@
+# Copyright 2013-2014 Ettus Research LLC
+#
+# GNU Radio is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3, or (at your option) any later version.
+#
+# GNU Radio is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# GNU Radio; see the file COPYING.  If not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Boston, MA 02110-1301, USA.
+
 INCLUDES = usrp3_regs.h uhd_dump.h
 
 BINARIES = chdr_log
 
-OBJECTS = uhd_dump.o 
+OBJECTS = uhd_dump.o
 
 CFLAGS = -g -O0 -Wall
 
-LDFLAGS = -lpcap -lm 
+LDFLAGS = -lpcap -lm
 
 CC = cc
 
diff --git a/tools/uhd_dump/chdr_log.c b/tools/uhd_dump/chdr_log.c
index 9a0834e9b..77473b895 100644
--- a/tools/uhd_dump/chdr_log.c
+++ b/tools/uhd_dump/chdr_log.c
@@ -1,3 +1,20 @@
+//
+// Copyright 2013-2014 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <pcap.h>
diff --git a/tools/uhd_dump/uhd_dump.c b/tools/uhd_dump/uhd_dump.c
index 3238d72cf..833eca911 100644
--- a/tools/uhd_dump/uhd_dump.c
+++ b/tools/uhd_dump/uhd_dump.c
@@ -1,3 +1,19 @@
+//
+// Copyright 2013-2014 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
 
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/tools/uhd_dump/uhd_dump.h b/tools/uhd_dump/uhd_dump.h
index 2c36f9a39..3a6ac4ef1 100644
--- a/tools/uhd_dump/uhd_dump.h
+++ b/tools/uhd_dump/uhd_dump.h
@@ -1,9 +1,23 @@
+//
+// Copyright 2013-2014 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
 
 #ifndef _UHD_DUMP_H_
 #define _UHD_DUMP_H_
 
-
-
 #define FALSE 0
 #define TRUE 1
 #define UNKNOWN 2
diff --git a/tools/uhd_dump/usrp3_regs.h b/tools/uhd_dump/usrp3_regs.h
index 5e3fc1cac..4ec147b52 100644
--- a/tools/uhd_dump/usrp3_regs.h
+++ b/tools/uhd_dump/usrp3_regs.h
@@ -1,3 +1,19 @@
+//
+// Copyright 2013-2014 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
 
 const struct radio_ctrl_names reg_list[] =
   {
diff --git a/tools/impact_jtag_programmer.sh b/tools/usrp_x3xx_fpga_jtag_programmer.sh
index df563da14..df563da14 100755
--- a/tools/impact_jtag_programmer.sh
+++ b/tools/usrp_x3xx_fpga_jtag_programmer.sh