net/hns3: increase readability in logs

[dpdk.git] / doc / guides / cryptodevs / bcmfs.rst

diff --git a/doc/guides/cryptodevs/bcmfs.rst b/doc/guides/cryptodevs/bcmfs.rst
index 0ed1a06..f5dcd59 100644 (file)
--- a/doc/guides/cryptodevs/bcmfs.rst
+++ b/doc/guides/cryptodevs/bcmfs.rst
@@ -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,7 +13,45 @@ Supported Broadcom SoCs
 -----------------------
 
 * Stingray
-* Stingray2
+
+Features
+--------
+
+The BCMFS PMD has support for below symmetric algorithms:
+
+Cipher algorithms:
+
+* ``RTE_CRYPTO_CIPHER_3DES_CBC``
+* ``RTE_CRYPTO_CIPHER_3DES_CTR``
+* ``RTE_CRYPTO_CIPHER_AES128_CBC``
+* ``RTE_CRYPTO_CIPHER_AES192_CBC``
+* ``RTE_CRYPTO_CIPHER_AES256_CBC``
+* ``RTE_CRYPTO_CIPHER_AES128_CTR``
+* ``RTE_CRYPTO_CIPHER_AES192_CTR``
+* ``RTE_CRYPTO_CIPHER_AES256_CTR``
+* ``RTE_CRYPTO_CIPHER_AES_XTS``
+* ``RTE_CRYPTO_CIPHER_DES_CBC``
+
+Hash algorithms:
+
+* ``RTE_CRYPTO_AUTH_SHA1``
+* ``RTE_CRYPTO_AUTH_SHA1_HMAC``
+* ``RTE_CRYPTO_AUTH_SHA224``
+* ``RTE_CRYPTO_AUTH_SHA224_HMAC``
+* ``RTE_CRYPTO_AUTH_SHA256``
+* ``RTE_CRYPTO_AUTH_SHA256_HMAC``
+* ``RTE_CRYPTO_AUTH_SHA384``
+* ``RTE_CRYPTO_AUTH_SHA384_HMAC``
+* ``RTE_CRYPTO_AUTH_SHA512``
+* ``RTE_CRYPTO_AUTH_SHA512_HMAC``
+* ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
+* ``RTE_CRYPTO_AUTH_MD5_HMAC``
+* ``RTE_CRYPTO_AUTH_AES_GMAC``
+* ``RTE_CRYPTO_AUTH_AES_CMAC``
+
+Supported AEAD algorithms:
+
+* ``RTE_CRYPTO_AEAD_AES_GCM``
 
 Installation
 ------------
@@ -25,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.
 
@@ -49,3 +87,20 @@ For example, below commands can be run to get hold of a device node by VFIO.
     io_device_name="vfio-platform"
     echo $io_device_name > /sys/bus/platform/devices/${SETUP_SYSFS_DEV_NAME}/driver_override
     echo ${SETUP_SYSFS_DEV_NAME} > /sys/bus/platform/drivers_probe
+
+Limitations
+-----------
+
+* The session-oriented APIs are supported but the session-less APIs are not.
+* CCM is not supported.
+
+Testing
+-------
+
+The symmetric crypto operations on BCMFS PMD may be verified by running the test
+application:
+
+.. code-block:: console
+
+    ./dpdk-test
+    RTE>>cryptodev_bcmfs_autotest