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.48, which
  40 can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v0.48.zip>`_.
  41
  42 .. code-block:: console
  43
  44         make
  45
  46 As a reference, the following table shows a mapping between the past DPDK versions
  47 and the external crypto libraries supported by them:
  48
  49 .. _table_aesni_gcm_versions:
  50
  51 .. table:: DPDK and external crypto library version compatibility
  52
  53    =============  ================================
  54    DPDK version   Crypto library version
  55    =============  ================================
  56    16.04 - 16.11  Multi-buffer library 0.43 - 0.44
  57    17.02 - 17.05  ISA-L Crypto v2.18
  58    17.08+         Multi-buffer library 0.46+
  59    =============  ================================
  60
  61
  62 Initialization
  63 --------------
  64
  65 In order to enable this virtual crypto PMD, user must:
  66
  67 * Export the environmental variable AESNI_MULTI_BUFFER_LIB_PATH with the path where
  68   the library was extracted.
  69
  70 * Build the multi buffer library (explained in Installation section).
  71
  72 * Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base.
  73
  74 To use the PMD in an application, user must:
  75
  76 * Call rte_vdev_init("crypto_aesni_gcm") within the application.
  77
  78 * Use --vdev="crypto_aesni_gcm" in the EAL options, which will call rte_vdev_init() internally.
  79
  80 The following parameters (all optional) can be provided in the previous two calls:
  81
  82 * socket_id: Specify the socket where the memory for the device is going to be allocated
  83   (by default, socket_id will be the socket where the core that is creating the PMD is running on).
  84
  85 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
  86
  87 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
  88
  89 Example:
  90
  91 .. code-block:: console
  92
  93     ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
  94     -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"