DPDK patches and discussions
 help / color / mirror / Atom feed
From: Fiona Trahe <fiona.trahe@intel.com>
To: dev@dpdk.org, pablo.de.lara.guarch@intel.com, tomaszx.jozwiak@intel.com
Cc: fiona.trahe@intel.com
Subject: [dpdk-dev] [PATCH v2] doc/qat: describe build config options
Date: Thu,  9 Aug 2018 17:50:30 +0100	[thread overview]
Message-ID: <1533833430-29134-9-git-send-email-fiona.trahe@intel.com> (raw)
In-Reply-To: <1533820674-9507-1-git-send-email-fiona.trahe@intel.com>

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

      parent reply	other threads:[~2018-08-09 16:50 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-09 13:17 [dpdk-dev] [PATCH] doc/qat: clarify " Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 0/8] " Fiona Trahe
2018-08-09 17:08   ` De Lara Guarch, Pablo
2018-08-09 19:49   ` Thomas Monjalon
2018-08-10  7:57     ` Trahe, Fiona
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 1/8] doc/qat: add limitations to compressdev PMD Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 2/8] doc/qat: add information on how to test Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 3/8] doc/qat: fix typos and make cosmetic changes Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 4/8] doc/qat: add overview of doc sections Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 5/8] doc/qat: remove unnecessary text Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 6/8] doc/qat: update kernel dependency section Fiona Trahe
2018-08-09 19:36   ` Thomas Monjalon
2018-08-10  7:45     ` Trahe, Fiona
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section Fiona Trahe
2018-08-09 19:47   ` Thomas Monjalon
2018-08-10  7:51     ` Trahe, Fiona
2018-08-10  9:00       ` Thomas Monjalon
2018-08-10 13:14         ` Trahe, Fiona
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 0/6] doc/qat: clarify build config options Fiona Trahe
2018-08-13 14:51     ` Jozwiak, TomaszX
2018-08-23 11:12     ` Akhil Goyal
2018-08-23 11:24       ` Thomas Monjalon
2018-08-23 11:28         ` Akhil Goyal
2018-08-23 11:35           ` Thomas Monjalon
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 1/6] doc/qat: add limitations to compressdev PMD Fiona Trahe
2018-08-13 14:31     ` Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 2/6] doc/qat: add information on how to test Fiona Trahe
2018-08-13 14:32     ` Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 3/6] doc/qat: fix typos and make cosmetic changes Fiona Trahe
2018-08-13 14:33     ` Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 4/6] doc/qat: add overview of doc sections Fiona Trahe
2018-08-13 14:37     ` Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 5/6] doc/qat: update build instructions for both PMDs Fiona Trahe
2018-08-13 14:37     ` Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 6/6] doc/qat: describe build config options Fiona Trahe
2018-08-13 14:38     ` Jozwiak, TomaszX
2018-08-09 16:50 ` Fiona Trahe [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1533833430-29134-9-git-send-email-fiona.trahe@intel.com \
    --to=fiona.trahe@intel.com \
    --cc=dev@dpdk.org \
    --cc=pablo.de.lara.guarch@intel.com \
    --cc=tomaszx.jozwiak@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).