[dpdk-dev] [PATCH] doc/guides: add more info re VT-d/iommu settings for QAT

[dpdk-dev] [PATCH] doc/guides: add more info re VT-d/iommu settings for QAT

[Fiona Trahe]

add more info re VT-d/iommu settings for QAT
remove limitation re performance tuning

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/cryptodevs/qat.rst | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 70bc2b1..bbe0b12 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -77,7 +77,6 @@ Limitations
 * Hash only is not supported except SNOW 3G UIA2 and KASUMI F9.
 * Cipher only is not supported except SNOW 3G UEA2, KASUMI F8 and 3DES.
 * Only supports the session-oriented API implementation (session-less APIs are not supported).
-* Not performance tuned.
 * SNOW 3G (UEA2) and KASUMI (F8) supported only if cipher length, cipher offset fields are byte-aligned.
 * SNOW 3G (UIA2) and KASUMI (F9) supported only if hash length, hash offset fields are byte-aligned.
 * No BSD support as BSD QAT kernel driver not available.
@@ -201,7 +200,7 @@ The steps below assume you are:
 * Running DPDK on a platform with one ``DH895xCC`` device.
 * On a kernel at least version 4.4.
 
-In BIOS ensure that SRIOV is enabled and VT-d is disabled.
+In BIOS ensure that SRIOV is enabled and either a) disable VT-d or b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 
 Ensure the QAT driver is loaded on your system, by executing::
 
@@ -260,7 +259,7 @@ The steps below assume you are:
 * Running DPDK on a platform with one ``C62x`` device.
 * On a kernel at least version 4.5.
 
-In BIOS ensure that SRIOV is enabled and VT-d is disabled.
+In BIOS ensure that SRIOV is enabled and either a) disable VT-d or b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 
 Ensure the QAT driver is loaded on your system, by executing::
 
@@ -304,7 +303,7 @@ The steps below assume you are:
 * Running DPDK on a platform with one ``C3xxx`` device.
 * On a kernel at least version 4.5.
 
-In BIOS ensure that SRIOV is enabled and VT-d is disabled.
+In BIOS ensure that SRIOV is enabled and either a) disable VT-d or b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 
 Ensure the QAT driver is loaded on your system, by executing::
 
-- 
2.5.0

Re: [dpdk-dev] [PATCH] doc/guides: add more info re VT-d/iommu settings for QAT

[Thomas Monjalon]

2016-10-26 16:20, Fiona Trahe:
> add more info re VT-d/iommu settings for QAT
> remove limitation re performance tuning

Sorry, I do not understand what means "re".
Please use an uppercase at the beginning of each sentence and
a dot at the end. It helps reading.

Re: [dpdk-dev] [PATCH] doc/guides: add more info re VT-d/iommu settings for QAT

[Trahe, Fiona]

 Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Wednesday, October 26, 2016 4:27 PM
> To: Trahe, Fiona <fiona.trahe@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc/guides: add more info re VT-d/iommu
> settings for QAT
> 
> 2016-10-26 16:20, Fiona Trahe:
> > add more info re VT-d/iommu settings for QAT remove limitation re
> > performance tuning
> 
> Sorry, I do not understand what means "re".

"re" is commonly used in the English language and means "in reference to" or "about"
but I'm happy to change to "about" which is the more conventional word.
There's an interesting explanation of the evolution of the term here:
https://en.oxforddictionaries.com/definition/re
Usage
The traditional view is that re should be used in headings and references, as in Re: Ainsworth versus Chambers, but not as a normal word meaning 'about', as in I saw the deputy head re the incident. However, the evidence suggests that re is now widely used in the second context in official and semi-official contexts, and is now generally accepted. It is hard to see any compelling logical argument against using it as an ordinary English word in this way

> Please use an uppercase at the beginning of each sentence and a dot at the
> end. It helps reading.
Ok.  
I was confusing this with the style needed for the email subject, which is the opposite!

Re: [dpdk-dev] [PATCH] doc/guides: add more info re VT-d/iommu settings for QAT

[Thomas Monjalon]

2016-10-26 16:50, Trahe, Fiona:
>  Hi Thomas,
> 
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > 2016-10-26 16:20, Fiona Trahe:
> > > add more info re VT-d/iommu settings for QAT remove limitation re
> > > performance tuning
> > 
> > Sorry, I do not understand what means "re".
> 
> "re" is commonly used in the English language and means "in reference to" or "about"
> but I'm happy to change to "about" which is the more conventional word.
> There's an interesting explanation of the evolution of the term here:
> https://en.oxforddictionaries.com/definition/re
> Usage
> The traditional view is that re should be used in headings and references, as in Re: Ainsworth versus Chambers, but not as a normal word meaning 'about', as in I saw the deputy head re the incident. However, the evidence suggests that re is now widely used in the second context in official and semi-official contexts, and is now generally accepted. It is hard to see any compelling logical argument against using it as an ordinary English word in this way

