[PATCH] doc : update guide and release notes for mlx5

[PATCH] doc : update guide and release notes for mlx5

[Olga Shern]

Signed-off-by: Olga Shern <olgas@mellanox.com>
---
 doc/guides/nics/mlx5.rst               |    7 ++++++-
 doc/guides/rel_notes/release_16_07.rst |   16 +++++++++++++++-
 2 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 063c4a5..1bcb818 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -154,6 +154,11 @@ Run-time configuration
   allows to save PCI bandwidth and improve performance at the cost of a
   slightly higher CPU usage.  Enabled by default.
 
+  Supported on:
+
+  - x86_64 with ConnectX4 and ConnectX4 LX
+  - Power8 with ConnectX4 LX
+
 - ``txq_inline`` parameter [int]
 
   Amount of data to be inlined during TX operations. Improves latency.
@@ -234,7 +239,7 @@ DPDK and must be installed separately:
 
 Currently supported by DPDK:
 
-- Mellanox OFED **3.3-1.0.0.0**.
+- Mellanox OFED **3.3-1.0.0.0** and **3.3-2.0.0.0**
 
 - Minimum firmware version:
 
diff --git a/doc/guides/rel_notes/release_16_07.rst b/doc/guides/rel_notes/release_16_07.rst
index d00a6ed..b48f676 100644
--- a/doc/guides/rel_notes/release_16_07.rst
+++ b/doc/guides/rel_notes/release_16_07.rst
@@ -191,7 +191,21 @@ New Features
 
   Live migration of a VM with Virtio and VF PMD's using the bonding PMD.
 
-
+* **Updated the mlx5 driver.**
+
+  The mlx5 driver was updated with changes including the following:
+
+  * Data path was refactored to bypass Verbs to improve RX and TX performance.
+  * Removed compilation parameters for inline send, MLX5_MAX_INLINE, and
+    added command line parameter instead, txq_inline.
+  * Improved TX scatter gather support: 
+    Removed compilation parameter MLX5_PMD_SGE_WR_N.
+    Scatter-gather elements is set to the maximum value the NIC supports.
+    Removed linearization logic, this decreases the memory consumption of the PMD.
+  * Improved jumbo frames support, by dynamically setting RX scatter gather elements
+    according to the MTU and mbuf size,
+    no need for compilation parameter MLX5_PMD_SGE_WR_N.
+ 
 Resolved Issues
 ---------------
 
-- 
1.7.8.2

Re: [PATCH] doc : update guide and release notes for mlx5

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Olga Shern
> Sent: Tuesday, July 26, 2016 5:29 PM
> To: dev@dpdk.org
> Cc: Olga Shern <olgas@mellanox.com>
> Subject: [dpdk-dev] [PATCH] doc : update guide and release notes for mlx5
> 
> ...
>
> +* **Updated the mlx5 driver.**
> +
> +  The mlx5 driver was updated with changes including the following:
> +
> +  * Data path was refactored to bypass Verbs to improve RX and TX
> performance.
> +  * Removed compilation parameters for inline send, MLX5_MAX_INLINE, and
> +    added command line parameter instead, txq_inline.
> +  * Improved TX scatter gather support:
> +    Removed compilation parameter MLX5_PMD_SGE_WR_N.
> +    Scatter-gather elements is set to the maximum value the NIC supports.
> +    Removed linearization logic, this decreases the memory consumption of
> the PMD.
> +  * Improved jumbo frames support, by dynamically setting RX scatter
> gather elements
> +    according to the MTU and mbuf size,
> +    no need for compilation parameter MLX5_PMD_SGE_WR_N.
> +

Hi,

There are 2 whitespace warnings in the patch. If you resubmit can you also
put the MLX5 variables in ```` fixed width quotes.

Apart from that:

Acked-by: John McNamara <john.mcnamara@intel.com>

[PATCH v2] doc: update guide and release notes for mlx5

[Olga Shern]

Signed-off-by: Olga Shern <olgas@mellanox.com>
---
 doc/guides/nics/mlx5.rst               |    7 ++++++-
 doc/guides/rel_notes/release_16_07.rst |   14 ++++++++++++++
 2 files changed, 20 insertions(+), 1 deletions(-)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 063c4a5..5c10cd3 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -154,6 +154,11 @@ Run-time configuration
   allows to save PCI bandwidth and improve performance at the cost of a
   slightly higher CPU usage.  Enabled by default.
 
+  Supported on:
+
+  - x86_64 with ConnectX4 and ConnectX4 LX
+  - Power8 with ConnectX4 LX
+
 - ``txq_inline`` parameter [int]
 
   Amount of data to be inlined during TX operations. Improves latency.
@@ -234,7 +239,7 @@ DPDK and must be installed separately:
 
 Currently supported by DPDK:
 
-- Mellanox OFED **3.3-1.0.0.0**.
+- Mellanox OFED **3.3-1.0.0.0** and **3.3-2.0.0.0**.
 
 - Minimum firmware version:
 
diff --git a/doc/guides/rel_notes/release_16_07.rst b/doc/guides/rel_notes/release_16_07.rst
index d00a6ed..4b43f8d 100644
--- a/doc/guides/rel_notes/release_16_07.rst
+++ b/doc/guides/rel_notes/release_16_07.rst
@@ -191,6 +191,20 @@ New Features
 
   Live migration of a VM with Virtio and VF PMD's using the bonding PMD.
 
