doc: add references to flow isolated mode in NICs guide
authorThomas Monjalon <thomas@monjalon.net>
Wed, 30 Jan 2019 11:20:19 +0000 (12:20 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Thu, 31 Jan 2019 17:41:07 +0000 (18:41 +0100)
Some drivers (mlx, mvpp2, sfc) support the flow isolated mode,
but the feature was not advertised.
A reference to the feature description is added for each driver.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Shahaf Shuler <shahafs@mellanox.com>
doc/guides/nics/mlx4.rst
doc/guides/nics/mlx5.rst
doc/guides/nics/mvpp2.rst
doc/guides/nics/sfc_efx.rst
doc/guides/prog_guide/rte_flow.rst

index 4d4842c..4ad361a 100644 (file)
@@ -46,6 +46,8 @@ This capability allows the PMD to coexist with kernel network interfaces
 which remain functional, although they stop receiving unicast packets as
 long as they share the same MAC address.
 
 which remain functional, although they stop receiving unicast packets as
 long as they share the same MAC address.
 
+The :ref:`flow_isolated_mode` is supported.
+
 Compiling librte_pmd_mlx4 causes DPDK to be linked against libibverbs.
 
 Configuration
 Compiling librte_pmd_mlx4 causes DPDK to be linked against libibverbs.
 
 Configuration
index af102f1..0b67496 100644 (file)
@@ -67,7 +67,7 @@ Features
 - Hardware checksum offloads.
 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
   RTE_ETH_FDIR_REJECT).
 - Hardware checksum offloads.
 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
   RTE_ETH_FDIR_REJECT).
-- Flow API.
+- Flow API, including :ref:`flow_isolated_mode`.
 - Multiple process.
 - KVM and VMware ESX SR-IOV modes are supported.
 - RSS hash result is supported.
 - Multiple process.
 - KVM and VMware ESX SR-IOV modes are supported.
 - RSS hash result is supported.
index 9dcb93d..4101d2d 100644 (file)
@@ -410,6 +410,9 @@ Flow API
 
 PPv2 offers packet classification capabilities via classifier engine which
 can be configured via generic flow API offered by DPDK.
 
 PPv2 offers packet classification capabilities via classifier engine which
 can be configured via generic flow API offered by DPDK.
+
+The :ref:`flow_isolated_mode` is supported.
+
 For an additional description please refer to DPDK :doc:`../prog_guide/rte_flow`.
 
 Supported flow actions
 For an additional description please refer to DPDK :doc:`../prog_guide/rte_flow`.
 
 Supported flow actions
index 4006528..028c92c 100644 (file)
@@ -207,6 +207,8 @@ Supported actions:
 
 Validating flow rules depends on the firmware variant.
 
 
 Validating flow rules depends on the firmware variant.
 
+The :ref:`flow_isolated_mode` is supported.
+
 Ethernet destinaton individual/group match
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Ethernet destinaton individual/group match
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
index 472dcef..0203f4f 100644 (file)
@@ -2557,8 +2557,10 @@ Return values:
 
 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
 
 
 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
 
-Isolated mode
--------------
+.. _flow_isolated_mode:
+
+Flow isolated mode
+------------------
 
 The general expectation for ingress traffic is that flow rules process it
 first; the remaining unmatched or pass-through traffic usually ends up in a
 
 The general expectation for ingress traffic is that flow rules process it
 first; the remaining unmatched or pass-through traffic usually ends up in a