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