[dpdk-dev] [PATCH] doc/qat: clarify build config options

[dpdk-dev] [PATCH] doc/qat: clarify build config options

[Fiona Trahe]

Clarified documentation structure between
compressedev, cryptodev and common build parts.
Clarified build configuration options.
Added Testing section.
Fixed typos and made some cosmetic improvements.

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/compressdevs/qat_comp.rst |   6 +-
 doc/guides/cryptodevs/qat.rst        | 194 ++++++++++++++++++++++++-----------
 2 files changed, 138 insertions(+), 62 deletions(-)

diff --git a/doc/guides/compressdevs/qat_comp.rst b/doc/guides/compressdevs/qat_comp.rst
index 8b1270b70..7bffbe6ff 100644
--- a/doc/guides/compressdevs/qat_comp.rst
+++ b/doc/guides/compressdevs/qat_comp.rst
@@ -36,12 +36,14 @@ Limitations
 -----------
 
 * Compressdev level 0, no compression, is not supported.
-
 * Dynamic Huffman encoding is not yet supported.
+* Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
+* No BSD support as BSD QAT kernel driver not available.
+
 
 Installation
 ------------
 
 The QAT compression PMD is built by default with a standard DPDK build.
 
-It depends on a QAT kernel driver, see :ref:`qat_kernel_installation`.
+It depends on a QAT kernel driver, see :ref:`building_qat`.
diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index bdc58eb2c..7b5929681 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -2,9 +2,21 @@
     Copyright(c) 2015-2016 Intel Corporation.
 
 Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
-==================================================
+===================================================
 
-The QAT PMD provides poll mode crypto driver support for the following
+QAT documentation consists of three parts:
+
+* Details of the symmetric crypto service below.
+* Details of the `compression service <http://dpdk.org/doc/guides/compressdevs/qat_comp.html>`_
+  in the compressdev drivers section.
+* Details of building the common QAT infrastructure and the PMDs to support the
+  above services. See :ref:`building_qat` below.
+
+
+Symmetric Crypto Service on QAT
+--------------------------------------------------
+
+The QAT crypto PMD provides poll mode crypto driver support for the following
 hardware accelerator devices:
 
 * ``Intel QuickAssist Technology DH895xCC``
@@ -14,7 +26,7 @@ hardware accelerator devices:
 
 
 Features
---------
+~~~~~~~~
 
 The QAT PMD has support for:
 
@@ -57,7 +69,7 @@ Supported AEAD algorithms:
 
 
 Limitations
------------
+~~~~~~~~~~~~~
 
 * Only supports the session-oriented API implementation (session-less APIs are not supported).
 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
@@ -69,104 +81,148 @@ Limitations
 
 
 Extra notes on KASUMI F9
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 When using KASUMI F9 authentication algorithm, the input buffer must be
-constructed according to the 3GPP KASUMI specifications (section 4.4, page 13):
-`<http://cryptome.org/3gpp/35201-900.pdf>`_.
-Input buffer has to have COUNT (4 bytes), FRESH (4 bytes), MESSAGE and DIRECTION (1 bit)
-concatenated. After the DIRECTION bit, a single '1' bit is appended, followed by
-between 0 and 7 '0' bits, so that the total length of the buffer is multiple of 8 bits.
-Note that the actual message can be any length, specified in bits.
+constructed according to the
+`3GPP KASUMI specification <http://cryptome.org/3gpp/35201-900.pdf>`_
+(section 4.4, page 13). The input buffer has to have COUNT (4 bytes),
+FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
+bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
+the total length of the buffer is multiple of 8 bits. Note that the actual
+message can be any length, specified in bits.
 
 Once this buffer is passed this way, when creating the crypto operation,
-length of data to authenticate (op.sym.auth.data.length) must be the length
+length of data to authenticate "op.sym.auth.data.length" must be the length
 of all the items described above, including the padding at the end.
-Also, offset of data to authenticate (op.sym.auth.data.offset)
+Also, offset of data to authenticate "op.sym.auth.data.offset"
 must be such that points at the start of the COUNT bytes.
 
 
-Building the DPDK QAT cryptodev PMD
------------------------------------
 
+.. _building_qat:
+
+Building PMDs on QAT
+----------------------------------
+
+A QAT device can host multiple acceleration services:
+
+* symmetric cryptography
+* data compression
 
-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>`_.
+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.
 
 
-Quick instructions are as follows:
+Configuring and Building the DPDK QAT PMDs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+Further information on configuring, building and installing DPDK is described
+`here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
+
+
+Quick instructions for QAT cryptodev PMD are as follows:
 
 .. 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
 
+Quick instructions for QAT compressdev PMD are as follows:
 
-.. _qat_kernel_installation:
+.. code-block:: console
 
-Dependency on the QAT kernel driver
------------------------------------
+	cd to the top-level DPDK directory
+	make config T=x86_64-native-linuxapp-gcc
+	make
 
-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.
+Build Configuration
+~~~~~~~~~~~~~~~~~~~~
 
-Instructions for installation are below, but first an explanation of the
-relationships between the PF/VF devices and the PMDs visible to
-DPDK applications.
+These are the build configuration options affecting QAT, and their default values:
 
+.. code-block:: console
 
-Acceleration services - cryptography and compression - are provided to DPDK
-applications via PMDs which register to implement the corresponding
-cryptodev and compressdev APIs.
+	CONFIG_RTE_LIBRTE_PMD_QAT=y
+	CONFIG_RTE_LIBRTE_PMD_QAT_SYM=n
+	CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES=48
+	CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS=16
 
-Each QuickAssist VF device can expose 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.
+CONFIG_RTE_LIBRTE_PMD_QAT must be enabled for any QAT PMD to be built.
 
-.. Note::
+The QAT cryptodev PMD has an external dependency on libcrypto, so is not
+built by default. CONFIG_RTE_LIBRTE_PMD_QAT_SYM should be enabled to build it.
 
-   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.
+The QAT compressdev PMD has no external dependencies, so needs no configuration
+options and is built by default.
 
-   Conversely one DPDK process can use one or more QAT VFs and can expose both
-   cryptodev and compressdev instances on each of those VFs.
+The number of VFs per PF varies - see table below. If multiple QAT packages are
+installed on a platform then CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES should be
+adjusted to the number of VFs which the QAT common code will need to handle.
+Note, there is a separate config item for max cryptodevs CONFIG_RTE_CRYPTO_MAX_DEVS,
+if necessary this should be adjusted to handle the total of QAT and other devices
+which the process will use.
 
