[v1] doc: support IPsec Multi-buffer lib v1.5

Message ID 20231109162930.1698810-1-venkatx.sivaramakrishnan@intel.com (mailing list archive)
State Accepted, archived
Delegated to: akhil goyal
Headers
Series [v1] doc: support IPsec Multi-buffer lib v1.5 |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS

Commit Message

Sivaramakrishnan Venkat Nov. 9, 2023, 4:29 p.m. UTC
  Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G and
CHACHA20_POLY1305 PMD documentation guides with information about
the latest Intel IPsec Multi-buffer library supported.

Signed-off-by: Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
---
 doc/guides/cryptodevs/aesni_gcm.rst         | 6 +++---
 doc/guides/cryptodevs/aesni_mb.rst          | 6 +++---
 doc/guides/cryptodevs/chacha20_poly1305.rst | 6 +++---
 doc/guides/cryptodevs/kasumi.rst            | 6 +++---
 doc/guides/cryptodevs/snow3g.rst            | 6 +++---
 doc/guides/cryptodevs/zuc.rst               | 6 +++---
 doc/guides/rel_notes/release_23_11.rst      | 4 ++++
 7 files changed, 22 insertions(+), 18 deletions(-)
  

Comments

Power, Ciara Nov. 10, 2023, 10:25 a.m. UTC | #1
Hi Venkat,

> -----Original Message-----
> From: Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
> Sent: Thursday, November 9, 2023 4:30 PM
> To: Ji, Kai <kai.ji@intel.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>
> Cc: dev@dpdk.org; stable@dpdk.org; gakhil@marvell.com; Sivaramakrishnan,
> VenkatX <venkatx.sivaramakrishnan@intel.com>
> Subject: [PATCH v1] doc: support IPsec Multi-buffer lib v1.5
> 
> Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G and
> CHACHA20_POLY1305 PMD documentation guides with information about
> the latest Intel IPsec Multi-buffer library supported.
> 
> Signed-off-by: Sivaramakrishnan Venkat
> <venkatx.sivaramakrishnan@intel.com>

Acked-by: Ciara Power <ciara.power@intel.com>
  
Akhil Goyal Nov. 13, 2023, 9:13 a.m. UTC | #2
> Hi Venkat,
> 
> > Subject: [PATCH v1] doc: support IPsec Multi-buffer lib v1.5
> >
> > Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G and
> > CHACHA20_POLY1305 PMD documentation guides with information about
> > the latest Intel IPsec Multi-buffer library supported.
> >
> > Signed-off-by: Sivaramakrishnan Venkat
> > <venkatx.sivaramakrishnan@intel.com>
> 
> Acked-by: Ciara Power <ciara.power@intel.com>
Applied to dpdk-next-crypto
Thanks.
  
Thomas Monjalon Nov. 13, 2023, 1:13 p.m. UTC | #3
13/11/2023 10:13, Akhil Goyal:
> > Hi Venkat,
> > 
> > > Subject: [PATCH v1] doc: support IPsec Multi-buffer lib v1.5
> > >
> > > Updated AESNI MB and AESNI GCM, KASUMI, ZUC, SNOW3G and
> > > CHACHA20_POLY1305 PMD documentation guides with information about
> > > the latest Intel IPsec Multi-buffer library supported.
> > >
> > > Signed-off-by: Sivaramakrishnan Venkat
> > > <venkatx.sivaramakrishnan@intel.com>
> > 
> > Acked-by: Ciara Power <ciara.power@intel.com>
> Applied to dpdk-next-crypto
> Thanks.

When updating the release notes, please take care of adding
the new item in the right place.
There was already a section for ipsec_mb with other crypto drivers.
Thanks
  

Patch

diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index e0d9188a5d..f5773426ee 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 <https://github.com/01org/intel-ipsec-mb>`_
 and compile it on their user system before building DPDK.
-The latest version of the library supported by this PMD is v1.4, which
-can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v1.4.zip>`_.
+The latest version of the library supported by this PMD is v1.5, which
+can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v1.5.zip>`_.
 
 .. code-block:: console
 
@@ -85,7 +85,7 @@  and the external crypto libraries supported by them:
    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.3*
-   21.11+         Multi-buffer library 1.0  - 1.4*
+   21.11+         Multi-buffer library 1.0  - 1.5*
    =============  ================================
 
 \* 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 879eb42d44..b2e74ba417 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -99,8 +99,8 @@  Installation
 To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer
 library from `here <https://github.com/01org/intel-ipsec-mb>`_
 and compile it on their user system before building DPDK.
-The latest version of the library supported by this PMD is v1.4, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.4.zip>`_.
+The latest version of the library supported by this PMD is v1.5, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.5.zip>`_.
 
 .. code-block:: console
 
@@ -146,7 +146,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.3*
-   21.11+          1.0  - 1.4*
+   21.11+          1.0  - 1.5*
    ==============  ============================
 
 \* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
