net/txgbe: support packet type

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

diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst
index 3ce2f8b..27ff306 100644 (file)
--- a/doc/guides/nics/fail_safe.rst
+++ b/doc/guides/nics/fail_safe.rst
@@ -4,7 +4,7 @@
 Fail-safe poll mode driver library
 ==================================
 
 Fail-safe poll mode driver library
 ==================================
 

-The Fail-safe poll mode driver library (**librte_pmd_failsafe**) implements a
+The Fail-safe poll mode driver library (**librte_net_failsafe**) implements a

 virtual device that allows using device supporting hotplug, without modifying
 other components relying on such device (application, other PMDs).
 In this context, hotplug support is meant as plugging or removing a device
 virtual device that allows using device supporting hotplug, without modifying
 other components relying on such device (application, other PMDs).
 In this context, hotplug support is meant as plugging or removing a device


@@ -14,10 +14,6 @@ Additionally to the Seamless Hotplug feature, the Fail-safe PMD offers the
 ability to redirect operations to a secondary device when the primary has been
 removed from the system.
 
 ability to redirect operations to a secondary device when the primary has been
 removed from the system.
 

-.. note::
-
-   The library is enabled by default. You can enable it or disable it manually
-   by setting the ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` configuration option.

 
 Features
 --------
 
 Features
 --------


@@ -33,14 +29,6 @@ automatically by detecting capable devices and registering the relevant handler.
 
 Check the feature matrix for the complete set of supported features.
 
 
 Check the feature matrix for the complete set of supported features.
 

-Compilation option
-------------------
-
-Available options within the ``$RTE_TARGET/build/.config`` file:
-
-- ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` (default **y**)
-
-  This option enables or disables compiling librte_pmd_failsafe.

 
 Using the Fail-safe PMD from the EAL command line
 -------------------------------------------------
 
 Using the Fail-safe PMD from the EAL command line
 -------------------------------------------------


@@ -49,7 +37,7 @@ The Fail-safe PMD can be used like most other DPDK virtual devices, by passing a
 ``--vdev`` parameter to the EAL when starting the application. The device name
 must start with the *net_failsafe* prefix, followed by numbers or letters. This
 name must be unique for each device. Each fail-safe instance must have at least one
 ``--vdev`` parameter to the EAL when starting the application. The device name
 must start with the *net_failsafe* prefix, followed by numbers or letters. This
 name must be unique for each device. Each fail-safe instance must have at least one

-sub-device, up to ``RTE_MAX_ETHPORTS-1``.
+sub-device, and at most two.

 
 A sub-device can be any DPDK device, including possibly another fail-safe device.
 
 
 A sub-device can be any DPDK device, including possibly another fail-safe device.
 


@@ -128,7 +116,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
 
    .. code-block:: console
 

-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \

          --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
          -b 84:00.0 -b 00:04.0 -- -i
 
          --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
          -b 84:00.0 -b 00:04.0 -- -i
 


@@ -142,7 +130,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
 
    .. code-block:: console
 

-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \

          --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
          -w 81:00.0 -- -i
 
          --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
          -w 81:00.0 -- -i
 


@@ -150,15 +138,15 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
 
    .. code-block:: console
 

-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 -w ff:ff.f \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -w ff:ff.f \

          --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i
 
 #. Start testpmd, automatically probing the device 84:00.0 and using it with
    the fail-safe.
          --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i
 
 #. Start testpmd, automatically probing the device 84:00.0 and using it with
    the fail-safe.

- 
+

    .. code-block:: console
    .. code-block:: console

- 
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \

          --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i
 
 
          --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i