[dpdk-dev] [PATCH] doc/guides: add info on how to enable QAT

[dpdk-dev] [PATCH] doc/guides: add info on how to enable QAT

[Eoin Breen]

Signed-off-by: Eoin Breen <eoin.breen@intel.com>
---
 doc/guides/cryptodevs/qat.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index cae1958..db03470 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -78,6 +78,11 @@ Installation
 To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The
 VF devices exposed by this driver will be used by QAT PMD.
 
+To enable QAT in DPDK you must change the ./config/common_base file. Change the
+line 'CONFIG_RTE_LIBRTE_PMD_QAT=n' to 'CONFIG_RTE_LIBRTE_PMD_QAT=y' to do this.
+You must then configure and build dpdk, for example using the commands:
+make T=x86_64-native-linuxapp-gcc config; make
+
 If you are running on kernel 4.4 or greater, see instructions for
 `Installation using kernel.org driver`_ below. If you are on a kernel earlier
 than 4.4, see `Installation using 01.org QAT driver`_.
-- 
2.5.5

--------------------------------------------------------------
Intel Research and Development Ireland Limited
Registered in Ireland
Registered Office: Collinstown Industrial Park, Leixlip, County Kildare
Registered Number: 308263


This e-mail and any attachments may contain confidential material for the sole
use of the intended recipient(s). Any review or distribution by others is
strictly prohibited. If you are not the intended recipient, please contact the
sender and delete all copies.

Re: [dpdk-dev] [PATCH] doc/guides: add info on how to enable QAT

[Thomas Monjalon]

2016-08-30 14:26, Eoin Breen:
> --- a/doc/guides/cryptodevs/qat.rst
> +++ b/doc/guides/cryptodevs/qat.rst
> @@ -78,6 +78,11 @@ Installation
>  To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The
>  VF devices exposed by this driver will be used by QAT PMD.
>  
> +To enable QAT in DPDK you must change the ./config/common_base file. Change the
> +line 'CONFIG_RTE_LIBRTE_PMD_QAT=n' to 'CONFIG_RTE_LIBRTE_PMD_QAT=y' to do this.

No, the recommended way is to change the value in the generated config
file (.config).

PS: please avoid confidential disclaimer

Re: [dpdk-dev] [PATCH] doc/guides: add info on how to enable QAT

[Wiles, Keith]

Regards,
Keith

> On Aug 30, 2016, at 8:46 AM, Thomas Monjalon <thomas.monjalon@6wind.com> wrote:
> 
> 2016-08-30 14:26, Eoin Breen:
>> --- a/doc/guides/cryptodevs/qat.rst
>> +++ b/doc/guides/cryptodevs/qat.rst
>> @@ -78,6 +78,11 @@ Installation
>> To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The
>> VF devices exposed by this driver will be used by QAT PMD.
>> 
>> +To enable QAT in DPDK you must change the ./config/common_base file. Change the
>> +line 'CONFIG_RTE_LIBRTE_PMD_QAT=n' to 'CONFIG_RTE_LIBRTE_PMD_QAT=y' to do this.
> 
> No, the recommended way is to change the value in the generated config
> file (.config).

The way I have been changing the default configuration options is to copy the config/defconfig_XYZ file like defconfig_x86_64-native-linuxapp-gcc to a new name say defconfig-x86_64-qat-linuxapp-gcc. Then edit that file and add the CONFIG_RTE_LIBRTE_PMD_QAT=y to the bottom of the file. Then ‘make install T=x86_64-qat-linuxapp-gcc -j’.

Is this not a better way to build a new configuration for a specific reason?

> 
> PS: please avoid confidential disclaimer

Re: [dpdk-dev] [PATCH] doc/guides: add info on how to enable QAT

[Thomas Monjalon]

2016-08-30 13:57, Wiles, Keith:
> > 2016-08-30 14:26, Eoin Breen:
> >> --- a/doc/guides/cryptodevs/qat.rst
> >> +++ b/doc/guides/cryptodevs/qat.rst
> >> @@ -78,6 +78,11 @@ Installation
> >> To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The
> >> VF devices exposed by this driver will be used by QAT PMD.
> >> 
> >> +To enable QAT in DPDK you must change the ./config/common_base file. Change the
> >> +line 'CONFIG_RTE_LIBRTE_PMD_QAT=n' to 'CONFIG_RTE_LIBRTE_PMD_QAT=y' to do this.
> > 
> > No, the recommended way is to change the value in the generated config
> > file (.config).
> 
> The way I have been changing the default configuration options is to copy the config/defconfig_XYZ file like defconfig_x86_64-native-linuxapp-gcc to a new name say defconfig-x86_64-qat-linuxapp-gcc. Then edit that file and add the CONFIG_RTE_LIBRTE_PMD_QAT=y to the bottom of the file. Then ‘make install T=x86_64-qat-linuxapp-gcc -j’.
> 
> Is this not a better way to build a new configuration for a specific reason?

Yes you can also build your own defconfig.
I think it is better to stick to simply change the generated file between
"make config" and "make" for the documentation.

Re: [dpdk-dev] [PATCH] doc/guides: add info on how to enable QAT

[Mcnamara, John]

> -----Original Message-----
> From: Breen, Eoin
> Sent: Tuesday, August 30, 2016 2:27 PM
> To: Jain, Deepak K <deepak.k.jain@intel.com>; Trahe, Fiona
> <fiona.trahe@intel.com>; Griffin, John <john.griffin@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>; Breen, Eoin
> <eoin.breen@intel.com>
> Subject: [PATCH] doc/guides: add info on how to enable QAT
> 
> Signed-off-by: Eoin Breen <eoin.breen@intel.com>
> ---
>  doc/guides/cryptodevs/qat.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
> index cae1958..db03470 100644
> --- a/doc/guides/cryptodevs/qat.rst
> +++ b/doc/guides/cryptodevs/qat.rst
> @@ -78,6 +78,11 @@ Installation
>  To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required.
> The  VF devices exposed by this driver will be used by QAT PMD.
> 
> +To enable QAT in DPDK you must change the ./config/common_base file.
> +Change the line 'CONFIG_RTE_LIBRTE_PMD_QAT=n' to
> 'CONFIG_RTE_LIBRTE_PMD_QAT=y' to do this.
> +You must then configure and build dpdk, for example using the commands:
> +make T=x86_64-native-linuxapp-gcc config; make
> +

Hi,

>From a documentation point of view the 'make' commands should be on two lines, indented to indicate a code block and prefixed with '::' and a blank line.

The filename and CONFIG items should also be in ```` backquotes.

John