doc: add flow API to features list

[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 2d86a03..88e08cf 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
 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
 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.
 
 
 *   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:
 
 
 .. _figure_tep_termination_arch:
 


@@ -118,11 +119,6 @@ The example in this section have been validated with the following distributions
 
 *   Fedora* 20
 
 
 *   Fedora* 20
 

-Prerequisites
--------------
-
-Refer to :ref:`vhost_app_prerequisites`.
-

 Compiling the Sample Code
 -------------------------
 #.  Compile vhost lib:
 Compiling the Sample Code
 -------------------------
 #.  Compile vhost lib:


@@ -131,16 +127,8 @@ Compiling the Sample Code
 
     .. code-block:: console
 
 
     .. 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:
 
 
 #.  Go to the examples directory:
 


@@ -167,40 +155,9 @@ Compiling the Sample Code
         cd ${RTE_SDK}/examples/tep_termination
         make
 
         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
 -----------------------
 
 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
 #.  Go to the examples directory:
 
     .. code-block:: console


@@ -225,8 +182,7 @@ Parameters
 
 **The same parameters with the vhost sample.**
 
 
 **The same parameters with the vhost sample.**
 

-Refer to :ref:`vhost_app_parameters` 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.**
 
 
 **Number of Devices.**
 


@@ -303,12 +259,12 @@ The default value is 1.
 Running the Virtual Machine (QEMU)
 ----------------------------------
 
 Running the Virtual Machine (QEMU)
 ----------------------------------
 

-Refer to :ref:`vhost_app_running`.
+Refer to :ref:`vhost_app_run_vm`.

 
 Running DPDK in the Virtual Machine
 -----------------------------------
 
 
 Running DPDK in the Virtual Machine
 -----------------------------------
 

-Refer to :ref:`vhost_app_running_dpdk`.
+Refer to :ref:`vhost_app_run_dpdk_inside_guest`.

 
 Passing Traffic to the Virtual Machine Device
 ---------------------------------------------
 
 Passing Traffic to the Virtual Machine Device
 ---------------------------------------------