[dpdk-dev,v2] doc: add VF support statement

Message ID 1493792488-60857-1-git-send-email-qiming.yang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Qiming Yang May 3, 2017, 6:21 a.m. UTC
  This patch adds two note in doc build_dpdk, suggests DPDK user
don't use ``vfio-pci`` and ``uio_pci_generic`` module to create
virtual functions(VFs).

Signed-off-by: Qiming Yang <qiming.yang@intel.com>
---
v2 changes:
* use better expression.
---
---
 doc/guides/linux_gsg/build_dpdk.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
  

Comments

Thomas Monjalon May 7, 2017, 12:16 p.m. UTC | #1
03/05/2017 08:21, Qiming Yang:
> This patch adds two note in doc build_dpdk, suggests DPDK user
> don't use ``vfio-pci`` and ``uio_pci_generic`` module to create
> virtual functions(VFs).
> 
> Signed-off-by: Qiming Yang <qiming.yang@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
index 9d24573..cf6c06d 100644
--- a/doc/guides/linux_gsg/build_dpdk.rst
+++ b/doc/guides/linux_gsg/build_dpdk.rst
@@ -155,6 +155,10 @@  can provide the uio capability. This module can be loaded using the command
 
     sudo modprobe uio_pci_generic
 
+.. note::
+
+    ``uio_pci_generic`` module doesn't support the creation of virtual functions.
+
 As an alternative to the ``uio_pci_generic``, the DPDK also includes the igb_uio
 module which can be found in the kmod subdirectory referred to above. It can
 be loaded as shown below:
@@ -187,6 +191,10 @@  however please consult your distributions documentation to make sure that is the
 
 Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d).
 
+.. note::
+
+    ``vfio-pci`` module doesn't support the creation of virtual functions.
+
 For proper operation of VFIO when running DPDK applications as a non-privileged user, correct permissions should also be set up.
 This can be done by using the DPDK setup script (called dpdk-setup.sh and located in the usertools directory).