Thanks for the detailed explanations, and sorry again for my ignorance :)

[dpdk-dev] [PATCH v2] doc/guides: add more info about VT-d/iommu settings

[Fiona Trahe]

Add more information about VT-d/iommu settings for QAT PMD.
Remove limitation indicating QAT driver is not performance tuned.

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---

v2:
 clarified commit message


 doc/guides/cryptodevs/qat.rst | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 70bc2b1..bbe0b12 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -77,7 +77,6 @@ Limitations
 * Hash only is not supported except SNOW 3G UIA2 and KASUMI F9.
 * Cipher only is not supported except SNOW 3G UEA2, KASUMI F8 and 3DES.
 * Only supports the session-oriented API implementation (session-less APIs are not supported).
-* Not performance tuned.
 * SNOW 3G (UEA2) and KASUMI (F8) supported only if cipher length, cipher offset fields are byte-aligned.
 * SNOW 3G (UIA2) and KASUMI (F9) supported only if hash length, hash offset fields are byte-aligned.
 * No BSD support as BSD QAT kernel driver not available.
@@ -201,7 +200,7 @@ The steps below assume you are:
 * Running DPDK on a platform with one ``DH895xCC`` device.
 * On a kernel at least version 4.4.
 
-In BIOS ensure that SRIOV is enabled and VT-d is disabled.
+In BIOS ensure that SRIOV is enabled and either a) disable VT-d or b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 
 Ensure the QAT driver is loaded on your system, by executing::
 
@@ -260,7 +259,7 @@ The steps below assume you are:
 * Running DPDK on a platform with one ``C62x`` device.
 * On a kernel at least version 4.5.
 
-In BIOS ensure that SRIOV is enabled and VT-d is disabled.
+In BIOS ensure that SRIOV is enabled and either a) disable VT-d or b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 
 Ensure the QAT driver is loaded on your system, by executing::
 
@@ -304,7 +303,7 @@ The steps below assume you are:
 * Running DPDK on a platform with one ``C3xxx`` device.
 * On a kernel at least version 4.5.
 
-In BIOS ensure that SRIOV is enabled and VT-d is disabled.
+In BIOS ensure that SRIOV is enabled and either a) disable VT-d or b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 
 Ensure the QAT driver is loaded on your system, by executing::
 
-- 
2.5.0

Re: [dpdk-dev] [PATCH] doc/guides: add more info re VT-d/iommu settings for QAT

[Jain, Deepak K]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Fiona Trahe
> Sent: Wednesday, October 26, 2016 4:20 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc/guides: add more info re VT-d/iommu
> settings for QAT
> 
> add more info re VT-d/iommu settings for QAT remove limitation re
> performance tuning
> 
> Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
> ---
>  doc/guides/cryptodevs/qat.rst | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
> index 70bc2b1..bbe0b12 100644
> --- a/doc/guides/cryptodevs/qat.rst
> +++ b/doc/guides/cryptodevs/qat.rst
> 
> --
> 2.5.0
Acked-by: Deepak Kumar Jain<deepak.k.jain@intel.com>

Re: [dpdk-dev] [PATCH v2] doc/guides: add more info about VT-d/iommu settings

[Kusztal, ArkadiuszX]

> -----Original Message-----
> From: Trahe, Fiona
> Sent: Wednesday, October 26, 2016 6:24 PM
> To: dev@dpdk.org
> Cc: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Trahe, Fiona
> <fiona.trahe@intel.com>; Griffin, John <john.griffin@intel.com>
> Subject: [PATCH v2] doc/guides: add more info about VT-d/iommu settings
> 
> Add more information about VT-d/iommu settings for QAT PMD.
> Remove limitation indicating QAT driver is not performance tuned.
> 
> Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
> ---
> 
> v2:
>  clarified commit message
> 
> 
>  doc/guides/cryptodevs/qat.rst | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
> index 70bc2b1..bbe0b12 100644
> --- a/doc/guides/cryptodevs/qat.rst
> +++ b/doc/guides/cryptodevs/qat.rst
> 
> --
> 2.5.0
Acked-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>

Re: [dpdk-dev] [PATCH v2] doc/guides: add more info about VT-d/iommu settings

[Thomas Monjalon]

> > Add more information about VT-d/iommu settings for QAT PMD.
> > Remove limitation indicating QAT driver is not performance tuned.
> > 
> > Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
> Acked-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>

Wrapped lines and applied.