summaryrefslogtreecommitdiffstats
path: root/host/docs/usrp1.rst
diff options
context:
space:
mode:
authorNick Foster <nick@nerdnetworks.org>2010-09-30 12:28:29 -0700
committerNick Foster <nick@nerdnetworks.org>2010-09-30 12:28:29 -0700
commit6dd502737bcf6e59933be01720672db9a496803b (patch)
tree5ab70f1c7cb4f2fdd8b5924b5d7abacbd772c9be /host/docs/usrp1.rst
parented245848df8cc011ae8fe30833ecc28049139db5 (diff)
parente4fffed05dda57bb37d693a3a26ea6a903c925f7 (diff)
downloaduhd-6dd502737bcf6e59933be01720672db9a496803b.tar.gz
uhd-6dd502737bcf6e59933be01720672db9a496803b.tar.bz2
uhd-6dd502737bcf6e59933be01720672db9a496803b.zip
Merge branch 'master' of ettus.sourcerepo.com:ettus/uhdpriv into usrp2p
Conflicts: host/lib/usrp/usrp2/io_impl.cpp
Diffstat (limited to 'host/docs/usrp1.rst')
-rw-r--r--host/docs/usrp1.rst35
1 files changed, 32 insertions, 3 deletions
diff --git a/host/docs/usrp1.rst b/host/docs/usrp1.rst
index 3c1431d30..0baa93a45 100644
--- a/host/docs/usrp1.rst
+++ b/host/docs/usrp1.rst
@@ -60,6 +60,29 @@ Example device address string representations to specify non-standard firmware a
fpga=usrp1_fpga_4rx.rbf, fw=usrp1_fw_custom.ihx
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Change USB transfer parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The advanced user may manipulate parameters of the usb bulk transfers
+for various reasons, such as lowering latency or increasing buffer size.
+By default, the UHD will use values for these parameters
+that are known to perform well on a variety of systems.
+The following device address parameters can be used to manipulate USB bulk transfers:
+
+* **recv_xfer_size:** the size of each receive bulk transfer in bytes
+* **recv_num_xfers:** the number of simultaneous receive bulk transfers
+* **send_xfer_size:** the size of each send bulk transfer in bytes
+* **send_num_xfers:** the number of simultaneous send bulk transfers
+
+Example usage, set the device address markup string to the following:
+::
+
+ serial=12345678, recv_num_xfers=16
+
+ -- OR --
+
+ serial=12345678, recv_xfer_size=2048, recv_num_xfers=16
+
------------------------------------------------------------------------
Specifying the subdevice to use
------------------------------------------------------------------------
@@ -100,10 +123,10 @@ OS Specific Notes
------------------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Setup Udev on Linux
+Linux - setup udev
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-On Linux, Udev handles USB plug and unplug events.
-The following command creates a Udev rule for the USRP1
+On Linux, udev handles USB plug and unplug events.
+The following commands create a udev rule for the USRP1
so that non-root users may access the device:
::
@@ -113,3 +136,9 @@ so that non-root users may access the device:
sudo mv tmpfile /etc/udev/rules.d/10-usrp.rules
sudo udevadm control --reload-rules
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Windows - install driver
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+On Windows, a driver must be installed the first time the USRP1 is attached to the host computer.
+A download link for this driver can be found on the UHD wiki page.
+Download and unpack the driver, and direct the Windows driver install wizard to the .inf file.