From: Ferruh Yigit <ferruh.yigit@intel.com>
To: dev@dpdk.org, John McNamara <john.mcnamara@intel.com>,
Marko Kovacevic <marko.kovacevic@intel.com>
Cc: Ferruh Yigit <ferruh.yigit@intel.com>
Subject: [dpdk-dev] [PATCH 2/6] doc: add net null PMD guide
Date: Mon, 2 Mar 2020 17:36:41 +0000 [thread overview]
Message-ID: <20200302173646.54984-2-ferruh.yigit@intel.com> (raw)
In-Reply-To: <20200302173646.54984-1-ferruh.yigit@intel.com>
Net null PMD was missing documentation, adding it.
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
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 6d88028ef..2b78fcfee 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 000000000..405edf07b
--- /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.24.1
next prev parent reply other threads:[~2020-03-02 17:37 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-02 17:36 [dpdk-dev] [PATCH 1/6] net/null: fix secondary burst function selection Ferruh Yigit
2020-03-02 17:36 ` Ferruh Yigit [this message]
2020-03-02 17:36 ` [dpdk-dev] [PATCH 3/6] net/null: remove redundant check Ferruh Yigit
2020-03-02 17:36 ` [dpdk-dev] [PATCH 4/6] net/null: prefer unsigned int Ferruh Yigit
2020-03-02 17:36 ` [dpdk-dev] [PATCH 5/6] net/null: group device arguments Ferruh Yigit
2020-03-02 17:36 ` [dpdk-dev] [PATCH 6/6] net/null: add argument for no Rx Ferruh Yigit
2020-04-07 8:38 ` [dpdk-dev] [PATCH 1/6] net/null: fix secondary burst function selection Ferruh Yigit
2020-04-10 8:33 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200302173646.54984-2-ferruh.yigit@intel.com \
--to=ferruh.yigit@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).