[dpdk-dev,v2] doc: added inline crypto feature
Checks
Commit Message
Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
---
v2: removed useless anchor and updated ixgbe doc
doc/guides/nics/features.rst | 15 +++++++++++++++
doc/guides/nics/features/default.ini | 1 +
doc/guides/nics/features/ixgbe.ini | 2 ++
doc/guides/nics/features/ixgbe_vec.ini | 2 ++
doc/guides/nics/features/ixgbe_vf.ini | 2 ++
doc/guides/nics/features/ixgbe_vf_vec.ini | 2 ++
doc/guides/nics/ixgbe.rst | 15 +++++++++++++++
7 files changed, 39 insertions(+)
@@ -900,6 +900,21 @@ Documentation describes performance values.
See ``dpdk.org/doc/perf/*``.
+Inline crypto
+-------------
+
+Supports inline crypto processing (eg. inline IPsec). See Security library and PMD documentation for more details.
+
+* **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SECURITY``,
+* **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_SECURITY``.
+* **[implements] rte_security_ops**: ``session_create``, ``session_update``,
+ ``session_stats_get``, ``session_destroy``, ``set_pkt_metadata``, ``capabilities_get``.
+* **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_SECURITY``,
+ ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_SECURITY``.
+* **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD``,
+ ``mbuf.ol_flags:PKT_TX_SEC_OFFLOAD``, ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD_FAILED``.
+
+
.. _nic_features_other:
@@ -77,3 +77,4 @@ Usage doc =
Design doc =
Perf doc =
Mbuf fast free =
+Inline crypto =
@@ -58,3 +58,5 @@ Linux VFIO = Y
ARMv8 = Y
x86-32 = Y
x86-64 = Y
+Inline crypto = Y
+
@@ -47,3 +47,5 @@ Linux VFIO = Y
ARMv8 = Y
x86-32 = Y
x86-64 = Y
+Inline crypto = Y
+
@@ -37,3 +37,5 @@ Linux VFIO = Y
ARMv8 = Y
x86-32 = Y
x86-64 = Y
+Inline crypto = Y
+
@@ -29,3 +29,5 @@ Linux VFIO = Y
ARMv8 = Y
x86-32 = Y
x86-64 = Y
+Inline crypto = Y
+
@@ -239,6 +239,21 @@ There is no RTE API to add a VF's MAC address from the PF. On ixgbe, the
as a workaround.
+Inline crypto processing support
+---------------------------
+
+Inline IPsec processing is supported for ``RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO``
+mode for ESP packets only:
+
+- ESP authentication only: AES-128-GMAC (128-bit key)
+- ESP encryption and authentication: AES-128-GCM (128-bit key)
+
+IPsec Security Gateway Sample Application supports inline IPsec processing for
+ixgbe PMD.
+For more details see the IPsec Security Gateway Sample Application and Security
+library documentation.
+
+
Supported Chipsets and NICs
---------------------------