net/af_xdp: enable custom XDP program loading

[dpdk.git] / doc / guides / nics / mlx5.rst

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 00427b0..b0614ae 100644 (file)
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -253,6 +253,14 @@ Limitations
   reported via device xstats to assist applications to detect the
   time-related problems.
 
   reported via device xstats to assist applications to detect the
   time-related problems.
 

+  The timestamp upper "too-distant-future" limit
+  at the moment of invoking the Tx burst routine
+  can be estimated as ``tx_pp`` option (in nanoseconds) multiplied by 2^23.
+  Please note, for the testpmd txonly mode,
+  the limit is deduced from the expression::
+
+        (n_tx_descriptors / burst_size + 1) * inter_burst_gap
+

   There is no any packet reordering according timestamps is supposed,
   neither within packet burst, nor between packets, it is an entirely
   application responsibility to generate packets and its timestamps
   There is no any packet reordering according timestamps is supposed,
   neither within packet burst, nor between packets, it is an entirely
   application responsibility to generate packets and its timestamps


@@ -297,6 +305,12 @@ Limitations
 
     Other TCP packets (e.g. with MPLS label) received on Rx queue with LRO enabled, will be received with bad checksum.
 
 
     Other TCP packets (e.g. with MPLS label) received on Rx queue with LRO enabled, will be received with bad checksum.
 

+- CRC:
+
+  - ``DEV_RX_OFFLOAD_KEEP_CRC`` cannot be supported with decapsulation
+    for some NICs (such as ConnectX-6 Dx and BlueField 2).
+    The capability bit ``scatter_fcs_w_decap_disable`` shows NIC support.
+

 Statistics
 ----------
 
 Statistics
 ----------
 


@@ -923,6 +937,15 @@ Driver options
 
   By default, the PMD will set this value to 0.
 
 
   By default, the PMD will set this value to 0.
 

+- ``decap_en`` parameter [int]
+
+  Some devices do not support FCS (frame checksum) scattering for
+  tunnel-decapsulated packets.
+  If set to 0, this option forces the FCS feature and rejects tunnel
+  decapsulation in the flow engine for such devices.
+
+  By default, the PMD will set this value to 1.
+

 .. _mlx5_firmware_config:
 
 Firmware configuration
 .. _mlx5_firmware_config:
 
 Firmware configuration


@@ -1224,8 +1247,8 @@ Quick Start Guide on OFED/EN
 
         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
 
 
         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
 

-6. Compile DPDK and you are ready to go. See instructions on
-   :ref:`Development Kit Build System <Development_Kit_Build_System>`
+6. Install DPDK and you are ready to go.
+   See :doc:`compilation instructions <../linux_gsg/build_dpdk>`.

 
 Enable switchdev mode
 ---------------------
 
 Enable switchdev mode
 ---------------------