From patchwork Thu Apr 18 16:45:04 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Fiona Trahe X-Patchwork-Id: 52946 X-Patchwork-Delegate: gakhil@marvell.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 512301BC01; Thu, 18 Apr 2019 18:45:25 +0200 (CEST) Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by dpdk.org (Postfix) with ESMTP id 888521BBF7 for ; Thu, 18 Apr 2019 18:45:23 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Apr 2019 09:45:22 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,366,1549958400"; d="scan'208";a="141761894" Received: from sivswdev09.ir.intel.com (HELO localhost.localdomain) ([10.237.217.48]) by fmsmga008.fm.intel.com with ESMTP; 18 Apr 2019 09:45:20 -0700 From: Fiona Trahe To: dev@dpdk.org Cc: akhil.goyal@nxp.com, arkadiuszx.kusztal@intel.com, Fiona Trahe Date: Thu, 18 Apr 2019 17:45:04 +0100 Message-Id: <1555605904-14979-1-git-send-email-fiona.trahe@intel.com> X-Mailer: git-send-email 1.7.0.7 In-Reply-To: <20190418095125.12528-1-arkadiuszx.kusztal@intel.com> References: <20190418095125.12528-1-arkadiuszx.kusztal@intel.com> Subject: [dpdk-dev] [PATCH v3] doc/crypto: add release notes and more detailed doc to qat X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" From: Arek Kusztal This patch adds release notes to 19.05 release document, and more detailed description to Intel QuickAssist Technology driver documentation files for asymmmetric crypto PMD. Signed-off-by: Arek Kusztal Signed-off-by: Fiona Trahe Acked-by: Arek Kusztal --- v3 changes: - fixed broken table and moved note about max_devs up doc/guides/cryptodevs/features/qat.ini | 2 + doc/guides/cryptodevs/qat.rst | 81 +++++++++++++++++++++++++--------- doc/guides/rel_notes/release_19_05.rst | 6 +++ 3 files changed, 67 insertions(+), 22 deletions(-) diff --git a/doc/guides/cryptodevs/features/qat.ini b/doc/guides/cryptodevs/features/qat.ini index 81325801e..e8f906090 100644 --- a/doc/guides/cryptodevs/features/qat.ini +++ b/doc/guides/cryptodevs/features/qat.ini @@ -67,3 +67,5 @@ AES CCM (256) = Y ; Supported Asymmetric algorithms of the 'qat' crypto driver. ; [Asymmetric] +Modular Exponentiation = Y +Modular Inversion = Y diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst index 2c4ee62f1..e905f6d00 100644 --- a/doc/guides/cryptodevs/qat.rst +++ b/doc/guides/cryptodevs/qat.rst @@ -6,7 +6,7 @@ Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver QAT documentation consists of three parts: -* Details of the symmetric crypto service below. +* Details of the symmetric and asymmetric crypto services below. * Details of the `compression service `_ in the compressdev drivers section. * Details of building the common QAT infrastructure and the PMDs to support the @@ -16,8 +16,8 @@ QAT documentation consists of three parts: Symmetric Crypto Service on QAT ------------------------------- -The QAT crypto PMD provides poll mode crypto driver support for the following -hardware accelerator devices: +The QAT symmetric crypto PMD (hereafter referred to as `QAT SYM [PMD]`) provides +poll mode crypto driver support for the following hardware accelerator devices: * ``Intel QuickAssist Technology DH895xCC`` * ``Intel QuickAssist Technology C62x`` @@ -29,7 +29,7 @@ hardware accelerator devices: Features ~~~~~~~~ -The QAT PMD has support for: +The QAT SYM PMD has support for: Cipher algorithms: @@ -104,14 +104,26 @@ must be such that points at the start of the COUNT bytes. Asymmetric Crypto Service on QAT -------------------------------- -The QAT Asym PMD has support for: +The QAT asymmetric crypto PMD (hereafter referred to as `QAT ASYM [PMD]`) provides +poll mode crypto driver support for the following hardware accelerator devices: -* ``Modular exponentiation`` -* ``Modular multiplicative inverse`` +* ``Intel QuickAssist Technology DH895xCC`` +* ``Intel QuickAssist Technology C62x`` +* ``Intel QuickAssist Technology C3xxx`` +* ``Intel QuickAssist Technology D15xx`` +* ``Intel QuickAssist Technology C4xxx`` + +The QAT ASYM PMD has support for: + +* ``RTE_CRYPTO_ASYM_XFORM_MODEX`` +* ``RTE_CRYPTO_ASYM_XFORM_MODINV`` Limitations ~~~~~~~~~~~ +* Big integers longer than 4096 bits are not supported. +* Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported). + .. _building_qat: Building PMDs on QAT @@ -144,6 +156,8 @@ Quick instructions for QAT cryptodev PMD are as follows: cd to the top-level DPDK directory make defconfig sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\)=n,\1=y,' build/.config + or/and + sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_ASYM\)=n,\1=y,' build/.config make Quick instructions for QAT compressdev PMD are as follows: @@ -166,13 +180,14 @@ These are the build configuration options affecting QAT, and their default value CONFIG_RTE_LIBRTE_PMD_QAT=y CONFIG_RTE_LIBRTE_PMD_QAT_SYM=n + CONFIG_RTE_LIBRTE_PMD_QAT_ASYM=n CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES=48 CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE=65536 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. +Both QAT SYM PMD and QAT ASYM PMD have an external dependency on libcrypto, so are not +built by default. CONFIG_RTE_LIBRTE_PMD_QAT_SYM/ASYM should be enabled to build them. The QAT compressdev PMD has no external dependencies, so needs no configuration options and is built by default. @@ -180,9 +195,18 @@ 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 are separate config items for max cryptodevs CONFIG_RTE_CRYPTO_MAX_DEVS -and max compressdevs CONFIG_RTE_COMPRESS_MAX_DEVS, if necessary these should be -adjusted to handle the total of QAT and other devices which the process will use. + +.. Note:: + + There are separate config items (not QAT-specific) for max cryptodevs + CONFIG_RTE_CRYPTO_MAX_DEVS and max compressdevs CONFIG_RTE_COMPRESS_MAX_DEVS, + if necessary these should be adjusted to handle the total of QAT and other + devices which the process will use. In particular for crypto, where each + QAT VF may expose two crypto devices, sym and asym, it may happen that the + number of devices will be bigger than MAX_DEVS and the process will show an error + during PMD initialisation. To avoid this problem CONFIG_RTE_CRYPTO_MAX_DEVS may be + increased or -w, pci-whitelist domain:bus:devid:func option may be used. + QAT compression PMD needs intermediate buffers to support Deflate compression with Dynamic Huffman encoding. CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE @@ -204,16 +228,20 @@ allocated while for GEN1 devices, 12 buffers are allocated, plus 1472 bytes over 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 qat cryptodev symmetric crypto driver name is "crypto_qat". +* The qat cryptodev asymmetric crypto driver name is "crypto_qat_asym". -* Each qat crypto device has a unique name, in format +The "rte_cryptodev_devices_get()" returns the devices exposed by either of these drivers. + +* Each qat sym crypto device has a unique name, in format "_", e.g. "0000:41:01.0_qat_sym". +* Each qat asym crypto device has a unique name, in format + "_", e.g. "0000:41:01.0_qat_asym". 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 cryptodev 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. @@ -237,7 +265,8 @@ 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. +enable one symmetric cryptodev PMD and/or one asymmetric 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. @@ -268,17 +297,17 @@ to see the full table) +=====+=====+=====+=====+==========+===============+===============+============+========+======+========+========+ | Yes | No | No | 1 | DH895xCC | linux/4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 443 | 32 | +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+ - | Yes | No | No | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | + | Yes | Yes | No | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+ - | Yes | No | Yes | " | " | 01.org/4.3.0+ | " | " | " | " | " | " | + | Yes | Yes | Yes | " | " | 01.org/4.3.0+ | " | " | " | " | " | " | +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+ | Yes | No | No | 2 | C62x | linux/4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37c9 | 16 | +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+ - | Yes | No | Yes | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | + | Yes | Yes | Yes | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+ | Yes | No | No | 2 | C3xxx | linux/4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19e3 | 16 | +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+ - | Yes | No | Yes | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | + | Yes | Yes | Yes | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+ | Yes | No | No | 2 | D15xx | p | qat_d15xx | d15xx | 6f54 | 1 | 6f55 | 16 | +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+ @@ -540,7 +569,7 @@ Another way to bind the VFs to the DPDK UIO driver is by using the Testing ~~~~~~~ -QAT crypto PMD can be tested by running the test application:: +QAT SYM crypto PMD can be tested by running the test application:: make defconfig make -j @@ -548,6 +577,14 @@ QAT crypto PMD can be tested by running the test application:: ./test -l1 -n1 -w RTE>>cryptodev_qat_autotest +QAT ASYM crypto PMD can be tested by running the test application:: + + make defconfig + make -j + cd ./build/app + ./test -l1 -n1 -w + RTE>>cryptodev_qat_asym_autotest + QAT compression PMD can be tested by running the test application:: make defconfig diff --git a/doc/guides/rel_notes/release_19_05.rst b/doc/guides/rel_notes/release_19_05.rst index b0928a6d9..969794c69 100644 --- a/doc/guides/rel_notes/release_19_05.rst +++ b/doc/guides/rel_notes/release_19_05.rst @@ -160,6 +160,12 @@ New Features Improved testpmd application performance on ARM platform. For ``macswap`` forwarding mode, NEON intrinsics were used to do swap to save CPU cycles. +* **Added Intel QuickAssist Technology PMD for asymmetric crypto.** + + A new QAT Crypto PMD has been added, which provides asymmetric cryptography + algorithms, in this release modular exponentiation and modular multiplicative + inverse algorithms were added. + Removed Items -------------