xref: /f-stack/dpdk/doc/guides/cryptodevs/nitrox.rst (revision 2d9fd380)
14418919fSjohnjiang..  SPDX-License-Identifier: BSD-3-Clause
24418919fSjohnjiang    Copyright(C) 2019 Marvell International Ltd.
34418919fSjohnjiang
44418919fSjohnjiangMarvell NITROX Crypto Poll Mode Driver
54418919fSjohnjiang======================================
64418919fSjohnjiang
74418919fSjohnjiangThe Nitrox crypto poll mode driver provides support for offloading
84418919fSjohnjiangcryptographic operations to the NITROX V security processor. Detailed
94418919fSjohnjianginformation about the NITROX V security processor can be obtained here:
104418919fSjohnjiang
114418919fSjohnjiang* https://www.marvell.com/security-solutions/nitrox-security-processors/nitrox-v/
124418919fSjohnjiang
134418919fSjohnjiangFeatures
144418919fSjohnjiang--------
154418919fSjohnjiang
164418919fSjohnjiangNitrox crypto PMD has support for:
174418919fSjohnjiang
184418919fSjohnjiangCipher algorithms:
194418919fSjohnjiang
204418919fSjohnjiang* ``RTE_CRYPTO_CIPHER_AES_CBC``
21*2d9fd380Sjfb8856606* ``RTE_CRYPTO_CIPHER_3DES_CBC``
224418919fSjohnjiang
234418919fSjohnjiangHash algorithms:
244418919fSjohnjiang
254418919fSjohnjiang* ``RTE_CRYPTO_AUTH_SHA1_HMAC``
264418919fSjohnjiang* ``RTE_CRYPTO_AUTH_SHA224_HMAC``
274418919fSjohnjiang* ``RTE_CRYPTO_AUTH_SHA256_HMAC``
284418919fSjohnjiang
29*2d9fd380Sjfb8856606Supported AEAD algorithms:
30*2d9fd380Sjfb8856606
31*2d9fd380Sjfb8856606* ``RTE_CRYPTO_AEAD_AES_GCM``
32*2d9fd380Sjfb8856606
334418919fSjohnjiangLimitations
344418919fSjohnjiang-----------
354418919fSjohnjiang
364418919fSjohnjiang* Session-less APIs are not supported.
374418919fSjohnjiang
384418919fSjohnjiang
394418919fSjohnjiangInitialization
404418919fSjohnjiang--------------
414418919fSjohnjiang
424418919fSjohnjiangNitrox crypto PMD depend on Nitrox kernel PF driver being installed on the
434418919fSjohnjiangplatform. Nitrox PF driver is required to create VF devices which will
444418919fSjohnjiangbe used by the PMD. Each VF device can enable one cryptodev PMD.
454418919fSjohnjiang
464418919fSjohnjiangNitrox kernel PF driver is available as part of CNN55XX-Driver SDK. The SDK
474418919fSjohnjiangand it's installation instructions can be obtained from:
484418919fSjohnjiang`Marvell Technical Documentation Portal <https://support.cavium.com/>`_.
49