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
  22 Hash algorithms:
  23
  24 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
  25 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
  26 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
  27
  28 Limitations
  29 -----------
  30
  31 * AES_CBC Cipher Only combination is not supported.
  32 * Session-less APIs are not supported.
  33
  34 Installation
  35 ------------
  36
  37 For compiling the Nitrox crypto PMD, please check if the
  38 CONFIG_RTE_LIBRTE_PMD_NITROX setting is set to `y` in config/common_base file.
  39
  40 * ``CONFIG_RTE_LIBRTE_PMD_NITROX=y``
  41
  42 Initialization
  43 --------------
  44
  45 Nitrox crypto PMD depend on Nitrox kernel PF driver being installed on the
  46 platform. Nitrox PF driver is required to create VF devices which will
  47 be used by the PMD. Each VF device can enable one cryptodev PMD.
  48
  49 Nitrox kernel PF driver is available as part of CNN55XX-Driver SDK. The SDK
  50 and it's installation instructions can be obtained from:
  51 `Marvell Technical Documentation Portal <https://support.cavium.com/>`_.