Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/43675/?format=api
{ "id": 43675, "url": "http://patches.dpdk.org/api/patches/43675/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1533910253-29652-6-git-send-email-fiona.trahe@intel.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1533910253-29652-6-git-send-email-fiona.trahe@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1533910253-29652-6-git-send-email-fiona.trahe@intel.com", "date": "2018-08-10T14:10:52", "name": "[v3,5/6] doc/qat: update build instructions for both PMDs", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "cc059bf40c0c8070747b1e8c70ee74e2252626cf", "submitter": { "id": 423, "url": "http://patches.dpdk.org/api/people/423/?format=api", "name": "Fiona Trahe", "email": "fiona.trahe@intel.com" }, "delegate": { "id": 6690, "url": "http://patches.dpdk.org/api/users/6690/?format=api", "username": "akhil", "first_name": "akhil", "last_name": "goyal", "email": "gakhil@marvell.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1533910253-29652-6-git-send-email-fiona.trahe@intel.com/mbox/", "series": [ { "id": 959, "url": "http://patches.dpdk.org/api/series/959/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=959", "date": "2018-08-10T14:10:47", "name": "doc/qat: clarify build config options", "version": 3, "mbox": "http://patches.dpdk.org/series/959/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/43675/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/43675/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 48EBA4B4B;\n\tFri, 10 Aug 2018 16:11:18 +0200 (CEST)", "from mga11.intel.com (mga11.intel.com [192.55.52.93])\n\tby dpdk.org (Postfix) with ESMTP id 6C02E3250\n\tfor <dev@dpdk.org>; Fri, 10 Aug 2018 16:11:14 +0200 (CEST)", "from orsmga002.jf.intel.com ([10.7.209.21])\n\tby fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t10 Aug 2018 07:11:14 -0700", "from sivswdev01.ir.intel.com (HELO localhost.localdomain)\n\t([10.237.217.45])\n\tby orsmga002.jf.intel.com with ESMTP; 10 Aug 2018 07:11:12 -0700" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.53,219,1531810800\"; d=\"scan'208\";a=\"82324192\"", "From": "Fiona Trahe <fiona.trahe@intel.com>", "To": "dev@dpdk.org, pablo.de.lara.guarch@intel.com, tomaszx.jozwiak@intel.com, \n\tthomas@monjalon.net", "Cc": "fiona.trahe@intel.com", "Date": "Fri, 10 Aug 2018 15:10:52 +0100", "Message-Id": "<1533910253-29652-6-git-send-email-fiona.trahe@intel.com>", "X-Mailer": "git-send-email 1.7.0.7", "In-Reply-To": "<1533833430-29134-8-git-send-email-fiona.trahe@intel.com>", "References": "<1533833430-29134-8-git-send-email-fiona.trahe@intel.com>", "Subject": "[dpdk-dev] [PATCH v3 5/6] doc/qat: update build instructions for\n\tboth PMDs", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Update PMD build section.\nLinked to kernel dependency section and refactored text\nbetween those 2 sections.\n\nSigned-off-by: Fiona Trahe <fiona.trahe@intel.com>\n---\n doc/guides/cryptodevs/qat.rst | 81 ++++++++++++++++++++++++++-----------------\n 1 file changed, 49 insertions(+), 32 deletions(-)", "diff": "diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst\nindex 28bafa1f8..a352dabcd 100644\n--- a/doc/guides/cryptodevs/qat.rst\n+++ b/doc/guides/cryptodevs/qat.rst\n@@ -105,51 +105,41 @@ must be such that points at the start of the COUNT bytes.\n Building PMDs on QAT\n --------------------\n \n-To enable QAT crypto in DPDK, follow the instructions for modifying the compile-time\n-configuration file as described `here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.\n+A QAT device can host multiple acceleration services:\n \n+* symmetric cryptography\n+* data compression\n \n-Quick instructions are as follows:\n-\n-.. code-block:: console\n-\n-\tcd to the top-level DPDK directory\n-\tmake config T=x86_64-native-linuxapp-gcc\n-\tsed -i 's,\\(CONFIG_RTE_LIBRTE_PMD_QAT\\)=n,\\1=y,' build/.config\n-\tsed -i 's,\\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\\)=n,\\1=y,' build/.config\n-\tmake\n+These services are provided to DPDK applications via PMDs which register to\n+implement the corresponding cryptodev and compressdev APIs. The PMDs use\n+common QAT driver code which manages the QAT PCI device. They also depend on a\n+QAT kernel driver being installed on the platform, see :ref:`qat_kernel` below.\n \n \n-.. _qat_kernel_installation:\n+Configuring and Building the DPDK QAT PMDs\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n-Dependency on the QAT kernel driver\n------------------------------------\n \n-To use the QAT PMD an SRIOV-enabled QAT kernel driver is required. The VF\n-devices created and initialised by this driver will be used by the QAT PMD.\n+Further information on configuring, building and installing DPDK is described\n+`here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.\n \n-Instructions for installation are below, but first an explanation of the\n-relationships between the PF/VF devices and the PMDs visible to\n-DPDK applications.\n \n+Quick instructions for QAT cryptodev PMD are as follows:\n \n-Acceleration services - cryptography and compression - are provided to DPDK\n-applications via PMDs which register to implement the corresponding\n-cryptodev and compressdev APIs.\n+.. code-block:: console\n \n-Each QuickAssist VF device can expose one cryptodev PMD and/or one compressdev PMD.\n-These QAT PMDs share the same underlying device and pci-mgmt code, but are\n-enumerated independently on their respective APIs and appear as independent\n-devices to applications.\n+\tcd to the top-level DPDK directory\n+\tmake defconfig\n+\tsed -i 's,\\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\\)=n,\\1=y,' build/.config\n+\tmake\n \n-.. Note::\n+Quick instructions for QAT compressdev PMD are as follows:\n \n- Each VF can only be used by one DPDK process. It is not possible to share\n- the same VF across multiple processes, even if these processes are using\n- different acceleration services.\n+.. code-block:: console\n \n- Conversely one DPDK process can use one or more QAT VFs and can expose both\n- cryptodev and compressdev instances on each of those VFs.\n+\tcd to the top-level DPDK directory\n+\tmake defconfig\n+\tmake\n \n \n \n@@ -176,6 +166,33 @@ Device and driver naming\n <pci bdf>_<service>, e.g. \"0000:41:01.0_qat_comp\".\n This name can be passed to rte_compressdev_get_dev_id() to get the device_id.\n \n+.. _qat_kernel:\n+\n+Dependency on the QAT kernel driver\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+To use QAT an SRIOV-enabled QAT kernel driver is required. The VF\n+devices created and initialised by this driver will be used by the QAT PMDs.\n+\n+Instructions for installation are below, but first an explanation of the\n+relationships between the PF/VF devices and the PMDs visible to\n+DPDK applications.\n+\n+Each QuickAssist PF device exposes a number of VF devices. Each VF device can\n+enable one cryptodev PMD and/or one compressdev PMD.\n+These QAT PMDs share the same underlying device and pci-mgmt code, but are\n+enumerated independently on their respective APIs and appear as independent\n+devices to applications.\n+\n+.. Note::\n+\n+ Each VF can only be used by one DPDK process. It is not possible to share\n+ the same VF across multiple processes, even if these processes are using\n+ different acceleration services.\n+\n+ Conversely one DPDK process can use one or more QAT VFs and can expose both\n+ cryptodev and compressdev instances on each of those VFs.\n+\n \n Available kernel drivers\n ~~~~~~~~~~~~~~~~~~~~~~~~\n", "prefixes": [ "v3", "5/6" ] }