[v2] doc: update for ENA supported drivers
diff mbox series

Message ID 1539173295-11503-1-git-send-email-rk@semihalf.com
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • [v2] doc: update for ENA supported drivers
Related show

Checks

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

Commit Message

Rafal Kozik Oct. 10, 2018, 12:08 p.m. UTC
Add instruction how to bind ENA to VFIO-PCI driver.

Fixes: cf8a122c296a ("ena: introduce documentation")
Cc: stable@dpdk.org

Signed-off-by: Zorik Machulsky <zorik@amazon.com>
Signed-off-by: Rafal Kozik <rk@semihalf.com>
Acked-by: Michal Krawczyk <mk@semihalf.com>
---
v2:
Describe cases with and without IOMMU.
---
 doc/guides/nics/ena.rst          | 14 +++++++++++---
 doc/guides/nics/features/ena.ini |  1 +
 2 files changed, 12 insertions(+), 3 deletions(-)

Comments

Ferruh Yigit Oct. 11, 2018, 10:37 a.m. UTC | #1
On 10/10/2018 1:08 PM, Rafal Kozik wrote:
> Add instruction how to bind ENA to VFIO-PCI driver.
> 
> Fixes: cf8a122c296a ("ena: introduce documentation")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Zorik Machulsky <zorik@amazon.com>
> Signed-off-by: Rafal Kozik <rk@semihalf.com>
> Acked-by: Michal Krawczyk <mk@semihalf.com>

Applied to dpdk-next-net/master, thanks.

(syntax updated, highlight etc.. while merging.)

Patch
diff mbox series

diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst
index d19912e..77399f4 100644
--- a/doc/guides/nics/ena.rst
+++ b/doc/guides/nics/ena.rst
@@ -187,11 +187,19 @@  Prerequisites
 -------------
 
 #. Prepare the system as recommended by DPDK suite.  This includes environment
-   variables, hugepages configuration, tool-chains and configuration
+   variables, hugepages configuration, tool-chains and configuration.
 
-#. Insert igb_uio kernel module using the command 'modprobe igb_uio'
+#. ENA PMD can operate with vfio-pci or igb_uio driver.
 
-#. Bind the intended ENA device to igb_uio module
+#. Insert vfio-pci or igb_uio kernel module using the command
+   'modprobe vfio-pci' or 'modprobe igb_uio' respectively.
+
+#. For VFIO-PCI users only:
+   Please make sure that IOMMU is enabled in your system,
+   or use VFIO driver in noiommu mode:
+   echo 1 > /sys/module/vfio/parameters/enable_unsafe_noiommu_mode
+
+#. Bind the intended ENA device to vfio-pci or igb_uio module.
 
 
 At this point the system should be ready to run DPDK applications. Once the
diff --git a/doc/guides/nics/features/ena.ini b/doc/guides/nics/features/ena.ini
index 691c1e3..aa6f05a 100644
--- a/doc/guides/nics/features/ena.ini
+++ b/doc/guides/nics/features/ena.ini
@@ -23,5 +23,6 @@  Inner L4 checksum    = Y
 Basic stats          = Y
 Extended stats       = Y
 Linux UIO            = Y
+Linux VFIO           = Y
 x86-32               = Y
 x86-64               = Y