app/testpmd: disable Rx VLAN offloads by default

[dpdk.git] / doc / guides / sample_app_ug / qos_scheduler.rst

diff --git a/doc/guides/sample_app_ug/qos_scheduler.rst b/doc/guides/sample_app_ug/qos_scheduler.rst
index 66c261c..1c38d19 100644 (file)
--- a/doc/guides/sample_app_ug/qos_scheduler.rst
+++ b/doc/guides/sample_app_ug/qos_scheduler.rst
@@ -58,30 +58,14 @@ The TX thread, if present, reads from the TX ring and write the packets to the T
 Compiling the Application
 -------------------------
 
-To compile the application:
+To compile the sample application see :doc:`compiling`.
 
-#.  Go to the sample application directory:
-
-    .. code-block:: console
-
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/qos_sched
-
-#.  Set the target (a default target is used if not specified). For example:
+The application is located in the ``qos_sched`` sub-directory.
 
     .. note::
 
         This application is intended as a linuxapp only.
 
-    .. code-block:: console
-
-        export RTE_TARGET=x86_64-native-linuxapp-gcc
-
-#.  Build the application:
-
-    .. code-block:: console
-
-        make
-
 .. note::
 
     To get statistics on the sample app using the command line interface as described in the next section,
@@ -288,7 +272,7 @@ The following is an example command with a single packet flow configuration:
 
 .. code-block:: console
 
-    ./qos_sched -c a2 -n 4 -- --pfc "3,2,5,7" --cfg ./profile.cfg
+    ./qos_sched -l 1,5,7 -n 4 -- --pfc "3,2,5,7" --cfg ./profile.cfg
 
 This example uses a single packet flow configuration which creates one RX thread on lcore 5 reading
 from port 3 and a worker thread on lcore 7 writing to port 2.
@@ -297,12 +281,12 @@ Another example with 2 packet flow configurations using different ports but shar
 
 .. code-block:: console
 
-   ./qos_sched -c c6 -n 4 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg
+   ./qos_sched -l 1,2,6,7 -n 4 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg
 
 Note that independent cores for the packet flow configurations for each of the RX, WT and TX thread are also supported,
 providing flexibility to balance the work.
 
-The EAL coremask is constrained to contain the default mastercore 1 and the RX, WT and TX cores only.
+The EAL coremask/corelist is constrained to contain the default mastercore 1 and the RX, WT and TX cores only.
 
 Explanation
 -----------
@@ -321,28 +305,28 @@ The Port/Subport/Pipe/Traffic Class/Queue are the hierarchical entities in a typ
 The traffic flows that need to be configured are application dependent.
 This application classifies based on the QinQ double VLAN tags and the IP destination address as indicated in the following table.
 
-.. _table_2:
-
-**Table 2. Entity Types**
-
-+----------------+-------------------------+--------------------------------------------------+----------------------------------+
-| **Level Name** | **Siblings per Parent** | **QoS Functional Description**                   | **Selected By**                  |
-|                |                         |                                                  |                                  |
-+================+=========================+==================================================+==================================+
-| Port           | -                       | Ethernet port                                    | Physical port                    |
-|                |                         |                                                  |                                  |
-+----------------+-------------------------+--------------------------------------------------+----------------------------------+
-| Subport        | Config (8)              | Traffic shaped (token bucket)                    | Outer VLAN tag                   |
-|                |                         |                                                  |                                  |
-+----------------+-------------------------+--------------------------------------------------+----------------------------------+
-| Pipe           | Config (4k)             | Traffic shaped (token bucket)                    | Inner VLAN tag                   |
-|                |                         |                                                  |                                  |
-+----------------+-------------------------+--------------------------------------------------+----------------------------------+
-| Traffic Class  | 4                       | TCs of the same pipe services in strict priority | Destination IP address (0.0.X.0) |
-|                |                         |                                                  |                                  |
-+----------------+-------------------------+--------------------------------------------------+----------------------------------+
-| Queue          | 4                       | Queue of the same TC serviced in WRR             | Destination IP address (0.0.0.X) |
-|                |                         |                                                  |                                  |
-+----------------+-------------------------+--------------------------------------------------+----------------------------------+
+.. _table_qos_scheduler_1:
+
+.. table:: Entity Types
+
+   +----------------+-------------------------+--------------------------------------------------+----------------------------------+
+   | **Level Name** | **Siblings per Parent** | **QoS Functional Description**                   | **Selected By**                  |
+   |                |                         |                                                  |                                  |
+   +================+=========================+==================================================+==================================+
+   | Port           | -                       | Ethernet port                                    | Physical port                    |
+   |                |                         |                                                  |                                  |
+   +----------------+-------------------------+--------------------------------------------------+----------------------------------+
+   | Subport        | Config (8)              | Traffic shaped (token bucket)                    | Outer VLAN tag                   |
+   |                |                         |                                                  |                                  |
+   +----------------+-------------------------+--------------------------------------------------+----------------------------------+
+   | Pipe           | Config (4k)             | Traffic shaped (token bucket)                    | Inner VLAN tag                   |
+   |                |                         |                                                  |                                  |
+   +----------------+-------------------------+--------------------------------------------------+----------------------------------+
+   | Traffic Class  | 4                       | TCs of the same pipe services in strict priority | Destination IP address (0.0.X.0) |
+   |                |                         |                                                  |                                  |
+   +----------------+-------------------------+--------------------------------------------------+----------------------------------+
+   | Queue          | 4                       | Queue of the same TC serviced in WRR             | Destination IP address (0.0.0.X) |
+   |                |                         |                                                  |                                  |
+   +----------------+-------------------------+--------------------------------------------------+----------------------------------+
 
 Please refer to the "QoS Scheduler" chapter in the *DPDK Programmer's Guide* for more information about these parameters.