1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2016-2020 Intel Corporation.
4 AES-NI GCM Crypto Poll Mode Driver
5 ==================================
8 The AES-NI GCM PMD (**librte_pmd_aesni_gcm**) provides poll mode crypto driver
9 support for utilizing Intel multi buffer library (see AES-NI Multi-buffer PMD documentation
10 to learn more about it, including installation).
12 The AES-NI GCM PMD supports synchronous mode of operation with
13 ``rte_cryptodev_sym_cpu_crypto_process`` function call for both AES-GCM and
14 GMAC, however GMAC support is limited to one segment per operation. Please
15 refer to ``rte_crypto`` programmer's guide for more detail.
20 AESNI GCM PMD has support for:
22 Authentication algorithms:
24 * RTE_CRYPTO_AUTH_AES_GMAC
28 * RTE_CRYPTO_AEAD_AES_GCM
33 * In out-of-place operations, chained destination mbufs are not supported.
34 * Chained mbufs are only supported by RTE_CRYPTO_AEAD_AES_GCM algorithm,
35 not RTE_CRYPTO_AUTH_AES_GMAC.
36 * Cipher only is not supported.
42 To build DPDK with the AESNI_GCM_PMD the user is required to download the multi-buffer
43 library from `here <https://github.com/01org/intel-ipsec-mb>`_
44 and compile it on their user system before building DPDK.
45 The latest version of the library supported by this PMD is v0.54, which
46 can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v0.54.zip>`_.
48 .. code-block:: console
53 The library requires NASM to be built. Depending on the library version, it might
54 require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
56 NASM is packaged for different OS. However, on some OS the version is too old,
57 so a manual installation is required. In that case, NASM can be downloaded from
58 `NASM website <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
59 Once it is downloaded, extract it and follow these steps:
61 .. code-block:: console
69 Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
70 If a lower GCC version than 5.0, the workaround proposed by the following link
71 should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
74 As a reference, the following table shows a mapping between the past DPDK versions
75 and the external crypto libraries supported by them:
77 .. _table_aesni_gcm_versions:
79 .. table:: DPDK and external crypto library version compatibility
81 ============= ================================
82 DPDK version Crypto library version
83 ============= ================================
84 16.04 - 16.11 Multi-buffer library 0.43 - 0.44
85 17.02 - 17.05 ISA-L Crypto v2.18
86 17.08 - 18.02 Multi-buffer library 0.46 - 0.48
87 18.05 - 19.02 Multi-buffer library 0.49 - 0.52
88 19.05+ Multi-buffer library 0.52 - 0.54
89 ============= ================================
95 In order to enable this virtual crypto PMD, user must:
97 * Build the multi buffer library (explained in Installation section).
99 * Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base.
101 To use the PMD in an application, user must:
103 * Call rte_vdev_init("crypto_aesni_gcm") within the application.
105 * Use --vdev="crypto_aesni_gcm" in the EAL options, which will call rte_vdev_init() internally.
107 The following parameters (all optional) can be provided in the previous two calls:
109 * socket_id: Specify the socket where the memory for the device is going to be allocated
110 (by default, socket_id will be the socket where the core that is creating the PMD is running on).
112 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
114 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
118 .. code-block:: console
120 ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
121 -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"