diff mbox series

[ovs-dev,v11,7/7] Documentation: document ovs-dpdk flow offload

Message ID ded3616a7b4ac76d0babc8e2d2aa374580d01ad2.1529931922.git.shahafs@mellanox.com
State Accepted
Delegated to: Ian Stokes
Headers show
Series OVS-DPDK flow offload with rte_flow | expand

Commit Message

Shahaf Shuler June 25, 2018, 1:21 p.m. UTC
From: Yuanhan Liu <yliu@fridaylinux.org>

Add details in the DPDK howto guide on the way to enable the offload along
with the supported NICs and flow types.

The flow offload is marked as experimental.

Signed-off-by: Yuanhan Liu <yliu@fridaylinux.org>
Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
---
 Documentation/howto/dpdk.rst | 22 ++++++++++++++++++++++
 NEWS                         |  2 +-
 2 files changed, 23 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst
index 380181db0..82596f557 100644
--- a/Documentation/howto/dpdk.rst
+++ b/Documentation/howto/dpdk.rst
@@ -358,6 +358,28 @@  devices to bridge ``br0``. Once complete, follow the below steps:
 
        $ cat /proc/interrupts | grep virtio
 
+.. _dpdk-flow-hardware-offload:
+
+Flow Hardware Offload (Experimental)
+------------------------------------
+
+The flow hardware offload is disabled by default and can be enabled by::
+
+    $ ovs-vsctl set Open_vSwitch . other_config:hw-offload=true
+
+So far only partial flow offload is implemented. Moreover, it only works
+with PMD drivers have the rte_flow action "MARK + RSS" support.
+
+The validated NICs are:
+
+- Mellanox (ConnectX-4, ConnectX-4 Lx, ConnectX-5)
+- Napatech (NT200B01)
+
+Supported protocols for hardware offload are:
+- L2: Ethernet, VLAN
+- L3: IPv4, IPv6
+- L4: TCP, UDP, SCTP, ICMP
+
 Further Reading
 ---------------
 
diff --git a/NEWS b/NEWS
index cd15a332c..74dca1516 100644
--- a/NEWS
+++ b/NEWS
@@ -34,6 +34,7 @@  Post-v2.9.0
        See Testing topic for the details.
      * Add LSC interrupt support for DPDK physical devices.
      * Allow init to fail and record DPDK status/version in OVS database.
+     * Add experimental flow hardware offload support
    - Userspace datapath:
      * Commands ovs-appctl dpif-netdev/pmd-*-show can now work on a single PMD
      * Detailed PMD performance metrics available with new command
@@ -110,7 +111,6 @@  v2.9.0 - 19 Feb 2018
      * New appctl command 'dpif-netdev/pmd-rxq-rebalance' to rebalance rxq to
        pmd assignments.
      * Add rxq utilization of pmd to appctl 'dpif-netdev/pmd-rxq-show'.
-     * Add support for vHost dequeue zero copy (experimental)
    - Userspace datapath:
      * Output packet batching support.
    - vswitchd: