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