+QAT allocates internal structures to handle SGLs. For the compression service
+CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS can be changed if more segments are needed.
+An extra (max_inflight_ops x 16) bytes per queue_pair will be used for every increment.
 
 
 Device and driver naming
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * The qat cryptodev driver name is "crypto_qat".
-  The rte_cryptodev_devices_get() returns the devices exposed by this driver.
+  The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
 
 * Each qat crypto device has a unique name, in format
-  <pci bdf>_<service>, e.g. "0000:41:01.0_qat_sym".
-  This name can be passed to rte_cryptodev_get_dev_id() to get the device_id.
+  "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_sym".
+  This name can be passed to "rte_cryptodev_get_dev_id()" to get the device_id.
 
 .. Note::
 
-	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the -devtype parameter.
+	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
 
 	The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
 
-* The qat compressdev driver name is "comp_qat".
-  The rte_compressdev_devices_get() returns the devices exposed by this driver.
 
-* Each qat compression device has a unique name, in format
-  <pci bdf>_<service>, e.g. "0000:41:01.0_qat_comp".
-  This name can be passed to rte_compressdev_get_dev_id() to get the device_id.
+.. _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
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Kernel drivers for each device are listed in the following table. Scroll right
-to check that the driver and device supports the servic you require.
+to check that the driver and device supports the service you require.
 
 
 .. _table_qat_pmds_drivers:
@@ -203,7 +259,7 @@ If you are running on a kernel which includes a driver for your device, see
 
 
 Installation using kernel.org driver
-------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The examples below are based on the C62x device, if you have a different device
 use the corresponding values in the above table.
@@ -274,7 +330,7 @@ To complete the installation follow the instructions in
 
 
 Installation using 01.org QAT driver
-------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Download the latest QuickAssist Technology Driver from `01.org
 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
@@ -368,12 +424,12 @@ To complete the installation - follow instructions in `Binding the available VFs
 
 
 Binding the available VFs to the DPDK UIO driver
-------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Unbind the VFs from the stock driver so they can be bound to the uio driver.
 
 For an Intel(R) QuickAssist Technology DH895xCC device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
 VFs are different adjust the unbind command below::
@@ -386,7 +442,7 @@ VFs are different adjust the unbind command below::
     done
 
 For an Intel(R) QuickAssist Technology C62x device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
@@ -406,7 +462,7 @@ adjust the unbind command below::
     done
 
 For Intel(R) QuickAssist Technology C3xxx or D15xx device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
 VFs are different adjust the unbind command below::
@@ -419,7 +475,7 @@ VFs are different adjust the unbind command below::
     done
 
 Bind to the DPDK uio driver
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
 to confirm the VF devices are now in use by igb_uio kernel driver,
@@ -438,9 +494,27 @@ Another way to bind the VFs to the DPDK UIO driver is by using the
     cd to the top-level DPDK directory
     ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
 
+Testing
+~~~~~~~
+
+QAT crypto PMD can be tested by running the test application::
+
+    make test-build -j
+    cd ./build/build/test/test
+    ./test -l1 -n1 -w <your qat bdf>
+    RTE>>cryptodev_qat_autotest
+
+QAT compression PMD can be tested by running the test application::
+
+    sed -i 's,\(CONFIG_RTE_COMPRESSDEV_TEST\)=n,\1=y,' build/.config
+    make test-build -j
+    cd ./build/build/test/test
+    ./test -l1 -n1 -w <your qat bdf>
+    RTE>>compressdev_autotest
+
 
 Debugging
-----------------------------------------
+~~~~~~~~~
 
 There are 2 sets of trace available via the dynamic logging feature:
 
-- 
2.13.6

[dpdk-dev] [PATCH v2 0/8] doc/qat: clarify build config options

[Fiona Trahe]

Clarified documentation structure between
compressedev, cryptodev and common build parts.
Clarified build configuration options.
Added Testing section.
Fixed typos and made some cosmetic improvements.

v2 changes
 - split into patchset
 - changed test path from build/build/test/test to build/app
 - use make defconfig instead of make config T=xxx
 - matched underline lengths to titles

Fiona Trahe (8):
  doc/qat: add limitations to compressdev PMD
  doc/qat: add information on how to test
  doc/qat: fix typos and make cosmetic changes
  doc/qat: add overview of doc sections
  doc/qat: remove unnecessary text
  doc/qat: update kernel dependency section
  doc/qat: update PMD build section
  doc/qat: describe build config options

 doc/guides/compressdevs/qat_comp.rst |   6 +-
 doc/guides/cryptodevs/qat.rst        | 197 ++++++++++++++++++++++++-----------
 2 files changed, 141 insertions(+), 62 deletions(-)

-- 
2.13.6

[dpdk-dev] [PATCH v2 1/8] doc/qat: add limitations to compressdev PMD

[Fiona Trahe]

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

diff --git a/doc/guides/compressdevs/qat_comp.rst b/doc/guides/compressdevs/qat_comp.rst
index 8b1270b70..b45f4a626 100644
--- a/doc/guides/compressdevs/qat_comp.rst
+++ b/doc/guides/compressdevs/qat_comp.rst
@@ -36,8 +36,10 @@ Limitations
 -----------
 
 * Compressdev level 0, no compression, is not supported.
-
 * Dynamic Huffman encoding is not yet supported.
+* Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
+* No BSD support as BSD QAT kernel driver not available.
+
 
 Installation
 ------------
-- 
2.13.6

[dpdk-dev] [PATCH v2 2/8] doc/qat: add information on how to test

[Fiona Trahe]

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index bdc58eb2c..7df49ca44 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -438,6 +438,26 @@ Another way to bind the VFs to the DPDK UIO driver is by using the
     cd to the top-level DPDK directory
     ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
 
+Testing
+~~~~~~~
+
+QAT crypto PMD can be tested by running the test application::
+
+    make defconfig
+    make test-build -j
+    cd ./build/app
+    ./test -l1 -n1 -w <your qat bdf>
+    RTE>>cryptodev_qat_autotest
+
+QAT compression PMD can be tested by running the test application::
+
+    make defconfig
+    sed -i 's,\(CONFIG_RTE_COMPRESSDEV_TEST\)=n,\1=y,' build/.config
+    make test-build -j
+    cd ./build/app
+    ./test -l1 -n1 -w <your qat bdf>
+    RTE>>compressdev_autotest
+
 
 Debugging
 ----------------------------------------
-- 
2.13.6

[dpdk-dev] [PATCH v2 3/8] doc/qat: fix typos and make cosmetic changes

[Fiona Trahe]

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 7df49ca44..bfa4327b7 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -72,17 +72,18 @@ Extra notes on KASUMI F9
 ------------------------
 
 When using KASUMI F9 authentication algorithm, the input buffer must be
-constructed according to the 3GPP KASUMI specifications (section 4.4, page 13):
-`<http://cryptome.org/3gpp/35201-900.pdf>`_.
-Input buffer has to have COUNT (4 bytes), FRESH (4 bytes), MESSAGE and DIRECTION (1 bit)
-concatenated. After the DIRECTION bit, a single '1' bit is appended, followed by
-between 0 and 7 '0' bits, so that the total length of the buffer is multiple of 8 bits.
-Note that the actual message can be any length, specified in bits.
+constructed according to the
+`3GPP KASUMI specification <http://cryptome.org/3gpp/35201-900.pdf>`_
+(section 4.4, page 13). The input buffer has to have COUNT (4 bytes),
+FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
+bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
+the total length of the buffer is multiple of 8 bits. Note that the actual
+message can be any length, specified in bits.
 
 Once this buffer is passed this way, when creating the crypto operation,
-length of data to authenticate (op.sym.auth.data.length) must be the length
+length of data to authenticate "op.sym.auth.data.length" must be the length
 of all the items described above, including the padding at the end.
-Also, offset of data to authenticate (op.sym.auth.data.offset)
+Also, offset of data to authenticate "op.sym.auth.data.offset"
 must be such that points at the start of the COUNT bytes.
 
 
@@ -142,15 +143,15 @@ Device and driver naming
 ------------------------
 
 * The qat cryptodev driver name is "crypto_qat".
-  The rte_cryptodev_devices_get() returns the devices exposed by this driver.
+  The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
 
 * Each qat crypto device has a unique name, in format
-  <pci bdf>_<service>, e.g. "0000:41:01.0_qat_sym".
-  This name can be passed to rte_cryptodev_get_dev_id() to get the device_id.
+  "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_sym".
+  This name can be passed to "rte_cryptodev_get_dev_id()" to get the device_id.
 
 .. Note::
 
-	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the -devtype parameter.
+	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
 
 	The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
 
@@ -166,7 +167,7 @@ Available kernel drivers
 ------------------------
 
 Kernel drivers for each device are listed in the following table. Scroll right
-to check that the driver and device supports the servic you require.
+to check that the driver and device supports the service you require.
 
 
 .. _table_qat_pmds_drivers:
-- 
2.13.6

[dpdk-dev] [PATCH v2 4/8] doc/qat: add overview of doc sections

[Fiona Trahe]

Add overview of QAT doc sections and link between them.
Indent to next level all sections within
the crypto and common sections.

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/compressdevs/qat_comp.rst |  2 +-
 doc/guides/cryptodevs/qat.rst        | 46 +++++++++++++++++++++++-------------
 2 files changed, 31 insertions(+), 17 deletions(-)

diff --git a/doc/guides/compressdevs/qat_comp.rst b/doc/guides/compressdevs/qat_comp.rst
index b45f4a626..7bffbe6ff 100644
--- a/doc/guides/compressdevs/qat_comp.rst
+++ b/doc/guides/compressdevs/qat_comp.rst
@@ -46,4 +46,4 @@ Installation
 
 The QAT compression PMD is built by default with a standard DPDK build.
 
-It depends on a QAT kernel driver, see :ref:`qat_kernel_installation`.
+It depends on a QAT kernel driver, see :ref:`building_qat`.
diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index bfa4327b7..ab15e234b 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -4,7 +4,19 @@
 Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
 ==================================================
 
-The QAT PMD provides poll mode crypto driver support for the following
+QAT documentation consists of three parts:
+
+* Details of the symmetric crypto service below.
+* Details of the `compression service <http://dpdk.org/doc/guides/compressdevs/qat_comp.html>`_
+  in the compressdev drivers section.
+* Details of building the common QAT infrastructure and the PMDs to support the
+  above services. See :ref:`building_qat` below.
+
+
+Symmetric Crypto Service on QAT
+-------------------------------
+
+The QAT crypto PMD provides poll mode crypto driver support for the following
 hardware accelerator devices:
 
 * ``Intel QuickAssist Technology DH895xCC``
@@ -14,7 +26,7 @@ hardware accelerator devices:
 
 
 Features
---------
+~~~~~~~~
 
 The QAT PMD has support for:
 
@@ -57,7 +69,7 @@ Supported AEAD algorithms:
 
 
 Limitations
------------
+~~~~~~~~~~~
 
 * Only supports the session-oriented API implementation (session-less APIs are not supported).
 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
@@ -69,7 +81,7 @@ Limitations
 
 
 Extra notes on KASUMI F9
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 When using KASUMI F9 authentication algorithm, the input buffer must be
 constructed according to the
@@ -87,9 +99,11 @@ Also, offset of data to authenticate "op.sym.auth.data.offset"
 must be such that points at the start of the COUNT bytes.
 
 
-Building the DPDK QAT cryptodev PMD
------------------------------------
 
+.. _building_qat:
+
+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>`_.
@@ -140,7 +154,7 @@ devices to applications.
 
 
 Device and driver naming
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 * The qat cryptodev driver name is "crypto_qat".
   The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
@@ -164,7 +178,7 @@ Device and driver naming
 
 
 Available kernel drivers
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Kernel drivers for each device are listed in the following table. Scroll right
 to check that the driver and device supports the service you require.
@@ -204,7 +218,7 @@ If you are running on a kernel which includes a driver for your device, see
 
 
 Installation using kernel.org driver
-------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The examples below are based on the C62x device, if you have a different device
 use the corresponding values in the above table.
@@ -275,7 +289,7 @@ To complete the installation follow the instructions in
 
 
 Installation using 01.org QAT driver
-------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Download the latest QuickAssist Technology Driver from `01.org
 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
