X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcryptodevs%2Faesni_gcm.rst;h=19f95bde8ef92d31630d0c8a8bceb9591cfb85d5;hb=2e3dbc80cc012f11799c7eda866e1168dadb5032;hp=1e8cdec5bae5299fc9db9998176eec32fd2078a3;hpb=f69ed1044230c218c9afd8f1b47b6fe6aa1eeec5;p=dpdk.git diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst index 1e8cdec5ba..19f95bde8e 100644 --- a/doc/guides/cryptodevs/aesni_gcm.rst +++ b/doc/guides/cryptodevs/aesni_gcm.rst @@ -5,7 +5,7 @@ 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). @@ -31,8 +31,6 @@ Limitations ----------- * In out-of-place operations, chained destination mbufs are not supported. -* Chained mbufs are only supported by RTE_CRYPTO_AEAD_AES_GCM algorithm, - not RTE_CRYPTO_AUTH_AES_GMAC. * Cipher only is not supported. @@ -42,14 +40,28 @@ 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.53, 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. @@ -71,7 +83,7 @@ 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 - 0.53 + 19.05+ Multi-buffer library 0.52 - 1.0 ============= ================================ @@ -82,8 +94,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. @@ -103,5 +113,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"