devtools: add cocci script to rename mbuf offload flags

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

diff --git a/doc/guides/nics/kni.rst b/doc/guides/nics/kni.rst
index 77542b5..37c5411 100644 (file)
--- a/doc/guides/nics/kni.rst
+++ b/doc/guides/nics/kni.rst
@@ -1,32 +1,5 @@
-..  BSD LICENSE
-    Copyright(c) 2017 Intel Corporation. All rights reserved.
-    All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions
-    are met:
-
-    * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in
-    the documentation and/or other materials provided with the
-    distribution.
-    * Neither the name of Intel Corporation nor the names of its
-    contributors may be used to endorse or promote products derived
-    from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2017 Intel Corporation.

 
 KNI Poll Mode Driver
 ======================
 
 KNI Poll Mode Driver
 ======================


@@ -60,7 +33,7 @@ Usage
 
 EAL ``--vdev`` argument can be used to create KNI device instance, like::
 
 
 EAL ``--vdev`` argument can be used to create KNI device instance, like::
 

-        testpmd --vdev=net_kni0 --vdev=net_kn1 -- -i
+        dpdk-testpmd --vdev=net_kni0 --vdev=net_kn1 -- -i

 
 Above command will create ``kni0`` and ``kni1`` Linux network interfaces,
 those interfaces can be controlled by standard Linux tools.
 
 Above command will create ``kni0`` and ``kni1`` Linux network interfaces,
 those interfaces can be controlled by standard Linux tools.


@@ -82,7 +55,8 @@ configuration:
 
         Interface name: kni#
         force bind kernel thread to a core : NO
 
         Interface name: kni#
         force bind kernel thread to a core : NO

-        mbuf size: MAX_PACKET_SZ
+        mbuf size: (rte_pktmbuf_data_room_size(pktmbuf_pool) - RTE_PKTMBUF_HEADROOM)
+        mtu: (conf.mbuf_size - RTE_ETHER_HDR_LEN)

 
 KNI control path is not supported with the PMD, since there is no physical
 backend device by default.
 
 KNI control path is not supported with the PMD, since there is no physical
 backend device by default.


@@ -91,7 +65,7 @@ backend device by default.
 PMD arguments
 -------------
 
 PMD arguments
 -------------
 

-``no_request_thread``, by default PMD creates a phtread for each KNI interface
+``no_request_thread``, by default PMD creates a pthread for each KNI interface

 to handle Linux network interface control commands, like ``ifconfig kni0 up``
 
 With ``no_request_thread`` option, pthread is not created and control commands
 to handle Linux network interface control commands, like ``ifconfig kni0 up``
 
 With ``no_request_thread`` option, pthread is not created and control commands


@@ -103,7 +77,7 @@ requests itself.
 
 Argument usage::
 
 
 Argument usage::
 

-        testpmd --vdev "net_kni0,no_request_thread=1" -- -i
+        dpdk-testpmd --vdev "net_kni0,no_request_thread=1" -- -i

 
 
 PMD log messages
 
 
 PMD log messages


@@ -123,13 +97,13 @@ It is possible to test PMD quickly using KNI kernel module loopback feature:
 
     .. code-block:: console
 
 
     .. code-block:: console
 

-        insmod build/kmod/rte_kni.ko lo_mode=lo_mode_fifo_skb
+        insmod <build_dir>/kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo_skb

 
 * Start testpmd with no physical device but two KNI virtual devices:
 
     .. code-block:: console
 
 
 * Start testpmd with no physical device but two KNI virtual devices:
 
     .. code-block:: console
 

-        ./testpmd --vdev net_kni0 --vdev net_kni1 -- -i
+        ./dpdk-testpmd --vdev net_kni0 --vdev net_kni1 -- -i

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


@@ -194,4 +168,3 @@ It is possible to test PMD quickly using KNI kernel module loopback feature:
         RX-packets: 71275820       RX-dropped: 0             RX-total: 71275820
         TX-packets: 71275884       TX-dropped: 0             TX-total: 71275884
         ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
         RX-packets: 71275820       RX-dropped: 0             RX-total: 71275820
         TX-packets: 71275884       TX-dropped: 0             TX-total: 71275884
         ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

-