From 67d48c2c3436b1a54a9edf93d86a6a6a2966e2e0 Mon Sep 17 00:00:00 2001 From: Olga Shern Date: Mon, 14 Dec 2015 20:28:19 +0200 Subject: [PATCH] mlx: fix typos and inaccuracies in docs Signed-off-by: Olga Shern --- doc/guides/nics/mlx4.rst | 10 +++++----- doc/guides/nics/mlx5.rst | 4 ++-- doc/guides/rel_notes/release_2_2.rst | 12 ++++++++++-- 3 files changed, 17 insertions(+), 9 deletions(-) diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index 62f0c31eb9..7757013072 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -31,8 +31,8 @@ MLX4 poll mode driver library ============================= The MLX4 poll mode driver library (**librte_pmd_mlx4**) implements support -for **Mellanox ConnectX-3 EN** 10/40 Gbps adapters as well as their virtual -functions (VF) in SR-IOV context. +for **Mellanox ConnectX-3** and **Mellanox ConnectX-3 Pro** 10/40 Gbps adapters +as well as their virtual functions (VF) in SR-IOV context. Information and documentation about this family of adapters can be found on the `Mellanox website `_. Help is also provided by @@ -79,7 +79,7 @@ long as they share the same MAC address. Compiling librte_pmd_mlx4 causes DPDK to be linked against libibverbs. Features ---------- +-------- - RSS, also known as RCA, is supported. In this mode the number of configured RX queues must be a power of two. @@ -101,7 +101,7 @@ Limitations - RSS always includes L3 (IPv4/IPv6) and L4 (UDP/TCP). They cannot be dissociated. - Hardware counters are not implemented (they are software counters). -- Secondary process RX is not supported +- Secondary process RX is not supported. Configuration ------------- @@ -279,7 +279,7 @@ devices managed by librte_pmd_mlx4. modprobe -a ib_uverbs mlx4_en mlx4_core mlx4_ib - Alternatively if MLNX_OFED is fully installed, the follwoing script can + Alternatively if MLNX_OFED is fully installed, the following script can be run: .. code-block:: console diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 1f700fc1ff..b2a12ce6a3 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -31,7 +31,7 @@ MLX5 poll mode driver ===================== The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support for -**Mellanox ConnectX-4 EN** and **Mellanox ConnectX-4 Lx EN** families of +**Mellanox ConnectX-4** and **Mellanox ConnectX-4 Lx** families of 10/25/40/50/100 Gb/s adapters as well as their virtual functions (VF) in SR-IOV context. @@ -284,7 +284,7 @@ devices managed by librte_pmd_mlx5. modprobe -a ib_uverbs mlx5_core mlx5_ib - Alternatively if MLNX_OFED is fully installed, the follwoing script can + Alternatively if MLNX_OFED is fully installed, the following script can be run: .. code-block:: console diff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst index c0f3be264c..4fa11ddb85 100644 --- a/doc/guides/rel_notes/release_2_2.rst +++ b/doc/guides/rel_notes/release_2_2.rst @@ -390,7 +390,7 @@ Drivers * **mlx4: Fixed Tx loss after initialization.** -* **mlx4: Fixed scattered Tx with too many segments.** +* **mlx4: Fixed scattered Tx with too many segments.** * **mlx4: Fixed memory registration for indirect mbuf data.** @@ -455,9 +455,12 @@ Known Issues PF reset in host side. The workaround is to avoid triggering any PF reset events/requests on host side. +* 100G link report support is missing. + * **Mellanox PMDs (mlx4 & mlx5):** - * PMDs do not support DPDK integrated shared library. + * PMDs do not support CONFIG_RTE_BUILD_COMBINE_LIBS and + CONFIG_RTE_BUILD_SHARED_LIB simultaneously. * There is performance degradation for small packets when PMD is compiled with SGE_WR_N = 4 compared to the performance when SGE_WR_N = 1. @@ -467,6 +470,11 @@ Known Issues * When a Multicast or Broadcast packet is sent to the SR-IOV mlx4 VF, it is returned back to the port. + * PMDs report "bad" L4 checksum when IP packet is received. + + * mlx5 PMD reports "bad" checksum although the packet has "good" checksum. + Will be fixed in upcoming MLNX_OFED release. + API Changes ----------- -- 2.20.1