diff --git a/doc/guides/cryptodevs/chacha20_poly1305.rst b/doc/guides/cryptodevs/chacha20_poly1305.rst
index ee7b6e54e5..9d4bf86cf1 100644
--- a/doc/guides/cryptodevs/chacha20_poly1305.rst
+++ b/doc/guides/cryptodevs/chacha20_poly1305.rst
@@ -31,8 +31,8 @@  Installation
 To build DPDK with the Chacha20-poly1305 PMD the user is required to download
 the multi-buffer library from `here <https://github.com/01org/intel-ipsec-mb>`_
 and compile it on their user system before building DPDK.
-The latest version of the library supported by this PMD is v1.4, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.4.zip>`_.
+The latest version of the library supported by this PMD is v1.5, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.5.zip>`_.
 
 After downloading the library, the user needs to unpack and compile it
 on their system before building DPDK:
@@ -72,7 +72,7 @@  and the external crypto libraries supported by them:
    =============  ================================
    DPDK version   Crypto library version
    =============  ================================
-   21.11+         Multi-buffer library 1.0-1.4*
+   21.11+         Multi-buffer library 1.0-1.5*
    =============  ================================
 
 \* 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 b9c512703a..0989054875 100644
--- a/doc/guides/cryptodevs/kasumi.rst
+++ b/doc/guides/cryptodevs/kasumi.rst
@@ -44,8 +44,8 @@  Installation
 To build DPDK with the KASUMI_PMD the user is required to download the multi-buffer
 library from `here <https://github.com/01org/intel-ipsec-mb>`_
 and compile it on their user system before building DPDK.
-The latest version of the library supported by this PMD is v1.4, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.4.zip>`_.
+The latest version of the library supported by this PMD is v1.5, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.5.zip>`_.
 
 After downloading the library, the user needs to unpack and compile it
 on their system before building DPDK:
@@ -87,7 +87,7 @@  and the external crypto libraries supported by them:
    =============  ================================
    16.11 - 19.11  LibSSO KASUMI
    20.02 - 21.08  Multi-buffer library 0.53 - 1.3*
-   21.11+         Multi-buffer library 1.0  - 1.4*
+   21.11+         Multi-buffer library 1.0  - 1.5*
    =============  ================================
 
 \* 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 af8ccaa2fd..3392932653 100644
--- a/doc/guides/cryptodevs/snow3g.rst
+++ b/doc/guides/cryptodevs/snow3g.rst
@@ -49,8 +49,8 @@  library and compile it on their user system before building DPDK.
 
 For x86 system, the multi-buffer library is available
 `here <https://github.com/01org/intel-ipsec-mb>`_.
-The latest version of the library supported by this PMD is v1.4, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.4.zip>`_.
+The latest version of the library supported by this PMD is v1.5, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.5.zip>`_.
 
 For Arm system, ARM64 port of the multi-buffer library can be downloaded from
 `<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The
@@ -96,7 +96,7 @@  and the external crypto libraries supported by them:
    =============  ================================
    16.04 - 19.11  LibSSO SNOW3G
    20.02 - 21.08  Multi-buffer library 0.53 - 1.3*
-   21.11+         Multi-buffer library 1.0  - 1.4*
+   21.11+         Multi-buffer library 1.0  - 1.5*
    =============  ================================
 
 \* 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 43eab4decb..a414b5ad2c 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -48,8 +48,8 @@  library and compile it on their user system before building DPDK.
 
 For x86 system, the multi-buffer library is available
 `here <https://github.com/01org/intel-ipsec-mb>`_.
-The latest version of the library supported by this PMD is v1.4, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.4.zip>`_.
+The latest version of the library supported by this PMD is v1.5, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.5.zip>`_.
 
 For Arm system, ARM64 port of the multi-buffer library can be downloaded from
 `<https://gitlab.arm.com/arm-reference-solutions/ipsec-mb/-/tree/main/>`_. The
@@ -95,7 +95,7 @@  and the external crypto libraries supported by them:
    =============  ================================
    16.11 - 19.11  LibSSO ZUC
    20.02 - 21.08  Multi-buffer library 0.53 - 1.3*
-   21.11+         Multi-buffer library 1.0  - 1.4*
+   21.11+         Multi-buffer library 1.0  - 1.5*
    =============  ================================
 
 \* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
diff --git a/doc/guides/rel_notes/release_23_11.rst b/doc/guides/rel_notes/release_23_11.rst
index 0a0f51d1c0..7f71740a04 100644
--- a/doc/guides/rel_notes/release_23_11.rst
+++ b/doc/guides/rel_notes/release_23_11.rst
@@ -158,6 +158,10 @@  New Features
 
   * Added inline IPsec offload based on the security framework.
 
+* **Updated ipsec_mb crypto driver.**
+
+  * Added Intel IPsec MB v1.5 library support for x86 platform.
+
 * **Updated Intel cpfl driver.**
 
   * Added support for port representor.