From: Adrien Mazarguil <adrien.mazarguil@6wind.com>
Date: Fri, 30 Oct 2015 18:55:19 +0000 (+0100)
Subject: mlx5: update documentation
X-Git-Tag: spdx-start~8240
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=1ca601d160fc9ec56847c772526576f425159991;p=dpdk.git

mlx5: update documentation

Add new features related to Mellanox OFED 3.1 support.

Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
---

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index fdb621c2bd..2d68914408 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -73,6 +73,25 @@ long as they share the same MAC address.
 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
 libibverbs.
 
+Features
+--------
+
+- Multiple TX and RX queues.
+- Support for scattered TX and RX frames.
+- IPv4, TCPv4 and UDPv4 RSS on any number of queues.
+- Several RSS hash keys, one for each flow type.
+- Support for multiple MAC addresses.
+- VLAN filtering.
+- Promiscuous mode.
+
+Limitations
+-----------
+
+- IPv6 and inner VXLAN RSS are not supported yet.
+- Port statistics through software counters only.
+- No allmulticast mode.
+- Hardware checksum offloads are not supported yet.
+
 Configuration
 -------------
 
@@ -171,6 +190,13 @@ DPDK and must be installed separately:
    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
    licensed.
 
+Currently supported by DPDK:
+
+- Mellanox OFED **3.1**.
+- Minimum firmware version:
+  - ConnectX-4: **12.12.0780**.
+  - ConnectX-4 Lx: **14.12.0780**.
+
 Getting Mellanox OFED
 ~~~~~~~~~~~~~~~~~~~~~