+* **Updated the mlx5 driver.**
+
+  The mlx5 driver was updated with changes including the following:
+
+  * Data path was refactored to bypass Verbs to improve RX and TX performance.
+  * Removed compilation parameters for inline send, ``MLX5_MAX_INLINE``, and
+    added command line parameter instead, ``txq_inline``.
+  * Improved TX scatter gather support:
+    Removed compilation parameter ``MLX5_PMD_SGE_WR_N``.
+    Scatter-gather elements is set to the maximum value the NIC supports.
+    Removed linearization logic, this decreases the memory consumption of the PMD.
+  * Improved jumbo frames support, by dynamically setting RX scatter gather elements
+    according to the MTU and mbuf size,
+    no need for compilation parameter ``MLX5_PMD_SGE_WR_N``
 
 Resolved Issues
 ---------------
-- 
1.7.8.2

Re: [PATCH v2] doc: update guide and release notes for mlx5

[Nélio Laranjeiro]

On Wed, Jul 27, 2016 at 12:27:26PM +0300, Olga Shern wrote:
> Signed-off-by: Olga Shern <olgas@mellanox.com>
> ---
>  doc/guides/nics/mlx5.rst               |    7 ++++++-
>  doc/guides/rel_notes/release_16_07.rst |   14 ++++++++++++++
>  2 files changed, 20 insertions(+), 1 deletions(-)
> 
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index 063c4a5..5c10cd3 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -154,6 +154,11 @@ Run-time configuration
>    allows to save PCI bandwidth and improve performance at the cost of a
>    slightly higher CPU usage.  Enabled by default.
>  
> +  Supported on:
> +
> +  - x86_64 with ConnectX4 and ConnectX4 LX
> +  - Power8 with ConnectX4 LX
> +
>  - ``txq_inline`` parameter [int]
>  
>    Amount of data to be inlined during TX operations. Improves latency.
> @@ -234,7 +239,7 @@ DPDK and must be installed separately:
>  
>  Currently supported by DPDK:
>  
> -- Mellanox OFED **3.3-1.0.0.0**.
> +- Mellanox OFED **3.3-1.0.0.0** and **3.3-2.0.0.0**.
>  
>  - Minimum firmware version:
>  
> diff --git a/doc/guides/rel_notes/release_16_07.rst b/doc/guides/rel_notes/release_16_07.rst
> index d00a6ed..4b43f8d 100644
> --- a/doc/guides/rel_notes/release_16_07.rst
> +++ b/doc/guides/rel_notes/release_16_07.rst
> @@ -191,6 +191,20 @@ New Features
>  
>    Live migration of a VM with Virtio and VF PMD's using the bonding PMD.
>  
> +* **Updated the mlx5 driver.**
> +
> +  The mlx5 driver was updated with changes including the following:
> +
> +  * Data path was refactored to bypass Verbs to improve RX and TX performance.
> +  * Removed compilation parameters for inline send, ``MLX5_MAX_INLINE``, and
> +    added command line parameter instead, ``txq_inline``.
> +  * Improved TX scatter gather support:
> +    Removed compilation parameter ``MLX5_PMD_SGE_WR_N``.
> +    Scatter-gather elements is set to the maximum value the NIC supports.
> +    Removed linearization logic, this decreases the memory consumption of the PMD.
> +  * Improved jumbo frames support, by dynamically setting RX scatter gather elements
> +    according to the MTU and mbuf size,
> +    no need for compilation parameter ``MLX5_PMD_SGE_WR_N``
>  
>  Resolved Issues
>  ---------------
> -- 
> 1.7.8.2

Acked-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>

-- 
Nélio Laranjeiro
6WIND

Re: [PATCH] doc : update guide and release notes for mlx5

[Olga Shern]

Thanks John 
Sent fixed patch including your comments 

Best Regards,
Olga


-----Original Message-----
From: Mcnamara, John [mailto:john.mcnamara@intel.com] 
Sent: Wednesday, July 27, 2016 11:18 AM
To: Olga Shern <olgas@mellanox.com>; dev@dpdk.org
Subject: RE: [dpdk-dev] [PATCH] doc : update guide and release notes for mlx5



> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Olga Shern
> Sent: Tuesday, July 26, 2016 5:29 PM
> To: dev@dpdk.org
> Cc: Olga Shern <olgas@mellanox.com>
> Subject: [dpdk-dev] [PATCH] doc : update guide and release notes for 
> mlx5
> 
> ...
>
> +* **Updated the mlx5 driver.**
> +
> +  The mlx5 driver was updated with changes including the following:
> +
> +  * Data path was refactored to bypass Verbs to improve RX and TX
> performance.
> +  * Removed compilation parameters for inline send, MLX5_MAX_INLINE, and
> +    added command line parameter instead, txq_inline.
> +  * Improved TX scatter gather support:
> +    Removed compilation parameter MLX5_PMD_SGE_WR_N.
> +    Scatter-gather elements is set to the maximum value the NIC supports.
> +    Removed linearization logic, this decreases the memory 
> + consumption of
> the PMD.
> +  * Improved jumbo frames support, by dynamically setting RX scatter
> gather elements
> +    according to the MTU and mbuf size,
> +    no need for compilation parameter MLX5_PMD_SGE_WR_N.
> +

Hi,

There are 2 whitespace warnings in the patch. If you resubmit can you also put the MLX5 variables in ```` fixed width quotes.

Apart from that:

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [PATCH v2] doc: update guide and release notes for mlx5

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Olga Shern
> Sent: Wednesday, July 27, 2016 10:27 AM
> To: dev@dpdk.org
> Cc: Olga Shern <olgas@mellanox.com>
> Subject: [dpdk-dev] [PATCH v2] doc: update guide and release notes for
> mlx5
> 
> Signed-off-by: Olga Shern <olgas@mellanox.com>

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [PATCH v2] doc: update guide and release notes for mlx5

[Thomas Monjalon]

> > Signed-off-by: Olga Shern <olgas@mellanox.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks