1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2016-2019 Intel Corporation. 3 4AES-NI GCM Crypto Poll Mode Driver 5================================== 6 7 8The AES-NI GCM PMD (**librte_pmd_aesni_gcm**) provides poll mode crypto driver 9support for utilizing Intel multi buffer library (see AES-NI Multi-buffer PMD documentation 10to learn more about it, including installation). 11 12Features 13-------- 14 15AESNI GCM PMD has support for: 16 17Authentication algorithms: 18 19* RTE_CRYPTO_AUTH_AES_GMAC 20 21AEAD algorithms: 22 23* RTE_CRYPTO_AEAD_AES_GCM 24 25Limitations 26----------- 27 28* Chained mbufs are supported but only out-of-place (destination mbuf must be contiguous). 29* Chained mbufs are only supported by RTE_CRYPTO_AEAD_AES_GCM algorithm, 30 not RTE_CRYPTO_AUTH_AES_GMAC. 31* Cipher only is not supported. 32 33 34Installation 35------------ 36 37To build DPDK with the AESNI_GCM_PMD the user is required to download the multi-buffer 38library from `here <https://github.com/01org/intel-ipsec-mb>`_ 39and compile it on their user system before building DPDK. 40The latest version of the library supported by this PMD is v0.52, which 41can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v0.52.zip>`_. 42 43.. code-block:: console 44 45 make 46 make install 47 48As a reference, the following table shows a mapping between the past DPDK versions 49and the external crypto libraries supported by them: 50 51.. _table_aesni_gcm_versions: 52 53.. table:: DPDK and external crypto library version compatibility 54 55 ============= ================================ 56 DPDK version Crypto library version 57 ============= ================================ 58 16.04 - 16.11 Multi-buffer library 0.43 - 0.44 59 17.02 - 17.05 ISA-L Crypto v2.18 60 17.08 - 18.02 Multi-buffer library 0.46 - 0.48 61 18.05 - 19.02 Multi-buffer library 0.49 - 0.52 62 19.05+ Multi-buffer library 0.52 63 ============= ================================ 64 65 66Initialization 67-------------- 68 69In order to enable this virtual crypto PMD, user must: 70 71* Build the multi buffer library (explained in Installation section). 72 73* Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base. 74 75To use the PMD in an application, user must: 76 77* Call rte_vdev_init("crypto_aesni_gcm") within the application. 78 79* Use --vdev="crypto_aesni_gcm" in the EAL options, which will call rte_vdev_init() internally. 80 81The following parameters (all optional) can be provided in the previous two calls: 82 83* socket_id: Specify the socket where the memory for the device is going to be allocated 84 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 85 86* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 87 88* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 89 90Example: 91 92.. code-block:: console 93 94 ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ 95 -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm" 96