From 62a667f386fb6df5c2e96cb1e813f9abf6683bb4 Mon Sep 17 00:00:00 2001 From: Ferruh Yigit Date: Mon, 2 Mar 2020 17:36:41 +0000 Subject: [PATCH] doc: add net null PMD guide Net null PMD was missing documentation, adding it. Signed-off-by: Ferruh Yigit --- doc/guides/nics/index.rst | 1 + doc/guides/nics/null.rst | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 doc/guides/nics/null.rst diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 6d88028ef2..2b78fcfee1 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -46,6 +46,7 @@ Network Interface Controller Drivers netvsc nfb nfp + null octeontx octeontx2 pfe diff --git a/doc/guides/nics/null.rst b/doc/guides/nics/null.rst new file mode 100644 index 0000000000..405edf07ba --- /dev/null +++ b/doc/guides/nics/null.rst @@ -0,0 +1,39 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2020 Intel Corporation. + +NULL Poll Mode Driver +===================== + +NULL PMD is a simple virtual driver mainly for testing. It always returns success for all packets for Rx/Tx. + +On Rx it returns requested number of empty packets (all zero). On Tx it just frees all sent packets. + + +Usage +----- + +.. code-block:: console + + $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i + + +Runtime Config Options +---------------------- + +- ``copy`` [optional, default disabled] + + It copies data of the packet before Rx/Tx. For Rx it uses another empty dummy mbuf for this. + +.. code-block:: console + + $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i + +- ``size`` [optional, default=64 bytes] + + Custom packet length value to use.r + If ``copy`` is enabled, this is the length of copy operation. + +.. code-block:: console + + $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i + -- 2.20.1