From 9d91d5518751d37b32c86fe4f0c17f0b480fd0bb Mon Sep 17 00:00:00 2001 From: Josh Blum Date: Tue, 29 Mar 2011 11:22:57 -0700 Subject: usb: tweaks to the build guide (libusb + windows) --- host/docs/build.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'host/docs/build.rst') diff --git a/host/docs/build.rst b/host/docs/build.rst index de7c544f2..b81e25de1 100644 --- a/host/docs/build.rst +++ b/host/docs/build.rst @@ -165,12 +165,13 @@ LibUSB cmake notes On Windows, cmake does not have the advantage of pkg-config, so we must manually tell cmake how to locate the LibUSB header and lib. -From the cmake gui, select "Advanded View": - +* From the cmake gui, select "Advanded View" * Set LIBUSB_INCLUDE_DIR to the directory with "libusb.h". * Set LIBUSB_LIBRARIES to the full path for "libusb-1.0.lib". -Then check the boxes to enable USRP1 support, click configure and generate. + * Recommend the static libusb-1.0.lib to simplify runtime dependencies. + +* Check the box to enable USB support, click configure and generate. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Build the project in MSVC -- cgit v1.2.3 From 1721352e905e10dbff48d44b66b1684020a103d7 Mon Sep 17 00:00:00 2001 From: Josh Blum Date: Fri, 1 Apr 2011 10:27:54 -0700 Subject: uhd: install dlls into runtime path, updated docs --- host/docs/build.rst | 4 +--- host/docs/index.rst | 4 +--- host/lib/CMakeLists.txt | 2 +- 3 files changed, 3 insertions(+), 7 deletions(-) (limited to 'host/docs/build.rst') diff --git a/host/docs/build.rst b/host/docs/build.rst index b81e25de1..c645817ab 100644 --- a/host/docs/build.rst +++ b/host/docs/build.rst @@ -197,9 +197,7 @@ Open the Visual Studio Command Prompt Shorcut: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Setup the PATH environment variable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* Add the boost library path to %PATH% (usually c:\\program files\\boost\\\\lib) -* Add the uhd library path to %PATH% (usually c:\\program files\\uhd\\lib) -* Add the libusb library to %PATH% (if using usb support) +* Add the uhd bin path to %PATH% (usually c:\\program files\\uhd\\bin) **Note:** The interface for editing environment variable paths in Windows is very poor. diff --git a/host/docs/index.rst b/host/docs/index.rst index 734300164..467d5f385 100644 --- a/host/docs/index.rst +++ b/host/docs/index.rst @@ -4,9 +4,7 @@ UHD - Universal Hardware Driver The UHD is the universal hardware driver for Ettus Research products. The goal of the UHD is to provide a host driver and api for current and future Ettus Research products. -Users will be able to use the UHD driver standalone/without gnuradio. -Also, a dual license option will be available for those who build against the UHD -but cannot release their software products under the GPL. +Users will be able to use the UHD driver standalone or with 3rd party applications. ------------------------------------------------------------------------ Contents diff --git a/host/lib/CMakeLists.txt b/host/lib/CMakeLists.txt index 54f4893e3..f8886566a 100644 --- a/host/lib/CMakeLists.txt +++ b/host/lib/CMakeLists.txt @@ -121,5 +121,5 @@ ENDIF(DEFINED LIBUHD_OUTPUT_NAME) INSTALL(TARGETS uhd LIBRARY DESTINATION ${LIBRARY_DIR} COMPONENT libraries # .so file ARCHIVE DESTINATION ${LIBRARY_DIR} COMPONENT libraries # .lib file - RUNTIME DESTINATION ${LIBRARY_DIR} COMPONENT libraries # .dll file + RUNTIME DESTINATION ${RUNTIME_DIR} COMPONENT libraries # .dll file ) -- cgit v1.2.3 From af2ab1c688d641e82060016aa772432de6445633 Mon Sep 17 00:00:00 2001 From: Josh Blum Date: Tue, 5 Apr 2011 15:32:41 -0700 Subject: uhd: replace with in docs for clarity --- host/docs/build.rst | 2 +- host/docs/dboards.rst | 4 ++-- host/docs/general.rst | 2 +- host/docs/identification.rst | 2 +- host/docs/images.rst | 4 ++-- host/docs/usrp2.rst | 18 +++++++++--------- host/docs/usrp_e1xx.rst | 2 +- 7 files changed, 17 insertions(+), 17 deletions(-) (limited to 'host/docs/build.rst') diff --git a/host/docs/build.rst b/host/docs/build.rst index c645817ab..063b2b371 100644 --- a/host/docs/build.rst +++ b/host/docs/build.rst @@ -116,7 +116,7 @@ Generate Makefiles with cmake Additionally, configuration variables can be passed into cmake via the command line. The following common-use configuration variables are listed below: -* For a custom install prefix: -DCMAKE_INSTALL_PREFIX= +* For a custom install prefix: -DCMAKE_INSTALL_PREFIX= * To install libs into lib64: cmake -DLIB_SUFFIX=64 Example usage: diff --git a/host/docs/dboards.rst b/host/docs/dboards.rst index 7f205c404..419456df2 100644 --- a/host/docs/dboards.rst +++ b/host/docs/dboards.rst @@ -182,7 +182,7 @@ If you lose R193, you can use anything from 0 to 10 ohms there. With the daughterboard plugged-in, run the following commands: :: - cd /share/uhd/utils + cd /share/uhd/utils ./usrp_burn_db_eeprom --id=0x000d --unit=RX --args= --slot= * are device address arguments (optional if only one USRP is on your machine) @@ -209,7 +209,7 @@ These are all 0-ohm, so if you lose one, just short across the appropriate pads With the daughterboard plugged-in, run the following commands: :: - cd /share/uhd/utils + cd /share/uhd/utils ./usrp_burn_db_eeprom --id= --unit=RX --args= --slot= ./usrp_burn_db_eeprom --id= --unit=TX --args= --slot= diff --git a/host/docs/general.rst b/host/docs/general.rst index 2894fbf88..73b820c84 100644 --- a/host/docs/general.rst +++ b/host/docs/general.rst @@ -52,5 +52,5 @@ Support for dynamically loadable modules For a module to be loaded at runtime, it must be: * found in the UHD_MODULE_PATH environment variable, -* installed into the /share/uhd/modules directory, +* installed into the /share/uhd/modules directory, * or installed into /usr/share/uhd/modules directory (unix only). diff --git a/host/docs/identification.rst b/host/docs/identification.rst index 90484744c..deda61531 100644 --- a/host/docs/identification.rst +++ b/host/docs/identification.rst @@ -107,7 +107,7 @@ Set a custom name Run the following commands: :: - cd /share/uhd/utils + cd /share/uhd/utils ./usrp_burn_mb_eeprom --args= --key=name --val=lab1_xcvr ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/host/docs/images.rst b/host/docs/images.rst index f5be88a65..adfa6d530 100644 --- a/host/docs/images.rst +++ b/host/docs/images.rst @@ -54,8 +54,8 @@ When installing images from an archive, there are two options: **Option 1:** Unpack the archive into the UHD installation prefix. -The UHD will always search /share/uhd/images for image files. -Where was set by the CMAKE_INSTALL_PREFIX at configure-time. +The UHD will always search /share/uhd/images for image files. +Where was set by the CMAKE_INSTALL_PREFIX at configure-time. **Option 2:** diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst index 912f7d2bd..161170f2c 100644 --- a/host/docs/usrp2.rst +++ b/host/docs/usrp2.rst @@ -25,11 +25,11 @@ Use the card burner tool (unix) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: - sudo /share/uhd/utils/usrp2_card_burner_gui.py + sudo /share/uhd/utils/usrp2_card_burner_gui.py -- OR -- - cd /share/uhd/utils + cd /share/uhd/utils sudo ./usrp2_card_burner.py --dev=/dev/sd --fpga= sudo ./usrp2_card_burner.py --dev=/dev/sd --fw= @@ -42,7 +42,7 @@ Use the card burner tool (windows) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: - /share/uhd/utils/usrp2_card_burner_gui.py + /share/uhd/utils/usrp2_card_burner_gui.py ------------------------------------------------------------------------ @@ -58,11 +58,11 @@ Use the net burner tool (unix) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: - sudo /share/uhd/utils/usrp_n2xx_net_burner_gui.py + sudo /share/uhd/utils/usrp_n2xx_net_burner_gui.py -- OR -- - cd /share/uhd/utils + cd /share/uhd/utils ./usrp_n2xx_net_burner.py --addr= --fw= ./usrp_n2xx_net_burner.py --addr= --fpga= @@ -71,7 +71,7 @@ Use the net burner tool (Windows) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: - /share/uhd/utils/usrp_n2xx_net_burner_gui.py + /share/uhd/utils/usrp_n2xx_net_burner_gui.py ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Device recovery and bricking @@ -145,7 +145,7 @@ and the network must be setup properly as described above. Run the following commands: :: - cd /share/uhd/utils + cd /share/uhd/utils ./usrp_burn_mb_eeprom --args= --key=ip-addr --val=192.168.10.3 **Method 2 (Linux Only):** @@ -154,7 +154,7 @@ It uses raw ethernet packets to bypass the IP/UDP layer to communicate with the Run the following commands: :: - cd /share/uhd/utils + cd /share/uhd/utils sudo ./usrp2_recovery.py --ifc=eth0 --new-ip=192.168.10.3 ------------------------------------------------------------------------ @@ -343,5 +343,5 @@ Test the PPS input with the following app: :: - cd /share/uhd/examples + cd /share/uhd/examples ./test_pps_input --args= diff --git a/host/docs/usrp_e1xx.rst b/host/docs/usrp_e1xx.rst index ffcd370dd..fb5848bad 100644 --- a/host/docs/usrp_e1xx.rst +++ b/host/docs/usrp_e1xx.rst @@ -61,5 +61,5 @@ can talk directly to the clock generator over a SPI interface. Run the following commands to restore the clock generator to a usable state: :: - cd /share/uhd/usrp_e_utilities + cd /share/uhd/usrp_e_utilities ./usrp-e-utility --fpga=../images/usrp_e100_pt_fpga.bin --reclk -- cgit v1.2.3