path: root/doc/guides/nics/mlx5.rst
diff options
authorAdrien Mazarguil <>2018-07-13 11:40:37 +0200
committerThomas Monjalon <>2018-07-26 14:05:52 +0200
commit20b71e92ef8e0bac42143ae023f12c895829e44e (patch)
tree460cda6570876f58c55e7e643925b10cbdbdae07 /doc/guides/nics/mlx5.rst
parent3edc242d459b57aed3c63311f17a9138bec4b4cb (diff)
net/mlx5: lay groundwork for switch offloads
With mlx5, unlike normal flow rules implemented through Verbs for traffic emitted and received by the application, those targeting different logical ports of the device (VF representors for instance) are offloaded at the switch level and must be configured through Netlink (TC interface). This patch adds preliminary support to manage such flow rules through the flow API (rte_flow). Instead of rewriting tons of Netlink helpers and as previously suggested by Stephen [1], this patch introduces a new dependency to libmnl [2] (LGPL-2.1) when compiling mlx5. [1] [2] Signed-off-by: Adrien Mazarguil <> Acked-by: Nelio Laranjeiro <> Acked-by: Yongseok Koh <>
Diffstat (limited to 'doc/guides/nics/mlx5.rst')
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index ebf2336..4d692fa 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -448,6 +448,12 @@ DPDK and must be installed separately:
This library basically implements send/receive calls to the hardware
+- **libmnl**
+ Minimalistic Netlink library mainly relied on to manage E-Switch flow
+ rules (i.e. those with the "transfer" attribute and typically involving
+ port representors).
- **Kernel modules**
They provide the kernel-side Verbs API and low level device drivers that
@@ -526,6 +532,19 @@ required from that distribution.
this DPDK release was developed and tested against is strongly
recommended. Please check the `prerequisites`_.
+Minimal version for libmnl is **1.0.3**.
+As a dependency of the **iproute2** suite, this library is often installed
+by default. It is otherwise readily available through standard system
+Its development headers must be installed in order to compile this PMD.
+These packages are usually named **libmnl-dev** or **libmnl-devel**
+depending on the Linux distribution.
Supported NICs