diff options
author | Martin Braun <martin.braun@ettus.com> | 2019-08-22 15:33:10 -0700 |
---|---|---|
committer | Martin Braun <martin.braun@ettus.com> | 2019-08-22 16:01:19 -0700 |
commit | ea06c70f2e7d43fbec3ddc0e79239b3e3e9cc649 (patch) | |
tree | 2dacfe9928e204cd717e58f8039dfa1e803b2ad6 /host | |
parent | dd1606607e4612d3949764a0c5fb213a4593b56b (diff) | |
download | uhd-ea06c70f2e7d43fbec3ddc0e79239b3e3e9cc649.tar.gz uhd-ea06c70f2e7d43fbec3ddc0e79239b3e3e9cc649.tar.bz2 uhd-ea06c70f2e7d43fbec3ddc0e79239b3e3e9cc649.zip |
docs: Add a section on the PCIe NI-RIO transport
Diffstat (limited to 'host')
-rw-r--r-- | host/docs/transport.dox | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/host/docs/transport.dox b/host/docs/transport.dox index 07aaa3249..92802cfd1 100644 --- a/host/docs/transport.dox +++ b/host/docs/transport.dox @@ -172,5 +172,30 @@ software: - Continue through the installation wizard until the driver is installed. +\section transport_pcie PCIe Transport (NI-RIO) + +The NI-RIO-based PCIe transport is only used with the X300/X310. It uses a +separate driver stack (NI-RIO) which must be installed separately (see also +\ref page_ni_rio_kernel). + +More information on how to set it up can be found here: \ref x3x0_hw_pcie. + +The X3x0 PCIe transport has 6 separate bidirectional DMA channels, and UHD will +use two of those for command, control, and asynchronous messages. That means a +total of four DMA channels can be used for streaming (either 4xRX, for TwinRX +operations, or 2xRX + 2xTX for full-duplex operation). + +\subsection transport_usb_params Transport parameters + +The following parameters can be used to alter the transport's default +behavior: + +- `recv_frame_size:` The size of a single receive transfers in bytes +- `num_recv_frames:` The number of simultaneous receive transfers +- `recv_buff_size:` The socket buffer size. Must be a multiple of pages +- `send_frame_size:` The size of a single send transfers in bytes +- `num_send_frames:` The number of simultaneous send transfers +- `send_buff_size:` The socket buffer size. Must be a multiple of pages + */ // vim:ft=doxygen: |