[PATCH] doc: update for ENA supported drivers

[PATCH] doc: update for ENA supported drivers

[Rafal Kozik]

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>
---
 doc/guides/nics/ena.rst          | 12 +++++++++---
 doc/guides/nics/features/ena.ini |  1 +
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst
index d19912e..0dfefc6 100644
--- a/doc/guides/nics/ena.rst
+++ b/doc/guides/nics/ena.rst
@@ -187,11 +187,17 @@ 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.
+
+#. If vfio-pci driver is used please make sure noiommu mode is enabled:
+   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
-- 
2.7.4

Re: [PATCH] doc: update for ENA supported drivers

[Ferruh Yigit]

On 10/5/2018 10:02 AM, 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>
> ---
>  doc/guides/nics/ena.rst          | 12 +++++++++---
>  doc/guides/nics/features/ena.ini |  1 +
>  2 files changed, 10 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst
> index d19912e..0dfefc6 100644
> --- a/doc/guides/nics/ena.rst
> +++ b/doc/guides/nics/ena.rst
> @@ -187,11 +187,17 @@ 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.

Unless installed "igb_uio" won't be available to use with "modprobe", not sure
about adding that detail, what do you think?

> +
> +#. If vfio-pci driver is used please make sure noiommu mode is enabled:
> +   echo 1 > /sys/module/vfio/parameters/enable_unsafe_noiommu_mode

This is only required if there is no iommu on the system, right? Won't ena will
work without this parameter on the system that has iommu?

> +
> +#. 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
> 

Re: [PATCH] doc: update for ENA supported drivers

[Rafał Kozik]

Hello Ferruh,

> Unless installed "igb_uio" won't be available to use with "modprobe", not sure
> about adding that detail, what do you think?

I did not add it. In current version this information is already present:
> -#. Bind the intended ENA device to igb_uio module


> This is only required if there is no iommu on the system, right? Won't ena will
> work without this parameter on the system that has iommu?

I will prepare next version, that will clarify it.

Best regards,
Rafal

wt., 9 paź 2018 o 12:56 Ferruh Yigit <ferruh.yigit@intel.com> napisał(a):
>
> On 10/5/2018 10:02 AM, 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>
> > ---
> >  doc/guides/nics/ena.rst          | 12 +++++++++---
> >  doc/guides/nics/features/ena.ini |  1 +
> >  2 files changed, 10 insertions(+), 3 deletions(-)
> >
> > diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst
> > index d19912e..0dfefc6 100644
> > --- a/doc/guides/nics/ena.rst
> > +++ b/doc/guides/nics/ena.rst
> > @@ -187,11 +187,17 @@ 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.
>
> Unless installed "igb_uio" won't be available to use with "modprobe", not sure
> about adding that detail, what do you think?
>
> > +
> > +#. If vfio-pci driver is used please make sure noiommu mode is enabled:
> > +   echo 1 > /sys/module/vfio/parameters/enable_unsafe_noiommu_mode
>
> This is only required if there is no iommu on the system, right? Won't ena will
> work without this parameter on the system that has iommu?
>
> > +
> > +#. 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
> >
>

[PATCH v2] doc: update for ENA supported drivers

[Rafal Kozik]

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(-)

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
-- 
2.7.4

Re: [PATCH v2] doc: update for ENA supported drivers

[Ferruh Yigit]

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.)