[dpdk-dev] doc: update mlx5 guide
Checks
Commit Message
Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
---
doc/guides/nics/mlx5.rst | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
Comments
On Sun, Oct 29, 2017 at 01:49:42PM +0200, Shahaf Shuler wrote:
> Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> ---
> doc/guides/nics/mlx5.rst | 18 +++++++++++-------
> 1 file changed, 11 insertions(+), 7 deletions(-)
>
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index cdb880a4c..0aaf80f94 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -99,6 +99,7 @@ Features
> - Hardware checksum TX offload for VXLAN and GRE.
> - RX interrupts.
> - Statistics query including Basic, Extended and per queue.
> +- Rx HW timestamp.
>
> Limitations
> -----------
> @@ -129,6 +130,7 @@ Limitations
> is set to multi-packet send or Enhanced multi-packet send. Otherwise it must have
> less than 50 segments.
> - Count action for RTE flow is only supported in Mellanox OFED 4.2.
> +- VXLAN TSO and checksum offloads are not supported on VM.
>
> Configuration
> -------------
> @@ -353,8 +355,10 @@ releases.
> RMDA Core with Linux Kernel
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> -- Minimal kernel version : 4.13-rc4 (see `Linux installation documentation`_)
> -- Minimal rdma-core version: v15 (see `RDMA Core installation documentation`_)
> +- Minimal kernel version : 4.14-rc6+ commit 25a5d23b4799 ("Merge tag 'kbuild-fixes-v4.14-2' of git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy/linux-kbuild")
According to http://www.kernel.org/, the v4.14-rc7 is out, don't it have
everything needed?
And why not simply put v4.14?
> + (see `Linux installation documentation`_)
> +- Minimal rdma-core version: v15+ commit f967fd5e38c7 ("Merge pull request #231 from rleon/topic/fix-cplusplus")
> + (see `RDMA Core installation documentation`_)
>
> .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
> .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
> @@ -365,10 +369,10 @@ Mellanox OFED
> - Mellanox OFED version: **4.2**.
> - firmware version:
>
> - - ConnectX-4: **12.20.1010** and above.
> - - ConnectX-4 Lx: **14.20.1010** and above.
> - - ConnectX-5: **16.20.1010** and above.
> - - ConnectX-5 Ex: **16.20.1010** and above.
> + - ConnectX-4: **12.21.1000** and above.
> + - ConnectX-4 Lx: **14.21.1000** and above.
> + - ConnectX-5: **16.21.1000** and above.
> + - ConnectX-5 Ex: **16.21.1000** and above.
>
> While these libraries and kernel modules are available on OpenFabrics
> Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
> @@ -421,7 +425,7 @@ Quick Start Guide on OFED
>
> .. code-block:: console
>
> - ./mlnxofedinstall
> + ./mlnxofedinstall --upstream-libs --dpdk
>
> 3. Verify the firmware is the correct one:
>
> --
> 2.12.0
Regards,
Monday, October 30, 2017 10:22 AM, Nélio Laranjeiro:
> On Sun, Oct 29, 2017 at 01:49:42PM +0200, Shahaf Shuler wrote:
> > @@ -353,8 +355,10 @@ releases.
> > RMDA Core with Linux Kernel
> > ^^^^^^^^^^^^^^^^^^^^^^^^^^^
> >
> > -- Minimal kernel version : 4.13-rc4 (see `Linux installation
> > documentation`_)
> > -- Minimal rdma-core version: v15 (see `RDMA Core installation
> > documentation`_)
> > +- Minimal kernel version : 4.14-rc6+ commit 25a5d23b4799 ("Merge tag
> > +'kbuild-fixes-v4.14-2' of
> > +git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy/linux-kbuild"
> > +)
>
> According to
> https://emea01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fww
> w.kernel.org%2F&data=02%7C01%7Cshahafs%40mellanox.com%7C92970b5a
> 32d049cad1ac08d51f6f59de%7Ca652971c7d2e4d9ba6a4d149256f461b%7C0%
> 7C0%7C636449485478543975&sdata=Qw5faaoaRZbvzPlrGBKJrpg6dXZD8u1uz
> 6TMwKVJyTc%3D&reserved=0, the v4.14-rc7 is out, don't it have everything
> needed?
It has. When I release this patch it wasn't present yet.
>
> And why not simply put v4.14?
The point is the v4.14 is expected to be released on the 12/11 according to http://phb-crystal-ball.org/
So we may have a week on which there is no upstream kernel which supports mlx5.
At second thought - since we are not yet on rc3 it may be OK.
>
> > + (see `Linux installation documentation`_)
> > +- Minimal rdma-core version: v15+ commit f967fd5e38c7 ("Merge pull
> > +request #231 from rleon/topic/fix-cplusplus")
> > + (see `RDMA Core installation documentation`_)
> >
> > .. _`Linux installation documentation`:
> >
> https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit
> > .kernel.org%2Fpub%2Fscm%2Flinux%2Fkernel%2Fgit%2Fstable%2Flinux-
> stable
> > .git%2Fplain%2FDocumentation%2Fadmin-
> guide%2FREADME.rst&data=02%7C01%7
> >
> Cshahafs%40mellanox.com%7C92970b5a32d049cad1ac08d51f6f59de%7Ca652
> 971c7
> >
> d2e4d9ba6a4d149256f461b%7C0%7C0%7C636449485478543975&sdata=MKU
> bb2GjH9z
> > PsaQ14LnaMODAI8jOg1horwqRzSUroZA%3D&reserved=0
> > .. _`RDMA Core installation documentation`:
> >
> https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fra
> w
> > .githubusercontent.com%2Flinux-rdma%2Frdma-
> core%2Fmaster%2FREADME.md&d
> >
> ata=02%7C01%7Cshahafs%40mellanox.com%7C92970b5a32d049cad1ac08d51
> f6f59d
> >
> e%7Ca652971c7d2e4d9ba6a4d149256f461b%7C0%7C0%7C6364494854785439
> 75&sdat
> >
> a=DP6n%2FH7kgbbbctXfr5mgiJPelHfKgtMQMYrSHy7yA1Q%3D&reserved=0
> > @@ -365,10 +369,10 @@ Mellanox OFED
> > - Mellanox OFED version: **4.2**.
> > - firmware version:
> >
> > - - ConnectX-4: **12.20.1010** and above.
> > - - ConnectX-4 Lx: **14.20.1010** and above.
> > - - ConnectX-5: **16.20.1010** and above.
> > - - ConnectX-5 Ex: **16.20.1010** and above.
> > + - ConnectX-4: **12.21.1000** and above.
> > + - ConnectX-4 Lx: **14.21.1000** and above.
> > + - ConnectX-5: **16.21.1000** and above.
> > + - ConnectX-5 Ex: **16.21.1000** and above.
> >
> > While these libraries and kernel modules are available on OpenFabrics
> > Alliance's `website
> >
> <https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fw
> w
> >
> w.openfabrics.org%2F&data=02%7C01%7Cshahafs%40mellanox.com%7C929
> 70b5a3
> >
> 2d049cad1ac08d51f6f59de%7Ca652971c7d2e4d9ba6a4d149256f461b%7C0%7
> C0%7C6
> >
> 36449485478543975&sdata=Wk5DpTB8LkYm3%2F6Xdv91aZxa%2FwOWNp4T7
> L5EJxPZcS
> > E%3D&reserved=0>`__ and provided by package @@ -421,7 +425,7 @@
> Quick
> > Start Guide on OFED
> >
> > .. code-block:: console
> >
> > - ./mlnxofedinstall
> > + ./mlnxofedinstall --upstream-libs --dpdk
> >
> > 3. Verify the firmware is the correct one:
> >
> > --
> > 2.12.0
>
> Regards,
>
> --
> Nélio Laranjeiro
> 6WIND
@@ -99,6 +99,7 @@ Features
- Hardware checksum TX offload for VXLAN and GRE.
- RX interrupts.
- Statistics query including Basic, Extended and per queue.
+- Rx HW timestamp.
Limitations
-----------
@@ -129,6 +130,7 @@ Limitations
is set to multi-packet send or Enhanced multi-packet send. Otherwise it must have
less than 50 segments.
- Count action for RTE flow is only supported in Mellanox OFED 4.2.
+- VXLAN TSO and checksum offloads are not supported on VM.
Configuration
-------------
@@ -353,8 +355,10 @@ releases.
RMDA Core with Linux Kernel
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- Minimal kernel version : 4.13-rc4 (see `Linux installation documentation`_)
-- Minimal rdma-core version: v15 (see `RDMA Core installation documentation`_)
+- Minimal kernel version : 4.14-rc6+ commit 25a5d23b4799 ("Merge tag 'kbuild-fixes-v4.14-2' of git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy/linux-kbuild")
+ (see `Linux installation documentation`_)
+- Minimal rdma-core version: v15+ commit f967fd5e38c7 ("Merge pull request #231 from rleon/topic/fix-cplusplus")
+ (see `RDMA Core installation documentation`_)
.. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
.. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
@@ -365,10 +369,10 @@ Mellanox OFED
- Mellanox OFED version: **4.2**.
- firmware version:
- - ConnectX-4: **12.20.1010** and above.
- - ConnectX-4 Lx: **14.20.1010** and above.
- - ConnectX-5: **16.20.1010** and above.
- - ConnectX-5 Ex: **16.20.1010** and above.
+ - ConnectX-4: **12.21.1000** and above.
+ - ConnectX-4 Lx: **14.21.1000** and above.
+ - ConnectX-5: **16.21.1000** and above.
+ - ConnectX-5 Ex: **16.21.1000** and above.
While these libraries and kernel modules are available on OpenFabrics
Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
@@ -421,7 +425,7 @@ Quick Start Guide on OFED
.. code-block:: console
- ./mlnxofedinstall
+ ./mlnxofedinstall --upstream-libs --dpdk
3. Verify the firmware is the correct one: