doc: improve firmware configuration in mlx5 guide

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

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 6f0c382..d3acf4c 100644 (file)
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -57,6 +57,7 @@ Features
 - Several RSS hash keys, one for each flow type.
 - Default RSS operation with no hash key specification.
 - Configurable RETA table.
+- Link flow control (pause frame).
 - Support for multiple MAC addresses.
 - VLAN filtering.
 - RX VLAN stripping.
@@ -448,7 +449,7 @@ Run-time configuration
   and CPU resources are scarce), data inline is not performed by the driver.
   Assigning ``txqs_min_inline`` with zero always enables the data inline.
 
-  The default ``txq_inline_mpw`` value is 188. The specified value may be adjusted
+  The default ``txq_inline_mpw`` value is 268. The specified value may be adjusted
   by the driver in order not to exceed the limit (930 bytes) and to provide better
   WQE space filling without gaps, the adjustment is reflected in the debug log.
   Due to multiple packets may be included to the same WQE with Enhanced Multi
@@ -574,46 +575,53 @@ Run-time configuration
 Firmware configuration
 ~~~~~~~~~~~~~~~~~~~~~~
 
-- L3 VXLAN and VXLAN-GPE destination UDP port
+Firmware features can be configured as key/value pairs.
 
-   .. code-block:: console
+The command to set a value is::
 
-     mlxconfig -d <mst device> set IP_OVER_VXLAN_EN=1
-     mlxconfig -d <mst device> set IP_OVER_VXLAN_PORT=<udp dport>
+  mlxconfig -d <device> set <key>=<value>
 
-  Verify configurations are set:
+The command to query a value is::
 
-   .. code-block:: console
+  mlxconfig -d <device> query | grep <key>
 
-     mlxconfig -d <mst device> query | grep IP_OVER_VXLAN
-     IP_OVER_VXLAN_EN                    True(1)
-     IP_OVER_VXLAN_PORT                  <udp dport>
+The device name for the command ``mlxconfig`` can be either the PCI address,
+or the mst device name found with::
 
-- enable ICMP/ICMP6's code/type field matching
+  mst status
 
-   .. code-block:: console
+Below are some firmware configurations listed.
 
-     mlxconfig -d <mst device> set FLEX_PARSER_PROFILE_ENABLE=2
+- link type::
 
-  Verify configurations are set:
+    LINK_TYPE_P1
+    LINK_TYPE_P2
+    value: 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
 
-   .. code-block:: console
+- enable SR-IOV::
 
-     mlxconfig -d <mst device> query | grep FLEX_PARSER_PROFILE_ENABLE
-     FLEX_PARSER_PROFILE_ENABLE         2
+    SRIOV_EN=1
 
-- IP-in-IP tunnel enable
+- maximum number of SR-IOV virtual functions::
 
-   .. code-block:: console
+    NUM_OF_VFS=<max>
 
-     mlxconfig -d <mst device> set FLEX_PARSER_PROFILE_ENABLE=0
+- aggressive CQE zipping::
 
-  Verify configurations are set:
+    CQE_COMPRESSION=1
 
-   .. code-block:: console
+- L3 VXLAN and VXLAN-GPE destination UDP port::
+
+    IP_OVER_VXLAN_EN=1
+    IP_OVER_VXLAN_PORT=<udp dport>
+
+- enable IP-in-IP tunnel flow matching::
+
+    FLEX_PARSER_PROFILE_ENABLE=0
+
+- enable ICMP/ICMP6 code/type fields matching::
 
-     mlxconfig -d <mst device> query | grep FLEX_PARSER_PROFILE_ENABLE
-     FLEX_PARSER_PROFILE_ENABLE          0
+    FLEX_PARSER_PROFILE_ENABLE=2
 
 Prerequisites
 -------------