[v2,7/8] doc/qat: update PMD build section

Message ID 1533833430-29134-8-git-send-email-fiona.trahe@intel.com
State Superseded, archived
Delegated to: akhil goyal
Headers show
Series
  • doc/qat: clarify build config options
Related show

Checks

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

Commit Message

Trahe, Fiona Aug. 9, 2018, 4:50 p.m.
Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/cryptodevs/qat.rst | 76 ++++++++++++++++++++++++++++---------------
 1 file changed, 49 insertions(+), 27 deletions(-)

Comments

Thomas Monjalon Aug. 9, 2018, 7:47 p.m. | #1
09/08/2018 18:50, Fiona Trahe:
> +Quick instructions for QAT compressdev PMD are as follows:
>  
> +.. code-block:: console
> +
> +	cd to the top-level DPDK directory
> +	make defconfig
> +	make

This code block seems too much obvious.


> +.. _qat_kernel:
> +
> +Dependency on the QAT kernel driver
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The anchor seems useless.
Trahe, Fiona Aug. 10, 2018, 7:51 a.m. | #2
Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, August 9, 2018 8:48 PM
> To: Trahe, Fiona <fiona.trahe@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX
> <tomaszx.jozwiak@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section
> 
> 09/08/2018 18:50, Fiona Trahe:
> > +Quick instructions for QAT compressdev PMD are as follows:
> >
> > +.. code-block:: console
> > +
> > +	cd to the top-level DPDK directory
> > +	make defconfig
> > +	make
> 
> This code block seems too much obvious.
Just for completeness and to be helpful - save people wasting time looking for 
a non-existent QAT comp config option which they'd probably do if following the snippet above it
for QAT crypto where there is a need to change config. 
  
> 
> 
> > +.. _qat_kernel:
> > +
> > +Dependency on the QAT kernel driver
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> The anchor seems useless.
> 
It's used a few paragraphs above.
Thomas Monjalon Aug. 10, 2018, 9 a.m. | #3
10/08/2018 09:51, Trahe, Fiona:
> Hi Thomas,
> 
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> > 09/08/2018 18:50, Fiona Trahe:
> > > +Quick instructions for QAT compressdev PMD are as follows:
> > >
> > > +.. code-block:: console
> > > +
> > > +	cd to the top-level DPDK directory
> > > +	make defconfig
> > > +	make
> > 
> > This code block seems too much obvious.
> Just for completeness and to be helpful - save people wasting time looking for 
> a non-existent QAT comp config option which they'd probably do if following the snippet above it
> for QAT crypto where there is a need to change config. 

I don't understand.
There is nothing to change in the config, right?

> > > +.. _qat_kernel:
> > > +
> > > +Dependency on the QAT kernel driver
> > > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > 
> > The anchor seems useless.
> > 
> It's used a few paragraphs above.

I don't find it in your patches.
Trahe, Fiona Aug. 10, 2018, 1:14 p.m. | #4
Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Friday, August 10, 2018 10:01 AM
> To: Trahe, Fiona <fiona.trahe@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX
> <tomaszx.jozwiak@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section
> 
> 10/08/2018 09:51, Trahe, Fiona:
> > Hi Thomas,
> >
> > From: Thomas Monjalon [mailto:thomas@monjalon.net]
> > > 09/08/2018 18:50, Fiona Trahe:
> > > > +Quick instructions for QAT compressdev PMD are as follows:
> > > >
> > > > +.. code-block:: console
> > > > +
> > > > +	cd to the top-level DPDK directory
> > > > +	make defconfig
> > > > +	make
> > >
> > > This code block seems too much obvious.
> > Just for completeness and to be helpful - save people wasting time looking for
> > a non-existent QAT comp config option which they'd probably do if following the snippet above it
> > for QAT crypto where there is a need to change config.
> 
> I don't understand.
> There is nothing to change in the config, right?
[Fiona] Have a look in the final html - I believe it's clearer with this section in and is more helpful to leave in than to omit.


