doc: add details about MDD with ixgbe kernel PF

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

diff --git a/doc/guides/sample_app_ug/tep_termination.rst b/doc/guides/sample_app_ug/tep_termination.rst
index 71a4acd..087823b 100644 (file)
--- a/doc/guides/sample_app_ug/tep_termination.rst
+++ b/doc/guides/sample_app_ug/tep_termination.rst
@@ -59,8 +59,8 @@ This allows network isolation, QOS, etc to be provided on a per client basis.
 In a typical setup, the network overlay tunnel is terminated at the Virtual/Tunnel End Point (VEP/TEP).
 The TEP is normally located at the physical host level ideally in the software switch.
 Due to processing constraints and the inevitable bottleneck that the switch
-becomes the ability to offload overlay support features becomes an important requirement.
-Intel® XL710 10/40 G Ethernet network card provides hardware filtering
+becomes, the ability to offload overlay support features becomes an important requirement.
+Intel® XL710 10/40 Gigabit Ethernet network card provides hardware filtering
 and offload capabilities to support overlay networks implementations such as MAC in UDP and MAC in GRE.
 
 Sample Code Overview
@@ -99,7 +99,8 @@ The sample will support the followings:
 
 *   TSO offload support for tunneling packet.
 
-The following figure shows the framework of the TEP termination sample application based on vhost-cuse.
+The following figure shows the framework of the TEP termination sample
+application based on DPDK vhost lib.
 
 .. _figure_tep_termination_arch:
 
@@ -118,11 +119,6 @@ The example in this section have been validated with the following distributions
 
 *   Fedora* 20
 
-Prerequisites
--------------
-
-Refer to the guide in section 27.4 in the vhost sample.
-
 Compiling the Sample Code
 -------------------------
 #.  Compile vhost lib:
@@ -131,16 +127,8 @@ Compiling the Sample Code
 
     .. code-block:: console
 
-        CONFIG_RTE_LIBRTE_VHOST=n
+        CONFIG_RTE_LIBRTE_VHOST=y
 
-    vhost user is turned on by default in the configure file config/common_linuxapp.
-    To enable vhost cuse, disable vhost user.
-
-    .. code-block:: console
-
-        CONFIG_RTE_LIBRTE_VHOST_USER=y
-
-     After vhost is enabled and the implementation is selected, build the vhost library.
 
 #.  Go to the examples directory:
 
@@ -167,40 +155,9 @@ Compiling the Sample Code
         cd ${RTE_SDK}/examples/tep_termination
         make
 
-#.  Go to the eventfd_link directory(vhost cuse required):
-
-    .. code-block:: console
-
-        cd ${RTE_SDK}/lib/librte_vhost/eventfd_link
-
-#.  Build the eventfd_link kernel module(vhost cuse required):
-
-    .. code-block:: console
-
-        make
-
 Running the Sample Code
 -----------------------
 
-#.  Install the cuse kernel module(vhost cuse required):
-
-    .. code-block:: console
-
-        modprobe cuse
-
-#.  Go to the eventfd_link directory(vhost cuse required):
-
-    .. code-block:: console
-
-        export RTE_SDK=/path/to/rte_sdk
-        cd ${RTE_SDK}/lib/librte_vhost/eventfd_link
-
-#.  Install the eventfd_link module(vhost cuse required):
-
-    .. code-block:: console
-
-        insmod ./eventfd_link.ko
-
 #.  Go to the examples directory:
 
     .. code-block:: console
@@ -212,7 +169,7 @@ Running the Sample Code
 
     .. code-block:: console
 
-        user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge --
+        user@target:~$ ./build/app/tep_termination -l 0-3 -n 4 --huge-dir /mnt/huge --
                         -p 0x1 --dev-basename tep-termination --nb-devices 4
                         --udp-port 4789 --filter-type 1
 
@@ -225,8 +182,7 @@ Parameters
 
 **The same parameters with the vhost sample.**
 
-Refer to the guide in section 27.6.1 in the vhost sample for the meanings of 'Basename',
-'Stats', 'RX Retry', 'RX Retry Number' and 'RX Retry Delay Time'.
+Refer to :ref:`vhost_app_parameters` for detailed explanation.
 
 **Number of Devices.**
 
@@ -235,7 +191,7 @@ The default value is 2.
 
 .. code-block:: console
 
-    user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge --
+    user@target:~$ ./build/app/tep_termination -l 0-3 -n 4 --huge-dir /mnt/huge --
                     --nb-devices 2
 
 **Tunneling UDP port.**
@@ -245,7 +201,7 @@ The default value is 4789.
 
 .. code-block:: console
 
-    user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge --
+    user@target:~$ ./build/app/tep_termination -l 0-3 -n 4 --huge-dir /mnt/huge --
                     --nb-devices 2 --udp-port 4789
 
 **Filter Type.**
@@ -256,7 +212,7 @@ The default value is 1, which means the filter type of inner MAC and tenant ID i
 
 .. code-block:: console
 
-    user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge --
+    user@target:~$ ./build/app/tep_termination -l 0-3 -n 4 --huge-dir /mnt/huge --
                 --nb-devices 2 --udp-port 4789 --filter-type 1
 
 **TX Checksum.**
@@ -266,7 +222,7 @@ The default value is 0, which means the checksum offload is disabled.
 
 .. code-block:: console
 
-    user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge --
+    user@target:~$ ./build/app/tep_termination -l 0-3 -n 4 --huge-dir /mnt/huge --
                 --nb-devices 2 --tx-checksum
 
 **TCP segment size.**
@@ -276,7 +232,7 @@ The default value is 0, which means TSO offload is disabled.
 
 .. code-block:: console
 
-    user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge --
+    user@target:~$ ./build/app/tep_termination -l 0-3 -n 4 --huge-dir /mnt/huge --
                 --tx-checksum --tso-segsz 800
 
 **Decapsulation option.**
@@ -286,7 +242,7 @@ The default value is 1.
 
 .. code-block:: console
 
-    user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge --
+    user@target:~$ ./build/app/tep_termination -l 0-3 -n 4 --huge-dir /mnt/huge --
                 --nb-devices 4 --udp-port 4789 --decap 1
 
 **Encapsulation option.**
@@ -296,19 +252,19 @@ The default value is 1.
 
 .. code-block:: console
 
-    user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge --
+    user@target:~$ ./build/app/tep_termination -l 0-3 -n 4 --huge-dir /mnt/huge --
                 --nb-devices 4 --udp-port 4789 --encap 1
 
 
 Running the Virtual Machine (QEMU)
 ----------------------------------
 
-Refer to the guide in section 27.7 in the vhost sample.
+Refer to :ref:`vhost_app_run_vm`.
 
 Running DPDK in the Virtual Machine
 -----------------------------------
 
-Refer to the guide in section 27.8 in the vHost sample.
+Refer to :ref:`vhost_app_run_dpdk_inside_guest`.
 
 Passing Traffic to the Virtual Machine Device
 ---------------------------------------------