doc/guides/cryptodevs/dpaa2_sec.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2016 NXP
   3
   4
   5
   6 NXP DPAA2 CAAM (DPAA2_SEC)
   7 ==========================
   8
   9 The DPAA2_SEC PMD provides poll mode crypto driver support for NXP DPAA2 CAAM
  10 hardware accelerator.
  11
  12 Architecture
  13 ------------
  14
  15 SEC is the SOC's security engine, which serves as NXP's latest cryptographic
  16 acceleration and offloading hardware. It combines functions previously
  17 implemented in separate modules to create a modular and scalable acceleration
  18 and assurance engine. It also implements block encryption algorithms, stream
  19 cipher algorithms, hashing algorithms, public key algorithms, run-time
  20 integrity checking, and a hardware random number generator. SEC performs
  21 higher-level cryptographic operations than previous NXP cryptographic
  22 accelerators. This provides significant improvement to system level performance.
  23
  24 DPAA2_SEC is one of the hardware resource in DPAA2 Architecture. More information
  25 on DPAA2 Architecture is described in :ref:`dpaa2_overview`.
  26
  27 DPAA2_SEC PMD is one of DPAA2 drivers which interacts with Management Complex (MC)
  28 portal to access the hardware object - DPSECI. The MC provides access to create,
  29 discover, connect, configure and destroy dpseci objects in DPAA2_SEC PMD.
  30
  31 DPAA2_SEC PMD also uses some of the other hardware resources like buffer pools,
  32 queues, queue portals to store and to enqueue/dequeue data to the hardware SEC.
  33
  34 DPSECI objects are detected by PMD using a resource container called DPRC (like
  35 in :ref:`dpaa2_overview`).
  36
  37 For example:
  38
  39 .. code-block:: console
  40
  41     DPRC.1 (bus)
  42       |
  43       +--+--------+-------+-------+-------+---------+
  44          |        |       |       |       |         |
  45        DPMCP.1  DPIO.1  DPBP.1  DPNI.1  DPMAC.1  DPSECI.1
  46        DPMCP.2  DPIO.2          DPNI.2  DPMAC.2  DPSECI.2
  47        DPMCP.3
  48
  49 Implementation
  50 --------------
  51
  52 SEC provides platform assurance by working with SecMon, which is a companion
  53 logic block that tracks the security state of the SOC. SEC is programmed by
  54 means of descriptors (not to be confused with frame descriptors (FDs)) that
  55 indicate the operations to be performed and link to the message and
  56 associated data. SEC incorporates two DMA engines to fetch the descriptors,
  57 read the message data, and write the results of the operations. The DMA
  58 engine provides a scatter/gather capability so that SEC can read and write
  59 data scattered in memory. SEC may be configured by means of software for
  60 dynamic changes in byte ordering. The default configuration for this version
  61 of SEC is little-endian mode.
  62
  63 A block diagram similar to dpaa2 NIC is shown below to show where DPAA2_SEC
  64 fits in the DPAA2 Bus model
  65
  66 .. code-block:: console
  67
  68
  69                                        +----------------+
  70                                        | DPDK DPAA2_SEC |
  71                                        |     PMD        |
  72                                        +----------------+       +------------+
  73                                        |  MC SEC object |.......|  Mempool   |
  74                     . . . . . . . . .  |   (DPSECI)     |       |  (DPBP)    |
  75                    .                   +---+---+--------+       +-----+------+
  76                   .                        ^   |                      .
  77                  .                         |   |<enqueue,             .
  78                 .                          |   | dequeue>             .
  79                .                           |   |                      .
  80               .                        +---+---V----+                 .
  81              .      . . . . . . . . . .| DPIO driver|                 .
  82             .      .                   |  (DPIO)    |                 .
  83            .      .                    +-----+------+                 .
  84           .      .                     |  QBMAN     |                 .
  85          .      .                      |  Driver    |                 .
  86     +----+------+-------+              +-----+----- |                 .
  87     |   dpaa2 bus       |                    |                        .
  88     |   VFIO fslmc-bus  |....................|.........................
  89     |                   |                    |
  90     |     /bus/fslmc    |                    |
  91     +-------------------+                    |
  92                                              |
  93     ========================== HARDWARE =====|=======================
  94                                            DPIO
  95                                              |
  96                                            DPSECI---DPBP
  97     =========================================|========================
  98
  99
 100
 101 Features
 102 --------
 103
 104 The DPAA2_SEC PMD has support for:
 105
 106 Cipher algorithms:
 107
 108 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
 109 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
 110 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
 111 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
 112 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
 113 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
 114 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
 115
 116 Hash algorithms:
 117
 118 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
 119 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
 120 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
 121 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
 122 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
 123 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
 124 * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
 125 * ``RTE_CRYPTO_AUTH_AES_CMAC``
 126
 127 AEAD algorithms:
 128
 129 * ``RTE_CRYPTO_AEAD_AES_GCM``
 130
 131 Supported DPAA2 SoCs
 132 --------------------
 133
 134 * LS2160A
 135 * LS2084A/LS2044A
 136 * LS2088A/LS2048A
 137 * LS1088A/LS1048A
 138
 139 Allowing & Blocking
 140 -------------------
 141
 142 The DPAA2 SEC device can be blocked with the following:
 143
 144  .. code-block:: console
 145
 146     <dpdk app> <EAL args> -b "fslmc:dpseci.x" -- ...
 147
 148 Where x is the device object id as configured in resource container.
 149
 150 Limitations
 151 -----------
 152
 153 * Hash followed by Cipher mode is not supported
 154 * Only supports the session-oriented API implementation (session-less APIs are not supported).
 155
 156 Prerequisites
 157 -------------
 158
 159 DPAA2_SEC driver has similar pre-requisites as described in :ref:`dpaa2_overview`.
 160 The following dependencies are not part of DPDK and must be installed separately:
 161
 162 See :doc:`../platform/dpaa2` for setup information
 163
 164 Currently supported by DPDK:
 165
 166 - NXP SDK **19.09+**.
 167 - MC Firmware version **10.18.0** and higher.
 168 - Supported architectures:  **arm64 LE**.
 169
 170 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 171
 172
 173 Enabling logs
 174 -------------
 175
 176 For enabling logs, use the following EAL parameter:
 177
 178 .. code-block:: console
 179
 180    ./your_crypto_application <EAL args> --log-level=pmd.crypto.dpaa2:<level>
 181
 182 Using ``crypto.dpaa2`` as log matching criteria, all Crypto PMD logs can be
 183 enabled which are lower than logging ``level``.