> > > > +.. _qat_kernel:
> > > > +
> > > > +Dependency on the QAT kernel driver
> > > > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > >
> > > The anchor seems useless.
> > >
> > It's used a few paragraphs above.
> 
> I don't find it in your patches.
> 
It's in this patch about 40 lines above the line you commented on.

Patch

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 2f233ec9d..6e4927697 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -105,45 +105,41 @@  must be such that points at the start of the COUNT bytes.
 Building PMDs on QAT
 --------------------
 
-To enable QAT crypto in DPDK, follow the instructions for modifying the compile-time
-configuration file as described `here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
+A QAT device can host multiple acceleration services:
 
+* symmetric cryptography
+* data compression
 
-Quick instructions are as follows:
+These services are provided to DPDK applications via PMDs which register to
+implement the corresponding cryptodev and compressdev APIs. The PMDs use
+common QAT driver code which manages the QAT PCI device. They also depend on a
+QAT kernel driver being installed on the platform, see :ref:`qat_kernel` below.
 
-.. code-block:: console
 
-	cd to the top-level DPDK directory
-	make config T=x86_64-native-linuxapp-gcc
-	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT\)=n,\1=y,' build/.config
-	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\)=n,\1=y,' build/.config
-	make
+Configuring and Building the DPDK QAT PMDs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
-Dependency on the QAT kernel driver
-~~~~~~~~~~~~~~~~~~~~~~~~
+Further information on configuring, building and installing DPDK is described
+`here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
 
-To use the QAT PMD an SRIOV-enabled QAT kernel driver is required. The VF
-devices created and initialised by this driver will be used by the QAT PMD.
 
-Instructions for installation are below, but first an explanation of the
-relationships between the PF/VF devices and the PMDs visible to
-DPDK applications.
+Quick instructions for QAT cryptodev PMD are as follows:
 
-Each QuickAssist PF device exposes a number of VF devices. Each VF device can
-enable one cryptodev PMD and/or one compressdev PMD.
-These QAT PMDs share the same underlying device and pci-mgmt code, but are
-enumerated independently on their respective APIs and appear as independent
-devices to applications.
+.. code-block:: console
 
-.. Note::
+	cd to the top-level DPDK directory
+	make defconfig
+	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\)=n,\1=y,' build/.config
+	make
 
-   Each VF can only be used by one DPDK process. It is not possible to share
-   the same VF across multiple processes, even if these processes are using
-   different acceleration services.
+Quick instructions for QAT compressdev PMD are as follows:
 
-   Conversely one DPDK process can use one or more QAT VFs and can expose both
-   cryptodev and compressdev instances on each of those VFs.
+.. code-block:: console
+
+	cd to the top-level DPDK directory
+	make defconfig
+	make
 
 
 
@@ -164,6 +160,32 @@  Device and driver naming
 	The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
 
 
+.. _qat_kernel:
+
+Dependency on the QAT kernel driver
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To use QAT an SRIOV-enabled QAT kernel driver is required. The VF
+devices created and initialised by this driver will be used by the QAT PMDs.
+
+Instructions for installation are below, but first an explanation of the
+relationships between the PF/VF devices and the PMDs visible to
+DPDK applications.
+
+Each QuickAssist PF device exposes a number of VF devices. Each VF device can
+enable one cryptodev PMD and/or one compressdev PMD.
+These QAT PMDs share the same underlying device and pci-mgmt code, but are
+enumerated independently on their respective APIs and appear as independent
+devices to applications.
+
+.. Note::
+
+   Each VF can only be used by one DPDK process. It is not possible to share
+   the same VF across multiple processes, even if these processes are using
+   different acceleration services.
+
+   Conversely one DPDK process can use one or more QAT VFs and can expose both
+   cryptodev and compressdev instances on each of those VFs.
 
 
 Available kernel drivers