xref: /dpdk/doc/guides/cryptodevs/nitrox.rst (revision 60531a2c53f4d2b4b96ebb10ca813f62d0a5508d)
10a8fc242SNagadheeraj Rottela..  SPDX-License-Identifier: BSD-3-Clause
20a8fc242SNagadheeraj Rottela    Copyright(C) 2019 Marvell International Ltd.
30a8fc242SNagadheeraj Rottela
40a8fc242SNagadheeraj RottelaMarvell NITROX Crypto Poll Mode Driver
50a8fc242SNagadheeraj Rottela======================================
60a8fc242SNagadheeraj Rottela
70a8fc242SNagadheeraj RottelaThe Nitrox crypto poll mode driver provides support for offloading
80a8fc242SNagadheeraj Rottelacryptographic operations to the NITROX V security processor. Detailed
90a8fc242SNagadheeraj Rottelainformation about the NITROX V security processor can be obtained here:
100a8fc242SNagadheeraj Rottela
110a8fc242SNagadheeraj Rottela* https://www.marvell.com/security-solutions/nitrox-security-processors/nitrox-v/
120a8fc242SNagadheeraj Rottela
139282bdeeSNagadheeraj RottelaFeatures
149282bdeeSNagadheeraj Rottela--------
159282bdeeSNagadheeraj Rottela
169282bdeeSNagadheeraj RottelaNitrox crypto PMD has support for:
179282bdeeSNagadheeraj Rottela
189282bdeeSNagadheeraj RottelaCipher algorithms:
199282bdeeSNagadheeraj Rottela
209282bdeeSNagadheeraj Rottela* ``RTE_CRYPTO_CIPHER_AES_CBC``
212a41db75SNagadheeraj Rottela* ``RTE_CRYPTO_CIPHER_3DES_CBC``
229282bdeeSNagadheeraj Rottela
239282bdeeSNagadheeraj RottelaHash algorithms:
249282bdeeSNagadheeraj Rottela
259282bdeeSNagadheeraj Rottela* ``RTE_CRYPTO_AUTH_SHA1_HMAC``
269282bdeeSNagadheeraj Rottela* ``RTE_CRYPTO_AUTH_SHA224_HMAC``
279282bdeeSNagadheeraj Rottela* ``RTE_CRYPTO_AUTH_SHA256_HMAC``
289282bdeeSNagadheeraj Rottela
2993ba4a6eSNagadheeraj RottelaSupported AEAD algorithms:
3093ba4a6eSNagadheeraj Rottela
3193ba4a6eSNagadheeraj Rottela* ``RTE_CRYPTO_AEAD_AES_GCM``
32*60531a2cSNagadheeraj Rottela* ``RTE_CRYPTO_AEAD_AES_CCM``
3393ba4a6eSNagadheeraj Rottela
349282bdeeSNagadheeraj RottelaLimitations
359282bdeeSNagadheeraj Rottela-----------
369282bdeeSNagadheeraj Rottela
379282bdeeSNagadheeraj Rottela* Session-less APIs are not supported.
389282bdeeSNagadheeraj Rottela
390a8fc242SNagadheeraj Rottela
400a8fc242SNagadheeraj RottelaInitialization
410a8fc242SNagadheeraj Rottela--------------
420a8fc242SNagadheeraj Rottela
430a8fc242SNagadheeraj RottelaNitrox crypto PMD depend on Nitrox kernel PF driver being installed on the
440a8fc242SNagadheeraj Rottelaplatform. Nitrox PF driver is required to create VF devices which will
450a8fc242SNagadheeraj Rottelabe used by the PMD. Each VF device can enable one cryptodev PMD.
460a8fc242SNagadheeraj Rottela
470a8fc242SNagadheeraj RottelaNitrox kernel PF driver is available as part of CNN55XX-Driver SDK. The SDK
480a8fc242SNagadheeraj Rottelaand it's installation instructions can be obtained from:
490a8fc242SNagadheeraj Rottela`Marvell Technical Documentation Portal <https://support.cavium.com/>`_.
50