Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/43674/?format=api
{ "id": 43674, "url": "http://patches.dpdk.org/api/patches/43674/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1533910253-29652-5-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-5-git-send-email-fiona.trahe@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1533910253-29652-5-git-send-email-fiona.trahe@intel.com", "date": "2018-08-10T14:10:51", "name": "[v3,4/6] doc/qat: add overview of doc sections", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "bc43f86646f10c15bda4fe4ee0c038f104d83201", "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-5-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/43674/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/43674/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 3CC6537B4;\n\tFri, 10 Aug 2018 16:11:16 +0200 (CEST)", "from mga11.intel.com (mga11.intel.com [192.55.52.93])\n\tby dpdk.org (Postfix) with ESMTP id C342A3238\n\tfor <dev@dpdk.org>; Fri, 10 Aug 2018 16:11:12 +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:12 -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:10 -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=\"82324188\"", "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:51 +0100", "Message-Id": "<1533910253-29652-5-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 4/6] doc/qat: add overview of doc sections", "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": "Add overview of QAT doc sections and link between them.\nIndent to next level all sections within\nthe crypto and common sections.\n\nSigned-off-by: Fiona Trahe <fiona.trahe@intel.com>\n---\n doc/guides/compressdevs/qat_comp.rst | 2 +-\n doc/guides/cryptodevs/qat.rst | 46 +++++++++++++++++++++++-------------\n 2 files changed, 31 insertions(+), 17 deletions(-)", "diff": "diff --git a/doc/guides/compressdevs/qat_comp.rst b/doc/guides/compressdevs/qat_comp.rst\nindex b45f4a626..7bffbe6ff 100644\n--- a/doc/guides/compressdevs/qat_comp.rst\n+++ b/doc/guides/compressdevs/qat_comp.rst\n@@ -46,4 +46,4 @@ Installation\n \n The QAT compression PMD is built by default with a standard DPDK build.\n \n-It depends on a QAT kernel driver, see :ref:`qat_kernel_installation`.\n+It depends on a QAT kernel driver, see :ref:`building_qat`.\ndiff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst\nindex 17b313c9d..28bafa1f8 100644\n--- a/doc/guides/cryptodevs/qat.rst\n+++ b/doc/guides/cryptodevs/qat.rst\n@@ -4,7 +4,19 @@\n Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver\n ==================================================\n \n-The QAT PMD provides poll mode crypto driver support for the following\n+QAT documentation consists of three parts:\n+\n+* Details of the symmetric crypto service below.\n+* Details of the `compression service <http://dpdk.org/doc/guides/compressdevs/qat_comp.html>`_\n+ in the compressdev drivers section.\n+* Details of building the common QAT infrastructure and the PMDs to support the\n+ above services. See :ref:`building_qat` below.\n+\n+\n+Symmetric Crypto Service on QAT\n+-------------------------------\n+\n+The QAT crypto PMD provides poll mode crypto driver support for the following\n hardware accelerator devices:\n \n * ``Intel QuickAssist Technology DH895xCC``\n@@ -14,7 +26,7 @@ hardware accelerator devices:\n \n \n Features\n---------\n+~~~~~~~~\n \n The QAT PMD has support for:\n \n@@ -57,7 +69,7 @@ Supported AEAD algorithms:\n \n \n Limitations\n------------\n+~~~~~~~~~~~\n \n * Only supports the session-oriented API implementation (session-less APIs are not supported).\n * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.\n@@ -69,7 +81,7 @@ Limitations\n \n \n Extra notes on KASUMI F9\n-------------------------\n+~~~~~~~~~~~~~~~~~~~~~~~~\n \n When using KASUMI F9 authentication algorithm, the input buffer must be\n constructed according to the\n@@ -87,9 +99,11 @@ Also, offset of data to authenticate \"op.sym.auth.data.offset\"\n must be such that points at the start of the COUNT bytes.\n \n \n-Building the DPDK QAT cryptodev PMD\n------------------------------------\n \n+.. _building_qat:\n+\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@@ -140,7 +154,7 @@ devices to applications.\n \n \n Device and driver naming\n-------------------------\n+~~~~~~~~~~~~~~~~~~~~~~~~\n \n * The qat cryptodev driver name is \"crypto_qat\".\n The \"rte_cryptodev_devices_get()\" returns the devices exposed by this driver.\n@@ -164,7 +178,7 @@ Device and driver naming\n \n \n Available kernel drivers\n-------------------------\n+~~~~~~~~~~~~~~~~~~~~~~~~\n \n Kernel drivers for each device are listed in the following table. Scroll right\n to check that the driver and device supports the service you require.\n@@ -204,7 +218,7 @@ If you are running on a kernel which includes a driver for your device, see\n \n \n Installation using kernel.org driver\n-------------------------------------\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n The examples below are based on the C62x device, if you have a different device\n use the corresponding values in the above table.\n@@ -275,7 +289,7 @@ To complete the installation follow the instructions in\n \n \n Installation using 01.org QAT driver\n-------------------------------------\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n Download the latest QuickAssist Technology Driver from `01.org\n <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.\n@@ -369,12 +383,12 @@ To complete the installation - follow instructions in `Binding the available VFs\n \n \n Binding the available VFs to the DPDK UIO driver\n-------------------------------------------------\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n Unbind the VFs from the stock driver so they can be bound to the uio driver.\n \n For an Intel(R) QuickAssist Technology DH895xCC device\n-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n \n The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your\n VFs are different adjust the unbind command below::\n@@ -387,7 +401,7 @@ VFs are different adjust the unbind command below::\n done\n \n For an Intel(R) QuickAssist Technology C62x device\n-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n \n The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,\n ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different\n@@ -407,7 +421,7 @@ adjust the unbind command below::\n done\n \n For Intel(R) QuickAssist Technology C3xxx or D15xx device\n-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n \n The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your\n VFs are different adjust the unbind command below::\n@@ -420,7 +434,7 @@ VFs are different adjust the unbind command below::\n done\n \n Bind to the DPDK uio driver\n-~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^\n \n Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci\n to confirm the VF devices are now in use by igb_uio kernel driver,\n@@ -461,7 +475,7 @@ QAT compression PMD can be tested by running the test application::\n \n \n Debugging\n-----------------------------------------\n+~~~~~~~~~\n \n There are 2 sets of trace available via the dynamic logging feature:\n \n", "prefixes": [ "v3", "4/6" ] }