@@ -369,12 +383,12 @@ To complete the installation - follow instructions in `Binding the available VFs
 
 
 Binding the available VFs to the DPDK UIO driver
-------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Unbind the VFs from the stock driver so they can be bound to the uio driver.
 
 For an Intel(R) QuickAssist Technology DH895xCC device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
 VFs are different adjust the unbind command below::
@@ -387,7 +401,7 @@ VFs are different adjust the unbind command below::
     done
 
 For an Intel(R) QuickAssist Technology C62x device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
@@ -407,7 +421,7 @@ adjust the unbind command below::
     done
 
 For Intel(R) QuickAssist Technology C3xxx or D15xx device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
 VFs are different adjust the unbind command below::
@@ -420,7 +434,7 @@ VFs are different adjust the unbind command below::
     done
 
 Bind to the DPDK uio driver
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
 to confirm the VF devices are now in use by igb_uio kernel driver,
@@ -461,7 +475,7 @@ QAT compression PMD can be tested by running the test application::
 
 
 Debugging
-----------------------------------------
+~~~~~~~~~
 
 There are 2 sets of trace available via the dynamic logging feature:
 
-- 
2.13.6

[dpdk-dev] [PATCH v2 5/8] doc/qat: remove unnecessary text

[Fiona Trahe]

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index ab15e234b..e6d78ac16 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -169,12 +169,7 @@ Device and driver naming
 
 	The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
 
-* The qat compressdev driver name is "comp_qat".
-  The rte_compressdev_devices_get() returns the devices exposed by this driver.
 
-* Each qat compression device has a unique name, in format
-  <pci bdf>_<service>, e.g. "0000:41:01.0_qat_comp".
-  This name can be passed to rte_compressdev_get_dev_id() to get the device_id.
 
 
 Available kernel drivers
-- 
2.13.6

[dpdk-dev] [PATCH v2 6/8] doc/qat: update kernel dependency section

[Fiona Trahe]

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index e6d78ac16..2f233ec9d 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -120,10 +120,8 @@ Quick instructions are as follows:
 	make
 
 
-.. _qat_kernel_installation:
-
 Dependency on the QAT kernel driver
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 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.
@@ -132,12 +130,8 @@ Instructions for installation are below, but first an explanation of the
 relationships between the PF/VF devices and the PMDs visible to
 DPDK applications.
 
-
-Acceleration services - cryptography and compression - are provided to DPDK
-applications via PMDs which register to implement the corresponding
-cryptodev and compressdev APIs.
-
-Each QuickAssist VF device can expose one cryptodev PMD and/or one compressdev PMD.
+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.
-- 
2.13.6

[dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section

[Fiona Trahe]

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

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

[dpdk-dev] [PATCH v2] doc/qat: describe build config options

[Fiona Trahe]

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 6e4927697..68cfd9e3e 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -142,6 +142,37 @@ Quick instructions for QAT compressdev PMD are as follows:
 	make
 
 
+Build Configuration
+~~~~~~~~~~~~~~~~~~~
+
+These are the build configuration options affecting QAT, and their default values:
+
+.. code-block:: console
+
+	CONFIG_RTE_LIBRTE_PMD_QAT=y
+	CONFIG_RTE_LIBRTE_PMD_QAT_SYM=n
+	CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES=48
+	CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS=16
+
+CONFIG_RTE_LIBRTE_PMD_QAT must be enabled for any QAT PMD to be built.
+
+The QAT cryptodev PMD has an external dependency on libcrypto, so is not
+built by default. CONFIG_RTE_LIBRTE_PMD_QAT_SYM should be enabled to build it.
+
+The QAT compressdev PMD has no external dependencies, so needs no configuration
+options and is built by default.
+
+The number of VFs per PF varies - see table below. If multiple QAT packages are
+installed on a platform then CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES should be
+adjusted to the number of VFs which the QAT common code will need to handle.
+Note, there is a separate config item for max cryptodevs CONFIG_RTE_CRYPTO_MAX_DEVS,
+if necessary this should be adjusted to handle the total of QAT and other devices
+which the process will use.
+
+QAT allocates internal structures to handle SGLs. For the compression service
+CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS can be changed if more segments are needed.
+An extra (max_inflight_ops x 16) bytes per queue_pair will be used for every increment.
+
 
 Device and driver naming
 ~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.13.6

Re: [dpdk-dev] [PATCH v2 0/8] doc/qat: clarify build config options

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: Trahe, Fiona
> Sent: Thursday, August 9, 2018 5:50 PM
> To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>;
> Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>
> Cc: Trahe, Fiona <fiona.trahe@intel.com>
> Subject: [PATCH v2 0/8] doc/qat: clarify build config options
> 
> Clarified documentation structure between compressedev, cryptodev and
> common build parts.
> Clarified build configuration options.
> Added Testing section.
> Fixed typos and made some cosmetic improvements.
> 
> v2 changes
>  - split into patchset
>  - changed test path from build/build/test/test to build/app
>  - use make defconfig instead of make config T=xxx
>  - matched underline lengths to titles
> 
> Fiona Trahe (8):
>   doc/qat: add limitations to compressdev PMD
>   doc/qat: add information on how to test
>   doc/qat: fix typos and make cosmetic changes
>   doc/qat: add overview of doc sections
>   doc/qat: remove unnecessary text
>   doc/qat: update kernel dependency section
>   doc/qat: update PMD build section
>   doc/qat: describe build config options
> 
>  doc/guides/compressdevs/qat_comp.rst |   6 +-
>  doc/guides/cryptodevs/qat.rst        | 197 ++++++++++++++++++++++++-----------
>  2 files changed, 141 insertions(+), 62 deletions(-)
> 
> --
> 2.13.6

Nice splitting :) Just a note on patch 8, which shows as  [Patch v2] doc/qat: describe build config options.

Apart from that:

Series-acked-by: Pablo de Lara <Pablo.de.lara.guarch@intel.com>

Re: [dpdk-dev] [PATCH v2 6/8] doc/qat: update kernel dependency section

[Thomas Monjalon]

09/08/2018 18:50, Fiona Trahe:
> --- a/doc/guides/cryptodevs/qat.rst
> +++ b/doc/guides/cryptodevs/qat.rst
> @@ -120,10 +120,8 @@ Quick instructions are as follows:
>  	make
>  
>  
> -.. _qat_kernel_installation:
> -
>  Dependency on the QAT kernel driver
> ------------------------------------
> +~~~~~~~~~~~~~~~~~~~~~~~~

Strange, why changing the underline to make it shorter?

Re: [dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section

[Thomas Monjalon]

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.

Re: [dpdk-dev] [PATCH v2 0/8] doc/qat: clarify build config options

[Thomas Monjalon]

09/08/2018 18:50, Fiona Trahe:
> Clarified documentation structure between
> compressedev, cryptodev and common build parts.
> Clarified build configuration options.
> Added Testing section.
> Fixed typos and made some cosmetic improvements.
> 
> v2 changes
>  - split into patchset

I am not sure about the split.
Usually, when there is no text in the commit log,
it is a tip that it is not worth to be a separate commit.
Perhaps, it is good to have this split, but in this case,
please try to explain the purpose (or reason) of each patch in the commit logs.

Thanks

Re: [dpdk-dev] [PATCH v2 6/8] doc/qat: update kernel dependency section

[Trahe, Fiona]

Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, August 9, 2018 8:36 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 6/8] doc/qat: update kernel dependency section
> 
> 09/08/2018 18:50, Fiona Trahe:
> > --- a/doc/guides/cryptodevs/qat.rst
> > +++ b/doc/guides/cryptodevs/qat.rst
> > @@ -120,10 +120,8 @@ Quick instructions are as follows:
> >  	make
> >
> >
> > -.. _qat_kernel_installation:
> > -
> >  Dependency on the QAT kernel driver
> > ------------------------------------
> > +~~~~~~~~~~~~~~~~~~~~~~~~
> 
> Strange, why changing the underline to make it shorter?
> 
The intent was to correct the indent level, I didn't intend to make it shorter.
But I don't know why checkpatch didn't catch this as it did warn of too short underlines in other places.
I'll fix in a v3

Re: [dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section

[Trahe, Fiona]

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.

Re: [dpdk-dev] [PATCH v2 0/8] doc/qat: clarify build config options

[Trahe, Fiona]

Hi Thomas

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, August 9, 2018 8:49 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 0/8] doc/qat: clarify build config options
> 
> 09/08/2018 18:50, Fiona Trahe:
> > Clarified documentation structure between
> > compressedev, cryptodev and common build parts.
> > Clarified build configuration options.
> > Added Testing section.
> > Fixed typos and made some cosmetic improvements.
> >
> > v2 changes
> >  - split into patchset
> 
> I am not sure about the split.
> Usually, when there is no text in the commit log,
> it is a tip that it is not worth to be a separate commit.
> Perhaps, it is good to have this split, but in this case,
> please try to explain the purpose (or reason) of each patch in the commit logs.
> 
> Thanks
> 
With over 200 changed lines in the v1 patch I did this to make it easier for Pablo to review.
I'll add more explanation in the v3.

Re: [dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section

[Thomas Monjalon]

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.

Re: [dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section

[Trahe, Fiona]

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.

[dpdk-dev] [PATCH v3 0/6] doc/qat: clarify build config options

[Fiona Trahe]

Clarified documentation structure between
compressedev, cryptodev and common build parts.
Clarified build configuration options.
Added Testing section.
Fixed typos and made some cosmetic improvements.


v3 changes
 - squashed some patches
 - added more text to remaining commit msgs
 - fixed underline line length
 - fixed typo: comp_qat should be qat 

v2 changes
 - split into patchset
 - changed test path from build/build/test/test to build/app
 - use make defconfig instead of make config T=xxx
 - matched underline lengths to titles

Fiona Trahe (6):
  doc/qat: add limitations to compressdev PMD
  doc/qat: add information on how to test
  doc/qat: fix typos and make cosmetic changes
  doc/qat: add overview of doc sections
  doc/qat: update build instructions for both PMDs
  doc/qat: describe build config options

 doc/guides/compressdevs/qat_comp.rst |   6 +-
 doc/guides/cryptodevs/qat.rst        | 195 +++++++++++++++++++++++++----------
 2 files changed, 143 insertions(+), 58 deletions(-)

-- 
2.13.6

[dpdk-dev] [PATCH v3 1/6] doc/qat: add limitations to compressdev PMD

[Fiona Trahe]

Add 2 missing limitations to QAT compressdev documentation

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

diff --git a/doc/guides/compressdevs/qat_comp.rst b/doc/guides/compressdevs/qat_comp.rst
index 8b1270b70..b45f4a626 100644
--- a/doc/guides/compressdevs/qat_comp.rst
+++ b/doc/guides/compressdevs/qat_comp.rst
@@ -36,8 +36,10 @@ Limitations
 -----------
 
 * Compressdev level 0, no compression, is not supported.
-
 * Dynamic Huffman encoding is not yet supported.
+* Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
+* No BSD support as BSD QAT kernel driver not available.
+
 
 Installation
 ------------
-- 
2.13.6

[dpdk-dev] [PATCH v3 2/6] doc/qat: add information on how to test

[Fiona Trahe]

Add section to common QAT part of doc about
which tests can be used to exercise
QAT compress and crypto PMDS

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index bdc58eb2c..7df49ca44 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -438,6 +438,26 @@ Another way to bind the VFs to the DPDK UIO driver is by using the
     cd to the top-level DPDK directory
     ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
 
+Testing
+~~~~~~~
+
+QAT crypto PMD can be tested by running the test application::
+
+    make defconfig
+    make test-build -j
+    cd ./build/app
+    ./test -l1 -n1 -w <your qat bdf>
+    RTE>>cryptodev_qat_autotest
+
+QAT compression PMD can be tested by running the test application::
+
+    make defconfig
+    sed -i 's,\(CONFIG_RTE_COMPRESSDEV_TEST\)=n,\1=y,' build/.config
+    make test-build -j
+    cd ./build/app
+    ./test -l1 -n1 -w <your qat bdf>
+    RTE>>compressdev_autotest
+
 
 Debugging
 ----------------------------------------
-- 
2.13.6

[dpdk-dev] [PATCH v3 3/6] doc/qat: fix typos and make cosmetic changes

[Fiona Trahe]

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 7df49ca44..17b313c9d 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -72,17 +72,18 @@ Extra notes on KASUMI F9
 ------------------------
 
 When using KASUMI F9 authentication algorithm, the input buffer must be
-constructed according to the 3GPP KASUMI specifications (section 4.4, page 13):
-`<http://cryptome.org/3gpp/35201-900.pdf>`_.
-Input buffer has to have COUNT (4 bytes), FRESH (4 bytes), MESSAGE and DIRECTION (1 bit)
-concatenated. After the DIRECTION bit, a single '1' bit is appended, followed by
-between 0 and 7 '0' bits, so that the total length of the buffer is multiple of 8 bits.
-Note that the actual message can be any length, specified in bits.
+constructed according to the
+`3GPP KASUMI specification <http://cryptome.org/3gpp/35201-900.pdf>`_
+(section 4.4, page 13). The input buffer has to have COUNT (4 bytes),
+FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
+bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
+the total length of the buffer is multiple of 8 bits. Note that the actual
+message can be any length, specified in bits.
 
 Once this buffer is passed this way, when creating the crypto operation,
