DPDK patches and discussions
 help / color / mirror / Atom feed
From: Agalya Babu RadhaKrishnan <agalyax.babu.radhakrishnan@intel.com>
To: dev@dpdk.org
Cc: reshma.pattan@intel.com, olivier.matz@6wind.com,
	ramirose@gmail.com, bernard.iremonger@intel.com,
	ferruh.yigit@intel.com,
	Agalya Babu RadhaKrishnan <agalyax.babu.radhakrishnan@intel.com>,
	stable@dpdk.org
Subject: [dpdk-dev] [PATCH v2] doc: fix interactive commands in testpmd guide
Date: Tue, 23 Apr 2019 11:44:27 +0100	[thread overview]
Message-ID: <1556016267-20308-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> (raw)
Message-ID: <20190423104427.RaCTT4PM7vbNASJlU6LMbaTqWXvtUBtv9A__65NMk_Q@z> (raw)
In-Reply-To: <1555396398-17880-1-git-send-email-agalyax.babu.radhakrishnan@intel.com>

Added some missing documentation for interactive mode commands

Fixes: 01b2092a5e ("testpmd: add dump commands for debug")
Fixes: caf05a1b86 ("app/testpmd: new command to dump log types")
Fixes: 0f62d63593ed ("app/testpmd: support tunneled TSO in checksum engine")
Fixes: 8fff667578a7
	("app/testpmd: new command to add/remove multicast MAC addresses")
Fixes: ae03d0d18adf ("app/testpmd: command to configure MTU")
Fixes: f79959ea1504 ("app/testpmd: allow to configure RSS hash key")
Fixes: caf05a1b8608 ("app/testpmd: new command to dump log types")
Cc: stable@dpdk.org

Signed-off-by: Agalya Babu RadhaKrishnan <agalyax.babu.radhakrishnan@intel.com>
Reviewed-by: Rami Rosen <ramirose@gmail.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
v2: Added fixes lines and addressed comments.
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 100 ++++++++++++++++++++
 1 file changed, 100 insertions(+)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 5d4dc6f0c..cdcc51957 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -467,6 +467,56 @@ Show Tx metadata value set for a specific port::
 
    testpmd> show port (port_id) tx_metadata
 
+dump physmem
+~~~~~~~~~~~~
+
+Dumps all physical memory segment layouts::
+
+   testpmd> dump_physmem
+
+dump memzone
+~~~~~~~~~~~~
+
+Dumps the layout of all memory zones::
+
+   testpmd> dump_memzone
+
+
+dump struct size
+~~~~~~~~~~~~~~~~
+
+Dumps the size of all memory structures::
+
+   testpmd> dump_struct_sizes
+
+dump ring
+~~~~~~~~~
+
+Dumps the status of all or specific element in DPDK rings::
+
+   testpmd> dump_ring [ring_name]
+
+dump mempool
+~~~~~~~~~~~~
+
+Dumps the statistics of all or specific memory pool::
+
+   testpmd> dump_mempool [mempool_name]
+
+dump devargs
+~~~~~~~~~~~~
+
+Dumps the user device list::
+
+   testpmd> dump_devargs
+
+dump log types
+~~~~~~~~~~~~~~
+
+Dumps the log level for all the dpdk modules::
+
+   testpmd> dump_log_types
+
 Configuration Functions
 -----------------------
 
@@ -1041,6 +1091,20 @@ Display the status of TCP Segmentation Offload::
 
    testpmd> tso show (port_id)
 
+tunnel tso set
+~~~~~~~~~~~~~~
+
+Set tso segment size of tunneled packets for a port in csum engine::
+
+   testpmd> tunnel_tso set (tso_segsz) (port_id)
+
+tunnel tso show
+~~~~~~~~~~~~~~~
+
+Display the status of tunneled TCP Segmentation Offload for a port::
+
+   testpmd> tunnel_tso show (port_id)
+
 set port - gro
 ~~~~~~~~~~~~~~
 
@@ -1162,6 +1226,22 @@ Remove a MAC address from a port::
 
    testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
 
+mcast_addr add
+~~~~~~~~~~~~~~
+
+To add the multicast MAC address to/from the set of multicast addresses
+filtered by port::
+
+   testpmd> mcast_addr add (port_id) (mcast_addr)
+
+mcast_addr remove
+~~~~~~~~~~~~~~~~~
+
+To remove the multicast MAC address to/from the set of multicast addresses
+filtered by port::
+
+   testpmd> mcast_addr remove (port_id) (mcast_addr)
+
 mac_addr add (for VF)
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -2183,6 +2263,26 @@ testpmd will add this value to any Tx packet sent from this port::
 
    testpmd> port config (port_id) tx_metadata (value)
 
+port config mtu
+~~~~~~~~~~~~~~~
+
+To configure MTU(Maximum Transmission Unit) on devices using testpmd::
+
+   testpmd> port config mtu (port_id) (value)
+
+port config rss hash key
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+To configure the RSS hash key used to compute the RSS
+hash of input [IP] packets received on port::
+
+   testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
+                     ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
+                     ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
+                     ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
+                     ipv6-udp-ex <string of hex digits \
+                     (variable length, NIC dependent)>)
+
 Link Bonding Functions
 ----------------------
 
-- 
2.17.2


  parent reply	other threads:[~2019-04-23 10:45 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-16  6:33 [dpdk-dev] [PATCH] " Agalya Babu RadhaKrishnan
2019-04-16  6:33 ` Agalya Babu RadhaKrishnan
2019-04-16  7:32 ` Rami Rosen
2019-04-16  7:32   ` Rami Rosen
2019-04-16 15:05 ` Ferruh Yigit
2019-04-16 15:05   ` Ferruh Yigit
2019-04-17  9:25   ` Iremonger, Bernard
2019-04-17  9:25     ` Iremonger, Bernard
2019-04-18 19:51   ` Ferruh Yigit
2019-04-18 19:51     ` Ferruh Yigit
2019-04-23 10:44 ` Agalya Babu RadhaKrishnan [this message]
2019-04-23 10:44   ` [dpdk-dev] [PATCH v2] " Agalya Babu RadhaKrishnan
2019-04-23 11:38   ` Ferruh Yigit
2019-04-23 11:38     ` 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=1556016267-20308-1-git-send-email-agalyax.babu.radhakrishnan@intel.com \
    --to=agalyax.babu.radhakrishnan@intel.com \
    --cc=bernard.iremonger@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=olivier.matz@6wind.com \
    --cc=ramirose@gmail.com \
    --cc=reshma.pattan@intel.com \
    --cc=stable@dpdk.org \
    /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).