diff mbox series

[28/28] doc: update MLX5 doc and release notes with LRO

Message ID	1563786795-14027-29-git-send-email-matan@mellanox.com (mailing list archive)
State	Superseded, archived
Delegated to:	Raslan Darawsheh
Headers	From: Matan Azrad <matan@mellanox.com> To: Shahaf Shuler <shahafs@mellanox.com>, Yongseok Koh <yskoh@mellanox.com>, Viacheslav Ovsiienko <viacheslavo@mellanox.com> Cc: dev@dpdk.org, Dekel Peled <dekelp@mellanox.com> Date: Mon, 22 Jul 2019 09:13:15 +0000 Message-Id: <1563786795-14027-29-git-send-email-matan@mellanox.com> In-Reply-To: <1563786795-14027-1-git-send-email-matan@mellanox.com> References: <1563786795-14027-1-git-send-email-matan@mellanox.com> Subject: [dpdk-dev] [PATCH 28/28] doc: update MLX5 doc and release notes with LRO Precedence: list Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org>
Series	net/mlx5: support LRO \| [00/28] net/mlx5: support LRO [01/28] net/mlx5: remove redundant item from union [02/28] net/mlx5: add LRO APIs and initial settings [03/28] net/mlx5: support LRO caps query using devx API [04/28] net/mlx5: glue func for queue query using new API [05/28] net/mlx5: glue function for action using new API [06/28] net/mlx5: check conditions to enable LRO [07/28] net/mlx5: support Tx interface query using new API [08/28] net/mlx5: update Tx queue create for LRO [09/28] net/mlx5: create advanced RxQ object using new API [10/28] net/mlx5: modify advanced RxQ object using new API [11/28] net/mlx5: create advanced Rx object using new API [12/28] net/mlx5: create advanced RxQ table using new API [13/28] net/mlx5: allocate door-bells using new API [14/28] net/mlx5: rename RxQ verbs to general RxQ object [15/28] net/mlx5: rename verbs indirection table to obj [16/28] net/mlx5: rename hash RxQ verbs to general [17/28] net/mlx5: update queue state modify function [18/28] net/mlx5: store protection domain number on create [19/28] net/mlx5: func to create Rx verbs completion queue [20/28] net/mlx5: function to create Rx verbs work queue [21/28] net/mlx5: create advanced RxQ using new API [22/28] net/mlx5: support LRO with single RxQ object [23/28] net/mlx5: replace the external mbuf shared memory [24/28] net/mlx5: update LRO fields in completion entry [25/28] net/mlx5: handle LRO packets in Rx queue [26/28] net/mlx5: zero the LRO mbuf headroom [27/28] net/mlx5: adjust the maximum LRO message size [28/28] doc: update MLX5 doc and release notes with LRO

Checks

Context	Check	Description
ci/checkpatch	success	coding style OK
ci/Intel-compilation	success	Compilation OK

Commit Message

Matan Azrad July 22, 2019, 9:13 a.m. UTC

  From: Dekel Peled <dekelp@mellanox.com>

Add documentation of LRO feature.

Signed-off-by: Dekel Peled <dekelp@mellanox.com>
Acked-by: Matan Azrad <matan@mellanox.com>
---
 doc/guides/nics/features/mlx5.ini      |  1 +
 doc/guides/nics/mlx5.rst               | 14 ++++++++++++++
 doc/guides/rel_notes/release_19_08.rst |  2 +-
 3 files changed, 16 insertions(+), 1 deletion(-)

Comments

Slava Ovsiienko July 22, 2019, 9:23 a.m. UTC | #1

> -----Original Message-----
> From: Matan Azrad <matan@mellanox.com>
> Sent: Monday, July 22, 2019 12:13
> To: Shahaf Shuler <shahafs@mellanox.com>; Yongseok Koh
> <yskoh@mellanox.com>; Slava Ovsiienko <viacheslavo@mellanox.com>
> Cc: dev@dpdk.org; Dekel Peled <dekelp@mellanox.com>
> Subject: [PATCH 28/28] doc: update MLX5 doc and release notes with LRO
> 
> From: Dekel Peled <dekelp@mellanox.com>
> 
> Add documentation of LRO feature.
> 
> Signed-off-by: Dekel Peled <dekelp@mellanox.com>
> Acked-by: Matan Azrad <matan@mellanox.com>

Acked-by: Viacheslav Ovsiienko <viacheslavo@mellanox.com>

diff mbox series

Patch

diff --git a/doc/guides/nics/features/mlx5.ini b/doc/guides/nics/features/mlx5.ini
index f7e7358..c0ebdbd 100644
--- a/doc/guides/nics/features/mlx5.ini
+++ b/doc/guides/nics/features/mlx5.ini
@@ -13,6 +13,7 @@  Queue start/stop     = Y
 MTU update           = Y
 Jumbo frame          = Y
 Scattered Rx         = Y
+LRO                  = Y
 TSO                  = Y
 Promiscuous mode     = Y
 Allmulticast mode    = Y
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7e87344..85d96be 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -82,6 +82,7 @@  Features
   increment/decrement, count, drop, mark. For details please see :ref:`Supported hardware offloads using rte_flow API`.
 - Flow insertion rate of more then million flows per second, when using Direct Rules.
 - Support for multiple rte_flow groups.
+- Hardware LRO.
 
 Limitations
 -----------
@@ -162,6 +163,11 @@  Limitations
 
 - ICMP/ICMP6 code/type matching cannot be supported togeter with IP-in-IP tunnel.
 
+- LRO:
+
+  - No mbuf head-room space is created for RX packets when LRO is configured.
+  - scatter_fcs is disabled  when LRO is configured.
+
 Statistics
 ----------
 
@@ -556,6 +562,14 @@  Run-time configuration
 
   set to 128 by default.
 
+- ``lro_timeout_usec`` parameter [int]
+
+  The maximum allowed duration of an LRO session, in micro-seconds.
+  PMD will set the nearest value supported by HW, which is not bigger than
+  the input lro_timeout_usec value.
+  If this parameter is not specified, by default PMD will set the smallest value
+  supported by HW.
+
 Firmware configuration
 ~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/doc/guides/rel_notes/release_19_08.rst b/doc/guides/rel_notes/release_19_08.rst
index 6c382cb..d8676b6 100644
--- a/doc/guides/rel_notes/release_19_08.rst
+++ b/doc/guides/rel_notes/release_19_08.rst
@@ -117,7 +117,7 @@  New Features
   * Accelerate flows with count action creation and destroy.
   * Accelerate flows counter query.
   * Improve Tx datapath improves performance with enabled HW offloads.
-
+  * Added support for LRO.
 
 * **Updated Solarflare network PMD.**