-length of data to authenticate (op.sym.auth.data.length) must be the length
+length of data to authenticate "op.sym.auth.data.length" must be the length
 of all the items described above, including the padding at the end.
-Also, offset of data to authenticate (op.sym.auth.data.offset)
+Also, offset of data to authenticate "op.sym.auth.data.offset"
 must be such that points at the start of the COUNT bytes.
 
 
@@ -142,19 +143,19 @@ Device and driver naming
 ------------------------
 
 * The qat cryptodev driver name is "crypto_qat".
-  The rte_cryptodev_devices_get() returns the devices exposed by this driver.
+  The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
 
 * Each qat crypto device has a unique name, in format
-  <pci bdf>_<service>, e.g. "0000:41:01.0_qat_sym".
-  This name can be passed to rte_cryptodev_get_dev_id() to get the device_id.
+  "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_sym".
+  This name can be passed to "rte_cryptodev_get_dev_id()" to get the device_id.
 
 .. Note::
 
-	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the -devtype parameter.
+	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
 
 	The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
 
-* The qat compressdev driver name is "comp_qat".
+* The qat compressdev driver name is "qat".
   The rte_compressdev_devices_get() returns the devices exposed by this driver.
 
 * Each qat compression device has a unique name, in format
@@ -166,7 +167,7 @@ Available kernel drivers
 ------------------------
 
 Kernel drivers for each device are listed in the following table. Scroll right
-to check that the driver and device supports the servic you require.
+to check that the driver and device supports the service you require.
 
 
 .. _table_qat_pmds_drivers:
-- 
2.13.6

[dpdk-dev] [PATCH v3 4/6] doc/qat: add overview of doc sections

[Fiona Trahe]

Add overview of QAT doc sections and link between them.
Indent to next level all sections within
the crypto and common sections.

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/compressdevs/qat_comp.rst |  2 +-
 doc/guides/cryptodevs/qat.rst        | 46 +++++++++++++++++++++++-------------
 2 files changed, 31 insertions(+), 17 deletions(-)

diff --git a/doc/guides/compressdevs/qat_comp.rst b/doc/guides/compressdevs/qat_comp.rst
index b45f4a626..7bffbe6ff 100644
--- a/doc/guides/compressdevs/qat_comp.rst
+++ b/doc/guides/compressdevs/qat_comp.rst
@@ -46,4 +46,4 @@ Installation
 
 The QAT compression PMD is built by default with a standard DPDK build.
 
-It depends on a QAT kernel driver, see :ref:`qat_kernel_installation`.
+It depends on a QAT kernel driver, see :ref:`building_qat`.
diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 17b313c9d..28bafa1f8 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -4,7 +4,19 @@
 Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
 ==================================================
 
-The QAT PMD provides poll mode crypto driver support for the following
+QAT documentation consists of three parts:
+
+* Details of the symmetric crypto service below.
+* Details of the `compression service <http://dpdk.org/doc/guides/compressdevs/qat_comp.html>`_
+  in the compressdev drivers section.
+* Details of building the common QAT infrastructure and the PMDs to support the
+  above services. See :ref:`building_qat` below.
+
+
+Symmetric Crypto Service on QAT
+-------------------------------
+
+The QAT crypto PMD provides poll mode crypto driver support for the following
 hardware accelerator devices:
 
 * ``Intel QuickAssist Technology DH895xCC``
@@ -14,7 +26,7 @@ hardware accelerator devices:
 
 
 Features
---------
+~~~~~~~~
 
 The QAT PMD has support for:
 
@@ -57,7 +69,7 @@ Supported AEAD algorithms:
 
 
 Limitations
------------
+~~~~~~~~~~~
 
 * Only supports the session-oriented API implementation (session-less APIs are not supported).
 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
@@ -69,7 +81,7 @@ Limitations
 
 
 Extra notes on KASUMI F9
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 When using KASUMI F9 authentication algorithm, the input buffer must be
 constructed according to the
@@ -87,9 +99,11 @@ Also, offset of data to authenticate "op.sym.auth.data.offset"
 must be such that points at the start of the COUNT bytes.
 
 
-Building the DPDK QAT cryptodev PMD
------------------------------------
 
+.. _building_qat:
+
+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>`_.
@@ -140,7 +154,7 @@ devices to applications.
 
 
 Device and driver naming
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 * The qat cryptodev driver name is "crypto_qat".
   The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
@@ -164,7 +178,7 @@ Device and driver naming
 
 
 Available kernel drivers
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Kernel drivers for each device are listed in the following table. Scroll right
 to check that the driver and device supports the service you require.
@@ -204,7 +218,7 @@ If you are running on a kernel which includes a driver for your device, see
 
 
 Installation using kernel.org driver
-------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The examples below are based on the C62x device, if you have a different device
 use the corresponding values in the above table.
@@ -275,7 +289,7 @@ To complete the installation follow the instructions in
 
 
 Installation using 01.org QAT driver
-------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Download the latest QuickAssist Technology Driver from `01.org
 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
