From patchwork Wed Nov 9 18:33:17 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: "De Lara Guarch, Pablo" X-Patchwork-Id: 119630 X-Patchwork-Delegate: gakhil@marvell.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 2EFE3A034C; Wed, 9 Nov 2022 19:33:25 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1102C400EF; Wed, 9 Nov 2022 19:33:25 +0100 (CET) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by mails.dpdk.org (Postfix) with ESMTP id 3C49840150 for ; Wed, 9 Nov 2022 19:33:23 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1668018803; x=1699554803; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=KUxZsa26TtYhCYh1fDEBZ9nQEa4MW/U16XOPPN+YTlw=; b=OZmVgd8wRD2BOYFnTK9kuUWsJ6hfgcCf/45R/bquaQkgRxFmUnETaT1p /V0OxrctJZQSECirAnwqijBTqIfimDRCub5cdfhlJ9yjQByy118wINPRE kQkvlQY7eJh8UPb8pyA7wzs8hv0QJni/mBKANMKq1DIoeAJmCHBSB+uua fld7u3ITjtFfYtxNXyQAZfIGfOPEorMCZCQLQ3WMeRMqAXg81RtWjRUoY zXgyUAsM3ZVlRMD23qVpBPmMGkEMlnF5Pc0UpdaHnN669I4A6dESFTBU0 dVnc54Gfyp3V2Q5S32IH2fOhSNYiNtvX6x0mJZBXWAp819v/5tzSnT/ot Q==; X-IronPort-AV: E=McAfee;i="6500,9779,10526"; a="312864722" X-IronPort-AV: E=Sophos;i="5.96,151,1665471600"; d="scan'208";a="312864722" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 09 Nov 2022 10:33:22 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6500,9779,10526"; a="636849505" X-IronPort-AV: E=Sophos;i="5.96,151,1665471600"; d="scan'208";a="636849505" Received: from silpixa00401399.ir.intel.com ([10.55.128.243]) by orsmga002.jf.intel.com with ESMTP; 09 Nov 2022 10:33:20 -0800 From: Pablo de Lara To: kai.ji@intel.com Cc: dev@dpdk.org, Pablo de Lara Subject: [PATCH] doc: support IPsec Multi-buffer lib v1.3 Date: Wed, 9 Nov 2022 18:33:17 +0000 Message-Id: <20221109183317.3909285-1-pablo.de.lara.guarch@intel.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Updated AESNI MB and AESNI GCM, KASUMI, ZUC and SNOW3G PMD documentation guides with information about the latest Intel IPSec Multi-buffer library supported. Signed-off-by: Pablo de Lara --- doc/guides/cryptodevs/aesni_gcm.rst | 8 ++++---- doc/guides/cryptodevs/aesni_mb.rst | 18 ++++++++++++------ doc/guides/cryptodevs/kasumi.rst | 15 +++++++++++---- doc/guides/cryptodevs/snow3g.rst | 15 +++++++++++---- doc/guides/cryptodevs/zuc.rst | 14 ++++++++++---- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst index 6229392f58..5192287ed8 100644 --- a/doc/guides/cryptodevs/aesni_gcm.rst +++ b/doc/guides/cryptodevs/aesni_gcm.rst @@ -40,8 +40,8 @@ Installation To build DPDK with the AESNI_GCM_PMD the user is required to download the multi-buffer library from `here `_ and compile it on their user system before building DPDK. -The latest version of the library supported by this PMD is v1.2, which -can be downloaded in ``_. +The latest version of the library supported by this PMD is v1.3, which +can be downloaded in ``_. .. code-block:: console @@ -84,8 +84,8 @@ and the external crypto libraries supported by them: 17.08 - 18.02 Multi-buffer library 0.46 - 0.48 18.05 - 19.02 Multi-buffer library 0.49 - 0.52 19.05 - 20.08 Multi-buffer library 0.52 - 0.55 - 20.11 - 21.08 Multi-buffer library 0.53 - 1.2* - 21.11+ Multi-buffer library 1.0 - 1.2* + 20.11 - 21.08 Multi-buffer library 0.53 - 1.3* + 21.11+ Multi-buffer library 1.0 - 1.3* ============= ================================ \* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst index 599ed5698f..3d0cd3de85 100644 --- a/doc/guides/cryptodevs/aesni_mb.rst +++ b/doc/guides/cryptodevs/aesni_mb.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2015-2018 Intel Corporation. -AESN-NI Multi Buffer Crypto Poll Mode Driver +AES-NI Multi Buffer Crypto Poll Mode Driver ============================================ @@ -10,8 +10,6 @@ support for utilizing Intel multi buffer library, see the white paper `Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors `_. -The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc. - The AES-NI MB PMD supports synchronous mode of operation with ``rte_cryptodev_sym_cpu_crypto_process`` function call. @@ -77,6 +75,14 @@ Limitations * RTE_CRYPTO_CIPHER_DES_DOCSISBPI is not supported for combined Crypto-CRC DOCSIS security protocol. +AESNI MB PMD selection over SNOW3G/ZUC/KASUMI PMDs +-------------------------------------------------- + +This PMD supports wireless cipher suite (SNOW3G, ZUC and KASUMI). +On Intel processors, it is recommended to use this PMD instead of SNOW3G, ZUC and KASUMI PMDs, +as it enables algorithm mixing (e.g. cipher algorithm SNOW3G-UEA2 with +authentication algorithm AES-CMAC-128) and performance over IMIX (packet size mix) traffic +is significantly higher. Installation ------------ @@ -84,8 +90,8 @@ Installation To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer library from `here `_ and compile it on their user system before building DPDK. -The latest version of the library supported by this PMD is v1.2, which -can be downloaded from ``_. +The latest version of the library supported by this PMD is v1.3, which +can be downloaded from ``_. .. code-block:: console @@ -131,7 +137,7 @@ and the Multi-Buffer library version supported by them: 19.05 - 19.08 0.52 19.11 - 20.08 0.52 - 0.55 20.11 - 21.08 0.53 - 1.2* - 21.11+ 1.0 - 1.2* + 21.11+ 1.0 - 1.3* ============== ============================ \* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst index d8128928f8..dc3a300fb5 100644 --- a/doc/guides/cryptodevs/kasumi.rst +++ b/doc/guides/cryptodevs/kasumi.rst @@ -30,14 +30,21 @@ Limitations (if length and/or offset of data to be ciphered is not byte-aligned). +KASUMI PMD vs AESNI MB PMD +-------------------------- + +AESNI MB PMD also supports KASUMI cipher and authentication algorithms, +It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors. +Take a look at the the PMD documentation here :doc:`aesni_mb` for more information. + Installation ------------ To build DPDK with the KASUMI_PMD the user is required to download the multi-buffer library from `here `_ and compile it on their user system before building DPDK. -The latest version of the library supported by this PMD is v1.2, which -can be downloaded from ``_. +The latest version of the library supported by this PMD is v1.3, which +can be downloaded from ``_. After downloading the library, the user needs to unpack and compile it on their system before building DPDK: @@ -78,8 +85,8 @@ and the external crypto libraries supported by them: DPDK version Crypto library version ============= ================================ 16.11 - 19.11 LibSSO KASUMI - 20.02 - 21.08 Multi-buffer library 0.53 - 1.2* - 21.11+ Multi-buffer library 1.0 - 1.2* + 20.02 - 21.08 Multi-buffer library 0.53 - 1.3* + 21.11+ Multi-buffer library 1.0 - 1.3* ============= ================================ \* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst index 02e857c0d2..eb7e53b8a4 100644 --- a/doc/guides/cryptodevs/snow3g.rst +++ b/doc/guides/cryptodevs/snow3g.rst @@ -29,6 +29,13 @@ Limitations * In-place bit-level operations for SNOW 3G (UEA2) are not supported (if length and/or offset of data to be ciphered is not byte-aligned). +SNOW3G PMD vs AESNI MB PMD +-------------------------- + +AESNI MB PMD also supports SNOW3G cipher and authentication algorithms, +It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors. +Take a look at the the PMD documentation here :doc:`aesni_mb` for more information. + Installation ------------ @@ -37,8 +44,8 @@ library and compile it on their user system before building DPDK. For x86 system, the multi-buffer library is available `here `_. -The latest version of the library supported by this PMD is v1.2, which -can be downloaded from ``_. +The latest version of the library supported by this PMD is v1.3, which +can be downloaded from ``_. For Arm system, ARM64 port of the multi-buffer library can be downloaded from ``_. The @@ -83,8 +90,8 @@ and the external crypto libraries supported by them: DPDK version Crypto library version ============= ================================ 16.04 - 19.11 LibSSO SNOW3G - 20.02 - 21.08 Multi-buffer library 0.53 - 1.2* - 21.11+ Multi-buffer library 1.0 - 1.2* + 20.02 - 21.08 Multi-buffer library 0.53 - 1.3* + 21.11+ Multi-buffer library 1.0 - 1.3* ============= ================================ \* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst index 10d44b7393..44fc2784cd 100644 --- a/doc/guides/cryptodevs/zuc.rst +++ b/doc/guides/cryptodevs/zuc.rst @@ -28,6 +28,12 @@ Limitations * ZUC (EIA3) supported only if hash offset field is byte-aligned. * ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned. +ZUC PMD vs AESNI MB PMD +----------------------- + +AESNI MB PMD also supports ZUC cipher and authentication algorithms, +It is recommended to use the AESNI MB PMD, which offers better performance on Intel processors. +Take a look at the the PMD documentation here :doc:`aesni_mb` for more information. Installation ------------ @@ -37,8 +43,8 @@ library and compile it on their user system before building DPDK. For x86 system, the multi-buffer library is available `here `_. -The latest version of the library supported by this PMD is v1.2, which -can be downloaded from ``_. +The latest version of the library supported by this PMD is v1.3, which +can be downloaded from ``_. For Arm system, ARM64 port of the multi-buffer library can be downloaded from ``_. The @@ -83,8 +89,8 @@ and the external crypto libraries supported by them: DPDK version Crypto library version ============= ================================ 16.11 - 19.11 LibSSO ZUC - 20.02 - 21.08 Multi-buffer library 0.53 - 1.2* - 21.11+ Multi-buffer library 1.0 - 1.2* + 20.02 - 21.08 Multi-buffer library 0.53 - 1.3* + 21.11+ Multi-buffer library 1.0 - 1.3* ============= ================================ \* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.