summaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/build.rst6
-rw-r--r--host/docs/general.rst8
-rw-r--r--host/docs/usrp2.rst30
3 files changed, 25 insertions, 19 deletions
diff --git a/host/docs/build.rst b/host/docs/build.rst
index f5a8dac8d..108d8dc8b 100644
--- a/host/docs/build.rst
+++ b/host/docs/build.rst
@@ -97,7 +97,10 @@ Generate Makefiles with cmake
cd build
cmake ../
-For a custom prefix, use: cmake -DCMAKE_INSTALL_PREFIX=<prefix> ../
+**Notes:**
+
+* For a custom prefix, use: cmake -DCMAKE_INSTALL_PREFIX=<prefix> ../
+* On some Fedora 64-bit systems, cmake has trouble finding boost, use: cmake -DBOOST_LIBRARYDIR=/usr/lib64 ../
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Build and install
@@ -138,6 +141,7 @@ Generate the project with cmake
Build the project in MSVC
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* Open the generated project file in MSVC.
+* Change the build type from "Debug" to "Release".
* Select the build all target, right click, and choose build.
* Select the install target, right click, and choose build.
diff --git a/host/docs/general.rst b/host/docs/general.rst
index 7d1f467a0..6b309cba0 100644
--- a/host/docs/general.rst
+++ b/host/docs/general.rst
@@ -58,14 +58,12 @@ Misc notes
------------------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Process scheduling
+Thread priority scheduling
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The UHD will try to automatically boost the process's scheduling priority.
-Currently, this is only supported on platforms with *sched.h*.
-
+When the UHD spawns a new thread it may try to boost the thread's scheduling priority.
When setting the priority fails, the UHD prints out an error.
-This error is harmless, it simply means that your process will have a normal scheduling priority.
+This error is harmless, it simply means that the thread will have a normal scheduling priority.
**Linux Notes:**
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 1bd95cefa..aff0d0454 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -20,7 +20,7 @@ Run the following commands:
::
cd <uhd-repo-path>/fpga/usrp2/top/u2_rev3
- make bin
+ make -f Makefile.udp bin
*The image file will be ./build/u2_rev3.bin*
@@ -158,10 +158,25 @@ buffer incoming samples faster than they can be processed.
However, if you application cannot process samples fast enough,
no amount of buffering can save you.
+By default, the UHD will try to request a reasonably large buffer size for both send and receive.
+A warning will be printed on instantiation if the actual buffer size is insufficient.
+See the OS specific notes below:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+OS specific notes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+On linux, the maximum buffer sizes are capped by the sysctl values
+**net.core.rmem_max** and **net.core.wmem_max**.
+To change the maximum values, run the following commands:
+::
+
+ sudo sysctl -w net.core.rmem_max=<new value>
+ sudo sysctl -w net.core.wmem_max=<new value>
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Device address params
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-To set the size of the buffers,
+To manually set the size of the buffers,
the usrp2 will accept two optional parameters in the device address.
Each parameter will accept a numeric value for the number of bytes.
@@ -172,14 +187,3 @@ Example, set the args string to the following:
::
addr=192.168.10.2, recv_buff_size=100e6
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-OS specific notes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-On linux, the maximum buffer sizes are capped by the sysctl values
-**net.core.rmem_max** and **net.core.wmem_max**.
-To change the maximum values, run the following commands:
-::
-
- sudo sysctl -w net.core.rmem_max=<new value>
- sudo sysctl -w net.core.wmem_max=<new value>