@@ -369,12 +383,12 @@ To complete the installation - follow instructions in `Binding the available VFs
 
 
 Binding the available VFs to the DPDK UIO driver
-------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Unbind the VFs from the stock driver so they can be bound to the uio driver.
 
 For an Intel(R) QuickAssist Technology DH895xCC device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
 VFs are different adjust the unbind command below::
@@ -387,7 +401,7 @@ VFs are different adjust the unbind command below::
     done
 
 For an Intel(R) QuickAssist Technology C62x device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
@@ -407,7 +421,7 @@ adjust the unbind command below::
     done
 
 For Intel(R) QuickAssist Technology C3xxx or D15xx device
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
 VFs are different adjust the unbind command below::
@@ -420,7 +434,7 @@ VFs are different adjust the unbind command below::
     done
 
 Bind to the DPDK uio driver
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
 to confirm the VF devices are now in use by igb_uio kernel driver,
@@ -461,7 +475,7 @@ QAT compression PMD can be tested by running the test application::
 
 
 Debugging
-----------------------------------------
+~~~~~~~~~
 
 There are 2 sets of trace available via the dynamic logging feature:
 
-- 
2.13.6

[dpdk-dev] [PATCH v3 5/6] doc/qat: update build instructions for both PMDs

[Fiona Trahe]

Update PMD build section.
Linked to kernel dependency section and refactored text
between those 2 sections.

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 28bafa1f8..a352dabcd 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -105,51 +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:
-
-.. 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
+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.
 
 
-.. _qat_kernel_installation:
+Configuring and Building the DPDK QAT PMDs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Dependency on the QAT kernel driver
------------------------------------
 
-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.
+Further information on configuring, building and installing DPDK is described
+`here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
 
-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:
 
-Acceleration services - cryptography and compression - are provided to DPDK
-applications via PMDs which register to implement the corresponding
-cryptodev and compressdev APIs.
+.. code-block:: console
 
-Each QuickAssist VF device can expose 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.
+	cd to the top-level DPDK directory
+	make defconfig
+	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\)=n,\1=y,' build/.config
+	make
 
-.. Note::
+Quick instructions for QAT compressdev PMD are as follows:
 
-   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.
+.. code-block:: console
 
-   Conversely one DPDK process can use one or more QAT VFs and can expose both
-   cryptodev and compressdev instances on each of those VFs.
+	cd to the top-level DPDK directory
+	make defconfig
+	make
 
 
 
@@ -176,6 +166,33 @@ Device and driver naming
   <pci bdf>_<service>, e.g. "0000:41:01.0_qat_comp".
   This name can be passed to rte_compressdev_get_dev_id() to get the device_id.
 
+.. _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
 ~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.13.6

[dpdk-dev] [PATCH v3 6/6] doc/qat: describe build config options

[Fiona Trahe]

Added description of the build configuration options for QAT.

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index a352dabcd..67b84b3e2 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -142,6 +142,37 @@ Quick instructions for QAT compressdev PMD are as follows:
 	make
 
 
+Build Configuration
+~~~~~~~~~~~~~~~~~~~
+
+These are the build configuration options affecting QAT, and their default values:
+
+.. code-block:: console
+
+	CONFIG_RTE_LIBRTE_PMD_QAT=y
+	CONFIG_RTE_LIBRTE_PMD_QAT_SYM=n
+	CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES=48
+	CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS=16
+
+CONFIG_RTE_LIBRTE_PMD_QAT must be enabled for any QAT PMD to be built.
+
+The QAT cryptodev PMD has an external dependency on libcrypto, so is not
+built by default. CONFIG_RTE_LIBRTE_PMD_QAT_SYM should be enabled to build it.
+
+The QAT compressdev PMD has no external dependencies, so needs no configuration
+options and is built by default.
+
+The number of VFs per PF varies - see table below. If multiple QAT packages are
+installed on a platform then CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES should be
+adjusted to the number of VFs which the QAT common code will need to handle.
+Note, there is a separate config item for max cryptodevs CONFIG_RTE_CRYPTO_MAX_DEVS,
+if necessary this should be adjusted to handle the total of QAT and other devices
+which the process will use.
+
+QAT allocates internal structures to handle SGLs. For the compression service
+CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS can be changed if more segments are needed.
+An extra (max_inflight_ops x 16) bytes per queue_pair will be used for every increment.
+
 
 Device and driver naming
 ~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.13.6

Re: [dpdk-dev] [PATCH v3 1/6] doc/qat: add limitations to compressdev PMD

[Jozwiak, TomaszX]

-----Original Message-----
From: Trahe, Fiona 
Sent: Friday, August 10, 2018 4:11 PM
To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; thomas@monjalon.net
Cc: Trahe, Fiona <fiona.trahe@intel.com>
Subject: [PATCH v3 1/6] doc/qat: add limitations to compressdev PMD

Add 2 missing limitations to QAT compressdev documentation

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

Re: [dpdk-dev] [PATCH v3 2/6] doc/qat: add information on how to test

[Jozwiak, TomaszX]

-----Original Message-----
From: Trahe, Fiona 
Sent: Friday, August 10, 2018 4:11 PM
To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; thomas@monjalon.net
Cc: Trahe, Fiona <fiona.trahe@intel.com>
Subject: [PATCH v3 2/6] doc/qat: add information on how to test

Add section to common QAT part of doc about which tests can be used to exercise QAT compress and crypto PMDS

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

Re: [dpdk-dev] [PATCH v3 3/6] doc/qat: fix typos and make cosmetic changes

[Jozwiak, TomaszX]

-----Original Message-----
From: Trahe, Fiona 
Sent: Friday, August 10, 2018 4:11 PM
To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; thomas@monjalon.net
Cc: Trahe, Fiona <fiona.trahe@intel.com>
Subject: [PATCH v3 3/6] doc/qat: fix typos and make cosmetic changes

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

Re: [dpdk-dev] [PATCH v3 4/6] doc/qat: add overview of doc sections

[Jozwiak, TomaszX]

-----Original Message-----
From: Trahe, Fiona 
Sent: Friday, August 10, 2018 4:11 PM
To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; thomas@monjalon.net
Cc: Trahe, Fiona <fiona.trahe@intel.com>
Subject: [PATCH v3 4/6] doc/qat: add overview of doc sections

Add overview of QAT doc sections and link between them.
Indent to next level all sections within the crypto and common sections.

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

Re: [dpdk-dev] [PATCH v3 5/6] doc/qat: update build instructions for both PMDs

[Jozwiak, TomaszX]

