update documentation file
cover update documentation file
Hi,
This patchset update the bcmfs.rst file.
Regards,
Vikas
Vikas Gupta (1):
crypto/bcmfs: update documentation file
doc/guides/cryptodevs/bcmfs.rst | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-)
Signature · 1 line
2.17.1
PATCH 1/1 crypto/bcmfs: update documentation file
Update bcmfs.rst file with supported features and devices.
Signed-off-by Vikas Gupta <[email protected]>
Reviewed-by Ajit Khaparde <[email protected]>
Reviewed-by JP Lee <[email protected]>
--- doc/guides/cryptodevs/bcmfs.rst | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-)
doc/guides/cryptodevs/bcmfs.rst +6 -9
@@ -5,7 +5,7 @@ Broadcom FlexSparc Crypto Poll Mode Driver ========================================== The FlexSparc crypto poll mode driver (BCMFS PMD) provides support for offloading -cryptographic operations to the Broadcom SoCs having FlexSparc4/FlexSparc5 unit. +cryptographic operations to the Broadcom SoCs having FlexSparc4 unit. Detailed information about SoCs can be found at `Broadcom Official Website <https://www.broadcom.com/products/ethernet-connectivity/network-adapters/smartnic>`__.
@@ -13,12 +13,11 @@ Supported Broadcom SoCs ----------------------- * Stingray -* Stingray2 Features -------- -The BCMFS SYM PMD has support for: +The BCMFS PMD has support for below symmetric algorithms: Cipher algorithms:
@@ -46,7 +45,6 @@ Hash algorithms: * ``RTE_CRYPTO_AUTH_SHA512`` * ``RTE_CRYPTO_AUTH_SHA512_HMAC`` * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC`` -* ``RTE_CRYPTO_AUTH_AES_CBC_MAC`` * ``RTE_CRYPTO_AUTH_MD5_HMAC`` * ``RTE_CRYPTO_AUTH_AES_GMAC`` * ``RTE_CRYPTO_AUTH_AES_CMAC``
@@ -54,7 +52,6 @@ Hash algorithms: Supported AEAD algorithms: * ``RTE_CRYPTO_AEAD_AES_GCM`` -* ``RTE_CRYPTO_AEAD_AES_CCM`` Installation ------------
@@ -66,7 +63,7 @@ Information about kernel, rootfs and toolchain can be found at To execute BCMFS PMD, it must be compiled with VFIO_PRESENT flag on the compiling platform and same gets enabled in rte_vfio.h. -The BCMFS crypto PMD may be compiled natively on a Stingray/Stingray2 platform or +The BCMFS PMD may be compiled natively on a Stingray platform or cross-compiled on an x86 platform. For example, below commands can be executed for cross compiling on x86 platform.
@@ -94,13 +91,13 @@ For example, below commands can be run to get hold of a device node by VFIO. Limitations ----------- -* Only supports the session-oriented API implementation (session-less APIs are not supported). -* CCM is not supported on Broadcom`s SoCs having FlexSparc4 unit. +* The session-oriented APIs are supported but the session-less APIs are not. +* CCM is not supported. Testing ------- -The symmetric crypto operations on BCMFS crypto PMD may be verified by running the test +The symmetric crypto operations on BCMFS PMD may be verified by running the test application: .. code-block:: console
Signature · 1 line
2.17.1
Akhil Goyal
AppliedRe: [dpdk-dev] [PATCH v1 1/1] crypto/bcmfs: update documentation file
Quoted 6 lines
Subject: [PATCH v1 1/1]
crypto/bcmfs: update documentation fileUpdate
bcmfs.rstfile with supported features and devices.
Title updated " doc: update bcmfs crypto PMD features"
Quoted 4 lines
Signed-off-by Vikas Gupta <[email protected]>Reviewed-by Ajit Khaparde <[email protected]>Reviewed-by JP Lee <[email protected]>---
Applied to dpdk-next-crypto
Thanks.