doc/guides/cryptodevs/dpaa_sec.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2017 NXP
   3
   4
   5
   6 NXP DPAA CAAM (DPAA_SEC)
   7 ========================
   8
   9 The DPAA_SEC PMD provides poll mode crypto driver support for NXP DPAA 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 DPAA_SEC is one of the hardware resource in DPAA Architecture. More information
  25 on DPAA Architecture is described in :ref:`dpaa_overview`.
  26
  27 DPAA_SEC PMD is one of DPAA drivers which interacts with QBMAN to create,
  28 configure and destroy the device instance using queue pair with CAAM portal.
  29
  30 DPAA_SEC PMD also uses some of the other hardware resources like buffer pools,
  31 queues, queue portals to store and to enqueue/dequeue data to the hardware SEC.
  32
  33 Implementation
  34 --------------
  35
  36 SEC provides platform assurance by working with SecMon, which is a companion
  37 logic block that tracks the security state of the SOC. SEC is programmed by
  38 means of descriptors (not to be confused with frame descriptors (FDs)) that
  39 indicate the operations to be performed and link to the message and
  40 associated data. SEC incorporates two DMA engines to fetch the descriptors,
  41 read the message data, and write the results of the operations. The DMA
  42 engine provides a scatter/gather capability so that SEC can read and write
  43 data scattered in memory. SEC may be configured by means of software for
  44 dynamic changes in byte ordering. The default configuration for this version
  45 of SEC is little-endian mode.
  46
  47 Features
  48 --------
  49
  50 The DPAA PMD has support for:
  51
  52 Cipher algorithms:
  53
  54 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
  55 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
  56 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
  57 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
  58 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
  59 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
  60 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
  61
  62 Hash algorithms:
  63
  64 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
  65 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
  66 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
  67 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
  68 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
  69 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
  70
  71 AEAD algorithms:
  72
  73 * ``RTE_CRYPTO_AEAD_AES_GCM``
  74
  75 Supported DPAA SoCs
  76 --------------------
  77
  78 * LS1046A/LS1026A
  79 * LS1043A/LS1023A
  80
  81 Whitelisting & Blacklisting
  82 ---------------------------
  83
  84 For blacklisting a DPAA device, following commands can be used.
  85
  86  .. code-block:: console
  87
  88     <dpdk app> <EAL args> -b "dpaa_bus:dpaa-secX" -- ...
  89     e.g. "dpaa_bus:dpaa-sec0"
  90
  91     or to disable all 4 SEC devices
  92     -b "dpaa_sec:dpaa-sec0"  -b "dpaa_sec:dpaa-sec1" -b "dpaa_sec:dpaa-sec2" -b "dpaa_sec:dpaa-sec3"
  93
  94 Limitations
  95 -----------
  96
  97 * Hash followed by Cipher mode is not supported
  98 * Only supports the session-oriented API implementation (session-less APIs are not supported).
  99
 100 Prerequisites
 101 -------------
 102
 103 DPAA_SEC driver has similar pre-requisites as described in :ref:`dpaa_overview`.
 104
 105 See :doc:`../platform/dpaa` for setup information
 106
 107
 108 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 109
 110 Pre-Installation Configuration
 111 ------------------------------
 112
 113 Config File Options
 114 ~~~~~~~~~~~~~~~~~~~
 115
 116 Basic DPAA config file options are described in :ref:`dpaa_overview`.
 117 In addition to those, the following options can be modified in the ``config`` file
 118 to enable DPAA_SEC PMD.
 119
 120 Please note that enabling debugging options may affect system performance.
 121
 122 * ``CONFIG_RTE_LIBRTE_PMD_DPAA_SEC`` (default ``n``)
 123   By default it is only enabled in defconfig_arm64-dpaa-* config.
 124   Toggle compilation of the ``librte_pmd_dpaa_sec`` driver.
 125
 126 Installations
 127 -------------
 128 To compile the DPAA_SEC PMD for Linux arm64 gcc target, run the
 129 following ``make`` command:
 130
 131 .. code-block:: console
 132
 133    cd <DPDK-source-directory>
 134    make config T=arm64-dpaa-linuxapp-gcc install
 135
 136 Enabling logs
 137 -------------
 138
 139 For enabling logs, use the following EAL parameter:
 140
 141 .. code-block:: console
 142
 143    ./your_crypto_application <EAL args> --log-level=pmd.crypto.dpaa:<level>
 144
 145 Using ``pmd.crypto.dpaa`` as log matching criteria, all Crypto PMD logs can be
 146 enabled which are lower than logging ``level``.