-----Original Message-----
From: Trahe, Fiona 
Sent: Friday, August 10, 2018 4:11 PM
To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; thomas@monjalon.net
Cc: Trahe, Fiona <fiona.trahe@intel.com>
Subject: [PATCH v3 5/6] doc/qat: update build instructions for both PMDs

Update PMD build section.
Linked to kernel dependency section and refactored text between those 2 sections.

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

Re: [dpdk-dev] [PATCH v3 6/6] doc/qat: describe build config options

[Jozwiak, TomaszX]

-----Original Message-----
From: Trahe, Fiona 
Sent: Friday, August 10, 2018 4:11 PM
To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; thomas@monjalon.net
Cc: Trahe, Fiona <fiona.trahe@intel.com>
Subject: [PATCH v3 6/6] doc/qat: describe build config options

Added description of the build configuration options for QAT.

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

Re: [dpdk-dev] [PATCH v3 0/6] doc/qat: clarify build config options

[Jozwiak, TomaszX]

-----Original Message-----
From: Trahe, Fiona 
Sent: Friday, August 10, 2018 4:11 PM
To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; thomas@monjalon.net
Cc: Trahe, Fiona <fiona.trahe@intel.com>
Subject: [PATCH v3 0/6] doc/qat: clarify build config options

Clarified documentation structure between compressedev, cryptodev and common build parts.
Clarified build configuration options.
Added Testing section.
Fixed typos and made some cosmetic improvements.


v3 changes
 - squashed some patches
 - added more text to remaining commit msgs
 - fixed underline line length
 - fixed typo: comp_qat should be qat 

v2 changes
 - split into patchset
 - changed test path from build/build/test/test to build/app
 - use make defconfig instead of make config T=xxx
 - matched underline lengths to titles

Fiona Trahe (6):
  doc/qat: add limitations to compressdev PMD
  doc/qat: add information on how to test
  doc/qat: fix typos and make cosmetic changes
  doc/qat: add overview of doc sections
  doc/qat: update build instructions for both PMDs
  doc/qat: describe build config options

 doc/guides/compressdevs/qat_comp.rst |   6 +-
 doc/guides/cryptodevs/qat.rst        | 195 +++++++++++++++++++++++++----------
 2 files changed, 143 insertions(+), 58 deletions(-)

--
2.13.6


Series-acked-by: tomaszx.jozwiak@intel.com

Re: [dpdk-dev] [PATCH v3 0/6] doc/qat: clarify build config options

[Akhil Goyal]

On 8/10/2018 7:40 PM, Fiona Trahe wrote:

> Clarified documentation structure between
> compressedev, cryptodev and common build parts.
> Clarified build configuration options.
> Added Testing section.
> Fixed typos and made some cosmetic improvements.
>
>
> v3 changes
>   - squashed some patches
>   - added more text to remaining commit msgs
>   - fixed underline line length
>   - fixed typo: comp_qat should be qat
>
> v2 changes
>   - split into patchset
>   - changed test path from build/build/test/test to build/app
>   - use make defconfig instead of make config T=xxx
>   - matched underline lengths to titles
>
> Fiona Trahe (6):
>    doc/qat: add limitations to compressdev PMD
>    doc/qat: add information on how to test
>    doc/qat: fix typos and make cosmetic changes
>    doc/qat: add overview of doc sections
>    doc/qat: update build instructions for both PMDs
>    doc/qat: describe build config options
>
>   doc/guides/compressdevs/qat_comp.rst |   6 +-
>   doc/guides/cryptodevs/qat.rst        | 195 +++++++++++++++++++++++++----------
>   2 files changed, 143 insertions(+), 58 deletions(-)
>
>
Patchset applied to dpdk-next-crypto.

Subject for "doc/qat: fix typos and make cosmetic changes" changed to "doc/qat: correct typo and make cosmetic changes"

to avoid git log error.

Thanks,

Akhil

Re: [dpdk-dev] [PATCH v3 0/6] doc/qat: clarify build config options

[Thomas Monjalon]

23/08/2018 13:12, Akhil Goyal:
> Patchset applied to dpdk-next-crypto.
> 
> Subject for "doc/qat: fix typos and make cosmetic changes" changed to "doc/qat: correct typo and make cosmetic changes"
> 
> to avoid git log error.

Which error? Lack of Fixes tag?
As a committer, you must be sure the Fixes tags and Cc: stable@dpdk.org
are all set. It is mandatory to know what should be backported and where.
Even typos should be backported.

Re: [dpdk-dev] [PATCH v3 0/6] doc/qat: clarify build config options

[Akhil Goyal]

Hi Thomas,

On 8/23/2018 4:54 PM, Thomas Monjalon wrote:

> 23/08/2018 13:12, Akhil Goyal:
>> Patchset applied to dpdk-next-crypto.
>>
>> Subject for "doc/qat: fix typos and make cosmetic changes" changed to "doc/qat: correct typo and make cosmetic changes"
>>
>> to avoid git log error.
> Which error? Lack of Fixes tag?
> As a committer, you must be sure the Fixes tags and Cc: stable@dpdk.org
> are all set. It is mandatory to know what should be backported and where.
> Even typos should be backported.
>
>
Fiona clarified that this patch is not required for back porting.

Regards,

Akhil

Re: [dpdk-dev] [PATCH v3 0/6] doc/qat: clarify build config options

[Thomas Monjalon]

23/08/2018 13:28, Akhil Goyal:
> Hi Thomas,
> 
> On 8/23/2018 4:54 PM, Thomas Monjalon wrote:
> 
> > 23/08/2018 13:12, Akhil Goyal:
> >> Patchset applied to dpdk-next-crypto.
> >>
> >> Subject for "doc/qat: fix typos and make cosmetic changes" changed to "doc/qat: correct typo and make cosmetic changes"
> >>
> >> to avoid git log error.
> > Which error? Lack of Fixes tag?
> > As a committer, you must be sure the Fixes tags and Cc: stable@dpdk.org
> > are all set. It is mandatory to know what should be backported and where.
> > Even typos should be backported.
> >
> >
> Fiona clarified that this patch is not required for back porting.

It will make future backporting of doc fixes harder.
That's a good example to discuss.
OK to keep it as is, and will discuss it with maintainers of stable branches
during the Dublin event, in order to make the policies clear.