Added FreeBSD prerequisites, limitations and features supported.
---
doc/guides/nics/mlx5.rst | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index bae73f42d8..cf6d1e70f6 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -133,6 +133,25 @@ Limitations
- IPv4/TCP with CVLAN filtering
- L4 steering rules for port RSS of UDP, TCP and IP
+- FreeBSD support:
+
+ On FreeBSD, only SRIOV interface is supported along with the following
features:
+
+ - Hypervisors: KVM, ESXi and Azure/HyperV
+ - Multiple Tx and Rx queues
+ - Support for scattered Tx and Rx frames
+ - RSS
+ - VLAN filtering, stripping and insertion
+ - RX CRC stripping configuration
+ - Promiscuous and Multicast mode
+ - Statistics query including Basic, Extended, and per queue.
+ - Configurable MTU and MAC
+ - Jumbo frame support
+ - Trust mode support
+ - Vxlan
+ - QoS
+ - Flow steering
+
- For secondary process:
- Forked secondary process not supported.
@@ -1340,6 +1359,17 @@ DevX for Windows must be enabled in the Windows registry.
The keys ``DevxEnabled`` and ``DevxFsRules`` must be set.
Additional information can be found in the WinOF2 user manual.
+FreeBSD Prerequisites
+---------------------
+
+Currently there is an ongoing review of FreeBSD OFED drivers and RDMA-core
libraries.
+Their status can be tracked at
+`OFED Review <https://reviews.freebsd.org/p/vag.singh_oneconvergence.com/>`__.
+
+The FreeBSD MLX5 PMD requires these OFED changes to run.
+To build successfully, file ``/usr/include/infiniband/mlx5dv.h`` should be
present. It
+is generally missing on FreeBSD.
+
Supported NICs
--------------
--
2.30.2
