[PATCH v2] doc: support IPsec Multi-buffer lib v1.3

[Power, Ciara]

Hi Pablo,

> -----Original Message-----
> From: Pablo de Lara <pablo.de.lara.guarch at intel.com>
> Sent: Wednesday 9 November 2022 18:39
> To: Ji, Kai <kai.ji at intel.com>
> Cc: dev at dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>
> Subject: [PATCH v2] doc: support IPsec Multi-buffer lib v1.3
> 
> 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 <pablo.de.lara.guarch at intel.com>
> ---
> 
> - v2: Removed repeated word 'the'
> 
> ---
>  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(-)
> 
<snip>
> --- 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
> <https://www.intel.com/content/dam/www/public/us/en/documents/whit
> e-papers/fast-multi-buffer-ipsec-implementations-ia-processors-
> paper.pdf>`_.
> 
> -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 <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.2, which -can be
> downloaded from `<https://github.com/01org/intel-ipsec-
> mb/archive/v1.2.zip>`_.
> +The latest version of the library supported by this PMD is v1.3, which
> +can be downloaded from `<https://github.com/01org/intel-ipsec-
> mb/archive/v1.3.zip>`_.
> 
>  .. 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*
>     ==============  ============================
[CP] 

Should 20.11 - 21.08 be 0.53 - 1.3* also? 

Overall, looks good, thanks.

Acked-by: Ciara Power <ciara.power at intel.com>