X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcryptodevs%2Faesni_gcm.rst;h=bbe9d9984073b93b1f1ddd67a3afd22e32242aa8;hb=f16662885472d33570b564e62427199d733be363;hp=15002aba7f90f8b9a36c3eabf175f8e4a5d57bc2;hpb=185059c0f3ebdf396aa12877689e51880d47027e;p=dpdk.git diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst index 15002aba7f..bbe9d99840 100644 --- a/doc/guides/cryptodevs/aesni_gcm.rst +++ b/doc/guides/cryptodevs/aesni_gcm.rst @@ -1,14 +1,19 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright(c) 2016-2019 Intel Corporation. + Copyright(c) 2016-2020 Intel Corporation. AES-NI GCM Crypto Poll Mode Driver ================================== -The AES-NI GCM PMD (**librte_pmd_aesni_gcm**) provides poll mode crypto driver +The AES-NI GCM PMD (**librte_crypto_aesni_gcm**) provides poll mode crypto driver support for utilizing Intel multi buffer library (see AES-NI Multi-buffer PMD documentation to learn more about it, including installation). +The AES-NI GCM PMD supports synchronous mode of operation with +``rte_cryptodev_sym_cpu_crypto_process`` function call for both AES-GCM and +GMAC, however GMAC support is limited to one segment per operation. Please +refer to ``rte_crypto`` programmer's guide for more detail. + Features -------- @@ -25,9 +30,7 @@ AEAD algorithms: Limitations ----------- -* Chained mbufs are supported but only out-of-place (destination mbuf must be contiguous). -* Chained mbufs are only supported by RTE_CRYPTO_AEAD_AES_GCM algorithm, - not RTE_CRYPTO_AUTH_AES_GMAC. +* In out-of-place operations, chained destination mbufs are not supported. * Cipher only is not supported. @@ -37,14 +40,35 @@ 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 v0.52, which -can be downloaded in ``_. +The latest version of the library supported by this PMD is v1.0, which +can be downloaded in ``_. + +.. code-block:: console + + make + make install + +The library requires NASM to be built. Depending on the library version, it might +require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14). + +NASM is packaged for different OS. However, on some OS the version is too old, +so a manual installation is required. In that case, NASM can be downloaded from +`NASM website `_. +Once it is downloaded, extract it and follow these steps: .. code-block:: console + ./configure make make install +.. note:: + + Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53. + If a lower GCC version than 5.0, the workaround proposed by the following link + should be used: ``_. + + As a reference, the following table shows a mapping between the past DPDK versions and the external crypto libraries supported by them: @@ -59,9 +83,12 @@ and the external crypto libraries supported by them: 17.02 - 17.05 ISA-L Crypto v2.18 17.08 - 18.02 Multi-buffer library 0.46 - 0.48 18.05 - 19.02 Multi-buffer library 0.49 - 0.52 - 19.05+ Multi-buffer library 0.52 + 19.05 - 20.08 Multi-buffer library 0.52 - 0.55 + 20.11 - 21.08 Multi-buffer library 0.53 - 1.0* + 21.11+ Multi-buffer library 1.0* ============= ================================ +\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. Initialization -------------- @@ -70,8 +97,6 @@ In order to enable this virtual crypto PMD, user must: * Build the multi buffer library (explained in Installation section). -* Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base. - To use the PMD in an application, user must: * Call rte_vdev_init("crypto_aesni_gcm") within the application. @@ -91,5 +116,5 @@ Example: .. code-block:: console - ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"