doc: improve lstopo tip

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

diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst
index 5b2f868..2396509 100644 (file)
--- a/doc/guides/nics/qede.rst
+++ b/doc/guides/nics/qede.rst
@@ -5,7 +5,7 @@
 QEDE Poll Mode Driver
 ======================
 
 QEDE Poll Mode Driver
 ======================
 

-The QEDE poll mode driver library (**librte_pmd_qede**) implements support
+The QEDE poll mode driver library (**librte_net_qede**) implements support

 for **QLogic FastLinQ QL4xxxx 10G/25G/40G/50G/100G Intelligent Ethernet Adapters (IEA) and Converged Network Adapters (CNA)** family of adapters as well as SR-IOV virtual functions (VF). It is supported on
 several standard Linux distros like RHEL, SLES, Ubuntu etc.
 It is compile-tested under FreeBSD OS.
 for **QLogic FastLinQ QL4xxxx 10G/25G/40G/50G/100G Intelligent Ethernet Adapters (IEA) and Converged Network Adapters (CNA)** family of adapters as well as SR-IOV virtual functions (VF). It is supported on
 several standard Linux distros like RHEL, SLES, Ubuntu etc.
 It is compile-tested under FreeBSD OS.


@@ -34,18 +34,13 @@ Supported Features
 - VLAN offload - Filtering and stripping
 - N-tuple filter and flow director (limited support)
 - NPAR (NIC Partitioning)
 - VLAN offload - Filtering and stripping
 - N-tuple filter and flow director (limited support)
 - NPAR (NIC Partitioning)

-- SR-IOV VF
+- SR-IOV PF and VF

 - GRE Tunneling offload
 - GENEVE Tunneling offload
 - VXLAN Tunneling offload
 - MPLSoUDP Tx Tunneling offload
 - Generic flow API
 
 - GRE Tunneling offload
 - GENEVE Tunneling offload
 - VXLAN Tunneling offload
 - MPLSoUDP Tx Tunneling offload
 - Generic flow API
 

-Non-supported Features
-----------------------
-
-- SR-IOV PF
-

 Co-existence considerations
 ---------------------------
 
 Co-existence considerations
 ---------------------------
 


@@ -108,25 +103,12 @@ Performance note
 
 - For better performance, it is recommended to use 4K or higher RX/TX rings.
 
 
 - For better performance, it is recommended to use 4K or higher RX/TX rings.
 

-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_PMD`` (default **y**)
-
-  Toggle compilation of QEDE PMD driver.
+Config Options
+~~~~~~~~~~~~~~

 
 

-- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_TX`` (default **n**)
+The following option can be modified in the ``config/rte_config.h`` file.

 
 

-  Toggle display of transmit fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_RX`` (default **n**)
-
-  Toggle display of receive fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_FW`` (default **""**)
+- ``RTE_LIBRTE_QEDE_FW`` (default **""**)

 
   Gives absolute path of firmware file.
   ``Eg: "/lib/firmware/qed/qed_init_values-8.40.33.0.bin"``
 
   Gives absolute path of firmware file.
   ``Eg: "/lib/firmware/qed/qed_init_values-8.40.33.0.bin"``


@@ -135,6 +117,16 @@ enabling debugging options may affect system performance.
   CAUTION this option is more for custom firmware, it is not
   recommended for use under normal condition.
 
   CAUTION this option is more for custom firmware, it is not
   recommended for use under normal condition.
 

+The following options can be enabled with Meson flags.
+
+- ``RTE_LIBRTE_QEDE_DEBUG_TX`` (default **disabled**)
+
+  Toggle display of transmit fast path run-time messages.
+
+- ``RTE_LIBRTE_QEDE_DEBUG_RX`` (default **disabled**)
+
+  Toggle display of receive fast path run-time messages.
+

 Config notes
 ~~~~~~~~~~~~
 
 Config notes
 ~~~~~~~~~~~~
 


@@ -198,7 +190,7 @@ SR-IOV: Prerequisites and Sample Application Notes
 
 This section provides instructions to configure SR-IOV with Linux OS.
 
 
 This section provides instructions to configure SR-IOV with Linux OS.
 

-**Note**: librte_pmd_qede will be used to bind to SR-IOV VF device and Linux native kernel driver (qede) will function as SR-IOV PF driver. Requires PF driver to be 8.20.x.x or higher.
+**Note**: librte_net_qede will be used to bind to SR-IOV VF device and Linux native kernel driver (qede) will function as SR-IOV PF driver. Requires PF driver to be 8.20.x.x or higher.

 
 #. Verify SR-IOV and ARI capability is enabled on the adapter using ``lspci``:
 
 
 #. Verify SR-IOV and ARI capability is enabled on the adapter using ``lspci``:
 


@@ -280,7 +272,7 @@ This section provides instructions to configure SR-IOV with Linux OS.
 
    .. code-block:: console
 
 
    .. code-block:: console
 

-      testpmd -l 0,4-11 -n 4 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \
+      dpdk-testpmd -l 0,4-11 -n 4 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \

       --txd=4096 --txfreet=4068 --enable-rx-cksum --rxq=4 --txq=4 \
       --rss-ip --rss-udp
 
       --txd=4096 --txfreet=4068 --enable-rx-cksum --rxq=4 --txq=4 \
       --rss-ip --rss-udp