summaryrefslogtreecommitdiffstats
path: root/host/docs/usrp1.rst
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-09-29 16:32:11 -0700
committerJosh Blum <josh@joshknows.com>2010-09-29 16:32:11 -0700
commitb8e62bb9bf86d4804defe738b2a7140cd9417a6f (patch)
treea2ad9056b2001afa55f365a18e0cfbde61a14a0c /host/docs/usrp1.rst
parent543a63648f11d0e502e897f3cd98667005580c9e (diff)
downloaduhd-b8e62bb9bf86d4804defe738b2a7140cd9417a6f.tar.gz
uhd-b8e62bb9bf86d4804defe738b2a7140cd9417a6f.tar.bz2
uhd-b8e62bb9bf86d4804defe738b2a7140cd9417a6f.zip
usb: added libusb docs to build guide, usrp1: moved transfer param docs
Diffstat (limited to 'host/docs/usrp1.rst')
-rw-r--r--host/docs/usrp1.rst56
1 files changed, 29 insertions, 27 deletions
diff --git a/host/docs/usrp1.rst b/host/docs/usrp1.rst
index 7cf447719..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
------------------------------------------------------------------------
@@ -95,36 +118,15 @@ Notice that the subdevice name is always specified in the 3 possible cases.
B:B
-
-------------------------------------------------------------------------
-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 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, set the args string to the following:
-::
-
- serial=12345678, recv_num_xfers=16
-
------------------------------------------------------------------------
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:
::
@@ -135,8 +137,8 @@ so that non-root users may access the device:
sudo udevadm control --reload-rules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Install libusb driver on Windows
+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 Ettus Research UHD wiki page.
-Download and unpack the driver, and direct the Windows driver install wizard to the *.inf file.
+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.