doc/guides/cryptodevs/nitrox.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(C) 2019 Marvell International Ltd.
   3
   4 Marvell NITROX Crypto Poll Mode Driver
   5 ======================================
   6
   7 The Nitrox crypto poll mode driver provides support for offloading
   8 cryptographic operations to the NITROX V security processor. Detailed
   9 information about the NITROX V security processor can be obtained here:
  10
  11 * https://www.marvell.com/security-solutions/nitrox-security-processors/nitrox-v/
  12
  13 Features
  14 --------
  15
  16 Nitrox crypto PMD has support for:
  17
  18 Cipher algorithms:
  19
  20 * ``RTE_CRYPTO_CIPHER_AES_CBC``
  21 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
  22
  23 Hash algorithms:
  24
  25 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
  26 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
  27 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
  28
  29 Supported AEAD algorithms:
  30
  31 * ``RTE_CRYPTO_AEAD_AES_GCM``
  32
  33 Limitations
  34 -----------
  35
  36 * Session-less APIs are not supported.
  37
  38
  39 Initialization
  40 --------------
  41
  42 Nitrox crypto PMD depend on Nitrox kernel PF driver being installed on the
  43 platform. Nitrox PF driver is required to create VF devices which will
  44 be used by the PMD. Each VF device can enable one cryptodev PMD.
  45
  46 Nitrox kernel PF driver is available as part of CNN55XX-Driver SDK. The SDK
  47 and it's installation instructions can be obtained from:
  48 `Marvell Technical Documentation Portal <https://support.cavium.com/>`_.