1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2015-2018 Intel Corporation.
4 AESN-NI Multi Buffer Crypto Poll Mode Driver
5 ============================================
8 The AESNI MB PMD (**librte_pmd_aesni_mb**) provides poll mode crypto driver
9 support for utilizing Intel multi buffer library, see the white paper
10 `Fast Multi-buffer IPsec Implementations on IntelĀ® Architecture Processors
11 <https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-multi-buffer-ipsec-implementations-ia-processors-paper.pdf>`_.
13 The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc.
18 AESNI MB PMD has support for:
22 * RTE_CRYPTO_CIPHER_AES128_CBC
23 * RTE_CRYPTO_CIPHER_AES192_CBC
24 * RTE_CRYPTO_CIPHER_AES256_CBC
25 * RTE_CRYPTO_CIPHER_AES128_CTR
26 * RTE_CRYPTO_CIPHER_AES192_CTR
27 * RTE_CRYPTO_CIPHER_AES256_CTR
28 * RTE_CRYPTO_CIPHER_AES_DOCSISBPI
29 * RTE_CRYPTO_CIPHER_DES_CBC
30 * RTE_CRYPTO_CIPHER_3DES_CBC
31 * RTE_CRYPTO_CIPHER_DES_DOCSISBPI
35 * RTE_CRYPTO_HASH_MD5_HMAC
36 * RTE_CRYPTO_HASH_SHA1_HMAC
37 * RTE_CRYPTO_HASH_SHA224_HMAC
38 * RTE_CRYPTO_HASH_SHA256_HMAC
39 * RTE_CRYPTO_HASH_SHA384_HMAC
40 * RTE_CRYPTO_HASH_SHA512_HMAC
41 * RTE_CRYPTO_HASH_AES_XCBC_HMAC
42 * RTE_CRYPTO_HASH_AES_CMAC
43 * RTE_CRYPTO_HASH_AES_GMAC
44 * RTE_CRYPTO_HASH_SHA1
45 * RTE_CRYPTO_HASH_SHA224
46 * RTE_CRYPTO_HASH_SHA256
47 * RTE_CRYPTO_HASH_SHA384
48 * RTE_CRYPTO_HASH_SHA512
52 * RTE_CRYPTO_AEAD_AES_CCM
53 * RTE_CRYPTO_AEAD_AES_GCM
58 * Chained mbufs are not supported.
59 * Only in-place is currently supported (destination address is the same as source address).
60 * RTE_CRYPTO_AEAD_AES_GCM only works properly when the multi-buffer library is
62 * RTE_CRYPTO_HASH_AES_GMAC is supported by library version v0.51 or later.
63 * RTE_CRYPTO_HASH_SHA* is supported by library version v0.52 or later.
69 To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer
70 library from `here <https://github.com/01org/intel-ipsec-mb>`_
71 and compile it on their user system before building DPDK.
72 The latest version of the library supported by this PMD is v0.52, which
73 can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.52.zip>`.
75 .. code-block:: console
80 As a reference, the following table shows a mapping between the past DPDK versions
81 and the Multi-Buffer library version supported by them:
83 .. _table_aesni_mb_versions:
85 .. table:: DPDK and Multi-Buffer library version compatibility
87 ============== ============================
88 DPDK version Multi-buffer library version
89 ============== ============================
90 2.2 - 16.11 0.43 - 0.44
92 17.05 - 17.08 0.45 - 0.48
96 ============== ============================
102 In order to enable this virtual crypto PMD, user must:
104 * Build the multi buffer library (explained in Installation section).
106 * Set CONFIG_RTE_LIBRTE_PMD_AESNI_MB=y in config/common_base.
108 To use the PMD in an application, user must:
110 * Call rte_vdev_init("crypto_aesni_mb") within the application.
112 * Use --vdev="crypto_aesni_mb" in the EAL options, which will call rte_vdev_init() internally.
114 The following parameters (all optional) can be provided in the previous two calls:
116 * socket_id: Specify the socket where the memory for the device is going to be allocated
117 (by default, socket_id will be the socket where the core that is creating the PMD is running on).
119 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
121 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
125 .. code-block:: console
127 ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \
128 -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac"
133 For AES Counter mode (AES-CTR), the library supports two different sizes for Initialization
136 * 12 bytes: used mainly for IPSec, as it requires 12 bytes from the user, which internally
137 are appended the counter block (4 bytes), which is set to 1 for the first block
138 (no padding required from the user)
140 * 16 bytes: when passing 16 bytes, the library will take them and use the last 4 bytes
141 as the initial counter block for the first block.